feat(port-data): add skip to queryDocuments port #609

hyper63 · Oct 10, 2023 · 96c99a6 · 96c99a6
1 parent 7648b89
commit 96c99a6
Show file tree

Hide file tree

Showing 2 changed files with 89 additions and 1 deletion.
diff --git a/packages/port-data/mod.test.ts b/packages/port-data/mod.test.ts
@@ -408,6 +408,7 @@ Deno.test('data', async (t) => {
             fields: ['name'],
             sort: ['name'],
             limit: 1000,
+            skip: 2,
             use_index: 'idx-name',
           },
         }),
@@ -577,6 +578,92 @@ Deno.test('data', async (t) => {
         })
       })
 
+      await t.step('skip', async (t) => {
+        await t.step('should parse to a number, if provided', async () => {
+          assert(
+            await adapter.queryDocuments({
+              db: 'foo',
+              query: {
+                selector: { name: { $gt: 'mike' } },
+                fields: ['name'],
+                sort: ['ASC' as const],
+                skip: 1000,
+                use_index: 'idx-name',
+              },
+            }),
+          )
+
+          assert(
+            await adapter.queryDocuments({
+              db: 'foo',
+              query: {
+                selector: { name: { $gt: 'mike' } },
+                fields: ['name'],
+                sort: ['ASC' as const],
+                limit: '1000',
+                use_index: 'idx-name',
+              },
+            }),
+          )
+
+          assert(
+            await adapter.queryDocuments({
+              db: 'foo',
+              query: {
+                selector: { name: { $gt: 'mike' } },
+                fields: ['name'],
+                sort: ['ASC' as const],
+                skip: ' 1000  ',
+                use_index: 'idx-name',
+              },
+            }),
+          )
+
+          assert(
+            await adapter.queryDocuments({
+              db: 'foo',
+              query: {
+                selector: { name: { $gt: 'mike' } },
+                fields: ['name'],
+                sort: ['ASC' as const],
+                skip: undefined,
+                use_index: 'idx-name',
+              },
+            }),
+          )
+        })
+
+        await t.step('should reject the unparseable value', async () => {
+          await assertRejects(() =>
+            adapter.queryDocuments({
+              db: '123',
+              query: {
+                selector: { name: { $gt: 'mike' } },
+                fields: ['name'],
+                sort: ['ASC' as const],
+                // @ts-ignore
+                skip: 'wut',
+                use_index: 'idx-name',
+              },
+            })
+          )
+
+          await assertRejects(() =>
+            adapter.queryDocuments({
+              db: '123',
+              query: {
+                selector: { name: { $gt: 'mike' } },
+                fields: ['name'],
+                sort: ['ASC' as const],
+                // @ts-ignore
+                skip: [],
+                use_index: 'idx-name',
+              },
+            })
+          )
+        })
+      })
+
       await assertRejects(() =>
         adapter.queryDocuments({
           db: '123',
@@ -680,11 +767,11 @@ Deno.test('data', async (t) => {
       )
 
       await assertRejects(() =>
-        // @ts-ignore
         adapter.indexDocuments({
           db: 'foo',
           fields: ['name'],
           name: 'idx-name',
+          // @ts-ignore
           partialFilter: 123,
         })
       )

diff --git a/packages/port-data/port.ts b/packages/port-data/port.ts
@@ -111,6 +111,7 @@ export const port = z.object({
             .union([z.array(z.string()), z.array(z.record(SortEnum))])
             .optional(),
           limit: maybeNumber.optional(),
+          skip: maybeNumber.optional(),
           use_index: z.string().optional(),
         }),
       }),