@expo/entity 0.34.0 → 0.36.0

package/src/utils/testing/__tests__/StubDatabaseAdapter-test.ts

@@ -47,8 +47,8 @@ describe(StubDatabaseAdapter, () => {
                 },
               ],
             ],
-          ])
-        )
+          ]),
+        ),
       );
 
       const results = await databaseAdapter.fetchManyWhereAsync(queryContext, 'stringField', [
@@ -95,8 +95,8 @@ describe(StubDatabaseAdapter, () => {
                 },
               ],
             ],
-          ])
-        )
+          ]),
+        ),
       );
 
       const results = await databaseAdapter.fetchManyByFieldEqualityConjunctionAsync(
@@ -120,7 +120,7 @@ describe(StubDatabaseAdapter, () => {
               order: OrderByOrdering.DESCENDING,
             },
           ],
-        }
+        },
       );
 
       expect(results).toHaveLength(2);
@@ -163,8 +163,8 @@ describe(StubDatabaseAdapter, () => {
                 },
               ],
             ],
-          ])
-        )
+          ]),
+        ),
       );
 
       const results = await databaseAdapter.fetchManyByFieldEqualityConjunctionAsync(
@@ -186,7 +186,7 @@ describe(StubDatabaseAdapter, () => {
               order: OrderByOrdering.DESCENDING,
             },
           ],
-        }
+        },
       );
 
       expect(results).toHaveLength(3);
@@ -237,14 +237,14 @@ describe(StubDatabaseAdapter, () => {
                 },
               ],
             ],
-          ])
-        )
+          ]),
+        ),
       );
 
       const results = await databaseAdapter.fetchManyByFieldEqualityConjunctionAsync(
         queryContext,
         [{ fieldName: 'nullableField', fieldValue: null }],
-        {}
+        {},
       );
       expect(results).toHaveLength(2);
       expect(results[0]!.nullableField).toBeNull();
@@ -262,7 +262,7 @@ describe(StubDatabaseAdapter, () => {
               order: OrderByOrdering.DESCENDING,
             },
           ],
-        }
+        },
       );
       expect(results2).toHaveLength(2);
       expect(results2.map((e) => e.nullableField)).toEqual([null, 'a']);
@@ -274,10 +274,10 @@ describe(StubDatabaseAdapter, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const databaseAdapter = new StubDatabaseAdapter<TestFields>(
         testEntityConfiguration,
-        new Map()
+        new Map(),
       );
       await expect(
-        databaseAdapter.fetchManyByRawWhereClauseAsync(queryContext, '', [], {})
+        databaseAdapter.fetchManyByRawWhereClauseAsync(queryContext, '', [], {}),
       ).rejects.toThrow();
     });
   });
@@ -287,7 +287,7 @@ describe(StubDatabaseAdapter, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const databaseAdapter = new StubDatabaseAdapter<TestFields>(
         testEntityConfiguration,
-        new Map()
+        new Map(),
       );
       const result = await databaseAdapter.insertAsync(queryContext, {
         stringField: 'hello',
@@ -297,9 +297,29 @@ describe(StubDatabaseAdapter, () => {
       });
 
       expect(
-        databaseAdapter.getObjectCollectionForTable(testEntityConfiguration.tableName)
+        databaseAdapter.getObjectCollectionForTable(testEntityConfiguration.tableName),
       ).toHaveLength(1);
     });
+
+    it('inserts a record with valid v7 id', async () => {
+      const expectedTime = new Date('2024-06-03T20:16:33.761Z');
+
+      jest.useFakeTimers({
+        now: expectedTime,
+      });
+
+      const queryContext = instance(mock(EntityQueryContext));
+      const databaseAdapter = new StubDatabaseAdapter<TestFields>(
+        testEntityConfiguration,
+        new Map(),
+      );
+      const result = await databaseAdapter.insertAsync(queryContext, {
+        stringField: 'hello',
+      });
+
+      const ts = getTimeFromUUIDv7(result.customIdField);
+      expect(ts).toEqual(expectedTime);
+    });
   });
 
   describe('updateAsync', () => {
@@ -323,8 +343,8 @@ describe(StubDatabaseAdapter, () => {
                 },
               ],
             ],
-          ])
-        )
+          ]),
+        ),
       );
       const result = await databaseAdapter.updateAsync(queryContext, 'customIdField', 'hello', {
         stringField: 'b',
@@ -334,6 +354,34 @@ describe(StubDatabaseAdapter, () => {
         testIndexedField: 'h1',
       });
     });
