@expo/entity 0.31.1 → 0.32.0

package/src/__tests__/Entity-test.ts

@@ -26,7 +26,12 @@ describe(Entity, () => {
       const data = {
         id: 'what',
       };
-      const testEntity = new SimpleTestEntity(viewerContext, data);
+      const testEntity = new SimpleTestEntity({
+        viewerContext,
+        id: 'what',
+        databaseFields: data,
+        selectedFields: data,
+      });
       expect(SimpleTestEntity.updater(testEntity)).toBeInstanceOf(UpdateMutator);
     });
   });
@@ -38,7 +43,12 @@ describe(Entity, () => {
       const data = {
         id: 'what',
       };
-      const testEntity = new SimpleTestDenyDeleteEntity(viewerContext, data);
+      const testEntity = new SimpleTestDenyDeleteEntity({
+        viewerContext,
+        id: 'what',
+        databaseFields: data,
+        selectedFields: data,
+      });
       const canViewerUpdate = await SimpleTestDenyDeleteEntity.canViewerUpdateAsync(testEntity);
       expect(canViewerUpdate).toBe(true);
     });
@@ -49,7 +59,12 @@ describe(Entity, () => {
       const data = {
         id: 'what',
       };
-      const testEntity = new SimpleTestDenyUpdateEntity(viewerContext, data);
+      const testEntity = new SimpleTestDenyUpdateEntity({
+        viewerContext,
+        id: 'what',
+        databaseFields: data,
+        selectedFields: data,
+      });
       const canViewerUpdate = await SimpleTestDenyUpdateEntity.canViewerUpdateAsync(testEntity);
       expect(canViewerUpdate).toBe(false);
     });
@@ -62,7 +77,12 @@ describe(Entity, () => {
       const data = {
         id: 'what',
       };
-      const testEntity = new SimpleTestDenyUpdateEntity(viewerContext, data);
+      const testEntity = new SimpleTestDenyUpdateEntity({
+        viewerContext,
+        id: 'what',
+        databaseFields: data,
+        selectedFields: data,
+      });
       const canViewerDelete = await SimpleTestDenyUpdateEntity.canViewerDeleteAsync(testEntity);
       expect(canViewerDelete).toBe(true);
     });
@@ -73,7 +93,12 @@ describe(Entity, () => {
       const data = {
         id: 'what',
       };
-      const testEntity = new SimpleTestDenyDeleteEntity(viewerContext, data);
+      const testEntity = new SimpleTestDenyDeleteEntity({
+        viewerContext,
+        id: 'what',
+        databaseFields: data,
+        selectedFields: data,
+      });
       const canViewerDelete = await SimpleTestDenyDeleteEntity.canViewerDeleteAsync(testEntity);
       expect(canViewerDelete).toBe(false);
     });
@@ -177,37 +202,33 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
 }
 
 class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     TestEntityFields,
     string,
     ViewerContext,
     SimpleTestDenyUpdateEntity,
     SimpleTestDenyUpdateEntityPrivacyPolicy
   > {
-    return simpleTestDenyUpdateEntityCompanion;
+    return {
+      entityClass: SimpleTestDenyUpdateEntity,
+      entityConfiguration: testEntityConfiguration,
+      privacyPolicyClass: SimpleTestDenyUpdateEntityPrivacyPolicy,
+    };
   }
 }
 
-const simpleTestDenyUpdateEntityCompanion = new EntityCompanionDefinition({
-  entityClass: SimpleTestDenyUpdateEntity,
-  entityConfiguration: testEntityConfiguration,
-  privacyPolicyClass: SimpleTestDenyUpdateEntityPrivacyPolicy,
-});
-
 class SimpleTestDenyDeleteEntity extends Entity<TestEntityFields, string, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     TestEntityFields,
     string,
     ViewerContext,
     SimpleTestDenyDeleteEntity,
     SimpleTestDenyDeleteEntityPrivacyPolicy
   > {
-    return simpleTestDenyDeleteEntityCompanion;
+    return {
+      entityClass: SimpleTestDenyDeleteEntity,
+      entityConfiguration: testEntityConfiguration,
+      privacyPolicyClass: SimpleTestDenyDeleteEntityPrivacyPolicy,
+    };
   }
 }
