fix: support number ID field generation in StubDatabaseAdapter (#43)

Author: wschurman

packages/entity/src/testfixtures/DateIDTestEntity.ts

@@ -0,0 +1,65 @@
+import Entity from '../Entity';
+import {
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
+  EntityCompanionDefinition,
+} from '../EntityCompanionProvider';
+import EntityConfiguration from '../EntityConfiguration';
+import { DateField } from '../EntityFields';
+import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
+import ViewerContext from '../ViewerContext';
+import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
+
+export type DateIDTestFields = {
+  id: Date;
+};
+
+export const dateIDTestEntityConfiguration = new EntityConfiguration<DateIDTestFields>({
+  idField: 'id',
+  tableName: 'simple_test_entity_should_not_write_to_db',
+  schema: {
+    id: new DateField({
+      columnName: 'custom_id',
+    }),
+  },
+});
+
+export class DateIDTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
+  DateIDTestFields,
+  Date,
+  ViewerContext,
+  DateIDTestEntity
+> {
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<DateIDTestFields, Date, ViewerContext, DateIDTestEntity>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<DateIDTestFields, Date, ViewerContext, DateIDTestEntity>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<DateIDTestFields, Date, ViewerContext, DateIDTestEntity>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<DateIDTestFields, Date, ViewerContext, DateIDTestEntity>(),
+  ];
+}
+
+export default class DateIDTestEntity extends Entity<DateIDTestFields, Date, ViewerContext> {
+  static getCompanionDefinition(): EntityCompanionDefinition<
+    DateIDTestFields,
+    Date,
+    ViewerContext,
+    DateIDTestEntity,
+    DateIDTestEntityPrivacyPolicy
+  > {
+    return dateIDTestEntityCompanion;
+  }
+}
+
+export const dateIDTestEntityCompanion = {
+  entityClass: DateIDTestEntity,
+  entityConfiguration: dateIDTestEntityConfiguration,
+  databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
+  cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
+  privacyPolicyClass: DateIDTestEntityPrivacyPolicy,
+};

packages/entity/src/testfixtures/TestEntityNumberKey.ts

@@ -0,0 +1,65 @@
+import Entity from '../Entity';
+import {
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
+  EntityCompanionDefinition,
+} from '../EntityCompanionProvider';
+import EntityConfiguration from '../EntityConfiguration';
+import { NumberField } from '../EntityFields';
+import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
+import ViewerContext from '../ViewerContext';
+import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
+
+export type NumberKeyFields = {
+  id: number;
+};
+
+export const numberKeyEntityConfiguration = new EntityConfiguration<NumberKeyFields>({
+  idField: 'id',
+  tableName: 'simple_test_entity_should_not_write_to_db',
+  schema: {
+    id: new NumberField({
+      columnName: 'custom_id',
+    }),
+  },
+});
+
+export class NumberKeyPrivacyPolicy extends EntityPrivacyPolicy<
+  NumberKeyFields,
+  number,
+  ViewerContext,
+  NumberKeyEntity
+> {
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<NumberKeyFields, number, ViewerContext, NumberKeyEntity>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<NumberKeyFields, number, ViewerContext, NumberKeyEntity>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<NumberKeyFields, number, ViewerContext, NumberKeyEntity>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<NumberKeyFields, number, ViewerContext, NumberKeyEntity>(),
+  ];
+}
+
+export default class NumberKeyEntity extends Entity<NumberKeyFields, number, ViewerContext> {
+  static getCompanionDefinition(): EntityCompanionDefinition<
+    NumberKeyFields,
+    number,
+    ViewerContext,
+    NumberKeyEntity,
+    NumberKeyPrivacyPolicy
+  > {
+    return numberKeyEntityCompanion;
+  }
+}
+
+export const numberKeyEntityCompanion = {
+  entityClass: NumberKeyEntity,
+  entityConfiguration: numberKeyEntityConfiguration,
+  databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
+  cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
+  privacyPolicyClass: NumberKeyPrivacyPolicy,
+};

