@expo/entity 0.32.0 → 0.34.0

package/src/__tests__/cases/TwoEntitySameTableOverlappingRows-test.ts

@@ -3,26 +3,26 @@ import { EntityCompanionDefinition } from '../../EntityCompanionProvider';
 import EntityConfiguration from '../../EntityConfiguration';
 import { UUIDField, StringField } from '../../EntityFields';
 import EntityPrivacyPolicy from '../../EntityPrivacyPolicy';
-import ViewerContext from '../../ViewerContext';
 import AlwaysAllowPrivacyPolicyRule from '../../rules/AlwaysAllowPrivacyPolicyRule';
+import TestViewerContext from '../../testfixtures/TestViewerContext';
 import { createUnitTestEntityCompanionProvider } from '../../utils/testing/createUnitTestEntityCompanionProvider';
 
 describe('Two entities backed by the same table', () => {
   test('mutate through different types and keep consistent cache and dataloader', async () => {
     const companionProvider = createUnitTestEntityCompanionProvider();
-    const viewerContext = new ViewerContext(companionProvider);
+    const viewerContext = new TestViewerContext(companionProvider);
 
-    const entity1 = await OneTestEntity.creator(viewerContext)
+    const entity1 = await OneTestEntity.creator(viewerContext, viewerContext.getQueryContext())
       .setField('fake_field', 'hello')
       .enforceCreateAsync();
     expect(entity1).toBeInstanceOf(OneTestEntity);
 
-    const entity2 = await TwoTestEntity.loader(viewerContext)
+    const entity2 = await TwoTestEntity.loader(viewerContext, viewerContext.getQueryContext())
       .enforcing()
       .loadByIDAsync(entity1.getID());
     expect(entity2).toBeInstanceOf(TwoTestEntity);
 
-    const updated2 = await TwoTestEntity.updater(entity2)
+    const updated2 = await TwoTestEntity.updater(entity2, viewerContext.getQueryContext())
       .setField('fake_field', 'world')
       .setField('other_field', 'wat')
       .enforceUpdateAsync();
@@ -32,7 +32,7 @@ describe('Two entities backed by the same table', () => {
       fake_field: 'world',
     });
 
-    const loaded1 = await OneTestEntity.loader(viewerContext)
+    const loaded1 = await OneTestEntity.loader(viewerContext, viewerContext.getQueryContext())
       .enforcing()
       .loadByIDAsync(entity1.getID());
     expect(loaded1.getAllFields()).toMatchObject({
@@ -43,14 +43,14 @@ describe('Two entities backed by the same table', () => {
 
   test('cached field that differs between the two to test invalidation', async () => {
     const companionProvider = createUnitTestEntityCompanionProvider();
-    const viewerContext = new ViewerContext(companionProvider);
+    const viewerContext = new TestViewerContext(companionProvider);
 
-    const entity = await TwoTestEntity.creator(viewerContext)
+    const entity = await TwoTestEntity.creator(viewerContext, viewerContext.getQueryContext())
       .setField('fake_field', 'hello')
       .setField('other_field', 'huh')
       .enforceCreateAsync();
 
-    const loadedEntity = await TwoTestEntity.loader(viewerContext)
+    const loadedEntity = await TwoTestEntity.loader(viewerContext, viewerContext.getQueryContext())
       .enforcing()
       .loadByFieldEqualingAsync('other_field', 'huh');
     expect(loadedEntity?.getAllFields()).toMatchObject({
@@ -59,12 +59,14 @@ describe('Two entities backed by the same table', () => {
       other_field: 'huh',
     });
 
-    const loaded1 = await OneTestEntity.loader(viewerContext)
+    const loaded1 = await OneTestEntity.loader(viewerContext, viewerContext.getQueryContext())
       .enforcing()
       .loadByIDAsync(entity.getID());
-    await OneTestEntity.updater(loaded1).setField('fake_field', 'world').enforceUpdateAsync();
+    await OneTestEntity.updater(loaded1, viewerContext.getQueryContext())
+      .setField('fake_field', 'world')
+      .enforceUpdateAsync();
 
-    const loaded2 = await TwoTestEntity.loader(viewerContext)
+    const loaded2 = await TwoTestEntity.loader(viewerContext, viewerContext.getQueryContext())
       .enforcing()
       .loadByFieldEqualingAsync('other_field', 'huh');
     expect(loaded2?.getAllFields()).toMatchObject({
@@ -73,7 +75,7 @@ describe('Two entities backed by the same table', () => {
       other_field: 'huh',
     });
 
-    const loaded22 = await TwoTestEntity.loader(viewerContext)
+    const loaded22 = await TwoTestEntity.loader(viewerContext, viewerContext.getQueryContext())
       .enforcing()
       .loadByFieldEqualingAsync('fake_field', 'world');
     expect(loaded22?.getAllFields()).toMatchObject({
@@ -114,26 +116,32 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
   cacheAdapterFlavor: 'redis',
 });
 
-class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
+class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
+  any,
+  string,
+  TestViewerContext,
+  any,
+  any
+> {
   protected override readonly readRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+    new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
   ];
   protected override readonly createRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+    new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
   ];
   protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+    new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
   ];
   protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+    new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
   ];
 }
 
-class OneTestEntity extends Entity<TestFields, string, ViewerContext, OneTestFields> {
+class OneTestEntity extends Entity<TestFields, string, TestViewerContext, OneTestFields> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     TestFields,
     string,
-    ViewerContext,
+    TestViewerContext,
     OneTestEntity,
     TestEntityPrivacyPolicy,
     OneTestFields
@@ -147,11 +155,11 @@ class OneTestEntity extends Entity<TestFields, string, ViewerContext, OneTestFie
   }
 }
 
-class TwoTestEntity extends Entity<TestFields, string, ViewerContext, TwoTestFields> {
+class TwoTestEntity extends Entity<TestFields, string, TestViewerContext, TwoTestFields> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     TestFields,
     string,
-    ViewerContext,
+    TestViewerContext,
     TwoTestEntity,
     TestEntityPrivacyPolicy,
     TwoTestFields

package/src/internal/EntityDataManager.ts

@@ -76,7 +76,7 @@ export default class EntityDataManager<TFields> {
           entityClassName: this.entityClassName,
         });
         return await this.databaseAdapter.fetchManyWhereAsync(
-          this.queryContextProvider.getQueryContext(),
+          this.queryContextProvider.getNonTransactionalQueryContext(),
           fieldName,
           fetcherValues
         );

package/src/internal/__tests__/EntityDataManager-test.ts

@@ -78,7 +78,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyWhereAsync');
     const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -126,7 +126,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyWhereAsync');
     const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -174,7 +174,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
     // use second data manager to ensure that cache is hit instead of data loader
     const entityDataManager2 = new EntityDataManager(
       databaseAdapter,
@@ -218,7 +218,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyWhereAsync');
     const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -254,7 +254,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyWhereAsync');
     const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -298,7 +298,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     const objectInQuestion = objects.get(testEntityConfiguration.tableName)![1]!;
 
@@ -337,7 +337,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     const objectInQuestion = objects.get(testEntityConfiguration.tableName)![1]!;
 
@@ -415,7 +415,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyByFieldEqualityConjunctionAsync');
     const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -461,7 +461,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     await expect(
       entityDataManager.loadManyByFieldEqualingAsync(queryContext, 'customIdField', ['2'])
@@ -488,7 +488,7 @@ describe(EntityDataManager, () => {
       metricsAdapter,
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     await entityDataManager.loadManyByFieldEqualingAsync(queryContext, 'customIdField', ['1']);
     verify(
@@ -591,7 +591,7 @@ describe(EntityDataManager, () => {
       new NoOpEntityMetricsAdapter(),
       TestEntity.name
     );
-    const queryContext = StubQueryContextProvider.getQueryContext();
+    const queryContext = StubQueryContextProvider.getNonTransactionalQueryContext();
 
     await expect(
       entityDataManager.loadManyByFieldEqualingAsync(queryContext, 'nullableField', [null as any])

package/src/testfixtures/SimpleTestEntity.ts

@@ -1,9 +1,9 @@
+import TestViewerContext from './TestViewerContext';
 import Entity from '../Entity';
 import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
-import ViewerContext from '../ViewerContext';
 import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
 
 export type SimpleTestFields = {
@@ -27,7 +27,7 @@ export const simpleTestEntityConfiguration = new EntityConfiguration<SimpleTestF
 export class SimpleTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   SimpleTestFields,
   string,
-  ViewerContext,
+  TestViewerContext,
   SimpleTestEntity,
   SimpleTestFieldSelection
 > {
@@ -35,7 +35,7 @@ export class SimpleTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       SimpleTestFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestEntity,
       SimpleTestFieldSelection
     >(),
@@ -44,7 +44,7 @@ export class SimpleTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       SimpleTestFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestEntity,
       SimpleTestFieldSelection
     >(),
@@ -53,7 +53,7 @@ export class SimpleTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       SimpleTestFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestEntity,
       SimpleTestFieldSelection
     >(),
@@ -62,7 +62,7 @@ export class SimpleTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       SimpleTestFields,
       string,
-      ViewerContext,
+      TestViewerContext,
       SimpleTestEntity,
       SimpleTestFieldSelection
     >(),
@@ -72,13 +72,13 @@ export class SimpleTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
 export default class SimpleTestEntity extends Entity<
   SimpleTestFields,
   string,
-  ViewerContext,
+  TestViewerContext,
   SimpleTestFieldSelection
 > {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     SimpleTestFields,
     string,
-    ViewerContext,
+    TestViewerContext,
     SimpleTestEntity,
     SimpleTestEntityPrivacyPolicy,
     SimpleTestFieldSelection

package/src/testfixtures/TestEntity.ts

@@ -1,11 +1,11 @@
 import { result, Result } from '@expo/results';
 
+import TestViewerContext from './TestViewerContext';
 import Entity from '../Entity';
 import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField, StringField, DateField, IntField } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
-import ViewerContext from '../ViewerContext';
 import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
 
 export type TestFields = {
@@ -48,28 +48,28 @@ export const testEntityConfiguration = new EntityConfiguration<TestFields>({
 export class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   TestFields,
   string,
-  ViewerContext,
+  TestViewerContext,
   TestEntity
 > {
   protected override readonly readRules = [
-    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+    new AlwaysAllowPrivacyPolicyRule<TestFields, string, TestViewerContext, TestEntity>(),
   ];
   protected override readonly createRules = [
-    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+    new AlwaysAllowPrivacyPolicyRule<TestFields, string, TestViewerContext, TestEntity>(),
   ];
   protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+    new AlwaysAllowPrivacyPolicyRule<TestFields, string, TestViewerContext, TestEntity>(),
   ];
   protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+    new AlwaysAllowPrivacyPolicyRule<TestFields, string, TestViewerContext, TestEntity>(),
   ];
 }
 
-export default class TestEntity extends Entity<TestFields, string, ViewerContext> {
+export default class TestEntity extends Entity<TestFields, string, TestViewerContext> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     TestFields,
     string,
-    ViewerContext,
+    TestViewerContext,
     TestEntity,
     TestEntityPrivacyPolicy
   > {
@@ -84,7 +84,10 @@ export default class TestEntity extends Entity<TestFields, string, ViewerContext
     return 'Hello World!';
   }
 
-  static async hello(viewerContext: ViewerContext, testValue: string): Promise<Result<TestEntity>> {
+  static async hello(
+    viewerContext: TestViewerContext,
+    testValue: string
+  ): Promise<Result<TestEntity>> {
     const fields = {
       customIdField: testValue,
       testIndexedField: 'hello',
@@ -103,15 +106,15 @@ export default class TestEntity extends Entity<TestFields, string, ViewerContext
     );
   }
 
-  static async returnError(_viewerContext: ViewerContext): Promise<Result<TestEntity>> {
+  static async returnError(_viewerContext: TestViewerContext): Promise<Result<TestEntity>> {
     return result(new Error('return entity'));
   }
 
-  static async throwError(_viewerContext: ViewerContext): Promise<Result<TestEntity>> {
+  static async throwError(_viewerContext: TestViewerContext): Promise<Result<TestEntity>> {
     throw new Error('threw entity');
   }
 
-  static async nonResult(_viewerContext: ViewerContext, testValue: string): Promise<string> {
+  static async nonResult(_viewerContext: TestViewerContext, testValue: string): Promise<string> {
     return testValue;
   }
 }

package/src/testfixtures/TestEntity2.ts

@@ -1,9 +1,9 @@
+import TestViewerContext from './TestViewerContext';
 import Entity from '../Entity';
 import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
-import ViewerContext from '../ViewerContext';
 import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
 
 export type Test2Fields = {
@@ -29,28 +29,28 @@ export const testEntity2Configuration = new EntityConfiguration<Test2Fields>({
 export class TestEntity2PrivacyPolicy extends EntityPrivacyPolicy<
   Test2Fields,
   string,
-  ViewerContext,
+  TestViewerContext,
   TestEntity2
 > {
   protected override readonly readRules = [
-    new AlwaysAllowPrivacyPolicyRule<Test2Fields, string, ViewerContext, TestEntity2>(),
+    new AlwaysAllowPrivacyPolicyRule<Test2Fields, string, TestViewerContext, TestEntity2>(),
   ];
   protected override readonly createRules = [
-    new AlwaysAllowPrivacyPolicyRule<Test2Fields, string, ViewerContext, TestEntity2>(),
+    new AlwaysAllowPrivacyPolicyRule<Test2Fields, string, TestViewerContext, TestEntity2>(),
   ];
   protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<Test2Fields, string, ViewerContext, TestEntity2>(),
+    new AlwaysAllowPrivacyPolicyRule<Test2Fields, string, TestViewerContext, TestEntity2>(),
   ];
   protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<Test2Fields, string, ViewerContext, TestEntity2>(),
+    new AlwaysAllowPrivacyPolicyRule<Test2Fields, string, TestViewerContext, TestEntity2>(),
   ];
 }
 
-export default class TestEntity2 extends Entity<Test2Fields, string, ViewerContext> {
+export default class TestEntity2 extends Entity<Test2Fields, string, TestViewerContext> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     Test2Fields,
     string,
-    ViewerContext,
+    TestViewerContext,
     TestEntity2,
     TestEntity2PrivacyPolicy
   > {

package/src/testfixtures/TestViewerContext.ts

@@ -1,3 +1,14 @@
+import { EntityQueryContext, EntityTransactionalQueryContext } from '../EntityQueryContext';
 import ViewerContext from '../ViewerContext';
 
-export default class TestViewerContext extends ViewerContext {}
+export default class TestViewerContext extends ViewerContext {
+  public getQueryContext(): EntityQueryContext {
+    return super.getNonTransactionalQueryContextForDatabaseAdaptorFlavor('postgres');
+  }
+
+  public async runInTransactionAsync<TResult>(
+    transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
+  ): Promise<TResult> {
+    return await super.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', transactionScope);
+  }
+}