Release/17.0.0 (#7588)

* ADD ensure indexes and primaryKey have a maximum `maxLength` of `1000`

* ADD use internal types for `WeakRef` so people do not have to add `ES2021.WeakRef` to their TypeScript config

* REMOVE dist folder

* ADD `context` field to all RxDB write errors for easier debugging

* CHANGE `toggleOnDocumentVisible` is now `true` by default

* CHANGE final fields no longer must be `required`

* FIX types

* FIX dexie

* FIX

* FIX `RxCollection.cleanup()` does not respect the provided `minimumDeletedTime`

Author: pubkey

CHANGELOG.md

@@ -2,6 +2,15 @@
 # RxDB Changelog
 
 <!-- CHANGELOG NEWEST -->
+- ADD ensure indexes and primaryKey have a maximum `maxLength` of `1000`.
+- ADD use internal types for `WeakRef` so people do not have to add `ES2021.WeakRef` to their TypeScript config.
+- We no longer have the `dist` folder in the github repository. Either install RxDB from npm, or run the build scripts locally.
+- ADD `context` field to all RxDB write errors for easier debugging.
+- CHANGE `toggleOnDocumentVisible` is now `true` by default.
+- CHANGE final fields no longer must be `required`.
+- FIX OPFS-Storage memory and cleanup leaking
+- FIXmemory-mapped-storage: deleted docs must be purged
+- FIX `RxCollection.cleanup()` does not respect the provided `minimumDeletedTime`.
 
 <!-- ADD new changes here! -->
 

orga/before-next-major.md

@@ -36,21 +36,11 @@ https://github.com/pubkey/rxdb/issues/6810
 
 https://discord.com/channels/969553741705539624/1237000453791678487/threads/1327921349808885831
 
-## Move `final` definitions to the top level
-
-This should be done similar to where indexes or `encryption` fields are defined. This would 
-then allow to have `final` be also set for nested properties.
-
 
 ---------------------------------
 ## Maybe later (not sure if should be done)
 
 
-## Suggestions from #6787
-
-See https://github.com/pubkey/rxdb/pull/6787
-
-
 ## Do not allow type mixing
 
 In the RxJsonSchema, a property of a document can have multiple types like

src/plugins/cleanup/index.ts

@@ -1,4 +1,3 @@
-import { runAsyncPluginHooks } from '../../hooks.ts';
 import type {
     RxCollection,
     RxPlugin
@@ -19,8 +18,8 @@ export const RxDBCleanupPlugin: RxPlugin = {
                     this.database.cleanupPolicy ? this.database.cleanupPolicy : {}
                 );
 
-                if (typeof minimumDeletedTime === 'undefined') {
-                    minimumDeletedTime = cleanupPolicy.minimumDeletedTime;
+                if (typeof minimumDeletedTime !== 'undefined') {
+                    cleanupPolicy.minimumDeletedTime = minimumDeletedTime;
                 }
 
                 // run cleanup() until it returns true
@@ -43,3 +42,4 @@ export const RxDBCleanupPlugin: RxPlugin = {
 };
 
 export * from './cleanup.ts';
+export * from './cleanup-helper.ts';

test/unit/cleanup.test.ts

@@ -6,7 +6,8 @@ import {
     schemaObjects,
     schemas,
     isFastMode,
-    HumanDocumentType
+    HumanDocumentType,
+    humansCollection
 } from '../../plugins/test-utils/index.mjs';
 import {
     createRxDatabase,
@@ -21,6 +22,7 @@ import { replicateRxCollection } from '../../plugins/replication/index.mjs';
 
 import { RxDBCleanupPlugin } from '../../plugins/cleanup/index.mjs';
 import { wrappedValidateAjvStorage } from '../../plugins/validate-ajv/index.mjs';
+import { DEFAULT_CLEANUP_POLICY } from '../../plugins/cleanup/index.mjs';
 addRxPlugin(RxDBCleanupPlugin);
 
 describeParallel('cleanup.test.js', () => {
@@ -200,6 +202,29 @@ describeParallel('cleanup.test.js', () => {
         });
     });
     describe('issues', () => {
+        it('minimumDeletedTime not respected', async () => {
+            const col = await humansCollection.create(0);
+
+            const storageInstance = col.storageInstance.originalStorageInstance;
+            const cleanupBefore = storageInstance.cleanup.bind(storageInstance);
+
+            const calls: number[] = [];
+            storageInstance.cleanup = (t) => {
+                calls.push(t);
+                return cleanupBefore(t);
+            }
+
+            await col.cleanup(0);
+            await col.cleanup(5);
+            await col.cleanup();
+
+
+            assert.strictEqual(calls[0], 0);
+            assert.strictEqual(calls[1], 5);
+            assert.strictEqual(calls[2], DEFAULT_CLEANUP_POLICY.minimumDeletedTime);
+
+            col.database.remove();
+        });
         it('fields with umlauts and emojis could break the state after cleanup in some storages', async () => {
             type DocType = {
                 id: string;