packages/entity/src/utils/testing/StubDatabaseAdapter.ts

@@ -8,6 +8,7 @@ import EntityDatabaseAdapter, {
   TableQuerySelectionModifiers,
   OrderByOrdering,
 } from '../../EntityDatabaseAdapter';
+import { StringField, NumberField } from '../../EntityFields';
 import {
   getDatabaseFieldForEntityField,
   FieldTransformerMap,
@@ -127,6 +128,20 @@ export default class StubDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
     throw new Error('Raw WHERE clauses not supported for StubDatabaseAdapter');
   }
 
+  private generateRandomID(): any {
+    const idSchemaField = this.entityConfiguration2.schema.get(this.entityConfiguration2.idField);
+    invariant(idSchemaField, `No schema field found for ${this.entityConfiguration2.idField}`);
+    if (idSchemaField instanceof StringField) {
+      return uuidv4();
+    } else if (idSchemaField instanceof NumberField) {
+      return Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
+    } else {
+      throw new Error(
+        `Unsupported ID type for StubDatabaseAdapter: ${idSchemaField.constructor.name}`
+      );
+    }
+  }
+
   protected async insertInternalAsync(
     _queryInterface: any,
     _tableName: string,
@@ -137,7 +152,7 @@ export default class StubDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
       this.entityConfiguration2.idField
     );
     const objectToInsert = {
-      [idField]: uuidv4(),
+      [idField]: this.generateRandomID(),
       ...object,
     };
     this.objects.push(objectToInsert);

packages/entity/src/utils/testing/__tests__/StubDatabaseAdapter-test.ts

@@ -2,7 +2,19 @@ import { instance, mock } from 'ts-mockito';
 
 import { OrderByOrdering } from '../../../EntityDatabaseAdapter';
 import { EntityNonTransactionalQueryContext } from '../../../EntityQueryContext';
+import {
+  DateIDTestFields,
+  dateIDTestEntityConfiguration,
+} from '../../../testfixtures/DateIDTestEntity';
+import {
+  SimpleTestFields,
+  simpleTestEntityConfiguration,
+} from '../../../testfixtures/SimpleTestEntity';
 import { TestFields, testEntityConfiguration } from '../../../testfixtures/TestEntity';
+import {
+  NumberKeyFields,
+  numberKeyEntityConfiguration,
+} from '../../../testfixtures/TestEntityNumberKey';
 import StubDatabaseAdapter from '../StubDatabaseAdapter';
 
 describe(StubDatabaseAdapter, () => {
@@ -206,4 +218,24 @@ describe(StubDatabaseAdapter, () => {
       expect(databaseAdapter.getAllObjectsForTest()).toHaveLength(0);
     });
   });
+
+  it('supports string and number IDs', async () => {
+    const queryContext = instance(mock(EntityNonTransactionalQueryContext));
+    const databaseAdapter1 = new StubDatabaseAdapter<SimpleTestFields>(
+      simpleTestEntityConfiguration
+    );
+    const insertedObject1 = await databaseAdapter1.insertAsync(queryContext, {});
+    expect(typeof insertedObject1.id).toBe('string');
+
+    const databaseAdapter2 = new StubDatabaseAdapter<NumberKeyFields>(numberKeyEntityConfiguration);
+    const insertedObject2 = await databaseAdapter2.insertAsync(queryContext, {});
+    expect(typeof insertedObject2.id).toBe('number');
+
+    const databaseAdapter3 = new StubDatabaseAdapter<DateIDTestFields>(
+      dateIDTestEntityConfiguration
+    );
+    await expect(databaseAdapter3.insertAsync(queryContext, {})).rejects.toThrowError(
+      'Unsupported ID type for StubDatabaseAdapter: DateField'
+    );
+  });
 });