+
+    it('throws error when empty update to match common DBMS behavior', async () => {
+      const queryContext = instance(mock(EntityQueryContext));
+      const databaseAdapter = new StubDatabaseAdapter<TestFields>(
+        testEntityConfiguration,
+        StubDatabaseAdapter.convertFieldObjectsToDataStore(
+          testEntityConfiguration,
+          new Map([
+            [
+              testEntityConfiguration.tableName,
+              [
+                {
+                  customIdField: 'hello',
+                  testIndexedField: 'h1',
+                  intField: 3,
+                  stringField: 'a',
+                  dateField: new Date(),
+                  nullableField: null,
+                },
+              ],
+            ],
+          ]),
+        ),
+      );
+      await expect(
+        databaseAdapter.updateAsync(queryContext, 'customIdField', 'hello', {}),
+      ).rejects.toThrowError(`Empty update (custom_id = hello)`);
+    });
   });
 
   describe('deleteAsync', () => {
@@ -357,14 +405,14 @@ describe(StubDatabaseAdapter, () => {
                 },
               ],
             ],
-          ])
-        )
+          ]),
+        ),
       );
 
       await databaseAdapter.deleteAsync(queryContext, 'customIdField', 'hello');
 
       expect(
-        databaseAdapter.getObjectCollectionForTable(testEntityConfiguration.tableName)
+        databaseAdapter.getObjectCollectionForTable(testEntityConfiguration.tableName),
       ).toHaveLength(0);
     });
   });
@@ -373,24 +421,24 @@ describe(StubDatabaseAdapter, () => {
     const queryContext = instance(mock(EntityQueryContext));
     const databaseAdapter1 = new StubDatabaseAdapter<SimpleTestFields>(
       simpleTestEntityConfiguration,
-      new Map()
+      new Map(),
     );
     const insertedObject1 = await databaseAdapter1.insertAsync(queryContext, {});
     expect(typeof insertedObject1.id).toBe('string');
 
     const databaseAdapter2 = new StubDatabaseAdapter<NumberKeyFields>(
       numberKeyEntityConfiguration,
-      new Map()
+      new Map(),
     );
     const insertedObject2 = await databaseAdapter2.insertAsync(queryContext, {});
     expect(typeof insertedObject2.id).toBe('number');
 
     const databaseAdapter3 = new StubDatabaseAdapter<DateIDTestFields>(
       dateIDTestEntityConfiguration,
-      new Map()
+      new Map(),
     );
     await expect(databaseAdapter3.insertAsync(queryContext, {})).rejects.toThrowError(
-      'Unsupported ID type for StubDatabaseAdapter: DateField'
+      'Unsupported ID type for StubDatabaseAdapter: DateField',
     );
   });
 
@@ -432,10 +480,24 @@ describe(StubDatabaseAdapter, () => {
             },
             {
               hello: v2,
-            }
-          )
+            },
+          ),
         ).toEqual(expectedResult);
       });
+
+      it('works for empty', () => {
+        expect(
+          StubDatabaseAdapter['compareByOrderBys'](
+            [],
+            {
+              hello: 'test',
+            },
+            {
+              hello: 'blah',
+            },
+          ),
+        ).toEqual(0);
+      });
     });
 
     describe('recursing', () => {
@@ -458,9 +520,29 @@ describe(StubDatabaseAdapter, () => {
           {
             hello: 'a',
             world: 2,
-          }
-        )
+          },
+        ),
       ).toEqual(-1);
     });
   });
 });
+
+const UUIDV7_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
+
+/**
+ * Returns the Date object encoded in the first 48 bits of the given UUIDv7.
+ * @throws TypeError if the UUID is not version 7
+ */
+function getTimeFromUUIDv7(uuid: string): Date {
+  if (!UUIDV7_REGEX.test(uuid)) {
+    throw new TypeError(`UUID must be version 7 to get its timestamp`);
+  }
+
+  // The first 48 bits = 12 hex characters of the UUID encode the timestamp in big endian
+  const hexCharacters = uuid.replaceAll('-', '').split('', 12);
+  const milliseconds = hexCharacters.reduce(
+    (milliseconds, character) => milliseconds * 16 + parseInt(character, 16),
+    0,
+  );
+  return new Date(milliseconds);
+}

