datastore-api 6.3.0 → 6.4.0

package/README.md

@@ -23,7 +23,7 @@ Main differences:
 - [allocateOneId](http://mdornseif.io/datastore-api/classes/Dstore.html#allocateOneId) returns a single numeric string encoded unique datastore id without the need of fancy unpacking.
 - [runInTransaction](http://mdornseif.io/datastore-api/classes/Dstore.html#runInTransaction) allows you to provide a function to be executed inside an transaction without the need of passing around the transaction object. This is modelled after Python 2.7 [ndb's `@ndb.transactional` feature](https://cloud.google.com/appengine/docs/standard/python/ndb/transactions). This is implemented via node's [AsyncLocalStorage](https://nodejs.org/docs/latest-v14.x/api/async_hooks.html).
 - [keySerialize](http://mdornseif.io/datastore-api/classes/Dstore.html#keySerialize) is synchronous. 🦄
-- [iterate] allows for async iteration of (larege) queries.
+- [iterate] allows for async iteration of (large) queries. [list] has the same API but generates an array.
 - Starting your code with the environment variable `DEBUG='ds:api'` allows you to trace API calls.
 
 Find the full documentation [here](https://mdornseif.github.io/datastore-api/classes/Dstore.html). In there also some of the idiosyncrasies of using the Datastore are explained.

package/package.json

@@ -54,7 +54,6 @@
     "nyc": "^15.1.0",
     "open-cli": "8.0.0",
     "prettier": "^3.2.5",
-    "sort-package-json": "^2.8.0",
     "standard-version": "^9.5.0",
     "ts-essentials": "9.4.1",
     "ts-node": "^10.9.2",
@@ -71,24 +70,11 @@
     "src"
   ],
   "homepage": "https://forge.23.nu/md/datastore-api",
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
   "keywords": [
     "datastore",
     "google cloud"
   ],
   "license": "MIT",
-  "lint-staged": {
-    "*{css,scss,md,markdown,json,yaml,yml,graphql,html}": "npx prettier -w",
-    "*{js,jsx,ts,tsx}": [
-      "npx prettier -w",
-      "npm run lint --fix"
-    ],
-    "package.json": "sort-package-json"
-  },
   "main": "dist/index.js",
   "module": "dist/datastore-api2.esm.js",
   "name": "datastore-api",
@@ -122,5 +108,5 @@
     "update": "npx npm-check-updates --interactive"
   },
   "typings": "dist/index.d.ts",
-  "version": "6.3.0"
+  "version": "6.4.0"
 }

package/src/lib/dstore-api-cloud.spec.ts

@@ -6,14 +6,28 @@
  */
 // @ts-nocheck
 import { Datastore, Key } from '@google-cloud/datastore'
-import { assert, describe, expect, test } from 'vitest'
+import { beforeAll, assert, describe, expect, test } from 'vitest'
 
 import { Dstore } from './dstore-api'
+let entity, saveResult
 
 function getDstore() {
   return new Dstore(new Datastore({ namespace: 'test', projectId: 'hdmashup-hrd' }))
 }
 
+beforeAll(async () => {
+  // Data for the query tests
+  const kvStore = getDstore()
+  entity = {
+    key: kvStore.key(['testYodel', '3']),
+    data: { foo: 'bar', baz: 'baz' },
+  }
+
+  saveResult = await kvStore.save([entity])
+  // Give Datastore time to become consistent
+  do { } while ((await kvStore.get(entity.key)) === null)
+})
+
 test('keySerialize', async () => {
   const kvStore = getDstore()
   assert.deepEqual(kvStore.key(['testYodel', 123]).path, ['testYodel', 123])
@@ -37,6 +51,29 @@ test('keySerialize', async () => {
     }
   `)
 })
+test('keyFromLegacyUrlsafe', async () => {
+  const kvStore = getDstore()
+  const ser = await kvStore.datastore.keyToLegacyUrlSafe(kvStore.key(['testYodel', 123]))
+  expect(ser).toMatchInlineSnapshot(`
+    [
+      "agxoZG1hc2h1cC1ocmRyDwsSCXRlc3RZb2RlbBh7DKIBBHRlc3Q",
+    ]
+  `)
+
+  const key = kvStore.datastore.keyFromLegacyUrlsafe(ser[0])
+  expect(key).toMatchInlineSnapshot(`
+    Key {
+      "id": "123",
+      "kind": "testYodel",
+      "namespace": "test",
+      "path": [
+        "testYodel",
+        "123",
+      ],
+    }
+  `)
+  expect(kvStore.datastore.isKey(key)).toBeTruthy()
+})
 
 describe('Allocation', () => {
   test('allocateIds', async () => {
@@ -160,29 +197,77 @@ describe('Read', () => {
     // expect(Array.isArray(result)).toBeTruthy();
     expect(result6).toMatchInlineSnapshot('[]')
   })
+
+  test('get name', async (t) => {
+    const kvStore = getDstore()
+    const entity = {
+      key: kvStore.key(['testYodel', 'two']),
+      data: { foo: 'bar' },
+    }
+    await kvStore.save([entity])
+    const result = await kvStore.get(entity.key)
+    expect(result?._keyStr).toMatchInlineSnapshot('"agByEgsSCXRlc3RZb2RlbCIDdHdvDKIBBHRlc3Q"')
+    expect(result?.foo).toBe('bar')
+  })
 })
 
-test('get name', async (t) => {
+describe('queryies', async () => {
   const kvStore = getDstore()
   const entity = {
-    key: kvStore.key(['testYodel', 'two']),
-    data: { foo: 'bar' },
+    key: kvStore.key(['testYodel', '3']),
+    data: { foo: 'bar', baz: 'baz' },
   }
-  await kvStore.save([entity])
-  const result = await kvStore.get(entity.key)
-  expect(result?._keyStr).toMatchInlineSnapshot('"agByEgsSCXRlc3RZb2RlbCIDdHdvDKIBBHRlc3Q"')
-  expect(result?.foo).toBe('bar')
-})
 
-describe('query', async () => {
-  test('raw', async () => {
-    const kvStore = getDstore()
-    const entity = {
-      key: kvStore.key(['testYodel', '3']),
-      data: { foo: 'bar', baz: 'baz' },
+  const saveResult = await kvStore.save([entity])
+  // Give Datastore time to become consistent
+  do { } while ((await kvStore.get(entity.key)) === null)
+
+  test('sanity check', async () => {
+    expect(saveResult).toMatchInlineSnapshot(`
+      [
+        {
+          "commitTime": null,
+          "indexUpdates": 0,
+          "mutationResults": [
+            {
+              "conflictDetected": false,
+              "createTime": {
+                "nanos": 706047000,
+                "seconds": "1688123436",
+              },
+              "key": null,
+              "updateTime": {
+                "nanos": 706047000,
+                "seconds": "1688123436",
+              },
+              "version": "1688123436706047",
+            },
+          ],
+        },
+      ]
+    `)
+
+    expect(await kvStore.get(entity.key)).toMatchInlineSnapshot(`
+    {
+      "_keyStr": "agByEAsSCXRlc3RZb2RlbCIBMwyiAQR0ZXN0",
+      "baz": "baz",
+      "foo": "bar",
+      Symbol(KEY): Key {
+        "kind": "testYodel",
+        "name": "3",
+        "namespace": "test",
+        "path": [
+          "testYodel",
+          "3",
+        ],
+      },
     }
+  `)
+  })
 
-    await kvStore.save([entity])
+
+  test('raw', async () => {
+    const kvStore = getDstore()
     const query = kvStore.datastore.createQuery('testYodel')
     query.limit(1)
     const [entities, runQueryInfo] = await kvStore.datastore.runQuery(query)
@@ -205,58 +290,7 @@ describe('query', async () => {
     `)
   })
 
-  test('query', async () => {
-    const kvStore = getDstore()
-    const entity = {
-      key: kvStore.key(['testYodel', '3']),
-      data: { foo: 'bar', baz: 'baz' },
-    }
-
-    const saveResult = await kvStore.save([entity])
-    expect(saveResult?.[0]?.mutationResults?.key).toMatchInlineSnapshot('undefined')
-
-    // expect(saveResult).toMatchInlineSnapshot(`
-    //   [
-    //     {
-    //       "commitTime": null,
-    //       "indexUpdates": 0,
-    //       "mutationResults": [
-    //         {
-    //           "conflictDetected": false,
-    //           "createTime": {
-    //             "nanos": 706047000,
-    //             "seconds": "1688123436",
-    //           },
-    //           "key": null,
-    //           "updateTime": {
-    //             "nanos": 706047000,
-    //             "seconds": "1688123436",
-    //           },
-    //           "version": "1688123436706047",
-    //         },
-    //       ],
-    //     },
-    //   ]
-    // `)
-    expect(await kvStore.get(entity.key)).toMatchInlineSnapshot(`
-      {
-        "_keyStr": "agByEAsSCXRlc3RZb2RlbCIBMwyiAQR0ZXN0",
-        "baz": "baz",
-        "foo": "bar",
-        Symbol(KEY): Key {
-          "kind": "testYodel",
-          "name": "3",
-          "namespace": "test",
-          "path": [
-            "testYodel",
-            "3",
-          ],
-        },
-      }
-    `)
-    // Give Datastore time to become consistent
-    do { } while ((await kvStore.get(entity.key)) === null)
-
+  test('runQuery', async () => {
     const query = kvStore.createQuery('testYodel')
     query.limit(1)
     const [entities, runQueryInfo] = await kvStore.runQuery(query)
@@ -287,7 +321,9 @@ describe('query', async () => {
     expect(entities?.[0]?.foo).toBe('bar')
     expect(entities?.[0]?.[Datastore.KEY]?.kind).toBe('testYodel')
     expect(runQueryInfo?.moreResults).toBe('MORE_RESULTS_AFTER_LIMIT')
+  })
 
+  test('query', async () => {
     // modern interface
     const [result2] = await kvStore.query('testYodel', [], 1, [], ['baz'])
     expect(result2.length).toBe(1)
@@ -302,6 +338,49 @@ describe('query', async () => {
     const key = kvStore.readKey(result2?.[0])
     expect(key.id).toBe(entity.key.id)
   })
+
+  test('iterate', async () => {
+    const result = await kvStore.iterate({ kindName: 'testYodel', limit: 1 })
+    for await (const entity of result) {
+      expect(entity).toMatchInlineSnapshot(`
+        {
+          "_keyStr": "agByDwsSCXRlc3RZb2RlbBgCDKIBBHRlc3Q",
+          "foo": "bar",
+          Symbol(KEY): Key {
+            "id": "2",
+            "kind": "testYodel",
+            "namespace": "test",
+            "path": [
+              "testYodel",
+              "2",
+            ],
+          },
+        }
+      `)
+    }
+  })
+
+  test('list', async () => {
+    const kvStore = getDstore()
+    const result = await kvStore.list({ kindName: 'testYodel', limit: 1 })
+    expect(result).toMatchInlineSnapshot(`
+      [
+        {
+          "_keyStr": "agByDwsSCXRlc3RZb2RlbBgCDKIBBHRlc3Q",
+          "foo": "bar",
+          Symbol(KEY): Key {
+            "id": "2",
+            "kind": "testYodel",
+            "namespace": "test",
+            "path": [
+              "testYodel",
+              "2",
+            ],
+          },
+        },
+      ]
+    `)
+  })
 })
 
 test('set', async () => {