fix(datastore.ts): ensure entities with id based keys are correcly loaded from cache

All entities which have id based keys now return those ids and their paths as numbers. If you rely
on the id being a string you will need to update your code.

BREAKING CHANGE: Entity keys return ids as Number

fix #243

Author: carnun

__tests__/integration/cache.ts

@@ -27,6 +27,7 @@ const gstore = new Gstore({
 gstore.connect(ds);
 
 const uniqueId = (): string => chance.string({ pool: 'abcdefghijklmnopqrstuvwxyz0123456789' });
+const uniqueNumericId = (): number => Number(`4${chance.string({ numeric: true, length: 15 })}`);
 
 const cleanUp = (cb: any): void => {
   ((ds.delete(allKeys) as unknown) as Promise<any>).then(cb);
@@ -101,8 +102,8 @@ describe('Integration Tests (Cache)', () => {
   });
 
   test('should load already cached entities with correct datastore entity keys', async () => {
-    const id1 = uniqueId();
-    const id2 = uniqueId();
+    const id1 = uniqueNumericId();
+    const id2 = uniqueNumericId();
 
     const user1 = new MyModel({ email: '[email protected]' }, id1);
     const user2 = new MyModel({ email: '[email protected]' }, id2);
@@ -115,12 +116,14 @@ describe('Integration Tests (Cache)', () => {
 
     responseMultiple0.entities.forEach((entry) => {
       expect(ds.isKey(entry?.entityKey)).to.equal(true);
+      expect(typeof entry?.entityKey.id).to.equal('number');
     });
 
     const responseMultiple1 = await MyModel.list({ format: 'ENTITY', order: { property: 'email', descending: false } });
 
     responseMultiple1.entities.forEach((entry) => {
       expect(ds.isKey(entry?.entityKey)).to.equal(true);
+      expect(typeof entry?.entityKey.id).to.equal('number');
     });
   });
 

src/serializers/datastore.ts

@@ -60,8 +60,25 @@ const fromDatastore = <F extends 'JSON' | 'ENTITY' = 'JSON', R = F extends 'ENTI
   options: { format?: F; readAll?: boolean; showKey?: boolean } = {},
 ): R => {
   const getEntityKey = (): EntityKey => {
-    const keyData = entityData[Model.gstore.ds.KEY as any];
-    return Model.gstore.ds.isKey(keyData) ? (keyData as EntityKey) : Model.gstore.ds.key({ ...keyData });
+    let keyData = entityData[Model.gstore.ds.KEY as any];
+    // datastore can return id as a string however we need to ensure that the path
+    // is correctly a number in order to return the correct entity key
+    if (keyData.id && typeof keyData.id !== 'number') {
+      const path = [...keyData.path];
+      const id = Number(path.pop());
+      // if id is still not a number then we ignore since it is either really a string or another non-number type
+      if (!isNaN(id)) {
+        keyData = {
+          ...keyData,
+          id,
+          path: [...path, Number(id)],
+        };
+      }
+    }
+    if (Model.gstore.ds.isKey(keyData)) {
+      return keyData;
+    }
+    return Model.gstore.ds.key(keyData);
   };
 
   const convertToJson = (): GenericObject => {