package/src/utils/testing/createUnitTestEntityCompanionProvider.ts

@@ -10,7 +10,7 @@ import NoOpEntityMetricsAdapter from '../../metrics/NoOpEntityMetricsAdapter';
  * are replaced with in-memory simulations.
  */
 export const createUnitTestEntityCompanionProvider = (
-  metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
+  metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
@@ -30,6 +30,6 @@ export const createUnitTestEntityCompanionProvider = (
           cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
         },
       ],
-    ])
+    ]),
   );
 };

package/src/utils/testing/describeFieldTestCase.ts

@@ -3,7 +3,7 @@ import { EntityFieldDefinition } from '../../EntityFieldDefinition';
 export default function describeFieldTestCase<T>(
   fieldDefinition: EntityFieldDefinition<T>,
   validValues: T[],
-  invalidValues: any[]
+  invalidValues: any[],
 ): void {
   describe(fieldDefinition.constructor.name, () => {
     if (validValues.length > 0) {

package/build/__tests__/EntityDataConfiguration-test.js

@@ -1,68 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const EntityConfiguration_1 = __importDefault(require("../EntityConfiguration"));
-const EntityFields_1 = require("../EntityFields");
-describe(EntityConfiguration_1.default, () => {
-    const blahEntityConfiguration = new EntityConfiguration_1.default({
-        idField: 'id',
-        tableName: 'blah_table',
-        schema: {
-            id: new EntityFields_1.UUIDField({
-                columnName: 'id',
-            }),
-            cacheable: new EntityFields_1.StringField({
-                columnName: 'cacheable',
-                cache: true,
-            }),
-            uniqueButNotCacheable: new EntityFields_1.StringField({
-                columnName: 'unique_but_not_cacheable',
-            }),
-        },
-        databaseAdapterFlavor: 'postgres',
-        cacheAdapterFlavor: 'redis',
-    });
-    it('returns correct fields', () => {
-        expect(blahEntityConfiguration.idField).toEqual('id');
-        expect(blahEntityConfiguration.tableName).toEqual('blah_table');
-        expect(blahEntityConfiguration.databaseAdapterFlavor).toEqual('postgres');
-        expect(blahEntityConfiguration.cacheAdapterFlavor).toEqual('redis');
-    });
-    it('filters cacheable fields', () => {
-        expect(blahEntityConfiguration.cacheableKeys).toEqual(new Set(['cacheable']));
-    });
-    describe('cache key version', () => {
-        it('defaults to 0', () => {
-            const entityConfiguration = new EntityConfiguration_1.default({
-                idField: 'id',
-                tableName: 'blah',
-                schema: {
-                    id: new EntityFields_1.UUIDField({
-                        columnName: 'id',
-                    }),
-                },
-                databaseAdapterFlavor: 'postgres',
-                cacheAdapterFlavor: 'redis',
-            });
-            expect(entityConfiguration.cacheKeyVersion).toEqual(0);
-        });
-        it('sets to custom version', () => {
-            const entityConfiguration = new EntityConfiguration_1.default({
-                idField: 'id',
-                tableName: 'blah',
-                schema: {
-                    id: new EntityFields_1.UUIDField({
-                        columnName: 'id',
-                    }),
-                },
-                databaseAdapterFlavor: 'postgres',
-                cacheAdapterFlavor: 'redis',
-                cacheKeyVersion: 100,
-            });
-            expect(entityConfiguration.cacheKeyVersion).toEqual(100);
-        });
-    });
-});
-//# sourceMappingURL=EntityDataConfiguration-test.js.map

package/build/__tests__/EntityDataConfiguration-test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EntityDataConfiguration-test.js","sourceRoot":"","sources":["../../src/__tests__/EntityDataConfiguration-test.ts"],"names":[],"mappings":";;;;;AAAA,iFAAyD;AACzD,kDAAyD;AAEzD,QAAQ,CAAC,6BAAmB,EAAE,GAAG,EAAE;IAWjC,MAAM,uBAAuB,GAAG,IAAI,6BAAmB,CAAQ;QAC7D,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,YAAY;QACvB,MAAM,EAAE;YACN,EAAE,EAAE,IAAI,wBAAS,CAAC;gBAChB,UAAU,EAAE,IAAI;aACjB,CAAC;YACF,SAAS,EAAE,IAAI,0BAAW,CAAC;gBACzB,UAAU,EAAE,WAAW;gBACvB,KAAK,EAAE,IAAI;aACZ,CAAC;YACF,qBAAqB,EAAE,IAAI,0BAAW,CAAC;gBACrC,UAAU,EAAE,0BAA0B;aACvC,CAAC;SACH;QACD,qBAAqB,EAAE,UAAU;QACjC,kBAAkB,EAAE,OAAO;KAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtD,MAAM,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1E,MAAM,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACvB,MAAM,mBAAmB,GAAG,IAAI,6BAAmB,CAAS;gBAC1D,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE,MAAM;gBACjB,MAAM,EAAE;oBACN,EAAE,EAAE,IAAI,wBAAS,CAAC;wBAChB,UAAU,EAAE,IAAI;qBACjB,CAAC;iBACH;gBACD,qBAAqB,EAAE,UAAU;gBACjC,kBAAkB,EAAE,OAAO;aAC5B,CAAC,CAAC;YACH,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;YAChC,MAAM,mBAAmB,GAAG,IAAI,6BAAmB,CAAS;gBAC1D,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE,MAAM;gBACjB,MAAM,EAAE;oBACN,EAAE,EAAE,IAAI,wBAAS,CAAC;wBAChB,UAAU,EAAE,IAAI;qBACjB,CAAC;iBACH;gBACD,qBAAqB,EAAE,UAAU;gBACjC,kBAAkB,EAAE,OAAO;gBAC3B,eAAe,EAAE,GAAG;aACrB,CAAC,CAAC;YACH,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/src/__tests__/EntityDataConfiguration-test.ts

@@ -1,77 +0,0 @@
-import EntityConfiguration from '../EntityConfiguration';
-import { UUIDField, StringField } from '../EntityFields';
-
-describe(EntityConfiguration, () => {
-  type BlahT = {
-    id: string;
-    cacheable: string;
-    uniqueButNotCacheable: string;
-  };
-
-  type Blah2T = {
-    id: string;
-  };
-
-  const blahEntityConfiguration = new EntityConfiguration<BlahT>({
-    idField: 'id',
-    tableName: 'blah_table',
-    schema: {
-      id: new UUIDField({
-        columnName: 'id',
-      }),
-      cacheable: new StringField({
-        columnName: 'cacheable',
-        cache: true,
-      }),
-      uniqueButNotCacheable: new StringField({
-        columnName: 'unique_but_not_cacheable',
-      }),
-    },
-    databaseAdapterFlavor: 'postgres',
-    cacheAdapterFlavor: 'redis',
-  });
-
-  it('returns correct fields', () => {
-    expect(blahEntityConfiguration.idField).toEqual('id');
-    expect(blahEntityConfiguration.tableName).toEqual('blah_table');
-    expect(blahEntityConfiguration.databaseAdapterFlavor).toEqual('postgres');
-    expect(blahEntityConfiguration.cacheAdapterFlavor).toEqual('redis');
-  });
-
-  it('filters cacheable fields', () => {
-    expect(blahEntityConfiguration.cacheableKeys).toEqual(new Set(['cacheable']));
-  });
-
-  describe('cache key version', () => {
-    it('defaults to 0', () => {
-      const entityConfiguration = new EntityConfiguration<Blah2T>({
-        idField: 'id',
-        tableName: 'blah',
-        schema: {
-          id: new UUIDField({
-            columnName: 'id',
-          }),
-        },
-        databaseAdapterFlavor: 'postgres',
-        cacheAdapterFlavor: 'redis',
-      });
-      expect(entityConfiguration.cacheKeyVersion).toEqual(0);
-    });
-
-    it('sets to custom version', () => {
-      const entityConfiguration = new EntityConfiguration<Blah2T>({
-        idField: 'id',
-        tableName: 'blah',
-        schema: {
-          id: new UUIDField({
-            columnName: 'id',
-          }),
-        },
-        databaseAdapterFlavor: 'postgres',
-        cacheAdapterFlavor: 'redis',
-        cacheKeyVersion: 100,
-      });
-      expect(entityConfiguration.cacheKeyVersion).toEqual(100);
-    });
-  });
-});