ADD helpfull error message for #5046

pubkey · Oct 5, 2023 · 45285ec · 45285ec
1 parent ae84f68
commit 45285ec
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 0 deletions.
diff --git a/src/plugins/dev-mode/error-messages.ts b/src/plugins/dev-mode/error-messages.ts
@@ -120,6 +120,8 @@ export const ERROR_MESSAGES = {
     DOC21: 'PrimaryKey must be equal to PrimaryKey.trim(). It cannot start or end with a whitespace',
     DOC22: 'PrimaryKey must not contain a linebreak',
     DOC23: 'PrimaryKey must not contain a double-quote ["]',
+    DOC24: 'Given document data could not be structured cloned. This happens if you pass non-plain-json data into it, like a Date() or a Function. ' +
+        'In vue.js this happens if you use ref() on the document data which transforms it into a Proxy object.',
 
     // data-migrator.js
     DM1: 'migrate() Migration has already run',

diff --git a/src/rx-storage-helper.ts b/src/rx-storage-helper.ts
@@ -600,6 +600,20 @@ export function getWrappedStorageInstance<
                 data as any
             );
 
+
+            /**
+             * Ensure it can be structured cloned
+             */
+            try {
+                structuredClone(writeRow);
+            } catch (err) {
+                throw newRxError('DOC24', {
+                    collection: storageInstance.collectionName,
+                    document: writeRow.document
+                });
+            }
+
+
             /**
              * Ensure that the new revision is higher
              * then the previous one

diff --git a/test/unit/rx-collection.test.ts b/test/unit/rx-collection.test.ts
@@ -285,6 +285,30 @@ describe('rx-collection.test.ts', () => {
                     ].map(id => ensurePrimaryKeyInsertThrows(id)));
                     c.database.destroy();
                 });
+                /**
+                 * @link https://github.com/pubkey/rxdb/issues/5046
+                 */
+                it('should throw a helpful error on non-plain-json data', async () => {
+                    const c = await humansCollection.create(1);
+
+                    // inserts
+                    const doc = schemaObjects.human();
+                    (doc as any).lastName = () => { };
+                    await assertThrows(
+                        () => c.insert(doc),
+                        'RxError',
+                        'DOC24'
+                    );
+
+                    // updates
+                    const doc2 = await c.findOne().exec(true);
+                    await assertThrows(
+                        () => doc2.patch({ lastName: (() => { }) as any }),
+                        'RxError',
+                        'DOC24'
+                    );
+                    c.database.destroy();
+                });
             });
         });
         config.parallel('.bulkInsert()', () => {