@expo/entity 0.31.0 → 0.32.0

package/src/IEntityCacheAdapterProvider.ts

@@ -1,5 +1,5 @@
-import EntityCacheAdapter from './EntityCacheAdapter';
 import EntityConfiguration from './EntityConfiguration';
+import IEntityCacheAdapter from './IEntityCacheAdapter';
 
 /**
  * A cache adapter provider vends cache adapters for a particular cache adapter type.
@@ -11,5 +11,5 @@ export default interface IEntityCacheAdapterProvider {
    */
   getCacheAdapter<TFields>(
     entityConfiguration: EntityConfiguration<TFields>
-  ): EntityCacheAdapter<TFields>;
+  ): IEntityCacheAdapter<TFields>;
 }

package/src/IEntityGenericCacher.ts

@@ -1,15 +1,45 @@
 import { CacheLoadResult } from './internal/ReadThroughEntityCache';
 
 /**
- * A cacher stores and loads key-value pairs. It also supports negative caching - it stores the absence
- * of keys that don't exist in the backing datastore.
+ * A generic cacher stores and loads key-value pairs. It also supports negative caching - it stores the absence
+ * of keys that don't exist in the backing datastore. It is also responsible for cache key creation.
  */
 export default interface IEntityGenericCacher<TFields> {
+  /**
+   * Load many keys from the cache. Return info in a format that is useful for read-through caching and
+   * negative caching.
+   *
+   * @param keys - cache keys to load
+   */
   loadManyAsync(keys: readonly string[]): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>>;
 
+  /**
+   * Cache many objects for specified keys.
+   *
+   * @param objectMap - map from cache key to object to cache for key
+   */
   cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void>;
 
+  /**
+   * Negatively-cache specified keys. Subsequent loads for these keys (without calling invalidate) may
+   * return a negative CacheLoadResult
+   *
+   * @param keys - keys to cache negatively
+   */
   cacheDBMissesAsync(keys: readonly string[]): Promise<void>;
 
+  /**
+   * Invalidate specified keys in cache. Subsequent loads for these keys may return a cache miss.
+   *
+   * @param keys - keys to invalidate
+   */
   invalidateManyAsync(keys: readonly string[]): Promise<void>;
+
+  /**
+   * Create a cache key for a field and value of a object being cached or invalidated.
+   *
+   * @param fieldName - name of the object field for this cache key
+   * @param fieldValue - value of the obejct field for this cache key
+   */
+  makeCacheKey<N extends keyof TFields>(fieldName: N, fieldValue: NonNullable<TFields[N]>): string;
 }

package/src/ReadonlyEntity.ts

@@ -2,12 +2,10 @@ import invariant from 'invariant';
 
 import { IEntityClass } from './Entity';
 import EntityAssociationLoader from './EntityAssociationLoader';
-import { EntityCompanionDefinition } from './EntityCompanionProvider';
 import EntityLoader from './EntityLoader';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
 import ViewerContext from './ViewerContext';
-import { pick } from './entityUtils';
 
 /**
  * A readonly entity exposes only the read functionality of an Entity. Used as the base
@@ -18,45 +16,47 @@ import { pick } from './entityUtils';
  * - Entities representing immutable tables.
  */
 export default abstract class ReadonlyEntity<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
+  private readonly viewerContext: TViewerContext;
   private readonly id: TID;
-  private readonly rawFields: Readonly<Pick<TFields, TSelectedFields>>;
+  private readonly databaseFields: Readonly<TFields>;
+  private readonly selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
 
   /**
    * Constructs an instance of an Entity.
-   * @param viewerContext - the ViewerContext reading this entity
-   * @param rawFields - all underlying fields for this entity's data
+   *
+   * @param constructorParam - data needed to construct an instance of an entity
+   * viewerContext - the ViewerContext reading this entity
+   * id - the ID of this entity
+   * databaseFields - all underlying fields for this entity's data
+   * selectedFields - selected fields for this entity from TSelectedFields type
+   *
+   * This should only be overridden in cases where additional data validation is needed.
+   * The params should not be modified when calling super during constructions.
    *
    * @internal
    */