-
-const simpleTestDenyDeleteEntityCompanion = new EntityCompanionDefinition({
-  entityClass: SimpleTestDenyDeleteEntity,
-  entityConfiguration: testEntityConfiguration,
-  privacyPolicyClass: SimpleTestDenyDeleteEntityPrivacyPolicy,
-});

package/src/__tests__/EntityCommonUseCases-test.ts

@@ -31,14 +31,32 @@ type BlahFields = {
 };
 
 class BlahEntity extends Entity<BlahFields, string, TestUserViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     BlahFields,
     string,
     TestUserViewerContext,
     BlahEntity,
     BlahEntityPrivacyPolicy
   > {
-    return blahCompanion;
+    return {
+      entityClass: BlahEntity,
+      entityConfiguration: new EntityConfiguration<BlahFields>({
+        idField: 'id',
+        tableName: 'blah_table',
+        schema: {
+          id: new UUIDField({
+            columnName: 'id',
+            cache: true,
+          }),
+          ownerID: new UUIDField({
+            columnName: 'owner_id',
+          }),
+        },
+        databaseAdapterFlavor: 'postgres',
+        cacheAdapterFlavor: 'redis',
+      }),
+      privacyPolicyClass: BlahEntityPrivacyPolicy,
+    };
   }
 }
 
@@ -84,26 +102,6 @@ class BlahEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ];
 }
 
