FIX #3319 graphql checkpoint not removed after database.remove()

.eslintignore

@@ -14,5 +14,6 @@ examples/react-native
 examples/vanilla
 examples/vue
 examples/svelte
+examples/react/build
 node_modules
 docs

CHANGELOG.md

@@ -6,6 +6,9 @@ Other:
   - Added svelte example [#3287](https://github.com/pubkey/rxdb/pull/3287) Thanks [@bkeating](https://github.com/bkeating)
   - Improved error messages
 
+Bugfixes:
+  - [#3319](https://github.com/pubkey/rxdb/issues/3319) Graphql replication checkpoint was not deleted after running `RxDatabase.remove()`
+
 ### 10.0.3 (9 August 2021)
 
 Bugfixes:

src/plugins/pouchdb/rx-storage-pouchdb.ts

@@ -511,6 +511,16 @@ export class RxStorageInstancePouch<RxDocType> implements RxStorageInstance<
         const doc: RxDocumentData<RxDocType> = change.operation === 'DELETE' ? change.previous as any : change.doc as any;
         const primaryPath = getPrimaryFieldOfPrimaryKey(this.schema.primaryKey);
         const primary: string = (doc as any)[primaryPath];
+
+        // TODO remove this check because this should never happen
+        if (!primary) {
+            console.log('----');
+            console.dir(this.schema);
+            console.dir(change);
+            console.dir(doc);
+            throw new Error('primary missing (' + primaryPath + ')');
+        }
+
         const eventId = getEventKey(false, primary, doc._rev);
 
         if (this.emittedEventIds.has(eventId)) {
@@ -1211,12 +1221,17 @@ export function pouchStripLocalFlagFromPrimary(str: string): string {
     return str.substring(POUCHDB_LOCAL_PREFIX.length);
 }
 
-export function getEventKey(isLocal: boolean, primary: string, revision: string): string {
+export function getEventKey(
+    isLocal: boolean,
+    primary: string,
+    revision: string
+): string {
 
     // TODO remove this check this should never happen
     if (!primary) {
         throw new Error('primary missing !!');
     }
+
     const prefix = isLocal ? 'local' : 'non-local';
     const eventKey = prefix + '|' + primary + '|' + revision;
     return eventKey;

src/plugins/replication-graphql/crawling-checkpoint.ts

@@ -200,10 +200,10 @@ export async function getChangesSinceLastPushSequence<RxDocType>(
 
 const pullLastDocumentId = (endpointHash: string) => GRAPHQL_REPLICATION_PLUGIN_IDENT + '-pull-checkpoint-' + endpointHash;
 
-export async function getLastPullDocument(
-    collection: RxCollection,
+export async function getLastPullDocument<RxDocType>(
+    collection: RxCollection<RxDocType>,
     endpointHash: string
-) {
+): Promise<RxDocType | null> {
     const localDoc = await findLocalDocument<any>(
         collection.localDocumentsStore,
         pullLastDocumentId(endpointHash)

src/rx-collection-helper.ts

@@ -134,6 +134,11 @@ export function fillObjectDataBeforeInsert(
     return useJson;
 }
 
+
+export function getCollectionLocalInstanceName(collectionName: string): string {
+    return collectionName + '-local';
+}
+
 /**
  * Creates the storage instances that are used internally in the collection
  */
@@ -161,7 +166,7 @@ export async function createRxCollectionStorageInstances<RxDocumentType, Interna
              * so that the local docs can be kept while deleting the normal instance
              * after migration.
              */
-            collectionName + '-local',
+            getCollectionLocalInstanceName(collectionName),
             instanceCreationOptions
         )
     ]);

src/rx-database.ts

@@ -31,7 +31,7 @@ import {
     newRxError
 } from './rx-error';
 import {
-    createRxSchema
+    createRxSchema, getPrimaryFieldOfPrimaryKey
 } from './rx-schema';
 import {
     isRxChangeEventIntern,
@@ -60,7 +60,7 @@ import {
 } from './rx-storage-helper';
 import type { RxBackupState } from './plugins/backup';
 import { getPseudoSchemaForVersion } from './rx-schema-helper';
-import { createRxCollectionStorageInstances } from './rx-collection-helper';
+import { createRxCollectionStorageInstances, getCollectionLocalInstanceName } from './rx-collection-helper';
 
 /**
  * stores the used database names
@@ -708,20 +708,30 @@ export async function removeRxDatabase(
     const docs = await getAllDocuments(storageInstance.internalStore);
     await Promise.all(
         docs
-            .map(colDoc => colDoc.collectionName)
-            .map(async (id: string) => {
+            .map(async (colDoc) => {
+                const id = colDoc.collectionName;
+                const schema = colDoc.schema
                 const split = id.split('-');
-                const name = split[0];
+                const collectionName = split[0];
                 const version = parseInt(split[1], 10);
-                const instance = await storage.createStorageInstance<InternalStoreDocumentData>(
-                    {
+                const primaryPath = getPrimaryFieldOfPrimaryKey(schema.primaryKey);
+                const [instance, localInstance] = await Promise.all([
+                    storage.createStorageInstance<InternalStoreDocumentData>(
+                        {
+                            databaseName,
+                            collectionName,
+                            schema: getPseudoSchemaForVersion(version, primaryPath as any),
+                            options: {}
+                        }
+                    ),
+                    storage.createKeyObjectStorageInstance(
                         databaseName,
-                        collectionName: name,
-                        schema: getPseudoSchemaForVersion(version, 'collectionName'),
-                        options: {}
-                    }
-                );
-                return instance.remove();
+                        getCollectionLocalInstanceName(collectionName),
+                        {}
+                    )
+                ]);
+
+                await Promise.all([instance.remove(), localInstance.remove()]);
             })
     );
 

test/unit/replication-graphql.test.ts

@@ -2490,6 +2490,26 @@ describe('replication-graphql.test.js', () => {
 
                 c.database.destroy();
             });
+            it('#3319 database.remove() should delete the last-pull document', async () => {
+                const dbName = randomCouchString(12);
+                const c = await humansCollection.createHumanWithTimestamp(1, dbName);
+                const doc = await c.findOne().exec(true);
+                let docData = doc.toJSON(true);
+                docData = clone(docData); // clone to make it mutateable
+                (docData as any).name = 'foobar';
+
+                await setLastPullDocument(c, endpointHash, docData);
+                await c.database.remove();
+
+
+                // recreate the same collection again
+                const c2 = await humansCollection.createHumanWithTimestamp(1, dbName);
+                // there should be no pull document now
+                const ret = await getLastPullDocument(c2, endpointHash);
+                assert.strictEqual(ret, null);
+
+                c2.database.destroy();
+            });
         });
     });
     describe('browser', () => {