-  constructor(
-    private readonly viewerContext: TViewerContext,
-    private readonly databaseFields: Readonly<TFields>
-  ) {
-    const companionDefinition = (
-      this.constructor as any
-    ).getCompanionDefinition() as EntityCompanionDefinition<
-      TFields,
-      TID,
-      TViewerContext,
-      this,
-      EntityPrivacyPolicy<TFields, TID, TViewerContext, this, TSelectedFields>,
-      TSelectedFields
-    >;
-    const idField = companionDefinition.entityConfiguration.idField as keyof Pick<
-      TFields,
-      TSelectedFields
-    >;
-    const id = databaseFields[idField];
-    invariant(id, 'must provide ID to create an entity');
-    this.id = id as any;
+  constructor({
+    viewerContext,
+    id,
+    databaseFields,
+    selectedFields,
+  }: {
+    viewerContext: TViewerContext;
+    id: TID;
+    databaseFields: Readonly<TFields>;
+    selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
+  }) {
+    invariant(id !== null && id !== undefined, 'id must be non-null');
 
-    const entitySelectedFields = companionDefinition.entitySelectedFields as (keyof TFields)[];
-    this.rawFields = pick(databaseFields, entitySelectedFields);
+    this.viewerContext = viewerContext;
+    this.id = id;
+    this.databaseFields = databaseFields;
+    this.selectedFields = selectedFields;
   }
 
   toString(): string {
@@ -102,14 +102,14 @@ export default abstract class ReadonlyEntity<
   getField<K extends keyof Pick<TFields, TSelectedFields>>(
     fieldName: K
   ): Pick<TFields, TSelectedFields>[K] {
-    return this.rawFields[fieldName];
+    return this.selectedFields[fieldName];
   }
 
   /**
    * @returns all underlying fields from this entity's data
    */
   getAllFields(): Readonly<Pick<TFields, TSelectedFields>> {
-    return { ...this.rawFields };
+    return { ...this.selectedFields };
   }
 
   /**
@@ -125,7 +125,7 @@ export default abstract class ReadonlyEntity<
    * @param queryContext - query context in which to perform the load
    */
   static loader<
-    TMFields,
+    TMFields extends object,
     TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMViewerContext2 extends TMViewerContext,

package/src/ViewerContext.ts

@@ -1,7 +1,11 @@
 import { IEntityClass } from './Entity';
 import EntityCompanionProvider, { DatabaseAdapterFlavor } from './EntityCompanionProvider';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
-import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
+import {
+  EntityQueryContext,
+  EntityTransactionalQueryContext,
+  TransactionConfig,
+} from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerScopedEntityCompanion from './ViewerScopedEntityCompanion';
 import ViewerScopedEntityCompanionProvider from './ViewerScopedEntityCompanionProvider';
@@ -27,7 +31,7 @@ export default class ViewerContext {
   }
 
   getViewerScopedEntityCompanionForClass<
-    TMFields,
+    TMFields extends object,
     TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -56,10 +60,7 @@ export default class ViewerContext {
     TMPrivacyPolicy,
     TMSelectedFields
   > {
-    return this.viewerScopedEntityCompanionProvider.getViewerScopedCompanionForEntity(
-      entityClass,
-      entityClass.getCompanionDefinition()
-    );
+    return this.viewerScopedEntityCompanionProvider.getViewerScopedCompanionForEntity(entityClass);
   }
 
   /**
@@ -82,11 +83,12 @@ export default class ViewerContext {
    */
   async runInTransactionForDatabaseAdaptorFlavorAsync<TResult>(
     databaseAdaptorFlavor: DatabaseAdapterFlavor,
-    transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
+    transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>,
+    transactionConfig?: TransactionConfig
   ): Promise<TResult> {
     return await this.entityCompanionProvider
       .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
       .getQueryContext()
-      .runInTransactionIfNotInTransactionAsync(transactionScope);
+      .runInTransactionIfNotInTransactionAsync(transactionScope, transactionConfig);
   }
 }

package/src/ViewerScopedEntityCompanion.ts

@@ -12,7 +12,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
  * from the viewer-scoped entity companion provider.
  */
 export default class ViewerScopedEntityCompanion<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -26,7 +26,7 @@ export default class ViewerScopedEntityCompanion<
   TSelectedFields extends keyof TFields
 > {
   constructor(
-    private readonly entityCompanion: EntityCompanion<
+    public readonly entityCompanion: EntityCompanion<
       TFields,
       TID,
       TViewerContext,

package/src/ViewerScopedEntityCompanionProvider.ts

@@ -1,5 +1,5 @@
 import { IEntityClass } from './Entity';
-import EntityCompanionProvider, { EntityCompanionDefinition } from './EntityCompanionProvider';
+import EntityCompanionProvider from './EntityCompanionProvider';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
@@ -19,10 +19,10 @@ export default class ViewerScopedEntityCompanionProvider {
    * companion is constructed using the configuration provided by the factory.
    *
    * @param entityClass - entity class to load
-   * @param factory - entity companion factory
+   * @param entityCompanionDefinitionFn - function defining entity companion definition
    */
   getViewerScopedCompanionForEntity<
-    TFields,
+    TFields extends object,
     TID extends NonNullable<TFields[TSelectedFields]>,
     TViewerContext extends ViewerContext,
     TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -42,14 +42,6 @@ export default class ViewerScopedEntityCompanionProvider {
       TEntity,
       TPrivacyPolicy,
       TSelectedFields
-    >,
-    entityCompanionDefinition: EntityCompanionDefinition<
-      TFields,
-      TID,
-      TViewerContext,
-      TEntity,
-      TPrivacyPolicy,
-      TSelectedFields
     >
   ): ViewerScopedEntityCompanion<
     TFields,
@@ -60,7 +52,7 @@ export default class ViewerScopedEntityCompanionProvider {
     TSelectedFields
   > {
     return new ViewerScopedEntityCompanion(
-      this.entityCompanionProvider.getCompanionForEntity(entityClass, entityCompanionDefinition),
+      this.entityCompanionProvider.getCompanionForEntity(entityClass),
       this.viewerContext as TViewerContext
     );
   }

package/src/ViewerScopedEntityLoaderFactory.ts

@@ -9,7 +9,7 @@ import ViewerContext from './ViewerContext';
  * Provides a cleaner API for loading entities by passing through the ViewerContext.
  */
 export default class ViewerScopedEntityLoaderFactory<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,

package/src/ViewerScopedEntityMutatorFactory.ts

@@ -9,7 +9,7 @@ import ViewerContext from './ViewerContext';
  * Provides a cleaner API for mutating entities by passing through the ViewerContext.
  */
 export default class ViewerScopedEntityMutatorFactory<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,

package/src/__tests__/ComposedCacheAdapter-test.ts

@@ -1,9 +1,9 @@
 import invariant from 'invariant';
 
 import ComposedEntityCacheAdapter from '../ComposedEntityCacheAdapter';
-import EntityCacheAdapter from '../EntityCacheAdapter';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField } from '../EntityFields';
+import IEntityCacheAdapter from '../IEntityCacheAdapter';
 import { CacheLoadResult, CacheStatus } from '../internal/ReadThroughEntityCache';
 
 type BlahFields = {
@@ -23,13 +23,11 @@ const entityConfiguration = new EntityConfiguration<BlahFields>({
 export const DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = Symbol('doesNotExist');
 type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
 
-class TestLocalCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
+class TestLocalCacheAdapter<TFields> implements IEntityCacheAdapter<TFields> {
   constructor(
-    entityConfiguration: EntityConfiguration<TFields>,
+    private readonly entityConfiguration: EntityConfiguration<TFields>,
     private readonly cache: Map<string, LocalMemoryCacheValue<TFields>>
-  ) {
-    super(entityConfiguration);
-  }
+  ) {}
 
   public async loadManyAsync<N extends keyof TFields>(
     fieldName: N,
@@ -123,10 +121,7 @@ function makeTestCacheAdapters(): {
   const fallbackCache = new Map();
   const fallbackCacheAdapter = new TestLocalCacheAdapter(entityConfiguration, fallbackCache);
 
-  const cacheAdapter = new ComposedEntityCacheAdapter(entityConfiguration, [
-    primaryCacheAdapter,
-    fallbackCacheAdapter,
-  ]);
+  const cacheAdapter = new ComposedEntityCacheAdapter([primaryCacheAdapter, fallbackCacheAdapter]);
 
   return {
     primaryCache,
@@ -229,7 +224,7 @@ describe(ComposedEntityCacheAdapter, () => {
     });
 
     it('handles 0 cache adapter compose case', async () => {
-      const cacheAdapter = new ComposedEntityCacheAdapter(entityConfiguration, []);
+      const cacheAdapter = new ComposedEntityCacheAdapter<any>([]);
       const results = await cacheAdapter.loadManyAsync('id', []);
       expect(results).toEqual(new Map());
     });

package/src/__tests__/EnforcingEntityLoader-test.ts

@@ -222,6 +222,46 @@ describe(EnforcingEntityLoader, () => {
     });
   });
 
+  describe('loadFirstByFieldEqualityConjunction', () => {
+    it('throws when result is unsuccessful', async () => {
+      const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
+      const rejection = new Error();
+      when(
+        entityLoaderMock.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
+      ).thenResolve(result(rejection));
+      const entityLoader = instance(entityLoaderMock);
+      const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
+      await expect(
+        enforcingEntityLoader.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
+      ).rejects.toThrow(rejection);
+    });
+
+    it('returns value when result is successful', async () => {
+      const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
+      const resolved = {};
+      when(
+        entityLoaderMock.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
+      ).thenResolve(result(resolved));
+      const entityLoader = instance(entityLoaderMock);
+      const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
+      await expect(
+        enforcingEntityLoader.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
+      ).resolves.toEqual(resolved);
+    });
+
+    it('returns null when the query is successful but no rows match', async () => {
+      const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
+      when(
+        entityLoaderMock.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
+      ).thenResolve(null);
+      const entityLoader = instance(entityLoaderMock);
+      const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
+      await expect(
+        enforcingEntityLoader.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
+      ).resolves.toBeNull();
+    });
+  });
+
   describe('loadManyByFieldEqualityConjunction', () => {
     it('throws when result is unsuccessful', async () => {
       const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
@@ -290,6 +330,7 @@ describe(EnforcingEntityLoader, () => {
       'tryConstructEntities',
       'validateFieldValues',
       'constructAndAuthorizeEntitiesAsync',
+      'constructEntity',
     ];
     expect(loaderProperties).toEqual(expect.arrayContaining(knownLoaderOnlyDifferences));
 

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);