-const blahCompanion = new EntityCompanionDefinition({
-  entityClass: BlahEntity,
-  entityConfiguration: new EntityConfiguration<BlahFields>({
-    idField: 'id',
-    tableName: 'blah_table',
-    schema: {
-      id: new UUIDField({
-        columnName: 'id',
-        cache: true,
-      }),
-      ownerID: new UUIDField({
-        columnName: 'owner_id',
-      }),
-    },
-    databaseAdapterFlavor: 'postgres',
-    cacheAdapterFlavor: 'redis',
-  }),
-  privacyPolicyClass: BlahEntityPrivacyPolicy,
-});
-
 it('runs through a common workflow', async () => {
   // will be one entity companion provider for each request, so
   // share amongst all VCs created in that request

package/src/__tests__/EntityCompanion-test.ts

@@ -1,27 +1,24 @@
 import { instance, mock, when } from 'ts-mockito';
 
 import EntityCompanion from '../EntityCompanion';
+import EntityCompanionProvider from '../EntityCompanionProvider';
 import EntityLoaderFactory from '../EntityLoaderFactory';
 import EntityMutatorFactory from '../EntityMutatorFactory';
 import EntityTableDataCoordinator from '../internal/EntityTableDataCoordinator';
 import IEntityMetricsAdapter from '../metrics/IEntityMetricsAdapter';
-import TestEntity, {
-  TestEntityPrivacyPolicy,
-  testEntityConfiguration,
-  TestFields,
-} from '../testfixtures/TestEntity';
+import TestEntity, { testEntityConfiguration, TestFields } from '../testfixtures/TestEntity';
 
 describe(EntityCompanion, () => {
   it('correctly instantiates mutator and loader factories', () => {
+    const entityCompanionProvider = instance(mock<EntityCompanionProvider>());
+
     const tableDataCoordinatorMock = mock<EntityTableDataCoordinator<TestFields>>();
     when(tableDataCoordinatorMock.entityConfiguration).thenReturn(testEntityConfiguration);
 
     const companion = new EntityCompanion(
-      TestEntity,
+      entityCompanionProvider,
+      TestEntity.defineCompanionDefinition(),
       instance(tableDataCoordinatorMock),
-      TestEntityPrivacyPolicy,
-      [],
-      {},
       instance(mock<IEntityMetricsAdapter>())
     );
     expect(companion.getLoaderFactory()).toBeInstanceOf(EntityLoaderFactory);

package/src/__tests__/EntityCompanionProvider-test.ts

@@ -23,26 +23,34 @@ const blahConfiguration = new EntityConfiguration<BlahFields>({
 });
 
 class Blah1Entity extends Entity<BlahFields, string, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     BlahFields,
     string,
     ViewerContext,
     Blah1Entity,
     NoOpTest1PrivacyPolicy
   > {
-    return blah1CompanionDefinition;
+    return {
+      entityClass: Blah1Entity,
+      entityConfiguration: blahConfiguration,
+      privacyPolicyClass: NoOpTest1PrivacyPolicy,
+    };
   }
 }
 
 class Blah2Entity extends Entity<BlahFields, string, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     BlahFields,
     string,
     ViewerContext,
     Blah2Entity,
     NoOpTest2PrivacyPolicy
   > {
-    return blah2CompanionDefinition;
+    return {
+      entityClass: Blah2Entity,
+      entityConfiguration: blahConfiguration,
+      privacyPolicyClass: NoOpTest2PrivacyPolicy,
+    };
   }
 }
 
@@ -59,31 +67,11 @@ class NoOpTest2PrivacyPolicy extends EntityPrivacyPolicy<
   Blah2Entity
 > {}
 
-const blah1CompanionDefinition = new EntityCompanionDefinition({
-  entityClass: Blah1Entity,
-  entityConfiguration: blahConfiguration,
-  privacyPolicyClass: NoOpTest1PrivacyPolicy,
-});
-
-const blah2CompanionDefinition = new EntityCompanionDefinition({
-  entityClass: Blah2Entity,
-  entityConfiguration: blahConfiguration,
-  privacyPolicyClass: NoOpTest2PrivacyPolicy,
-});
-
 describe(EntityCompanionProvider, () => {
   it('returns different instances for different entity types, but share table data coordinators', () => {
     const entityCompanionProvider = createUnitTestEntityCompanionProvider();
-    const companion1 = entityCompanionProvider.getCompanionForEntity(
-      Blah1Entity,
-      blah1CompanionDefinition
-    );
-
-    const companion2 = entityCompanionProvider.getCompanionForEntity(
-      Blah2Entity,
-      blah2CompanionDefinition
-    );
-
+    const companion1 = entityCompanionProvider.getCompanionForEntity(Blah1Entity);
+    const companion2 = entityCompanionProvider.getCompanionForEntity(Blah2Entity);
     expect(companion1).not.toEqual(companion2);
     expect(companion1['tableDataCoordinator']).toEqual(companion2['tableDataCoordinator']);
   });

package/src/__tests__/EntityEdges-test.ts

@@ -322,45 +322,78 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
   }
 
   class ParentEntity extends Entity<ParentFields, string, TestViewerContext> {
-    static getCompanionDefinition(): EntityCompanionDefinition<
+    static defineCompanionDefinition(): EntityCompanionDefinition<
       ParentFields,
       string,
       TestViewerContext,
       ParentEntity,
       TestEntityPrivacyPolicy
     > {
-      return parentEntityCompanion;
+      return {
+        entityClass: ParentEntity,
+        entityConfiguration: parentEntityConfiguration,
+        privacyPolicyClass: TestEntityPrivacyPolicy,
+        mutationTriggers: {
+          beforeDelete: [new ParentCheckInfoDeletionTrigger()],
+          afterDelete: [new ParentCheckInfoDeletionTrigger()],
+
+          beforeUpdate: [new ParentCheckInfoUpdateTrigger()],
+          afterUpdate: [new ParentCheckInfoUpdateTrigger()],
+        },
+      };
     }
   }
 
   class ChildEntity extends Entity<ChildFields, string, TestViewerContext> {
-    static getCompanionDefinition(): EntityCompanionDefinition<
+    static defineCompanionDefinition(): EntityCompanionDefinition<
       ChildFields,
       string,
       TestViewerContext,
       ChildEntity,
       TestEntityPrivacyPolicy
     > {
-      return childEntityCompanion;
+      return {
+        entityClass: ChildEntity,
+        entityConfiguration: childEntityConfiguration,
+        privacyPolicyClass: TestEntityPrivacyPolicy,
+        mutationTriggers: {
+          beforeDelete: [new ChildCheckInfoDeletionTrigger()],
+          afterDelete: [new ChildCheckInfoDeletionTrigger()],
+
+          beforeUpdate: [new ChildCheckInfoUpdateTrigger()],
+          afterUpdate: [new ChildCheckInfoUpdateTrigger()],
+        },
+      };
     }
   }
 
   class GrandChildEntity extends Entity<GrandChildFields, string, TestViewerContext> {
-    static getCompanionDefinition(): EntityCompanionDefinition<
+    static defineCompanionDefinition(): EntityCompanionDefinition<
       GrandChildFields,
       string,
       TestViewerContext,
       GrandChildEntity,
       TestEntityPrivacyPolicy
     > {
-      return grandChildEntityCompanion;
+      return {
+        entityClass: GrandChildEntity,
+        entityConfiguration: grandChildEntityConfiguration,
+        privacyPolicyClass: TestEntityPrivacyPolicy,
+        mutationTriggers: {
+          beforeDelete: [new GrandChildCheckInfoDeletionTrigger()],
+          afterDelete: [new GrandChildCheckInfoDeletionTrigger()],
+
+          beforeUpdate: [new GrandChildCheckInfoUpdateTrigger()],
+          afterUpdate: [new GrandChildCheckInfoUpdateTrigger()],
+        },
+      };
     }
   }
 
   const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
     idField: 'id',
     tableName: 'parents',
-    getInboundEdges: () => [ChildEntity],
+    inboundEdges: [ChildEntity],
     schema: {
       id: new UUIDField({
         columnName: 'id',
@@ -374,7 +407,7 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
   const childEntityConfiguration = new EntityConfiguration<ChildFields>({
     idField: 'id',
     tableName: 'children',
-    getInboundEdges: () => [GrandChildEntity],
+    inboundEdges: [GrandChildEntity],
     schema: {
       id: new UUIDField({
         columnName: 'id',
@@ -384,7 +417,7 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
         columnName: 'parent_id',
         cache: true,
         association: {
-          getAssociatedEntityClass: () => ParentEntity,
+          associatedEntityClass: ParentEntity,
           edgeDeletionBehavior,
         },
       }),
@@ -405,7 +438,7 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
         columnName: 'parent_id',
         cache: true,
         association: {
-          getAssociatedEntityClass: () => ChildEntity,
+          associatedEntityClass: ChildEntity,
           edgeDeletionBehavior,
         },
       }),
@@ -414,45 +447,6 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
     cacheAdapterFlavor: 'redis',
   });
 
-  const parentEntityCompanion = new EntityCompanionDefinition({
-    entityClass: ParentEntity,
-    entityConfiguration: parentEntityConfiguration,
-    privacyPolicyClass: TestEntityPrivacyPolicy,
-    mutationTriggers: () => ({
-      beforeDelete: [new ParentCheckInfoDeletionTrigger()],
-      afterDelete: [new ParentCheckInfoDeletionTrigger()],
-
-      beforeUpdate: [new ParentCheckInfoUpdateTrigger()],
-      afterUpdate: [new ParentCheckInfoUpdateTrigger()],
-    }),
-  });
-
-  const childEntityCompanion = new EntityCompanionDefinition({
-    entityClass: ChildEntity,
-    entityConfiguration: childEntityConfiguration,
-    privacyPolicyClass: TestEntityPrivacyPolicy,
-    mutationTriggers: () => ({
-      beforeDelete: [new ChildCheckInfoDeletionTrigger()],
-      afterDelete: [new ChildCheckInfoDeletionTrigger()],
-
-      beforeUpdate: [new ChildCheckInfoUpdateTrigger()],
-      afterUpdate: [new ChildCheckInfoUpdateTrigger()],
-    }),
-  });
-
-  const grandChildEntityCompanion = new EntityCompanionDefinition({
-    entityClass: GrandChildEntity,
-    entityConfiguration: grandChildEntityConfiguration,
-    privacyPolicyClass: TestEntityPrivacyPolicy,
-    mutationTriggers: () => ({
-      beforeDelete: [new GrandChildCheckInfoDeletionTrigger()],
-      afterDelete: [new GrandChildCheckInfoDeletionTrigger()],
-
-      beforeUpdate: [new GrandChildCheckInfoUpdateTrigger()],
-      afterUpdate: [new GrandChildCheckInfoUpdateTrigger()],
-    }),
-  });
-
   return {
     ParentEntity,
     ChildEntity,

package/src/__tests__/EntityLoader-constructor-test.ts

@@ -87,17 +87,22 @@ export default class TestEntity extends Entity<
   ViewerContext,
   TestFieldSelection
 > {
-  constructor(viewerContext: ViewerContext, rawFields: Readonly<TestFields>) {
-    if (rawFields.id === ID_SENTINEL_THROW_LITERAL) {
+  constructor(constructorParams: {
+    viewerContext: ViewerContext;
+    id: string;
+    databaseFields: Readonly<TestFields>;
+    selectedFields: Readonly<TestFields>;
+  }) {
+    if (constructorParams.selectedFields.id === ID_SENTINEL_THROW_LITERAL) {
       // eslint-disable-next-line no-throw-literal,@typescript-eslint/no-throw-literal
       throw 'hello';
-    } else if (rawFields.id === ID_SENTINEL_THROW_ERROR) {
+    } else if (constructorParams.selectedFields.id === ID_SENTINEL_THROW_ERROR) {
       throw new Error('world');
     }
-    super(viewerContext, rawFields);
+    super(constructorParams);
   }
 
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     TestFields,
     string,
     ViewerContext,
@@ -105,16 +110,14 @@ export default class TestEntity extends Entity<
     TestEntityPrivacyPolicy,
     TestFieldSelection
   > {
-    return testEntityCompanion;
+    return {
+      entityClass: TestEntity,
+      entityConfiguration: testEntityConfiguration,
+      privacyPolicyClass: TestEntityPrivacyPolicy,
+    };
   }
 }
 
-export const testEntityCompanion = new EntityCompanionDefinition({
-  entityClass: TestEntity,
-  entityConfiguration: testEntityConfiguration,
-  privacyPolicyClass: TestEntityPrivacyPolicy,
-});
-
 describe(EntityLoader, () => {
   it('handles thrown errors and literals from constructor', async () => {
     const viewerContext = instance(mock(ViewerContext));
@@ -158,6 +161,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManager,
       metricsAdapter

package/src/__tests__/EntityLoader-test.ts

@@ -75,6 +75,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManager,
       metricsAdapter
@@ -177,6 +178,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManager,
       metricsAdapter
@@ -275,6 +277,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManager,
       metricsAdapter
@@ -353,6 +356,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManager,
       metricsAdapter
@@ -385,6 +389,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManagerInstance,
       metricsAdapter
@@ -412,6 +417,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManagerInstance,
       metricsAdapter
@@ -442,6 +448,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManagerInstance,
       metricsAdapter
@@ -486,6 +493,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManagerInstance,
       metricsAdapter
@@ -519,6 +527,7 @@ describe(EntityLoader, () => {
       privacyPolicyEvaluationContext,
       testEntityConfiguration,
       TestEntity,
+      /* entitySelectedFields */ undefined,
       privacyPolicy,
       dataManagerInstance,
       metricsAdapter

package/src/__tests__/EntityMutator-MutationCacheConsistency-test.ts

@@ -34,37 +34,35 @@ class BlahEntityPrivacyPolicy extends EntityPrivacyPolicy<
 }
 
 class BlahEntity extends Entity<BlahFields, string, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     BlahFields,
     string,
     ViewerContext,
     BlahEntity,
     BlahEntityPrivacyPolicy
   > {
-    return blahCompanion;
+    return {
+      entityClass: BlahEntity,
+      entityConfiguration: new EntityConfiguration<BlahFields>({
+        idField: 'id',
+        tableName: 'blah_table',
+        schema: {
+          id: new UUIDField({
+            columnName: 'id',
+            cache: true,
+          }),
+        },
+        databaseAdapterFlavor: 'postgres',
+        cacheAdapterFlavor: 'redis',
+      }),
+      privacyPolicyClass: BlahEntityPrivacyPolicy,
+      mutationTriggers: {
+        afterCommit: [new TestNonTransactionalMutationTrigger()],
+      },
+    };
   }
 }
 
-const blahCompanion = new EntityCompanionDefinition({
-  entityClass: BlahEntity,
-  entityConfiguration: new EntityConfiguration<BlahFields>({
-    idField: 'id',
-    tableName: 'blah_table',
-    schema: {
-      id: new UUIDField({
-        columnName: 'id',
-        cache: true,
-      }),
-    },
-    databaseAdapterFlavor: 'postgres',
-    cacheAdapterFlavor: 'redis',
-  }),
-  privacyPolicyClass: BlahEntityPrivacyPolicy,
-  mutationTriggers: () => ({
-    afterCommit: [new TestNonTransactionalMutationTrigger()],
-  }),
-});
-
 class TestNonTransactionalMutationTrigger extends EntityNonTransactionalMutationTrigger<
   BlahFields,
   string,