feat: dataloaders within transactions

.eslintrc

@@ -10,8 +10,7 @@
   "rules": {
     "no-restricted-imports": ["error",{ "paths": [".", "..", "../.."] }],
     "tsdoc/syntax": "warn",
-    "no-console": "warn",
+    "no-console": "warn"
-    "handle-callback-err": "off"
   },
   "overrides": [
     {

CHANGELOG.md

@@ -3,189 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
-
-
-### Features
-
-* Upgrade knex to 1.x in `@expo/entity-database-adapter-knex` ([#150](https://github.com/expo/entity/issues/150)) ([e1b0ee5](https://github.com/expo/entity/commit/e1b0ee528175646239d88aa71ffce73983eeb52f))
-
-
-
-
-
-# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
-
-
-### Features
-
-* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
-
-
-
-
-
-# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
-
-
-### Bug Fixes
-
-* separate post-commit invalidation callbacks from trigger and user callbacks ([#144](https://github.com/expo/entity/issues/144)) ([efa131e](https://github.com/expo/entity/commit/efa131ef29532accf0e51b6d867ffe15a27b4c90))
-
-
-### Features
-
-* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
-
-
-
-
-
-# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
-
-
-### Features
-
-* add authorization metrics ([#142](https://github.com/expo/entity/issues/142)) ([7cf54d8](https://github.com/expo/entity/commit/7cf54d83c52e104159a3e2e675cdda2d29afe204))
-* add IP support ([#138](https://github.com/expo/entity/issues/138)) ([1405a91](https://github.com/expo/entity/commit/1405a9126ee3a56c3e2a38bf3b697283744f5b5d))
-
-
-
-
-
-# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
-
-
-### Features
-
-* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
-* expose describeFieldTestCase for use in other packages ([#139](https://github.com/expo/entity/issues/139)) ([1220477](https://github.com/expo/entity/commit/1220477aa331349b482ad015b44f76fa2bda7b90))
-* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
-* use better QueryContext types for transactional triggers and validators ([#136](https://github.com/expo/entity/issues/136)) ([5c7efe1](https://github.com/expo/entity/commit/5c7efe1678424ff907687e9327175bdc2538c3e0))
-
-
-
-
-
-# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
-
-
-### Features
-
-* Add IntField and FloatField, deprecate NumberField ([#131](https://github.com/expo/entity/issues/131)) ([2f2d963](https://github.com/expo/entity/commit/2f2d963cf92c6575d78f8eeca344a4aadcc9b8d9))
-
-
-
-
-
-# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
-
-
-### Features
-
-* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
-
-
-
-
-
-# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
-
-
-### Bug Fixes
-
-* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
-* upgrade some other packages to fix dependabot alerts ([#126](https://github.com/expo/entity/issues/126)) ([226bffe](https://github.com/expo/entity/commit/226bffe0a95d7b8a3e9e9d46aebdb0edf1eeec1a))
-* use column name instead of field name for redis cache key ([#124](https://github.com/expo/entity/issues/124)) ([d78f452](https://github.com/expo/entity/commit/d78f452bb3ac5527069813a03f5b2264375bd8ab))
-
-
-### Features
-
-* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
-
-
-
-
-
-## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
-
-
-### Bug Fixes
-
-* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
-
-
-
-
-
-# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
-
-
-### Bug Fixes
-
-* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
-
-
-### Features
-
-* add mutation type to validator and trigger execute functions ([#119](https://github.com/expo/entity/issues/119)) ([ef40fa5](https://github.com/expo/entity/commit/ef40fa5e9cdf53e25e78a9423c698e6d1c9737af))
-
-
-
-
-
-# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
-
-
-### Bug Fixes
-
-* allow undefined value for all fields ([#114](https://github.com/expo/entity/issues/114)) ([022e0e9](https://github.com/expo/entity/commit/022e0e9b88a5e84e0c1bc6c8810c850beb05f0cf))
-
-
-### Features
-
-* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
-
-
-
-
-
-# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
-
-
-### Bug Fixes
-
-* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
-* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
-
-
-### Features
-
-* better typing on filterMap for use with predicates ([#106](https://github.com/expo/entity/issues/106)) ([01b3bfe](https://github.com/expo/entity/commit/01b3bfef7c6da55e7d89d8cccb52a0050187aee8))
-
-
-
-
-
-# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
-
-
-### Bug Fixes
-
-* add type generic default in test utils ([#104](https://github.com/expo/entity/issues/104)) ([fe2917e](https://github.com/expo/entity/commit/fe2917e6b5af808f166aa354d476e168c41e6d21))
-* maps utils invariants for collections containing undefined values ([#103](https://github.com/expo/entity/issues/103)) ([29c1a43](https://github.com/expo/entity/commit/29c1a434ab6cd8d30e9f0e7c742065c8d46d8d8a))
-* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
-
-
-### Features
-
-* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
-* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
-
-
-
-
-
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 

lerna.json

@@ -4,5 +4,5 @@
   ],
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "0.22.0"
+  "version": "0.10.0"
 }

package.json

@@ -1,14 +1,11 @@
 {
   "name": "root",
   "private": true,
-  "workspaces": [
+  "workspaces": ["packages/*"],
-    "packages/*"
-  ],
   "scripts": {
     "tsc": "lerna run tsc",
     "clean": "lerna run clean",
     "lint": "lerna run lint",
-    "lint-fix": "lerna run lint-fix",
     "test": "lerna run test",
     "integration": "./resources/run-with-docker lerna run integration-no-setup",
     "prepublish": "lerna link && lerna run clean",
@@ -19,33 +16,30 @@
     "@expo/entity": "file:packages/entity",
     "@expo/results": "^1.0.0",
     "@types/invariant": "^2.2.33",
-    "@types/ioredis": "^4.26.4",
+    "@types/ioredis": "^4.17.3",
     "@types/jest": "^26.0.10",
-    "@types/jsbn": "^1.2.29",
     "@types/node": "^14.6.0",
     "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^4.14.0",
+    "@typescript-eslint/eslint-plugin": "^3.10.1",
-    "@typescript-eslint/parser": "^4.14.0",
+    "@typescript-eslint/parser": "^3.10.1",
     "barrelsby": "^2.2.0",
     "eslint": "^7.7.0",
-    "eslint-config-universe": "^7.0.0",
+    "eslint-config-universe": "^4.0.0",
-    "eslint-plugin-tsdoc": "^0.2.11",
+    "eslint-plugin-tsdoc": "^0.2.6",
-    "jest": "^26.6.3",
+    "jest": "^26.4.2",
-    "lerna": "^4.0.0",
+    "lerna": "^3.22.1",
-    "nullthrows": "^1.1.1",
+    "pg": "^8.3.2",
-    "pg": "^8.6.0",
+    "prettier": "^2.1.0",
-    "prettier": "^2.3.2",
+    "ts-jest": "~26.2.0",
-    "ts-jest": "~26.4.4",
     "ts-mockito": "^2.6.1",
-    "typedoc": "^0.21.9",
+    "typedoc": "^0.17.6",
-    "typescript": "^4.4.2",
+    "typedoc-plugin-lerna-packages": "^0.3.0",
+    "typescript": "^4.0.2",
     "uuid": "^8.3.0"
   },
   "dependencies": {
     "@expo/entity": "file:packages/entity",
     "@expo/entity-cache-adapter-redis": "file:packages/entity-cache-adapter-redis",
-    "@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex",
+    "@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex"
-    "@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis",
-    "@expo/entity-ip-address-field": "file:packages/entity-ip-address-field"
   }
 }

packages/entity-cache-adapter-redis/CHANGELOG.md

@@ -3,129 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
-
-
-### Features
-
-* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
-* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
-
-
-
-
-
-# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
-
-
-### Bug Fixes
-
-* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
-* use column name instead of field name for redis cache key ([#124](https://github.com/expo/entity/issues/124)) ([d78f452](https://github.com/expo/entity/commit/d78f452bb3ac5527069813a03f5b2264375bd8ab))
-
-
-### Features
-
-* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
-
-
-
-
-
-## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
-
-**Note:** Version bump only for package @expo/entity-cache-adapter-redis
-
-
-
-
-
-# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
-
-
-### Bug Fixes
-
-* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
-
-
-
-
-
-# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
-
-
-### Features
-
-* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
-
-
-
-
-
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 **Note:** Version bump only for package @expo/entity-cache-adapter-redis

packages/entity-cache-adapter-redis/README.md

@@ -12,7 +12,7 @@ During `EntityCompanionProvider` instantiation:
 import Redis from 'ioredis';
 
 const redisCacheAdapterContext = {
-  redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
+  redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
   makeKeyFn(...parts: string[]): string {
     const delimiter = ':';
     const escapedParts = parts.map((part) =>
@@ -35,7 +35,7 @@ export const createDefaultEntityCompanionProvider = (
       ...
     },
     {
-      ['redis']: {
+      [CacheAdapterFlavor.REDIS]: {
         cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
       },
     }

packages/entity-cache-adapter-redis/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expo/entity-cache-adapter-redis",
-  "version": "0.22.0",
+  "version": "0.10.0",
   "description": "Redis cache adapter for @expo/entity",
   "files": [
     "build",
@@ -11,8 +11,7 @@
   "scripts": {
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
-    "lint": "eslint src",
+    "lint": "eslint src --ext '.ts'",
-    "lint-fix": "eslint src --fix",
     "test": "jest --rootDir . --config ../../resources/jest.config.js",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
@@ -30,9 +29,9 @@
     "@expo/entity": "*"
   },
   "dependencies": {
-    "ioredis": "^4.27.3"
+    "ioredis": "^4.17.3"
   },
   "devDependencies": {
-    "@expo/entity": "^0.22.0"
+    "@expo/entity": "^0.10.0"
   }
 }

packages/entity-cache-adapter-redis/src/GenericRedisCacher.ts

@@ -1,107 +0,0 @@
-import { CacheLoadResult, CacheStatus } from '@expo/entity';
-import { Redis } from 'ioredis';
-
-import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
-
-// Sentinel value we store in Redis to negatively cache a database miss.
-// The sentinel value is distinct from any (positively) cached value.
-const DOES_NOT_EXIST_REDIS = '';
-
-export interface GenericRedisCacheContext {
-  /**
-   * Instance of ioredis.Redis
-   */
-  redisClient: Redis;
-
-  /**
-   * TTL for caching database hits. Successive entity loads within this TTL
-   * will be read from cache (unless invalidated).
-   */
-  ttlSecondsPositive: number;
-
-  /**
-   * TTL for negatively caching database misses. Successive entity loads within
-   * this TTL will be assumed not present in the database (unless invalidated).
-   */
-  ttlSecondsNegative: number;
-}
-
-export default class GenericRedisCacher {
-  constructor(private readonly context: GenericRedisCacheContext) {}
-
-  public async loadManyAsync(
-    keys: readonly string[]
-  ): Promise<ReadonlyMap<string, CacheLoadResult>> {
-    if (keys.length === 0) {
-      return new Map();
-    }
-
-    const redisResults = await wrapNativeRedisCallAsync(() =>
-      this.context.redisClient.mget(...keys)
-    );
-
-    const results = new Map<string, CacheLoadResult>();
-    for (let i = 0; i < keys.length; i++) {
-      const key = keys[i]!;
-      const redisResult = redisResults[i];
-
-      if (redisResult === DOES_NOT_EXIST_REDIS) {
-        results.set(key, {
-          status: CacheStatus.NEGATIVE,
-        });
-      } else if (redisResult) {
-        results.set(key, {
-          status: CacheStatus.HIT,
-          item: JSON.parse(redisResult),
-        });
-      } else {
-        results.set(key, {
-          status: CacheStatus.MISS,
-        });
-      }
-    }
-    return results;
-  }
-
-  public async cacheManyAsync(objectMap: ReadonlyMap<string, object>): Promise<void> {
-    if (objectMap.size === 0) {
-      return;
-    }
-
-    let redisTransaction = this.context.redisClient.multi();
-    objectMap.forEach((object, key) => {
-      redisTransaction = redisTransaction.set(
-        key,
-        JSON.stringify(object),
-        'EX',
-        this.context.ttlSecondsPositive
-      );
-    });
-    await wrapNativeRedisCallAsync(() => redisTransaction.exec());
-  }
-
-  public async cacheDBMissesAsync(keys: string[]): Promise<void> {
-    if (keys.length === 0) {
-      return;
-    }
-
-    let redisTransaction = this.context.redisClient.multi();
-    keys.forEach((key) => {
-      redisTransaction = redisTransaction.set(
-        key,
-        DOES_NOT_EXIST_REDIS,
-        'EX',
-        this.context.ttlSecondsNegative
-      );
-    });
-    await wrapNativeRedisCallAsync(() => redisTransaction.exec());
-  }
-
-  public async invalidateManyAsync(keys: string[]): Promise<void> {
-    if (keys.length === 0) {
-      return;
-    }
-
-    await wrapNativeRedisCallAsync(() => this.context.redisClient.del(...keys));
-  }
-}

packages/entity-cache-adapter-redis/src/RedisCacheAdapter.ts

@@ -1,19 +1,18 @@
 import {
   EntityCacheAdapter,
   EntityConfiguration,
-  CacheLoadResult,
   FieldTransformerMap,
-  mapKeys,
+  CacheLoadResult,
-  transformCacheObjectToFields,
   CacheStatus,
-  transformFieldsToCacheObject,
 } from '@expo/entity';
-import invariant from 'invariant';
 import { Redis } from 'ioredis';
 
-import GenericRedisCacher from './GenericRedisCacher';
 import { redisTransformerMap } from './RedisCommon';
 
+// Sentinel value we store in Redis to negatively cache a database miss.
+// The sentinel value is distinct from any (positively) cached value.
+const DOES_NOT_EXIST_REDIS = '';
+
 export interface RedisCacheAdapterContext {
   /**
    * Instance of ioredis.Redis
@@ -52,112 +51,114 @@ export interface RedisCacheAdapterContext {
 }
 
 export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
-  /**
-   * Transformer definitions for field types. Used to modify values as they are read from or written to
-   * the cache. Override in concrete subclasses to change transformation behavior.
-   * If a field type is not present in the map, then fields of that type will not be transformed.
-   */
-  private readonly redisFieldTransformer: FieldTransformerMap = redisTransformerMap;
-  private readonly genericRedisCacher: GenericRedisCacher;
   constructor(
     entityConfiguration: EntityConfiguration<TFields>,
     private readonly context: RedisCacheAdapterContext
   ) {
     super(entityConfiguration);
+  }
 
-    this.genericRedisCacher = new GenericRedisCacher({
+  public getFieldTransformerMap(): FieldTransformerMap {
-      redisClient: context.redisClient,
+    return redisTransformerMap;
-      ttlSecondsNegative: context.ttlSecondsNegative,
-      ttlSecondsPositive: context.ttlSecondsPositive,
-    });
   }
 
   public async loadManyAsync<N extends keyof TFields>(
     fieldName: N,
     fieldValues: readonly NonNullable<TFields[N]>[]
   ): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult>> {
-    const redisCacheKeyToFieldValueMapping = new Map(
+    if (fieldValues.length === 0) {
-      fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue])
+      return new Map();
-    );
-    const rawCacheResults = await this.genericRedisCacher.loadManyAsync(
-      Array.from(redisCacheKeyToFieldValueMapping.keys())
-    );
-    const cacheResults = new Map<string, CacheLoadResult>();
-    for (const [redisCacheKey, rawCacheResult] of rawCacheResults) {
-      if (rawCacheResult.status === CacheStatus.HIT) {
-        cacheResults.set(redisCacheKey, {
-          status: CacheStatus.HIT,
-          item: transformCacheObjectToFields(
-            this.entityConfiguration,
-            this.redisFieldTransformer,
-            rawCacheResult.item
-          ),
-        });
-      } else {
-        cacheResults.set(redisCacheKey, rawCacheResult);
-      }
     }
 
-    return mapKeys(cacheResults, (redisCacheKey) => {
+    const redisKeys = fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue));
-      const fieldValue = redisCacheKeyToFieldValueMapping.get(redisCacheKey);
+    const redisResults = await this.context.redisClient.mget(...redisKeys);
-      invariant(
+
-        fieldValue !== undefined,
+    const results = new Map<NonNullable<TFields[N]>, CacheLoadResult>();
-        'Unspecified cache key %s returned from generic Redis cacher',
+    for (let i = 0; i < fieldValues.length; i++) {
-        redisCacheKey
+      const fieldValue = fieldValues[i];
-      );
+      const redisResult = redisResults[i];
-      return fieldValue;
+
+      if (redisResult === DOES_NOT_EXIST_REDIS) {
+        results.set(fieldValue, {
+          status: CacheStatus.NEGATIVE,
         });
+      } else if (redisResult) {
+        results.set(fieldValue, {
+          status: CacheStatus.HIT,
+          item: JSON.parse(redisResult),
+        });
+      } else {
+        results.set(fieldValue, {
+          status: CacheStatus.MISS,
+        });
+      }
+    }
+    return results;
   }
 
   public async cacheManyAsync<N extends keyof TFields>(
     fieldName: N,
     objectMap: ReadonlyMap<NonNullable<TFields[N]>, object>
   ): Promise<void> {
-    const cacheObjectMap = new Map<NonNullable<TFields[N]>, object>();
+    if (objectMap.size === 0) {
-    for (const [fieldValue, object] of objectMap) {
+      return;
-      cacheObjectMap.set(
-        fieldValue,
-        transformFieldsToCacheObject(
-          this.entityConfiguration,
-          this.redisFieldTransformer,
-          object as Readonly<TFields>
-        )
-      );
     }
-    await this.genericRedisCacher.cacheManyAsync(
+
-      mapKeys(cacheObjectMap, (fieldValue) => this.makeCacheKey(fieldName, fieldValue))
+    let redisTransaction = this.context.redisClient.multi();
+    objectMap.forEach((object, fieldValue) => {
+      const redisKey = this.makeCacheKey(fieldName, fieldValue);
+      redisTransaction = redisTransaction.set(
+        redisKey,
+        JSON.stringify(object),
+        'EX',
+        this.context.ttlSecondsPositive
       );
+    });
+    await redisTransaction.exec();
   }
 
   public async cacheDBMissesAsync<N extends keyof TFields>(
     fieldName: N,
     fieldValues: readonly NonNullable<TFields[N]>[]
   ): Promise<void> {
-    await this.genericRedisCacher.cacheDBMissesAsync(
+    if (fieldValues.length === 0) {
-      fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
+      return;
+    }
+
+    let redisTransaction = this.context.redisClient.multi();
+    fieldValues.forEach((fieldValue) => {
+      const redisKey = this.makeCacheKey(fieldName, fieldValue);
+      redisTransaction = redisTransaction.set(
+        redisKey,
+        DOES_NOT_EXIST_REDIS,
+        'EX',
+        this.context.ttlSecondsNegative
       );
+    });
+    await redisTransaction.exec();
   }
 
   public async invalidateManyAsync<N extends keyof TFields>(
     fieldName: N,
     fieldValues: readonly NonNullable<TFields[N]>[]
   ): Promise<void> {
-    await this.genericRedisCacher.invalidateManyAsync(
+    if (fieldValues.length === 0) {
-      fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
+      return;
-    );
+    }
+
+    const redisKeys = fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue));
+    await this.context.redisClient.del(...redisKeys);
   }
 
   private makeCacheKey<N extends keyof TFields>(
     fieldName: N,
     fieldValue: NonNullable<TFields[N]>
   ): string {
-    const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
-    invariant(columnName, `database field mapping missing for ${fieldName}`);
     return this.context.makeKeyFn(
       this.context.cacheKeyPrefix,
       this.entityConfiguration.tableName,
-      `v2.${this.entityConfiguration.cacheKeyVersion}`,
+      `v${this.entityConfiguration.cacheKeyVersion}`,
-      columnName,
+      fieldName as string,
       String(fieldValue)
     );
   }

packages/entity-cache-adapter-redis/src/__integration-tests__/RedisCacheAdapter-integration-test.ts

@@ -15,7 +15,7 @@ describe(RedisCacheAdapter, () => {
 
   beforeAll(() => {
     redisCacheAdapterContext = {
-      redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
+      redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
       makeKeyFn(...parts: string[]): string {
         const delimiter = ':';
         const escapedParts = parts.map((part) =>
@@ -38,21 +38,21 @@ describe(RedisCacheAdapter, () => {
   });
 
   it('has correct caching behavior', async () => {
-    const viewerContext = new TestViewerContext(
+    const vc1 = new TestViewerContext(
       createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
     );
-    const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
+    const cacheAdapter = vc1.entityCompanionProvider.getCompanionForEntity(
       RedisTestEntity,
       RedisTestEntity.getCompanionDefinition()
     )['tableDataCoordinator']['cacheAdapter'];
     const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
 
-    const entity1Created = await RedisTestEntity.creator(viewerContext)
+    const entity1Created = await RedisTestEntity.creator(vc1)
       .setField('name', 'blah')
       .enforceCreateAsync();
 
     // loading an entity should put it in cache
-    const entity1 = await RedisTestEntity.loader(viewerContext)
+    const entity1 = await RedisTestEntity.loader(vc1)
       .enforcing()
       .loadByIDAsync(entity1Created.getID());
 
@@ -68,9 +68,7 @@ describe(RedisCacheAdapter, () => {
     // simulate non existent db fetch, should write negative result ('') to cache
     const nonExistentId = uuidv4();
 
-    const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
+    const entityNonExistentResult = await RedisTestEntity.loader(vc1).loadByIDAsync(nonExistentId);
-      nonExistentId
-    );
     expect(entityNonExistentResult.ok).toBe(false);
 
     const nonExistentCachedValue = await redisCacheAdapterContext.redisClient.get(
@@ -79,13 +77,11 @@ describe(RedisCacheAdapter, () => {
     expect(nonExistentCachedValue).toEqual('');
 
     // load again through entities framework to ensure it reads negative result
-    const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
+    const entityNonExistentResult2 = await RedisTestEntity.loader(vc1).loadByIDAsync(nonExistentId);
-      nonExistentId
-    );
     expect(entityNonExistentResult2.ok).toBe(false);
 
     // invalidate from cache to ensure it invalidates correctly
-    await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
+    await RedisTestEntity.loader(vc1).invalidateFieldsAsync(entity1.getAllFields());
     const cachedValueNull = await redisCacheAdapterContext.redisClient.get(
       cacheKeyMaker('id', entity1.getID())
     );
@@ -93,18 +89,16 @@ describe(RedisCacheAdapter, () => {
   });
 
   it('caches and restores date fields', async () => {
-    const viewerContext = new TestViewerContext(
+    const vc1 = new TestViewerContext(
       createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
     );
     const date = new Date();
     const entity1 = await enforceAsyncResult(
-      RedisTestEntity.creator(viewerContext).setField('dateField', date).createAsync()
+      RedisTestEntity.creator(vc1).setField('dateField', date).createAsync()
     );
     expect(entity1.getField('dateField')).toEqual(date);
 
-    const entity2 = await RedisTestEntity.loader(viewerContext)
+    const entity2 = await RedisTestEntity.loader(vc1).enforcing().loadByIDAsync(entity1.getID());
-      .enforcing()
-      .loadByIDAsync(entity1.getID());
     expect(entity2.getField('dateField')).toEqual(date);
 
     // simulate new request
@@ -114,26 +108,4 @@ describe(RedisCacheAdapter, () => {
     const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
     expect(entity3.getField('dateField')).toEqual(date);
   });
-
-  it('caches and restores empty string field keys', async () => {
-    const viewerContext = new TestViewerContext(
-      createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
-    );
-    const entity1 = await enforceAsyncResult(
-      RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
-    );
-    const entity2 = await RedisTestEntity.loader(viewerContext)
-      .enforcing()
-      .loadByFieldEqualingAsync('name', '');
-    expect(entity2?.getID()).toEqual(entity1.getID());
-
-    // simulate new request
-    const vc2 = new TestViewerContext(
-      createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
-    );
-    const entity3 = await RedisTestEntity.loader(vc2)
-      .enforcing()
-      .loadByFieldEqualingAsync('name', '');
-    expect(entity3?.getID()).toEqual(entity1.getID());
-  });
 });

packages/entity-cache-adapter-redis/src/__integration-tests__/errors-test.ts

@@ -1,46 +0,0 @@
-import { EntityCacheAdapterTransientError, ViewerContext } from '@expo/entity';
-import Redis from 'ioredis';
-import { URL } from 'url';
-
-import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
-import RedisTestEntity from '../testfixtures/RedisTestEntity';
-import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
-
-class TestViewerContext extends ViewerContext {}
-
-describe(RedisCacheAdapter, () => {
-  let redisCacheAdapterContext: RedisCacheAdapterContext;
-
-  beforeAll(() => {
-    redisCacheAdapterContext = {
-      redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
-      makeKeyFn(...parts: string[]): string {
-        const delimiter = ':';
-        const escapedParts = parts.map((part) =>
-          part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
-        );
-        return escapedParts.join(delimiter);
-      },
-      cacheKeyPrefix: 'test-',
-      cacheKeyVersion: 1,
-      ttlSecondsPositive: 86400, // 1 day
-      ttlSecondsNegative: 600, // 10 minutes
-    };
-  });
-
-  beforeEach(async () => {
-    await redisCacheAdapterContext.redisClient.flushdb();
-  });
-
-  it('throws when redis is disconnected', async () => {
-    redisCacheAdapterContext.redisClient.disconnect();
-
-    const vc1 = new TestViewerContext(
-      createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
-    );
-
-    await expect(
-      RedisTestEntity.creator(vc1).setField('name', 'blah').enforceCreateAsync()
-    ).rejects.toThrow(EntityCacheAdapterTransientError);
-  });
-});

packages/entity-cache-adapter-redis/src/__tests__/RedisCacheAdapter-test.ts

@@ -1,4 +1,10 @@
-import { CacheStatus, UUIDField, EntityConfiguration, DateField } from '@expo/entity';
+import {
+  CacheStatus,
+  UUIDField,
+  EntityConfiguration,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
+} from '@expo/entity';
 import { Redis, Pipeline } from 'ioredis';
 import { mock, when, instance, anything, verify } from 'ts-mockito';
 
@@ -6,7 +12,6 @@ import RedisCacheAdapter from '../RedisCacheAdapter';
 
 type BlahFields = {
   id: string;
-  date: Date | null;
 };
 
 const entityConfiguration = new EntityConfiguration<BlahFields>({
@@ -14,10 +19,9 @@ const entityConfiguration = new EntityConfiguration<BlahFields>({
   tableName: 'blah',
   schema: {
     id: new UUIDField({ columnName: 'id', cache: true }),
-    date: new DateField({ columnName: 'date' }),
   },
-  databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
 });
 
 describe(RedisCacheAdapter, () => {
@@ -64,40 +68,6 @@ describe(RedisCacheAdapter, () => {
       const results = await cacheAdapter.loadManyAsync('id', []);
       expect(results).toEqual(new Map());
     });
-
-    it('transforms a cache object to an Entity object', async () => {
-      const redisResults = new Map();
-
-      const mockRedisClient = mock<Redis>();
-
-      // need to have one anything() for each element of spread, in this case 1
-      when(mockRedisClient.mget(anything())).thenCall(async (...keys) =>
-        keys.map((k) => redisResults.get(k) ?? null)
-      );
-
-      const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
-        redisClient: instance(mockRedisClient),
-        makeKeyFn: (...parts) => parts.join(':'),
-        cacheKeyVersion: 1,
-        cacheKeyPrefix: 'hello-',
-        ttlSecondsPositive: 1,
-        ttlSecondsNegative: 2,
-      });
-
-      const date = new Date();
-      redisResults.set(
-        cacheAdapter['makeCacheKey']('id', 'wat'),
-        JSON.stringify({ id: 'wat', date: date.toISOString() })
-      );
-
-      const results = await cacheAdapter.loadManyAsync('id', ['wat']);
-
-      expect(results.get('wat')).toMatchObject({
-        status: CacheStatus.HIT,
-        item: { id: 'wat', date },
-      });
-      expect(results.size).toBe(1);
-    });
   });
 
   describe('cacheManyAsync', () => {
@@ -134,41 +104,6 @@ describe(RedisCacheAdapter, () => {
         ttl: 1,
       });
     });
-
-    it('transforms an Entity object to a cache object', async () => {
-      const redisResults = new Map();
-
-      const mockPipeline = mock<Pipeline>();
-      when(mockPipeline.set(anything(), anything(), anything(), anything())).thenCall(
-        (key, value, code, ttl) => {
-          redisResults.set(key, { value, code, ttl });
-          return pipeline;
-        }
-      );
-      when(mockPipeline.exec()).thenResolve({} as any);
-      const pipeline = instance(mockPipeline);
-
-      const mockRedisClient = mock<Redis>();
-      when(mockRedisClient.multi()).thenReturn(pipeline);
-
-      const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
-        redisClient: instance(mockRedisClient),
-        makeKeyFn: (...parts) => parts.join(':'),
-        cacheKeyVersion: 1,
-        cacheKeyPrefix: 'hello-',
-        ttlSecondsPositive: 1,
-        ttlSecondsNegative: 2,
-      });
-      const date = new Date();
-      await cacheAdapter.cacheManyAsync('id', new Map([['wat', { id: 'wat', date }]]));
-
-      const cacheKey = cacheAdapter['makeCacheKey']('id', 'wat');
-      expect(redisResults.get(cacheKey)).toMatchObject({
-        value: JSON.stringify({ id: 'wat', date: date.toISOString() }),
-        code: 'EX',
-        ttl: 1,
-      });
-    });
   });
 
   describe('cacheDBMissesAsync', () => {

packages/entity-cache-adapter-redis/src/errors/__tests__/wrapNativeRedisCallAsync-test.ts

@@ -1,39 +0,0 @@
-import { EntityCacheAdapterTransientError } from '@expo/entity';
-
-import wrapNativeRedisCallAsync from '../wrapNativeRedisCallAsync';
-
-describe(wrapNativeRedisCallAsync, () => {
-  it('rethrows literals', async () => {
-    const throwingFn = async (): Promise<void> => {
-      // eslint-disable-next-line no-throw-literal,@typescript-eslint/no-throw-literal
-      throw 'hello';
-    };
-
-    let capturedThrownThing: any;
-    try {
-      await wrapNativeRedisCallAsync(throwingFn);
-    } catch (e) {
-      capturedThrownThing = e;
-    }
-    expect(capturedThrownThing).not.toBeInstanceOf(Error);
-    expect(capturedThrownThing).toEqual('hello');
-  });
-
-  it('wraps errors with stacks', async () => {
-    const throwingFn = async (): Promise<void> => {
-      const e = new Error('hello');
-      e.stack = 'world';
-      throw e;
-    };
-
-    let capturedThrownThing: any;
-    try {
-      await wrapNativeRedisCallAsync(throwingFn);
-    } catch (e) {
-      capturedThrownThing = e;
-    }
-    expect(capturedThrownThing).toBeInstanceOf(EntityCacheAdapterTransientError);
-    expect(capturedThrownThing.message).toEqual('hello');
-    expect(capturedThrownThing.stack).toEqual('world');
-  });
-});

packages/entity-cache-adapter-redis/src/errors/wrapNativeRedisCallAsync.ts

@@ -1,17 +0,0 @@
-import { EntityCacheAdapterTransientError } from '@expo/entity';
-
-export default async function wrapNativeRedisCallAsync<T>(fn: () => Promise<T>): Promise<T> {
-  try {
-    return await fn();
-  } catch (e) {
-    if (!(e instanceof Error)) {
-      throw e;
-    }
-
-    const error = new EntityCacheAdapterTransientError(e.message, e);
-    if (e.stack) {
-      error.stack = e.stack;
-    }
-    throw error;
-  }
-}

packages/entity-cache-adapter-redis/src/index.ts

@@ -1,12 +1,8 @@
-/* eslint-disable tsdoc/syntax */
 /**
- * @packageDocumentation
+ * Automatically generated by barrelsby.
- * @module @expo/entity-cache-adapter-redis
  */
 
 export { default as RedisCacheAdapter } from './RedisCacheAdapter';
 export * from './RedisCacheAdapter';
 export { default as RedisCacheAdapterProvider } from './RedisCacheAdapterProvider';
 export * from './RedisCommon';
-export { default as GenericRedisCacher } from './GenericRedisCacher';
-export * from './GenericRedisCacher';

packages/entity-cache-adapter-redis/src/testfixtures/RedisTestEntity.ts

@@ -6,6 +6,8 @@ import {
   DateField,
   StringField,
   EntityConfiguration,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
 } from '@expo/entity';
@@ -28,13 +30,13 @@ export default class RedisTestEntity extends Entity<RedisTestEntityFields, strin
   }
 }
 
-export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
+class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   RedisTestEntityFields,
   string,
   ViewerContext,
   RedisTestEntity
 > {
-  protected override readonly createRules = [
+  protected readonly createRules = [
     new AlwaysAllowPrivacyPolicyRule<
       RedisTestEntityFields,
       string,
@@ -42,7 +44,7 @@ export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       RedisTestEntity
     >(),
   ];
-  protected override readonly readRules = [
+  protected readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       RedisTestEntityFields,
       string,
@@ -50,7 +52,7 @@ export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       RedisTestEntity
     >(),
   ];
-  protected override readonly updateRules = [
+  protected readonly updateRules = [
     new AlwaysAllowPrivacyPolicyRule<
       RedisTestEntityFields,
       string,
@@ -58,7 +60,7 @@ export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       RedisTestEntity
     >(),
   ];
-  protected override readonly deleteRules = [
+  protected readonly deleteRules = [
     new AlwaysAllowPrivacyPolicyRule<
       RedisTestEntityFields,
       string,
@@ -78,14 +80,13 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
     }),
     name: new StringField({
       columnName: 'name',
-      cache: true,
     }),
     dateField: new DateField({
       columnName: 'date_field',
     }),
   },
-  databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
 });
 
 const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({

packages/entity-cache-adapter-redis/src/testfixtures/createRedisIntegrationTestEntityCompanionProvider.ts

@@ -2,6 +2,8 @@ import {
   NoOpEntityMetricsAdapter,
   IEntityMetricsAdapter,
   EntityCompanionProvider,
+  CacheAdapterFlavor,
+  DatabaseAdapterFlavor,
   StubQueryContextProvider,
   StubDatabaseAdapterProvider,
 } from '@expo/entity';
@@ -15,22 +17,16 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
-    new Map([
-      [
-        'postgres',
     {
+      [DatabaseAdapterFlavor.POSTGRES]: {
         adapterProvider: new StubDatabaseAdapterProvider(),
         queryContextProvider: StubQueryContextProvider,
       },
-      ],
+    },
-    ]),
-    new Map([
-      [
-        'redis',
     {
+      [CacheAdapterFlavor.REDIS]: {
         cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
       },
-      ],
+    }
-    ])
   );
 };

packages/entity-database-adapter-knex/CHANGELOG.md

@@ -3,154 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
-
-
-### Features
-
-* Upgrade knex to 1.x in `@expo/entity-database-adapter-knex` ([#150](https://github.com/expo/entity/issues/150)) ([e1b0ee5](https://github.com/expo/entity/commit/e1b0ee528175646239d88aa71ffce73983eeb52f))
-
-
-
-
-
-# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
-
-
-### Features
-
-* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
-
-
-
-
-
-# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
-
-
-### Features
-
-* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
-
-
-
-
-
-# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
-
-**Note:** Version bump only for package @expo/entity-database-adapter-knex
-
-
-
-
-
-# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
-
-
-### Features
-
-* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
-* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
-
-
-
-
-
-# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
-
-
-### Features
-
-* Add IntField and FloatField, deprecate NumberField ([#131](https://github.com/expo/entity/issues/131)) ([2f2d963](https://github.com/expo/entity/commit/2f2d963cf92c6575d78f8eeca344a4aadcc9b8d9))
-
-
-
-
-
-# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
-
-
-### Features
-
-* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
-
-
-
-
-
-# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
-
-
-### Bug Fixes
-
-* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
-
-
-### Features
-
-* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
-
-
-
-
-
-## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
-
-
-### Bug Fixes
-
-* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
-
-
-
-
-
-# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
-
-
-### Bug Fixes
-
-* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
-
-
-
-
-
-# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
-
-
-### Features
-
-* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
-
-
-
-
-
-# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
-
-
-### Bug Fixes
-
-* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
-* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
-
-
-
-
-
-# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
-
-
-### Features
-
-* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
-* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
-
-
-
-
-
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 **Note:** Version bump only for package @expo/entity-database-adapter-knex

packages/entity-database-adapter-knex/README.md

@@ -9,16 +9,16 @@
 During `EntityCompanionProvider` instantiation:
 
 ```typescript
-import { knex, Knex } from 'knex';
+import Knex from 'knex';
 
-const knexInstance = knex({
+const knexInstance = Knex({
   client: 'pg',
   connection: {
-    user: process.env['PGUSER'],
+    user: process.env.PGUSER,
-    password: process.env['PGPASSWORD'],
+    password: process.env.PGPASSWORD,
-    host: process.env['PGHOST'],
+    host: process.env.PGHOST,
-    port: parseInt(nullthrows(process.env['PGPORT']), 10),
+    port: parseInt(process.env.PGPORT!, 10),
-    database: process.env['PGDATABASE'],
+    database: process.env.PGDATABASE,
   },
 });
 
@@ -29,7 +29,7 @@ export const createDefaultEntityCompanionProvider = (
     metricsAdapter,
     {
       // add the knex database adapter flavor
-      ['postgres']: {
+      [DatabaseAdapterFlavor.POSTGRES]: {
         adapter: PostgresEntityDatabaseAdapter,
         queryContextProvider: new PostgresEntityQueryContextProvider(knexInstance),
       },

packages/entity-database-adapter-knex/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expo/entity-database-adapter-knex",
-  "version": "0.22.0",
+  "version": "0.10.0",
   "description": "Knex database adapter for @expo/entity",
   "files": [
     "build",
@@ -11,8 +11,7 @@
   "scripts": {
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
-    "lint": "eslint src",
+    "lint": "eslint src --ext '.ts'",
-    "lint-fix": "eslint src --fix",
     "test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
@@ -30,10 +29,9 @@
     "@expo/entity": "*"
   },
   "dependencies": {
-    "knex": "^1.0.2"
+    "knex": "^0.21.5"
   },
   "devDependencies": {
-    "@expo/entity": "^0.22.0",
+    "@expo/entity": "^0.10.0"
-    "pg": "^8.7.1"
   }
 }

packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts

@@ -8,9 +8,7 @@ import {
   TableFieldSingleValueEqualityCondition,
   TableFieldMultiValueEqualityCondition,
 } from '@expo/entity';
-import { Knex } from 'knex';
+import Knex from 'knex';
-
-import wrapNativePostgresCallAsync from './errors/wrapNativePostgresCallAsync';
 
 export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDatabaseAdapter<TFields> {
   protected getFieldTransformerMap(): FieldTransformerMap {
@@ -45,12 +43,10 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
     tableField: string,
     tableValues: readonly any[]
   ): Promise<object[]> {
-    return await wrapNativePostgresCallAsync(() =>
+    return await queryInterface
-      queryInterface
       .select()
       .from(tableName)
-        .whereRaw('?? = ANY(?)', [tableField, tableValues as any[]])
+      .whereRaw('?? = ANY(?)', [tableField, tableValues as any[]]);
-    );
   }
 
   private applyQueryModifiersToQuery(
@@ -89,39 +85,20 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
 
     if (tableFieldSingleValueEqualityOperands.length > 0) {
       const whereObject: { [key: string]: any } = {};
-      const nonNullTableFieldSingleValueEqualityOperands =
+      for (const { tableField, tableValue } of tableFieldSingleValueEqualityOperands) {
-        tableFieldSingleValueEqualityOperands.filter(({ tableValue }) => tableValue !== null);
-      const nullTableFieldSingleValueEqualityOperands =
-        tableFieldSingleValueEqualityOperands.filter(({ tableValue }) => tableValue === null);
-
-      if (nonNullTableFieldSingleValueEqualityOperands.length > 0) {
-        for (const { tableField, tableValue } of nonNullTableFieldSingleValueEqualityOperands) {
         whereObject[tableField] = tableValue;
       }
       query = query.where(whereObject);
     }
-      if (nullTableFieldSingleValueEqualityOperands.length > 0) {
-        for (const { tableField } of nullTableFieldSingleValueEqualityOperands) {
-          query = query.whereNull(tableField);
-        }
-      }
-    }
 
     if (tableFieldMultiValueEqualityOperands.length > 0) {
       for (const { tableField, tableValues } of tableFieldMultiValueEqualityOperands) {
-        const nonNullTableValues = tableValues.filter((tableValue) => tableValue !== null);
+        query = query.whereRaw('?? = ANY(?)', [tableField, tableValues]);
-        query = query.where((builder) => {
-          builder.whereRaw('?? = ANY(?)', [tableField, [...nonNullTableValues]]);
-          // there was at least one null, allow null in this equality clause
-          if (nonNullTableValues.length !== tableValues.length) {
-            builder.orWhereNull(tableField);
-          }
-        });
       }
     }
 
     query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
-    return await wrapNativePostgresCallAsync(() => query);
+    return await query;
   }
 
   protected async fetchManyByRawWhereClauseInternalAsync(
@@ -136,7 +113,7 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
       .from(tableName)
       .whereRaw(rawWhereClause, bindings as any);
     query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
-    return await wrapNativePostgresCallAsync(() => query);
+    return await query;
   }
 
   protected async insertInternalAsync(
@@ -144,9 +121,7 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
     tableName: string,
     object: object
   ): Promise<object[]> {
-    return await wrapNativePostgresCallAsync(() =>
+    return await queryInterface.insert(object).into(tableName).returning('*');
-      queryInterface.insert(object).into(tableName).returning('*')
-    );
   }
 
   protected async updateInternalAsync(
@@ -156,9 +131,11 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
     id: any,
     object: object
   ): Promise<object[]> {
-    return await wrapNativePostgresCallAsync(() =>
+    return await queryInterface
-      queryInterface.update(object).into(tableName).where(tableIdField, id).returning('*')
+      .update(object)
-    );
+      .into(tableName)
+      .where(tableIdField, id)
+      .returning('*');
   }
 
   protected async deleteInternalAsync(
@@ -167,8 +144,6 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
     tableIdField: string,
     id: any
   ): Promise<number> {
-    return await wrapNativePostgresCallAsync(() =>
+    return await queryInterface.into(tableName).where(tableIdField, id).del();
-      queryInterface.into(tableName).where(tableIdField, id).del()
-    );
   }
 }

packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapterProvider.ts

@@ -7,8 +7,7 @@ import {
 import PostgresEntityDatabaseAdapter from './PostgresEntityDatabaseAdapter';
 
 export default class PostgresEntityDatabaseAdapterProvider
-  implements IEntityDatabaseAdapterProvider
+  implements IEntityDatabaseAdapterProvider {
-{
   getDatabaseAdapter<TFields>(
     entityConfiguration: EntityConfiguration<TFields>
   ): EntityDatabaseAdapter<TFields> {

packages/entity-database-adapter-knex/src/PostgresEntityQueryContextProvider.ts

@@ -1,5 +1,5 @@
 import { EntityQueryContextProvider } from '@expo/entity';
-import { Knex } from 'knex';
+import Knex from 'knex';
 
 /**
  * Query context provider for knex (postgres).

packages/entity-database-adapter-knex/src/__integration-tests__/PostgresEntityIntegration-test.ts

@@ -5,8 +5,7 @@ import {
   ViewerContext,
 } from '@expo/entity';
 import { enforceAsyncResult } from '@expo/results';
-import { knex, Knex } from 'knex';
+import Knex from 'knex';
-import nullthrows from 'nullthrows';
 
 import PostgresTestEntity from '../testfixtures/PostgresTestEntity';
 import PostgresTriggerTestEntity from '../testfixtures/PostgresTriggerTestEntity';
@@ -17,14 +16,14 @@ describe('postgres entity integration', () => {
   let knexInstance: Knex;
 
   beforeAll(() => {
-    knexInstance = knex({
+    knexInstance = Knex({
       client: 'pg',
       connection: {
-        user: nullthrows(process.env['PGUSER']),
+        user: process.env.PGUSER,
-        password: nullthrows(process.env['PGPASSWORD']),
+        password: process.env.PGPASSWORD,
         host: 'localhost',
-        port: parseInt(nullthrows(process.env['PGPORT']), 10),
+        port: parseInt(process.env.PGPORT!, 10),
-        database: nullthrows(process.env['PGDATABASE']),
+        database: process.env.PGDATABASE,
       },
     });
   });
@@ -95,7 +94,7 @@ describe('postgres entity integration', () => {
     const errorToThrow = new Error('Intentional error');
 
     await expect(
-      vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
+      PostgresTestEntity.runInTransactionAsync(vc1, async (queryContext) => {
         // put another in the DB that will be rolled back due to error thrown
         await enforceAsyncResult(
           PostgresTestEntity.creator(vc1, queryContext).setField('name', 'hello').createAsync()
@@ -232,59 +231,6 @@ describe('postgres entity integration', () => {
       expect(results).toHaveLength(2);
       expect(results.map((e) => e.getField('name'))).toEqual(['b', 'a']);
     });
-
-    it('supports null field values', async () => {
-      const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-      await enforceAsyncResult(
-        PostgresTestEntity.creator(vc1)
-          .setField('name', 'a')
-          .setField('hasADog', true)
-          .createAsync()
-      );
-      await enforceAsyncResult(
-        PostgresTestEntity.creator(vc1)
-          .setField('name', 'b')
-          .setField('hasADog', true)
-          .createAsync()
-      );
-      await enforceAsyncResult(
-        PostgresTestEntity.creator(vc1)
-          .setField('name', null)
-          .setField('hasADog', true)
-          .createAsync()
-      );
-      await enforceAsyncResult(
-        PostgresTestEntity.creator(vc1)
-          .setField('name', null)
-          .setField('hasADog', false)
-          .createAsync()
-      );
-
-      const results = await PostgresTestEntity.loader(vc1)
-        .enforcing()
-        .loadManyByFieldEqualityConjunctionAsync([{ fieldName: 'name', fieldValue: null }]);
-      expect(results).toHaveLength(2);
-      expect(results[0]!.getField('name')).toBeNull();
-
-      const results2 = await PostgresTestEntity.loader(vc1)
-        .enforcing()
-        .loadManyByFieldEqualityConjunctionAsync(
-          [
-            { fieldName: 'name', fieldValues: ['a', null] },
-            { fieldName: 'hasADog', fieldValue: true },
-          ],
-          {
-            orderBy: [
-              {
-                fieldName: 'name',
-                order: OrderByOrdering.DESCENDING,
-              },
-            ],
-          }
-        );
-      expect(results2).toHaveLength(2);
-      expect(results2.map((e) => e.getField('name'))).toEqual([null, 'a']);
-    });
   });
 
   describe('raw where clause loading', () => {
@@ -600,37 +546,4 @@ describe('postgres entity integration', () => {
       });
     });
   });
-
-  describe('queryContext callback behavior', () => {
-    it('calls callbacks correctly', async () => {
-      const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-
-      let preCommitCallCount = 0;
-      let postCommitCallCount = 0;
-
-      await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
-        queryContext.appendPostCommitCallback(async () => {
-          postCommitCallCount++;
-        });
-        queryContext.appendPreCommitCallback(async () => {
-          preCommitCallCount++;
-        }, 0);
-      });
-
-      await expect(
-        vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
-          queryContext.appendPostCommitCallback(async () => {
-            postCommitCallCount++;
-          });
-          queryContext.appendPreCommitCallback(async () => {
-            preCommitCallCount++;
-            throw Error('wat');
-          }, 0);
-        })
-      ).rejects.toThrowError('wat');
-
-      expect(preCommitCallCount).toBe(2);
-      expect(postCommitCallCount).toBe(1);
-    });
-  });
 });

packages/entity-database-adapter-knex/src/__integration-tests__/PostgresInvalidSetup-test.ts

@@ -1,7 +1,6 @@
 import { ViewerContext } from '@expo/entity';
 import { enforceAsyncResult } from '@expo/results';
-import { knex, Knex } from 'knex';
+import Knex from 'knex';
-import nullthrows from 'nullthrows';
 
 import InvalidTestEntity from '../testfixtures/InvalidTestEntity';
 import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
@@ -10,14 +9,14 @@ describe('postgres entity integration', () => {
   let knexInstance: Knex;
 
   beforeAll(() => {
-    knexInstance = knex({
+    knexInstance = Knex({
       client: 'pg',
       connection: {
-        user: nullthrows(process.env['PGUSER']),
+        user: process.env.PGUSER,
-        password: nullthrows(process.env['PGPASSWORD']),
+        password: process.env.PGPASSWORD,
         host: 'localhost',
-        port: parseInt(nullthrows(process.env['PGPORT']), 10),
+        port: parseInt(process.env.PGPORT!, 10),
-        database: nullthrows(process.env['PGDATABASE']),
+        database: process.env.PGDATABASE,
       },
     });
   });

packages/entity-database-adapter-knex/src/__integration-tests__/errors-test.ts

@@ -1,171 +0,0 @@
-import {
-  ViewerContext,
-  EntityDatabaseAdapterCheckConstraintError,
-  EntityDatabaseAdapterExclusionConstraintError,
-  EntityDatabaseAdapterForeignKeyConstraintError,
-  EntityDatabaseAdapterNotNullConstraintError,
-  EntityDatabaseAdapterTransientError,
-  EntityDatabaseAdapterUniqueConstraintError,
-  EntityDatabaseAdapterUnknownError,
-} from '@expo/entity';
-import { knex, Knex } from 'knex';
-import nullthrows from 'nullthrows';
-
-import ErrorsTestEntity from '../testfixtures/ErrorsTestEntity';
-import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
-
-describe('postgres errors', () => {
-  let knexInstance: Knex;
-
-  beforeAll(() => {
-    knexInstance = knex({
-      client: 'pg',
-      connection: {
-        user: nullthrows(process.env['PGUSER']),
-        password: nullthrows(process.env['PGPASSWORD']),
-        host: 'localhost',
-        port: parseInt(nullthrows(process.env['PGPORT']), 10),
-        database: nullthrows(process.env['PGDATABASE']),
-      },
-    });
-  });
-
-  beforeEach(async () => {
-    await ErrorsTestEntity.createOrTruncatePostgresTable(knexInstance);
-  });
-
-  afterAll(async () => {
-    await ErrorsTestEntity.dropPostgresTable(knexInstance);
-    await knexInstance.destroy();
-  });
-
-  it('throws EntityDatabaseAdapterTransientError on Knex timeout', async () => {
-    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-    await ErrorsTestEntity.creator(vc)
-      .setField('id', 1)
-      .setField('fieldNonNull', 'hello')
-      .enforceCreateAsync();
-
-    const shortTimeoutKnexInstance = knex({
-      client: 'pg',
-      connection: {
-        user: nullthrows(process.env['PGUSER']),
-        password: nullthrows(process.env['PGPASSWORD']),
-        host: 'localhost',
-        port: parseInt(nullthrows(process.env['PGPORT']), 10),
-        database: nullthrows(process.env['PGDATABASE']),
-      },
-      acquireConnectionTimeout: 1,
-    });
-    const vc2 = new ViewerContext(
-      createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance)
-    );
-    await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow(
-      EntityDatabaseAdapterTransientError
-    );
-    await shortTimeoutKnexInstance.destroy();
-  });
-
-  it('throws EntityDatabaseAdapterNotNullConstraintError when not null is violated', async () => {
-    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 1)
-        .setField('fieldNonNull', null as any)
-        .enforceCreateAsync()
-    ).rejects.toThrow(EntityDatabaseAdapterNotNullConstraintError);
-  });
-
-  it('throws EntityDatabaseAdapterForeignKeyConstraintError when foreign key is violated', async () => {
-    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 1)
-        .setField('fieldNonNull', 'hello')
-        .setField('fieldForeignKey', 2)
-        .enforceCreateAsync()
-    ).rejects.toThrow(EntityDatabaseAdapterForeignKeyConstraintError);
-  });
-
-  it('throws EntityDatabaseAdapterUniqueConstraintError when primary key unique constraint is violated', async () => {
-    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-
-    await ErrorsTestEntity.creator(vc)
-      .setField('id', 1)
-      .setField('fieldNonNull', 'hello')
-      .enforceCreateAsync();
-
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 1)
-        .setField('fieldNonNull', 'hello')
-        .enforceCreateAsync()
-    ).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
-  });
-
-  it('throws EntityDatabaseAdapterUniqueConstraintError when unique constraint is violated', async () => {
-    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-    await ErrorsTestEntity.creator(vc)
-      .setField('id', 2)
-      .setField('fieldNonNull', 'hello')
-      .setField('fieldUnique', 'hello')
-      .enforceCreateAsync();
-
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 1)
-        .setField('fieldNonNull', 'hello')
-        .setField('fieldUnique', 'hello')
-        .enforceCreateAsync()
-    ).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
-  });
-
-  it('throws EntityDatabaseAdapterCheckConstraintError when check constraint is violated', async () => {
-    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 1)
-        .setField('fieldNonNull', 'hello')
-        .setField('checkLessThan5', 2)
-        .enforceCreateAsync()
-    ).resolves.toBeTruthy();
-
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 2)
-        .setField('fieldNonNull', 'hello')
-        .setField('checkLessThan5', 10)
-        .enforceCreateAsync()
-    ).rejects.toThrow(EntityDatabaseAdapterCheckConstraintError);
-  });
-
-  it('throws EntityDatabaseAdapterExclusionConstraintError when exclusion constraint is violated', async () => {
-    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 1)
-        .setField('fieldNonNull', 'hello')
-        .setField('fieldExclusion', 'what')
-        .enforceCreateAsync()
-    ).resolves.toBeTruthy();
-
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 2)
-        .setField('fieldNonNull', 'hello')
-        .setField('fieldExclusion', 'what')
-        .enforceCreateAsync()
-    ).rejects.toThrow(EntityDatabaseAdapterExclusionConstraintError);
-  });
-
-  it('throws EntityDatabaseAdapterUnknownError otherwise', async () => {
-    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
-    await expect(
-      ErrorsTestEntity.creator(vc)
-        .setField('id', 1)
-        .setField('fieldNonNull', 'hello')
-        .setField('nonExistentColumn', 'what')
-        .enforceCreateAsync()
-    ).rejects.toThrow(EntityDatabaseAdapterUnknownError);
-  });
-});

packages/entity-database-adapter-knex/src/errors/__tests__/wrapNativePostgresCallAsync-test.ts

@@ -1,19 +0,0 @@
-import wrapNativePostgresCallAsync from '../wrapNativePostgresCallAsync';
-
-describe(wrapNativePostgresCallAsync, () => {
-  it('rethrows literals', async () => {
-    const throwingFn = async (): Promise<void> => {
-      // eslint-disable-next-line no-throw-literal,@typescript-eslint/no-throw-literal
-      throw 'hello';
-    };
-
-    let capturedThrownThing: any;
-    try {
-      await wrapNativePostgresCallAsync(throwingFn);
-    } catch (e) {
-      capturedThrownThing = e;
-    }
-    expect(capturedThrownThing).not.toBeInstanceOf(Error);
-    expect(capturedThrownThing).toEqual('hello');
-  });
-});

packages/entity-database-adapter-knex/src/errors/wrapNativePostgresCallAsync.ts

@@ -1,55 +0,0 @@
-import {
-  EntityDatabaseAdapterError,
-  EntityDatabaseAdapterCheckConstraintError,
-  EntityDatabaseAdapterExclusionConstraintError,
-  EntityDatabaseAdapterForeignKeyConstraintError,
-  EntityDatabaseAdapterNotNullConstraintError,
-  EntityDatabaseAdapterTransientError,
-  EntityDatabaseAdapterUniqueConstraintError,
-  EntityDatabaseAdapterUnknownError,
-} from '@expo/entity';
-import { knex } from 'knex';
-
-function wrapNativePostgresError(
-  error: Error & { code?: string }
-): EntityDatabaseAdapterError & Error {
-  const ret = translatePostgresError(error);
-  if (error.stack) {
-    ret.stack = error.stack;
-  }
-  return ret;
-}
-
-function translatePostgresError(
-  error: Error & { code?: string }
-): EntityDatabaseAdapterError & Error {
-  if (error instanceof knex.KnexTimeoutError) {
-    return new EntityDatabaseAdapterTransientError(error.message, error);
-  }
-
-  switch (error.code) {
-    case '23502':
-      return new EntityDatabaseAdapterNotNullConstraintError(error.message, error);
-    case '23503':
-      return new EntityDatabaseAdapterForeignKeyConstraintError(error.message, error);
-    case '23505':
-      return new EntityDatabaseAdapterUniqueConstraintError(error.message, error);
-    case '23514':
-      return new EntityDatabaseAdapterCheckConstraintError(error.message, error);
-    case '23P01':
-      return new EntityDatabaseAdapterExclusionConstraintError(error.message, error);
-    default:
-      return new EntityDatabaseAdapterUnknownError(error.message, error);
-  }
-}
-
-export default async function wrapNativePostgresCallAsync<T>(fn: () => Promise<T>): Promise<T> {
-  try {
-    return await fn();
-  } catch (e) {
-    if (!(e instanceof Error)) {
-      throw e;
-    }
-    throw wrapNativePostgresError(e);
-  }
-}

packages/entity-database-adapter-knex/src/index.ts

@@ -1,9 +1,3 @@
-/* eslint-disable tsdoc/syntax */
-/**
- * @packageDocumentation
- * @module @expo/entity-database-adapter-knex
- */
-
 export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter';
 export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider';
 export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider';

packages/entity-database-adapter-knex/src/testfixtures/ErrorsTestEntity.ts

@@ -1,177 +0,0 @@
-import {
-  AlwaysAllowPrivacyPolicyRule,
-  EntityPrivacyPolicy,
-  ViewerContext,
-  StringField,
-  EntityConfiguration,
-  EntityCompanionDefinition,
-  Entity,
-  IntField,
-} from '@expo/entity';
-import { Knex } from 'knex';
-
-type ErrorsTestEntityFields = {
-  id: number;
-  fieldNonNull: string;
-  fieldForeignKey: number | null;
-  fieldUnique: string | null;
-  checkLessThan5: number | null;
-  fieldExclusion: string | null;
-  nonExistentColumn: string | null;
-};
-
-const foreignTableName = 'foreign_table';
-
-export default class ErrorsTestEntity extends Entity<
-  ErrorsTestEntityFields,
-  number,
-  ViewerContext
-> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
-    ErrorsTestEntityFields,
-    number,
-    ViewerContext,
-    ErrorsTestEntity,
-    ErrorsTestEntityPrivacyPolicy
-  > {
-    return errorsTestEntityCompanionDefinition;
-  }
-
-  public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
-    await knex.raw('CREATE EXTENSION IF NOT EXISTS "btree_gist"'); // for gist exclusion on varchar
-
-    const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
-
-    const hasForeignTable = await knex.schema.hasTable(foreignTableName);
-    if (!hasForeignTable) {
-      await knex.schema.createTable(foreignTableName, (table) => {
-        table.integer('id').primary();
-      });
-    }
-
-    const hasTable = await knex.schema.hasTable(tableName);
-    if (!hasTable) {
-      await knex.schema.createTable(tableName, (table) => {
-        table.integer('id').primary();
-        table.string('field_non_null').notNullable();
-        table.integer('field_foreign_key').references(`${foreignTableName}.id`);
-        table.string('field_unique').unique();
-        table.integer('check_less_than_5');
-        table.string('field_exclusion');
-      });
-
-      await knex.raw(
-        `
-        ALTER TABLE :tableName:
-        ADD CONSTRAINT check_less_than_5_check_constraint
-        CHECK (check_less_than_5 IS NULL OR check_less_than_5 < 5);`,
-        {
-          tableName,
-        }
-      );
-
-      await knex.raw(
-        `
-        ALTER TABLE :tableName:
-        ADD CONSTRAINT field_exclusion_exclusion_constraint
-        EXCLUDE USING gist (field_exclusion WITH =);
-        `,
-        {
-          tableName,
-        }
-      );
-    }
-
-    await knex(tableName).delete();
-    await knex(foreignTableName).delete();
-  }
-
-  public static async dropPostgresTable(knex: Knex): Promise<void> {
-    const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
-    const hasTable = await knex.schema.hasTable(tableName);
-    if (hasTable) {
-      await knex.schema.dropTable(tableName);
-    }
-
-    const hasForeignTable = await knex.schema.hasTable(foreignTableName);
-    if (hasForeignTable) {
-      await knex.schema.dropTable(foreignTableName);
-    }
-  }
-}
-
-class ErrorsTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
-  ErrorsTestEntityFields,
-  number,
-  ViewerContext,
-  ErrorsTestEntity
-> {
-  protected override readonly createRules = [
-    new AlwaysAllowPrivacyPolicyRule<
-      ErrorsTestEntityFields,
-      number,
-      ViewerContext,
-      ErrorsTestEntity
-    >(),
-  ];
-  protected override readonly readRules = [
-    new AlwaysAllowPrivacyPolicyRule<
-      ErrorsTestEntityFields,
-      number,
-      ViewerContext,
-      ErrorsTestEntity
-    >(),
-  ];
-  protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<
-      ErrorsTestEntityFields,
-      number,
-      ViewerContext,
-      ErrorsTestEntity
-    >(),
-  ];
-  protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<
-      ErrorsTestEntityFields,
-      number,
-      ViewerContext,
-      ErrorsTestEntity
-    >(),
-  ];
-}
-
-export const ErrorsTestEntityConfiguration = new EntityConfiguration<ErrorsTestEntityFields>({
-  idField: 'id',
-  tableName: 'postgres_test_entities',
-  schema: {
-    id: new IntField({
-      columnName: 'id',
-    }),
-    fieldNonNull: new StringField({
-      columnName: 'field_non_null',
-    }),
-    fieldForeignKey: new IntField({
-      columnName: 'field_foreign_key',
-    }),
-    fieldUnique: new StringField({
-      columnName: 'field_unique',
-    }),
-    checkLessThan5: new IntField({
-      columnName: 'check_less_than_5',
-    }),
-    fieldExclusion: new StringField({
-      columnName: 'field_exclusion',
-    }),
-    nonExistentColumn: new StringField({
-      columnName: 'non_existent_column',
-    }),
-  },
-  databaseAdapterFlavor: 'postgres',
-  cacheAdapterFlavor: 'redis',
-});
-
-const errorsTestEntityCompanionDefinition = new EntityCompanionDefinition({
-  entityClass: ErrorsTestEntity,
-  entityConfiguration: ErrorsTestEntityConfiguration,
-  privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
-});

packages/entity-database-adapter-knex/src/testfixtures/InvalidTestEntity.ts

@@ -4,11 +4,13 @@ import {
   ViewerContext,
   StringField,
   EntityConfiguration,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
-  IntField,
+  NumberField,
 } from '@expo/entity';
-import { Knex } from 'knex';
+import Knex from 'knex';
 
 type InvalidTestEntityFields = {
   id: number;
@@ -57,7 +59,7 @@ class InvalidTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ViewerContext,
   InvalidTestEntity
 > {
-  protected override readonly createRules = [
+  protected readonly createRules = [
     new AlwaysAllowPrivacyPolicyRule<
       InvalidTestEntityFields,
       number,
@@ -65,7 +67,7 @@ class InvalidTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       InvalidTestEntity
     >(),
   ];
-  protected override readonly readRules = [
+  protected readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       InvalidTestEntityFields,
       number,
@@ -73,7 +75,7 @@ class InvalidTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       InvalidTestEntity
     >(),
   ];
-  protected override readonly updateRules = [
+  protected readonly updateRules = [
     new AlwaysAllowPrivacyPolicyRule<
       InvalidTestEntityFields,
       number,
@@ -81,7 +83,7 @@ class InvalidTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       InvalidTestEntity
     >(),
   ];
-  protected override readonly deleteRules = [
+  protected readonly deleteRules = [
     new AlwaysAllowPrivacyPolicyRule<
       InvalidTestEntityFields,
       number,
@@ -95,15 +97,15 @@ export const invalidTestEntityConfiguration = new EntityConfiguration<InvalidTes
   idField: 'id',
   tableName: 'postgres_test_entities',
   schema: {
-    id: new IntField({
+    id: new NumberField({
       columnName: 'id',
     }),
     name: new StringField({
       columnName: 'name',
     }),
   },
-  databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
 });
 
 const invalidTestEntityCompanionDefinition = new EntityCompanionDefinition({

packages/entity-database-adapter-knex/src/testfixtures/PostgresTestEntity.ts

@@ -11,10 +11,12 @@ import {
   DateField,
   MaybeJSONArrayField,
   EntityConfiguration,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
 } from '@expo/entity';
-import { Knex } from 'knex';
+import Knex from 'knex';
 
 type PostgresTestEntityFields = {
   id: string;
@@ -81,7 +83,7 @@ class PostgresTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ViewerContext,
   PostgresTestEntity
 > {
-  protected override readonly createRules = [
+  protected readonly createRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresTestEntityFields,
       string,
@@ -89,7 +91,7 @@ class PostgresTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresTestEntity
     >(),
   ];
-  protected override readonly readRules = [
+  protected readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresTestEntityFields,
       string,
@@ -97,7 +99,7 @@ class PostgresTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresTestEntity
     >(),
   ];
-  protected override readonly updateRules = [
+  protected readonly updateRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresTestEntityFields,
       string,
@@ -105,7 +107,7 @@ class PostgresTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresTestEntity
     >(),
   ];
-  protected override readonly deleteRules = [
+  protected readonly deleteRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresTestEntityFields,
       string,
@@ -148,8 +150,8 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
       columnName: 'maybe_json_array_field',
     }),
   },
-  databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
 });
 
 const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({

packages/entity-database-adapter-knex/src/testfixtures/PostgresTriggerTestEntity.ts

@@ -5,14 +5,15 @@ import {
   UUIDField,
   StringField,
   EntityConfiguration,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
   EntityMutationTrigger,
   EntityQueryContext,
   EntityNonTransactionalMutationTrigger,
-  EntityTriggerMutationInfo,
 } from '@expo/entity';
-import { Knex } from 'knex';
+import Knex from 'knex';
 
 type PostgresTriggerTestEntityFields = {
   id: string;
@@ -63,7 +64,7 @@ class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ViewerContext,
   PostgresTriggerTestEntity
 > {
-  protected override readonly createRules = [
+  protected readonly createRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresTriggerTestEntityFields,
       string,
@@ -71,7 +72,7 @@ class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresTriggerTestEntity
     >(),
   ];
-  protected override readonly readRules = [
+  protected readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresTriggerTestEntityFields,
       string,
@@ -79,7 +80,7 @@ class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresTriggerTestEntity
     >(),
   ];
-  protected override readonly updateRules = [
+  protected readonly updateRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresTriggerTestEntityFields,
       string,
@@ -87,7 +88,7 @@ class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresTriggerTestEntity
     >(),
   ];
-  protected override readonly deleteRules = [
+  protected readonly deleteRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresTriggerTestEntityFields,
       string,
@@ -110,13 +111,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
   async executeAsync(
     _viewerContext: ViewerContext,
     _queryContext: EntityQueryContext,
-    entity: PostgresTriggerTestEntity,
+    entity: PostgresTriggerTestEntity
-    _mutationInfo: EntityTriggerMutationInfo<
-      PostgresTriggerTestEntityFields,
-      string,
-      ViewerContext,
-      PostgresTriggerTestEntity
-    >
   ): Promise<void> {
     if (entity.getField(this.fieldName) === this.badValue) {
       throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
@@ -144,8 +139,9 @@ class ThrowConditionallyNonTransactionalTrigger extends EntityNonTransactionalMu
   }
 }
 
-export const postgresTestEntityConfiguration =
+export const postgresTestEntityConfiguration = new EntityConfiguration<
-  new EntityConfiguration<PostgresTriggerTestEntityFields>({
+  PostgresTriggerTestEntityFields
+>({
   idField: 'id',
   tableName: 'postgres_test_entities',
   schema: {
@@ -157,15 +153,15 @@ export const postgresTestEntityConfiguration =
       columnName: 'name',
     }),
   },
-    databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
-  });
+});
 
 const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
   entityClass: PostgresTriggerTestEntity,
   entityConfiguration: postgresTestEntityConfiguration,
   privacyPolicyClass: PostgresTriggerTestEntityPrivacyPolicy,
-  mutationTriggers: () => ({
+  mutationTriggers: {
     beforeCreate: [new ThrowConditionallyTrigger('name', 'beforeCreate')],
     afterCreate: [new ThrowConditionallyTrigger('name', 'afterCreate')],
     beforeUpdate: [new ThrowConditionallyTrigger('name', 'beforeUpdate')],
@@ -175,5 +171,5 @@ const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
     beforeAll: [new ThrowConditionallyTrigger('name', 'beforeAll')],
     afterAll: [new ThrowConditionallyTrigger('name', 'afterAll')],
     afterCommit: [new ThrowConditionallyNonTransactionalTrigger('name', 'afterCommit')],
-  }),
+  },
 });

packages/entity-database-adapter-knex/src/testfixtures/PostgresValidatorTestEntity.ts

@@ -5,13 +5,14 @@ import {
   UUIDField,
   StringField,
   EntityConfiguration,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
   EntityMutationTrigger,
   EntityQueryContext,
-  EntityValidatorMutationInfo,
 } from '@expo/entity';
-import { Knex } from 'knex';
+import Knex from 'knex';
 
 type PostgresValidatorTestEntityFields = {
   id: string;
@@ -62,7 +63,7 @@ class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ViewerContext,
   PostgresValidatorTestEntity
 > {
-  protected override readonly createRules = [
+  protected readonly createRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresValidatorTestEntityFields,
       string,
@@ -70,7 +71,7 @@ class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresValidatorTestEntity
     >(),
   ];
-  protected override readonly readRules = [
+  protected readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresValidatorTestEntityFields,
       string,
@@ -78,7 +79,7 @@ class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresValidatorTestEntity
     >(),
   ];
-  protected override readonly updateRules = [
+  protected readonly updateRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresValidatorTestEntityFields,
       string,
@@ -86,7 +87,7 @@ class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
       PostgresValidatorTestEntity
     >(),
   ];
-  protected override readonly deleteRules = [
+  protected readonly deleteRules = [
     new AlwaysAllowPrivacyPolicyRule<
       PostgresValidatorTestEntityFields,
       string,
@@ -112,13 +113,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
   async executeAsync(
     _viewerContext: ViewerContext,
     _queryContext: EntityQueryContext,
-    entity: PostgresValidatorTestEntity,
+    entity: PostgresValidatorTestEntity
-    _mutationInfo: EntityValidatorMutationInfo<
-      PostgresValidatorTestEntityFields,
-      string,
-      ViewerContext,
-      PostgresValidatorTestEntity
-    >
   ): Promise<void> {
     if (entity.getField(this.fieldName) === this.badValue) {
       throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
@@ -126,8 +121,9 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
   }
 }
 
-export const postgresTestEntityConfiguration =
+export const postgresTestEntityConfiguration = new EntityConfiguration<
-  new EntityConfiguration<PostgresValidatorTestEntityFields>({
+  PostgresValidatorTestEntityFields
+>({
   idField: 'id',
   tableName: 'postgres_test_entities',
   schema: {
@@ -139,13 +135,13 @@ export const postgresTestEntityConfiguration =
       columnName: 'name',
     }),
   },
-    databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
-  });
+});
 
 const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
   entityClass: PostgresValidatorTestEntity,
   entityConfiguration: postgresTestEntityConfiguration,
   privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
-  mutationValidators: () => [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
+  mutationValidators: [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
 });

packages/entity-database-adapter-knex/src/testfixtures/createKnexIntegrationTestEntityCompanionProvider.ts

@@ -2,9 +2,11 @@ import {
   NoOpEntityMetricsAdapter,
   IEntityMetricsAdapter,
   EntityCompanionProvider,
+  CacheAdapterFlavor,
+  DatabaseAdapterFlavor,
   InMemoryFullCacheStubCacheAdapterProvider,
 } from '@expo/entity';
-import { Knex } from 'knex';
+import Knex from 'knex';
 
 import PostgresEntityDatabaseAdapterProvider from '../PostgresEntityDatabaseAdapterProvider';
 import PostgresEntityQueryContextProvider from '../PostgresEntityQueryContextProvider';
@@ -15,22 +17,16 @@ export const createKnexIntegrationTestEntityCompanionProvider = (
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
-    new Map([
-      [
-        'postgres',
     {
+      [DatabaseAdapterFlavor.POSTGRES]: {
         adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
         queryContextProvider: new PostgresEntityQueryContextProvider(knex),
       },
-      ],
+    },
-    ]),
-    new Map([
-      [
-        'redis',
     {
+      [CacheAdapterFlavor.REDIS]: {
         cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
       },
-      ],
+    }
-    ])
   );
 };

packages/entity-example/CHANGELOG.md

@@ -3,126 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
-
-**Note:** Version bump only for package @expo/entity-example
-
-
-
-
-
-# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
-
-**Note:** Version bump only for package @expo/entity-example
-
-
-
-
-
-# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
-
-**Note:** Version bump only for package @expo/entity-example
-
-
-
-
-
-# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
-
-**Note:** Version bump only for package @expo/entity-example
-
-
-
-
-
-# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
-
-
-### Features
-
-* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
-* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
-
-
-
-
-
-# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
-
-**Note:** Version bump only for package @expo/entity-example
-
-
-
-
-
-# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
-
-**Note:** Version bump only for package @expo/entity-example
-
-
-
-
-
-# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
-
-
-### Features
-
-* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
-
-
-
-
-
-## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
-
-**Note:** Version bump only for package @expo/entity-example
-
-
-
-
-
-# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
-
-**Note:** Version bump only for package @expo/entity-example
-
-
-
-
-
-# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
-
-
-### Features
-
-* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
-
-
-
-
-
-# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
-
-
-### Bug Fixes
-
-* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
-
-
-
-
-
-# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
-
-
-### Bug Fixes
-
-* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
-
-
-
-
-
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 **Note:** Version bump only for package @expo/entity-example

packages/entity-example/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@expo/entity-example",
   "private": true,
-  "version": "0.22.0",
+  "version": "0.10.0",
   "description": "An example integration of the @expo/entity framework",
   "scripts": {
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
-    "lint": "eslint src",
+    "lint": "eslint src --ext '.ts'",
-    "lint-fix": "eslint src --fix",
     "test": "jest --rootDir . --config ../../resources/jest.config.js",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
@@ -23,7 +22,7 @@
   "author": "Expo",
   "license": "MIT",
   "dependencies": {
-    "@expo/entity": "^0.22.0",
+    "@expo/entity": "^0.10.0",
     "apollo-server-koa": "^2.16.1",
     "graphql": "^15.3.0",
     "koa": "^2.13.0",

packages/entity-example/src/__tests__/NoteEntity-test.ts

@@ -1,5 +1,4 @@
 import { createUnitTestEntityCompanionProvider } from '@expo/entity';
-import { v4 as uuidv4 } from 'uuid';
 
 import NoteEntity from '../entities/NoteEntity';
 import { UserViewerContext } from '../viewerContexts';
@@ -7,18 +6,17 @@ import { UserViewerContext } from '../viewerContexts';
 describe(NoteEntity, () => {
   test('demonstrate usage of business logic test utilities', async () => {
     const companionProvider = createUnitTestEntityCompanionProvider();
-    const userId = uuidv4();
+    const viewerContext = new UserViewerContext(companionProvider, '4');
-    const viewerContext = new UserViewerContext(companionProvider, userId);
 
     const createdEntityResult = await NoteEntity.creator(viewerContext)
-      .setField('userID', userId)
+      .setField('userID', '4')
       .setField('body', 'image')
       .setField('title', 'page')
       .createAsync();
     expect(createdEntityResult.ok).toBe(true);
 
     const createdEntityResultImpersonate = await NoteEntity.creator(viewerContext)
-      .setField('userID', uuidv4()) // a different user
+      .setField('userID', '5')
       .setField('body', 'image')
       .setField('title', 'page')
       .createAsync();

packages/entity-example/src/__tests__/graphql-integration-test.ts

@@ -1,6 +1,5 @@
 import http from 'http';
 import request from 'supertest';
-import { v4 as uuidv4 } from 'uuid';
 
 import app from '../app';
 
@@ -8,15 +7,14 @@ describe('graphql', () => {
   it('allows CRUD of user notes', async () => {
     const server = request(http.createServer(app.callback()));
 
-    const userId = uuidv4();
+    const responseEmpty = await server.post('/graphql').set('totally-secure-user-id', '4').send({
-    const responseEmpty = await server.post('/graphql').set('totally-secure-user-id', userId).send({
       query: `query { me { notes { id } } }`,
     });
     expect(responseEmpty.body.data.me.notes).toEqual([]);
 
     const createResponse1 = await server
       .post('/graphql')
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send({
         query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
         variables: {
@@ -33,7 +31,7 @@ describe('graphql', () => {
 
     const createResponse2 = await server
       .post('/graphql')
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send({
         query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
         variables: {
@@ -44,17 +42,14 @@ describe('graphql', () => {
         },
       });
 
-    const responseLength2 = await server
+    const responseLength2 = await server.post('/graphql').set('totally-secure-user-id', '4').send({
-      .post('/graphql')
-      .set('totally-secure-user-id', userId)
-      .send({
       query: `query { me { notes { id } } }`,
     });
     expect(responseLength2.body.data.me.notes).toHaveLength(2);
 
     const responseGetSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send({
         query: `query($id: ID!) { noteByID(id: $id) { id, title, body } }`,
         variables: {
@@ -69,7 +64,7 @@ describe('graphql', () => {
 
     const responseUpdateSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send({
         query: `mutation($id: ID!, $note: NoteInput!) { updateNote(id: $id, note: $note) { id, title, body } }`,
         variables: {
@@ -89,7 +84,7 @@ describe('graphql', () => {
 
     const responseDeleteSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send({
         query: `mutation($id: ID!) { deleteNote(id: $id) { id, title, body } }`,
         variables: {
@@ -107,10 +102,7 @@ describe('graphql', () => {
       body: 'boarding',
     });
 
-    const responseLength1 = await server
+    const responseLength1 = await server.post('/graphql').set('totally-secure-user-id', '4').send({
-      .post('/graphql')
-      .set('totally-secure-user-id', userId)
-      .send({
       query: `query { me { notes { id } } }`,
     });
     expect(responseLength1.body.data.me.notes).toHaveLength(1);
@@ -135,11 +127,9 @@ describe('graphql', () => {
   it('disallows cross-user note impersonation', async () => {
     const server = request(http.createServer(app.callback()));
 
-    const userId = uuidv4();
-    const userId2 = uuidv4();
     const createResponse1 = await server
       .post('/graphql')
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send({
         query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
         variables: {
@@ -153,7 +143,7 @@ describe('graphql', () => {
     // notes are public
     const responseGetSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', userId2)
+      .set('totally-secure-user-id', '5')
       .send({
         query: `query($id: ID!) { noteByID(id: $id) { id, title, body } }`,
         variables: {
@@ -169,7 +159,7 @@ describe('graphql', () => {
     // but can only be updated by the owner
     const responseUpdateSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', userId2)
+      .set('totally-secure-user-id', '5')
       .send({
         query: `mutation($id: ID!, $note: NoteInput!) { updateNote(id: $id, note: $note) { id, title, body } }`,
         variables: {

packages/entity-example/src/__tests__/notesRouter-integration-test.ts

@@ -1,6 +1,5 @@
 import http from 'http';
 import request from 'supertest';
-import { v4 as uuidv4 } from 'uuid';
 
 import app from '../app';
 
@@ -12,74 +11,59 @@ describe('notesRouter', () => {
 
   it('allows CRUD of user notes', async () => {
     const server = request(http.createServer(app.callback()));
-
+    const responseEmpty = await server.get('/notes/').set('totally-secure-user-id', '4').send();
-    const userId = uuidv4();
-
-    const responseEmpty = await server.get('/notes/').set('totally-secure-user-id', userId).send();
     expect(responseEmpty.body.notes).toEqual([]);
 
-    const createResponse1 = await server
+    const createResponse1 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
-      .post('/notes/')
-      .set('totally-secure-user-id', userId)
-      .send({
       title: 'track',
       body: 'language',
     });
     expect(createResponse1.body.note).toMatchObject({
-      userID: userId,
+      userID: '4',
       title: 'track',
       body: 'language',
     });
 
-    const createResponse2 = await server
+    const createResponse2 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
-      .post('/notes/')
-      .set('totally-secure-user-id', userId)
-      .send({
       title: 'nine',
       body: 'lotion',
     });
 
-    const responseLength2 = await server
+    const responseLength2 = await server.get('/notes/').set('totally-secure-user-id', '4').send();
-      .get('/notes/')
-      .set('totally-secure-user-id', userId)
-      .send();
     expect(responseLength2.body.notes).toHaveLength(2);
 
     const responseGetSingle = await server
       .get(`/notes/${createResponse2.body.note.id}`)
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send();
     expect(responseGetSingle.body.note).toMatchObject({
       id: createResponse2.body.note.id,
-      userID: userId,
+      userID: '4',
       title: 'nine',
       body: 'lotion',
     });
 
     const responseUpdateSingle = await server
       .put(`/notes/${createResponse2.body.note.id}`)
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send({
         title: 'wave',
         body: 'boarding',
       });
     expect(responseUpdateSingle.body.note).toMatchObject({
       id: responseGetSingle.body.note.id,
-      userID: userId,
+      userID: '4',
       title: 'wave',
       body: 'boarding',
     });
 
     const responseDeleteSingle = await server
       .delete(`/notes/${createResponse2.body.note.id}`)
-      .set('totally-secure-user-id', userId)
+      .set('totally-secure-user-id', '4')
       .send();
     expect(responseDeleteSingle.body.status).toEqual('ok');
 
-    const responseLength1 = await server
+    const responseLength1 = await server.get('/notes/').set('totally-secure-user-id', '4').send();
-      .get('/notes/')
-      .set('totally-secure-user-id', userId)
-      .send();
     expect(responseLength1.body.notes).toHaveLength(1);
   });
 
@@ -95,12 +79,7 @@ describe('notesRouter', () => {
 
   it('disallows cross-user note impersonation', async () => {
     const server = request(http.createServer(app.callback()));
-    const userId = uuidv4();
+    const createResponse1 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
-    const userId2 = uuidv4();
-    const createResponse1 = await server
-      .post('/notes/')
-      .set('totally-secure-user-id', userId)
-      .send({
       title: 'track',
       body: 'language',
     });
@@ -109,14 +88,14 @@ describe('notesRouter', () => {
     // notes are public
     const responseGetSingleOtherUser = await server
       .get(`/notes/${createResponse1.body.note.id}`)
-      .set('totally-secure-user-id', userId2)
+      .set('totally-secure-user-id', '5')
       .send();
     expect(responseGetSingleOtherUser.ok).toBe(true);
 
     // but can only be updated by the owner
     const responseUpdateSingle = await server
       .put(`/notes/${createResponse1.body.note.id}`)
-      .set('totally-secure-user-id', userId2)
+      .set('totally-secure-user-id', '5')
       .send({
         title: 'wave',
         body: 'boarding',

packages/entity-example/src/adapters/InMemoryDatabaseAdapter.ts

@@ -58,7 +58,7 @@ class InMemoryDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
       return 0;
     }
 
-    const currentOrderBy = orderBys[0]!;
+    const currentOrderBy = orderBys[0];
     const aField = objectA[currentOrderBy.columnName];
     const bField = objectB[currentOrderBy.columnName];
     switch (currentOrderBy.order) {
@@ -161,7 +161,7 @@ class InMemoryDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
       ...dbObjects[objectIndex],
       ...object,
     };
-    return [dbObjects[objectIndex]!];
+    return [dbObjects[objectIndex]];
   }
 
   protected async deleteInternalAsync(

packages/entity-example/src/data.ts

@@ -3,6 +3,8 @@ import {
   NoOpEntityMetricsAdapter,
   EntityCompanionProvider,
   InMemoryFullCacheStubCacheAdapterProvider,
+  CacheAdapterFlavor,
+  DatabaseAdapterFlavor,
 } from '@expo/entity';
 
 import { InMemoryDatabaseAdapterProvider } from './adapters/InMemoryDatabaseAdapter';
@@ -19,26 +21,20 @@ export const createEntityCompanionProvider = (
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
-    new Map([
+    {
-      [
-        'postgres',
       // An in-memory DB is used for demonstration purposes, but generally this would be
       // instantiated with PostgresEntityDatabaseAdapter and PostgresEntityQueryContextProvider
-        {
+      [DatabaseAdapterFlavor.POSTGRES]: {
         adapterProvider: new InMemoryDatabaseAdapterProvider(),
         queryContextProvider: new InMemoryQueryContextProvider(),
       },
-      ],
+    },
-    ]),
+    {
-    new Map([
-      [
-        'redis',
       // An in-memory cache is used for demonstration purposes, but generally this would be
       // instantiated with a RedisCacheAdapterProvider
-        {
+      [CacheAdapterFlavor.REDIS]: {
         cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
       },
-      ],
+    }
-    ])
   );
 };

packages/entity-example/src/entities/AllowIfUserOwnerPrivacyRule.ts

@@ -23,9 +23,8 @@ import { ExampleViewerContext } from '../viewerContexts';
  */
 export default class AllowIfUserOwnerPrivacyRule<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
-  TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>,
+  TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>
-  TSelectedFields extends keyof TFields = keyof TFields
 > extends PrivacyPolicyRule<TFields, TID, ExampleViewerContext, TEntity> {
   constructor(private readonly entityOwnerField: keyof TFields) {
     super();

packages/entity-example/src/entities/NoteEntity.ts

@@ -3,6 +3,8 @@ import {
   EntityCompanionDefinition,
   EntityConfiguration,
   UUIDField,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
   StringField,
 } from '@expo/entity';
 
@@ -55,8 +57,8 @@ export const noteEntityCompanion = new EntityCompanionDefinition({
         columnName: 'body',
       }),
     },
-    databaseAdapterFlavor: 'postgres',
+    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: 'redis',
+    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
   }),
   privacyPolicyClass: NotePrivacyPolicy,
 });

packages/entity-example/src/entities/NotePrivacyPolicy.ts

@@ -13,16 +13,16 @@ export default class NotePrivacyPolicy extends EntityPrivacyPolicy<
   ExampleViewerContext,
   NoteEntity
 > {
-  protected override readonly readRules = [
+  protected readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<NoteFields, string, ExampleViewerContext, NoteEntity>(),
   ];
-  protected override readonly createRules = [
+  protected readonly createRules = [
     new AllowIfUserOwnerPrivacyRule<NoteFields, string, NoteEntity>('userID'),
   ];
-  protected override readonly updateRules = [
+  protected readonly updateRules = [
     new AllowIfUserOwnerPrivacyRule<NoteFields, string, NoteEntity>('userID'),
   ];
-  protected override readonly deleteRules = [
+  protected readonly deleteRules = [
     new AllowIfUserOwnerPrivacyRule<NoteFields, string, NoteEntity>('userID'),
   ];
 }

packages/entity-full-integration-tests/CHANGELOG.md

@@ -3,132 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
-
-**Note:** Version bump only for package @expo/entity-full-integration-tests
-
-
-
-
-
-# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
-
-**Note:** Version bump only for package @expo/entity-full-integration-tests
-
-
-
-
-
-# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
-
-**Note:** Version bump only for package @expo/entity-full-integration-tests
-
-
-
-
-
-# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
-
-**Note:** Version bump only for package @expo/entity-full-integration-tests
-
-
-
-
-
-# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
-
-
-### Features
-
-* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
-* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
-
-
-
-
-
-# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
-
-**Note:** Version bump only for package @expo/entity-full-integration-tests
-
-
-
-
-
-# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
-
-**Note:** Version bump only for package @expo/entity-full-integration-tests
-
-
-
-
-
-# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
-
-
-### Bug Fixes
-
-* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
-
-
-### Features
-
-* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
-
-
-
-
-
-## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
-
-**Note:** Version bump only for package @expo/entity-full-integration-tests
-
-
-
-
-
-# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
-
-**Note:** Version bump only for package @expo/entity-full-integration-tests
-
-
-
-
-
-# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
-
-
-### Features
-
-* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
-
-
-
-
-
-# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
-
-
-### Bug Fixes
-
-* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
-* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
-
-
-
-
-
-# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
-
-
-### Bug Fixes
-
-* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
-
-
-
-
-
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 **Note:** Version bump only for package @expo/entity-full-integration-tests

packages/entity-full-integration-tests/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@expo/entity-full-integration-tests",
   "private": true,
-  "version": "0.22.0",
+  "version": "0.10.0",
   "description": "Full redis and knex integration tests for the entity framework",
   "scripts": {
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
-    "lint": "eslint src",
+    "lint": "eslint src --ext '.ts'",
-    "lint-fix": "eslint src --fix",
     "test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
@@ -27,8 +26,8 @@
     "@expo/entity-database-adapter-knex": "*"
   },
   "devDependencies": {
-    "@expo/entity": "^0.22.0",
+    "@expo/entity": "^0.10.0",
-    "@expo/entity-cache-adapter-redis": "^0.22.0",
+    "@expo/entity-cache-adapter-redis": "^0.10.0",
-    "@expo/entity-database-adapter-knex": "^0.22.0"
+    "@expo/entity-database-adapter-knex": "^0.10.0"
   }
 }

packages/entity-full-integration-tests/src/__integration-tests__/EntityCacheInconsistency-test.ts

@@ -5,13 +5,13 @@ import {
   Entity,
   EntityCompanionDefinition,
   EntityConfiguration,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
   UUIDField,
-  StringField,
 } from '@expo/entity';
 import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
 import Redis from 'ioredis';
-import { knex, Knex } from 'knex';
+import Knex from 'knex';
-import nullthrows from 'nullthrows';
 import { URL } from 'url';
 
 import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
@@ -28,18 +28,10 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ViewerContext,
   TestEntity
 > {
-  protected override readonly readRules = [
+  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  ];
+  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected override readonly createRules = [
+  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
-    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
-  ];
-  protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
-  ];
-  protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
-  ];
 }
 
 class TestEntity extends Entity<TestFields, string, ViewerContext> {
@@ -62,16 +54,16 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
       columnName: 'id',
       cache: true,
     }),
-    other_string: new StringField({
+    other_string: new UUIDField({
       columnName: 'other_string',
       cache: true,
     }),
-    third_string: new StringField({
+    third_string: new UUIDField({
       columnName: 'third_string',
     }),
   },
-  databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
 });
 
 const testEntityCompanion = new EntityCompanionDefinition({
@@ -105,18 +97,18 @@ describe('Entity cache inconsistency', () => {
   let redisCacheAdapterContext: RedisCacheAdapterContext;
 
   beforeAll(() => {
-    knexInstance = knex({
+    knexInstance = Knex({
       client: 'pg',
       connection: {
-        user: nullthrows(process.env['PGUSER']),
+        user: process.env.PGUSER,
-        password: nullthrows(process.env['PGPASSWORD']),
+        password: process.env.PGPASSWORD,
         host: 'localhost',
-        port: parseInt(nullthrows(process.env['PGPORT']), 10),
+        port: parseInt(process.env.PGPORT!, 10),
-        database: nullthrows(process.env['PGDATABASE']),
+        database: process.env.PGDATABASE,
       },
     });
     redisCacheAdapterContext = {
-      redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
+      redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
       makeKeyFn(...parts: string[]): string {
         const delimiter = ':';
         const escapedParts = parts.map((part) =>
@@ -159,12 +151,12 @@ describe('Entity cache inconsistency', () => {
       .loadByFieldEqualingAsync('other_string', 'hello');
 
     let openBarrier1: () => void;
-    const barrier1 = new Promise<void>((resolve) => {
+    const barrier1 = new Promise((resolve) => {
       openBarrier1 = resolve;
     });
 
     let openBarrier2: () => void;
-    const barrier2 = new Promise<void>((resolve) => {
+    const barrier2 = new Promise((resolve) => {
       openBarrier2 = resolve;
     });
 
@@ -183,9 +175,7 @@ describe('Entity cache inconsistency', () => {
 
         openBarrier2!();
       })(),
-      viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+      TestEntity.runInTransactionAsync(viewerContext, async (queryContext) => {
-        'postgres',
-        async (queryContext) => {
         await TestEntity.updater(entity1, queryContext)
           .setField('third_string', 'updated')
           .enforceUpdateAsync();
@@ -194,8 +184,7 @@ describe('Entity cache inconsistency', () => {
 
         // wait for to ensure the transaction isn't committed until after load above occurs
         await barrier2;
-        }
+      }),
-      ),
     ]);
 
     // ensure cache consistency

packages/entity-full-integration-tests/src/__integration-tests__/EntityEdgesIntegration-test.ts

@@ -1,8 +1,7 @@
 import { ViewerContext } from '@expo/entity';
 import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
 import Redis from 'ioredis';
-import { knex, Knex } from 'knex';
+import Knex from 'knex';
-import nullthrows from 'nullthrows';
 import { URL } from 'url';
 
 import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
@@ -38,18 +37,18 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
   let redisCacheAdapterContext: RedisCacheAdapterContext;
 
   beforeAll(() => {
-    knexInstance = knex({
+    knexInstance = Knex({
       client: 'pg',
       connection: {
-        user: nullthrows(process.env['PGUSER']),
+        user: process.env.PGUSER,
-        password: nullthrows(process.env['PGPASSWORD']),
+        password: process.env.PGPASSWORD,
         host: 'localhost',
-        port: parseInt(nullthrows(process.env['PGPORT']), 10),
+        port: parseInt(process.env.PGPORT!, 10),
-        database: nullthrows(process.env['PGDATABASE']),
+        database: process.env.PGDATABASE,
       },
     });
     redisCacheAdapterContext = {
-      redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
+      redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
       makeKeyFn(...parts: string[]): string {
         const delimiter = ':';
         const escapedParts = parts.map((part) =>

packages/entity-full-integration-tests/src/__integration-tests__/EntitySelfReferentialEdgesIntegration-test.ts

@@ -5,13 +5,14 @@ import {
   Entity,
   EntityCompanionDefinition,
   EntityConfiguration,
+  DatabaseAdapterFlavor,
+  CacheAdapterFlavor,
   UUIDField,
   EntityEdgeDeletionBehavior,
 } from '@expo/entity';
 import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
 import Redis from 'ioredis';
-import { knex, Knex } from 'knex';
+import Knex from 'knex';
-import nullthrows from 'nullthrows';
 import { URL } from 'url';
 import { v4 as uuidv4 } from 'uuid';
 
@@ -28,18 +29,10 @@ interface OtherFields {
 }
 
 class PrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any> {
-  protected override readonly readRules = [
+  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
+  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  ];
+  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected override readonly createRules = [
+  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
-  ];
-  protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
-  ];
-  protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
-  ];
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -89,8 +82,8 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
         },
       }),
     },
-    databaseAdapterFlavor: 'postgres',
+    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: 'redis',
+    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
   });
 
   const categoryEntityCompanion = new EntityCompanionDefinition({
@@ -117,8 +110,8 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
         },
       }),
     },
-    databaseAdapterFlavor: 'postgres',
+    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: 'redis',
+    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
   });
 
   const otherEntityCompanion = new EntityCompanionDefinition({
@@ -167,18 +160,18 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
   let redisCacheAdapterContext: RedisCacheAdapterContext;
 
   beforeAll(() => {
-    knexInstance = knex({
+    knexInstance = Knex({
       client: 'pg',
       connection: {
-        user: nullthrows(process.env['PGUSER']),
+        user: process.env.PGUSER,
-        password: nullthrows(process.env['PGPASSWORD']),
+        password: process.env.PGPASSWORD,
         host: 'localhost',
-        port: parseInt(nullthrows(process.env['PGPORT']), 10),
+        port: parseInt(process.env.PGPORT!, 10),
-        database: nullthrows(process.env['PGDATABASE']),
+        database: process.env.PGDATABASE,
       },
     });
     redisCacheAdapterContext = {
-      redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
+      redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
       makeKeyFn(...parts: string[]): string {
         const delimiter = ':';
         const escapedParts = parts.map((part) =>

packages/entity-full-integration-tests/src/__integration-tests__/entities/ChildEntity.ts

@@ -1,5 +1,7 @@
 import {
   AlwaysAllowPrivacyPolicyRule,
+  CacheAdapterFlavor,
+  DatabaseAdapterFlavor,
   Entity,
   EntityCompanionDefinition,
   EntityConfiguration,
@@ -17,18 +19,10 @@ interface ChildFields {
 }
 
 class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
-  protected override readonly readRules = [
+  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  ];
+  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected override readonly createRules = [
+  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
-  ];
-  protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
-  ];
-  protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
-  ];
 }
 
 export default class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
@@ -60,8 +54,8 @@ const childEntityConfiguration = new EntityConfiguration<ChildFields>({
       },
     }),
   },
-  databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
 });
 
 const childEntityCompanion = new EntityCompanionDefinition({

packages/entity-full-integration-tests/src/__integration-tests__/entities/ParentEntity.ts

@@ -1,5 +1,7 @@
 import {
   AlwaysAllowPrivacyPolicyRule,
+  CacheAdapterFlavor,
+  DatabaseAdapterFlavor,
   Entity,
   EntityCompanionDefinition,
   EntityConfiguration,
@@ -15,18 +17,10 @@ interface ParentFields {
 }
 
 class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
-  protected override readonly readRules = [
+  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  ];
+  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected override readonly createRules = [
+  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
-  ];
-  protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
-  ];
-  protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
-  ];
 }
 
 export default class ParentEntity extends Entity<ParentFields, string, ViewerContext> {
@@ -51,8 +45,8 @@ const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
       cache: true,
     }),
   },
-  databaseAdapterFlavor: 'postgres',
+  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: 'redis',
+  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
 });
 
 const parentEntityCompanion = new EntityCompanionDefinition({

packages/entity-full-integration-tests/src/testfixtures/createFullIntegrationTestEntityCompanionProvider.ts

@@ -2,6 +2,8 @@ import {
   NoOpEntityMetricsAdapter,
   IEntityMetricsAdapter,
   EntityCompanionProvider,
+  CacheAdapterFlavor,
+  DatabaseAdapterFlavor,
 } from '@expo/entity';
 import {
   RedisCacheAdapterContext,
@@ -11,7 +13,7 @@ import {
   PostgresEntityDatabaseAdapterProvider,
   PostgresEntityQueryContextProvider,
 } from '@expo/entity-database-adapter-knex';
-import { Knex } from 'knex';
+import Knex from 'knex';
 
 export const createFullIntegrationTestEntityCompanionProvider = (
   knex: Knex,
@@ -20,22 +22,16 @@ export const createFullIntegrationTestEntityCompanionProvider = (
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
-    new Map([
-      [
-        'postgres',
     {
+      [DatabaseAdapterFlavor.POSTGRES]: {
         adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
         queryContextProvider: new PostgresEntityQueryContextProvider(knex),
       },
-      ],
+    },
-    ]),
-    new Map([
-      [
-        'redis',
     {
+      [CacheAdapterFlavor.REDIS]: {
         cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
       },
-      ],
+    }
-    ])
   );
 };

packages/entity-ip-address-field/CHANGELOG.md

@@ -1,50 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
-
-**Note:** Version bump only for package @expo/entity-ip-address-field
-
-
-
-
-
-# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
-
-**Note:** Version bump only for package @expo/entity-ip-address-field
-
-
-
-
-
-# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
-
-**Note:** Version bump only for package @expo/entity-ip-address-field
-
-
-
-
-
-# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
-
-
-### Features
-
-* add IP support ([#138](https://github.com/expo/entity/issues/138)) ([1405a91](https://github.com/expo/entity/commit/1405a9126ee3a56c3e2a38bf3b697283744f5b5d))
-
-
-
-
-
-# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
-
-
-### Features
-
-* lands @expo/entity-ip-address-field ([#138](https://github.com/expo/entity/pull/138))
-* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
-* expose describeFieldTestCase for use in other packages ([#139](https://github.com/expo/entity/issues/139)) ([1220477](https://github.com/expo/entity/commit/1220477aa331349b482ad015b44f76fa2bda7b90))
-* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
-* use better QueryContext types for transactional triggers and validators ([#136](https://github.com/expo/entity/issues/136)) ([5c7efe1](https://github.com/expo/entity/commit/5c7efe1678424ff907687e9327175bdc2538c3e0))

packages/entity-ip-address-field/README.md

@@ -1,3 +0,0 @@
-# @expo/entity-ip-address-field
-
-A package containing the IP address EntityField definitions for @expo/entity. Supports addresses with either IPv4 or IPv6 syntax.

packages/entity-ip-address-field/package.json

@@ -1,37 +0,0 @@
-{
-  "name": "@expo/entity-ip-address-field",
-  "version": "0.22.0",
-  "description": "IP address EntityField definitions for @expo/entity",
-  "files": [
-    "build",
-    "src"
-  ],
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
-  "scripts": {
-    "tsc": "tsc",
-    "clean": "rm -rf build coverage coverage-integration",
-    "lint": "eslint src",
-    "lint-fix": "eslint src --fix",
-    "test": "jest --rootDir . --config ../../resources/jest.config.js",
-    "barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --delete"
-  },
-  "engines": {
-    "node": ">=12"
-  },
-  "keywords": [
-    "entity"
-  ],
-  "author": "Expo",
-  "license": "MIT",
-  "dependencies": {
-    "ip-address": "^8.1.0"
-  },
-  "devDependencies": {
-    "@expo/entity": "^0.22.0",
-    "@types/jsbn": "^1.2.29"
-  },
-  "peerDependencies": {
-    "@expo/entity": "*"
-  }
-}

packages/entity-ip-address-field/src/EntityFields.ts

@@ -1,8 +0,0 @@
-import { EntityFieldDefinition } from '@expo/entity';
-import { Address4, Address6 } from 'ip-address';
-
-export class IPAddressField extends EntityFieldDefinition<string> {
-  protected validateInputValueInternal(value: string): boolean {
-    return Address4.isValid(value) || Address6.isValid(value);
-  }
-}

packages/entity-ip-address-field/src/__tests__/EntityFields-test.ts

@@ -1,16 +0,0 @@
-import { describeFieldTestCase } from '@expo/entity';
-
-import { IPAddressField } from '../EntityFields';
-
-describeFieldTestCase(
-  new IPAddressField({ columnName: 'wat' }),
-  [
-    '192.168.1.1',
-    '198.24.10.0/24',
-    '10.0.0.0',
-    '0:1:2:3:4:5:6:7',
-    '1:2:3:4:5:6:7:8/64',
-    'fedc:ba98:7654:3210:fedc:ba98:7654:3210',
-  ],
-  ['', 'abs', '0.0.0.x/0', '123.21.23', '1:2:3:4:5:6', '198.10/8']
-);

packages/entity-ip-address-field/src/index.ts

@@ -1,7 +0,0 @@
-/* eslint-disable tsdoc/syntax */
-/**
- * @packageDocumentation
- * @module @expo/entity-ip-address-field
- */
-
-export * from './EntityFields';

packages/entity-ip-address-field/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "build",
-  },
-  "include": ["src"]
-}

packages/entity-secondary-cache-redis/CHANGELOG.md

@@ -1,71 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
-
-**Note:** Version bump only for package @expo/entity-secondary-cache-redis
-
-
-
-
-
-# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
-
-**Note:** Version bump only for package @expo/entity-secondary-cache-redis
-
-
-
-
-
-# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
-
-**Note:** Version bump only for package @expo/entity-secondary-cache-redis
-
-
-
-
-
-# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
-
-**Note:** Version bump only for package @expo/entity-secondary-cache-redis
-
-
-
-
-
-# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
-
-
-### Features
-
-* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
-* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
-
-
-
-
-
-# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
-
-**Note:** Version bump only for package @expo/entity-secondary-cache-redis
-
-
-
-
-
-# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
-
-**Note:** Version bump only for package @expo/entity-secondary-cache-redis
-
-
-
-
-
-# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
-
-
-### Features
-
-* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))

packages/entity-secondary-cache-redis/README.md

@@ -1,25 +0,0 @@
-# `@expo/entity-secondary-cache-redis`
-
-[ioredis](https://github.com/luin/ioredis) secondary cache for `@expo/entity`.
-
-[Documentation](https://expo.github.io/entity/modules/_expo_secondary_cache_redis.html)
-
-## Usage
-
-1. Create a concrete implementation of abstract class `EntitySecondaryCacheLoader`, in this example `TestEntitySecondaryCacheLoader`. The underlying data can come from anywhere, but an entity is constructed from the data and then authorized for the viewer.
-2. Create an instance of your `EntitySecondaryCacheLoader`, passing in a `RedisSecondaryEntityCache`.
-    ```typescript
-    const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
-      new RedisSecondaryEntityCache(
-        redisTestEntityConfiguration,
-        redisCacheAdapterContext,
-        (loadParams) => `${loadParams.id}`
-      ),
-      RedisTestEntity.loader(viewerContext)
-    );
-    ```
-3. Load entities through it:
-    ```typescript
-    const loadParams = { id: createdEntity.getID() };
-    const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
-    ```

packages/entity-secondary-cache-redis/package.json

@@ -1,41 +0,0 @@
-{
-  "name": "@expo/entity-secondary-cache-redis",
-  "version": "0.22.0",
-  "description": "Redis secondary cache for @expo/entity",
-  "files": [
-    "build",
-    "src"
-  ],
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
-  "scripts": {
-    "tsc": "tsc",
-    "clean": "rm -rf build coverage coverage-integration",
-    "lint": "eslint src",
-    "lint-fix": "eslint src --fix",
-    "test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
-    "integration": "../../resources/run-with-docker yarn integration-no-setup",
-    "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
-    "barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
-  },
-  "engines": {
-    "node": ">=12"
-  },
-  "keywords": [
-    "entity"
-  ],
-  "author": "Expo",
-  "license": "MIT",
-  "peerDependencies": {
-    "@expo/entity": "*",
-    "@expo/entity-cache-adapter-redis": "*"
-  },
-  "dependencies": {
-    "ioredis": "^4.17.3"
-  },
-  "devDependencies": {
-    "@expo/entity": "^0.22.0",
-    "@expo/entity-cache-adapter-redis": "^0.22.0",
-    "nullthrows": "^1.1.1"
-  }
-}

packages/entity-secondary-cache-redis/src/RedisSecondaryEntityCache.ts

@@ -1,136 +0,0 @@
-import {
-  CacheStatus,
-  EntityConfiguration,
-  filterMap,
-  ISecondaryEntityCache,
-  transformCacheObjectToFields,
-  transformFieldsToCacheObject,
-  zipToMap,
-} from '@expo/entity';
-import {
-  GenericRedisCacheContext,
-  GenericRedisCacher,
-  redisTransformerMap,
-} from '@expo/entity-cache-adapter-redis';
-import invariant from 'invariant';
-
-/**
- * A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
- * single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
- * a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
- */
-export default class RedisSecondaryEntityCache<TFields, TLoadParams>
-  implements ISecondaryEntityCache<TFields, TLoadParams>
-{
-  private readonly genericRedisCacher: GenericRedisCacher;
-
-  constructor(
-    private readonly entityConfiguration: EntityConfiguration<TFields>,
-    genericRedisCacheContext: GenericRedisCacheContext,
-    private readonly constructRedisKey: (params: Readonly<TLoadParams>) => string
-  ) {
-    this.genericRedisCacher = new GenericRedisCacher(genericRedisCacheContext);
-  }
-
-  /**
-   * Read-through cache function. Steps:
-   *
-   * 1. Check for cached objects
-   * 2. Query the fetcher for loadParams not in the cache
-   * 3. Cache the results from the fetcher
-   * 4. Negatively cache anything missing from the fetcher
-   * 5. Return the full set of data for the query.
-   *
-   * @param loadParamsArray - array of loadParams to load from the cache
-   * @param fetcher - closure used to provide underlying data source objects for loadParams
-   * @returns map from loadParams to the entity field object
-   */
-  public async loadManyThroughAsync(
-    loadParamsArray: readonly Readonly<TLoadParams>[],
-    fetcher: (
-      fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
-    ) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
-  ): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>> {
-    const redisKeys = loadParamsArray.map(this.constructRedisKey);
-    const redisKeyToLoadParamsMap = zipToMap(redisKeys, loadParamsArray);
-
-    const cacheLoadResults = await this.genericRedisCacher.loadManyAsync(redisKeys);
-
-    invariant(
-      cacheLoadResults.size === loadParamsArray.length,
-      `${this.constructor.name} loadMany should return a result for each key`
-    );
-
-    const redisKeysToFetch = Array.from(
-      filterMap(
-        cacheLoadResults,
-        (cacheLoadResult) => cacheLoadResult.status === CacheStatus.MISS
-      ).keys()
-    );
-
-    // put transformed cache hits in result map
-    const results: Map<Readonly<TLoadParams>, Readonly<TFields> | null> = new Map();
-    cacheLoadResults.forEach((cacheLoadResult, redisKey) => {
-      if (cacheLoadResult.status === CacheStatus.HIT) {
-        const loadParams = redisKeyToLoadParamsMap.get(redisKey);
-        invariant(loadParams !== undefined, 'load params should be in redis key map');
-        results.set(
-          loadParams,
-          transformCacheObjectToFields(
-            this.entityConfiguration,
-            redisTransformerMap,
-            cacheLoadResult.item
-          )
-        );
-      }
-    });
-
-    // fetch any misses from DB, add DB objects to results, cache DB results, inform cache of any missing DB results
-    if (redisKeysToFetch.length > 0) {
-      const loadParamsToFetch = redisKeysToFetch.map((redisKey) => {
-        const loadParams = redisKeyToLoadParamsMap.get(redisKey);
-        invariant(loadParams !== undefined, 'load params should be in redis key map');
-        return loadParams;
-      });
-      const fetchResults = await fetcher(loadParamsToFetch);
-
-      const fetchMisses = loadParamsToFetch.filter((loadParams) => {
-        // all values of fetchResults should be field objects or undefined
-        return !fetchResults.get(loadParams);
-      });
-
-      for (const fetchMiss of fetchMisses) {
-        results.set(fetchMiss, null);
-      }
-
-      const objectsToCache: Map<string, object> = new Map();
-      for (const [loadParams, object] of fetchResults.entries()) {
-        if (object) {
-          objectsToCache.set(
-            this.constructRedisKey(loadParams),
-            transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
-          );
-          results.set(loadParams, object);
-        }
-      }
-
-      await Promise.all([
-        this.genericRedisCacher.cacheManyAsync(objectsToCache),
-        this.genericRedisCacher.cacheDBMissesAsync(fetchMisses.map(this.constructRedisKey)),
-      ]);
-    }
-
-    return results;
-  }
-
-  /**
-   * Invalidate the cache for objects cached by constructRedisKey(loadParams).
-   *
-   * @param loadParamsArray - load params to invalidate
-   */
-  public async invalidateManyAsync(
-    loadParamsArray: readonly Readonly<TLoadParams>[]
-  ): Promise<void> {
-    await this.genericRedisCacher.invalidateManyAsync(loadParamsArray.map(this.constructRedisKey));
-  }
-}

packages/entity-secondary-cache-redis/src/__integration-tests__/RedisSecondaryEntityCache-integration-test.ts

@@ -1,139 +0,0 @@
-import { EntitySecondaryCacheLoader, mapMapAsync, ViewerContext } from '@expo/entity';
-import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
-import Redis from 'ioredis';
-import nullthrows from 'nullthrows';
-import { URL } from 'url';
-
-import RedisSecondaryEntityCache from '../RedisSecondaryEntityCache';
-import RedisTestEntity, {
-  redisTestEntityConfiguration,
-  RedisTestEntityFields,
-  RedisTestEntityPrivacyPolicy,
-} from '../testfixtures/RedisTestEntity';
-import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
-
-class TestViewerContext extends ViewerContext {}
-
-type TestLoadParams = { id: string };
-
-const FAKE_ID = 'fake';
-
-class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
-  TestLoadParams,
-  RedisTestEntityFields,
-  string,
-  TestViewerContext,
-  RedisTestEntity,
-  RedisTestEntityPrivacyPolicy
-> {
-  public databaseLoadCount = 0;
-
-  protected async fetchObjectsFromDatabaseAsync(
-    loadParamsArray: readonly Readonly<TestLoadParams>[]
-  ): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<RedisTestEntityFields> | null>> {
-    this.databaseLoadCount += loadParamsArray.length;
-
-    const emptyMap = new Map(loadParamsArray.map((p) => [p, null]));
-    return await mapMapAsync(emptyMap, async (_value, loadParams) => {
-      if (loadParams.id === FAKE_ID) {
-        return null;
-      }
-      return nullthrows(
-        (
-          await this.entityLoader
-            .enforcing()
-            .loadManyByFieldEqualityConjunctionAsync([
-              { fieldName: 'id', fieldValue: loadParams.id },
-            ])
-        )[0]
-      ).getAllFields();
-    });
-  }
-}
-
-describe(RedisSecondaryEntityCache, () => {
-  let redisCacheAdapterContext: RedisCacheAdapterContext;
-
-  beforeAll(() => {
-    redisCacheAdapterContext = {
-      redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
-      makeKeyFn(..._parts: string[]): string {
-        throw new Error('should not be used by this test');
-      },
-      cacheKeyPrefix: 'test-',
-      cacheKeyVersion: 1,
-      ttlSecondsPositive: 86400, // 1 day
-      ttlSecondsNegative: 600, // 10 minutes
-    };
-  });
-
-  beforeEach(async () => {
-    await redisCacheAdapterContext.redisClient.flushdb();
-  });
-  afterAll(async () => {
-    redisCacheAdapterContext.redisClient.disconnect();
-  });
-
-  it('Loads through secondary loader, caches, and invalidates', async () => {
-    const viewerContext = new TestViewerContext(
-      createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
-    );
-
-    const createdEntity = await RedisTestEntity.creator(viewerContext)
-      .setField('name', 'wat')
-      .enforceCreateAsync();
-
-    const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
-      new RedisSecondaryEntityCache(
-        redisTestEntityConfiguration,
-        redisCacheAdapterContext,
-        (loadParams) => `test-key-${loadParams.id}`
-      ),
-      RedisTestEntity.loader(viewerContext)
-    );
-
-    const loadParams = { id: createdEntity.getID() };
-    const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
-    expect(nullthrows(results.get(loadParams)).enforceValue().getID()).toEqual(
-      createdEntity.getID()
-    );
-
-    expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
-
-    const results2 = await secondaryCacheLoader.loadManyAsync([loadParams]);
-    expect(nullthrows(results2.get(loadParams)).enforceValue().getID()).toEqual(
-      createdEntity.getID()
-    );
-
-    expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
-
-    await secondaryCacheLoader.invalidateManyAsync([loadParams]);
-
-    const results3 = await secondaryCacheLoader.loadManyAsync([loadParams]);
-    expect(nullthrows(results3.get(loadParams)).enforceValue().getID()).toEqual(
-      createdEntity.getID()
-    );
-
-    expect(secondaryCacheLoader.databaseLoadCount).toEqual(2);
-  });
-
-  it('correctly handles uncached and unfetchable load params', async () => {
-    const viewerContext = new TestViewerContext(
-      createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
-    );
-
-    const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
-      new RedisSecondaryEntityCache(
-        redisTestEntityConfiguration,
-        redisCacheAdapterContext,
-        (loadParams) => `test-key-${loadParams.id}`
-      ),
-      RedisTestEntity.loader(viewerContext)
-    );
-
-    const loadParams = { id: FAKE_ID };
-    const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
-    expect(results.size).toBe(1);
-    expect(results.get(loadParams)).toBe(null);
-  });
-});

packages/entity-secondary-cache-redis/src/index.ts

@@ -1,7 +0,0 @@
-/* eslint-disable tsdoc/syntax */
-/**
- * @packageDocumentation
- * @module @expo/entity-secondary-cache-redis
- */
-
-export { default as RedisSecondaryEntityCache } from './RedisSecondaryEntityCache';

packages/entity-secondary-cache-redis/src/testfixtures/RedisTestEntity.ts

@@ -1,88 +0,0 @@
-import {
-  AlwaysAllowPrivacyPolicyRule,
-  EntityPrivacyPolicy,
-  ViewerContext,
-  UUIDField,
-  StringField,
-  EntityConfiguration,
-  EntityCompanionDefinition,
-  Entity,
-} from '@expo/entity';
-
-export type RedisTestEntityFields = {
-  id: string;
-  name: string;
-};
-
-export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
-    RedisTestEntityFields,
-    string,
-    ViewerContext,
-    RedisTestEntity,
-    RedisTestEntityPrivacyPolicy
-  > {
-    return redisTestEntityCompanionDefinition;
-  }
-}
-
-export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
-  RedisTestEntityFields,
-  string,
-  ViewerContext,
-  RedisTestEntity
-> {
-  protected override readonly createRules = [
-    new AlwaysAllowPrivacyPolicyRule<
-      RedisTestEntityFields,
-      string,
-      ViewerContext,
-      RedisTestEntity
-    >(),
-  ];
-  protected override readonly readRules = [
-    new AlwaysAllowPrivacyPolicyRule<
-      RedisTestEntityFields,
-      string,
-      ViewerContext,
-      RedisTestEntity
-    >(),
-  ];
-  protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<
-      RedisTestEntityFields,
-      string,
-      ViewerContext,
-      RedisTestEntity
-    >(),
-  ];
-  protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<
-      RedisTestEntityFields,
-      string,
-      ViewerContext,
-      RedisTestEntity
-    >(),
-  ];
-}
-
-export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEntityFields>({
-  idField: 'id',
-  tableName: 'redis_test_entities',
-  schema: {
-    id: new UUIDField({
-      columnName: 'id',
-    }),
-    name: new StringField({
-      columnName: 'name',
-    }),
-  },
-  databaseAdapterFlavor: 'postgres',
-  cacheAdapterFlavor: 'redis',
-});
-
-const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
-  entityClass: RedisTestEntity,
-  entityConfiguration: redisTestEntityConfiguration,
-  privacyPolicyClass: RedisTestEntityPrivacyPolicy,
-});

packages/entity-secondary-cache-redis/src/testfixtures/createRedisIntegrationTestEntityCompanionProvider.ts

@@ -1,37 +0,0 @@
-import {
-  NoOpEntityMetricsAdapter,
-  IEntityMetricsAdapter,
-  EntityCompanionProvider,
-  StubQueryContextProvider,
-  StubDatabaseAdapterProvider,
-} from '@expo/entity';
-import {
-  RedisCacheAdapterContext,
-  RedisCacheAdapterProvider,
-} from '@expo/entity-cache-adapter-redis';
-
-export const createRedisIntegrationTestEntityCompanionProvider = (
-  redisCacheAdapterContext: RedisCacheAdapterContext,
-  metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
-): EntityCompanionProvider => {
-  return new EntityCompanionProvider(
-    metricsAdapter,
-    new Map([
-      [
-        'postgres',
-        {
-          adapterProvider: new StubDatabaseAdapterProvider(),
-          queryContextProvider: StubQueryContextProvider,
-        },
-      ],
-    ]),
-    new Map([
-      [
-        'redis',
-        {
-          cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
-        },
-      ],
-    ])
-  );
-};

packages/entity-secondary-cache-redis/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "build",
-  },
-  "include": ["src"]
-}

packages/entity/CHANGELOG.md

@@ -3,178 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
-
-**Note:** Version bump only for package @expo/entity
-
-
-
-
-
-# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
-
-
-### Features
-
-* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
-
-
-
-
-
-# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
-
-
-### Bug Fixes
-
-* separate post-commit invalidation callbacks from trigger and user callbacks ([#144](https://github.com/expo/entity/issues/144)) ([efa131e](https://github.com/expo/entity/commit/efa131ef29532accf0e51b6d867ffe15a27b4c90))
-
-
-### Features
-
-* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
-
-
-
-
-
-# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
-
-
-### Features
-
-* add authorization metrics ([#142](https://github.com/expo/entity/issues/142)) ([7cf54d8](https://github.com/expo/entity/commit/7cf54d83c52e104159a3e2e675cdda2d29afe204))
-
-
-
-
-
-# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
-
-
-### Features
-
-* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
-* expose describeFieldTestCase for use in other packages ([#139](https://github.com/expo/entity/issues/139)) ([1220477](https://github.com/expo/entity/commit/1220477aa331349b482ad015b44f76fa2bda7b90))
-* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
-* use better QueryContext types for transactional triggers and validators ([#136](https://github.com/expo/entity/issues/136)) ([5c7efe1](https://github.com/expo/entity/commit/5c7efe1678424ff907687e9327175bdc2538c3e0))
-
-
-
-
-
-# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
-
-
-### Features
-
-* Add IntField and FloatField, deprecate NumberField ([#131](https://github.com/expo/entity/issues/131)) ([2f2d963](https://github.com/expo/entity/commit/2f2d963cf92c6575d78f8eeca344a4aadcc9b8d9))
-
-
-
-
-
-# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
-
-
-### Features
-
-* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
-
-
-
-
-
-# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
-
-
-### Features
-
-* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
-
-
-
-
-
-## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
-
-
-### Bug Fixes
-
-* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
-
-
-
-
-
-# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
-
-
-### Bug Fixes
-
-* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
-
-
-### Features
-
-* add mutation type to validator and trigger execute functions ([#119](https://github.com/expo/entity/issues/119)) ([ef40fa5](https://github.com/expo/entity/commit/ef40fa5e9cdf53e25e78a9423c698e6d1c9737af))
-
-
-
-
-
-# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
-
-
-### Bug Fixes
-
-* allow undefined value for all fields ([#114](https://github.com/expo/entity/issues/114)) ([022e0e9](https://github.com/expo/entity/commit/022e0e9b88a5e84e0c1bc6c8810c850beb05f0cf))
-
-
-### Features
-
-* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
-
-
-
-
-
-# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
-
-
-### Bug Fixes
-
-* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
-* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
-
-
-### Features
-
-* better typing on filterMap for use with predicates ([#106](https://github.com/expo/entity/issues/106)) ([01b3bfe](https://github.com/expo/entity/commit/01b3bfef7c6da55e7d89d8cccb52a0050187aee8))
-
-
-
-
-
-# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
-
-
-### Bug Fixes
-
-* add type generic default in test utils ([#104](https://github.com/expo/entity/issues/104)) ([fe2917e](https://github.com/expo/entity/commit/fe2917e6b5af808f166aa354d476e168c41e6d21))
-* maps utils invariants for collections containing undefined values ([#103](https://github.com/expo/entity/issues/103)) ([29c1a43](https://github.com/expo/entity/commit/29c1a434ab6cd8d30e9f0e7c742065c8d46d8d8a))
-* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
-
-
-### Features
-
-* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
-* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
-
-
-
-
-
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 

packages/entity/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expo/entity",
-  "version": "0.22.0",
+  "version": "0.10.0",
   "description": "A privacy-first data model",
   "files": [
     "build",
@@ -11,8 +11,7 @@
   "scripts": {
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
-    "lint": "eslint src",
+    "lint": "eslint src --ext '.ts'",
-    "lint-fix": "eslint src --fix",
     "test": "jest --rootDir . --config ../../resources/jest.config.js",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",

packages/entity/src/EnforcingEntityLoader.ts

@@ -11,7 +11,7 @@ import { mapMap } from './utils/collections/maps';
  */
 export default class EnforcingEntityLoader<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/Entity.ts

@@ -27,7 +27,7 @@ import ViewerContext from './ViewerContext';
  */
 export default abstract class Entity<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TSelectedFields extends keyof TFields = keyof TFields
 > extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields> {
@@ -39,7 +39,7 @@ export default abstract class Entity<
    */
   static creator<
     TMFields,
-    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMID,
     TMViewerContext extends ViewerContext,
     TMViewerContext2 extends TMViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -80,7 +80,7 @@ export default abstract class Entity<
    */
   static updater<
     TMFields,
-    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMID,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -121,7 +121,7 @@ export default abstract class Entity<
    */
   static deleteAsync<
     TMFields,
-    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMID,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -163,7 +163,7 @@ export default abstract class Entity<
    */
   static enforceDeleteAsync<
     TMFields,
-    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMID,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -216,7 +216,7 @@ export default abstract class Entity<
    */
   static async canViewerUpdateAsync<
     TMFields,
-    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMID,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -243,16 +243,12 @@ export default abstract class Entity<
       .getQueryContextProvider()
       .getQueryContext()
   ): Promise<boolean> {
-    const companion = existingEntity
-      .getViewerContext()
-      .getViewerScopedEntityCompanionForClass(this);
     const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
     const evaluationResult = await asyncResult(
       privacyPolicy.authorizeUpdateAsync(
         existingEntity.getViewerContext(),
         queryContext,
-        existingEntity,
+        existingEntity
-        companion.getMetricsAdapter()
       )
     );
     return evaluationResult.ok;
@@ -269,7 +265,7 @@ export default abstract class Entity<
    */
   static async canViewerDeleteAsync<
     TMFields,
-    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMID,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -296,16 +292,12 @@ export default abstract class Entity<
       .getQueryContextProvider()
       .getQueryContext()
   ): Promise<boolean> {
-    const companion = existingEntity
-      .getViewerContext()
-      .getViewerScopedEntityCompanionForClass(this);
     const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
     const evaluationResult = await asyncResult(
       privacyPolicy.authorizeDeleteAsync(
         existingEntity.getViewerContext(),
         queryContext,
-        existingEntity,
+        existingEntity
-        companion.getMetricsAdapter()
       )
     );
     return evaluationResult.ok;
@@ -317,7 +309,7 @@ export default abstract class Entity<
  */
 export interface IEntityClass<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/EntityAssociationLoader.ts

@@ -8,7 +8,7 @@ import ViewerContext from './ViewerContext';
 
 export default class EntityAssociationLoader<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields
@@ -25,7 +25,7 @@ export default class EntityAssociationLoader<
   async loadAssociatedEntityAsync<
     TIdentifyingField extends keyof Pick<TFields, TSelectedFields>,
     TAssociatedFields,
-    TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
+    TAssociatedID,
     TAssociatedEntity extends ReadonlyEntity<
       TAssociatedFields,
       TAssociatedID,
@@ -71,7 +71,7 @@ export default class EntityAssociationLoader<
       .getLoaderFactory()
       .forLoad(queryContext);
 
-    return (await loader.loadByIDAsync(associatedEntityID as unknown as TAssociatedID)) as Result<
+    return (await loader.loadByIDAsync((associatedEntityID as unknown) as TAssociatedID)) as Result<
       null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity
     >;
   }
@@ -87,7 +87,7 @@ export default class EntityAssociationLoader<
    */
   async loadManyAssociatedEntitiesAsync<
     TAssociatedFields,
-    TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
+    TAssociatedID,
     TAssociatedEntity extends ReadonlyEntity<
       TAssociatedFields,
       TAssociatedID,
@@ -140,7 +140,7 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityByFieldEqualingAsync<
     TAssociatedFields,
-    TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
+    TAssociatedID,
     TAssociatedEntity extends ReadonlyEntity<
       TAssociatedFields,
       TAssociatedID,
@@ -197,7 +197,7 @@ export default class EntityAssociationLoader<
    */
   async loadManyAssociatedEntitiesByFieldEqualingAsync<
     TAssociatedFields,
-    TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
+    TAssociatedID,
     TAssociatedEntity extends ReadonlyEntity<
       TAssociatedFields,
       TAssociatedID,
@@ -253,7 +253,7 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityThroughAsync<
     TFields2,
-    TID2 extends NonNullable<TFields2[TSelectedFields2]>,
+    TID2,
     TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
     TPrivacyPolicy2 extends EntityPrivacyPolicy<
       TFields2,
@@ -287,7 +287,7 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityThroughAsync<
     TFields2,
-    TID2 extends NonNullable<TFields2[TSelectedFields2]>,
+    TID2,
     TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
     TPrivacyPolicy2 extends EntityPrivacyPolicy<
       TFields2,
@@ -297,7 +297,7 @@ export default class EntityAssociationLoader<
       TSelectedFields2
     >,
     TFields3,
-    TID3 extends NonNullable<TFields3[TSelectedFields3]>,
+    TID3,
     TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
     TPrivacyPolicy3 extends EntityPrivacyPolicy<
       TFields3,
@@ -342,7 +342,7 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityThroughAsync<
     TFields2,
-    TID2 extends NonNullable<TFields2[TSelectedFields2]>,
+    TID2,
     TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
     TPrivacyPolicy2 extends EntityPrivacyPolicy<
       TFields2,
@@ -352,7 +352,7 @@ export default class EntityAssociationLoader<
       TSelectedFields2
     >,
     TFields3,
-    TID3 extends NonNullable<TFields3[TSelectedFields3]>,
+    TID3,
     TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
     TPrivacyPolicy3 extends EntityPrivacyPolicy<
       TFields3,
@@ -362,7 +362,7 @@ export default class EntityAssociationLoader<
       TSelectedFields3
     >,
     TFields4,
-    TID4 extends NonNullable<TFields4[TSelectedFields4]>,
+    TID4,
     TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext, TSelectedFields4>,
     TPrivacyPolicy4 extends EntityPrivacyPolicy<
       TFields4,
@@ -478,7 +478,7 @@ export interface EntityLoadThroughDirective<
   TViewerContext extends ViewerContext,
   TFields,
   TAssociatedFields,
-  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
+  TAssociatedID,
   TAssociatedEntity extends ReadonlyEntity<
     TAssociatedFields,
     TAssociatedID,

packages/entity/src/EntityCacheAdapter.ts

@@ -1,4 +1,5 @@
 import EntityConfiguration from './EntityConfiguration';
+import { FieldTransformerMap } from './internal/EntityFieldTransformationUtils';
 import { CacheLoadResult } from './internal/ReadThroughEntityCache';
 
 /**
@@ -8,6 +9,13 @@ import { CacheLoadResult } from './internal/ReadThroughEntityCache';
 export default abstract class EntityCacheAdapter<TFields> {
   constructor(protected readonly entityConfiguration: EntityConfiguration<TFields>) {}
 
+  /**
+   * Transformer definitions for field types. Used to modify values as they are read from or written to
+   * the cache. Override in concrete subclasses to change transformation behavior.
+   * If a field type is not present in the map, then fields of that type will not be transformed.
+   */
+  public abstract getFieldTransformerMap(): FieldTransformerMap;
+
   /**
    * Load many objects from cache.
    * @param fieldName - object field being queried

packages/entity/src/EntityCompanion.ts

@@ -19,7 +19,7 @@ export interface IPrivacyPolicyClass<TPrivacyPolicy> {
  */
 export default class EntityCompanion<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -73,7 +73,7 @@ export default class EntityCompanion<
       TEntity,
       TSelectedFields
     >,
-    private readonly metricsAdapter: IEntityMetricsAdapter
+    metricsAdapter: IEntityMetricsAdapter
   ) {
     const privacyPolicy = new PrivacyPolicyClass();
     this.entityLoaderFactory = new EntityLoaderFactory<
@@ -84,11 +84,10 @@ export default class EntityCompanion<
       TPrivacyPolicy,
       TSelectedFields
     >(
-      tableDataCoordinator.entityConfiguration,
+      tableDataCoordinator.entityConfiguration.idField as keyof Pick<TFields, TSelectedFields>,
       entityClass,
       privacyPolicy,
-      tableDataCoordinator.dataManager,
+      tableDataCoordinator.dataManager
-      metricsAdapter
     );
     this.entityMutatorFactory = new EntityMutatorFactory(
       tableDataCoordinator.entityConfiguration,
@@ -130,11 +129,4 @@ export default class EntityCompanion<
   getQueryContextProvider(): EntityQueryContextProvider {
     return this.tableDataCoordinator.getQueryContextProvider();
   }
-
-  /**
-   * Get the {@link IEntityMetricsAdapter} for this companion.
-   */
-  getMetricsAdapter(): IEntityMetricsAdapter {
-    return this.metricsAdapter;
-  }
 }

packages/entity/src/EntityCompanionProvider.ts

@@ -1,5 +1,3 @@
-import invariant from 'invariant';
-
 import { IEntityClass } from './Entity';
 import EntityCompanion, { IPrivacyPolicyClass } from './EntityCompanion';
 import EntityConfiguration from './EntityConfiguration';
@@ -18,14 +16,25 @@ import { computeIfAbsent } from './utils/collections/maps';
 /**
  * Backing database and transaction type for an entity. The definitions and implementations
  * are provided by injection in the root EntityCompanionProvider to allow for mocking and sharing.
+ *
+ * Note: this enum will likely be modified soon to be more flexible.
  */
-export type DatabaseAdapterFlavor = string;
+export enum DatabaseAdapterFlavor {
+  /**
+   * Knex postgres adapter, using postgres table and postgres transactions.
+   */
+  POSTGRES = 'postgres',
+}
 
 /**
  * Cache system for an entity. The definitions and implementations are provided by injection
  * in the root EntityCompanionProvider to allow for mocking and sharing.
+ *
+ * Note: this enum will likely be modified soon to be more flexible.
  */
-export type CacheAdapterFlavor = string;
+export enum CacheAdapterFlavor {
+  REDIS = 'redis',
+}
 
 /**
  * Defines a set interfaces for a entity database adapter flavor. An entity that uses a flavor
@@ -51,7 +60,7 @@ export interface CacheAdapterFlavorDefinition {
  */
 export class EntityCompanionDefinition<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -73,14 +82,14 @@ export class EntityCompanionDefinition<
   >;
   readonly entityConfiguration: EntityConfiguration<TFields>;
   readonly privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
-  readonly mutationValidators: () => EntityMutationValidator<
+  readonly mutationValidators: EntityMutationValidator<
     TFields,
     TID,
     TViewerContext,
     TEntity,
     TSelectedFields
   >[];
-  readonly mutationTriggers: () => EntityMutationTriggerConfiguration<
+  readonly mutationTriggers: EntityMutationTriggerConfiguration<
     TFields,
     TID,
     TViewerContext,
@@ -93,13 +102,10 @@ export class EntityCompanionDefinition<
     entityClass,
     entityConfiguration,
     privacyPolicyClass,
-    mutationValidators = () => [],
+    mutationValidators = [],
-    mutationTriggers = () => ({}),
+    mutationTriggers = {},
     entitySelectedFields = Array.from(entityConfiguration.schema.keys()) as TSelectedFields[],
   }: {
-    /**
-     * The concrete Entity class for which this is the definition.
-     */
     entityClass: IEntityClass<
       TFields,
       TID,
@@ -108,39 +114,22 @@ export class EntityCompanionDefinition<
       TPrivacyPolicy,
       TSelectedFields
     >;
-    /**
-     * The {@link EntityConfiguration} for this entity.
-     */
     entityConfiguration: EntityConfiguration<TFields>;
-    /**
-     * The {@link EntityPrivacyPolicy} class for this entity.
-     */
     privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
-    /**
+    mutationValidators?: EntityMutationValidator<
-     * An optional list of {@link EntityMutationValidator} for this entity.
-     */
-    mutationValidators?: () => EntityMutationValidator<
       TFields,
       TID,
       TViewerContext,
       TEntity,
       TSelectedFields
     >[];
-    /**
+    mutationTriggers?: EntityMutationTriggerConfiguration<
-     * An optional list of {@link EntityMutationTrigger} for this entity.
-     */
-    mutationTriggers?: () => EntityMutationTriggerConfiguration<
       TFields,
       TID,
       TViewerContext,
       TEntity,
       TSelectedFields
     >;
-    /**
-     * An optional subset of fields defined in the {@link EntityConfiguration} which belong to this entity.
-     * For use when multiple types of entities are backed by a single table ({@link EntityConfiguration}) yet
-     * only expose a subset of the fields.
-     */
     entitySelectedFields?: TSelectedFields[];
   }) {
     this.entityClass = entityClass;
@@ -162,10 +151,14 @@ export class EntityCompanionDefinition<
  * {@link EntityCompanion} for each type of {@link Entity}.
  */
 export default class EntityCompanionProvider {
-  private readonly companionMap: Map<string, EntityCompanion<any, any, any, any, any, any>> =
+  private readonly companionMap: Map<
-    new Map();
+    string,
-  private readonly tableDataCoordinatorMap: Map<string, EntityTableDataCoordinator<any>> =
+    EntityCompanion<any, any, any, any, any, any>
-    new Map();
+  > = new Map();
+  private readonly tableDataCoordinatorMap: Map<
+    string,
+    EntityTableDataCoordinator<any>
+  > = new Map();
 
   /**
    * Instantiate an Entity framework.
@@ -174,12 +167,9 @@ export default class EntityCompanionProvider {
    * @param cacheAdapterFlavors - Cache adapter configurations for this instance
    */
   constructor(
-    public readonly metricsAdapter: IEntityMetricsAdapter,
+    private metricsAdapter: IEntityMetricsAdapter,
-    private databaseAdapterFlavors: ReadonlyMap<
+    private databaseAdapterFlavors: Record<DatabaseAdapterFlavor, DatabaseAdapterFlavorDefinition>,
-      DatabaseAdapterFlavor,
+    private cacheAdapterFlavors: Record<CacheAdapterFlavor, CacheAdapterFlavorDefinition>
-      DatabaseAdapterFlavorDefinition
-    >,
-    private cacheAdapterFlavors: ReadonlyMap<CacheAdapterFlavor, CacheAdapterFlavorDefinition>
   ) {}
 
   /**
@@ -191,7 +181,7 @@ export default class EntityCompanionProvider {
    */
   getCompanionForEntity<
     TFields,
-    TID extends NonNullable<TFields[TSelectedFields]>,
+    TID,
     TViewerContext extends ViewerContext,
     TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
     TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -229,46 +219,24 @@ export default class EntityCompanionProvider {
         entityCompanionDefinition.entityClass,
         tableDataCoordinator,
         entityCompanionDefinition.privacyPolicyClass,
-        entityCompanionDefinition.mutationValidators(),
+        entityCompanionDefinition.mutationValidators,
-        entityCompanionDefinition.mutationTriggers(),
+        entityCompanionDefinition.mutationTriggers,
         this.metricsAdapter
       );
     });
   }
 
-  getQueryContextProviderForDatabaseAdaptorFlavor(
-    databaseAdapterFlavor: DatabaseAdapterFlavor
-  ): EntityQueryContextProvider {
-    const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors.get(databaseAdapterFlavor);
-    invariant(
-      entityDatabaseAdapterFlavor,
-      `No database adaptor configuration found for flavor: ${databaseAdapterFlavor}`
-    );
-
-    return entityDatabaseAdapterFlavor.queryContextProvider;
-  }
-
   private getTableDataCoordinatorForEntity<TFields>(
     entityConfiguration: EntityConfiguration<TFields>,
     entityClassName: string
   ): EntityTableDataCoordinator<TFields> {
     return computeIfAbsent(this.tableDataCoordinatorMap, entityConfiguration.tableName, () => {
-      const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors.get(
+      const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors[
         entityConfiguration.databaseAdapterFlavor
-      );
+      ];
-      invariant(
+      const entityCacheAdapterFlavor = this.cacheAdapterFlavors[
-        entityDatabaseAdapterFlavor,
-        `No database adaptor configuration found for flavor: ${entityConfiguration.databaseAdapterFlavor}`
-      );
-
-      const entityCacheAdapterFlavor = this.cacheAdapterFlavors.get(
         entityConfiguration.cacheAdapterFlavor
-      );
+      ];
-      invariant(
-        entityCacheAdapterFlavor,
-        `No cache adaptor configuration found for flavor: ${entityConfiguration.cacheAdapterFlavor}`
-      );
-
       return new EntityTableDataCoordinator(
         entityConfiguration,
         entityDatabaseAdapterFlavor.adapterProvider,

packages/entity/src/EntityConfiguration.ts

@@ -1,6 +1,6 @@
 import { IEntityClass } from './Entity';
 import { DatabaseAdapterFlavor, CacheAdapterFlavor } from './EntityCompanionProvider';
-import { EntityFieldDefinition } from './EntityFieldDefinition';
+import { EntityFieldDefinition } from './EntityFields';
 import { mapMap, invertMap, reduceMap } from './utils/collections/maps';
 
 /**
@@ -14,7 +14,7 @@ export default class EntityConfiguration<TFields> {
   readonly cacheKeyVersion: number;
 
   readonly getInboundEdges: () => IEntityClass<any, any, any, any, any, any>[];
-  readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>;
+  readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>;
   readonly entityToDBFieldsKeyMapping: ReadonlyMap<keyof TFields, string>;
   readonly dbToEntityFieldsKeyMapping: ReadonlyMap<string, keyof TFields>;
 
@@ -30,40 +30,12 @@ export default class EntityConfiguration<TFields> {
     databaseAdapterFlavor,
     cacheAdapterFlavor,
   }: {
-    /**
-     * The field used to identify this entity. Must be a unique field in the table.
-     */
     idField: keyof TFields;
-
-    /**
-     * The name of the table where entities of this type are stored.
-     */
     tableName: string;
-
+    schema: Record<keyof TFields, EntityFieldDefinition>;
-    /**
-     * Map from each entity field to an {@link EntityFieldDefinition} specifying information about the field.
-     */
-    schema: Record<keyof TFields, EntityFieldDefinition<any>>;
-
-    /**
-     * List of other entity types that reference this type in {@link EntityFieldDefinition} associations.
-     */
     getInboundEdges?: () => IEntityClass<any, any, any, any, any, any>[];
-
-    /**
-     * Cache key version for this entity type. Should be bumped when a field is added to, removed from, or changed
-     * in this entity and the underlying database table.
-     */
     cacheKeyVersion?: number;
-
-    /**
-     * Backing database and transaction type for this entity.
-     */
     databaseAdapterFlavor: DatabaseAdapterFlavor;
-
-    /**
-     * Cache system for this entity.
-     */
     cacheAdapterFlavor: CacheAdapterFlavor;
   }) {
     this.idField = idField;
@@ -87,7 +59,7 @@ export default class EntityConfiguration<TFields> {
   }
 
   private static computeCacheableKeys<TFields>(
-    schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>
+    schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>
   ): ReadonlySet<keyof TFields> {
     return reduceMap(
       schema,
@@ -102,7 +74,7 @@ export default class EntityConfiguration<TFields> {
   }
 
   private static computeEntityToDBFieldsKeyMapping<TFields>(
-    schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>
+    schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>
   ): ReadonlyMap<keyof TFields, string> {
     return mapMap(schema, (v) => v.columnName);
   }

packages/entity/src/EntityDatabaseAdapter.ts

@@ -14,17 +14,14 @@ interface SingleValueFieldEqualityCondition<TFields, N extends keyof TFields = k
 
 interface MultiValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
   fieldName: N;
-  fieldValues: readonly TFields[N][];
+  fieldValues: TFields[N][];
 }
 
 export type FieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> =
   | SingleValueFieldEqualityCondition<TFields, N>
   | MultiValueFieldEqualityCondition<TFields, N>;
 
-export function isSingleValueFieldEqualityCondition<
+function isSingleValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields>(
-  TFields,
-  N extends keyof TFields = keyof TFields
->(
   condition: FieldEqualityCondition<TFields, N>
 ): condition is SingleValueFieldEqualityCondition<TFields, N> {
   return (condition as SingleValueFieldEqualityCondition<TFields, N>).fieldValue !== undefined;
@@ -37,7 +34,7 @@ export interface TableFieldSingleValueEqualityCondition {
 
 export interface TableFieldMultiValueEqualityCondition {
   tableField: string;
-  tableValues: readonly any[];
+  tableValues: any[];
 }
 
 export enum OrderByOrdering {
@@ -69,14 +66,12 @@ export interface QuerySelectionModifiers<TFields> {
 }
 
 export interface TableQuerySelectionModifiers {
-  orderBy:
+  orderBy?: {
-    | {
     columnName: string;
     order: OrderByOrdering;
-      }[]
+  }[];
-    | undefined;
+  offset?: number;
-  offset: number | undefined;
+  limit?: number;
-  limit: number | undefined;
 }
 
 /**
@@ -265,7 +260,7 @@ export default abstract class EntityDatabaseAdapter<TFields> {
     return transformDatabaseObjectToFields(
       this.entityConfiguration,
       this.fieldTransformerMap,
-      results[0]!
+      results[0]
     );
   }
 
@@ -317,7 +312,7 @@ export default abstract class EntityDatabaseAdapter<TFields> {
     return transformDatabaseObjectToFields(
       this.entityConfiguration,
       this.fieldTransformerMap,
-      results[0]!
+      results[0]
     );
   }
 

packages/entity/src/EntityErrors.ts

@@ -0,0 +1,61 @@
+import ES6Error from 'es6-error';
+
+import { IEntityClass } from './Entity';
+import EntityPrivacyPolicy, { EntityAuthorizationAction } from './EntityPrivacyPolicy';
+import ReadonlyEntity from './ReadonlyEntity';
+import ViewerContext from './ViewerContext';
+
+export abstract class EntityError extends ES6Error {}
+
+export class EntityNotFoundError<
+  TFields,
+  TID,
+  TViewerContext extends ViewerContext,
+  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
+  TPrivacyPolicy extends EntityPrivacyPolicy<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TSelectedFields
+  >,
+  N extends keyof TFields,
+  TSelectedFields extends keyof TFields = keyof TFields
+> extends EntityError {
+  constructor(
+    entityClass: IEntityClass<
+      TFields,
+      TID,
+      TViewerContext,
+      TEntity,
+      TPrivacyPolicy,
+      TSelectedFields
+    >,
+    fieldName: N,
+    fieldValue: TFields[N]
+  ) {
+    super(`Entity not found: ${entityClass.name} (${fieldName} = ${fieldValue})`);
+  }
+}
+
+export class EntityNotAuthorizedError<
+  TFields,
+  TID,
+  TViewerContext extends ViewerContext,
+  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
+  TSelectedFields extends keyof TFields = keyof TFields
+> extends EntityError {
+  public readonly entityClassName: string;
+
+  constructor(
+    entity: TEntity,
+    viewerContext: TViewerContext,
+    action: EntityAuthorizationAction,
+    ruleIndex: number
+  ) {
+    super(
+      `Entity not authorized: ${entity} (viewer = ${viewerContext}, action = ${EntityAuthorizationAction[action]}, ruleIndex = ${ruleIndex})`
+    );
+    this.entityClassName = entity.constructor.name;
+  }
+}

packages/entity/src/EntityFieldDefinition.ts

@@ -1,124 +0,0 @@
-import { IEntityClass } from './Entity';
-import EntityPrivacyPolicy from './EntityPrivacyPolicy';
-import ReadonlyEntity from './ReadonlyEntity';
-import ViewerContext from './ViewerContext';
-
-export enum EntityEdgeDeletionBehavior {
-  /**
-   * Default. Invalidate the cache for all entities that reference the entity
-   * being deleted through this field, and transitively run deletions on those entities.
-   * This is most useful when the database itself expresses foreign
-   * keys and cascading deletes or set nulls and the entity framework just needs to
-   * be kept consistent with the state of the database.
-   */
-  CASCADE_DELETE_INVALIDATE_CACHE,
-
-  /**
-   * Delete all entities that reference the entity being deleted through this field. This is very similar
-   * to SQL `ON DELETE CASCADE` but is done in the Entity framework instead of at the underlying level.
-   * This will also invalidate the cached referencing entities.
-   */
-  CASCADE_DELETE,
-
-  /**
-   * Set this field to null when the referenced entity is deleted. This is very similar
-   * to SQL `ON DELETE SET NULL` but is done in the Entity framework instead of at the underlying level.
-   * This will also invalidate the cached referencing entities.
-   */
-  SET_NULL,
-}
-
-export interface EntityAssociationDefinition<
-  TViewerContext extends ViewerContext,
-  TAssociatedFields,
-  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
-  TAssociatedEntity extends ReadonlyEntity<
-    TAssociatedFields,
-    TAssociatedID,
-    TViewerContext,
-    TAssociatedSelectedFields
-  >,
-  TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
-    TAssociatedFields,
-    TAssociatedID,
-    TViewerContext,
-    TAssociatedEntity,
-    TAssociatedSelectedFields
-  >,
-  TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
-> {
-  /**
-   * Class of entity on the other end of this edge.
-   */
-  getAssociatedEntityClass: () => IEntityClass<
-    TAssociatedFields,
-    TAssociatedID,
-    TViewerContext,
-    TAssociatedEntity,
-    TAssociatedPrivacyPolicy,
-    TAssociatedSelectedFields
-  >;
-
-  /**
-   * Field by which to load the instance of associatedEntityClass. If not provided, the
-   * associatedEntityClass instance is fetched by its ID.
-   */
-  associatedEntityLookupByField?: keyof TAssociatedFields;
-
-  /**
-   * What action to perform on the current entity when the entity on the referencing end of
-   * this edge is deleted.
-   *
-   * @remarks
-   * The entity framework doesn't prescribe a one-size-fits-all solution for referential
-   * integrity; instead it exposes mechanisms that supports both database foreign key constraints
-   * and implicit entity-specified foreign keys. Choosing which approach to use often depends on
-   * application requirements, and sometimes even a mix-and-match is the right choice.
-   *
-   * - If referential integrity is critical to your application, database foreign key constraints
-   *   combined with {@link EntityEdgeDeletionBehavior.CASACDE_DELETE_INVALIDATE_CACHE} are recommended.
-   * - If the database being used doesn't support foreign keys, then using the entity framework for referential
-   *   integrity is recommended.
-   */
-  edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
-}
-
-export abstract class EntityFieldDefinition<T> {
-  readonly columnName: string;
-  readonly cache: boolean;
-  readonly association: EntityAssociationDefinition<any, any, any, any, any, any> | undefined;
-  /**
-   *
-   * @param columnName - Column name in the database.
-   * @param cache - Whether or not to cache loaded instances of the entity by this field. The column name is
-   *              used to derive a cache key for the cache entry. If true, this column must be able uniquely
-   *              identify the entity.
-   */
-  constructor({
-    columnName,
-    cache = false,
-    association,
-  }: {
-    columnName: string;
-    cache?: boolean;
-    association?: EntityAssociationDefinition<any, any, any, any, any, any>;
-  }) {
-    this.columnName = columnName;
-    this.cache = cache;
-    this.association = association;
-  }
-
-  /**
-   * Validates input value for a field of this type. Null and undefined are considered valid by default. This is used for things like:
-   * - EntityLoader.loadByFieldValue - to ensure the value being loaded by is a valid value
-   * - EntityMutator.setField - to ensure the value being set is a valid value
-   */
-  public validateInputValue(value: T | null | undefined): boolean {
-    if (value === null || value === undefined) {
-      return true;
-    }
-
-    return this.validateInputValueInternal(value);
-  }
-  protected abstract validateInputValueInternal(value: T): boolean;
-}

packages/entity/src/EntityFields.ts

@@ -1,62 +1,121 @@
-import { validate as validateUUID } from 'uuid';
+import { IEntityClass } from './Entity';
+import EntityPrivacyPolicy from './EntityPrivacyPolicy';
+import ReadonlyEntity from './ReadonlyEntity';
+import ViewerContext from './ViewerContext';
 
-import { EntityFieldDefinition } from './EntityFieldDefinition';
+export enum EntityEdgeDeletionBehavior {
+  /**
+   * Default. Invalidate the cache for all entities that reference the entity
+   * being deleted through this field, and transitively run deletions on those entities.
+   * This is most useful when the database itself expresses foreign
+   * keys and cascading deletes or set nulls and the entity framework just needs to
+   * be kept consistent with the state of the database.
+   */
+  CASCADE_DELETE_INVALIDATE_CACHE,
 
-export class StringField extends EntityFieldDefinition<string> {
+  /**
-  protected validateInputValueInternal(value: string): boolean {
+   * Delete all entities that reference the entity being deleted through this field. This is very similar
-    return typeof value === 'string';
+   * to SQL `ON DELETE CASCADE` but is done in the Entity framework instead of at the underlying level.
-  }
+   * This will also invalidate the cached referencing entities.
+   */
+  CASCADE_DELETE,
+
+  /**
+   * Set this field to null when the referenced entity is deleted. This is very similar
+   * to SQL `ON DELETE SET NULL` but is done in the Entity framework instead of at the underlying level.
+   * This will also invalidate the cached referencing entities.
+   */
+  SET_NULL,
 }
-export class UUIDField extends StringField {
+
-  protected override validateInputValueInternal(value: string): boolean {
+export interface EntityAssociationDefinition<
-    return validateUUID(value);
+  TViewerContext extends ViewerContext,
-  }
+  TAssociatedFields,
+  TAssociatedID,
+  TAssociatedEntity extends ReadonlyEntity<
+    TAssociatedFields,
+    TAssociatedID,
+    TViewerContext,
+    TAssociatedSelectedFields
+  >,
+  TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
+    TAssociatedFields,
+    TAssociatedID,
+    TViewerContext,
+    TAssociatedEntity,
+    TAssociatedSelectedFields
+  >,
+  TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
+> {
+  /**
+   * Class of entity on the other end of this edge.
+   */
+  getAssociatedEntityClass: () => IEntityClass<
+    TAssociatedFields,
+    TAssociatedID,
+    TViewerContext,
+    TAssociatedEntity,
+    TAssociatedPrivacyPolicy,
+    TAssociatedSelectedFields
+  >;
+
+  /**
+   * Field by which to load the instance of associatedEntityClass. If not provided, the
+   * associatedEntityClass instance is fetched by its ID.
+   */
+  associatedEntityLookupByField?: keyof TAssociatedFields;
+
+  /**
+   * What action to perform on the current entity when the entity on the referencing end of
+   * this edge is deleted.
+   *
+   * @remarks
+   * The entity framework doesn't prescribe a one-size-fits-all solution for referential
+   * integrity; instead it exposes mechanisms that supports both database foreign key constraints
+   * and implicit entity-specified foreign keys. Choosing which approach to use often depends on
+   * application requirements, and sometimes even a mix-and-match is the right choice.
+   *
+   * - If referential integrity is critical to your application, database foreign key constraints
+   *   combined with {@link EntityEdgeDeletionBehavior.CASACDE_DELETE_INVALIDATE_CACHE} are recommended.
+   * - If the database being used doesn't support foreign keys, then using the entity framework for referential
+   *   integrity is recommended.
+   */
+  edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
 }
-export class DateField extends EntityFieldDefinition<Date> {
+
-  protected validateInputValueInternal(value: Date): boolean {
+export abstract class EntityFieldDefinition {
-    return value instanceof Date;
+  readonly columnName: string;
-  }
+  readonly cache: boolean;
-}
+  readonly association?: EntityAssociationDefinition<any, any, any, any, any, any>;
-export class BooleanField extends EntityFieldDefinition<boolean> {
+  /**
-  protected validateInputValueInternal(value: boolean): boolean {
+   *
-    return typeof value === 'boolean';
+   * @param columnName - Column name in the database.
+   * @param cache - Whether or not to cache loaded instances of the entity by this field. The column name is
+   *              used to derive a cache key for the cache entry. If true, this column must be able uniquely
+   *              identify the entity.
+   */
+  constructor({
+    columnName,
+    cache = false,
+    association,
+  }: {
+    columnName: string;
+    cache?: boolean;
+    association?: EntityAssociationDefinition<any, any, any, any, any, any>;
+  }) {
+    this.columnName = columnName;
+    this.cache = cache;
+    this.association = association;
   }
 }
 
-export class IntField extends EntityFieldDefinition<number> {
+export class StringField extends EntityFieldDefinition {}
-  protected validateInputValueInternal(value: number): boolean {
+export class UUIDField extends StringField {}
-    return typeof value === 'number' && Number.isInteger(value);
+export class DateField extends EntityFieldDefinition {}
-  }
+export class BooleanField extends EntityFieldDefinition {}
-}
+export class NumberField extends EntityFieldDefinition {}
-
+export class StringArrayField extends EntityFieldDefinition {}
-export class FloatField extends EntityFieldDefinition<number> {
+export class JSONObjectField extends EntityFieldDefinition {}
-  protected validateInputValueInternal(value: number): boolean {
+export class EnumField extends EntityFieldDefinition {}
-    return typeof value === 'number';
+export class JSONArrayField extends EntityFieldDefinition {}
-  }
+export class MaybeJSONArrayField extends EntityFieldDefinition {}
-}
-
-export class StringArrayField extends EntityFieldDefinition<string[]> {
-  protected validateInputValueInternal(value: string[]): boolean {
-    return Array.isArray(value) && value.every((subValue) => typeof subValue === 'string');
-  }
-}
-export class JSONObjectField extends EntityFieldDefinition<object> {
-  protected validateInputValueInternal(value: object): boolean {
-    return typeof value === 'object' && !Array.isArray(value);
-  }
-}
-export class EnumField extends EntityFieldDefinition<string | number> {
-  protected validateInputValueInternal(value: string | number): boolean {
-    return typeof value === 'number' || typeof value === 'string';
-  }
-}
-export class JSONArrayField extends EntityFieldDefinition<any[]> {
-  protected validateInputValueInternal(value: any[]): boolean {
-    return Array.isArray(value);
-  }
-}
-export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
-  protected validateInputValueInternal(_value: any): boolean {
-    return true;
-  }
-}

packages/entity/src/EntityLoader.ts

@@ -3,20 +3,13 @@ import invariant from 'invariant';
 
 import EnforcingEntityLoader from './EnforcingEntityLoader';
 import { IEntityClass } from './Entity';
-import EntityConfiguration from './EntityConfiguration';
+import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
-import {
+import { EntityNotFoundError } from './EntityErrors';
-  FieldEqualityCondition,
-  QuerySelectionModifiers,
-  isSingleValueFieldEqualityCondition,
-} from './EntityDatabaseAdapter';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
-import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
-import EntityNotFoundError from './errors/EntityNotFoundError';
 import EntityDataManager from './internal/EntityDataManager';
-import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
 import { mapMap, mapMapAsync } from './utils/collections/maps';
 
 /**
@@ -25,7 +18,7 @@ import { mapMap, mapMapAsync } from './utils/collections/maps';
  */
 export default class EntityLoader<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -40,7 +33,7 @@ export default class EntityLoader<
   constructor(
     private readonly viewerContext: TViewerContext,
     private readonly queryContext: EntityQueryContext,
-    private readonly entityConfiguration: EntityConfiguration<TFields>,
+    private readonly idField: keyof Pick<TFields, TSelectedFields>,
     private readonly entityClass: IEntityClass<
       TFields,
       TID,
@@ -50,8 +43,7 @@ export default class EntityLoader<
       TSelectedFields
     >,
     private readonly privacyPolicy: TPrivacyPolicy,
-    private readonly dataManager: EntityDataManager<TFields>,
+    private readonly dataManager: EntityDataManager<TFields>
-    protected readonly metricsAdapter: IEntityMetricsAdapter
   ) {}
 
   /**
@@ -81,15 +73,34 @@ export default class EntityLoader<
     fieldName: N,
     fieldValues: readonly NonNullable<TFields[N]>[]
   ): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
-    this.validateFieldValues(fieldName, fieldValues);
-
     const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
       this.queryContext,
       fieldName,
       fieldValues
     );
+    const fieldValuesToUncheckedEntityResults = mapMap(fieldValuesToFieldObjects, (fieldObjects) =>
+      this.tryConstructEntities(fieldObjects)
+    );
 
-    return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects);
+    return await mapMapAsync(
+      fieldValuesToUncheckedEntityResults,
+      async (uncheckedEntityResults) => {
+        return await Promise.all(
+          uncheckedEntityResults.map(async (uncheckedEntityResult) => {
+            if (!uncheckedEntityResult.ok) {
+              return uncheckedEntityResult;
+            }
+            return await asyncResult(
+              this.privacyPolicy.authorizeReadAsync(
+                this.viewerContext,
+                this.queryContext,
+                uncheckedEntityResult.value
+              )
+            );
+          })
+        );
+      }
+    );
   }
 
   /**
@@ -139,9 +150,7 @@ export default class EntityLoader<
     const entityResults = await this.loadManyByIDsAsync([id]);
     const entityResult = entityResults.get(id);
     if (entityResult === undefined) {
-      return result(
+      return result(new EntityNotFoundError(this.entityClass, this.idField, id as any));
-        new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
-      );
     }
     return entityResult;
   }
@@ -152,10 +161,7 @@ export default class EntityLoader<
    * @returns entity result for matching ID, or null if no entity exists for ID.
    */
   async loadByIDNullableAsync(id: TID): Promise<Result<TEntity> | null> {
-    return await this.loadByFieldEqualingAsync(
+    return await this.loadByFieldEqualingAsync(this.idField, id as any);
-      this.entityConfiguration.idField as TSelectedFields,
-      id
-    );
   }
 
   /**
@@ -165,15 +171,14 @@ export default class EntityLoader<
    * @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
    */
   async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
-    const entityResults = (await this.loadManyByFieldEqualingManyAsync(
+    const entityResults = ((await this.loadManyByFieldEqualingManyAsync(
-      this.entityConfiguration.idField as TSelectedFields,
+      this.idField,
-      ids
+      ids as any
-    )) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
+    )) as any) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
     return mapMap(entityResults, (entityResultsForId, id) => {
       const entityResult = entityResultsForId[0];
       return (
-        entityResult ??
+        entityResult ?? result(new EntityNotFoundError(this.entityClass, this.idField, id as any))
-        result(new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id))
       );
     });
   }
@@ -196,13 +201,6 @@ export default class EntityLoader<
     fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
     querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
   ): Promise<readonly Result<TEntity>[]> {
-    for (const fieldEqualityOperand of fieldEqualityOperands) {
-      const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
-        ? [fieldEqualityOperand.fieldValue]
-        : fieldEqualityOperand.fieldValues;
-      this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
-    }
-
     const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
       this.queryContext,
       fieldEqualityOperands,
@@ -218,8 +216,7 @@ export default class EntityLoader<
           this.privacyPolicy.authorizeReadAsync(
             this.viewerContext,
             this.queryContext,
-            uncheckedEntityResult.value,
+            uncheckedEntityResult.value
-            this.metricsAdapter
           )
         );
       })
@@ -272,8 +269,7 @@ export default class EntityLoader<
           this.privacyPolicy.authorizeReadAsync(
             this.viewerContext,
             this.queryContext,
-            uncheckedEntityResult.value,
+            uncheckedEntityResult.value
-            this.metricsAdapter
           )
         );
       })
@@ -288,6 +284,13 @@ export default class EntityLoader<
     await this.dataManager.invalidateObjectFieldsAsync(objectFields);
   }
 
+  async invalidateFieldsTransactionalAsync(objectFields: Readonly<TFields>): Promise<void> {
+    await this.dataManager.invalidateObjectFieldsTransactionalAsync(
+      this.queryContext,
+      objectFields
+    );
+  }
+
   /**
    * Invalidate all caches for an entity. One potential use case would be to keep the entity
    * framework in sync with changes made to data outside of the framework.
@@ -297,61 +300,18 @@ export default class EntityLoader<
     await this.invalidateFieldsAsync(entity.getAllDatabaseFields());
   }
 
+  /**
+   * Wrap entity construction in try/catch and return Results. Used to prevent constructor errors
+   * thrown for one entity instantiation from interfering with other entity instantiatons of the same query.
+   * @param fieldsObjects - array of entity data objects to construct entities
+   */
   private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
     return fieldsObjects.map((fieldsObject) => {
       try {
         return result(new this.entityClass(this.viewerContext, fieldsObject));
       } catch (e) {
-        if (!(e instanceof Error)) {
-          throw e;
-        }
         return result(e);
       }
     });
   }
-
-  /**
-   * Construct and authorize entities from fields map, returning error results for entities that fail
-   * to construct or fail to authorize.
-   *
-   * @param map - map from an arbitrary key type to an array of entity field objects
-   */
-  public async constructAndAuthorizeEntitiesAsync<K>(
-    map: ReadonlyMap<K, readonly Readonly<TFields>[]>
-  ): Promise<ReadonlyMap<K, readonly Result<TEntity>[]>> {
-    const uncheckedEntityResultsMap = mapMap(map, (fieldObjects) =>
-      this.tryConstructEntities(fieldObjects)
-    );
-    return await mapMapAsync(uncheckedEntityResultsMap, async (uncheckedEntityResults) => {
-      return await Promise.all(
-        uncheckedEntityResults.map(async (uncheckedEntityResult) => {
-          if (!uncheckedEntityResult.ok) {
-            return uncheckedEntityResult;
-          }
-          return await asyncResult(
-            this.privacyPolicy.authorizeReadAsync(
-              this.viewerContext,
-              this.queryContext,
-              uncheckedEntityResult.value,
-              this.metricsAdapter
-            )
-          );
-        })
-      );
-    });
-  }
-
-  private validateFieldValues<N extends keyof Pick<TFields, TSelectedFields>>(
-    fieldName: N,
-    fieldValues: readonly TFields[N][]
-  ): void {
-    const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
-    invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
-    for (const fieldValue of fieldValues) {
-      const isInputValid = fieldDefinition.validateInputValue(fieldValue);
-      if (!isInputValid) {
-        throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
-      }
-    }
-  }
 }

packages/entity/src/EntityLoaderFactory.ts

@@ -1,19 +1,17 @@
 import { IEntityClass } from './Entity';
-import EntityConfiguration from './EntityConfiguration';
 import EntityLoader from './EntityLoader';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
 import EntityDataManager from './internal/EntityDataManager';
-import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
 
 /**
  * The primary entry point for loading entities.
  */
 export default class EntityLoaderFactory<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -26,7 +24,7 @@ export default class EntityLoaderFactory<
   TSelectedFields extends keyof TFields
 > {
   constructor(
-    private readonly entityConfiguration: EntityConfiguration<TFields>,
+    private readonly idField: keyof Pick<TFields, TSelectedFields>,
     private readonly entityClass: IEntityClass<
       TFields,
       TID,
@@ -36,8 +34,7 @@ export default class EntityLoaderFactory<
       TSelectedFields
     >,
     private readonly privacyPolicyClass: TPrivacyPolicy,
-    private readonly dataManager: EntityDataManager<TFields>,
+    private readonly dataManager: EntityDataManager<TFields>
-    protected readonly metricsAdapter: IEntityMetricsAdapter
   ) {}
 
   /**
@@ -52,11 +49,10 @@ export default class EntityLoaderFactory<
     return new EntityLoader(
       viewerContext,
       queryContext,
-      this.entityConfiguration,
+      this.idField,
       this.entityClass,
       this.privacyPolicyClass,
-      this.dataManager,
+      this.dataManager
-      this.metricsAdapter
     );
   }
 }

packages/entity/src/EntityMutationInfo.ts

@@ -1,47 +0,0 @@
-import Entity from './Entity';
-import ViewerContext from './ViewerContext';
-
-export enum EntityMutationType {
-  CREATE,
-  UPDATE,
-  DELETE,
-}
-
-export type EntityValidatorMutationInfo<
-  TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
-  TViewerContext extends ViewerContext,
-  TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
-  TSelectedFields extends keyof TFields = keyof TFields
-> =
-  | {
-      type: EntityMutationType.CREATE;
-    }
-  | {
-      type: EntityMutationType.UPDATE;
-      previousValue: TEntity;
-    };
-
-export type EntityMutationTriggerDeleteCascadeInfo<> = {
-  entity: Entity<any, any, any, any>;
-  cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null;
-};
-
-export type EntityTriggerMutationInfo<
-  TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
-  TViewerContext extends ViewerContext,
-  TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
-  TSelectedFields extends keyof TFields = keyof TFields
-> =
-  | {
-      type: EntityMutationType.CREATE;
-    }
-  | {
-      type: EntityMutationType.UPDATE;
-      previousValue: TEntity;
-    }
-  | {
-      type: EntityMutationType.DELETE;
-      cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null;
-    };

packages/entity/src/EntityMutationTriggerConfiguration.ts

@@ -1,5 +1,4 @@
-import { EntityTriggerMutationInfo } from './EntityMutationInfo';
+import { EntityQueryContext } from './EntityQueryContext';
-import { EntityTransactionalQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
 
@@ -8,7 +7,7 @@ import ViewerContext from './ViewerContext';
  */
 export default interface EntityMutationTriggerConfiguration<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
@@ -71,16 +70,15 @@ export default interface EntityMutationTriggerConfiguration<
  */
 export abstract class EntityMutationTrigger<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
-  abstract executeAsync(
+  abstract async executeAsync(
     viewerContext: TViewerContext,
-    queryContext: EntityTransactionalQueryContext,
+    queryContext: EntityQueryContext,
-    entity: TEntity,
+    entity: TEntity
-    mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
   ): Promise<void>;
 }
 
@@ -90,14 +88,10 @@ export abstract class EntityMutationTrigger<
  */
 export abstract class EntityNonTransactionalMutationTrigger<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
-  abstract executeAsync(
+  abstract async executeAsync(viewerContext: TViewerContext, entity: TEntity): Promise<void>;
-    viewerContext: TViewerContext,
-    entity: TEntity,
-    mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
-  ): Promise<void>;
 }

packages/entity/src/EntityMutationValidator.ts

@@ -1,29 +1,21 @@
-import { EntityValidatorMutationInfo } from './EntityMutationInfo';
+import { EntityQueryContext } from './EntityQueryContext';
-import { EntityTransactionalQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
 
-/**
+/*
  * A validator is a way to specify entity mutation validation that runs within the
  * same transaction as the mutation itself before creating or updating an entity.
  */
 export default abstract class EntityMutationValidator<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
-  abstract executeAsync(
+  abstract async executeAsync(
     viewerContext: TViewerContext,
-    queryContext: EntityTransactionalQueryContext,
+    queryContext: EntityQueryContext,
-    entity: TEntity,
+    entity: TEntity
-    mutationInfo: EntityValidatorMutationInfo<
-      TFields,
-      TID,
-      TViewerContext,
-      TEntity,
-      TSelectedFields
-    >
   ): Promise<void>;
 }

packages/entity/src/EntityMutator.ts

@@ -1,18 +1,11 @@
 import { Result, asyncResult, result, enforceAsyncResult } from '@expo/results';
-import invariant from 'invariant';
 
 import Entity, { IEntityClass } from './Entity';
 import { EntityCompanionDefinition } from './EntityCompanionProvider';
 import EntityConfiguration from './EntityConfiguration';
 import EntityDatabaseAdapter from './EntityDatabaseAdapter';
-import { EntityEdgeDeletionBehavior } from './EntityFieldDefinition';
+import { EntityEdgeDeletionBehavior } from './EntityFields';
 import EntityLoaderFactory from './EntityLoaderFactory';
-import {
-  EntityValidatorMutationInfo,
-  EntityMutationType,
-  EntityTriggerMutationInfo,
-  EntityMutationTriggerDeleteCascadeInfo,
-} from './EntityMutationInfo';
 import EntityMutationTriggerConfiguration, {
   EntityMutationTrigger,
   EntityNonTransactionalMutationTrigger,
@@ -22,14 +15,13 @@ import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
-import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
 import { timeAndLogMutationEventAsync } from './metrics/EntityMetricsUtils';
 import IEntityMetricsAdapter, { EntityMetricsMutationType } from './metrics/IEntityMetricsAdapter';
 import { mapMapAsync } from './utils/collections/maps';
 
 abstract class BaseMutator<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -80,56 +72,25 @@ abstract class BaseMutator<
     protected readonly metricsAdapter: IEntityMetricsAdapter
   ) {}
 
-  protected validateFields(fields: Partial<TFields>): void {
+  protected async executeMutationTriggersOrValidatorsAsync(
-    for (const fieldName in fields) {
+    triggersOrValidators:
-      const fieldValue = fields[fieldName];
-      const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
-      invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
-      const isInputValid = fieldDefinition.validateInputValue(fieldValue);
-      if (!isInputValid) {
-        throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
-      }
-    }
-  }
-
-  protected async executeMutationValidatorsAsync(
-    validators: EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
-    queryContext: EntityTransactionalQueryContext,
-    entity: TEntity,
-    mutationInfo: EntityValidatorMutationInfo<
-      TFields,
-      TID,
-      TViewerContext,
-      TEntity,
-      TSelectedFields
-    >
-  ): Promise<void> {
-    await Promise.all(
-      validators.map((validator) =>
-        validator.executeAsync(this.viewerContext, queryContext, entity, mutationInfo)
-      )
-    );
-  }
-
-  protected async executeMutationTriggersAsync(
-    triggers:
       | EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
+      | EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
       | undefined,
-    queryContext: EntityTransactionalQueryContext,
+    queryContext: EntityQueryContext,
-    entity: TEntity,
+    entity: TEntity
-    mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
   ): Promise<void> {
-    if (!triggers) {
+    if (!triggersOrValidators) {
       return;
     }
     await Promise.all(
-      triggers.map((trigger) =>
+      triggersOrValidators.map((triggerOrValidator) =>
-        trigger.executeAsync(this.viewerContext, queryContext, entity, mutationInfo)
+        triggerOrValidator.executeAsync(this.viewerContext, queryContext, entity)
       )
     );
   }
 
-  protected async executeNonTransactionalMutationTriggersAsync(
+  protected async executeNonTransactionalMutationTriggersOrValidatorsAsync(
     triggers:
       | EntityNonTransactionalMutationTrigger<
           TFields,
@@ -139,15 +100,12 @@ abstract class BaseMutator<
           TSelectedFields
         >[]
       | undefined,
-    entity: TEntity,
+    entity: TEntity
-    mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
   ): Promise<void> {
     if (!triggers) {
       return;
     }
-    await Promise.all(
+    await Promise.all(triggers.map((trigger) => trigger.executeAsync(this.viewerContext, entity)));
-      triggers.map((trigger) => trigger.executeAsync(this.viewerContext, entity, mutationInfo))
-    );
   }
 }
 
@@ -156,7 +114,7 @@ abstract class BaseMutator<
  */
 export class CreateMutator<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -209,75 +167,67 @@ export class CreateMutator<
   private async createInternalAsync(
     queryContext: EntityTransactionalQueryContext
   ): Promise<Result<TEntity>> {
-    this.validateFields(this.fieldsForEntity);
+    const temporaryEntityForPrivacyCheck = new this.entityClass(this.viewerContext, ({
-
-    const temporaryEntityForPrivacyCheck = new this.entityClass(this.viewerContext, {
       [this.entityConfiguration.idField]: '00000000-0000-0000-0000-000000000000', // zero UUID
       ...this.fieldsForEntity,
-    } as unknown as TFields);
+    } as unknown) as TFields);
 
     const authorizeCreateResult = await asyncResult(
       this.privacyPolicy.authorizeCreateAsync(
         this.viewerContext,
         queryContext,
-        temporaryEntityForPrivacyCheck,
+        temporaryEntityForPrivacyCheck
-        this.metricsAdapter
       )
     );
     if (!authorizeCreateResult.ok) {
       return authorizeCreateResult;
     }
 
-    await this.executeMutationValidatorsAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationValidators,
       queryContext,
-      temporaryEntityForPrivacyCheck,
+      temporaryEntityForPrivacyCheck
-      { type: EntityMutationType.CREATE }
     );
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.beforeAll,
       queryContext,
-      temporaryEntityForPrivacyCheck,
+      temporaryEntityForPrivacyCheck
-      { type: EntityMutationType.CREATE }
     );
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.beforeCreate,
       queryContext,
-      temporaryEntityForPrivacyCheck,
+      temporaryEntityForPrivacyCheck
-      { type: EntityMutationType.CREATE }
     );
 
     const insertResult = await this.databaseAdapter.insertAsync(queryContext, this.fieldsForEntity);
 
     const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
-    queryContext.appendPostCommitInvalidationCallback(
+    queryContext.appendPostCommitCallback(
       entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult)
     );
+    await entityLoader.invalidateFieldsTransactionalAsync(insertResult);
 
     const unauthorizedEntityAfterInsert = new this.entityClass(this.viewerContext, insertResult);
     const newEntity = await entityLoader
       .enforcing()
       .loadByIDAsync(unauthorizedEntityAfterInsert.getID());
 
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.afterCreate,
       queryContext,
-      newEntity,
+      newEntity
-      { type: EntityMutationType.CREATE }
     );
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.afterAll,
       queryContext,
-      newEntity,
+      newEntity
-      { type: EntityMutationType.CREATE }
     );
 
     queryContext.appendPostCommitCallback(
-      this.executeNonTransactionalMutationTriggersAsync.bind(
+      this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
         this,
         this.mutationTriggers.afterCommit,
-        newEntity,
+        newEntity
-        { type: EntityMutationType.CREATE }
       )
     );
 
@@ -290,7 +240,7 @@ export class CreateMutator<
  */
 export class UpdateMutator<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -302,7 +252,7 @@ export class UpdateMutator<
   >,
   TSelectedFields extends keyof TFields
 > extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
-  private readonly originalEntity: TEntity;
+  private readonly originalFieldsForEntity: Readonly<TFields>;
   private readonly fieldsForEntity: TFields;
   private readonly updatedFields: Partial<TFields> = {};
 
@@ -343,7 +293,7 @@ export class UpdateMutator<
     >,
     databaseAdapter: EntityDatabaseAdapter<TFields>,
     metricsAdapter: IEntityMetricsAdapter,
-    originalEntity: TEntity
+    fieldsForEntity: Readonly<TFields>
   ) {
     super(
       viewerContext,
@@ -357,8 +307,8 @@ export class UpdateMutator<
       databaseAdapter,
       metricsAdapter
     );
-    this.originalEntity = originalEntity;
+    this.originalFieldsForEntity = { ...fieldsForEntity };
-    this.fieldsForEntity = { ...originalEntity.getAllDatabaseFields() };
+    this.fieldsForEntity = { ...fieldsForEntity };
   }
 
   /**
@@ -402,38 +352,32 @@ export class UpdateMutator<
   private async updateInternalAsync(
     queryContext: EntityTransactionalQueryContext
   ): Promise<Result<TEntity>> {
-    this.validateFields(this.updatedFields);
-
     const entityAboutToBeUpdated = new this.entityClass(this.viewerContext, this.fieldsForEntity);
     const authorizeUpdateResult = await asyncResult(
       this.privacyPolicy.authorizeUpdateAsync(
         this.viewerContext,
         queryContext,
-        entityAboutToBeUpdated,
+        entityAboutToBeUpdated
-        this.metricsAdapter
       )
     );
     if (!authorizeUpdateResult.ok) {
       return authorizeUpdateResult;
     }
 
-    await this.executeMutationValidatorsAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationValidators,
       queryContext,
-      entityAboutToBeUpdated,
+      entityAboutToBeUpdated
-      { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
     );
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.beforeAll,
       queryContext,
-      entityAboutToBeUpdated,
+      entityAboutToBeUpdated
-      { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
     );
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.beforeUpdate,
       queryContext,
-      entityAboutToBeUpdated,
+      entityAboutToBeUpdated
-      { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
     );
 
     const updateResult = await this.databaseAdapter.updateAsync(
@@ -445,40 +389,39 @@ export class UpdateMutator<
 
     const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
 
-    queryContext.appendPostCommitInvalidationCallback(
+    queryContext.appendPostCommitCallback(
-      entityLoader.invalidateFieldsAsync.bind(
+      entityLoader.invalidateFieldsAsync.bind(entityLoader, this.originalFieldsForEntity)
-        entityLoader,
-        this.originalEntity.getAllDatabaseFields()
-      )
     );
-    queryContext.appendPostCommitInvalidationCallback(
+    queryContext.appendPostCommitCallback(
       entityLoader.invalidateFieldsAsync.bind(entityLoader, this.fieldsForEntity)
     );
 
+    await Promise.all([
+      entityLoader.invalidateFieldsTransactionalAsync(this.originalFieldsForEntity),
+      entityLoader.invalidateFieldsTransactionalAsync(this.fieldsForEntity),
+    ]);
+
     const unauthorizedEntityAfterUpdate = new this.entityClass(this.viewerContext, updateResult);
     const updatedEntity = await entityLoader
       .enforcing()
       .loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
 
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.afterUpdate,
       queryContext,
-      updatedEntity,
+      updatedEntity
-      { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
     );
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.afterAll,
       queryContext,
-      updatedEntity,
+      updatedEntity
-      { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
     );
 
     queryContext.appendPostCommitCallback(
-      this.executeNonTransactionalMutationTriggersAsync.bind(
+      this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
         this,
         this.mutationTriggers.afterCommit,
-        updatedEntity,
+        updatedEntity
-        { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
       )
     );
 
@@ -491,7 +434,7 @@ export class UpdateMutator<
  */
 export class DeleteMutator<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -565,7 +508,7 @@ export class DeleteMutator<
       this.metricsAdapter,
       EntityMetricsMutationType.DELETE,
       this.entityClass.name
-    )(this.deleteInTransactionAsync(new Set(), false, null));
+    )(this.deleteInTransactionAsync());
   }
 
   /**
@@ -576,16 +519,14 @@ export class DeleteMutator<
   }
 
   private async deleteInTransactionAsync(
-    processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
+    processedEntityIdentifiersFromTransitiveDeletions: Set<string> = new Set(),
-    skipDatabaseDeletion: boolean,
+    skipDatabaseDeletion: boolean = false
-    cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null
   ): Promise<Result<void>> {
     return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
       this.deleteInternalAsync(
         innerQueryContext,
         processedEntityIdentifiersFromTransitiveDeletions,
-        skipDatabaseDeletion,
+        skipDatabaseDeletion
-        cascadingDeleteCause
       )
     );
   }
@@ -593,39 +534,30 @@ export class DeleteMutator<
   private async deleteInternalAsync(
     queryContext: EntityTransactionalQueryContext,
     processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
-    skipDatabaseDeletion: boolean,
+    skipDatabaseDeletion: boolean
-    cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null
   ): Promise<Result<void>> {
     const authorizeDeleteResult = await asyncResult(
-      this.privacyPolicy.authorizeDeleteAsync(
+      this.privacyPolicy.authorizeDeleteAsync(this.viewerContext, queryContext, this.entity)
-        this.viewerContext,
-        queryContext,
-        this.entity,
-        this.metricsAdapter
-      )
     );
     if (!authorizeDeleteResult.ok) {
       return authorizeDeleteResult;
     }
 
-    await this.processEntityDeletionForInboundEdgesAsync(
+    await DeleteMutator.processEntityDeletionForInboundEdgesAsync(
       this.entity,
       queryContext,
-      processedEntityIdentifiersFromTransitiveDeletions,
+      processedEntityIdentifiersFromTransitiveDeletions
-      cascadingDeleteCause
     );
 
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.beforeAll,
       queryContext,
-      this.entity,
+      this.entity
-      { type: EntityMutationType.DELETE, cascadingDeleteCause }
     );
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.beforeDelete,
       queryContext,
-      this.entity,
+      this.entity
-      { type: EntityMutationType.DELETE, cascadingDeleteCause }
     );
 
     if (!skipDatabaseDeletion) {
@@ -637,29 +569,27 @@ export class DeleteMutator<
     }
 
     const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
-    queryContext.appendPostCommitInvalidationCallback(
+    queryContext.appendPostCommitCallback(
       entityLoader.invalidateFieldsAsync.bind(entityLoader, this.entity.getAllDatabaseFields())
     );
+    await entityLoader.invalidateFieldsTransactionalAsync(this.entity.getAllDatabaseFields());
 
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.afterDelete,
       queryContext,
-      this.entity,
+      this.entity
-      { type: EntityMutationType.DELETE, cascadingDeleteCause }
     );
-    await this.executeMutationTriggersAsync(
+    await this.executeMutationTriggersOrValidatorsAsync(
       this.mutationTriggers.afterAll,
       queryContext,
-      this.entity,
+      this.entity
-      { type: EntityMutationType.DELETE, cascadingDeleteCause }
     );
 
     queryContext.appendPostCommitCallback(
-      this.executeNonTransactionalMutationTriggersAsync.bind(
+      this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
         this,
         this.mutationTriggers.afterCommit,
-        this.entity,
+        this.entity
-        { type: EntityMutationType.DELETE, cascadingDeleteCause }
       )
     );
 
@@ -680,11 +610,16 @@ export class DeleteMutator<
    *
    * @param entity - entity to find all references to
    */
-  private async processEntityDeletionForInboundEdgesAsync(
+  private static async processEntityDeletionForInboundEdgesAsync<
-    entity: TEntity,
+    TMFields,
+    TMID,
+    TMViewerContext extends ViewerContext,
+    TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
+    TMSelectedFields extends keyof TMFields
+  >(
+    entity: TMEntity,
     queryContext: EntityTransactionalQueryContext,
-    processedEntityIdentifiers: Set<string>,
+    processedEntityIdentifiers: Set<string>
-    cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null
   ): Promise<void> {
     // prevent infinite reference cycles by keeping track of entities already processed
     if (processedEntityIdentifiers.has(entity.getUniqueIdentifier())) {
@@ -692,15 +627,13 @@ export class DeleteMutator<
     }
     processedEntityIdentifiers.add(entity.getUniqueIdentifier());
 
-    const companionDefinition = (
+    const companionDefinition = (entity.constructor as any).getCompanionDefinition() as EntityCompanionDefinition<
-      entity.constructor as any
+      TMFields,
-    ).getCompanionDefinition() as EntityCompanionDefinition<
+      TMID,
-      TFields,
+      TMViewerContext,
-      TID,
+      TMEntity,
-      TViewerContext,
+      EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity, TMSelectedFields>,
-      TEntity,
+      TMSelectedFields
-      TPrivacyPolicy,
-      TSelectedFields
     >;
     const entityConfiguration = companionDefinition.entityConfiguration;
     const inboundEdges = entityConfiguration.getInboundEdges();
@@ -757,11 +690,7 @@ export class DeleteMutator<
                       .forDelete(inboundReferenceEntity, queryContext)
                       .deleteInTransactionAsync(
                         processedEntityIdentifiers,
-                        /* skipDatabaseDeletion */ true, // deletion is handled by DB
+                        /* skipDatabaseDeletion */ true // deletion is handled by DB
-                        {
-                          entity,
-                          cascadingDeleteCause,
-                        }
                       )
                   )
                 );
@@ -785,11 +714,7 @@ export class DeleteMutator<
                       .forDelete(inboundReferenceEntity, queryContext)
                       .deleteInTransactionAsync(
                         processedEntityIdentifiers,
-                        /* skipDatabaseDeletion */ false,
+                        /* skipDatabaseDeletion */ false
-                        {
-                          entity,
-                          cascadingDeleteCause,
-                        }
                       )
                   )
                 );

packages/entity/src/EntityMutatorFactory.ts

@@ -15,7 +15,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
  */
 export default class EntityMutatorFactory<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -109,7 +109,7 @@ export default class EntityMutatorFactory<
       this.entityLoaderFactory,
       this.databaseAdapter,
       this.metricsAdapter,
-      existingEntity
+      existingEntity.getAllDatabaseFields()
     );
   }
 

packages/entity/src/EntityPrivacyPolicy.ts

@@ -1,10 +1,7 @@
+import { EntityNotAuthorizedError } from './EntityErrors';
 import { EntityQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
-import EntityNotAuthorizedError from './errors/EntityNotAuthorizedError';
-import IEntityMetricsAdapter, {
-  EntityMetricsAuthorizationResult,
-} from './metrics/IEntityMetricsAdapter';
 import PrivacyPolicyRule, { RuleEvaluationResult } from './rules/PrivacyPolicyRule';
 
 export enum EntityPrivacyPolicyEvaluationMode {
@@ -15,7 +12,7 @@ export enum EntityPrivacyPolicyEvaluationMode {
 
 export type EntityPrivacyPolicyEvaluator<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
@@ -66,7 +63,7 @@ export enum EntityAuthorizationAction {
  */
 export default abstract class EntityPrivacyPolicy<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
@@ -127,16 +124,14 @@ export default abstract class EntityPrivacyPolicy<
   async authorizeCreateAsync(
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
-    entity: TEntity,
+    entity: TEntity
-    metricsAdapter: IEntityMetricsAdapter
   ): Promise<TEntity> {
     return await this.authorizeForRulesetAsync(
       this.createRules,
       viewerContext,
       queryContext,
       entity,
-      EntityAuthorizationAction.CREATE,
+      EntityAuthorizationAction.CREATE
-      metricsAdapter
     );
   }
 
@@ -151,16 +146,14 @@ export default abstract class EntityPrivacyPolicy<
   async authorizeReadAsync(
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
-    entity: TEntity,
+    entity: TEntity
-    metricsAdapter: IEntityMetricsAdapter
   ): Promise<TEntity> {
     return await this.authorizeForRulesetAsync(
       this.readRules,
       viewerContext,
       queryContext,
       entity,
-      EntityAuthorizationAction.READ,
+      EntityAuthorizationAction.READ
-      metricsAdapter
     );
   }
 
@@ -175,16 +168,14 @@ export default abstract class EntityPrivacyPolicy<
   async authorizeUpdateAsync(
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
-    entity: TEntity,
+    entity: TEntity
-    metricsAdapter: IEntityMetricsAdapter
   ): Promise<TEntity> {
     return await this.authorizeForRulesetAsync(
       this.updateRules,
       viewerContext,
       queryContext,
       entity,
-      EntityAuthorizationAction.UPDATE,
+      EntityAuthorizationAction.UPDATE
-      metricsAdapter
     );
   }
 
@@ -199,16 +190,14 @@ export default abstract class EntityPrivacyPolicy<
   async authorizeDeleteAsync(
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
-    entity: TEntity,
+    entity: TEntity
-    metricsAdapter: IEntityMetricsAdapter
   ): Promise<TEntity> {
     return await this.authorizeForRulesetAsync(
       this.deleteRules,
       viewerContext,
       queryContext,
       entity,
-      EntityAuthorizationAction.DELETE,
+      EntityAuthorizationAction.DELETE
-      metricsAdapter
     );
   }
 
@@ -217,95 +206,48 @@ export default abstract class EntityPrivacyPolicy<
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
     entity: TEntity,
-    action: EntityAuthorizationAction,
+    action: EntityAuthorizationAction
-    metricsAdapter: IEntityMetricsAdapter
   ): Promise<TEntity> {
     const privacyPolicyEvaluator = this.getPrivacyPolicyEvaluator(viewerContext);
     switch (privacyPolicyEvaluator.mode) {
       case EntityPrivacyPolicyEvaluationMode.ENFORCE:
-        try {
+        return await this.authorizeForRulesetInnerAsync(
-          const result = await this.authorizeForRulesetInnerAsync(
           ruleset,
           viewerContext,
           queryContext,
           entity,
           action
         );
-          metricsAdapter.logAuthorizationEvent({
-            entityClassName: entity.constructor.name,
-            action,
-            evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
-            privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
-          });
-          return result;
-        } catch (e) {
-          if (!(e instanceof EntityNotAuthorizedError)) {
-            throw e;
-          }
-          metricsAdapter.logAuthorizationEvent({
-            entityClassName: entity.constructor.name,
-            action,
-            evaluationResult: EntityMetricsAuthorizationResult.DENY,
-            privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
-          });
-          throw e;
-        }
       case EntityPrivacyPolicyEvaluationMode.ENFORCE_AND_LOG:
         try {
-          const result = await this.authorizeForRulesetInnerAsync(
+          return await this.authorizeForRulesetInnerAsync(
             ruleset,
             viewerContext,
             queryContext,
             entity,
             action
           );
-          metricsAdapter.logAuthorizationEvent({
-            entityClassName: entity.constructor.name,
-            action,
-            evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
-            privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
-          });
-          return result;
         } catch (e) {
           if (!(e instanceof EntityNotAuthorizedError)) {
             throw e;
           }
           privacyPolicyEvaluator.denyHandler(e);
-          metricsAdapter.logAuthorizationEvent({
-            entityClassName: entity.constructor.name,
-            action,
-            evaluationResult: EntityMetricsAuthorizationResult.DENY,
-            privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
-          });
           throw e;
         }
       case EntityPrivacyPolicyEvaluationMode.DRY_RUN:
         try {
-          const result = await this.authorizeForRulesetInnerAsync(
+          return await this.authorizeForRulesetInnerAsync(
             ruleset,
             viewerContext,
             queryContext,
             entity,
             action
           );
-          metricsAdapter.logAuthorizationEvent({
-            entityClassName: entity.constructor.name,
-            action,
-            evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
-            privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
-          });
-          return result;
         } catch (e) {
           if (!(e instanceof EntityNotAuthorizedError)) {
             throw e;
           }
           privacyPolicyEvaluator.denyHandler(e);
-          metricsAdapter.logAuthorizationEvent({
-            entityClassName: entity.constructor.name,
-            action,
-            evaluationResult: EntityMetricsAuthorizationResult.DENY,
-            privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
-          });
           return entity;
         }
     }
@@ -319,17 +261,11 @@ export default abstract class EntityPrivacyPolicy<
     action: EntityAuthorizationAction
   ): Promise<TEntity> {
     for (let i = 0; i < ruleset.length; i++) {
-      const rule = ruleset[i]!;
+      const rule = ruleset[i];
       const ruleEvaluationResult = await rule.evaluateAsync(viewerContext, queryContext, entity);
       switch (ruleEvaluationResult) {
         case RuleEvaluationResult.DENY:
-          throw new EntityNotAuthorizedError<
+          throw new EntityNotAuthorizedError(entity, viewerContext, action, i);
-            TFields,
-            TID,
-            TViewerContext,
-            TEntity,
-            TSelectedFields
-          >(entity, viewerContext, action, i);
         case RuleEvaluationResult.SKIP:
           continue;
         case RuleEvaluationResult.ALLOW:
@@ -339,11 +275,6 @@ export default abstract class EntityPrivacyPolicy<
       }
     }
 
-    throw new EntityNotAuthorizedError<TFields, TID, TViewerContext, TEntity, TSelectedFields>(
+    throw new EntityNotAuthorizedError(entity, viewerContext, action, -1);
-      entity,
-      viewerContext,
-      action,
-      -1
-    );
   }
 }

packages/entity/src/EntityQueryContext.ts

@@ -1,12 +1,8 @@
-import assert from 'assert';
+import { v4 as uuidv4 } from 'uuid';
 
 import EntityQueryContextProvider from './EntityQueryContextProvider';
 
 export type PostCommitCallback = (...args: any) => Promise<any>;
-export type PreCommitCallback = (
-  queryContext: EntityTransactionalQueryContext,
-  ...args: any
-) => Promise<any>;
 
 /**
  * Entity framework representation of transactional and non-transactional database
@@ -18,13 +14,13 @@ export type PreCommitCallback = (
 export abstract class EntityQueryContext {
   constructor(private readonly queryInterface: any) {}
 
-  abstract isInTransaction(): boolean;
+  abstract isInTransaction(): this is EntityTransactionalQueryContext;
 
   getQueryInterface(): any {
     return this.queryInterface;
   }
 
-  abstract runInTransactionIfNotInTransactionAsync<T>(
+  abstract async runInTransactionIfNotInTransactionAsync<T>(
     transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
   ): Promise<T>;
 }
@@ -37,7 +33,7 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
     super(queryInterface);
   }
 
-  isInTransaction(): boolean {
+  isInTransaction(): this is EntityTransactionalQueryContext {
     return false;
   }
 
@@ -49,67 +45,21 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
 }
 
 export class EntityTransactionalQueryContext extends EntityQueryContext {
-  private readonly postCommitInvalidationCallbacks: PostCommitCallback[] = [];
+  public readonly transactionID = uuidv4();
+
   private readonly postCommitCallbacks: PostCommitCallback[] = [];
 
-  private readonly preCommitCallbacks: { callback: PreCommitCallback; order: number }[] = [];
-
-  /**
-   * Schedule a pre-commit callback. These will be run within the transaction right before it is
-   * committed, and will be run in the order specified. Ordering of callbacks scheduled with the
-   * same value for the order parameter is undefined within that ordering group.
-   * @param callback - callback to schedule
-   * @param order - order in which this should be run relative to other scheduled pre-commit callbacks,
-   *                with higher numbers running later than lower numbers.
-   */
-  public appendPreCommitCallback(callback: PreCommitCallback, order: number): void {
-    assert(
-      order >= Number.MIN_SAFE_INTEGER && order <= Number.MAX_SAFE_INTEGER,
-      `Invalid order specified: ${order}`
-    );
-    this.preCommitCallbacks.push({ callback, order });
-  }
-
-  /**
-   * Schedule a post-commit cache invalidation callback. These are run before normal
-   * post-commit callbacks in order to have cache consistency in normal post-commit callbacks.
-   * @param callback - callback to schedule
-   */
-  public appendPostCommitInvalidationCallback(callback: PostCommitCallback): void {
-    this.postCommitInvalidationCallbacks.push(callback);
-  }
-
-  /**
-   * Schedule a post-commit callback. These will be run after the transaction has
-   * been committed.
-   * @param callback - callback to schedule
-   */
   public appendPostCommitCallback(callback: PostCommitCallback): void {
     this.postCommitCallbacks.push(callback);
   }
 
-  public async runPreCommitCallbacksAsync(): Promise<void> {
-    const callbacks = [...this.preCommitCallbacks]
-      .sort((a, b) => a.order - b.order)
-      .map((c) => c.callback);
-    this.preCommitCallbacks.length = 0;
-
-    for (const callback of callbacks) {
-      await callback(this);
-    }
-  }
-
   public async runPostCommitCallbacksAsync(): Promise<void> {
-    const invalidationCallbacks = [...this.postCommitInvalidationCallbacks];
-    this.postCommitInvalidationCallbacks.length = 0;
-    await Promise.all(invalidationCallbacks.map((callback) => callback()));
-
     const callbacks = [...this.postCommitCallbacks];
     this.postCommitCallbacks.length = 0;
     await Promise.all(callbacks.map((callback) => callback()));
   }
 
-  isInTransaction(): boolean {
+  isInTransaction(): this is EntityTransactionalQueryContext {
     return true;
   }
 

packages/entity/src/EntityQueryContextProvider.ts

@@ -38,7 +38,6 @@ export default abstract class EntityQueryContextProvider {
     >()(async (queryInterface) => {
       const queryContext = new EntityTransactionalQueryContext(queryInterface);
       const result = await transactionScope(queryContext);
-      await queryContext.runPreCommitCallbacksAsync();
       return [result, queryContext];
     });
     await queryContext.runPostCommitCallbacksAsync();

packages/entity/src/EntitySecondaryCacheLoader.ts

@@ -1,112 +0,0 @@
-import { Result } from '@expo/results';
-
-import EntityLoader from './EntityLoader';
-import EntityPrivacyPolicy from './EntityPrivacyPolicy';
-import ReadonlyEntity from './ReadonlyEntity';
-import ViewerContext from './ViewerContext';
-import { mapMap } from './utils/collections/maps';
-
-/**
- * An interface that knows how to load many objects from a cache by load params and invalidate
- * those same load params.
- */
-export interface ISecondaryEntityCache<TFields, TLoadParams> {
-  /**
-   * Read-through cache function.
-   * @param loadParamsArray - array of loadParams to load from the cache
-   * @param fetcher - closure used to provide underlying data source objects for loadParams
-   * @returns map from loadParams to the entity field object
-   */
-  loadManyThroughAsync(
-    loadParamsArray: readonly Readonly<TLoadParams>[],
-    fetcher: (
-      fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
-    ) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
-  ): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>;
-
-  /**
-   * Invalidate the cache for objects cached by loadParams.
-   *
-   * @param loadParamsArray - array of load params objects to invalidate
-   */
-  invalidateManyAsync(loadParamsArray: readonly Readonly<TLoadParams>[]): Promise<void>;
-}
-
-/**
- * A secondary cache loader allows for arbitrary cache keying for load params, which are a set of params used to load
- * a single entity field object.
- *
- * Note that this cache cannot be automatically invalidated like other entity caches so it must be manually invalidated
- * when the underlying data of a cache key could be stale.
- *
- * This is most commonly used to further optimize hot paths that cannot make use of normal entity cache loading
- * due to use of a non-unique-field-based {@link EntityLoader} method like `loadManyByFieldEqualityConjunctionAsync` or
- * `loadManyByRawWhereClauseAsync`.
- */
-export default abstract class EntitySecondaryCacheLoader<
-  TLoadParams,
-  TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
-  TViewerContext extends ViewerContext,
-  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
-  TPrivacyPolicy extends EntityPrivacyPolicy<
-    TFields,
-    TID,
-    TViewerContext,
-    TEntity,
-    TSelectedFields
-  >,
-  TSelectedFields extends keyof TFields = keyof TFields
-> {
-  constructor(
-    private readonly secondaryEntityCache: ISecondaryEntityCache<TFields, TLoadParams>,
-    protected readonly entityLoader: EntityLoader<
-      TFields,
-      TID,
-      TViewerContext,
-      TEntity,
-      TPrivacyPolicy,
-      TSelectedFields
-    >
-  ) {}
-
-  /**
-   * Load many by load params objects
-   *
-   * @param loadParamsArray - array of loadParams to load through the cache
-   */
-  public async loadManyAsync(
-    loadParamsArray: readonly Readonly<TLoadParams>[]
-  ): Promise<ReadonlyMap<Readonly<TLoadParams>, Result<TEntity> | null>> {
-    const loadParamsToFieldObjects = await this.secondaryEntityCache.loadManyThroughAsync(
-      loadParamsArray,
-      this.fetchObjectsFromDatabaseAsync.bind(this)
-    );
-
-    // convert value to and from array to reuse complex code
-    const entitiesMap = await this.entityLoader.constructAndAuthorizeEntitiesAsync(
-      mapMap(loadParamsToFieldObjects, (fieldObject) => (fieldObject ? [fieldObject] : []))
-    );
-    return mapMap(entitiesMap, (fieldObjects) => fieldObjects[0] ?? null);
-  }
-
-  /**
-   * Invalidate the cache for objects cached by loadParams.
-   *
-   * @param loadParamsArray - array of load params objects to invalidate
-   */
-  public async invalidateManyAsync(
-    loadParamsArray: readonly Readonly<TLoadParams>[]
-  ): Promise<void> {
-    await this.secondaryEntityCache.invalidateManyAsync(loadParamsArray);
-  }
-
-  /**
-   * Load through method called to fetch objects when load params objects are not in the cache
-   *
-   * @param loadParamsArray - array of load params objects to load
-   */
-  protected abstract fetchObjectsFromDatabaseAsync(
-    loadParamsArray: readonly Readonly<TLoadParams>[]
-  ): Promise<ReadonlyMap<Readonly<Readonly<TLoadParams>>, Readonly<TFields> | null>>;
-}

packages/entity/src/ReadonlyEntity.ts

@@ -5,7 +5,7 @@ import EntityAssociationLoader from './EntityAssociationLoader';
 import { EntityCompanionDefinition } from './EntityCompanionProvider';
 import EntityLoader from './EntityLoader';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
-import { EntityQueryContext } from './EntityQueryContext';
+import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
 import ViewerContext from './ViewerContext';
 import { pick } from './entityUtils';
 
@@ -19,7 +19,7 @@ import { pick } from './entityUtils';
  */
 export default abstract class ReadonlyEntity<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
@@ -37,9 +37,8 @@ export default abstract class ReadonlyEntity<
     private readonly viewerContext: TViewerContext,
     private readonly databaseFields: Readonly<TFields>
   ) {
-    const companionDefinition = (
+    const companionDefinition = (this
-      this.constructor as any
+      .constructor as any).getCompanionDefinition() as EntityCompanionDefinition<
-    ).getCompanionDefinition() as EntityCompanionDefinition<
       TFields,
       TID,
       TViewerContext,
@@ -119,6 +118,80 @@ export default abstract class ReadonlyEntity<
     return { ...this.databaseFields };
   }
 
+  /**
+   * Get the regular (non-transactional) query context for this entity.
+   * @param viewerContext - viewer context of calling user
+   */
+  static getQueryContext<
+    TMFields,
+    TMID,
+    TMViewerContext extends ViewerContext,
+    TMViewerContext2 extends TMViewerContext,
+    TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
+    TMPrivacyPolicy extends EntityPrivacyPolicy<
+      TMFields,
+      TMID,
+      TMViewerContext,
+      TMEntity,
+      TMSelectedFields
+    >,
+    TMSelectedFields extends keyof TMFields = keyof TMFields
+  >(
+    this: IEntityClass<
+      TMFields,
+      TMID,
+      TMViewerContext,
+      TMEntity,
+      TMPrivacyPolicy,
+      TMSelectedFields
+    >,
+    viewerContext: TMViewerContext2
+  ): EntityQueryContext {
+    return viewerContext
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext();
+  }
+
+  /**
+   * Start a transaction and execute the provided transaction-scoped closure within the transaction.
+   * @param viewerContext - viewer context of calling user
+   * @param transactionScope - async callback to execute within the transaction
+   */
+  static async runInTransactionAsync<
+    TResult,
+    TMFields,
+    TMID,
+    TMViewerContext extends ViewerContext,
+    TMViewerContext2 extends TMViewerContext,
+    TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
+    TMPrivacyPolicy extends EntityPrivacyPolicy<
+      TMFields,
+      TMID,
+      TMViewerContext,
+      TMEntity,
+      TMSelectedFields
+    >,
+    TMSelectedFields extends keyof TMFields = keyof TMFields
+  >(
+    this: IEntityClass<
+      TMFields,
+      TMID,
+      TMViewerContext,
+      TMEntity,
+      TMPrivacyPolicy,
+      TMSelectedFields
+    >,
+    viewerContext: TMViewerContext2,
+    transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
+  ): Promise<TResult> {
+    return await viewerContext
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext()
+      .runInTransactionIfNotInTransactionAsync(transactionScope);
+  }
+
   /**
    * Vend loader for loading an entity in a given query context.
    * @param viewerContext - viewer context of loading user
@@ -126,7 +199,7 @@ export default abstract class ReadonlyEntity<
    */
   static loader<
     TMFields,
-    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMID,
     TMViewerContext extends ViewerContext,
     TMViewerContext2 extends TMViewerContext,
     TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,

packages/entity/src/ViewerContext.ts

@@ -1,7 +1,6 @@
 import { IEntityClass } from './Entity';
-import EntityCompanionProvider, { DatabaseAdapterFlavor } from './EntityCompanionProvider';
+import EntityCompanionProvider from './EntityCompanionProvider';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
-import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerScopedEntityCompanion from './ViewerScopedEntityCompanion';
 import ViewerScopedEntityCompanionProvider from './ViewerScopedEntityCompanionProvider';
@@ -28,7 +27,7 @@ export default class ViewerContext {
 
   getViewerScopedEntityCompanionForClass<
     TMFields,
-    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMID,
     TMViewerContext extends ViewerContext,
     TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -61,32 +60,4 @@ export default class ViewerContext {
       entityClass.getCompanionDefinition()
     );
   }
-
-  /**
-   * Get the regular (non-transactional) query context for a database adaptor flavor.
-   * @param databaseAdaptorFlavor - database adaptor flavor
-   */
-  getQueryContextForDatabaseAdaptorFlavor(
-    databaseAdaptorFlavor: DatabaseAdapterFlavor
-  ): EntityQueryContext {
-    return this.entityCompanionProvider
-      .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
-      .getQueryContext();
-  }
-
-  /**
-   * Run a transaction of specified database adaptor flavor and execute the provided
-   * transaction-scoped closure within the transaction.
-   * @param databaseAdaptorFlavor - databaseAdaptorFlavor
-   * @param transactionScope - async callback to execute within the transaction
-   */
-  async runInTransactionForDatabaseAdaptorFlavorAsync<TResult>(
-    databaseAdaptorFlavor: DatabaseAdapterFlavor,
-    transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
-  ): Promise<TResult> {
-    return await this.entityCompanionProvider
-      .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
-      .getQueryContext()
-      .runInTransactionIfNotInTransactionAsync(transactionScope);
-  }
 }

packages/entity/src/ViewerScopedEntityCompanion.ts

@@ -5,7 +5,6 @@ import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
 import ViewerScopedEntityLoaderFactory from './ViewerScopedEntityLoaderFactory';
 import ViewerScopedEntityMutatorFactory from './ViewerScopedEntityMutatorFactory';
-import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
 
 /**
  * Provides a simpler API for loading and mutating entities by injecting the {@link ViewerContext}
@@ -13,7 +12,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
  */
 export default class ViewerScopedEntityCompanion<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -77,11 +76,4 @@ export default class ViewerScopedEntityCompanion<
   getQueryContextProvider(): EntityQueryContextProvider {
     return this.entityCompanion.getQueryContextProvider();
   }
-
-  /**
-   * Get the {@link IEntityMetricsAdapter} for this companion.
-   */
-  getMetricsAdapter(): IEntityMetricsAdapter {
-    return this.entityCompanion.getMetricsAdapter();
-  }
 }

packages/entity/src/ViewerScopedEntityCompanionProvider.ts

@@ -23,7 +23,7 @@ export default class ViewerScopedEntityCompanionProvider {
    */
   getViewerScopedCompanionForEntity<
     TFields,
-    TID extends NonNullable<TFields[TSelectedFields]>,
+    TID,
     TViewerContext extends ViewerContext,
     TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
     TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/ViewerScopedEntityLoaderFactory.ts

@@ -10,7 +10,7 @@ import ViewerContext from './ViewerContext';
  */
 export default class ViewerScopedEntityLoaderFactory<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/ViewerScopedEntityMutatorFactory.ts

@@ -10,7 +10,7 @@ import ViewerContext from './ViewerContext';
  */
 export default class ViewerScopedEntityMutatorFactory<
   TFields,
-  TID extends NonNullable<TFields[TSelectedFields]>,
+  TID,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/__tests__/EnforcingEntityLoader-test.ts

@@ -287,9 +287,8 @@ describe(EnforcingEntityLoader, () => {
       'enforcing',
       'invalidateFieldsAsync',
       'invalidateEntityAsync',
+      'invalidateFieldsTransactionalAsync',
       'tryConstructEntities',
-      'validateFieldValues',
-      'constructAndAuthorizeEntitiesAsync',
     ];
     expect(loaderProperties).toEqual(expect.arrayContaining(knownLoaderOnlyDifferences));