@expo/entity 0.32.0 → 0.34.0

package/src/EntityMutationTriggerConfiguration.ts

@@ -51,9 +51,8 @@ export default interface EntityMutationTriggerConfiguration<
   afterAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
 
   /**
-   * Trigger set that runs after committing the transaction unless one is supplied
-   * after any mutation (create, update, delete). If the call to the mutation is wrapped in a transaction,
-   * this too will be within the transaction.
+   * Trigger set that runs after committing the mutation transaction. If the call to the mutation is wrapped in a transaction, these
+   * will be run after the wrapping transaction is completed.
    */
   afterCommit?: EntityNonTransactionalMutationTrigger<
     TFields,
@@ -65,9 +64,8 @@ export default interface EntityMutationTriggerConfiguration<
 }
 
 /**
- * A trigger is a way to specify entity mutation operation side-effects that run within the
- * same transaction as the mutation itself. The one exception is afterCommit, which will run within
- * the transaction if a transaction is supplied.
+ * A transactional trigger is a way to specify entity mutation operation side-effects that run within the
+ * same transaction as the mutation itself.
  */
 export abstract class EntityMutationTrigger<
   TFields extends object,
@@ -86,7 +84,7 @@ export abstract class EntityMutationTrigger<
 
 /**
  * A non-transactional trigger is like a EntityMutationTrigger but used for afterCommit triggers
- * since they explicitly occur outside of the transaction.
+ * since they run after the transaction is committed.
  */
 export abstract class EntityNonTransactionalMutationTrigger<
   TFields extends object,

package/src/EntityQueryContextProvider.ts

