Compare commits

..
Author SHA1 Message Date
Will Schurman f4b30cb704 v0.7.0 (#80) 2020-09-30 19:55:22 -07:00
Will Schurman 22aa907b11 docs: fix typedoc (#79) 2020-08-25 14:05:28 -07:00
Will Schurman 9891e74694 fix: upgrade packages (#78) 2020-08-25 13:38:00 -07:00
Will Schurman dbc3c81b35 fix: move cache invalidation to after transaction commit (#77) 2020-08-25 11:16:16 -07:00
Will Schurman 62bfd6c703 fix!: constuctor thrown exceptions for loadMany (#74) 2020-07-29 10:35:28 -07:00
Will Schurman 7e829f30fd fix: fix index export for EntityMutationTrigger and EntityMutationValidator (#73) 2020-07-28 15:09:45 -07:00
Will Schurman cd2df8da4b fix: fix incorrect loader types for field selecitons (#72) 2020-07-28 15:01:33 -07:00
Will Schurman b580a218c0 v0.6.0 (#69) 2020-07-23 14:48:27 -07:00
Will Schurman 547a1efcec fix: separate out EntityMutationValidator (#68) 2020-07-23 14:22:02 -07:00
Quinlan Jung fc4377d883 feat: entity mutation validators (#67)
* entity mutation validators

* pr feedback

* tests
2020-07-23 11:03:20 -07:00
Will Schurman 5744c51e6b fix: ensure transitive deletion triggers are run for CASCADE_DELETE_INVALIDATE_CACHE (#66) 2020-07-22 19:26:32 -07:00
Will Schurman fd6060cc84 feat: mutation triggers (#65) 2020-07-22 16:57:46 -07:00
Will Schurman a757867360 fix!: remove lodash dependency for vuln, require node 12 (#64) 2020-07-22 10:48:12 -07:00
Will Schurman 1224de79d5 feat!: add support for reference deletion and enclose mutations in transactions (#63) 2020-07-22 09:47:37 -07:00
Will Schurman 7a77afc83e fix: update setField to correct typing (#62) 2020-07-10 17:00:13 -07:00
Will Schurman 9c92d10b80 v0.5.2 (#60) 2020-07-01 22:04:27 -07:00
Will Schurman 7c180e84d9 fix: fix stub cache key generation for global cache (#59) 2020-07-01 22:00:55 -07:00
Will Schurman 1aa44e168e v0.5.1 (#58) 2020-07-01 16:32:35 -07:00
Will Schurman e91cfba993 fix: correct some typing issues and exports (#57) 2020-07-01 16:27:33 -07:00
Will Schurman 252d945917 Cut v0.5.0 (#56) 2020-07-01 11:43:46 -07:00
Will Schurman 4e40b2e521 feat: support entity fields subset of db fields (#49) 2020-07-01 11:23:55 -07:00
Will Schurman ccbdbc472a ci: fix checkout action to checkout branch at current state instead of merging into base branch (#55) 2020-07-01 10:45:01 -07:00
Will Schurman 89cfb3d5a0 feat: add two fan out methods to association loader (#52) 2020-06-30 09:26:05 -07:00
111 changed files with 7776 additions and 2462 deletions

No files matched your search

+2 -1
View File
@@ -9,7 +9,8 @@
],
"rules": {
"no-restricted-imports": ["error",{ "paths": [".", "..", "../.."] }],
"tsdoc/syntax": "warn"
"tsdoc/syntax": "warn",
"no-console": "warn"
},
"overrides": [
{
+1 -1
View File
@@ -12,7 +12,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 10.x
node-version: 12.x
- name: Cache Node.js modules
uses: actions/cache@v1
with:
+3 -1
View File
@@ -10,9 +10,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: ${{ github.event.pull_request.head.sha }}
- uses: actions/setup-node@v1
with:
node-version: 10.x
node-version: 12.x
- name: Cache Node.js modules
uses: actions/cache@v1
with:
+78 -4
View File
@@ -1,6 +1,80 @@
# Changelog
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [0.7.0](https://github.com/expo/entity/compare/v0.6.0...v0.7.0) (2020-10-01)
### Bug Fixes
* fix incorrect loader types for field selecitons ([#72](https://github.com/expo/entity/issues/72)) ([cd2df8d](https://github.com/expo/entity/commit/cd2df8da4b81bcd4769e950d3124c18886df2816))
* fix index export for EntityMutationTrigger and EntityMutationValidator ([#73](https://github.com/expo/entity/issues/73)) ([7e829f3](https://github.com/expo/entity/commit/7e829f30fde0bd343cb8a584ccda5530cf61ec33))
* move cache invalidation to after transaction commit ([#77](https://github.com/expo/entity/issues/77)) ([dbc3c81](https://github.com/expo/entity/commit/dbc3c81b359a668b5134189ce6de49b5893bb5e7))
* upgrade packages ([#78](https://github.com/expo/entity/issues/78)) ([9891e74](https://github.com/expo/entity/commit/9891e7469467a28589f529c8d87b10fc2232d3ff))
# [0.6.0](https://github.com/expo/entity/compare/v0.5.2...v0.6.0) (2020-07-23)
### Bug Fixes
* ensure transitive deletion triggers are run for CASCADE_DELETE_INVALIDATE_CACHE ([#66](https://github.com/expo/entity/issues/66)) ([5744c51](https://github.com/expo/entity/commit/5744c51e6b3178bd9f229f3f465b683bb4474c8a))
* separate out EntityMutationValidator ([#68](https://github.com/expo/entity/issues/68)) ([547a1ef](https://github.com/expo/entity/commit/547a1efcecd17cc085702d1a3e9888ce5b644b13))
* update setField to correct typing ([#62](https://github.com/expo/entity/issues/62)) ([7a77afc](https://github.com/expo/entity/commit/7a77afc83ea732c9b062a5d6865eff9d3131d015))
### Features
* entity mutation validators ([#67](https://github.com/expo/entity/issues/67)) ([fc4377d](https://github.com/expo/entity/commit/fc4377d8839da07417b88afc138f73556383d896))
* mutation triggers ([#65](https://github.com/expo/entity/issues/65)) ([fd6060c](https://github.com/expo/entity/commit/fd6060cc844f60635b3ce4c400c4877f2df8fa44))
## [0.5.2](https://github.com/expo/entity/compare/v0.5.1...v0.5.2) (2020-07-02)
### Bug Fixes
* fix stub cache key generation for global cache ([#59](https://github.com/expo/entity/issues/59)) ([7c180e8](https://github.com/expo/entity/commit/7c180e84d9a8cdfd9380fac0eab2d02a96ec18f3))
## [0.5.1](https://github.com/expo/entity/compare/v0.5.0...v0.5.1) (2020-07-01)
### Bug Fixes
* correct some typing issues and exports ([#57](https://github.com/expo/entity/issues/57)) ([e91cfba](https://github.com/expo/entity/commit/e91cfba99321c2c4da2078aafd8627cbf0ceca50))
# 0.5.0 (2020-07-01)
### Bug Fixes
* support number ID field generation in StubDatabaseAdapter ([#43](https://github.com/expo/entity/issues/43)) ([60cc0fb](https://github.com/expo/entity/commit/60cc0fbda460c3ada1f5244a2780f90382fe3ebd))
* upgrade Apollo server for security advisory ([#38](https://github.com/expo/entity/issues/38)) ([d25c1e1](https://github.com/expo/entity/commit/d25c1e142d52385725593f4f155d1795697ab490))
### Features
* add two fan out methods to association loader ([#52](https://github.com/expo/entity/issues/52)) ([89cfb3d](https://github.com/expo/entity/commit/89cfb3d5a01d4da90f64acc52ae1b839ba348a35))
* support entity fields subset of db fields ([#49](https://github.com/expo/entity/issues/49)) ([4e40b2e](https://github.com/expo/entity/commit/4e40b2e521407e521d236978ec3b3b56db3990be))
# 0.4.0 (2020-06-03)
## v0.4.0 (2020-06-03)
* All Packages
* Documentation Improvements
@@ -16,11 +90,11 @@
* `@expo/entity-example`
* Initial Version
## v0.3.0 (2020-04-28)
# 0.3.0 (2020-04-28)
* `@expo/entity`
* Initial Version
* `@expo/entity-cache-adapter-redis`
* Initial Version
* `@expo/entity-database-adapter-knex`
* Initial Version
* Initial Version
+1 -1
View File
@@ -4,5 +4,5 @@
],
"npmClient": "yarn",
"useWorkspaces": true,
"version": "0.4.0"
"version": "0.7.0"
}
+19 -20
View File
@@ -14,29 +14,28 @@
},
"devDependencies": {
"@expo/entity": "file:packages/entity",
"@expo/results": "^0.3.0",
"@types/invariant": "^2.2.32",
"@types/ioredis": "^4.14.9",
"@types/jest": "^25.2.1",
"@types/lodash": "^4.14.150",
"@types/node": "^13.13.4",
"@types/uuid": "^7.0.3",
"@typescript-eslint/eslint-plugin": "^2.30.0",
"@typescript-eslint/parser": "^2.30.0",
"@expo/results": "^1.0.0",
"@types/invariant": "^2.2.33",
"@types/ioredis": "^4.17.3",
"@types/jest": "^26.0.10",
"@types/node": "^14.6.0",
"@types/uuid": "^8.3.0",
"@typescript-eslint/eslint-plugin": "^3.10.1",
"@typescript-eslint/parser": "^3.10.1",
"barrelsby": "^2.2.0",
"eslint": "^6.8.0",
"eslint-config-universe": "^3.0.0",
"eslint-plugin-tsdoc": "^0.2.4",
"jest": "^24.9.0",
"lerna": "^3.20.2",
"pg": "^8.0.3",
"prettier": "^2.0.5",
"ts-jest": "~24.2.0",
"ts-mockito": "^2.5.0",
"eslint": "^7.7.0",
"eslint-config-universe": "^4.0.0",
"eslint-plugin-tsdoc": "^0.2.6",
"jest": "^26.4.2",
"lerna": "^3.22.1",
"pg": "^8.3.2",
"prettier": "^2.1.0",
"ts-jest": "~26.2.0",
"ts-mockito": "^2.6.1",
"typedoc": "^0.17.6",
"typedoc-plugin-lerna-packages": "^0.3.0",
"typescript": "^3.9.2",
"uuid": "^7.0.3"
"typescript": "^4.0.2",
"uuid": "^8.3.0"
},
"dependencies": {
"@expo/entity": "file:packages/entity",
@@ -0,0 +1,46 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [0.7.0](https://github.com/expo/entity/compare/v0.6.0...v0.7.0) (2020-10-01)
### Bug Fixes
* upgrade packages ([#78](https://github.com/expo/entity/issues/78)) ([9891e74](https://github.com/expo/entity/commit/9891e7469467a28589f529c8d87b10fc2232d3ff))
# [0.6.0](https://github.com/expo/entity/compare/v0.5.2...v0.6.0) (2020-07-23)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
## [0.5.2](https://github.com/expo/entity/compare/v0.5.1...v0.5.2) (2020-07-02)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
## [0.5.1](https://github.com/expo/entity/compare/v0.5.0...v0.5.1) (2020-07-01)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
# 0.5.0 (2020-07-01)
### Features
* support entity fields subset of db fields ([#49](https://github.com/expo/entity/issues/49)) ([4e40b2e](https://github.com/expo/entity/commit/4e40b2e521407e521d236978ec3b3b56db3990be))
@@ -1,6 +1,6 @@
{
"name": "@expo/entity-cache-adapter-redis",
"version": "0.4.0",
"version": "0.7.0",
"description": "Redis cache adapter for @expo/entity",
"files": [
"build",
@@ -12,13 +12,13 @@
"tsc": "tsc",
"clean": "rm -rf build coverage coverage-integration",
"lint": "eslint src --ext '.ts'",
"test": "jest --rootDir --config ../../resources/jest.config.js",
"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",
"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": ">=8"
"node": ">=12"
},
"keywords": [
"entity"
@@ -29,9 +29,9 @@
"@expo/entity": "*"
},
"dependencies": {
"ioredis": "^4.16.1"
"ioredis": "^4.17.3"
},
"devDependencies": {
"@expo/entity": "^0.4.0"
"@expo/entity": "^0.7.0"
}
}
@@ -44,13 +44,17 @@ describe(RedisCacheAdapter, () => {
const cacheAdapter = vc1.entityCompanionProvider.getCompanionForEntity(
RedisTestEntity,
RedisTestEntity.getCompanionDefinition()
)['cacheAdapter'];
)['tableDataCoordinator']['cacheAdapter'];
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
// creating an entity should put it in cache (loader loads it after creation)
const entity1 = await enforceAsyncResult(
RedisTestEntity.creator(vc1).setField('name', 'blah').createAsync()
);
const entity1Created = await RedisTestEntity.creator(vc1)
.setField('name', 'blah')
.enforceCreateAsync();
// loading an entity should put it in cache
const entity1 = await RedisTestEntity.loader(vc1)
.enforcing()
.loadByIDAsync(entity1Created.getID());
const cachedJSON = await redisCacheAdapterContext.redisClient.get(
cacheKeyMaker('id', entity1.getID())
@@ -1,4 +1,10 @@
import { CacheStatus, UUIDField, EntityConfiguration } 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';
@@ -14,6 +20,8 @@ const entityConfiguration = new EntityConfiguration<BlahFields>({
schema: {
id: new UUIDField({ columnName: 'id', cache: true }),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
describe(RedisCacheAdapter, () => {
@@ -85,12 +85,12 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
columnName: 'date_field',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const redisTestEntityCompanionDefinition = {
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: RedisTestEntity,
entityConfiguration: redisTestEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
};
});
@@ -0,0 +1,60 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [0.7.0](https://github.com/expo/entity/compare/v0.6.0...v0.7.0) (2020-10-01)
### Bug Fixes
* fix index export for EntityMutationTrigger and EntityMutationValidator ([#73](https://github.com/expo/entity/issues/73)) ([7e829f3](https://github.com/expo/entity/commit/7e829f30fde0bd343cb8a584ccda5530cf61ec33))
* move cache invalidation to after transaction commit ([#77](https://github.com/expo/entity/issues/77)) ([dbc3c81](https://github.com/expo/entity/commit/dbc3c81b359a668b5134189ce6de49b5893bb5e7))
* upgrade packages ([#78](https://github.com/expo/entity/issues/78)) ([9891e74](https://github.com/expo/entity/commit/9891e7469467a28589f529c8d87b10fc2232d3ff))
# [0.6.0](https://github.com/expo/entity/compare/v0.5.2...v0.6.0) (2020-07-23)
### Bug Fixes
* separate out EntityMutationValidator ([#68](https://github.com/expo/entity/issues/68)) ([547a1ef](https://github.com/expo/entity/commit/547a1efcecd17cc085702d1a3e9888ce5b644b13))
### Features
* entity mutation validators ([#67](https://github.com/expo/entity/issues/67)) ([fc4377d](https://github.com/expo/entity/commit/fc4377d8839da07417b88afc138f73556383d896))
* mutation triggers ([#65](https://github.com/expo/entity/issues/65)) ([fd6060c](https://github.com/expo/entity/commit/fd6060cc844f60635b3ce4c400c4877f2df8fa44))
## [0.5.2](https://github.com/expo/entity/compare/v0.5.1...v0.5.2) (2020-07-02)
**Note:** Version bump only for package @expo/entity-database-adapter-knex
## [0.5.1](https://github.com/expo/entity/compare/v0.5.0...v0.5.1) (2020-07-01)
### Bug Fixes
* correct some typing issues and exports ([#57](https://github.com/expo/entity/issues/57)) ([e91cfba](https://github.com/expo/entity/commit/e91cfba99321c2c4da2078aafd8627cbf0ceca50))
# 0.5.0 (2020-07-01)
### Features
* support entity fields subset of db fields ([#49](https://github.com/expo/entity/issues/49)) ([4e40b2e](https://github.com/expo/entity/commit/4e40b2e521407e521d236978ec3b3b56db3990be))
@@ -1,6 +1,6 @@
{
"name": "@expo/entity-database-adapter-knex",
"version": "0.4.0",
"version": "0.7.0",
"description": "Knex database adapter for @expo/entity",
"files": [
"build",
@@ -12,13 +12,13 @@
"tsc": "tsc",
"clean": "rm -rf build coverage coverage-integration",
"lint": "eslint src --ext '.ts'",
"test": "jest --rootDir --config ../../resources/jest.config.js --passWithNoTests",
"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",
"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": ">=8"
"node": ">=12"
},
"keywords": [
"entity"
@@ -29,9 +29,9 @@
"@expo/entity": "*"
},
"dependencies": {
"knex": "^0.20.11"
"knex": "^0.21.5"
},
"devDependencies": {
"@expo/entity": "^0.4.0"
"@expo/entity": "^0.7.0"
}
}
@@ -1,25 +1,21 @@
import {
IEntityQueryContextProvider,
EntityNonTransactionalQueryContext,
EntityTransactionalQueryContext,
} from '@expo/entity';
import { EntityQueryContextProvider } from '@expo/entity';
import Knex from 'knex';
/**
* Query context provider for knex (postgres).
*/
export default class PostgresEntityQueryContextProvider implements IEntityQueryContextProvider {
constructor(private readonly knexInstance: Knex) {}
getRegularEntityQueryContext(): EntityNonTransactionalQueryContext {
return new EntityNonTransactionalQueryContext(this.knexInstance);
export default class PostgresEntityQueryContextProvider extends EntityQueryContextProvider {
constructor(private readonly knexInstance: Knex) {
super();
}
async runInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T> {
return await this.knexInstance.transaction(async (trx) => {
return await transactionScope(new EntityTransactionalQueryContext(trx));
});
protected getQueryInterface(): any {
return this.knexInstance;
}
protected createTransactionRunner<T>(): (
transactionScope: (trx: any) => Promise<T>
) => Promise<T> {
return (transactionScope) => this.knexInstance.transaction(transactionScope);
}
}
@@ -8,6 +8,8 @@ import { enforceAsyncResult } from '@expo/results';
import Knex from 'knex';
import PostgresTestEntity from '../testfixtures/PostgresTestEntity';
import PostgresTriggerTestEntity from '../testfixtures/PostgresTriggerTestEntity';
import PostgresValidatorTestEntity from '../testfixtures/PostgresValidatorTestEntity';
import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
describe('postgres entity integration', () => {
@@ -32,7 +34,7 @@ describe('postgres entity integration', () => {
afterAll(async () => {
await PostgresTestEntity.dropPostgresTable(knexInstance);
knexInstance.destroy();
await knexInstance.destroy();
});
it('supports parallel partial updates', async () => {
@@ -325,4 +327,223 @@ describe('postgres entity integration', () => {
expect(resultsMultipleOrderBy.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
});
});
describe('trigger transaction behavior', () => {
describe('create', () => {
it('rolls back transaction when trigger throws except afterCommit', async () => {
const vc1 = new ViewerContext(
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
);
await expect(
PostgresTriggerTestEntity.creator(vc1)
.setField('name', 'beforeCreate')
.enforceCreateAsync()
).rejects.toThrowError('name cannot have value beforeCreate');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeCreate')
).resolves.toBeNull();
await expect(
PostgresTriggerTestEntity.creator(vc1)
.setField('name', 'afterCreate')
.enforceCreateAsync()
).rejects.toThrowError('name cannot have value afterCreate');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'afterCreate')
).resolves.toBeNull();
await expect(
PostgresTriggerTestEntity.creator(vc1).setField('name', 'beforeAll').enforceCreateAsync()
).rejects.toThrowError('name cannot have value beforeAll');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeAll')
).resolves.toBeNull();
await expect(
PostgresTriggerTestEntity.creator(vc1).setField('name', 'afterAll').enforceCreateAsync()
).rejects.toThrowError('name cannot have value afterAll');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'afterAll')
).resolves.toBeNull();
await expect(
PostgresTriggerTestEntity.creator(vc1)
.setField('name', 'afterCommit')
.enforceCreateAsync()
).rejects.toThrowError('name cannot have value afterCommit');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'afterCommit')
).resolves.not.toBeNull();
});
});
describe('update', () => {
it('rolls back transaction when trigger throws except afterCommit', async () => {
const vc1 = new ViewerContext(
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
);
const entity = await PostgresTriggerTestEntity.creator(vc1)
.setField('name', 'blah')
.enforceCreateAsync();
await expect(
PostgresTriggerTestEntity.updater(entity)
.setField('name', 'beforeUpdate')
.enforceUpdateAsync()
).rejects.toThrowError('name cannot have value beforeUpdate');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeUpdate')
).resolves.toBeNull();
await expect(
PostgresTriggerTestEntity.updater(entity)
.setField('name', 'afterUpdate')
.enforceUpdateAsync()
).rejects.toThrowError('name cannot have value afterUpdate');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'afterUpdate')
).resolves.toBeNull();
await expect(
PostgresTriggerTestEntity.updater(entity)
.setField('name', 'beforeAll')
.enforceUpdateAsync()
).rejects.toThrowError('name cannot have value beforeAll');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeAll')
).resolves.toBeNull();
await expect(
PostgresTriggerTestEntity.updater(entity)
.setField('name', 'afterAll')
.enforceUpdateAsync()
).rejects.toThrowError('name cannot have value afterAll');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'afterAll')
).resolves.toBeNull();
await expect(
PostgresTriggerTestEntity.updater(entity)
.setField('name', 'afterCommit')
.enforceUpdateAsync()
).rejects.toThrowError('name cannot have value afterCommit');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'afterCommit')
).resolves.not.toBeNull();
});
});
describe('delete', () => {
it('rolls back transaction when trigger throws except afterCommit', async () => {
const vc1 = new ViewerContext(
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
);
const entityBeforeDelete = await PostgresTriggerTestEntity.creator(vc1)
.setField('name', 'beforeDelete')
.enforceCreateAsync();
await expect(
PostgresTriggerTestEntity.enforceDeleteAsync(entityBeforeDelete)
).rejects.toThrowError('name cannot have value beforeDelete');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeDelete')
).resolves.not.toBeNull();
const entityAfterDelete = await PostgresTriggerTestEntity.creator(vc1)
.setField('name', 'afterDelete')
.enforceCreateAsync();
await expect(
PostgresTriggerTestEntity.enforceDeleteAsync(entityAfterDelete)
).rejects.toThrowError('name cannot have value afterDelete');
await expect(
PostgresTriggerTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'afterDelete')
).resolves.not.toBeNull();
});
});
describe('validation transaction behavior', () => {
describe('create', () => {
it('rolls back transaction when trigger throws ', async () => {
const vc1 = new ViewerContext(
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
);
await expect(
PostgresValidatorTestEntity.creator(vc1)
.setField('name', 'beforeCreateAndBeforeUpdate')
.enforceCreateAsync()
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
await expect(
PostgresValidatorTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate')
).resolves.toBeNull();
});
});
describe('update', () => {
it('rolls back transaction when trigger throws ', async () => {
const vc1 = new ViewerContext(
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
);
const entity = await PostgresValidatorTestEntity.creator(vc1)
.setField('name', 'blah')
.enforceCreateAsync();
await expect(
PostgresValidatorTestEntity.updater(entity)
.setField('name', 'beforeCreateAndBeforeUpdate')
.enforceUpdateAsync()
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
await expect(
PostgresValidatorTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate')
).resolves.toBeNull();
});
});
describe('delete', () => {
it('validation should not run on a delete mutation', async () => {
const vc1 = new ViewerContext(
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
);
const entityToDelete = await PostgresValidatorTestEntity.creator(vc1)
.setField('name', 'shouldBeDeleted')
.enforceCreateAsync();
await PostgresValidatorTestEntity.enforceDeleteAsync(entityToDelete);
await expect(
PostgresValidatorTestEntity.loader(vc1)
.enforcing()
.loadByFieldEqualingAsync('name', 'shouldBeDeleted')
).resolves.toBeNull();
});
});
});
});
});
@@ -27,7 +27,7 @@ describe('postgres entity integration', () => {
afterAll(async () => {
await InvalidTestEntity.dropPostgresTable(knexInstance);
knexInstance.destroy();
await knexInstance.destroy();
});
describe('invalid operation result counts', () => {
@@ -43,9 +43,6 @@ describe('postgres entity integration', () => {
await expect(InvalidTestEntity.deleteAsync(entity1)).rejects.toThrowError(
'Excessive deletions from database adapter delete'
);
await expect(InvalidTestEntity.deleteAsync(entity1)).rejects.toThrowError(
'No deletions from database adapter delete'
);
});
it('throws after update of multiple rows', async () => {
@@ -1,2 +1,3 @@
export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter';
export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider';
export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider';
@@ -104,12 +104,12 @@ export const invalidTestEntityConfiguration = new EntityConfiguration<InvalidTes
columnName: 'name',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const invalidTestEntityCompanionDefinition = {
const invalidTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: InvalidTestEntity,
entityConfiguration: invalidTestEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: InvalidTestEntityPrivacyPolicy,
};
});
@@ -150,12 +150,12 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
columnName: 'maybe_json_array_field',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const postgresTestEntityCompanionDefinition = {
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: PostgresTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: PostgresTestEntityPrivacyPolicy,
};
});
@@ -0,0 +1,175 @@
import {
AlwaysAllowPrivacyPolicyRule,
EntityPrivacyPolicy,
ViewerContext,
UUIDField,
StringField,
EntityConfiguration,
DatabaseAdapterFlavor,
CacheAdapterFlavor,
EntityCompanionDefinition,
Entity,
EntityMutationTrigger,
EntityQueryContext,
EntityNonTransactionalMutationTrigger,
} from '@expo/entity';
import Knex from 'knex';
type PostgresTriggerTestEntityFields = {
id: string;
name: string | null;
};
export default class PostgresTriggerTestEntity extends Entity<
PostgresTriggerTestEntityFields,
string,
ViewerContext
> {
static getCompanionDefinition(): EntityCompanionDefinition<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity,
PostgresTriggerTestEntityPrivacyPolicy
> {
return postgresTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) {
await knex.schema.createTable(tableName, (table) => {
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.string('name');
});
}
await knex.into(tableName).truncate();
}
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);
}
}
}
class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity
> {
protected readonly createRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity
>(),
];
protected readonly readRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity
>(),
];
protected readonly updateRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity
>(),
];
protected readonly deleteRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity
>(),
];
}
class ThrowConditionallyTrigger extends EntityMutationTrigger<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity
> {
constructor(private fieldName: keyof PostgresTriggerTestEntityFields, private badValue: string) {
super();
}
async executeAsync(
_viewerContext: ViewerContext,
_queryContext: EntityQueryContext,
entity: PostgresTriggerTestEntity
): Promise<void> {
if (entity.getField(this.fieldName) === this.badValue) {
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
}
}
}
class ThrowConditionallyNonTransactionalTrigger extends EntityNonTransactionalMutationTrigger<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity
> {
constructor(private fieldName: keyof PostgresTriggerTestEntityFields, private badValue: string) {
super();
}
async executeAsync(
_viewerContext: ViewerContext,
entity: PostgresTriggerTestEntity
): Promise<void> {
if (entity.getField(this.fieldName) === this.badValue) {
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
}
}
}
export const postgresTestEntityConfiguration = new EntityConfiguration<
PostgresTriggerTestEntityFields
>({
idField: 'id',
tableName: 'postgres_test_entities',
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
name: new StringField({
columnName: 'name',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: PostgresTriggerTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresTriggerTestEntityPrivacyPolicy,
mutationTriggers: {
beforeCreate: [new ThrowConditionallyTrigger('name', 'beforeCreate')],
afterCreate: [new ThrowConditionallyTrigger('name', 'afterCreate')],
beforeUpdate: [new ThrowConditionallyTrigger('name', 'beforeUpdate')],
afterUpdate: [new ThrowConditionallyTrigger('name', 'afterUpdate')],
beforeDelete: [new ThrowConditionallyTrigger('name', 'beforeDelete')],
afterDelete: [new ThrowConditionallyTrigger('name', 'afterDelete')],
beforeAll: [new ThrowConditionallyTrigger('name', 'beforeAll')],
afterAll: [new ThrowConditionallyTrigger('name', 'afterAll')],
afterCommit: [new ThrowConditionallyNonTransactionalTrigger('name', 'afterCommit')],
},
});
@@ -0,0 +1,147 @@
import {
AlwaysAllowPrivacyPolicyRule,
EntityPrivacyPolicy,
ViewerContext,
UUIDField,
StringField,
EntityConfiguration,
DatabaseAdapterFlavor,
CacheAdapterFlavor,
EntityCompanionDefinition,
Entity,
EntityMutationTrigger,
EntityQueryContext,
} from '@expo/entity';
import Knex from 'knex';
type PostgresValidatorTestEntityFields = {
id: string;
name: string | null;
};
export default class PostgresValidatorTestEntity extends Entity<
PostgresValidatorTestEntityFields,
string,
ViewerContext
> {
static getCompanionDefinition(): EntityCompanionDefinition<
PostgresValidatorTestEntityFields,
string,
ViewerContext,
PostgresValidatorTestEntity,
PostgresValidatorTestEntityPrivacyPolicy
> {
return postgresTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) {
await knex.schema.createTable(tableName, (table) => {
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.string('name');
});
}
await knex.into(tableName).truncate();
}
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);
}
}
}
class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
PostgresValidatorTestEntityFields,
string,
ViewerContext,
PostgresValidatorTestEntity
> {
protected readonly createRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresValidatorTestEntityFields,
string,
ViewerContext,
PostgresValidatorTestEntity
>(),
];
protected readonly readRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresValidatorTestEntityFields,
string,
ViewerContext,
PostgresValidatorTestEntity
>(),
];
protected readonly updateRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresValidatorTestEntityFields,
string,
ViewerContext,
PostgresValidatorTestEntity
>(),
];
protected readonly deleteRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresValidatorTestEntityFields,
string,
ViewerContext,
PostgresValidatorTestEntity
>(),
];
}
class ThrowConditionallyTrigger extends EntityMutationTrigger<
PostgresValidatorTestEntityFields,
string,
ViewerContext,
PostgresValidatorTestEntity
> {
constructor(
private fieldName: keyof PostgresValidatorTestEntityFields,
private badValue: string
) {
super();
}
async executeAsync(
_viewerContext: ViewerContext,
_queryContext: EntityQueryContext,
entity: PostgresValidatorTestEntity
): Promise<void> {
if (entity.getField(this.fieldName) === this.badValue) {
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
}
}
}
export const postgresTestEntityConfiguration = new EntityConfiguration<
PostgresValidatorTestEntityFields
>({
idField: 'id',
tableName: 'postgres_test_entities',
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
name: new StringField({
columnName: 'name',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: PostgresValidatorTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
mutationValidators: [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
});
@@ -4,7 +4,7 @@ import {
EntityCompanionProvider,
CacheAdapterFlavor,
DatabaseAdapterFlavor,
NoCacheStubCacheAdapterProvider,
InMemoryFullCacheStubCacheAdapterProvider,
} from '@expo/entity';
import Knex from 'knex';
@@ -25,7 +25,7 @@ export const createKnexIntegrationTestEntityCompanionProvider = (
},
{
[CacheAdapterFlavor.REDIS]: {
cacheAdapterProvider: new NoCacheStubCacheAdapterProvider(),
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
},
}
);
+52
View File
@@ -0,0 +1,52 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [0.7.0](https://github.com/expo/entity/compare/v0.6.0...v0.7.0) (2020-10-01)
### Bug Fixes
* move cache invalidation to after transaction commit ([#77](https://github.com/expo/entity/issues/77)) ([dbc3c81](https://github.com/expo/entity/commit/dbc3c81b359a668b5134189ce6de49b5893bb5e7))
* upgrade packages ([#78](https://github.com/expo/entity/issues/78)) ([9891e74](https://github.com/expo/entity/commit/9891e7469467a28589f529c8d87b10fc2232d3ff))
# [0.6.0](https://github.com/expo/entity/compare/v0.5.2...v0.6.0) (2020-07-23)
**Note:** Version bump only for package @expo/entity-example
## [0.5.2](https://github.com/expo/entity/compare/v0.5.1...v0.5.2) (2020-07-02)
**Note:** Version bump only for package @expo/entity-example
## [0.5.1](https://github.com/expo/entity/compare/v0.5.0...v0.5.1) (2020-07-01)
**Note:** Version bump only for package @expo/entity-example
# 0.5.0 (2020-07-01)
### Bug Fixes
* upgrade Apollo server for security advisory ([#38](https://github.com/expo/entity/issues/38)) ([d25c1e1](https://github.com/expo/entity/commit/d25c1e142d52385725593f4f155d1795697ab490))
### Features
* support entity fields subset of db fields ([#49](https://github.com/expo/entity/issues/49)) ([4e40b2e](https://github.com/expo/entity/commit/4e40b2e521407e521d236978ec3b3b56db3990be))
+14 -14
View File
@@ -1,20 +1,20 @@
{
"name": "@expo/entity-example",
"private": true,
"version": "0.4.0",
"version": "0.7.0",
"description": "An example integration of the @expo/entity framework",
"scripts": {
"tsc": "tsc",
"clean": "rm -rf build coverage coverage-integration",
"lint": "eslint src --ext '.ts'",
"test": "jest --rootDir --config ../../resources/jest.config.js",
"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",
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete",
"start": "tsnd --transpile-only --inspect --respawn --no-notify --async-stack-traces --throw-deprecation -- src/index.ts"
},
"engines": {
"node": ">=8"
"node": ">=12"
},
"keywords": [
"entity"
@@ -22,18 +22,18 @@
"author": "Expo",
"license": "MIT",
"dependencies": {
"@expo/entity": "^0.4.0",
"apollo-server-koa": "^2.14.2",
"graphql": "^15.0.0",
"koa": "^2.11.0",
"koa-body": "^4.1.1",
"koa-router": "^8.0.8"
"@expo/entity": "^0.7.0",
"apollo-server-koa": "^2.16.1",
"graphql": "^15.3.0",
"koa": "^2.13.0",
"koa-body": "^4.2.0",
"koa-router": "^9.4.0"
},
"devDependencies": {
"@types/koa": "^2.11.3",
"@types/koa-router": "^7.4.0",
"@types/supertest": "^2.0.9",
"@types/koa": "^2.11.4",
"@types/koa-router": "^7.4.1",
"@types/supertest": "^2.0.10",
"supertest": "^4.0.2",
"ts-node-dev": "^1.0.0-pre.44"
"ts-node-dev": "^1.0.0-pre.60"
}
}
@@ -1,18 +1,13 @@
import {
IEntityQueryContextProvider,
EntityQueryContext,
EntityNonTransactionalQueryContext,
EntityTransactionalQueryContext,
} from '@expo/entity';
import { EntityQueryContextProvider } from '@expo/entity';
export default class InMemoryQueryContextProvider implements IEntityQueryContextProvider {
getRegularEntityQueryContext(): EntityQueryContext {
return new EntityNonTransactionalQueryContext({});
export default class InMemoryQueryContextProvider extends EntityQueryContextProvider {
protected getQueryInterface(): any {
return {};
}
async runInTransactionAsync<T>(
transactionScope: (queryContext: EntityQueryContext) => Promise<T>
): Promise<T> {
return await transactionScope(new EntityTransactionalQueryContext({}));
protected createTransactionRunner<T>(): (
transactionScope: (queryInterface: any) => Promise<T>
) => Promise<T> {
return (transactionScope) => Promise.resolve(transactionScope({}));
}
}
+2 -2
View File
@@ -2,14 +2,14 @@ import { EntityCompanionProvider } from '@expo/entity';
import { ApolloServer } from 'apollo-server-koa';
import Koa from 'koa';
import koaBody from 'koa-body';
import KoaRouter from 'koa-router';
import KoaRouter, { RouterContext } from 'koa-router';
import { entityCompanionMiddleware, viewerContextMiddleware } from './middleware';
import notesRouter from './routers/notesRouter';
import { typeDefs, resolvers } from './schema';
import { ExampleViewerContext } from './viewerContexts';
export type ExampleContext = Koa.ParameterizedContext<ExampleState>;
export type ExampleContext = RouterContext<ExampleState>;
/**
* Koa provides a per-request state container to place custom properties.
@@ -38,7 +38,7 @@ export default class NoteEntity extends Entity<NoteFields, string, ExampleViewer
* of entity. In some languages, this would be representable as "abstract" static members
* of the class itself, but TypeScript disallows static generic and abstract methods.
*/
export const noteEntityCompanion = {
export const noteEntityCompanion = new EntityCompanionDefinition({
entityClass: NoteEntity,
entityConfiguration: new EntityConfiguration<NoteFields>({
idField: 'id',
@@ -57,8 +57,8 @@ export const noteEntityCompanion = {
columnName: 'body',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
}),
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: NotePrivacyPolicy,
};
});
@@ -0,0 +1,12 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [0.7.0](https://github.com/expo/entity/compare/v0.6.0...v0.7.0) (2020-10-01)
### Bug Fixes
* move cache invalidation to after transaction commit ([#77](https://github.com/expo/entity/issues/77)) ([dbc3c81](https://github.com/expo/entity/commit/dbc3c81b359a668b5134189ce6de49b5893bb5e7))
* upgrade packages ([#78](https://github.com/expo/entity/issues/78)) ([9891e74](https://github.com/expo/entity/commit/9891e7469467a28589f529c8d87b10fc2232d3ff))
@@ -0,0 +1,5 @@
# `@expo/entity-full-integration-tests`
Full integration tests for testing combinations of database and cache adapters.
[Documentation](https://expo.github.io/entity/modules/_expo_entity_full_integration_tests.html)
@@ -0,0 +1,33 @@
{
"name": "@expo/entity-full-integration-tests",
"private": true,
"version": "0.7.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 --ext '.ts'",
"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": "*",
"@expo/entity-database-adapter-knex": "*"
},
"devDependencies": {
"@expo/entity": "^0.7.0",
"@expo/entity-cache-adapter-redis": "^0.7.0",
"@expo/entity-database-adapter-knex": "^0.7.0"
}
}
@@ -0,0 +1,205 @@
import {
EntityPrivacyPolicy,
ViewerContext,
AlwaysAllowPrivacyPolicyRule,
Entity,
EntityCompanionDefinition,
EntityConfiguration,
DatabaseAdapterFlavor,
CacheAdapterFlavor,
UUIDField,
} from '@expo/entity';
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
import Redis from 'ioredis';
import Knex from 'knex';
import { URL } from 'url';
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
interface TestFields {
id: string;
other_string: string;
third_string: string;
}
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
TestFields,
string,
ViewerContext,
TestEntity
> {
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
}
class TestEntity extends Entity<TestFields, string, ViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
TestFields,
string,
ViewerContext,
TestEntity,
TestEntityPrivacyPolicy
> {
return testEntityCompanion;
}
}
const testEntityConfiguration = new EntityConfiguration<TestFields>({
idField: 'id',
tableName: 'testentities',
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
other_string: new UUIDField({
columnName: 'other_string',
cache: true,
}),
third_string: new UUIDField({
columnName: 'third_string',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const testEntityCompanion = new EntityCompanionDefinition({
entityClass: TestEntity,
entityConfiguration: testEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
await knex.schema.createTable('testentities', (table) => {
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.string('other_string').notNullable();
table.string('third_string').notNullable();
});
await knex.into('testentities').truncate();
}
async function dropPostgresTable(knex: Knex): Promise<void> {
if (await knex.schema.hasTable('children')) {
await knex.schema.dropTable('children');
}
if (await knex.schema.hasTable('parents')) {
await knex.schema.dropTable('parents');
}
}
describe('Entity cache inconsistency', () => {
let knexInstance: Knex;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
knexInstance = Knex({
client: 'pg',
connection: {
user: process.env.PGUSER,
password: process.env.PGPASSWORD,
host: 'localhost',
port: parseInt(process.env.PGPORT!, 10),
database: process.env.PGDATABASE,
},
});
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 createOrTruncatePostgresTables(knexInstance);
await redisCacheAdapterContext.redisClient.flushdb();
});
afterAll(async () => {
await dropPostgresTable(knexInstance);
await knexInstance.destroy();
redisCacheAdapterContext.redisClient.disconnect();
});
test('lots of updates in long-ish running transactions', async () => {
const viewerContext = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
const entity1 = await TestEntity.creator(viewerContext)
.setField('other_string', 'hello')
.setField('third_string', 'initial')
.enforceCreateAsync();
// put entities in cache and dataloader
await TestEntity.loader(viewerContext).enforcing().loadByIDAsync(entity1.getID());
await TestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('other_string', 'hello');
let openBarrier1: () => void;
const barrier1 = new Promise((resolve) => {
openBarrier1 = resolve;
});
let openBarrier2: () => void;
const barrier2 = new Promise((resolve) => {
openBarrier2 = resolve;
});
await Promise.all([
// do a load after the transaction below updates the entity but before transaction commits to ensure
// that the cache is cleared after the transaction commits rather than in the middle where the changes
// may not be visible by other requests (ViewerContexts) which would cache the incorrect
// value during the read-through cache.
(async () => {
await barrier1;
const viewerContextInternal = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
await TestEntity.loader(viewerContextInternal).enforcing().loadByIDAsync(entity1.getID());
openBarrier2!();
})(),
TestEntity.runInTransactionAsync(viewerContext, async (queryContext) => {
await TestEntity.updater(entity1, queryContext)
.setField('third_string', 'updated')
.enforceUpdateAsync();
openBarrier1();
// wait for to ensure the transaction isn't committed until after load above occurs
await barrier2;
}),
]);
// ensure cache consistency
const viewerContextLast = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
const loadedById = await TestEntity.loader(viewerContextLast)
.enforcing()
.loadByIDAsync(entity1.getID());
const loadedByField = await TestEntity.loader(viewerContextLast)
.enforcing()
.loadByFieldEqualingAsync('other_string', 'hello');
expect(loadedById.getField('third_string')).toEqual('updated');
expect(loadedByField!.getField('third_string')).toEqual('updated');
});
});
@@ -0,0 +1,204 @@
import {
EntityPrivacyPolicy,
ViewerContext,
AlwaysAllowPrivacyPolicyRule,
Entity,
EntityCompanionDefinition,
EntityConfiguration,
DatabaseAdapterFlavor,
CacheAdapterFlavor,
UUIDField,
EntityEdgeDeletionBehavior,
} from '@expo/entity';
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
import Redis from 'ioredis';
import Knex from 'knex';
import { URL } from 'url';
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
interface ParentFields {
id: string;
}
interface ChildFields {
id: string;
parent_id: string;
}
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
}
class ParentEntity extends Entity<ParentFields, string, ViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
ParentFields,
string,
ViewerContext,
ParentEntity,
TestEntityPrivacyPolicy
> {
return parentEntityCompanion;
}
}
class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
ChildFields,
string,
ViewerContext,
ChildEntity,
TestEntityPrivacyPolicy
> {
return childEntityCompanion;
}
}
const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
idField: 'id',
tableName: 'parents',
inboundEdges: [ChildEntity],
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const childEntityConfiguration = new EntityConfiguration<ChildFields>({
idField: 'id',
tableName: 'children',
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
parent_id: new UUIDField({
columnName: 'parent_id',
cache: true,
association: {
associatedEntityClass: ParentEntity,
edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
},
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const parentEntityCompanion = new EntityCompanionDefinition({
entityClass: ParentEntity,
entityConfiguration: parentEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
const childEntityCompanion = new EntityCompanionDefinition({
entityClass: ChildEntity,
entityConfiguration: childEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
await knex.schema.createTable('parents', (table) => {
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
});
await knex.into('parents').truncate();
await knex.schema.createTable('children', (table) => {
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.uuid('parent_id').references('id').inTable('parents').onDelete('cascade').unique();
});
await knex.into('children').truncate();
}
async function dropPostgresTable(knex: Knex): Promise<void> {
if (await knex.schema.hasTable('children')) {
await knex.schema.dropTable('children');
}
if (await knex.schema.hasTable('parents')) {
await knex.schema.dropTable('parents');
}
}
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
let knexInstance: Knex;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
knexInstance = Knex({
client: 'pg',
connection: {
user: process.env.PGUSER,
password: process.env.PGPASSWORD,
host: 'localhost',
port: parseInt(process.env.PGPORT!, 10),
database: process.env.PGDATABASE,
},
});
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 createOrTruncatePostgresTables(knexInstance);
await redisCacheAdapterContext.redisClient.flushdb();
});
afterAll(async () => {
await dropPostgresTable(knexInstance);
await knexInstance.destroy();
redisCacheAdapterContext.redisClient.disconnect();
});
describe('EntityEdgeDeletionBehavior.INVALIDATE_CACHE', () => {
it('invalidates the cache', async () => {
const viewerContext = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
const child = await ChildEntity.creator(viewerContext)
.setField('parent_id', parent.getID())
.enforceCreateAsync();
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull();
await expect(
ChildEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_id', parent.getID())
).resolves.not.toBeNull();
await ParentEntity.enforceDeleteAsync(parent);
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.toBeNull();
await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
).resolves.toBeNull();
});
});
});
@@ -0,0 +1,235 @@
import {
EntityPrivacyPolicy,
ViewerContext,
AlwaysAllowPrivacyPolicyRule,
Entity,
EntityCompanionDefinition,
EntityConfiguration,
DatabaseAdapterFlavor,
CacheAdapterFlavor,
UUIDField,
EntityEdgeDeletionBehavior,
} from '@expo/entity';
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
import Redis from 'ioredis';
import Knex from 'knex';
import { URL } from 'url';
import { v4 as uuidv4 } from 'uuid';
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
interface CategoryFields {
id: string;
parent_other_id: string;
}
interface OtherFields {
id: string;
parent_category_id: string;
}
class PrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any> {
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
}
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
const categoriesTableName = uuidv4();
const othersTableName = uuidv4();
class CategoryEntity extends Entity<CategoryFields, string, ViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
CategoryFields,
string,
ViewerContext,
CategoryEntity,
PrivacyPolicy
> {
return categoryEntityCompanion;
}
}
class OtherEntity extends Entity<OtherFields, string, ViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
OtherFields,
string,
ViewerContext,
OtherEntity,
PrivacyPolicy
> {
return otherEntityCompanion;
}
}
const categoryEntityConfiguration = new EntityConfiguration<CategoryFields>({
idField: 'id',
tableName: categoriesTableName,
inboundEdges: [OtherEntity],
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
parent_other_id: new UUIDField({
columnName: 'parent_other_id',
cache: true,
association: {
associatedEntityClass: OtherEntity,
edgeDeletionBehavior,
},
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const categoryEntityCompanion = new EntityCompanionDefinition({
entityClass: CategoryEntity,
entityConfiguration: categoryEntityConfiguration,
privacyPolicyClass: PrivacyPolicy,
});
const otherEntityConfiguration = new EntityConfiguration<OtherFields>({
idField: 'id',
tableName: othersTableName,
inboundEdges: [CategoryEntity],
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
parent_category_id: new UUIDField({
columnName: 'parent_category_id',
cache: true,
association: {
associatedEntityClass: CategoryEntity,
edgeDeletionBehavior,
},
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const otherEntityCompanion = new EntityCompanionDefinition({
entityClass: OtherEntity,
entityConfiguration: otherEntityConfiguration,
privacyPolicyClass: PrivacyPolicy,
});
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
await knex.schema.createTable(categoriesTableName, (table) => {
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
});
await knex.schema.createTable(othersTableName, (table) => {
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
table
.uuid('parent_category_id')
.references('id')
.inTable(categoriesTableName)
.unique()
.onDelete('cascade');
} else {
table.uuid('parent_category_id').unique();
}
});
await knex.schema.alterTable(categoriesTableName, (table) => {
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
table
.uuid('parent_other_id')
.references('id')
.inTable(othersTableName)
.unique()
.onDelete('cascade');
} else {
table.uuid('parent_other_id').unique();
}
});
return { CategoryEntity, OtherEntity };
};
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
let knexInstance: Knex;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
knexInstance = Knex({
client: 'pg',
connection: {
user: process.env.PGUSER,
password: process.env.PGPASSWORD,
host: 'localhost',
port: parseInt(process.env.PGPORT!, 10),
database: process.env.PGDATABASE,
},
});
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
};
});
afterAll(async () => {
await knexInstance.destroy();
redisCacheAdapterContext.redisClient.disconnect();
});
it.each([
EntityEdgeDeletionBehavior.CASCADE_DELETE,
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
EntityEdgeDeletionBehavior.SET_NULL,
])('behavior: %p', async (edgeDeletionBehavior) => {
const { CategoryEntity, OtherEntity } = await makeEntityClasses(
knexInstance,
edgeDeletionBehavior
);
const viewerContext = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
const category1 = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
const other1 = await OtherEntity.creator(viewerContext)
.setField('parent_category_id', category1.getID())
.enforceCreateAsync();
await CategoryEntity.updater(category1)
.setField('parent_other_id', other1.getID())
.enforceUpdateAsync();
await CategoryEntity.enforceDeleteAsync(category1);
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL) {
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
).resolves.toBeNull();
const otherLoaded = await OtherEntity.loader(viewerContext)
.enforcing()
.loadByIDNullableAsync(other1.getID());
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
} else {
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
).resolves.toBeNull();
await expect(
OtherEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(other1.getID())
).resolves.toBeNull();
}
});
});
@@ -0,0 +1,37 @@
import {
NoOpEntityMetricsAdapter,
IEntityMetricsAdapter,
EntityCompanionProvider,
CacheAdapterFlavor,
DatabaseAdapterFlavor,
} from '@expo/entity';
import {
RedisCacheAdapterContext,
RedisCacheAdapterProvider,
} from '@expo/entity-cache-adapter-redis';
import {
PostgresEntityDatabaseAdapterProvider,
PostgresEntityQueryContextProvider,
} from '@expo/entity-database-adapter-knex';
import Knex from 'knex';
export const createFullIntegrationTestEntityCompanionProvider = (
knex: Knex,
redisCacheAdapterContext: RedisCacheAdapterContext,
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => {
return new EntityCompanionProvider(
metricsAdapter,
{
[DatabaseAdapterFlavor.POSTGRES]: {
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
},
},
{
[CacheAdapterFlavor.REDIS]: {
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
},
}
);
};
@@ -0,0 +1,7 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"noEmit": true,
},
"include": ["src"]
}
+72
View File
@@ -0,0 +1,72 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [0.7.0](https://github.com/expo/entity/compare/v0.6.0...v0.7.0) (2020-10-01)
### Bug Fixes
* fix incorrect loader types for field selecitons ([#72](https://github.com/expo/entity/issues/72)) ([cd2df8d](https://github.com/expo/entity/commit/cd2df8da4b81bcd4769e950d3124c18886df2816))
* fix index export for EntityMutationTrigger and EntityMutationValidator ([#73](https://github.com/expo/entity/issues/73)) ([7e829f3](https://github.com/expo/entity/commit/7e829f30fde0bd343cb8a584ccda5530cf61ec33))
* move cache invalidation to after transaction commit ([#77](https://github.com/expo/entity/issues/77)) ([dbc3c81](https://github.com/expo/entity/commit/dbc3c81b359a668b5134189ce6de49b5893bb5e7))
* upgrade packages ([#78](https://github.com/expo/entity/issues/78)) ([9891e74](https://github.com/expo/entity/commit/9891e7469467a28589f529c8d87b10fc2232d3ff))
# [0.6.0](https://github.com/expo/entity/compare/v0.5.2...v0.6.0) (2020-07-23)
### Bug Fixes
* ensure transitive deletion triggers are run for CASCADE_DELETE_INVALIDATE_CACHE ([#66](https://github.com/expo/entity/issues/66)) ([5744c51](https://github.com/expo/entity/commit/5744c51e6b3178bd9f229f3f465b683bb4474c8a))
* separate out EntityMutationValidator ([#68](https://github.com/expo/entity/issues/68)) ([547a1ef](https://github.com/expo/entity/commit/547a1efcecd17cc085702d1a3e9888ce5b644b13))
* update setField to correct typing ([#62](https://github.com/expo/entity/issues/62)) ([7a77afc](https://github.com/expo/entity/commit/7a77afc83ea732c9b062a5d6865eff9d3131d015))
### Features
* entity mutation validators ([#67](https://github.com/expo/entity/issues/67)) ([fc4377d](https://github.com/expo/entity/commit/fc4377d8839da07417b88afc138f73556383d896))
* mutation triggers ([#65](https://github.com/expo/entity/issues/65)) ([fd6060c](https://github.com/expo/entity/commit/fd6060cc844f60635b3ce4c400c4877f2df8fa44))
## [0.5.2](https://github.com/expo/entity/compare/v0.5.1...v0.5.2) (2020-07-02)
### Bug Fixes
* fix stub cache key generation for global cache ([#59](https://github.com/expo/entity/issues/59)) ([7c180e8](https://github.com/expo/entity/commit/7c180e84d9a8cdfd9380fac0eab2d02a96ec18f3))
## [0.5.1](https://github.com/expo/entity/compare/v0.5.0...v0.5.1) (2020-07-01)
### Bug Fixes
* correct some typing issues and exports ([#57](https://github.com/expo/entity/issues/57)) ([e91cfba](https://github.com/expo/entity/commit/e91cfba99321c2c4da2078aafd8627cbf0ceca50))
# 0.5.0 (2020-07-01)
### Bug Fixes
* support number ID field generation in StubDatabaseAdapter ([#43](https://github.com/expo/entity/issues/43)) ([60cc0fb](https://github.com/expo/entity/commit/60cc0fbda460c3ada1f5244a2780f90382fe3ebd))
### Features
* add two fan out methods to association loader ([#52](https://github.com/expo/entity/issues/52)) ([89cfb3d](https://github.com/expo/entity/commit/89cfb3d5a01d4da90f64acc52ae1b839ba348a35))
* support entity fields subset of db fields ([#49](https://github.com/expo/entity/issues/49)) ([4e40b2e](https://github.com/expo/entity/commit/4e40b2e521407e521d236978ec3b3b56db3990be))
+6 -7
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/entity",
"version": "0.4.0",
"version": "0.7.0",
"description": "A privacy-first data model",
"files": [
"build",
@@ -12,13 +12,13 @@
"tsc": "tsc",
"clean": "rm -rf build coverage coverage-integration",
"lint": "eslint src --ext '.ts'",
"test": "jest --rootDir --config ../../resources/jest.config.js",
"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",
"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": ">=8"
"node": ">=12"
},
"keywords": [
"entity"
@@ -26,11 +26,10 @@
"author": "Expo",
"license": "MIT",
"dependencies": {
"@expo/results": "^0.3.0",
"@expo/results": "^1.0.0",
"dataloader": "^2.0.0",
"es6-error": "^4.1.1",
"invariant": "^2.2.4",
"lodash": "^4.17.15",
"uuid": "^7.0.3"
"uuid": "^8.3.0"
}
}
+15 -7
View File
@@ -13,8 +13,15 @@ export default class EnforcingEntityLoader<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
constructor(
private readonly entityLoader: EntityLoader<
@@ -22,7 +29,8 @@ export default class EnforcingEntityLoader<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>
) {}
@@ -30,7 +38,7 @@ export default class EnforcingEntityLoader<
* Enforcing version of entity loader method by the same name.
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
*/
async loadManyByFieldEqualingManyAsync<N extends keyof TFields>(
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N,
fieldValues: readonly NonNullable<TFields[N]>[]
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly TEntity[]>> {
@@ -47,7 +55,7 @@ export default class EnforcingEntityLoader<
* Enforcing version of entity loader method by the same name.
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
*/
async loadManyByFieldEqualingAsync<N extends keyof TFields>(
async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N,
fieldValue: NonNullable<TFields[N]>
): Promise<readonly TEntity[]> {
@@ -63,7 +71,7 @@ export default class EnforcingEntityLoader<
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
* @throws when multiple entities are found matching the condition
*/
async loadByFieldEqualingAsync<N extends keyof TFields>(
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
uniqueFieldName: N,
fieldValue: NonNullable<TFields[N]>
): Promise<TEntity | null> {
@@ -106,7 +114,7 @@ export default class EnforcingEntityLoader<
* Enforcing version of entity loader method by the same name.
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
*/
async loadManyByFieldEqualityConjunctionAsync<N extends keyof TFields>(
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly TEntity[]> {
+124 -31
View File
@@ -28,8 +28,9 @@ import ViewerContext from './ViewerContext';
export default abstract class Entity<
TFields,
TID,
TViewerContext extends ViewerContext
> extends ReadonlyEntity<TFields, TID, TViewerContext> {
TViewerContext extends ViewerContext,
TSelectedFields extends keyof TFields = keyof TFields
> extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields> {
/**
* Vend mutator for creating a new entity in given query context.
* @param viewerContext - viewer context of creating user
@@ -41,16 +42,30 @@ export default abstract class Entity<
TMID,
TMViewerContext extends ViewerContext,
TMViewerContext2 extends TMViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
TMEntity extends Entity<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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
viewerContext: TMViewerContext2,
queryContext: EntityQueryContext = viewerContext
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.getRegularEntityQueryContext()
): CreateMutator<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy> {
.getQueryContext()
): CreateMutator<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
return viewerContext
.getViewerScopedEntityCompanionForClass(this)
.getMutatorFactory()
@@ -67,17 +82,31 @@ export default abstract class Entity<
TMFields,
TMID,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
TMEntity extends Entity<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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
existingEntity: TMEntity,
queryContext: EntityQueryContext = existingEntity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.getRegularEntityQueryContext()
): UpdateMutator<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy> {
.getQueryContext()
): UpdateMutator<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
return existingEntity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(this)
@@ -94,16 +123,30 @@ export default abstract class Entity<
TMFields,
TMID,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
TMEntity extends Entity<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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
existingEntity: TMEntity,
queryContext: EntityQueryContext = existingEntity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.getRegularEntityQueryContext()
.getQueryContext()
): Promise<Result<void>> {
return existingEntity
.getViewerContext()
@@ -122,16 +165,30 @@ export default abstract class Entity<
TMFields,
TMID,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
TMEntity extends Entity<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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
existingEntity: TMEntity,
queryContext: EntityQueryContext = existingEntity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.getRegularEntityQueryContext()
.getQueryContext()
): Promise<void> {
return existingEntity
.getViewerContext()
@@ -161,16 +218,30 @@ export default abstract class Entity<
TMFields,
TMID,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
TMEntity extends Entity<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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
existingEntity: TMEntity,
queryContext: EntityQueryContext = existingEntity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.getRegularEntityQueryContext()
.getQueryContext()
): Promise<boolean> {
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
const evaluationResult = await asyncResult(
@@ -196,16 +267,30 @@ export default abstract class Entity<
TMFields,
TMID,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
TMEntity extends Entity<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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
existingEntity: TMEntity,
queryContext: EntityQueryContext = existingEntity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.getRegularEntityQueryContext()
.getQueryContext()
): Promise<boolean> {
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
const evaluationResult = await asyncResult(
@@ -226,8 +311,15 @@ export interface IEntityClass<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields = keyof TFields
> {
new (viewerContext: TViewerContext, obj: Readonly<TFields>): TEntity;
getCompanionDefinition(): EntityCompanionDefinition<
@@ -235,6 +327,7 @@ export interface IEntityClass<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>;
}
+239 -50
View File
@@ -10,7 +10,8 @@ export default class EntityAssociationLoader<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields
> {
constructor(private readonly entity: TEntity) {}
@@ -24,27 +25,35 @@ export default class EntityAssociationLoader<
async loadAssociatedEntityAsync<
TAssociatedFields,
TAssociatedID,
TAssociatedEntity extends ReadonlyEntity<TAssociatedFields, TAssociatedID, TViewerContext>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedSelectedFields
>,
TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity
>
TAssociatedEntity,
TAssociatedSelectedFields
>,
TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
>(
fieldIdentifyingAssociatedEntity: keyof TFields,
fieldIdentifyingAssociatedEntity: keyof Pick<TFields, TSelectedFields>,
associatedEntityClass: IEntityClass<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity,
TAssociatedPrivacyPolicy
TAssociatedPrivacyPolicy,
TAssociatedSelectedFields
>,
queryContext: EntityQueryContext = this.entity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getQueryContextProvider()
.getRegularEntityQueryContext()
.getQueryContext()
): Promise<Result<TAssociatedEntity>> {
const associatedEntityID = this.entity.getField(fieldIdentifyingAssociatedEntity);
const loader = this.entity
@@ -55,6 +64,60 @@ export default class EntityAssociationLoader<
return await loader.loadByIDAsync((associatedEntityID as unknown) as TAssociatedID);
}
/**
* Load many entities associated with this entity, often referred to as entites belonging
* to this entity. In a relational database, the field in the foreign entity is a
* foreign key to the ID of this entity. Also commonly referred to as a has many relationship,
* where this entity has many associated entities.
* @param associatedEntityClass - class of the associated entities
* @param associatedEntityFieldContainingThisID - field of associated entity which contains the ID of this entity
* @param queryContext - query context in which to perform the load
*/
async loadManyAssociatedEntitiesAsync<
TAssociatedFields,
TAssociatedID,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedSelectedFields
>,
TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity,
TAssociatedSelectedFields
>,
TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
>(
associatedEntityClass: IEntityClass<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity,
TAssociatedPrivacyPolicy,
TAssociatedSelectedFields
>,
associatedEntityFieldContainingThisID: keyof Pick<TAssociatedFields, TAssociatedSelectedFields>,
queryContext: EntityQueryContext = this.entity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getQueryContextProvider()
.getQueryContext()
): Promise<readonly Result<TAssociatedEntity>[]> {
const thisID = this.entity.getID();
const loader = this.entity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory()
.forLoad(queryContext);
return await loader.loadManyByFieldEqualingAsync(
associatedEntityFieldContainingThisID,
thisID as any
);
}
/**
* Load an associated entity identified by a field value of this entity. In a relational database,
* the field in this entity is a foreign key to a unique field of the associated entity.
@@ -66,28 +129,36 @@ export default class EntityAssociationLoader<
async loadAssociatedEntityByFieldEqualingAsync<
TAssociatedFields,
TAssociatedID,
TAssociatedEntity extends ReadonlyEntity<TAssociatedFields, TAssociatedID, TViewerContext>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedSelectedFields
>,
TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity
>
TAssociatedEntity,
TAssociatedSelectedFields
>,
TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
>(
fieldIdentifyingAssociatedEntity: keyof TFields,
fieldIdentifyingAssociatedEntity: keyof Pick<TFields, TSelectedFields>,
associatedEntityClass: IEntityClass<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity,
TAssociatedPrivacyPolicy
TAssociatedPrivacyPolicy,
TAssociatedSelectedFields
>,
associatedEntityLookupByField: keyof TAssociatedFields,
associatedEntityLookupByField: keyof Pick<TAssociatedFields, TAssociatedSelectedFields>,
queryContext: EntityQueryContext = this.entity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getQueryContextProvider()
.getRegularEntityQueryContext()
.getQueryContext()
): Promise<Result<TAssociatedEntity> | null> {
const associatedFieldValue = this.entity.getField(fieldIdentifyingAssociatedEntity);
const loader = this.entity
@@ -101,6 +172,60 @@ export default class EntityAssociationLoader<
);
}
/**
* Load many associated entities identified by a field value of this entity. In a relational database,
* the field in this entity refers to a field of the associated entity.
* @param fieldIdentifyingAssociatedEntity - field of this entity containing the value with which to look up associated entities
* @param associatedEntityClass - class of the associated entities
* @param associatedEntityLookupByField - field of associated entities with which to look up the associated entities
* @param queryContext - query context in which to perform the load
*/
async loadManyAssociatedEntitiesByFieldEqualingAsync<
TAssociatedFields,
TAssociatedID,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedSelectedFields
>,
TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity,
TAssociatedSelectedFields
>,
TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
>(
fieldIdentifyingAssociatedEntity: keyof Pick<TFields, TSelectedFields>,
associatedEntityClass: IEntityClass<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity,
TAssociatedPrivacyPolicy,
TAssociatedSelectedFields
>,
associatedEntityLookupByField: keyof Pick<TAssociatedFields, TAssociatedSelectedFields>,
queryContext: EntityQueryContext = this.entity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getQueryContextProvider()
.getQueryContext()
): Promise<readonly Result<TAssociatedEntity>[]> {
const associatedFieldValue = this.entity.getField(fieldIdentifyingAssociatedEntity);
const loader = this.entity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory()
.forLoad(queryContext);
return await loader.loadManyByFieldEqualingAsync(
associatedEntityLookupByField,
associatedFieldValue as any
);
}
/**
* Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
* fold step, load an associated entity identified by a field value of the current fold value.
@@ -108,15 +233,29 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the loads
*/
async loadAssociatedEntityThroughAsync<
TEntityRoot extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicyRoot extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntityRoot>,
TFields2,
TID2,
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<TFields2, TID2, TViewerContext, TEntity2>
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<
TFields2,
TID2,
TViewerContext,
TEntity2,
TSelectedFields2
>,
TSelectedFields2 extends keyof TFields2 = keyof TFields2
>(
loadDirectives: [
EntityLoadThroughDirective<TViewerContext, TFields, TFields2, TID2, TEntity2, TPrivacyPolicy2>
EntityLoadThroughDirective<
TViewerContext,
TFields,
TFields2,
TID2,
TEntity2,
TPrivacyPolicy2,
TSelectedFields,
TSelectedFields2
>
],
queryContext?: EntityQueryContext
): Promise<Result<TEntity2> | null>;
@@ -128,16 +267,28 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the loads
*/
async loadAssociatedEntityThroughAsync<
TEntityRoot extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicyRoot extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntityRoot>,
TFields2,
TID2,
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<TFields2, TID2, TViewerContext, TEntity2>,
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<
TFields2,
TID2,
TViewerContext,
TEntity2,
TSelectedFields2
>,
TFields3,
TID3,
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext>,
TPrivacyPolicy3 extends EntityPrivacyPolicy<TFields3, TID3, TViewerContext, TEntity3>
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
TPrivacyPolicy3 extends EntityPrivacyPolicy<
TFields3,
TID3,
TViewerContext,
TEntity3,
TSelectedFields3
>,
TSelectedFields2 extends keyof TFields2 = keyof TFields2,
TSelectedFields3 extends keyof TFields3 = keyof TFields3
>(
loadDirectives: [
EntityLoadThroughDirective<
@@ -146,7 +297,9 @@ export default class EntityAssociationLoader<
TFields2,
TID2,
TEntity2,
TPrivacyPolicy2
TPrivacyPolicy2,
TSelectedFields,
TSelectedFields2
>,
EntityLoadThroughDirective<
TViewerContext,
@@ -154,7 +307,9 @@ export default class EntityAssociationLoader<
TFields3,
TID3,
TEntity3,
TPrivacyPolicy3
TPrivacyPolicy3,
TSelectedFields2,
TSelectedFields3
>
],
queryContext?: EntityQueryContext
@@ -167,20 +322,39 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the loads
*/
async loadAssociatedEntityThroughAsync<
TEntityRoot extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicyRoot extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntityRoot>,
TFields2,
TID2,
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<TFields2, TID2, TViewerContext, TEntity2>,
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<
TFields2,
TID2,
TViewerContext,
TEntity2,
TSelectedFields2
>,
TFields3,
TID3,
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext>,
TPrivacyPolicy3 extends EntityPrivacyPolicy<TFields3, TID3, TViewerContext, TEntity3>,
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
TPrivacyPolicy3 extends EntityPrivacyPolicy<
TFields3,
TID3,
TViewerContext,
TEntity3,
TSelectedFields3
>,
TFields4,
TID4,
TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext>,
TPrivacyPolicy4 extends EntityPrivacyPolicy<TFields4, TID4, TViewerContext, TEntity4>
TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext, TSelectedFields4>,
TPrivacyPolicy4 extends EntityPrivacyPolicy<
TFields4,
TID4,
TViewerContext,
TEntity4,
TSelectedFields4
>,
TSelectedFields2 extends keyof TFields2 = keyof TFields2,
TSelectedFields3 extends keyof TFields3 = keyof TFields3,
TSelectedFields4 extends keyof TFields4 = keyof TFields4
>(
loadDirective: [
EntityLoadThroughDirective<
@@ -189,7 +363,9 @@ export default class EntityAssociationLoader<
TFields2,
TID2,
TEntity2,
TPrivacyPolicy2
TPrivacyPolicy2,
TSelectedFields,
TSelectedFields2
>,
EntityLoadThroughDirective<
TViewerContext,
@@ -197,7 +373,9 @@ export default class EntityAssociationLoader<
TFields3,
TID3,
TEntity3,
TPrivacyPolicy3
TPrivacyPolicy3,
TSelectedFields2,
TSelectedFields3
>,
EntityLoadThroughDirective<
TViewerContext,
@@ -205,7 +383,9 @@ export default class EntityAssociationLoader<
TFields4,
TID4,
TEntity4,
TPrivacyPolicy4
TPrivacyPolicy4,
TSelectedFields3,
TSelectedFields4
>
],
queryContext?: EntityQueryContext
@@ -218,22 +398,22 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the loads
*/
async loadAssociatedEntityThroughAsync(
loadDirectives: EntityLoadThroughDirective<TViewerContext, any, any, any, any, any>[],
loadDirectives: EntityLoadThroughDirective<TViewerContext, any, any, any, any, any, any, any>[],
queryContext?: EntityQueryContext
): Promise<Result<ReadonlyEntity<any, any, any>> | null>;
): Promise<Result<ReadonlyEntity<any, any, any, any>> | null>;
async loadAssociatedEntityThroughAsync(
loadDirectives: EntityLoadThroughDirective<TViewerContext, any, any, any, any, any>[],
loadDirectives: EntityLoadThroughDirective<TViewerContext, any, any, any, any, any, any, any>[],
queryContext?: EntityQueryContext
): Promise<Result<ReadonlyEntity<any, any, any>> | null> {
let currentEntity: ReadonlyEntity<any, any, any> = this.entity;
): Promise<Result<ReadonlyEntity<any, any, any, any>> | null> {
let currentEntity: ReadonlyEntity<any, any, any, any> = this.entity;
for (const loadDirective of loadDirectives) {
const {
associatedEntityClass,
fieldIdentifyingAssociatedEntity,
associatedEntityLookupByField,
} = loadDirective;
let associatedEntityResult: Result<ReadonlyEntity<any, any, any>> | null;
let associatedEntityResult: Result<ReadonlyEntity<any, any, any, any>> | null;
if (associatedEntityLookupByField) {
associatedEntityResult = await currentEntity
.associationLoader()
@@ -274,13 +454,21 @@ export interface EntityLoadThroughDirective<
TFields,
TAssociatedFields,
TAssociatedID,
TAssociatedEntity extends ReadonlyEntity<TAssociatedFields, TAssociatedID, TViewerContext>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedSelectedFields
>,
TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
TAssociatedFields,
TAssociatedID,
TViewerContext,
TAssociatedEntity
>
TAssociatedEntity,
TAssociatedSelectedFields
>,
TSelectedFields extends keyof TFields = keyof TFields,
TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
> {
/**
* Class of entity to load at this step.
@@ -290,17 +478,18 @@ export interface EntityLoadThroughDirective<
TAssociatedID,
TViewerContext,
TAssociatedEntity,
TAssociatedPrivacyPolicy
TAssociatedPrivacyPolicy,
TAssociatedSelectedFields
>;
/**
* Field of the current entity with which to load an instance of associatedEntityClass.
*/
fieldIdentifyingAssociatedEntity: keyof TFields;
fieldIdentifyingAssociatedEntity: keyof Pick<TFields, TSelectedFields>;
/**
* Field by which to load the instance of associatedEntityClass. If not provided, the
* associatedEntityClass instance is fetched by its ID.
*/
associatedEntityLookupByField?: keyof TAssociatedFields;
associatedEntityLookupByField?: keyof Pick<TAssociatedFields, TAssociatedSelectedFields>;
}
+75 -39
View File
@@ -1,17 +1,13 @@
import { IEntityClass } from './Entity';
import EntityCacheAdapter from './EntityCacheAdapter';
import EntityConfiguration from './EntityConfiguration';
import EntityDatabaseAdapter from './EntityDatabaseAdapter';
import EntityLoaderFactory from './EntityLoaderFactory';
import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
import EntityMutationValidator from './EntityMutationValidator';
import EntityMutatorFactory from './EntityMutatorFactory';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import IEntityCacheAdapterProvider from './IEntityCacheAdapterProvider';
import IEntityDatabaseAdapterProvider from './IEntityDatabaseAdapterProvider';
import IEntityQueryContextProvider from './IEntityQueryContextProvider';
import EntityQueryContextProvider from './EntityQueryContextProvider';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
import EntityDataManager from './internal/EntityDataManager';
import ReadThroughEntityCache from './internal/ReadThroughEntityCache';
import EntityTableDataCoordinator from './internal/EntityTableDataCoordinator';
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
export interface IPrivacyPolicyClass<TPrivacyPolicy> {
@@ -25,72 +21,112 @@ export default class EntityCompanion<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
// defined as properties so that they can be accessed from tests
private readonly databaseAdapter: EntityDatabaseAdapter<TFields>;
private readonly cacheAdapter: EntityCacheAdapter<TFields>;
private readonly entityLoaderFactory: EntityLoaderFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>;
private readonly entityMutatorFactory: EntityMutatorFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>;
constructor(
entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy>,
entityConfiguration: EntityConfiguration<TFields>,
databaseAdapterProvider: IEntityDatabaseAdapterProvider,
cacheAdapterProvider: IEntityCacheAdapterProvider,
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
private readonly tableDataCoordinator: EntityTableDataCoordinator<TFields>,
PrivacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>,
private readonly queryContextProvider: IEntityQueryContextProvider,
mutationValidators: EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[],
mutationTriggers: EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
metricsAdapter: IEntityMetricsAdapter
) {
this.databaseAdapter = databaseAdapterProvider.getDatabaseAdapter(entityConfiguration);
this.cacheAdapter = cacheAdapterProvider.getCacheAdapter(entityConfiguration);
const dataManager = new EntityDataManager(
this.databaseAdapter,
new ReadThroughEntityCache(entityConfiguration, this.cacheAdapter),
queryContextProvider,
metricsAdapter
);
const privacyPolicy = new PrivacyPolicyClass();
this.entityLoaderFactory = new EntityLoaderFactory(
entityConfiguration,
this.entityLoaderFactory = new EntityLoaderFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>(
tableDataCoordinator.entityConfiguration.idField as keyof Pick<TFields, TSelectedFields>,
entityClass,
privacyPolicy,
dataManager
tableDataCoordinator.dataManager
);
this.entityMutatorFactory = new EntityMutatorFactory(
entityConfiguration,
tableDataCoordinator.entityConfiguration,
entityClass,
privacyPolicy,
mutationValidators,
mutationTriggers,
this.entityLoaderFactory,
this.databaseAdapter,
tableDataCoordinator.databaseAdapter,
metricsAdapter
);
}
getLoaderFactory(): EntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
getLoaderFactory(): EntityLoaderFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
> {
return this.entityLoaderFactory;
}
getMutatorFactory(): EntityMutatorFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
getMutatorFactory(): EntityMutatorFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
> {
return this.entityMutatorFactory;
}
getQueryContextProvider(): IEntityQueryContextProvider {
return this.queryContextProvider;
/**
* Get the query context provider for this entity.
*/
getQueryContextProvider(): EntityQueryContextProvider {
return this.tableDataCoordinator.getQueryContextProvider();
}
}
+133 -26
View File
@@ -1,12 +1,15 @@
import { IEntityClass } from './Entity';
import EntityCompanion, { IPrivacyPolicyClass } from './EntityCompanion';
import EntityConfiguration from './EntityConfiguration';
import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
import EntityMutationValidator from './EntityMutationValidator';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import EntityQueryContextProvider from './EntityQueryContextProvider';
import IEntityCacheAdapterProvider from './IEntityCacheAdapterProvider';
import IEntityDatabaseAdapterProvider from './IEntityDatabaseAdapterProvider';
import IEntityQueryContextProvider from './IEntityQueryContextProvider';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
import EntityTableDataCoordinator from './internal/EntityTableDataCoordinator';
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
import { computeIfAbsent } from './utils/collections/maps';
@@ -40,7 +43,7 @@ export enum CacheAdapterFlavor {
*/
export interface DatabaseAdapterFlavorDefinition {
adapterProvider: IEntityDatabaseAdapterProvider;
queryContextProvider: IEntityQueryContextProvider;
queryContextProvider: EntityQueryContextProvider;
}
/**
@@ -55,18 +58,87 @@ export interface CacheAdapterFlavorDefinition {
* Definition for constructing a companion for an entity. Defines the core set of objects
* used to power the entity framework for a particular type of entity.
*/
export interface EntityCompanionDefinition<
export class EntityCompanionDefinition<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields = keyof TFields
> {
entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy>;
entityConfiguration: EntityConfiguration<TFields>;
databaseAdaptorFlavor: DatabaseAdapterFlavor;
cacheAdaptorFlavor: CacheAdapterFlavor;
privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
readonly entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>;
readonly entityConfiguration: EntityConfiguration<TFields>;
readonly privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
readonly mutationValidators: EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[];
readonly mutationTriggers: EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>;
readonly entitySelectedFields: TSelectedFields[];
constructor({
entityClass,
entityConfiguration,
privacyPolicyClass,
mutationValidators = [],
mutationTriggers = {},
entitySelectedFields = Array.from(entityConfiguration.schema.keys()) as TSelectedFields[],
}: {
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>;
entityConfiguration: EntityConfiguration<TFields>;
privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
mutationValidators?: EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[];
mutationTriggers?: EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>;
entitySelectedFields?: TSelectedFields[];
}) {
this.entityClass = entityClass;
this.entityConfiguration = entityConfiguration;
this.privacyPolicyClass = privacyPolicyClass;
this.mutationValidators = mutationValidators;
this.mutationTriggers = mutationTriggers;
this.entitySelectedFields = entitySelectedFields;
}
}
/**
@@ -79,9 +151,13 @@ export interface EntityCompanionDefinition<
* {@link EntityCompanion} for each type of {@link Entity}.
*/
export default class EntityCompanionProvider {
private readonly entityCompanionMap: Map<
private readonly companionMap: Map<
string,
EntityCompanion<any, any, any, any, any>
EntityCompanion<any, any, any, any, any, any>
> = new Map();
private readonly tableDataCoordinatorMap: Map<
string,
EntityTableDataCoordinator<any>
> = new Map();
/**
@@ -107,31 +183,62 @@ export default class EntityCompanionProvider {
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
>(
entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy>,
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
entityCompanionDefinition: EntityCompanionDefinition<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>
): EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
return computeIfAbsent(this.entityCompanionMap, entityClass.name, () => {
const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors[
entityCompanionDefinition.databaseAdaptorFlavor
];
const entityCacheAdapterFlavor = this.cacheAdapterFlavors[
entityCompanionDefinition.cacheAdaptorFlavor
];
): EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
const tableDataCoordinator = this.getTableDataCoordinatorForEntity(
entityCompanionDefinition.entityConfiguration
);
return computeIfAbsent(this.companionMap, entityClass.name, () => {
return new EntityCompanion(
entityCompanionDefinition.entityClass,
entityCompanionDefinition.entityConfiguration,
tableDataCoordinator,
entityCompanionDefinition.privacyPolicyClass,
entityCompanionDefinition.mutationValidators,
entityCompanionDefinition.mutationTriggers,
this.metricsAdapter
);
});
}
private getTableDataCoordinatorForEntity<TFields>(
entityConfiguration: EntityConfiguration<TFields>
): EntityTableDataCoordinator<TFields> {
return computeIfAbsent(this.tableDataCoordinatorMap, entityConfiguration.tableName, () => {
const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors[
entityConfiguration.databaseAdapterFlavor
];
const entityCacheAdapterFlavor = this.cacheAdapterFlavors[
entityConfiguration.cacheAdapterFlavor
];
return new EntityTableDataCoordinator(
entityConfiguration,
entityDatabaseAdapterFlavor.adapterProvider,
entityCacheAdapterFlavor.cacheAdapterProvider,
entityCompanionDefinition.privacyPolicyClass,
entityDatabaseAdapterFlavor.queryContextProvider,
this.metricsAdapter
);
+21 -5
View File
@@ -1,9 +1,11 @@
import { IEntityClass } from './Entity';
import { DatabaseAdapterFlavor, CacheAdapterFlavor } from './EntityCompanionProvider';
import { EntityFieldDefinition } from './EntityFields';
import { mapMap, invertMap, reduceMap } from './utils/collections/maps';
/**
* The data storage configuration for a type of Entity. Contains information relating to IDs,
* cachable fields, and field mappings.
* cachable fields, field mappings, and types of cache and database adapter.
*/
export default class EntityConfiguration<TFields> {
readonly idField: keyof TFields;
@@ -11,24 +13,38 @@ export default class EntityConfiguration<TFields> {
readonly cacheableKeys: ReadonlySet<keyof TFields>;
readonly cacheKeyVersion: number;
readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>;
readonly inboundEdges: IEntityClass<any, any, any, any, any, any>[];
readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>;
readonly entityToDBFieldsKeyMapping: ReadonlyMap<keyof TFields, string>;
readonly dbToEntityFieldsKeyMapping: ReadonlyMap<string, keyof TFields>;
readonly databaseAdapterFlavor: DatabaseAdapterFlavor;
readonly cacheAdapterFlavor: CacheAdapterFlavor;
constructor({
idField,
tableName,
schema,
inboundEdges = [],
cacheKeyVersion = 0,
databaseAdapterFlavor,
cacheAdapterFlavor,
}: {
idField: keyof TFields;
tableName: string;
schema: Record<keyof TFields, EntityFieldDefinition<any>>;
schema: Record<keyof TFields, EntityFieldDefinition>;
inboundEdges?: IEntityClass<any, any, any, any, any, any>[];
cacheKeyVersion?: number;
databaseAdapterFlavor: DatabaseAdapterFlavor;
cacheAdapterFlavor: CacheAdapterFlavor;
}) {
this.idField = idField;
this.tableName = tableName;
this.cacheKeyVersion = cacheKeyVersion;
this.databaseAdapterFlavor = databaseAdapterFlavor;
this.cacheAdapterFlavor = cacheAdapterFlavor;
this.inboundEdges = inboundEdges;
// external schema is a Record to typecheck that all fields have FieldDefinitions,
// but internally the most useful representation is a map for lookups
@@ -43,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,
@@ -58,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);
}
@@ -348,10 +348,6 @@ export default abstract class EntityDatabaseAdapter<TFields> {
throw new Error(
`Excessive deletions from database adapter delete: ${this.entityConfiguration.tableName}(id = ${id})`
);
} else if (numDeleted === 0) {
throw new Error(
`No deletions from database adapter delete: ${this.entityConfiguration.tableName}(id = ${id})`
);
}
}
+20 -5
View File
@@ -11,12 +11,26 @@ export class EntityNotFoundError<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>,
N extends keyof TFields
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>,
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
fieldName: N,
fieldValue: TFields[N]
) {
@@ -28,7 +42,8 @@ export class EntityNotAuthorizedError<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> extends EntityError {
public readonly entityClassName: string;
+95 -22
View File
@@ -1,17 +1,92 @@
export interface FieldValidator<T> {
import { IEntityClass } from './Entity';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
export enum EntityEdgeDeletionBehavior {
/**
* Validation to apply for this field before an entity is created or updated.
* Only applies to fields changed during a mutation; any existing fields will
* not be re-validated in order to allow for changing of validator logic.
* 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.
*/
write?: (value: T) => Promise<void>;
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 abstract class EntityFieldDefinition<T> {
export interface EntityAssociationDefinition<
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.
*/
associatedEntityClass: 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 {
readonly columnName: string;
readonly cache: boolean;
readonly validator: FieldValidator<T>;
readonly association?: EntityAssociationDefinition<any, any, any, any, any, any>;
/**
*
* @param columnName - Column name in the database.
@@ -22,27 +97,25 @@ export abstract class EntityFieldDefinition<T> {
constructor({
columnName,
cache = false,
validator = {},
association,
}: {
columnName: string;
cache?: boolean;
validator?: FieldValidator<T>;
association?: EntityAssociationDefinition<any, any, any, any, any, any>;
}) {
this.columnName = columnName;
this.cache = cache;
this.validator = validator;
this.association = association;
}
}
export class StringField extends EntityFieldDefinition<string> {}
export class StringField extends EntityFieldDefinition {}
export class UUIDField extends StringField {}
export class DateField extends EntityFieldDefinition<Date> {}
export class BooleanField extends EntityFieldDefinition<boolean> {}
export class NumberField extends EntityFieldDefinition<number> {}
export class StringArrayField extends EntityFieldDefinition<string[]> {}
export class JSONObjectField<T extends object> extends EntityFieldDefinition<T> {}
export class EnumField<T> extends EntityFieldDefinition<T> {}
export class JSONArrayField<T> extends EntityFieldDefinition<T[]> {}
export class MaybeJSONArrayField<TArray, TNotArray> extends EntityFieldDefinition<
TArray[] | TNotArray
> {}
export class DateField extends EntityFieldDefinition {}
export class BooleanField extends EntityFieldDefinition {}
export class NumberField extends EntityFieldDefinition {}
export class StringArrayField extends EntityFieldDefinition {}
export class JSONObjectField extends EntityFieldDefinition {}
export class EnumField extends EntityFieldDefinition {}
export class JSONArrayField extends EntityFieldDefinition {}
export class MaybeJSONArrayField extends EntityFieldDefinition {}
+96 -56
View File
@@ -3,7 +3,6 @@ import invariant from 'invariant';
import EnforcingEntityLoader from './EnforcingEntityLoader';
import { IEntityClass } from './Entity';
import EntityConfiguration from './EntityConfiguration';
import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
import { EntityNotFoundError } from './EntityErrors';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
@@ -21,22 +20,30 @@ export default class EntityLoader<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
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,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
private readonly privacyPolicy: TPrivacyPolicy,
private readonly entityDataManager: EntityDataManager<TFields>
private readonly dataManager: EntityDataManager<TFields>
) {}
/**
@@ -44,7 +51,14 @@ export default class EntityLoader<
* guaranteed to be the values of successful results (or null for some loader methods),
* and will throw otherwise.
*/
enforcing(): EnforcingEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
enforcing(): EnforcingEntityLoader<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
> {
return new EnforcingEntityLoader(this);
}
@@ -55,30 +69,38 @@ export default class EntityLoader<
* @returns map from fieldValue to entity results that match the query for that fieldValue,
* where result errors can be UnauthorizedError
*/
async loadManyByFieldEqualingManyAsync<N extends keyof TFields>(
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N,
fieldValues: readonly NonNullable<TFields[N]>[]
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
const fieldValuesToObjects = await this.entityDataManager.loadManyByFieldEqualingAsync(
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
this.queryContext,
fieldName,
fieldValues
);
const fieldValuesToUncheckedEntities = mapMap(fieldValuesToObjects, (v) => {
return v.map((obj) => {
return new this.entityClass(this.viewerContext, obj);
});
});
const fieldValuesToUncheckedEntityResults = mapMap(fieldValuesToFieldObjects, (fieldObjects) =>
this.tryConstructEntities(fieldObjects)
);
return await mapMapAsync(fieldValuesToUncheckedEntities, async (v) => {
return await Promise.all(
v.map((entity) =>
asyncResult(
this.privacyPolicy.authorizeReadAsync(this.viewerContext, this.queryContext, entity)
)
)
);
});
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
)
);
})
);
}
);
}
/**
@@ -87,7 +109,7 @@ export default class EntityLoader<
* @param fieldValue - fieldName field value being queried
* @returns array of entity results that match the query for fieldValue, where result error can be UnauthorizedError
*/
async loadManyByFieldEqualingAsync<N extends keyof TFields>(
async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N,
fieldValue: NonNullable<TFields[N]>
): Promise<readonly Result<TEntity>[]> {
@@ -107,7 +129,7 @@ export default class EntityLoader<
* @returns entity result where uniqueFieldName equals fieldValue, or null if no entity matches the condition.
* @throws when multiple entities match the condition
*/
async loadByFieldEqualingAsync<N extends keyof TFields>(
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
uniqueFieldName: N,
fieldValue: NonNullable<TFields[N]>
): Promise<Result<TEntity> | null> {
@@ -128,9 +150,7 @@ export default class EntityLoader<
const entityResults = await this.loadManyByIDsAsync([id]);
const entityResult = entityResults.get(id);
if (entityResult === undefined) {
return result(
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id as any)
);
return result(new EntityNotFoundError(this.entityClass, this.idField, id as any));
}
return entityResult;
}
@@ -141,7 +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(this.entityConfiguration.idField, id as any);
return await this.loadByFieldEqualingAsync(this.idField, id as any);
}
/**
@@ -152,16 +172,13 @@ export default class EntityLoader<
*/
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
const entityResults = ((await this.loadManyByFieldEqualingManyAsync(
this.entityConfiguration.idField,
this.idField,
ids as any
)) as any) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
return mapMap(entityResults, (entityResultsForId, id) => {
const entityResult = entityResultsForId[0];
return (
entityResult ??
result(
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id as any)
)
entityResult ?? result(new EntityNotFoundError(this.entityClass, this.idField, id as any))
);
});
}
@@ -180,25 +197,29 @@ export default class EntityLoader<
* @param querySelectionModifiers - limit, offset, and orderBy for the query
* @returns array of entity results that match the query, where result error can be UnauthorizedError
*/
async loadManyByFieldEqualityConjunctionAsync<N extends keyof TFields>(
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly Result<TEntity>[]> {
const fieldValuesArray = await this.entityDataManager.loadManyByFieldEqualityConjunctionAsync(
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
this.queryContext,
fieldEqualityOperands,
querySelectionModifiers
);
const uncheckedEntities = fieldValuesArray.map((obj) => {
return new this.entityClass(this.viewerContext, obj);
});
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
return await Promise.all(
uncheckedEntities.map(async (entity) =>
asyncResult(
this.privacyPolicy.authorizeReadAsync(this.viewerContext, this.queryContext, entity)
)
)
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
if (!uncheckedEntityResult.ok) {
return uncheckedEntityResult;
}
return await asyncResult(
this.privacyPolicy.authorizeReadAsync(
this.viewerContext,
this.queryContext,
uncheckedEntityResult.value
)
);
})
);
}
@@ -232,22 +253,26 @@ export default class EntityLoader<
bindings: any[] | object,
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly Result<TEntity>[]> {
const fieldValuesArray = await this.entityDataManager.loadManyByRawWhereClauseAsync(
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync(
this.queryContext,
rawWhereClause,
bindings,
querySelectionModifiers
);
const uncheckedEntities = fieldValuesArray.map((obj) => {
return new this.entityClass(this.viewerContext, obj);
});
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
return await Promise.all(
uncheckedEntities.map(async (entity) =>
asyncResult(
this.privacyPolicy.authorizeReadAsync(this.viewerContext, this.queryContext, entity)
)
)
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
if (!uncheckedEntityResult.ok) {
return uncheckedEntityResult;
}
return await asyncResult(
this.privacyPolicy.authorizeReadAsync(
this.viewerContext,
this.queryContext,
uncheckedEntityResult.value
)
);
})
);
}
@@ -256,6 +281,21 @@ export default class EntityLoader<
* @param objectFields - entity data object to be invalidated
*/
async invalidateFieldsAsync(objectFields: Readonly<TFields>): Promise<void> {
await this.entityDataManager.invalidateObjectFieldsAsync(objectFields);
await this.dataManager.invalidateObjectFieldsAsync(objectFields);
}
/**
* 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 fieldsObject - 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) {
return result(e);
}
});
}
}
+14 -7
View File
@@ -1,5 +1,4 @@
import { IEntityClass } from './Entity';
import EntityConfiguration from './EntityConfiguration';
import EntityLoader from './EntityLoader';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext';
@@ -14,17 +13,25 @@ export default class EntityLoaderFactory<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
constructor(
private readonly entityConfiguration: EntityConfiguration<TFields>,
private readonly idField: keyof Pick<TFields, TSelectedFields>,
private readonly entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
private readonly privacyPolicyClass: TPrivacyPolicy,
private readonly dataManager: EntityDataManager<TFields>
@@ -38,11 +45,11 @@ export default class EntityLoaderFactory<
forLoad(
viewerContext: TViewerContext,
queryContext: EntityQueryContext
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new EntityLoader(
viewerContext,
queryContext,
this.entityConfiguration,
this.idField,
this.entityClass,
this.privacyPolicyClass,
this.dataManager
@@ -0,0 +1,97 @@
import { EntityQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
/**
* Interface to define trigger behavior for entities.
*/
export default interface EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> {
/**
* Trigger set that runs within the transaction but before the entity is created in the database.
*/
beforeCreate?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs within the transaction but after the entity is created in the database and cache is invalidated.
*/
afterCreate?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs within the transaction but before the entity is updated in the database.
*/
beforeUpdate?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs within the transaction but after the entity is updated in the database and cache is invalidated.
*/
afterUpdate?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs within the transaction but before the entity is deleted from the database.
*/
beforeDelete?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs within the transaction but after the entity is deleted from the database and cache is invalidated.
*/
afterDelete?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs within the transaction but before the entity is created, updated, or deleted.
*/
beforeAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs within the transaction but before the entity is created in, updated in, or deleted from
* the database and the cache is invalidated.
*/
afterAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs after committing the transaction unless one is supplied
* after any mutation (create, update, delete). If the call to the mutation is wrapped in a transaction,
* this too will be within the transaction.
*/
afterCommit?: EntityNonTransactionalMutationTrigger<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[];
}
/**
* A trigger is a way to specify entity mutation operation side-effects that run within the
* same transaction as the mutation itself. The one exception is afterCommit, which will run within
* the transaction if a transaction is supplied.
*/
export abstract class EntityMutationTrigger<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> {
abstract async executeAsync(
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
entity: TEntity
): Promise<void>;
}
/**
* A non-transactional trigger is like a {@link EntityMutationTrigger} but used for afterCommit triggers
* since they explicitly occur outside of the transaction.
*/
export abstract class EntityNonTransactionalMutationTrigger<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> {
abstract async executeAsync(viewerContext: TViewerContext, entity: TEntity): Promise<void>;
}
@@ -0,0 +1,21 @@
import { EntityQueryContext } 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,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> {
abstract async executeAsync(
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
entity: TEntity
): Promise<void>;
}
+478 -75
View File
@@ -1,23 +1,37 @@
import { Result, asyncResult, result, enforceAsyncResult } from '@expo/results';
import invariant from 'invariant';
import _ from 'lodash';
import Entity, { IEntityClass } from './Entity';
import { EntityCompanionDefinition } from './EntityCompanionProvider';
import EntityConfiguration from './EntityConfiguration';
import EntityDatabaseAdapter from './EntityDatabaseAdapter';
import { EntityEdgeDeletionBehavior } from './EntityFields';
import EntityLoaderFactory from './EntityLoaderFactory';
import EntityMutationTriggerConfiguration, {
EntityMutationTrigger,
EntityNonTransactionalMutationTrigger,
} from './EntityMutationTriggerConfiguration';
import EntityMutationValidator from './EntityMutationValidator';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext';
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
import { timeAndLogMutationEventAsync } from './metrics/EntityMetricsUtils';
import IEntityMetricsAdapter, { EntityMetricsMutationType } from './metrics/IEntityMetricsAdapter';
import { mapMapAsync } from './utils/collections/maps';
abstract class BaseMutator<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
constructor(
protected readonly viewerContext: TViewerContext,
@@ -28,37 +42,70 @@ abstract class BaseMutator<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
protected readonly privacyPolicy: TPrivacyPolicy,
protected readonly mutationValidators: EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[],
protected readonly mutationTriggers: EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
protected readonly entityLoaderFactory: EntityLoaderFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
protected readonly databaseAdapter: EntityDatabaseAdapter<TFields>,
protected readonly metricsAdapter: IEntityMetricsAdapter
) {}
protected async validateFields(fields: Partial<TFields>): Promise<Result<Partial<TFields>>> {
const validatorResults = await asyncResult(
Promise.all(
Object.entries(fields).map(async ([fieldName, fieldValue]) => {
const fieldDefinition = this.entityConfiguration.schema.get(fieldName as keyof TFields);
invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
const writeValidator = fieldDefinition.validator.write;
if (writeValidator) {
await writeValidator(fieldValue);
}
})
protected async executeMutationTriggersOrValidatorsAsync(
triggersOrValidators:
| EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
| EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
| undefined,
queryContext: EntityQueryContext,
entity: TEntity
): Promise<void> {
if (!triggersOrValidators) {
return;
}
await Promise.all(
triggersOrValidators.map((triggerOrValidator) =>
triggerOrValidator.executeAsync(this.viewerContext, queryContext, entity)
)
);
if (!validatorResults.ok) {
return result(validatorResults.reason);
}
protected async executeNonTransactionalMutationTriggersOrValidatorsAsync(
triggers:
| EntityNonTransactionalMutationTrigger<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[]
| undefined,
entity: TEntity
): Promise<void> {
if (!triggers) {
return;
}
return result(fields);
await Promise.all(triggers.map((trigger) => trigger.executeAsync(this.viewerContext, entity)));
}
}
@@ -69,9 +116,16 @@ export class CreateMutator<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
> extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
private readonly fieldsForEntity: Partial<TFields> = {};
/**
@@ -79,7 +133,7 @@ export class CreateMutator<
* @param fieldName - entity field being updated
* @param value - value for entity field
*/
setField<K extends keyof TFields>(fieldName: K, value: TFields[K]): this {
setField<K extends keyof Pick<TFields, TSelectedFields>>(fieldName: K, value: TFields[K]): this {
this.fieldsForEntity[fieldName] = value;
return this;
}
@@ -93,7 +147,7 @@ export class CreateMutator<
return await timeAndLogMutationEventAsync(
this.metricsAdapter,
EntityMetricsMutationType.CREATE
)(this.createInternalAsync());
)(this.createInTransactionAsync());
}
/**
@@ -103,21 +157,24 @@ export class CreateMutator<
return await enforceAsyncResult(this.createAsync());
}
private async createInternalAsync(): Promise<Result<TEntity>> {
const validatedFieldsResult = await this.validateFields(this.fieldsForEntity);
if (!validatedFieldsResult.ok) {
return result(validatedFieldsResult.reason);
}
private async createInTransactionAsync(): Promise<Result<TEntity>> {
return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
this.createInternalAsync(innerQueryContext)
);
}
private async createInternalAsync(
queryContext: EntityTransactionalQueryContext
): Promise<Result<TEntity>> {
const temporaryEntityForPrivacyCheck = new this.entityClass(this.viewerContext, ({
[this.entityConfiguration.idField]: '00000000-0000-0000-0000-000000000000', // zero UUID
...validatedFieldsResult.value,
...this.fieldsForEntity,
} as unknown) as TFields);
const authorizeCreateResult = await asyncResult(
this.privacyPolicy.authorizeCreateAsync(
this.viewerContext,
this.queryContext,
queryContext,
temporaryEntityForPrivacyCheck
)
);
@@ -125,16 +182,54 @@ export class CreateMutator<
return authorizeCreateResult;
}
const insertResult = await this.databaseAdapter.insertAsync(
this.queryContext,
validatedFieldsResult.value
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationValidators,
queryContext,
temporaryEntityForPrivacyCheck
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.beforeAll,
queryContext,
temporaryEntityForPrivacyCheck
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.beforeCreate,
queryContext,
temporaryEntityForPrivacyCheck
);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, this.queryContext);
await entityLoader.invalidateFieldsAsync(insertResult);
const insertResult = await this.databaseAdapter.insertAsync(queryContext, this.fieldsForEntity);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
queryContext.appendPostCommitCallback(
entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult)
);
const unauthorizedEntityAfterInsert = new this.entityClass(this.viewerContext, insertResult);
return await entityLoader.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
const newEntity = await entityLoader
.enforcing()
.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.afterCreate,
queryContext,
newEntity
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.afterAll,
queryContext,
newEntity
);
queryContext.appendPostCommitCallback(
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
this,
this.mutationTriggers.afterCommit,
newEntity
)
);
return result(newEntity);
}
}
@@ -145,9 +240,16 @@ export class UpdateMutator<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
> extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
private readonly originalFieldsForEntity: Readonly<TFields>;
private readonly fieldsForEntity: TFields;
private readonly updatedFields: Partial<TFields> = {};
@@ -156,9 +258,37 @@ export class UpdateMutator<
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
entityConfiguration: EntityConfiguration<TFields>,
entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy>,
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
privacyPolicy: TPrivacyPolicy,
entityLoaderFactory: EntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy>,
mutationValidators: EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[],
mutationTriggers: EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
entityLoaderFactory: EntityLoaderFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
databaseAdapter: EntityDatabaseAdapter<TFields>,
metricsAdapter: IEntityMetricsAdapter,
fieldsForEntity: Readonly<TFields>
@@ -169,12 +299,14 @@ export class UpdateMutator<
entityConfiguration,
entityClass,
privacyPolicy,
mutationValidators,
mutationTriggers,
entityLoaderFactory,
databaseAdapter,
metricsAdapter
);
this.originalFieldsForEntity = _.cloneDeep(fieldsForEntity);
this.fieldsForEntity = _.cloneDeep(fieldsForEntity);
this.originalFieldsForEntity = { ...fieldsForEntity };
this.fieldsForEntity = { ...fieldsForEntity };
}
/**
@@ -182,7 +314,7 @@ export class UpdateMutator<
* @param fieldName - entity field being updated
* @param value - value for entity field
*/
setField<K extends keyof TFields>(fieldName: K, value: TFields[K]): this {
setField<K extends keyof Pick<TFields, TSelectedFields>>(fieldName: K, value: TFields[K]): this {
this.fieldsForEntity[fieldName] = value;
this.updatedFields[fieldName] = value;
return this;
@@ -198,7 +330,7 @@ export class UpdateMutator<
return await timeAndLogMutationEventAsync(
this.metricsAdapter,
EntityMetricsMutationType.UPDATE
)(this.updateInternalAsync());
)(this.updateInTransactionAsync());
}
/**
@@ -208,17 +340,20 @@ export class UpdateMutator<
return await enforceAsyncResult(this.updateAsync());
}
private async updateInternalAsync(): Promise<Result<TEntity>> {
const validatedUpdatedFieldsResult = await this.validateFields(this.updatedFields);
if (!validatedUpdatedFieldsResult.ok) {
return result(validatedUpdatedFieldsResult.reason);
}
private async updateInTransactionAsync(): Promise<Result<TEntity>> {
return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
this.updateInternalAsync(innerQueryContext)
);
}
private async updateInternalAsync(
queryContext: EntityTransactionalQueryContext
): Promise<Result<TEntity>> {
const entityAboutToBeUpdated = new this.entityClass(this.viewerContext, this.fieldsForEntity);
const authorizeUpdateResult = await asyncResult(
this.privacyPolicy.authorizeUpdateAsync(
this.viewerContext,
this.queryContext,
queryContext,
entityAboutToBeUpdated
)
);
@@ -226,20 +361,63 @@ export class UpdateMutator<
return authorizeUpdateResult;
}
const updateResult = await this.databaseAdapter.updateAsync(
this.queryContext,
this.entityConfiguration.idField,
entityAboutToBeUpdated.getID(),
validatedUpdatedFieldsResult.value
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationValidators,
queryContext,
entityAboutToBeUpdated
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.beforeAll,
queryContext,
entityAboutToBeUpdated
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.beforeUpdate,
queryContext,
entityAboutToBeUpdated
);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, this.queryContext);
const updateResult = await this.databaseAdapter.updateAsync(
queryContext,
this.entityConfiguration.idField,
entityAboutToBeUpdated.getID(),
this.updatedFields
);
await entityLoader.invalidateFieldsAsync(this.originalFieldsForEntity);
await entityLoader.invalidateFieldsAsync(this.fieldsForEntity);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
queryContext.appendPostCommitCallback(
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.originalFieldsForEntity)
);
queryContext.appendPostCommitCallback(
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.fieldsForEntity)
);
const unauthorizedEntityAfterUpdate = new this.entityClass(this.viewerContext, updateResult);
return await entityLoader.loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
const updatedEntity = await entityLoader
.enforcing()
.loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.afterUpdate,
queryContext,
updatedEntity
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.afterAll,
queryContext,
updatedEntity
);
queryContext.appendPostCommitCallback(
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
this,
this.mutationTriggers.afterCommit,
updatedEntity
)
);
return result(updatedEntity);
}
}
@@ -250,16 +428,51 @@ export class DeleteMutator<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
> extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
constructor(
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
entityConfiguration: EntityConfiguration<TFields>,
entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy>,
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
privacyPolicy: TPrivacyPolicy,
entityLoaderFactory: EntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy>,
mutationValidators: EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[],
mutationTriggers: EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
entityLoaderFactory: EntityLoaderFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
databaseAdapter: EntityDatabaseAdapter<TFields>,
metricsAdapter: IEntityMetricsAdapter,
private readonly entity: TEntity
@@ -270,6 +483,8 @@ export class DeleteMutator<
entityConfiguration,
entityClass,
privacyPolicy,
mutationValidators,
mutationTriggers,
entityLoaderFactory,
databaseAdapter,
metricsAdapter
@@ -284,7 +499,7 @@ export class DeleteMutator<
return await timeAndLogMutationEventAsync(
this.metricsAdapter,
EntityMetricsMutationType.DELETE
)(this.deleteInternalAsync());
)(this.deleteInTransactionAsync());
}
/**
@@ -294,21 +509,209 @@ export class DeleteMutator<
return await enforceAsyncResult(this.deleteAsync());
}
private async deleteInternalAsync(): Promise<Result<void>> {
private async deleteInTransactionAsync(
processedEntityIdentifiersFromTransitiveDeletions: Set<string> = new Set(),
skipDatabaseDeletion: boolean = false
): Promise<Result<void>> {
return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
this.deleteInternalAsync(
innerQueryContext,
processedEntityIdentifiersFromTransitiveDeletions,
skipDatabaseDeletion
)
);
}
private async deleteInternalAsync(
queryContext: EntityTransactionalQueryContext,
processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
skipDatabaseDeletion: boolean
): Promise<Result<void>> {
const authorizeDeleteResult = await asyncResult(
this.privacyPolicy.authorizeDeleteAsync(this.viewerContext, this.queryContext, this.entity)
this.privacyPolicy.authorizeDeleteAsync(this.viewerContext, queryContext, this.entity)
);
if (!authorizeDeleteResult.ok) {
return authorizeDeleteResult;
}
const id = this.entity.getID();
await DeleteMutator.processEntityDeletionForInboundEdgesAsync(
this.entity,
queryContext,
processedEntityIdentifiersFromTransitiveDeletions
);
await this.databaseAdapter.deleteAsync(this.queryContext, this.entityConfiguration.idField, id);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.beforeAll,
queryContext,
this.entity
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.beforeDelete,
queryContext,
this.entity
);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, this.queryContext);
await entityLoader.invalidateFieldsAsync(this.entity.getAllFields());
if (!skipDatabaseDeletion) {
await this.databaseAdapter.deleteAsync(
queryContext,
this.entityConfiguration.idField,
this.entity.getID()
);
}
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
queryContext.appendPostCommitCallback(
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.entity.getAllDatabaseFields())
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.afterDelete,
queryContext,
this.entity
);
await this.executeMutationTriggersOrValidatorsAsync(
this.mutationTriggers.afterAll,
queryContext,
this.entity
);
queryContext.appendPostCommitCallback(
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
this,
this.mutationTriggers.afterCommit,
this.entity
)
);
return result();
}
/**
* Finds all entities referencing the specified entity and either deletes them, nullifies
* their references to the specified entity, or invalidates the cache depending on the
* {@link OnDeleteBehavior} of the field referencing the specified entity.
*
* @remarks
* This works by doing reverse fan-out queries:
* 1. Load all entity configurations of entity types that reference this type of entity
* 2. For each entity configuration, find all fields that contain edges to this type of entity
* 3. For each edge field, load all entities with an edge from target entity to this entity via that field
* 4. Perform desired OnDeleteBehavior for entities
*
* @param entity - entity to find all references to
*/
private static async processEntityDeletionForInboundEdgesAsync<
TMFields,
TMID,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
TMSelectedFields extends keyof TMFields
>(
entity: TMEntity,
queryContext: EntityTransactionalQueryContext,
processedEntityIdentifiers: Set<string>
): Promise<void> {
// prevent infinite reference cycles by keeping track of entities already processed
if (processedEntityIdentifiers.has(entity.getUniqueIdentifier())) {
return;
}
processedEntityIdentifiers.add(entity.getUniqueIdentifier());
const companionDefinition = (entity.constructor as any).getCompanionDefinition() as EntityCompanionDefinition<
TMFields,
TMID,
TMViewerContext,
TMEntity,
EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity, TMSelectedFields>,
TMSelectedFields
>;
const entityConfiguration = companionDefinition.entityConfiguration;
const inboundEdges = entityConfiguration.inboundEdges;
await Promise.all(
inboundEdges.map(async (entityClass) => {
return await mapMapAsync(
entityClass.getCompanionDefinition().entityConfiguration.schema,
async (fieldDefinition, fieldName) => {
const association = fieldDefinition.association;
if (!association) {
return;
}
const associatedConfiguration = association.associatedEntityClass.getCompanionDefinition()
.entityConfiguration;
if (associatedConfiguration !== entityConfiguration) {
return;
}
const associatedEntityLookupByField = association.associatedEntityLookupByField;
const loaderFactory = entity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(entityClass)
.getLoaderFactory();
const mutatorFactory = entity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(entityClass)
.getMutatorFactory();
let inboundReferenceEntities: readonly ReadonlyEntity<any, any, any, any>[];
if (associatedEntityLookupByField) {
inboundReferenceEntities = await loaderFactory
.forLoad(queryContext)
.enforcing()
.loadManyByFieldEqualingAsync(
fieldName,
entity.getField(associatedEntityLookupByField as any)
);
} else {
inboundReferenceEntities = await loaderFactory
.forLoad(queryContext)
.enforcing()
.loadManyByFieldEqualingAsync(fieldName, entity.getID());
}
switch (association.edgeDeletionBehavior) {
case undefined:
case EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE: {
await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) =>
mutatorFactory
.forDelete(inboundReferenceEntity, queryContext)
.deleteInTransactionAsync(
processedEntityIdentifiers,
/* skipDatabaseDeletion */ true // deletion is handled by DB
)
)
);
break;
}
case EntityEdgeDeletionBehavior.SET_NULL: {
await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) =>
mutatorFactory
.forUpdate(inboundReferenceEntity, queryContext)
.setField(fieldName, null)
.enforceUpdateAsync()
)
);
break;
}
case EntityEdgeDeletionBehavior.CASCADE_DELETE: {
await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) =>
mutatorFactory
.forDelete(inboundReferenceEntity, queryContext)
.deleteInTransactionAsync(
processedEntityIdentifiers,
/* skipDatabaseDeletion */ false
)
)
);
}
}
}
);
})
);
}
}
+39 -8
View File
@@ -2,6 +2,8 @@ import Entity, { IEntityClass } from './Entity';
import EntityConfiguration from './EntityConfiguration';
import EntityDatabaseAdapter from './EntityDatabaseAdapter';
import EntityLoaderFactory from './EntityLoaderFactory';
import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
import EntityMutationValidator from './EntityMutationValidator';
import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext';
@@ -15,8 +17,15 @@ export default class EntityMutatorFactory<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields = keyof TFields
> {
constructor(
private readonly entityConfiguration: EntityConfiguration<TFields>,
@@ -25,15 +34,31 @@ export default class EntityMutatorFactory<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
private readonly privacyPolicy: TPrivacyPolicy,
private readonly mutationValidators: EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[],
private readonly mutationTriggers: EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
private readonly entityLoaderFactory: EntityLoaderFactory<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
private readonly databaseAdapter: EntityDatabaseAdapter<TFields>,
private readonly metricsAdapter: IEntityMetricsAdapter
@@ -48,13 +73,15 @@ export default class EntityMutatorFactory<
forCreate(
viewerContext: TViewerContext,
queryContext: EntityQueryContext
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new CreateMutator(
viewerContext,
queryContext,
this.entityConfiguration,
this.entityClass,
this.privacyPolicy,
this.mutationValidators,
this.mutationTriggers,
this.entityLoaderFactory,
this.databaseAdapter,
this.metricsAdapter
@@ -70,17 +97,19 @@ export default class EntityMutatorFactory<
forUpdate(
existingEntity: TEntity,
queryContext: EntityQueryContext
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new UpdateMutator(
existingEntity.getViewerContext(),
queryContext,
this.entityConfiguration,
this.entityClass,
this.privacyPolicy,
this.mutationValidators,
this.mutationTriggers,
this.entityLoaderFactory,
this.databaseAdapter,
this.metricsAdapter,
existingEntity.getAllFields()
existingEntity.getAllDatabaseFields()
);
}
@@ -92,13 +121,15 @@ export default class EntityMutatorFactory<
forDelete(
existingEntity: TEntity,
queryContext: EntityQueryContext
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new DeleteMutator(
existingEntity.getViewerContext(),
queryContext,
this.entityConfiguration,
this.entityClass,
this.privacyPolicy,
this.mutationValidators,
this.mutationTriggers,
this.entityLoaderFactory,
this.databaseAdapter,
this.metricsAdapter,
+21 -11
View File
@@ -14,18 +14,23 @@ export type EntityPrivacyPolicyEvaluator<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> =
| {
mode: EntityPrivacyPolicyEvaluationMode.ENFORCE;
}
| {
mode: EntityPrivacyPolicyEvaluationMode.DRY_RUN;
denyHandler: (error: EntityNotAuthorizedError<TFields, TID, TViewerContext, TEntity>) => void;
denyHandler: (
error: EntityNotAuthorizedError<TFields, TID, TViewerContext, TEntity, TSelectedFields>
) => void;
}
| {
mode: EntityPrivacyPolicyEvaluationMode.ENFORCE_AND_LOG;
denyHandler: (error: EntityNotAuthorizedError<TFields, TID, TViewerContext, TEntity>) => void;
denyHandler: (
error: EntityNotAuthorizedError<TFields, TID, TViewerContext, TEntity, TSelectedFields>
) => void;
};
export enum EntityAuthorizationAction {
@@ -60,31 +65,36 @@ export default abstract class EntityPrivacyPolicy<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> {
protected readonly createRules: readonly PrivacyPolicyRule<
TFields,
TID,
TViewerContext,
TEntity
TEntity,
TSelectedFields
>[] = [];
protected readonly readRules: readonly PrivacyPolicyRule<
TFields,
TID,
TViewerContext,
TEntity
TEntity,
TSelectedFields
>[] = [];
protected readonly updateRules: readonly PrivacyPolicyRule<
TFields,
TID,
TViewerContext,
TEntity
TEntity,
TSelectedFields
>[] = [];
protected readonly deleteRules: readonly PrivacyPolicyRule<
TFields,
TID,
TViewerContext,
TEntity
TEntity,
TSelectedFields
>[] = [];
/**
@@ -97,7 +107,7 @@ export default abstract class EntityPrivacyPolicy<
*/
protected getPrivacyPolicyEvaluator(
_viewerContext: TViewerContext
): EntityPrivacyPolicyEvaluator<TFields, TID, TViewerContext, TEntity> {
): EntityPrivacyPolicyEvaluator<TFields, TID, TViewerContext, TEntity, TSelectedFields> {
return {
mode: EntityPrivacyPolicyEvaluationMode.ENFORCE,
};
@@ -192,7 +202,7 @@ export default abstract class EntityPrivacyPolicy<
}
private async authorizeForRulesetAsync(
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity>[],
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
entity: TEntity,
@@ -244,7 +254,7 @@ export default abstract class EntityPrivacyPolicy<
}
private async authorizeForRulesetInnerAsync(
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity>[],
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
entity: TEntity,
+44 -5
View File
@@ -1,3 +1,7 @@
import EntityQueryContextProvider from './EntityQueryContextProvider';
export type PostCommitCallback = (...args: any) => Promise<any>;
/**
* Entity framework representation of transactional and non-transactional database
* query execution units.
@@ -13,16 +17,51 @@ export abstract class EntityQueryContext {
getQueryInterface(): any {
return this.queryInterface;
}
}
export class EntityTransactionalQueryContext extends EntityQueryContext {
isInTransaction(): boolean {
return true;
}
abstract async runInTransactionIfNotInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T>;
}
export class EntityNonTransactionalQueryContext extends EntityQueryContext {
constructor(
queryInterface: any,
private readonly entityQueryContextProvider: EntityQueryContextProvider
) {
super(queryInterface);
}
isInTransaction(): boolean {
return false;
}
async runInTransactionIfNotInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T> {
return await this.entityQueryContextProvider.runInTransactionAsync(transactionScope);
}
}
export class EntityTransactionalQueryContext extends EntityQueryContext {
private readonly postCommitCallbacks: PostCommitCallback[] = [];
public appendPostCommitCallback(callback: PostCommitCallback): void {
this.postCommitCallbacks.push(callback);
}
public async runPostCommitCallbacksAsync(): Promise<void> {
const callbacks = [...this.postCommitCallbacks];
this.postCommitCallbacks.length = 0;
await Promise.all(callbacks.map((callback) => callback()));
}
isInTransaction(): boolean {
return true;
}
async runInTransactionIfNotInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T> {
return await transactionScope(this);
}
}
@@ -0,0 +1,46 @@
import {
EntityTransactionalQueryContext,
EntityNonTransactionalQueryContext,
} from './EntityQueryContext';
/**
* A query context provider vends transactional and non-transactional query contexts.
*/
export default abstract class EntityQueryContextProvider {
/**
* Vend a regular (non-transactional) entity query context.
*/
public getQueryContext(): EntityNonTransactionalQueryContext {
return new EntityNonTransactionalQueryContext(this.getQueryInterface(), this);
}
/**
* Get the query interface for constructing a query context.
*/
protected abstract getQueryInterface(): any;
/**
* Vend a transaction runner for use in {@link runInTransactionAsync}.
*/
protected abstract createTransactionRunner<T>(): (
transactionScope: (queryInterface: any) => Promise<T>
) => Promise<T>;
/**
* Start a transaction and execute the provided transaction-scoped closure within the transaction.
* @param transactionScope - async callback to execute within the transaction
*/
async runInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T> {
const [returnedValue, queryContext] = await this.createTransactionRunner<
[T, EntityTransactionalQueryContext]
>()(async (queryInterface) => {
const queryContext = new EntityTransactionalQueryContext(queryInterface);
const result = await transactionScope(queryContext);
return [result, queryContext];
});
await queryContext.runPostCommitCallbacksAsync();
return returnedValue;
}
}
@@ -1,22 +0,0 @@
import {
EntityNonTransactionalQueryContext,
EntityTransactionalQueryContext,
} from './EntityQueryContext';
/**
* A query context provider vends transactional and non-transactional query contexts.
*/
export default interface IEntityQueryContextProvider {
/**
* Vend a regular (non-transactional) entity query context.
*/
getRegularEntityQueryContext(): EntityNonTransactionalQueryContext;
/**
* Start a transaction and execute the provided transaction-scoped closure within the transaction.
* @param transactionScope - async callback to execute within the transaction
*/
runInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T>;
}
+108 -24
View File
@@ -2,10 +2,12 @@ import invariant from 'invariant';
import { IEntityClass } from './Entity';
import EntityAssociationLoader from './EntityAssociationLoader';
import { EntityCompanionDefinition } from './EntityCompanionProvider';
import EntityLoader from './EntityLoader';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
import { EntityQueryContext } from './EntityQueryContext';
import ViewerContext from './ViewerContext';
import { pick } from './entityUtils';
/**
* A readonly entity exposes only the read functionality of an Entity. Used as the base
@@ -15,8 +17,14 @@ import ViewerContext from './ViewerContext';
* - Entities representing SQL views.
* - Entities representing immutable tables.
*/
export default abstract class ReadonlyEntity<TFields, TID, TViewerContext extends ViewerContext> {
export default abstract class ReadonlyEntity<
TFields,
TID,
TViewerContext extends ViewerContext,
TSelectedFields extends keyof TFields = keyof TFields
> {
private readonly id: TID;
private readonly rawFields: Readonly<Pick<TFields, TSelectedFields>>;
/**
* Constructs an instance of an Entity.
@@ -27,19 +35,37 @@ export default abstract class ReadonlyEntity<TFields, TID, TViewerContext extend
*/
constructor(
private readonly viewerContext: TViewerContext,
private readonly rawFields: Readonly<TFields>
private readonly databaseFields: Readonly<TFields>
) {
const idField = (this.constructor as any).getCompanionDefinition().entityConfiguration
.idField as keyof TFields;
const id = rawFields[idField];
const companionDefinition = (this
.constructor as any).getCompanionDefinition() as EntityCompanionDefinition<
TFields,
TID,
TViewerContext,
this,
EntityPrivacyPolicy<TFields, TID, TViewerContext, this, TSelectedFields>,
TSelectedFields
>;
const idField = companionDefinition.entityConfiguration.idField as keyof Pick<
TFields,
TSelectedFields
>;
const id = databaseFields[idField];
invariant(id, 'must provide ID to create an entity');
this.id = id as any;
const entitySelectedFields = companionDefinition.entitySelectedFields as (keyof TFields)[];
this.rawFields = pick(databaseFields, entitySelectedFields);
}
toString(): string {
return `${this.constructor.name}[${this.getID()}]`;
}
getUniqueIdentifier(): string {
return this.toString();
}
/**
* @returns the ViewerContext authorized to read this entity
*/
@@ -57,7 +83,13 @@ export default abstract class ReadonlyEntity<TFields, TID, TViewerContext extend
/**
* @returns {@link EntityAssociationLoader} for this entity
*/
associationLoader(): EntityAssociationLoader<TFields, TID, TViewerContext, this> {
associationLoader(): EntityAssociationLoader<
TFields,
TID,
TViewerContext,
this,
TSelectedFields
> {
return new EntityAssociationLoader(this);
}
@@ -66,36 +98,59 @@ export default abstract class ReadonlyEntity<TFields, TID, TViewerContext extend
* @param fieldName - the field to get
* @returns the value of the field or undefined if not loaded with that field
*/
getField<K extends keyof TFields>(fieldName: K): TFields[K] {
getField<K extends keyof Pick<TFields, TSelectedFields>>(
fieldName: K
): Pick<TFields, TSelectedFields>[K] {
return this.rawFields[fieldName];
}
/**
* @returns all underlying fields from this entity's data
*/
getAllFields(): Readonly<TFields> {
getAllFields(): Readonly<Pick<TFields, TSelectedFields>> {
return { ...this.rawFields };
}
/**
* @returns all underlying fields from this entity's database data
*/
getAllDatabaseFields(): Readonly<TFields> {
return { ...this.databaseFields };
}
/**
* Get the regular (non-transactional) query context for this entity.
* @param viewerContext - viewer context of calling user
*/
static getRegularEntityQueryContext<
static getQueryContext<
TMFields,
TMID,
TMViewerContext extends ViewerContext,
TMViewerContext2 extends TMViewerContext,
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
viewerContext: TMViewerContext2
): EntityQueryContext {
return viewerContext
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.getRegularEntityQueryContext();
.getQueryContext();
}
/**
@@ -109,17 +164,32 @@ export default abstract class ReadonlyEntity<TFields, TID, TViewerContext extend
TMID,
TMViewerContext extends ViewerContext,
TMViewerContext2 extends TMViewerContext,
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
viewerContext: TMViewerContext2,
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
transactionScope: (queryContext: EntityQueryContext) => Promise<TResult>
): Promise<TResult> {
return await viewerContext
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.runInTransactionAsync(transactionScope);
.getQueryContext()
.runInTransactionIfNotInTransactionAsync(transactionScope);
}
/**
@@ -132,16 +202,30 @@ export default abstract class ReadonlyEntity<TFields, TID, TViewerContext extend
TMID,
TMViewerContext extends ViewerContext,
TMViewerContext2 extends TMViewerContext,
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
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>,
this: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>,
viewerContext: TMViewerContext2,
queryContext: EntityQueryContext = viewerContext
.getViewerScopedEntityCompanionForClass(this)
.getQueryContextProvider()
.getRegularEntityQueryContext()
): EntityLoader<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy> {
.getQueryContext()
): EntityLoader<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
return viewerContext
.getViewerScopedEntityCompanionForClass(this)
.getLoaderFactory()
+25 -4
View File
@@ -29,11 +29,32 @@ export default class ViewerContext {
TMFields,
TMID,
TMViewerContext extends ViewerContext,
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext>,
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity>
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
TMPrivacyPolicy extends EntityPrivacyPolicy<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMSelectedFields
>,
TMSelectedFields extends keyof TMFields
>(
entityClass: IEntityClass<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy>
): ViewerScopedEntityCompanion<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy> {
entityClass: IEntityClass<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
>
): ViewerScopedEntityCompanion<
TMFields,
TMID,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields
> {
return this.viewerScopedEntityCompanionProvider.getViewerScopedCompanionForEntity(
entityClass,
entityClass.getCompanionDefinition()
@@ -1,6 +1,6 @@
import EntityCompanion from './EntityCompanion';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import IEntityQueryContextProvider from './IEntityQueryContextProvider';
import EntityQueryContextProvider from './EntityQueryContextProvider';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
import ViewerScopedEntityLoaderFactory from './ViewerScopedEntityLoaderFactory';
@@ -14,8 +14,15 @@ export default class ViewerScopedEntityCompanion<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
constructor(
private readonly entityCompanion: EntityCompanion<
@@ -23,7 +30,8 @@ export default class ViewerScopedEntityCompanion<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
private readonly viewerContext: TViewerContext
) {}
@@ -36,7 +44,8 @@ export default class ViewerScopedEntityCompanion<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
> {
return new ViewerScopedEntityLoaderFactory(
this.entityCompanion.getLoaderFactory(),
@@ -52,7 +61,8 @@ export default class ViewerScopedEntityCompanion<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
> {
return new ViewerScopedEntityMutatorFactory(
this.entityCompanion.getMutatorFactory(),
@@ -63,7 +73,7 @@ export default class ViewerScopedEntityCompanion<
/**
* Get the query context provider for this entity.
*/
getQueryContextProvider(): IEntityQueryContextProvider {
getQueryContextProvider(): EntityQueryContextProvider {
return this.entityCompanion.getQueryContextProvider();
}
}
@@ -25,18 +25,40 @@ export default class ViewerScopedEntityCompanionProvider {
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
>(
entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy>,
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
entityCompanionDefinition: EntityCompanionDefinition<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>
): ViewerScopedEntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): ViewerScopedEntityCompanion<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
> {
return new ViewerScopedEntityCompanion(
this.entityCompanionProvider.getCompanionForEntity(entityClass, entityCompanionDefinition),
this.viewerContext as TViewerContext
@@ -12,8 +12,15 @@ export default class ViewerScopedEntityLoaderFactory<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
constructor(
private readonly entityLoaderFactory: EntityLoaderFactory<
@@ -21,14 +28,15 @@ export default class ViewerScopedEntityLoaderFactory<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
private readonly viewerContext: TViewerContext
) {}
forLoad(
queryContext: EntityQueryContext
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
}
}
@@ -12,8 +12,15 @@ export default class ViewerScopedEntityMutatorFactory<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>,
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
constructor(
private readonly entityMutatorFactory: EntityMutatorFactory<
@@ -21,28 +28,29 @@ export default class ViewerScopedEntityMutatorFactory<
TID,
TViewerContext,
TEntity,
TPrivacyPolicy
TPrivacyPolicy,
TSelectedFields
>,
private readonly viewerContext: TViewerContext
) {}
forCreate(
queryContext: EntityQueryContext
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return this.entityMutatorFactory.forCreate(this.viewerContext, queryContext);
}
forUpdate(
existingEntity: TEntity,
queryContext: EntityQueryContext
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return this.entityMutatorFactory.forUpdate(existingEntity, queryContext);
}
forDelete(
existingEntity: TEntity,
queryContext: EntityQueryContext
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy> {
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return this.entityMutatorFactory.forDelete(existingEntity, queryContext);
}
}
@@ -7,7 +7,7 @@ import EntityLoader from '../EntityLoader';
describe(EnforcingEntityLoader, () => {
describe('loadManyByFieldEqualingManyAsync', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(entityLoaderMock.loadManyByFieldEqualingManyAsync(anything(), anything())).thenResolve(
new Map(
@@ -24,7 +24,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(entityLoaderMock.loadManyByFieldEqualingManyAsync(anything(), anything())).thenResolve(
new Map(
@@ -49,7 +49,7 @@ describe(EnforcingEntityLoader, () => {
describe('loadManyByFieldEqualingAsync', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(entityLoaderMock.loadManyByFieldEqualingAsync(anything(), anything())).thenResolve([
result(rejection),
@@ -62,7 +62,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(entityLoaderMock.loadManyByFieldEqualingAsync(anything(), anything())).thenResolve([
result(resolved),
@@ -77,7 +77,7 @@ describe(EnforcingEntityLoader, () => {
describe('loadByFieldEqualingAsync', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
result(rejection)
@@ -90,7 +90,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
result(resolved)
@@ -103,7 +103,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns null when result is successful and no entity is found', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = null;
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
result(resolved)
@@ -116,7 +116,7 @@ describe(EnforcingEntityLoader, () => {
});
it('throws when multiple matching entities are found', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const multipleEntitiesError = new Error();
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenReject(
multipleEntitiesError
@@ -131,7 +131,7 @@ describe(EnforcingEntityLoader, () => {
describe('loadByIDAsync', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(entityLoaderMock.loadByIDAsync(anything())).thenResolve(result(rejection));
const entityLoader = instance(entityLoaderMock);
@@ -140,7 +140,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(entityLoaderMock.loadByIDAsync(anything())).thenResolve(result(resolved));
const entityLoader = instance(entityLoaderMock);
@@ -151,7 +151,7 @@ describe(EnforcingEntityLoader, () => {
describe('loadByIDNullableAsync', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(rejection));
const entityLoader = instance(entityLoaderMock);
@@ -162,7 +162,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(resolved));
const entityLoader = instance(entityLoaderMock);
@@ -173,7 +173,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns null when non-existent object', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = null;
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(resolved));
const entityLoader = instance(entityLoaderMock);
@@ -186,7 +186,7 @@ describe(EnforcingEntityLoader, () => {
describe('loadManyByIDsAsync', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(entityLoaderMock.loadManyByIDsAsync(anything())).thenResolve(
new Map(
@@ -201,7 +201,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(entityLoaderMock.loadManyByIDsAsync(anything())).thenResolve(
new Map(
@@ -224,7 +224,7 @@ describe(EnforcingEntityLoader, () => {
describe('loadManyByFieldEqualityConjunction', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(
entityLoaderMock.loadManyByFieldEqualityConjunctionAsync(anything(), anything())
@@ -237,7 +237,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(
entityLoaderMock.loadManyByFieldEqualityConjunctionAsync(anything(), anything())
@@ -252,7 +252,7 @@ describe(EnforcingEntityLoader, () => {
describe('loadManyByRawWhereClause', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(
entityLoaderMock.loadManyByRawWhereClauseAsync(anything(), anything(), anything())
@@ -265,7 +265,7 @@ describe(EnforcingEntityLoader, () => {
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any>>(EntityLoader);
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(
entityLoaderMock.loadManyByRawWhereClauseAsync(anything(), anything(), anything())
@@ -283,7 +283,11 @@ describe(EnforcingEntityLoader, () => {
const loaderProperties = Object.getOwnPropertyNames(EntityLoader.prototype);
// ensure known differences still exist for sanity check
const knownLoaderOnlyDifferences = ['enforcing', 'invalidateFieldsAsync'];
const knownLoaderOnlyDifferences = [
'enforcing',
'invalidateFieldsAsync',
'tryConstructEntities',
];
expect(loaderProperties).toEqual(expect.arrayContaining(knownLoaderOnlyDifferences));
const loaderPropertiesWithoutKnownDifferences = loaderProperties.filter(
+6 -8
View File
@@ -96,6 +96,8 @@ const testEntityConfiguration = new EntityConfiguration<TestEntityFields>({
columnName: 'custom_id',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
@@ -134,13 +136,11 @@ class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, Viewer
}
}
const simpleTestDenyUpdateEntityCompanion = {
const simpleTestDenyUpdateEntityCompanion = new EntityCompanionDefinition({
entityClass: SimpleTestDenyUpdateEntity,
entityConfiguration: testEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: SimpleTestDenyUpdateEntityPrivacyPolicy,
};
});
class SimpleTestDenyDeleteEntity extends Entity<TestEntityFields, string, ViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
@@ -154,10 +154,8 @@ class SimpleTestDenyDeleteEntity extends Entity<TestEntityFields, string, Viewer
}
}
const simpleTestDenyDeleteEntityCompanion = {
const simpleTestDenyDeleteEntityCompanion = new EntityCompanionDefinition({
entityClass: SimpleTestDenyDeleteEntity,
entityConfiguration: testEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: SimpleTestDenyDeleteEntityPrivacyPolicy,
};
});
@@ -1,6 +1,7 @@
import { enforceAsyncResult } from '@expo/results';
import EntityAssociationLoader from '../EntityAssociationLoader';
import { enforceResultsAsync } from '../entityUtils';
import TestEntity from '../testfixtures/TestEntity';
import TestEntity2 from '../testfixtures/TestEntity2';
import TestViewerContext from '../testfixtures/TestViewerContext';
@@ -26,8 +27,28 @@ describe(EntityAssociationLoader, () => {
});
});
describe('loadRelatedEntityByFieldEqualingAsync', () => {
it('loads associated entities by field equaling', async () => {
describe('loadManyAssociatedEntitiesAsync', () => {
it('loads many associated entities referencing this entity', async () => {
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const testEntity = await enforceAsyncResult(TestEntity.creator(viewerContext).createAsync());
const testOtherEntity1 = await enforceAsyncResult(
TestEntity.creator(viewerContext).setField('stringField', testEntity.getID()).createAsync()
);
const testOtherEntity2 = await enforceAsyncResult(
TestEntity.creator(viewerContext).setField('stringField', testEntity.getID()).createAsync()
);
const loaded = await enforceResultsAsync(
testEntity.associationLoader().loadManyAssociatedEntitiesAsync(TestEntity, 'stringField')
);
expect(loaded).toHaveLength(2);
expect(loaded.find((e) => e.getID() === testOtherEntity1.getID())).not.toBeUndefined();
expect(loaded.find((e) => e.getID() === testOtherEntity2.getID())).not.toBeUndefined();
});
});
describe('loadAssociatedEntityByFieldEqualingAsync', () => {
it('loads associated entity by field equaling', async () => {
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const testOtherEntity = await enforceAsyncResult(
@@ -57,6 +78,32 @@ describe(EntityAssociationLoader, () => {
});
});
describe('loadManyAssociatedEntitiesByFieldEqualingAsync', () => {
it('loads many associated entities by field equaling', async () => {
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const testEntity = await enforceAsyncResult(TestEntity.creator(viewerContext).createAsync());
const testOtherEntity1 = await enforceAsyncResult(
TestEntity.creator(viewerContext).setField('stringField', testEntity.getID()).createAsync()
);
const testOtherEntity2 = await enforceAsyncResult(
TestEntity.creator(viewerContext).setField('stringField', testEntity.getID()).createAsync()
);
const loaded = await enforceResultsAsync(
testEntity
.associationLoader()
.loadManyAssociatedEntitiesByFieldEqualingAsync(
'customIdField',
TestEntity,
'stringField'
)
);
expect(loaded).toHaveLength(2);
expect(loaded.find((e) => e.getID() === testOtherEntity1.getID())).not.toBeUndefined();
expect(loaded.find((e) => e.getID() === testOtherEntity2.getID())).not.toBeUndefined();
});
});
describe('loadAssociatedEntityThroughAsync', () => {
it('chain loads associated entities', async () => {
const companionProvider = createUnitTestEntityCompanionProvider();
@@ -86,7 +86,7 @@ class BlahEntityPrivacyPolicy extends EntityPrivacyPolicy<
];
}
const blahCompanion = {
const blahCompanion = new EntityCompanionDefinition({
entityClass: BlahEntity,
entityConfiguration: new EntityConfiguration<BlahFields>({
idField: 'id',
@@ -100,11 +100,11 @@ const blahCompanion = {
columnName: 'owner_id',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
}),
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: BlahEntityPrivacyPolicy,
};
});
it('runs through a common workflow', async () => {
// will be one entity companion provider for each request, so
@@ -1,26 +1,26 @@
import { instance, mock } from 'ts-mockito';
import { instance, mock, when } from 'ts-mockito';
import EntityCompanion from '../EntityCompanion';
import EntityLoaderFactory from '../EntityLoaderFactory';
import EntityMutatorFactory from '../EntityMutatorFactory';
import IEntityQueryContextProvider from '../IEntityQueryContextProvider';
import EntityTableDataCoordinator from '../internal/EntityTableDataCoordinator';
import IEntityMetricsAdapter from '../metrics/IEntityMetricsAdapter';
import TestEntity, {
TestEntityPrivacyPolicy,
testEntityConfiguration,
} from '../testfixtures/TestEntity';
import { NoCacheStubCacheAdapterProvider } from '../utils/testing/StubCacheAdapter';
import StubDatabaseAdapterProvider from '../utils/testing/StubDatabaseAdapterProvider';
describe(EntityCompanion, () => {
it('correctly instantiates mutator and loader factories', () => {
const tableDataCoordinatorMock = mock(EntityTableDataCoordinator);
when(tableDataCoordinatorMock.entityConfiguration).thenReturn(testEntityConfiguration);
const companion = new EntityCompanion(
TestEntity,
testEntityConfiguration,
new StubDatabaseAdapterProvider(),
new NoCacheStubCacheAdapterProvider(),
instance(tableDataCoordinatorMock),
TestEntityPrivacyPolicy,
instance(mock<IEntityQueryContextProvider>()),
[],
{},
instance(mock<IEntityMetricsAdapter>())
);
expect(companion.getLoaderFactory()).toBeInstanceOf(EntityLoaderFactory);
@@ -22,6 +22,8 @@ const blahConfiguration = new EntityConfiguration<BlahFields>({
columnName: 'hello',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
class Blah1Entity extends Entity<BlahFields, string, ViewerContext> {
@@ -61,24 +63,20 @@ class NoOpTest2PrivacyPolicy extends EntityPrivacyPolicy<
Blah2Entity
> {}
const blah1CompanionDefinition = {
const blah1CompanionDefinition = new EntityCompanionDefinition({
entityClass: Blah1Entity,
entityConfiguration: blahConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: NoOpTest1PrivacyPolicy,
};
});
const blah2CompanionDefinition = {
const blah2CompanionDefinition = new EntityCompanionDefinition({
entityClass: Blah2Entity,
entityConfiguration: blahConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: NoOpTest2PrivacyPolicy,
};
});
describe(EntityCompanionProvider, () => {
it('returns different instances for different entity types', () => {
it('returns different instances for different entity types, but share table data coordinators', () => {
const entityCompanionProvider = createUnitTestEntityCompanionProvider();
const companion1 = entityCompanionProvider.getCompanionForEntity(
Blah1Entity,
@@ -91,5 +89,6 @@ describe(EntityCompanionProvider, () => {
);
expect(companion1).not.toEqual(companion2);
expect(companion1['tableDataCoordinator']).toEqual(companion2['tableDataCoordinator']);
});
});
@@ -1,3 +1,4 @@
import { DatabaseAdapterFlavor, CacheAdapterFlavor } from '../EntityCompanionProvider';
import EntityConfiguration from '../EntityConfiguration';
import { UUIDField, StringField } from '../EntityFields';
@@ -27,11 +28,15 @@ describe(EntityConfiguration, () => {
columnName: 'unique_but_not_cacheable',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
it('returns correct fields', () => {
expect(blahEntityConfiguration.idField).toEqual('id');
expect(blahEntityConfiguration.tableName).toEqual('blah_table');
expect(blahEntityConfiguration.databaseAdapterFlavor).toEqual(DatabaseAdapterFlavor.POSTGRES);
expect(blahEntityConfiguration.cacheAdapterFlavor).toEqual(CacheAdapterFlavor.REDIS);
});
it('filters cacheable fields', () => {
@@ -48,6 +53,8 @@ describe(EntityConfiguration, () => {
columnName: 'id',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
expect(entityConfiguration.cacheKeyVersion).toEqual(0);
});
@@ -61,6 +68,8 @@ describe(EntityConfiguration, () => {
columnName: 'id',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
cacheKeyVersion: 100,
});
expect(entityConfiguration.cacheKeyVersion).toEqual(100);
@@ -209,14 +209,6 @@ describe(EntityDatabaseAdapter, () => {
});
describe('deleteAsync', () => {
it('throws when update result count zero', async () => {
const queryContext = instance(mock(EntityQueryContext));
const adapter = new TestEntityDatabaseAdapter({ deleteCount: 0 });
await expect(adapter.deleteAsync(queryContext, 'customIdField', 'wat')).rejects.toThrowError(
'No deletions from database adapter delet'
);
});
it('throws when update result count greater than 1', async () => {
const queryContext = instance(mock(EntityQueryContext));
const adapter = new TestEntityDatabaseAdapter({ deleteCount: 2 });
@@ -0,0 +1,319 @@
import Entity from '../Entity';
import {
DatabaseAdapterFlavor,
CacheAdapterFlavor,
EntityCompanionDefinition,
} from '../EntityCompanionProvider';
import EntityConfiguration from '../EntityConfiguration';
import { UUIDField, EntityEdgeDeletionBehavior } from '../EntityFields';
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
import { CacheStatus } from '../internal/ReadThroughEntityCache';
import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
import TestViewerContext from '../testfixtures/TestViewerContext';
import { InMemoryFullCacheStubCacheAdapter } from '../utils/testing/StubCacheAdapter';
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
interface ParentFields {
id: string;
}
interface ChildFields {
id: string;
parent_id: string;
}
interface GrandChildFields {
id: string;
parent_id: string;
}
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
any,
string,
TestViewerContext,
any,
any
> {
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
}
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
class ParentEntity extends Entity<ParentFields, string, TestViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
ParentFields,
string,
TestViewerContext,
ParentEntity,
TestEntityPrivacyPolicy
> {
return parentEntityCompanion;
}
}
class ChildEntity extends Entity<ChildFields, string, TestViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
ChildFields,
string,
TestViewerContext,
ChildEntity,
TestEntityPrivacyPolicy
> {
return childEntityCompanion;
}
}
class GrandChildEntity extends Entity<GrandChildFields, string, TestViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
GrandChildFields,
string,
TestViewerContext,
GrandChildEntity,
TestEntityPrivacyPolicy
> {
return grandChildEntityCompanion;
}
}
const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
idField: 'id',
tableName: 'parents',
inboundEdges: [ChildEntity],
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const childEntityConfiguration = new EntityConfiguration<ChildFields>({
idField: 'id',
tableName: 'children',
inboundEdges: [GrandChildEntity],
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
parent_id: new UUIDField({
columnName: 'parent_id',
cache: true,
association: {
associatedEntityClass: ParentEntity,
edgeDeletionBehavior,
},
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const grandChildEntityConfiguration = new EntityConfiguration<GrandChildFields>({
idField: 'id',
tableName: 'grandchildren',
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
parent_id: new UUIDField({
columnName: 'parent_id',
cache: true,
association: {
associatedEntityClass: ChildEntity,
edgeDeletionBehavior,
},
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const parentEntityCompanion = new EntityCompanionDefinition({
entityClass: ParentEntity,
entityConfiguration: parentEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
const childEntityCompanion = new EntityCompanionDefinition({
entityClass: ChildEntity,
entityConfiguration: childEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
const grandChildEntityCompanion = new EntityCompanionDefinition({
entityClass: GrandChildEntity,
entityConfiguration: grandChildEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
return {
ParentEntity,
ChildEntity,
GrandChildEntity,
};
};
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
it('deletes', async () => {
const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
EntityEdgeDeletionBehavior.CASCADE_DELETE
);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
const child = await ChildEntity.creator(viewerContext)
.setField('parent_id', parent.getID())
.enforceCreateAsync();
const grandchild = await GrandChildEntity.creator(viewerContext)
.setField('parent_id', child.getID())
.enforceCreateAsync();
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull();
await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
).resolves.not.toBeNull();
await expect(
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
).resolves.not.toBeNull();
await ParentEntity.enforceDeleteAsync(parent);
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.toBeNull();
await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
).resolves.toBeNull();
await expect(
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
).resolves.toBeNull();
});
});
describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
it('sets null', async () => {
const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
EntityEdgeDeletionBehavior.SET_NULL
);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
const child = await ChildEntity.creator(viewerContext)
.setField('parent_id', parent.getID())
.enforceCreateAsync();
const grandchild = await GrandChildEntity.creator(viewerContext)
.setField('parent_id', child.getID())
.enforceCreateAsync();
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull();
await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
).resolves.not.toBeNull();
await expect(
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
).resolves.not.toBeNull();
await ParentEntity.enforceDeleteAsync(parent);
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.toBeNull();
const loadedChild = await ChildEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(child.getID());
expect(loadedChild.getField('parent_id')).toBeNull();
const loadedGrandchild = await GrandChildEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(grandchild.getID());
expect(loadedGrandchild.getField('parent_id')).toEqual(loadedChild.getID());
});
});
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
it('invalidates the cache', async () => {
const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE
);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
const child = await ChildEntity.creator(viewerContext)
.setField('parent_id', parent.getID())
.enforceCreateAsync();
const grandchild = await GrandChildEntity.creator(viewerContext)
.setField('parent_id', child.getID())
.enforceCreateAsync();
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull();
await expect(
ChildEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_id', parent.getID())
).resolves.not.toBeNull();
await expect(
GrandChildEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_id', child.getID())
).resolves.not.toBeNull();
const childCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(ChildEntity)[
'entityCompanion'
]['tableDataCoordinator']['cacheAdapter'] as InMemoryFullCacheStubCacheAdapter<ChildFields>;
const childCachedBefore = await childCacheAdapter.loadManyAsync('parent_id', [
parent.getID(),
]);
expect(childCachedBefore.get(parent.getID())?.status).toEqual(CacheStatus.HIT);
const grandChildCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
GrandChildEntity
)['entityCompanion']['tableDataCoordinator'][
'cacheAdapter'
] as InMemoryFullCacheStubCacheAdapter<ChildFields>;
const grandChildCachedBefore = await grandChildCacheAdapter.loadManyAsync('parent_id', [
child.getID(),
]);
expect(grandChildCachedBefore.get(child.getID())?.status).toEqual(CacheStatus.HIT);
await ParentEntity.enforceDeleteAsync(parent);
const childCachedAfter = await childCacheAdapter.loadManyAsync('parent_id', [parent.getID()]);
expect(childCachedAfter.get(parent.getID())?.status).toEqual(CacheStatus.MISS);
const grandChildCachedAfter = await grandChildCacheAdapter.loadManyAsync('parent_id', [
child.getID(),
]);
expect(grandChildCachedAfter.get(child.getID())?.status).toEqual(CacheStatus.MISS);
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.toBeNull();
await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
).resolves.not.toBeNull();
await expect(
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
).resolves.not.toBeNull();
});
});
});
@@ -1,6 +1,6 @@
import { EntityFieldDefinition } from '../EntityFields';
class TestFieldDefinition extends EntityFieldDefinition<any> {}
class TestFieldDefinition extends EntityFieldDefinition {}
describe(EntityFieldDefinition, () => {
it('returns correct column name and defaults cache to false', () => {
@@ -12,21 +12,4 @@ describe(EntityFieldDefinition, () => {
expect(fieldDefinition2.columnName).toEqual('wat');
expect(fieldDefinition2.cache).toEqual(true);
});
it('defaults validator to no-op', () => {
const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
expect(fieldDefinition.validator).toEqual({});
const fn = async (): Promise<void> => {
throw new Error();
};
const fieldDefinition2 = new TestFieldDefinition({
columnName: 'wat',
cache: true,
validator: {
write: fn,
},
});
expect(fieldDefinition2.validator.write).toEqual(fn);
});
});
@@ -2,7 +2,6 @@ import { enforceAsyncResult } from '@expo/results';
import { mock, instance, verify, spy, deepEqual, anyOfClass, anything, when } from 'ts-mockito';
import EntityLoader from '../EntityLoader';
import { EntityNonTransactionalQueryContext } from '../EntityQueryContext';
import ViewerContext from '../ViewerContext';
import { enforceResultsAsync } from '../entityUtils';
import EntityDataManager from '../internal/EntityDataManager';
@@ -21,7 +20,7 @@ describe(EntityLoader, () => {
it('loads entities', async () => {
const dateToInsert = new Date();
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
testEntityConfiguration,
@@ -63,7 +62,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader(
viewerContext,
queryContext,
testEntityConfiguration,
testEntityConfiguration.idField,
TestEntity,
privacyPolicy,
dataManager
@@ -96,7 +95,7 @@ describe(EntityLoader, () => {
const privacyPolicy = new TestEntityPrivacyPolicy();
const spiedPrivacyPolicy = spy(privacyPolicy);
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
testEntityConfiguration,
@@ -144,7 +143,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader(
viewerContext,
queryContext,
testEntityConfiguration,
testEntityConfiguration.idField,
TestEntity,
privacyPolicy,
dataManager
@@ -172,7 +171,7 @@ describe(EntityLoader, () => {
const spiedPrivacyPolicy = spy(privacyPolicy);
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
testEntityConfiguration,
@@ -206,7 +205,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader(
viewerContext,
queryContext,
testEntityConfiguration,
testEntityConfiguration.idField,
TestEntity,
privacyPolicy,
dataManager
@@ -217,7 +216,7 @@ describe(EntityLoader, () => {
it('invalidates upon invalidate one', async () => {
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
const dataManagerMock = mock(EntityDataManager);
const dataManagerInstance = instance(dataManagerMock);
@@ -225,7 +224,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader(
viewerContext,
queryContext,
testEntityConfiguration,
testEntityConfiguration.idField,
TestEntity,
privacyPolicy,
dataManagerInstance
@@ -239,7 +238,7 @@ describe(EntityLoader, () => {
it('invalidates upon invalidate by field', async () => {
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
const dataManagerMock = mock(EntityDataManager);
const dataManagerInstance = instance(dataManagerMock);
@@ -247,7 +246,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader(
viewerContext,
queryContext,
testEntityConfiguration,
testEntityConfiguration.idField,
TestEntity,
privacyPolicy,
dataManagerInstance
@@ -260,7 +259,7 @@ describe(EntityLoader, () => {
it('returns error result when not allowed', async () => {
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicyMock = mock(TestEntityPrivacyPolicy);
const dataManagerMock = mock(EntityDataManager);
@@ -280,7 +279,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader(
viewerContext,
queryContext,
testEntityConfiguration,
testEntityConfiguration.idField,
TestEntity,
privacyPolicy,
dataManagerInstance
@@ -294,7 +293,7 @@ describe(EntityLoader, () => {
it('throws upon database adapter error', async () => {
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
const dataManagerMock = mock(EntityDataManager);
@@ -309,7 +308,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader(
viewerContext,
queryContext,
testEntityConfiguration,
testEntityConfiguration.idField,
TestEntity,
privacyPolicy,
dataManagerInstance
@@ -12,8 +12,13 @@ import {
import EntityDatabaseAdapter from '../EntityDatabaseAdapter';
import EntityLoaderFactory from '../EntityLoaderFactory';
import EntityMutationTriggerConfiguration, {
EntityMutationTrigger,
EntityNonTransactionalMutationTrigger,
} from '../EntityMutationTriggerConfiguration';
import EntityMutationValidator from '../EntityMutationValidator';
import EntityMutatorFactory from '../EntityMutatorFactory';
import { EntityQueryContext, EntityNonTransactionalQueryContext } from '../EntityQueryContext';
import { EntityTransactionalQueryContext, EntityQueryContext } from '../EntityQueryContext';
import ViewerContext from '../ViewerContext';
import { enforceResultsAsync } from '../entityUtils';
import EntityDataManager from '../internal/EntityDataManager';
@@ -30,15 +35,165 @@ import TestEntity, {
TestEntityPrivacyPolicy,
testEntityConfiguration,
} from '../testfixtures/TestEntity';
import ValidationTestEntity, {
ValidationTestEntityPrivacyPolicy,
ValidationTestFields,
validationTestEntityConfiguration,
} from '../testfixtures/ValidationTestEntity';
import { NoCacheStubCacheAdapterProvider } from '../utils/testing/StubCacheAdapter';
import StubDatabaseAdapter from '../utils/testing/StubDatabaseAdapter';
import StubQueryContextProvider from '../utils/testing/StubQueryContextProvider';
class TestMutationTrigger extends EntityMutationTrigger<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
> {
async executeAsync(
_viewerContext: ViewerContext,
_queryContext: EntityQueryContext,
_entity: TestEntity
): Promise<void> {}
}
class TestNonTransactionalMutationTrigger extends EntityNonTransactionalMutationTrigger<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
> {
async executeAsync(_viewerContext: ViewerContext, _entity: TestEntity): Promise<void> {}
}
const setUpMutationValidatorSpies = (
mutationValidators: EntityMutationValidator<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
>[]
): EntityMutationValidator<TestFields, string, ViewerContext, TestEntity, keyof TestFields>[] => {
return mutationValidators.map((validator) => spy(validator));
};
const verifyValidatorCounts = (
viewerContext: ViewerContext,
mutationValidatorSpies: EntityMutationValidator<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
>[],
expectedCalls: number
): void => {
for (const validator of mutationValidatorSpies) {
verify(
validator.executeAsync(
viewerContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(TestEntity)
)
).times(expectedCalls);
}
};
const setUpMutationTriggerSpies = (
mutationTriggers: EntityMutationTriggerConfiguration<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
>
): EntityMutationTriggerConfiguration<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
> => {
return {
beforeCreate: [spy(mutationTriggers.beforeCreate![0])],
afterCreate: [spy(mutationTriggers.afterCreate![0])],
beforeUpdate: [spy(mutationTriggers.beforeUpdate![0])],
afterUpdate: [spy(mutationTriggers.afterUpdate![0])],
beforeDelete: [spy(mutationTriggers.beforeDelete![0])],
afterDelete: [spy(mutationTriggers.afterDelete![0])],
beforeAll: [spy(mutationTriggers.beforeAll![0])],
afterAll: [spy(mutationTriggers.afterAll![0])],
afterCommit: [spy(mutationTriggers.afterCommit![0])],
};
};
const verifyTriggerCounts = (
viewerContext: ViewerContext,
mutationTriggerSpies: EntityMutationTriggerConfiguration<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
>,
executed: Record<
keyof Pick<
EntityMutationTriggerConfiguration<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
>,
| 'beforeCreate'
| 'afterCreate'
| 'beforeUpdate'
| 'afterUpdate'
| 'beforeDelete'
| 'afterDelete'
>,
boolean
>
): void => {
Object.keys(executed).forEach((s) => {
if ((executed as any)[s]) {
verify(
(mutationTriggerSpies as any)[s]![0].executeAsync(
viewerContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(TestEntity)
)
).once();
} else {
verify(
(mutationTriggerSpies as any)[s]![0].executeAsync(
viewerContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(TestEntity)
)
).never();
}
});
verify(
mutationTriggerSpies.beforeAll![0].executeAsync(
viewerContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(TestEntity)
)
).once();
verify(
mutationTriggerSpies.afterAll![0].executeAsync(
viewerContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(TestEntity)
)
).once();
verify(
mutationTriggerSpies.afterCommit![0].executeAsync(viewerContext, anyOfClass(TestEntity))
).once();
};
const createEntityMutatorFactory = (
existingObjects: TestFields[]
): {
@@ -48,7 +203,8 @@ const createEntityMutatorFactory = (
string,
ViewerContext,
TestEntity,
TestEntityPrivacyPolicy
TestEntityPrivacyPolicy,
keyof TestFields
>;
entityMutatorFactory: EntityMutatorFactory<
TestFields,
@@ -58,7 +214,45 @@ const createEntityMutatorFactory = (
TestEntityPrivacyPolicy
>;
metricsAdapter: IEntityMetricsAdapter;
mutationValidators: EntityMutationValidator<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
>[];
mutationTriggers: EntityMutationTriggerConfiguration<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
>;
} => {
const mutationValidators: EntityMutationValidator<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
>[] = [new TestMutationTrigger()];
const mutationTriggers: EntityMutationTriggerConfiguration<
TestFields,
string,
ViewerContext,
TestEntity,
keyof TestFields
> = {
beforeCreate: [new TestMutationTrigger()],
afterCreate: [new TestMutationTrigger()],
beforeUpdate: [new TestMutationTrigger()],
afterUpdate: [new TestMutationTrigger()],
beforeDelete: [new TestMutationTrigger()],
afterDelete: [new TestMutationTrigger()],
beforeAll: [new TestMutationTrigger()],
afterAll: [new TestMutationTrigger()],
afterCommit: [new TestNonTransactionalMutationTrigger()],
};
const privacyPolicy = new TestEntityPrivacyPolicy();
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
testEntityConfiguration,
@@ -78,7 +272,7 @@ const createEntityMutatorFactory = (
metricsAdapter
);
const entityLoaderFactory = new EntityLoaderFactory(
testEntityConfiguration,
testEntityConfiguration.idField,
TestEntity,
privacyPolicy,
dataManager
@@ -87,6 +281,8 @@ const createEntityMutatorFactory = (
testEntityConfiguration,
TestEntity,
privacyPolicy,
mutationValidators,
mutationTriggers,
entityLoaderFactory,
databaseAdapter,
metricsAdapter
@@ -96,49 +292,148 @@ const createEntityMutatorFactory = (
entityLoaderFactory,
entityMutatorFactory,
metricsAdapter,
mutationValidators,
mutationTriggers,
};
};
describe(EntityMutatorFactory, () => {
it('creates entities checks privacy', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = mock<EntityQueryContext>();
const { privacyPolicy, entityMutatorFactory } = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
testIndexedField: '4',
numberField: 1,
dateField: new Date(),
},
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '5',
numberField: 1,
dateField: new Date(),
},
]);
describe('forCreate', () => {
it('creates entities', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const { entityMutatorFactory } = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
testIndexedField: '4',
numberField: 1,
dateField: new Date(),
},
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '5',
numberField: 1,
dateField: new Date(),
},
]);
const newEntity = await entityMutatorFactory
.forCreate(viewerContext, queryContext)
.setField('stringField', 'huh')
.enforceCreateAsync();
expect(newEntity).toBeTruthy();
});
const spiedPrivacyPolicy = spy(privacyPolicy);
it('checks privacy', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const { privacyPolicy, entityMutatorFactory } = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
testIndexedField: '4',
numberField: 1,
dateField: new Date(),
},
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '5',
numberField: 1,
dateField: new Date(),
},
]);
const newEntity = await entityMutatorFactory
.forCreate(viewerContext, queryContext)
.setField('stringField', 'huh')
.enforceCreateAsync();
const spiedPrivacyPolicy = spy(privacyPolicy);
expect(newEntity).toBeTruthy();
await entityMutatorFactory
.forCreate(viewerContext, queryContext)
.setField('stringField', 'huh')
.enforceCreateAsync();
verify(
spiedPrivacyPolicy.authorizeCreateAsync(viewerContext, queryContext, anyOfClass(TestEntity))
).once();
verify(
spiedPrivacyPolicy.authorizeCreateAsync(
viewerContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(TestEntity)
)
).once();
});
it('executes triggers', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const { mutationTriggers, entityMutatorFactory } = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
testIndexedField: '4',
numberField: 1,
dateField: new Date(),
},
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '5',
numberField: 1,
dateField: new Date(),
},
]);
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
await entityMutatorFactory
.forCreate(viewerContext, queryContext)
.setField('stringField', 'huh')
.enforceCreateAsync();
verifyTriggerCounts(viewerContext, triggerSpies, {
beforeCreate: true,
afterCreate: true,
beforeUpdate: false,
afterUpdate: false,
beforeDelete: false,
afterDelete: false,
});
});
it('executes validators', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const { mutationValidators, entityMutatorFactory } = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
testIndexedField: '4',
numberField: 1,
dateField: new Date(),
},
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '5',
numberField: 1,
dateField: new Date(),
},
]);
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
await entityMutatorFactory
.forCreate(viewerContext, queryContext)
.setField('stringField', 'huh')
.enforceCreateAsync();
verifyValidatorCounts(viewerContext, validatorSpies, 1);
});
});
it('updates entities and checks privacy', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = mock<EntityQueryContext>();
const { privacyPolicy, entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory(
[
describe('forUpdate', () => {
it('updates entities', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
@@ -153,39 +448,160 @@ describe(EntityMutatorFactory, () => {
numberField: 3,
dateField: new Date(),
},
]
);
]);
const spiedPrivacyPolicy = spy(privacyPolicy);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
const updatedEntity = await entityMutatorFactory
.forUpdate(existingEntity, queryContext)
.setField('stringField', 'huh2')
.enforceUpdateAsync();
const updatedEntity = await entityMutatorFactory
.forUpdate(existingEntity, queryContext)
.setField('stringField', 'huh2')
.enforceUpdateAsync();
expect(updatedEntity).toBeTruthy();
expect(updatedEntity.getAllFields()).not.toMatchObject(existingEntity.getAllFields());
expect(updatedEntity.getField('stringField')).toEqual('huh2');
expect(updatedEntity).toBeTruthy();
expect(updatedEntity.getAllFields()).not.toMatchObject(existingEntity.getAllFields());
expect(updatedEntity.getField('stringField')).toEqual('huh2');
const reloadedEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
expect(reloadedEntity.getAllFields()).toMatchObject(updatedEntity.getAllFields());
});
const reloadedEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
expect(reloadedEntity.getAllFields()).toMatchObject(updatedEntity.getAllFields());
it('checks privacy', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const {
privacyPolicy,
entityMutatorFactory,
entityLoaderFactory,
} = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
testIndexedField: '3',
numberField: 3,
dateField: new Date(),
},
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '4',
numberField: 3,
dateField: new Date(),
},
]);
verify(
spiedPrivacyPolicy.authorizeUpdateAsync(viewerContext, queryContext, anyOfClass(TestEntity))
).once();
const spiedPrivacyPolicy = spy(privacyPolicy);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
await entityMutatorFactory
.forUpdate(existingEntity, queryContext)
.setField('stringField', 'huh2')
.enforceUpdateAsync();
verify(
spiedPrivacyPolicy.authorizeUpdateAsync(
viewerContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(TestEntity)
)
).once();
});
it('executes triggers', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const {
mutationTriggers,
entityMutatorFactory,
entityLoaderFactory,
} = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
testIndexedField: '3',
numberField: 3,
dateField: new Date(),
},
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '4',
numberField: 3,
dateField: new Date(),
},
]);
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
await entityMutatorFactory
.forUpdate(existingEntity, queryContext)
.setField('stringField', 'huh2')
.enforceUpdateAsync();
verifyTriggerCounts(viewerContext, triggerSpies, {
beforeCreate: false,
afterCreate: false,
beforeUpdate: true,
afterUpdate: true,
beforeDelete: false,
afterDelete: false,
});
});
it('executes validators', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const {
mutationValidators,
entityMutatorFactory,
entityLoaderFactory,
} = createEntityMutatorFactory([
{
customIdField: 'hello',
stringField: 'huh',
testIndexedField: '3',
numberField: 3,
dateField: new Date(),
},
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '4',
numberField: 3,
dateField: new Date(),
},
]);
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
await entityMutatorFactory
.forUpdate(existingEntity, queryContext)
.setField('stringField', 'huh2')
.enforceUpdateAsync();
verifyValidatorCounts(viewerContext, validatorSpies, 1);
});
});
it('deletes entities and checks privacy', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = mock<EntityQueryContext>();
const { privacyPolicy, entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory(
[
describe('forDelete', () => {
it('deletes entities', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
{
customIdField: 'world',
stringField: 'huh',
@@ -193,32 +609,123 @@ describe(EntityMutatorFactory, () => {
numberField: 3,
dateField: new Date(),
},
]
);
]);
const spiedPrivacyPolicy = spy(privacyPolicy);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
expect(existingEntity).toBeTruthy();
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
await expect(
enforceAsyncResult(
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
)
).rejects.toBeInstanceOf(Error);
);
expect(existingEntity).toBeTruthy();
verify(
spiedPrivacyPolicy.authorizeDeleteAsync(viewerContext, queryContext, anyOfClass(TestEntity))
).once();
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
await expect(
enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
)
).rejects.toBeInstanceOf(Error);
});
it('checks privacy', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const {
privacyPolicy,
entityMutatorFactory,
entityLoaderFactory,
} = createEntityMutatorFactory([
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '3',
numberField: 3,
dateField: new Date(),
},
]);
const spiedPrivacyPolicy = spy(privacyPolicy);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
verify(
spiedPrivacyPolicy.authorizeDeleteAsync(
viewerContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(TestEntity)
)
).once();
});
it('executes triggers', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const {
mutationTriggers,
entityMutatorFactory,
entityLoaderFactory,
} = createEntityMutatorFactory([
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '3',
numberField: 3,
dateField: new Date(),
},
]);
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
verifyTriggerCounts(viewerContext, triggerSpies, {
beforeCreate: false,
afterCreate: false,
beforeUpdate: false,
afterUpdate: false,
beforeDelete: true,
afterDelete: true,
});
});
it('does not execute validators', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const {
mutationValidators,
entityMutatorFactory,
entityLoaderFactory,
} = createEntityMutatorFactory([
{
customIdField: 'world',
stringField: 'huh',
testIndexedField: '3',
numberField: 3,
dateField: new Date(),
},
]);
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
);
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
verifyValidatorCounts(viewerContext, validatorSpies, 0);
});
});
it('invalidates cache for fields upon create', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = mock<EntityQueryContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
{
customIdField: 'world',
@@ -251,76 +758,9 @@ describe(EntityMutatorFactory, () => {
expect(entities2).toHaveLength(2);
});
it('returns error when field not valid', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = mock<EntityQueryContext>();
const privacyPolicy = new ValidationTestEntityPrivacyPolicy();
const databaseAdapter = new StubDatabaseAdapter<ValidationTestFields>(
validationTestEntityConfiguration,
StubDatabaseAdapter.convertFieldObjectsToDataStore(
validationTestEntityConfiguration,
new Map([[validationTestEntityConfiguration.tableName, []]])
)
);
const metricsAdapter = new NoOpEntityMetricsAdapter();
const cacheAdapterProvider = new NoCacheStubCacheAdapterProvider();
const cacheAdapter = cacheAdapterProvider.getCacheAdapter(validationTestEntityConfiguration);
const entityCache = new ReadThroughEntityCache<ValidationTestFields>(
validationTestEntityConfiguration,
cacheAdapter
);
const dataManager = new EntityDataManager(
databaseAdapter,
entityCache,
StubQueryContextProvider,
metricsAdapter
);
const entityLoaderFactory = new EntityLoaderFactory(
validationTestEntityConfiguration,
ValidationTestEntity,
privacyPolicy,
dataManager
);
const entityMutatorFactory = new EntityMutatorFactory(
validationTestEntityConfiguration,
ValidationTestEntity,
privacyPolicy,
entityLoaderFactory,
databaseAdapter,
metricsAdapter
);
const entityCreateInvalidResult = await entityMutatorFactory
.forCreate(viewerContext, queryContext)
.setField('numberOtherThanTen', 10)
.createAsync();
expect(entityCreateInvalidResult.ok).toBe(false);
expect(entityCreateInvalidResult.reason?.message).toEqual('should not be ten');
const entityCreateValidResult = await entityMutatorFactory
.forCreate(viewerContext, queryContext)
.setField('numberOtherThanTen', 11)
.createAsync();
expect(entityCreateValidResult.ok).toBe(true);
const entityUpdateInvalidResult = await entityMutatorFactory
.forUpdate(entityCreateValidResult.enforceValue(), queryContext)
.setField('numberOtherThanTen', 10)
.updateAsync();
expect(entityUpdateInvalidResult.ok).toBe(false);
expect(entityUpdateInvalidResult.reason?.message).toEqual('should not be ten');
const entityUpdateValidResult = await entityMutatorFactory
.forUpdate(entityCreateValidResult.enforceValue(), queryContext)
.setField('numberOtherThanTen', 12)
.updateAsync();
expect(entityUpdateValidResult.ok).toBe(true);
});
it('returns error result when not authorized to create', async () => {
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicyMock = mock(SimpleTestEntityPrivacyPolicy);
const databaseAdapter = instance(mock(EntityDatabaseAdapter));
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
@@ -331,7 +771,8 @@ describe(EntityMutatorFactory, () => {
string,
ViewerContext,
SimpleTestEntity,
SimpleTestEntityPrivacyPolicy
SimpleTestEntityPrivacyPolicy,
keyof SimpleTestFields
>
>(EntityLoaderFactory)
);
@@ -341,21 +782,21 @@ describe(EntityMutatorFactory, () => {
when(
privacyPolicyMock.authorizeCreateAsync(
viewerContext,
queryContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(SimpleTestEntity)
)
).thenReject(rejectionError);
when(
privacyPolicyMock.authorizeUpdateAsync(
viewerContext,
queryContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(SimpleTestEntity)
)
).thenReject(rejectionError);
when(
privacyPolicyMock.authorizeDeleteAsync(
viewerContext,
queryContext,
anyOfClass(EntityTransactionalQueryContext),
anyOfClass(SimpleTestEntity)
)
).thenReject(rejectionError);
@@ -364,6 +805,8 @@ describe(EntityMutatorFactory, () => {
simpleTestEntityConfiguration,
SimpleTestEntity,
instance(privacyPolicyMock),
[],
{},
entityLoaderFactory,
databaseAdapter,
metricsAdapter
@@ -397,7 +840,7 @@ describe(EntityMutatorFactory, () => {
it('throws error when db adapter throws', async () => {
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityNonTransactionalQueryContext));
const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(SimpleTestEntityPrivacyPolicy));
const databaseAdapterMock = mock(EntityDatabaseAdapter);
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
@@ -408,25 +851,39 @@ describe(EntityMutatorFactory, () => {
string,
ViewerContext,
SimpleTestEntity,
SimpleTestEntityPrivacyPolicy
SimpleTestEntityPrivacyPolicy,
keyof SimpleTestFields
>
>(EntityLoaderFactory)
);
const rejectionError = new Error();
when(databaseAdapterMock.insertAsync(queryContext, anything())).thenReject(rejectionError);
when(
databaseAdapterMock.updateAsync(queryContext, anything(), anything(), anything())
databaseAdapterMock.insertAsync(anyOfClass(EntityTransactionalQueryContext), anything())
).thenReject(rejectionError);
when(
databaseAdapterMock.updateAsync(
anyOfClass(EntityTransactionalQueryContext),
anything(),
anything(),
anything()
)
).thenReject(rejectionError);
when(
databaseAdapterMock.deleteAsync(
anyOfClass(EntityTransactionalQueryContext),
anything(),
anything()
)
).thenReject(rejectionError);
when(databaseAdapterMock.deleteAsync(queryContext, anything(), anything())).thenReject(
rejectionError
);
const entityMutatorFactory = new EntityMutatorFactory(
simpleTestEntityConfiguration,
SimpleTestEntity,
privacyPolicy,
[],
{},
entityLoaderFactory,
instance(databaseAdapterMock),
metricsAdapter
@@ -449,7 +906,7 @@ describe(EntityMutatorFactory, () => {
it('records metrics appropriately', async () => {
const viewerContext = mock<ViewerContext>();
const queryContext = mock<EntityQueryContext>();
const queryContext = StubQueryContextProvider.getQueryContext();
const { entityMutatorFactory, metricsAdapter } = createEntityMutatorFactory([]);
const spiedMetricsAdapter = spy(metricsAdapter);
@@ -224,7 +224,7 @@ class EmptyPolicy extends EntityPrivacyPolicy<BlahFields, string, ViewerContext,
protected readonly deleteRules = [];
}
const blahEntityCompanionDefinition = {
const blahEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: BlahEntity,
entityConfiguration: new EntityConfiguration<BlahFields>({
idField: 'id',
@@ -234,11 +234,11 @@ const blahEntityCompanionDefinition = {
columnName: 'id',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
}),
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: AlwaysDenyPolicy,
};
});
describe(EntityPrivacyPolicy, () => {
it('throws EntityNotAuthorizedError when deny', async () => {
@@ -0,0 +1,327 @@
import Entity from '../Entity';
import {
DatabaseAdapterFlavor,
CacheAdapterFlavor,
EntityCompanionDefinition,
} from '../EntityCompanionProvider';
import EntityConfiguration from '../EntityConfiguration';
import { UUIDField, EntityEdgeDeletionBehavior } from '../EntityFields';
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
import { CacheStatus } from '../internal/ReadThroughEntityCache';
import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
import TestViewerContext from '../testfixtures/TestViewerContext';
import { InMemoryFullCacheStubCacheAdapter } from '../utils/testing/StubCacheAdapter';
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
interface CategoryFields {
id: string;
parent_category_id: string | null;
}
class CategoryPrivacyPolicy extends EntityPrivacyPolicy<
CategoryFields,
string,
TestViewerContext,
any,
any
> {
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
}
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
const makeEntityClass = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
class CategoryEntity extends Entity<CategoryFields, string, TestViewerContext> {
static getCompanionDefinition(): EntityCompanionDefinition<
CategoryFields,
string,
TestViewerContext,
CategoryEntity,
CategoryPrivacyPolicy
> {
return categoryEntityCompanion;
}
}
const categoryEntityConfiguration = new EntityConfiguration<CategoryFields>({
idField: 'id',
tableName: 'categories',
inboundEdges: [CategoryEntity],
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
parent_category_id: new UUIDField({
columnName: 'parent_category_id',
cache: true,
association: {
associatedEntityClass: CategoryEntity,
edgeDeletionBehavior,
},
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const categoryEntityCompanion = new EntityCompanionDefinition({
entityClass: CategoryEntity,
entityConfiguration: categoryEntityConfiguration,
privacyPolicyClass: CategoryPrivacyPolicy,
});
return {
CategoryEntity,
};
};
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
it('deletes', async () => {
const { CategoryEntity } = makeEntityClass(EntityEdgeDeletionBehavior.CASCADE_DELETE);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const parentCategory = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
const subCategory = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', parentCategory.getID())
.enforceCreateAsync();
const subSubCategory = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', subCategory.getID())
.enforceCreateAsync();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
).resolves.not.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
).resolves.not.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
).resolves.not.toBeNull();
await CategoryEntity.enforceDeleteAsync(parentCategory);
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
).resolves.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
).resolves.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
).resolves.toBeNull();
});
it('handles cycles', async () => {
const { CategoryEntity } = makeEntityClass(EntityEdgeDeletionBehavior.CASCADE_DELETE);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const categoryA = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
const categoryB = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', categoryA.getID())
.enforceCreateAsync();
await CategoryEntity.updater(categoryA)
.setField('parent_category_id', categoryB.getID())
.enforceUpdateAsync();
await CategoryEntity.enforceDeleteAsync(categoryA);
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(categoryA.getID())
).resolves.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(categoryB.getID())
).resolves.toBeNull();
});
});
describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
it('sets null', async () => {
const { CategoryEntity } = makeEntityClass(EntityEdgeDeletionBehavior.SET_NULL);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const parentCategory = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
const subCategory = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', parentCategory.getID())
.enforceCreateAsync();
const subSubCategory = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', subCategory.getID())
.enforceCreateAsync();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
).resolves.not.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
).resolves.not.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
).resolves.not.toBeNull();
await CategoryEntity.enforceDeleteAsync(parentCategory);
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
).resolves.toBeNull();
const loadedSubCategory = await CategoryEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(subCategory.getID());
expect(loadedSubCategory.getField('parent_category_id')).toBeNull();
const loadedSubSubCategory = await CategoryEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(subSubCategory.getID());
expect(loadedSubSubCategory.getField('parent_category_id')).not.toBeNull();
});
it('handles cycles', async () => {
const { CategoryEntity } = makeEntityClass(EntityEdgeDeletionBehavior.SET_NULL);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const categoryA = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
const categoryB = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', categoryA.getID())
.enforceCreateAsync();
await CategoryEntity.updater(categoryA)
.setField('parent_category_id', categoryB.getID())
.enforceUpdateAsync();
await CategoryEntity.enforceDeleteAsync(categoryA);
const loadedCategoryB = await CategoryEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(categoryB.getID());
expect(loadedCategoryB.getField('parent_category_id')).toBeNull();
});
});
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
it('invalidates the cache', async () => {
const { CategoryEntity } = makeEntityClass(
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE
);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const parentCategory = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
const subCategory = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', parentCategory.getID())
.enforceCreateAsync();
const subSubCategory = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', subCategory.getID())
.enforceCreateAsync();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
).resolves.not.toBeNull();
await expect(
CategoryEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_category_id', parentCategory.getID())
).resolves.not.toBeNull();
await expect(
CategoryEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_category_id', subCategory.getID())
).resolves.not.toBeNull();
const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
CategoryEntity
)['entityCompanion']['tableDataCoordinator'][
'cacheAdapter'
] as InMemoryFullCacheStubCacheAdapter<CategoryFields>;
const subCategoryCachedBefore = await categoryCacheAdapter.loadManyAsync('parent_category_id', [
parentCategory.getID(),
]);
expect(subCategoryCachedBefore.get(parentCategory.getID())?.status).toEqual(CacheStatus.HIT);
const subSubCategoryCachedBefore = await categoryCacheAdapter.loadManyAsync(
'parent_category_id',
[subCategory.getID()]
);
expect(subSubCategoryCachedBefore.get(subCategory.getID())?.status).toEqual(CacheStatus.HIT);
await CategoryEntity.enforceDeleteAsync(parentCategory);
const subCategoryCachedAfter = await categoryCacheAdapter.loadManyAsync('parent_category_id', [
parentCategory.getID(),
]);
expect(subCategoryCachedAfter.get(parentCategory.getID())?.status).toEqual(CacheStatus.MISS);
const subSubCategoryCachedAfter = await categoryCacheAdapter.loadManyAsync(
'parent_category_id',
[subCategory.getID()]
);
expect(subSubCategoryCachedAfter.get(subCategory.getID())?.status).toEqual(CacheStatus.MISS);
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
).resolves.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
).resolves.not.toBeNull();
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
).resolves.not.toBeNull();
});
it('handles cycles', async () => {
const { CategoryEntity } = makeEntityClass(
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE
);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const categoryA = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
const categoryB = await CategoryEntity.creator(viewerContext)
.setField('parent_category_id', categoryA.getID())
.enforceCreateAsync();
await CategoryEntity.updater(categoryA)
.setField('parent_category_id', categoryB.getID())
.enforceUpdateAsync();
await expect(
CategoryEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_category_id', categoryA.getID())
).resolves.not.toBeNull();
await expect(
CategoryEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_category_id', categoryB.getID())
).resolves.not.toBeNull();
const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
CategoryEntity
)['entityCompanion']['tableDataCoordinator'][
'cacheAdapter'
] as InMemoryFullCacheStubCacheAdapter<CategoryFields>;
const categoriesCachedBefore = await categoryCacheAdapter.loadManyAsync('parent_category_id', [
categoryA.getID(),
categoryB.getID(),
]);
expect(categoriesCachedBefore.get(categoryA.getID())?.status).toEqual(CacheStatus.HIT);
expect(categoriesCachedBefore.get(categoryB.getID())?.status).toEqual(CacheStatus.HIT);
await CategoryEntity.enforceDeleteAsync(categoryA);
const categoriesCachedAfter = await categoryCacheAdapter.loadManyAsync('parent_category_id', [
categoryA.getID(),
categoryB.getID(),
]);
expect(categoriesCachedAfter.get(categoryA.getID())?.status).toEqual(CacheStatus.MISS);
expect(categoriesCachedAfter.get(categoryB.getID())?.status).toEqual(CacheStatus.MISS);
});
});
@@ -6,6 +6,7 @@ import { EntityQueryContext } from '../EntityQueryContext';
import ReadonlyEntity from '../ReadonlyEntity';
import ViewerContext from '../ViewerContext';
import SimpleTestEntity from '../testfixtures/SimpleTestEntity';
import TestEntity from '../testfixtures/TestEntity';
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
describe(ReadonlyEntity, () => {
@@ -31,6 +32,42 @@ describe(ReadonlyEntity, () => {
});
});
describe('getUniqueIdentifier', () => {
it('returns a different value for two different entities of the same type', () => {
const viewerContext = instance(mock(ViewerContext));
const testEntity = new SimpleTestEntity(viewerContext, {
id: '1',
});
const testEntity2 = new SimpleTestEntity(viewerContext, {
id: '2',
});
expect(testEntity.getUniqueIdentifier()).not.toEqual(testEntity2.getUniqueIdentifier());
});
it('returns the same value even if different viewer context', () => {
const viewerContext = instance(mock(ViewerContext));
const viewerContext2 = instance(mock(ViewerContext));
const data = { id: '1' };
const testEntity = new SimpleTestEntity(viewerContext, data);
const testEntity2 = new SimpleTestEntity(viewerContext2, data);
expect(testEntity.getUniqueIdentifier()).toEqual(testEntity2.getUniqueIdentifier());
});
it('returns a different value for different entities even if same ID', () => {
const viewerContext = instance(mock(ViewerContext));
const data = { id: '1' };
const testEntity = new SimpleTestEntity(viewerContext, data);
const testEntity2 = new TestEntity(viewerContext, {
customIdField: '1',
testIndexedField: '2',
stringField: '3',
numberField: 4,
dateField: new Date(),
});
expect(testEntity.getUniqueIdentifier()).not.toEqual(testEntity2.getUniqueIdentifier());
});
});
it('cannot be created without an ID', () => {
const viewerContext = instance(mock(ViewerContext));
const dataWithoutID = {};
@@ -74,7 +111,7 @@ describe(ReadonlyEntity, () => {
it('creates a new regular query context', () => {
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new ViewerContext(companionProvider);
const queryContext = SimpleTestEntity.getRegularEntityQueryContext(viewerContext);
const queryContext = SimpleTestEntity.getQueryContext(viewerContext);
expect(queryContext).toBeInstanceOf(EntityQueryContext);
expect(queryContext.isInTransaction()).toBe(false);
});
@@ -11,7 +11,14 @@ describe(ViewerScopedEntityCompanion, () => {
it('returns viewer scoped loader and mutator factory', () => {
const vc = instance(mock(ViewerContext));
const entityCompanion = mock<
EntityCompanion<TestFields, string, ViewerContext, TestEntity, TestEntityPrivacyPolicy>
EntityCompanion<
TestFields,
string,
ViewerContext,
TestEntity,
TestEntityPrivacyPolicy,
keyof TestFields
>
>();
const viewerScopedEntityCompanion = new ViewerScopedEntityCompanion(entityCompanion, vc);
expect(viewerScopedEntityCompanion.getLoaderFactory()).toBeInstanceOf(
@@ -9,13 +9,17 @@ describe(ViewerScopedEntityLoaderFactory, () => {
it('correctly scopes viewer to entity loads', async () => {
const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext));
const baseLoader = mock<EntityLoaderFactory<any, any, any, any, any>>(EntityLoaderFactory);
const baseLoader = mock<EntityLoaderFactory<any, any, any, any, any, any>>(EntityLoaderFactory);
const baseLoaderInstance = instance(baseLoader);
const viewerScopedEntityLoader = new ViewerScopedEntityLoaderFactory<any, any, any, any, any>(
baseLoaderInstance,
viewerContext
);
const viewerScopedEntityLoader = new ViewerScopedEntityLoaderFactory<
any,
any,
any,
any,
any,
any
>(baseLoaderInstance, viewerContext);
viewerScopedEntityLoader.forLoad(queryContext);
@@ -20,7 +20,8 @@ describe(ViewerScopedEntityMutatorFactory, () => {
string,
ViewerContext,
TestEntity,
TestEntityPrivacyPolicy
TestEntityPrivacyPolicy,
keyof TestFields
>(baseMutatorFactoryInstance, viewerContext);
viewerScopedEntityLoader.forCreate(queryContext);
@@ -0,0 +1,172 @@
import Entity from '../../Entity';
import {
EntityCompanionDefinition,
DatabaseAdapterFlavor,
CacheAdapterFlavor,
} from '../../EntityCompanionProvider';
import EntityConfiguration from '../../EntityConfiguration';
import { UUIDField, EnumField, StringField } from '../../EntityFields';
import EntityPrivacyPolicy from '../../EntityPrivacyPolicy';
import ViewerContext from '../../ViewerContext';
import { successfulResults, failedResults } from '../../entityUtils';
import AlwaysAllowPrivacyPolicyRule from '../../rules/AlwaysAllowPrivacyPolicyRule';
import { createUnitTestEntityCompanionProvider } from '../../utils/testing/createUnitTestEntityCompanionProvider';
describe('Two entities backed by the same table', () => {
test('load by different types', async () => {
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new ViewerContext(companionProvider);
const one = await OneTestEntity.creator(viewerContext)
.setField('entity_type', EntityType.ONE)
.setField('common_other_field', 'wat')
.enforceCreateAsync();
const two = await TwoTestEntity.creator(viewerContext)
.setField('entity_type', EntityType.TWO)
.setField('other_field', 'blah')
.setField('common_other_field', 'wat')
.enforceCreateAsync();
expect(one).toBeInstanceOf(OneTestEntity);
expect(two).toBeInstanceOf(TwoTestEntity);
await expect(
TwoTestEntity.loader(viewerContext).enforcing().loadByIDAsync(one.getID())
).rejects.toThrowError('TwoTestEntity must be instantiated with two data');
await expect(
OneTestEntity.loader(viewerContext).enforcing().loadByIDAsync(two.getID())
).rejects.toThrowError('OneTestEntity must be instantiated with one data');
const manyResults = await OneTestEntity.loader(viewerContext).loadManyByFieldEqualingAsync(
'common_other_field',
'wat'
);
const successfulManyResults = successfulResults(manyResults);
const failedManyResults = failedResults(manyResults);
expect(successfulManyResults).toHaveLength(1);
expect(failedManyResults).toHaveLength(1);
expect(successfulManyResults[0].enforceValue().getID()).toEqual(one.getID());
expect(failedManyResults[0].enforceError().message).toEqual(
'OneTestEntity must be instantiated with one data'
);
const fieldEqualityConjunctionResults = await OneTestEntity.loader(
viewerContext
).loadManyByFieldEqualityConjunctionAsync([
{
fieldName: 'common_other_field',
fieldValue: 'wat',
},
]);
const successfulfieldEqualityConjunctionResultsResults = successfulResults(
fieldEqualityConjunctionResults
);
const failedfieldEqualityConjunctionResultsResults = failedResults(
fieldEqualityConjunctionResults
);
expect(successfulfieldEqualityConjunctionResultsResults).toHaveLength(1);
expect(failedfieldEqualityConjunctionResultsResults).toHaveLength(1);
});
});
enum EntityType {
ONE,
TWO,
}
interface TestFields {
id: string;
other_field: string;
common_other_field: string;
entity_type: EntityType;
}
type OneTestFields = 'id' | 'entity_type' | 'common_other_field';
type TwoTestFields = 'id' | 'other_field' | 'entity_type' | 'common_other_field';
const testEntityConfiguration = new EntityConfiguration<TestFields>({
idField: 'id',
tableName: 'entities',
schema: {
id: new UUIDField({
columnName: 'custom_id',
cache: true,
}),
other_field: new StringField({
columnName: 'other_field',
}),
common_other_field: new StringField({
columnName: 'common_other_field',
}),
entity_type: new EnumField({
columnName: 'entity_type',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
}
class OneTestEntity extends Entity<TestFields, string, ViewerContext, OneTestFields> {
constructor(viewerContext: ViewerContext, rawFields: Readonly<TestFields>) {
if (rawFields.entity_type !== EntityType.ONE) {
throw new Error('OneTestEntity must be instantiated with one data');
}
super(viewerContext, rawFields);
}
static getCompanionDefinition(): EntityCompanionDefinition<
TestFields,
string,
ViewerContext,
OneTestEntity,
TestEntityPrivacyPolicy,
OneTestFields
> {
return oneTestEntityCompanion;
}
}
class TwoTestEntity extends Entity<TestFields, string, ViewerContext, TwoTestFields> {
constructor(viewerContext: ViewerContext, rawFields: Readonly<TestFields>) {
if (rawFields.entity_type !== EntityType.TWO) {
throw new Error('TwoTestEntity must be instantiated with two data');
}
super(viewerContext, rawFields);
}
static getCompanionDefinition(): EntityCompanionDefinition<
TestFields,
string,
ViewerContext,
TwoTestEntity,
TestEntityPrivacyPolicy,
TwoTestFields
> {
return twoTestEntityCompanion;
}
}
const oneTestEntityCompanion = new EntityCompanionDefinition({
entityClass: OneTestEntity,
entityConfiguration: testEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
entitySelectedFields: ['id', 'entity_type', 'common_other_field'],
});
const twoTestEntityCompanion = new EntityCompanionDefinition({
entityClass: TwoTestEntity,
entityConfiguration: testEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
entitySelectedFields: ['id', 'other_field', 'common_other_field', 'entity_type'],
});
@@ -0,0 +1,166 @@
import Entity from '../../Entity';
import {
EntityCompanionDefinition,
DatabaseAdapterFlavor,
CacheAdapterFlavor,
} from '../../EntityCompanionProvider';
import EntityConfiguration from '../../EntityConfiguration';
import { UUIDField, StringField } from '../../EntityFields';
import EntityPrivacyPolicy from '../../EntityPrivacyPolicy';
import ViewerContext from '../../ViewerContext';
import AlwaysAllowPrivacyPolicyRule from '../../rules/AlwaysAllowPrivacyPolicyRule';
import { createUnitTestEntityCompanionProvider } from '../../utils/testing/createUnitTestEntityCompanionProvider';
describe('Two entities backed by the same table', () => {
test('mutate through different types and keep consistent cache and dataloader', async () => {
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new ViewerContext(companionProvider);
const entity1 = await OneTestEntity.creator(viewerContext)
.setField('fake_field', 'hello')
.enforceCreateAsync();
expect(entity1).toBeInstanceOf(OneTestEntity);
const entity2 = await TwoTestEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity1.getID());
expect(entity2).toBeInstanceOf(TwoTestEntity);
const updated2 = await TwoTestEntity.updater(entity2)
.setField('fake_field', 'world')
.setField('other_field', 'wat')
.enforceUpdateAsync();
expect(updated2.getAllFields()).toMatchObject({
id: updated2.getID(),
other_field: 'wat',
fake_field: 'world',
});
const loaded1 = await OneTestEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity1.getID());
expect(loaded1.getAllFields()).toMatchObject({
id: updated2.getID(),
fake_field: 'world',
});
});
test('cached field that differs between the two to test invalidation', async () => {
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new ViewerContext(companionProvider);
const entity = await TwoTestEntity.creator(viewerContext)
.setField('fake_field', 'hello')
.setField('other_field', 'huh')
.enforceCreateAsync();
const loadedEntity = await TwoTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('other_field', 'huh');
expect(loadedEntity?.getAllFields()).toMatchObject({
id: entity.getID(),
fake_field: 'hello',
other_field: 'huh',
});
const loaded1 = await OneTestEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity.getID());
await OneTestEntity.updater(loaded1).setField('fake_field', 'world').enforceUpdateAsync();
const loaded2 = await TwoTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('other_field', 'huh');
expect(loaded2?.getAllFields()).toMatchObject({
id: entity.getID(),
fake_field: 'world',
other_field: 'huh',
});
const loaded22 = await TwoTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('fake_field', 'world');
expect(loaded22?.getAllFields()).toMatchObject({
id: entity.getID(),
fake_field: 'world',
other_field: 'huh',
});
});
});
interface TestFields {
id: string;
other_field: string;
fake_field: string;
}
type OneTestFields = 'id' | 'fake_field';
type TwoTestFields = 'id' | 'other_field' | 'fake_field';
const testEntityConfiguration = new EntityConfiguration<TestFields>({
idField: 'id',
tableName: 'entities',
schema: {
id: new UUIDField({
columnName: 'custom_id',
cache: true,
}),
other_field: new StringField({
columnName: 'other_field',
cache: true,
}),
fake_field: new StringField({
columnName: 'fake_field',
cache: true,
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
}
class OneTestEntity extends Entity<TestFields, string, ViewerContext, OneTestFields> {
static getCompanionDefinition(): EntityCompanionDefinition<
TestFields,
string,
ViewerContext,
OneTestEntity,
TestEntityPrivacyPolicy,
OneTestFields
> {
return oneTestEntityCompanion;
}
}
class TwoTestEntity extends Entity<TestFields, string, ViewerContext, TwoTestFields> {
static getCompanionDefinition(): EntityCompanionDefinition<
TestFields,
string,
ViewerContext,
TwoTestEntity,
TestEntityPrivacyPolicy,
TwoTestFields
> {
return twoTestEntityCompanion;
}
}
const oneTestEntityCompanion = new EntityCompanionDefinition({
entityClass: OneTestEntity,
entityConfiguration: testEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
entitySelectedFields: ['id', 'fake_field'],
});
const twoTestEntityCompanion = new EntityCompanionDefinition({
entityClass: TwoTestEntity,
entityConfiguration: testEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
entitySelectedFields: ['id', 'other_field', 'fake_field'],
});
@@ -6,6 +6,7 @@ import {
failedResults,
successfulResultsFilterMap,
failedResultsFilterMap,
pick,
} from '../entityUtils';
describe(enforceResultsAsync, () => {
@@ -42,39 +43,57 @@ describe(failedResults, () => {
});
describe(successfulResultsFilterMap, () => {
const result1 = result(1);
const result2 = result(new Error('hello'));
const result3 = result(1);
const allResults = new Map(
Object.entries({
a: result1,
b: result2,
c: result3,
})
);
it('filters out failed results', () => {
const result1 = result(1);
const result2 = result(new Error('hello'));
const result3 = result(1);
const allResults = new Map(
Object.entries({
a: result1,
b: result2,
c: result3,
})
);
const resultingMap = successfulResultsFilterMap(allResults);
const resultingMap = successfulResultsFilterMap(allResults);
expect(resultingMap.get('a')).toEqual(result1);
expect(resultingMap.get('b')).toBeUndefined();
expect(resultingMap.get('c')).toEqual(result3);
expect(resultingMap.get('a')).toEqual(result1);
expect(resultingMap.get('b')).toBeUndefined();
expect(resultingMap.get('c')).toEqual(result3);
});
});
describe(failedResultsFilterMap, () => {
const result1 = result(1);
const result2 = result(new Error('hello'));
const result3 = result(1);
const allResults = new Map(
Object.entries({
a: result1,
b: result2,
c: result3,
})
);
it('filters out successful results', () => {
const result1 = result(1);
const result2 = result(new Error('hello'));
const result3 = result(1);
const allResults = new Map(
Object.entries({
a: result1,
b: result2,
c: result3,
})
);
const resultingMap = failedResultsFilterMap(allResults);
const resultingMap = failedResultsFilterMap(allResults);
expect(resultingMap.get('a')).toBeUndefined();
expect(resultingMap.get('b')).toEqual(result2);
expect(resultingMap.get('c')).toBeUndefined();
expect(resultingMap.get('a')).toBeUndefined();
expect(resultingMap.get('b')).toEqual(result2);
expect(resultingMap.get('c')).toBeUndefined();
});
});
describe(pick, () => {
it('picks specified keys', () => {
const object = {
a: 1,
b: 2,
c: 3,
};
expect(pick(object, ['a', 'b'])).toEqual({
a: 1,
b: 2,
});
});
});
+7
View File
@@ -93,3 +93,10 @@ export const partitionErrors = <T>(valuesAndErrors: (T | Error)[]): [T[], Error[
const isError = <T>(value: T | Error): value is Error => {
return value instanceof Error;
};
export const pick = <T extends object, U extends keyof T>(object: T, props: U[]): Pick<T, U> => {
const propsSet = new Set(props);
return Object.fromEntries(
Object.entries(object).filter((entry) => propsSet.has(entry[0] as any))
) as any;
};
+4 -1
View File
@@ -16,13 +16,16 @@ export * from './EntityFields';
export { default as EntityLoader } from './EntityLoader';
export { default as EntityLoaderFactory } from './EntityLoaderFactory';
export * from './EntityMutator';
export { default as EntityMutationValidator } from './EntityMutationValidator';
export * from './EntityMutationTriggerConfiguration';
export { default as EntityMutationTriggerConfiguration } from './EntityMutationTriggerConfiguration';
export { default as EntityMutatorFactory } from './EntityMutatorFactory';
export { default as EntityPrivacyPolicy } from './EntityPrivacyPolicy';
export * from './EntityPrivacyPolicy';
export * from './EntityQueryContext';
export { default as IEntityCacheAdapterProvider } from './IEntityCacheAdapterProvider';
export { default as IEntityDatabaseAdapterProvider } from './IEntityDatabaseAdapterProvider';
export { default as IEntityQueryContextProvider } from './IEntityQueryContextProvider';
export { default as EntityQueryContextProvider } from './EntityQueryContextProvider';
export { default as ReadonlyEntity } from './ReadonlyEntity';
export { default as ViewerContext } from './ViewerContext';
export { default as ViewerScopedEntityCompanion } from './ViewerScopedEntityCompanion';
@@ -5,7 +5,7 @@ import EntityDatabaseAdapter, {
QuerySelectionModifiers,
} from '../EntityDatabaseAdapter';
import { EntityQueryContext } from '../EntityQueryContext';
import IEntityQueryContextProvider from '../IEntityQueryContextProvider';
import EntityQueryContextProvider from '../EntityQueryContextProvider';
import { partitionErrors } from '../entityUtils';
import {
timeAndLogLoadEventAsync,
@@ -30,7 +30,7 @@ export default class EntityDataManager<TFields> {
constructor(
private readonly databaseAdapter: EntityDatabaseAdapter<TFields>,
private readonly entityCache: ReadThroughEntityCache<TFields>,
private readonly queryContextProvider: IEntityQueryContextProvider,
private readonly queryContextProvider: EntityQueryContextProvider,
private readonly metricsAdapter: IEntityMetricsAdapter
) {}
@@ -63,7 +63,7 @@ export default class EntityDataManager<TFields> {
async (fetcherValues) => {
this.metricsAdapter.incrementDataManagerDatabaseLoadCount(fieldValues.length);
return await this.databaseAdapter.fetchManyWhereAsync(
this.queryContextProvider.getRegularEntityQueryContext(),
this.queryContextProvider.getQueryContext(),
fieldName,
fetcherValues
);
@@ -0,0 +1,41 @@
import EntityCacheAdapter from '../EntityCacheAdapter';
import EntityConfiguration from '../EntityConfiguration';
import EntityDatabaseAdapter from '../EntityDatabaseAdapter';
import EntityQueryContextProvider from '../EntityQueryContextProvider';
import IEntityCacheAdapterProvider from '../IEntityCacheAdapterProvider';
import IEntityDatabaseAdapterProvider from '../IEntityDatabaseAdapterProvider';
import IEntityMetricsAdapter from '../metrics/IEntityMetricsAdapter';
import EntityDataManager from './EntityDataManager';
import ReadThroughEntityCache from './ReadThroughEntityCache';
/**
* Responsible for orchestrating fetching and caching of entity data from a
* table. Note that one instance is shared amongst all entities that read from
* the table to ensure cross-entity data consistency.
*/
export default class EntityTableDataCoordinator<TFields> {
readonly databaseAdapter: EntityDatabaseAdapter<TFields>;
readonly cacheAdapter: EntityCacheAdapter<TFields>;
readonly dataManager: EntityDataManager<TFields>;
constructor(
readonly entityConfiguration: EntityConfiguration<TFields>,
databaseAdapterProvider: IEntityDatabaseAdapterProvider,
cacheAdapterProvider: IEntityCacheAdapterProvider,
private readonly queryContextProvider: EntityQueryContextProvider,
metricsAdapter: IEntityMetricsAdapter
) {
this.databaseAdapter = databaseAdapterProvider.getDatabaseAdapter(entityConfiguration);
this.cacheAdapter = cacheAdapterProvider.getCacheAdapter(entityConfiguration);
this.dataManager = new EntityDataManager(
this.databaseAdapter,
new ReadThroughEntityCache(entityConfiguration, this.cacheAdapter),
queryContextProvider,
metricsAdapter
);
}
getQueryContextProvider(): EntityQueryContextProvider {
return this.queryContextProvider;
}
}
@@ -115,6 +115,7 @@ export default class ReadThroughEntityCache<TFields> {
if (objects.length > 1) {
// multiple objects received for what was supposed to be a unique query, don't add to return map nor cache
// TODO(wschurman): emit or throw here since console may not be available
// eslint-disable-next-line no-console
console.warn(
`unique key ${fieldName} in ${this.entityConfiguration.tableName} returned multiple rows for ${fieldValue}`
);
@@ -71,7 +71,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyWhereAsync');
const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -118,7 +118,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyWhereAsync');
const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -165,7 +165,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
// use second data manager to ensure that cache is hit instead of data loader
const entityDataManager2 = new EntityDataManager(
databaseAdapter,
@@ -207,7 +207,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyWhereAsync');
const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -242,7 +242,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyWhereAsync');
const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -285,7 +285,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
const objectInQuestion = objects.get(testEntityConfiguration.tableName)![1];
@@ -323,7 +323,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
const objectInQuestion = objects.get(testEntityConfiguration.tableName)![1];
@@ -398,7 +398,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
const dbSpy = jest.spyOn(databaseAdapter, 'fetchManyByFieldEqualityConjunctionAsync');
const cacheSpy = jest.spyOn(entityCache, 'readManyThroughAsync');
@@ -443,7 +443,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
new NoOpEntityMetricsAdapter()
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
await expect(
entityDataManager.loadManyByFieldEqualingAsync(queryContext, 'customIdField', ['2'])
@@ -469,7 +469,7 @@ describe(EntityDataManager, () => {
StubQueryContextProvider,
metricsAdapter
);
const queryContext = StubQueryContextProvider.getRegularEntityQueryContext();
const queryContext = StubQueryContextProvider.getQueryContext();
await entityDataManager.loadManyByFieldEqualingAsync(queryContext, 'customIdField', ['1']);
verify(
@@ -1,3 +1,4 @@
import { DatabaseAdapterFlavor, CacheAdapterFlavor } from '../../EntityCompanionProvider';
import EntityConfiguration from '../../EntityConfiguration';
import { UUIDField, StringField } from '../../EntityFields';
import {
@@ -37,6 +38,8 @@ const blahEntityConfiguration = new EntityConfiguration<BlahT>({
columnName: 'transform_write',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
describe(getDatabaseFieldForEntityField, () => {
@@ -1,6 +1,7 @@
import { verify, deepEqual, mock, instance, when, anything } from 'ts-mockito';
import EntityCacheAdapter from '../../EntityCacheAdapter';
import { DatabaseAdapterFlavor, CacheAdapterFlavor } from '../../EntityCompanionProvider';
import EntityConfiguration from '../../EntityConfiguration';
import { UUIDField } from '../../EntityFields';
import ReadThroughEntityCache, { CacheStatus } from '../ReadThroughEntityCache';
@@ -16,6 +17,8 @@ const makeEntityConfiguration = (cacheIdField: boolean): EntityConfiguration<Bla
schema: {
id: new UUIDField({ columnName: 'id', cache: cacheIdField }),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
const createIdFetcher = (ids: string[]) => async <N extends keyof BlahFields>(
@@ -10,8 +10,9 @@ export default class AlwaysAllowPrivacyPolicyRule<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>
> extends PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity> {
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> extends PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields> {
async evaluateAsync(
_viewerContext: TViewerContext,
_queryContext: EntityQueryContext,
@@ -10,8 +10,9 @@ export default class AlwaysDenyPrivacyPolicyRule<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>
> extends PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity> {
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> extends PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields> {
async evaluateAsync(
_viewerContext: TViewerContext,
_queryContext: EntityQueryContext,
@@ -10,8 +10,9 @@ export default class AlwaysSkipPrivacyPolicyRule<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>
> extends PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity> {
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> extends PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields> {
async evaluateAsync(
_viewerContext: TViewerContext,
_queryContext: EntityQueryContext,
@@ -39,7 +39,8 @@ export default abstract class PrivacyPolicyRule<
TFields,
TID,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext>
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TSelectedFields extends keyof TFields = keyof TFields
> {
abstract async evaluateAsync(
viewerContext: TViewerContext,
@@ -22,6 +22,8 @@ export const dateIDTestEntityConfiguration = new EntityConfiguration<DateIDTestF
columnName: 'custom_id',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
export class DateIDTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
@@ -56,10 +58,8 @@ export default class DateIDTestEntity extends Entity<DateIDTestFields, Date, Vie
}
}
export const dateIDTestEntityCompanion = {
export const dateIDTestEntityCompanion = new EntityCompanionDefinition({
entityClass: DateIDTestEntity,
entityConfiguration: dateIDTestEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: DateIDTestEntityPrivacyPolicy,
};
});
@@ -14,6 +14,8 @@ export type SimpleTestFields = {
id: string;
};
export type SimpleTestFieldSelection = keyof SimpleTestFields;
export const simpleTestEntityConfiguration = new EntityConfiguration<SimpleTestFields>({
idField: 'id',
tableName: 'simple_test_entity_should_not_write_to_db',
@@ -22,44 +24,75 @@ export const simpleTestEntityConfiguration = new EntityConfiguration<SimpleTestF
columnName: 'custom_id',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
export class SimpleTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
SimpleTestFields,
string,
ViewerContext,
SimpleTestEntity
SimpleTestEntity,
SimpleTestFieldSelection
> {
protected readonly readRules = [
new AlwaysAllowPrivacyPolicyRule<SimpleTestFields, string, ViewerContext, SimpleTestEntity>(),
new AlwaysAllowPrivacyPolicyRule<
SimpleTestFields,
string,
ViewerContext,
SimpleTestEntity,
SimpleTestFieldSelection
>(),
];
protected readonly createRules = [
new AlwaysAllowPrivacyPolicyRule<SimpleTestFields, string, ViewerContext, SimpleTestEntity>(),
new AlwaysAllowPrivacyPolicyRule<
SimpleTestFields,
string,
ViewerContext,
SimpleTestEntity,
SimpleTestFieldSelection
>(),
];
protected readonly updateRules = [
new AlwaysAllowPrivacyPolicyRule<SimpleTestFields, string, ViewerContext, SimpleTestEntity>(),
new AlwaysAllowPrivacyPolicyRule<
SimpleTestFields,
string,
ViewerContext,
SimpleTestEntity,
SimpleTestFieldSelection
>(),
];
protected readonly deleteRules = [
new AlwaysAllowPrivacyPolicyRule<SimpleTestFields, string, ViewerContext, SimpleTestEntity>(),
new AlwaysAllowPrivacyPolicyRule<
SimpleTestFields,
string,
ViewerContext,
SimpleTestEntity,
SimpleTestFieldSelection
>(),
];
}
export default class SimpleTestEntity extends Entity<SimpleTestFields, string, ViewerContext> {
export default class SimpleTestEntity extends Entity<
SimpleTestFields,
string,
ViewerContext,
SimpleTestFieldSelection
> {
static getCompanionDefinition(): EntityCompanionDefinition<
SimpleTestFields,
string,
ViewerContext,
SimpleTestEntity,
SimpleTestEntityPrivacyPolicy
SimpleTestEntityPrivacyPolicy,
SimpleTestFieldSelection
> {
return testEntityCompanion;
}
}
export const testEntityCompanion = {
export const testEntityCompanion = new EntityCompanionDefinition({
entityClass: SimpleTestEntity,
entityConfiguration: simpleTestEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: SimpleTestEntityPrivacyPolicy,
};
});
@@ -41,6 +41,8 @@ export const testEntityConfiguration = new EntityConfiguration<TestFields>({
columnName: 'date_field',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
export class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
@@ -103,10 +105,8 @@ export default class TestEntity extends Entity<TestFields, string, ViewerContext
}
}
export const testEntityCompanion = {
export const testEntityCompanion = new EntityCompanionDefinition({
entityClass: TestEntity,
entityConfiguration: testEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: TestEntityPrivacyPolicy,
};
});
@@ -26,6 +26,8 @@ export const testEntity2Configuration = new EntityConfiguration<Test2Fields>({
columnName: 'foreign_key',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
export class TestEntity2PrivacyPolicy extends EntityPrivacyPolicy<
@@ -60,10 +62,8 @@ export default class TestEntity2 extends Entity<Test2Fields, string, ViewerConte
}
}
export const testEntity2Companion = {
export const testEntity2Companion = new EntityCompanionDefinition({
entityClass: TestEntity2,
entityConfiguration: testEntity2Configuration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: TestEntity2PrivacyPolicy,
};
});
@@ -22,6 +22,8 @@ export const numberKeyEntityConfiguration = new EntityConfiguration<NumberKeyFie
columnName: 'custom_id',
}),
},
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
});
export class NumberKeyPrivacyPolicy extends EntityPrivacyPolicy<
@@ -56,10 +58,8 @@ export default class NumberKeyEntity extends Entity<NumberKeyFields, number, Vie
}
}
export const numberKeyEntityCompanion = {
export const numberKeyEntityCompanion = new EntityCompanionDefinition({
entityClass: NumberKeyEntity,
entityConfiguration: numberKeyEntityConfiguration,
databaseAdaptorFlavor: DatabaseAdapterFlavor.POSTGRES,
cacheAdaptorFlavor: CacheAdapterFlavor.REDIS,
privacyPolicyClass: NumberKeyPrivacyPolicy,
};
});
Loaded 100 of 111 files, more files were not shown because too many files have changed in this diff. Show more