@@ -12,7 +12,7 @@ export default abstract class EntityQueryContextProvider {
   /**
    * Vend a regular (non-transactional) entity query context.
    */
-  public getQueryContext(): EntityNonTransactionalQueryContext {
+  public getNonTransactionalQueryContext(): EntityNonTransactionalQueryContext {
     return new EntityNonTransactionalQueryContext(this.getQueryInterface(), this);
   }
 

package/src/IEntityCacheAdapterProvider.ts

@@ -7,7 +7,7 @@ import IEntityCacheAdapter from './IEntityCacheAdapter';
  */
 export default interface IEntityCacheAdapterProvider {
   /**
-   * Vend a cache adapter.
+   * Vend a cache adapter for an entity configuration.
    */
   getCacheAdapter<TFields>(
     entityConfiguration: EntityConfiguration<TFields>

package/src/ReadonlyEntity.ts

@@ -148,10 +148,7 @@ export default abstract class ReadonlyEntity<
       TMSelectedFields
     >,
     viewerContext: TMViewerContext2,
-    queryContext: EntityQueryContext = viewerContext
-      .getViewerScopedEntityCompanionForClass(this)
-      .getQueryContextProvider()
-      .getQueryContext()
+    queryContext: EntityQueryContext
   ): EntityLoader<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
     return viewerContext
       .getViewerScopedEntityCompanionForClass(this)

package/src/ViewerContext.ts

@@ -2,7 +2,7 @@ import { IEntityClass } from './Entity';
 import EntityCompanionProvider, { DatabaseAdapterFlavor } from './EntityCompanionProvider';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import {
-  EntityQueryContext,
+  EntityNonTransactionalQueryContext,
   EntityTransactionalQueryContext,
   TransactionConfig,
 } from './EntityQueryContext';
@@ -67,12 +67,12 @@ export default class ViewerContext {
    * Get the regular (non-transactional) query context for a database adaptor flavor.
    * @param databaseAdaptorFlavor - database adaptor flavor
    */
-  getQueryContextForDatabaseAdaptorFlavor(
+  getNonTransactionalQueryContextForDatabaseAdaptorFlavor(
     databaseAdaptorFlavor: DatabaseAdapterFlavor
-  ): EntityQueryContext {
+  ): EntityNonTransactionalQueryContext {
     return this.entityCompanionProvider
       .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
-      .getQueryContext();
+      .getNonTransactionalQueryContext();
   }
 
   /**
@@ -88,7 +88,7 @@ export default class ViewerContext {
   ): Promise<TResult> {
     return await this.entityCompanionProvider
       .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
-      .getQueryContext()
+      .getNonTransactionalQueryContext()
       .runInTransactionIfNotInTransactionAsync(transactionScope, transactionConfig);
   }
 }

package/src/__tests__/EnforcingEntityLoader-test.ts

@@ -222,6 +222,49 @@ describe(EnforcingEntityLoader, () => {
     });
   });
 
+  describe('loadManyByIDsNullableAsync', () => {
+    it('throws when result is unsuccessful even when there is a null result', async () => {
+      const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
+      const rejection = new Error();
+      when(entityLoaderMock.loadManyByIDsNullableAsync(anything())).thenResolve(
+        new Map(
+          Object.entries({
+            hello: result(rejection),
+            world: null,
+          })
+        )
+      );
+      const entityLoader = instance(entityLoaderMock);
+      const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
+      await expect(enforcingEntityLoader.loadManyByIDsNullableAsync(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.loadManyByIDsNullableAsync(anything())).thenResolve(
+        new Map(
+          Object.entries({
+            hello: result(resolved),
+            world: null,
+          })
+        )
+      );
+      const entityLoader = instance(entityLoaderMock);
+      const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
+      await expect(enforcingEntityLoader.loadManyByIDsNullableAsync(anything())).resolves.toEqual(
+        new Map(
+          Object.entries({
+            hello: resolved,
+            world: null,
+          })
+        )
+      );
+    });
+  });
+
   describe('loadFirstByFieldEqualityConjunction', () => {
     it('throws when result is unsuccessful', async () => {
       const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);

package/src/__tests__/Entity-test.ts

@@ -4,25 +4,27 @@ import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField } from '../EntityFields';
 import { CreateMutator, UpdateMutator } from '../EntityMutator';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
-import ViewerContext from '../ViewerContext';
 import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
 import AlwaysDenyPrivacyPolicyRule from '../rules/AlwaysDenyPrivacyPolicyRule';
 import SimpleTestEntity from '../testfixtures/SimpleTestEntity';
+import TestViewerContext from '../testfixtures/TestViewerContext';
 import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
 
 describe(Entity, () => {
   describe('creator', () => {
     it('creates a new CreateMutator', () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new ViewerContext(companionProvider);
-      expect(SimpleTestEntity.creator(viewerContext)).toBeInstanceOf(CreateMutator);
+      const viewerContext = new TestViewerContext(companionProvider);
+      expect(
+        SimpleTestEntity.creator(viewerContext, viewerContext.getQueryContext())
+      ).toBeInstanceOf(CreateMutator);
     });
   });
 
   describe('updater', () => {
     it('creates a new UpdateMutator', () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new ViewerContext(companionProvider);
+      const viewerContext = new TestViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -32,14 +34,16 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      expect(SimpleTestEntity.updater(testEntity)).toBeInstanceOf(UpdateMutator);
+      expect(SimpleTestEntity.updater(testEntity, viewerContext.getQueryContext())).toBeInstanceOf(
+        UpdateMutator
+      );
     });
   });
 
   describe('canViewerUpdateAsync', () => {
     it('appropriately executes update privacy policy', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new ViewerContext(companionProvider);
+      const viewerContext = new TestViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -49,13 +53,16 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      const canViewerUpdate = await SimpleTestDenyDeleteEntity.canViewerUpdateAsync(testEntity);
+      const canViewerUpdate = await SimpleTestDenyDeleteEntity.canViewerUpdateAsync(
+        testEntity,
+        viewerContext.getQueryContext()
+      );
       expect(canViewerUpdate).toBe(true);
     });
 
     it('denies when policy denies', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new ViewerContext(companionProvider);
+      const viewerContext = new TestViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -65,7 +72,10 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      const canViewerUpdate = await SimpleTestDenyUpdateEntity.canViewerUpdateAsync(testEntity);
+      const canViewerUpdate = await SimpleTestDenyUpdateEntity.canViewerUpdateAsync(
+        testEntity,
+        viewerContext.getQueryContext()
+      );
       expect(canViewerUpdate).toBe(false);
     });
   });
@@ -73,7 +83,7 @@ describe(Entity, () => {
   describe('canViewerDeleteAsync', () => {
     it('appropriately executes update privacy policy', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new ViewerContext(companionProvider);
+      const viewerContext = new TestViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -83,13 +93,16 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      const canViewerDelete = await SimpleTestDenyUpdateEntity.canViewerDeleteAsync(testEntity);
+      const canViewerDelete = await SimpleTestDenyUpdateEntity.canViewerDeleteAsync(
+        testEntity,
+        viewerContext.getQueryContext()
+      );
       expect(canViewerDelete).toBe(true);
     });
 
     it('denies when policy denies', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new ViewerContext(companionProvider);
+      const viewerContext = new TestViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -99,7 +112,10 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      const canViewerDelete = await SimpleTestDenyDeleteEntity.canViewerDeleteAsync(testEntity);
+      const canViewerDelete = await SimpleTestDenyDeleteEntity.canViewerDeleteAsync(
+        testEntity,
+        viewerContext.getQueryContext()
+      );
       expect(canViewerDelete).toBe(false);
     });
   });
@@ -124,14 +140,14 @@ const testEntityConfiguration = new EntityConfiguration<TestEntityFields>({
 class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
   TestEntityFields,
   string,
-  ViewerContext,
+  TestViewerContext,
   SimpleTestDenyUpdateEntity
 > {
   protected override readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestDenyUpdateEntity
     >(),
   ];
@@ -139,7 +155,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestDenyUpdateEntity
     >(),
   ];
@@ -147,7 +163,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysDenyPrivacyPolicyRule<
       TestEntityFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestDenyUpdateEntity
     >(),
   ];
@@ -155,7 +171,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestDenyUpdateEntity
     >(),
   ];
@@ -164,14 +180,14 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
 class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
   TestEntityFields,
   string,
-  ViewerContext,
+  TestViewerContext,
   SimpleTestDenyDeleteEntity
 > {
   protected override readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestDenyDeleteEntity
     >(),
   ];
@@ -179,7 +195,7 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestDenyDeleteEntity
     >(),
   ];
@@ -187,7 +203,7 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestDenyDeleteEntity
     >(),
   ];
@@ -195,17 +211,17 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysDenyPrivacyPolicyRule<
       TestEntityFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestDenyDeleteEntity
     >(),
   ];
 }
 
-class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, ViewerContext> {
+class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, TestViewerContext> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     TestEntityFields,
     string,
-    ViewerContext,
+    TestViewerContext,
     SimpleTestDenyUpdateEntity,
     SimpleTestDenyUpdateEntityPrivacyPolicy
   > {
@@ -217,11 +233,11 @@ class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, Viewer
   }
 }
 
-class SimpleTestDenyDeleteEntity extends Entity<TestEntityFields, string, ViewerContext> {
+class SimpleTestDenyDeleteEntity extends Entity<TestEntityFields, string, TestViewerContext> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     TestEntityFields,
     string,
-    ViewerContext,
+    TestViewerContext,
     SimpleTestDenyDeleteEntity,
     SimpleTestDenyDeleteEntityPrivacyPolicy
   > {