mirror of
https://github.com/expo/entity.git
synced 2026-11-15 17:32:07 -10:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1b749a0633 |
No files matched your search
@@ -2,7 +2,7 @@ name: tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
branches: [ master ]
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
@@ -14,7 +14,7 @@ jobs:
|
||||
ref: ${{ github.event.pull_request.head.sha }}
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 18.x
|
||||
node-version: 12.x
|
||||
- name: Cache Node.js modules
|
||||
uses: actions/cache@v1
|
||||
with:
|
||||
|
||||
@@ -3,23 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* fix workflow branch specification ([#179](https://github.com/expo/entity/issues/179)) ([25d14bf](https://github.com/expo/entity/commit/25d14bf8c1688524ad488aa2b63221393a4f0b05))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
|
||||
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -4,5 +4,5 @@
|
||||
],
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true,
|
||||
"version": "0.26.0"
|
||||
"version": "0.25.3"
|
||||
}
|
||||
+2
-2
@@ -19,6 +19,7 @@
|
||||
"@expo/entity": "file:packages/entity",
|
||||
"@expo/results": "^1.0.0",
|
||||
"@types/invariant": "^2.2.33",
|
||||
"@types/ioredis": "^4.26.4",
|
||||
"@types/jest": "^26.0.10",
|
||||
"@types/jsbn": "^1.2.29",
|
||||
"@types/lru-cache": "^5.1.1",
|
||||
@@ -30,7 +31,6 @@
|
||||
"eslint": "^7.7.0",
|
||||
"eslint-config-universe": "^7.0.0",
|
||||
"eslint-plugin-tsdoc": "^0.2.11",
|
||||
"ioredis": "^5.0.4",
|
||||
"jest": "^26.6.3",
|
||||
"lerna": "^4.0.0",
|
||||
"lru-cache": "^6.0.0",
|
||||
@@ -40,7 +40,7 @@
|
||||
"ts-jest": "~26.4.4",
|
||||
"ts-mockito": "^2.6.1",
|
||||
"typedoc": "^0.21.9",
|
||||
"typescript": "^4.6.3",
|
||||
"typescript": "^4.4.2",
|
||||
"uuid": "^8.3.0"
|
||||
},
|
||||
"dependencies": {
|
||||
|
||||
@@ -3,14 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-local-memory",
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Cross-request local memory cache adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -33,6 +33,6 @@
|
||||
"lru-cache": "^6.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.26.0"
|
||||
"@expo/entity": "^0.25.3"
|
||||
}
|
||||
}
|
||||
@@ -68,7 +68,7 @@ export default class LocalMemoryCacheAdapter<TFields> extends EntityCacheAdapter
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): string {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${String(fieldName)}`);
|
||||
invariant(columnName, `database field mapping missing for ${fieldName}`);
|
||||
const parts = [
|
||||
this.entityConfiguration.tableName,
|
||||
`${this.entityConfiguration.cacheKeyVersion}`,
|
||||
|
||||
+10
-12
@@ -32,9 +32,9 @@ describe(LocalMemoryCacheAdapter, () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
const entity1 = await LocalMemoryTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
const entity1 = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
entity1Created.getID()
|
||||
);
|
||||
|
||||
const entitySpecificGenericCacher =
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
|
||||
@@ -97,15 +97,13 @@ describe(LocalMemoryCacheAdapter, () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
await LocalMemoryTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(entity1Created.getID());
|
||||
|
||||
// load entity with a different request
|
||||
const viewerContext2 = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider());
|
||||
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2).loadByIDAsync(
|
||||
entity1Created.getID()
|
||||
);
|
||||
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
LocalMemoryTestEntity,
|
||||
@@ -140,9 +138,9 @@ describe(LocalMemoryCacheAdapter, () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity will try to put it in cache but it's a noop cache, so it should be a miss
|
||||
const entity1 = await LocalMemoryTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
const entity1 = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
entity1Created.getID()
|
||||
);
|
||||
|
||||
const entitySpecificGenericCacher =
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
|
||||
|
||||
@@ -3,17 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-redis",
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Redis cache adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -27,11 +27,12 @@
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*",
|
||||
"ioredis": ">=5"
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"ioredis": "^4.27.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.26.0",
|
||||
"ioredis": "^5.0.4"
|
||||
"@expo/entity": "^0.25.3"
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
import { EntityCacheAdapter, EntityConfiguration, CacheLoadResult, mapKeys } from '@expo/entity';
|
||||
import invariant from 'invariant';
|
||||
import type { Redis } from 'ioredis';
|
||||
import { Redis } from 'ioredis';
|
||||
|
||||
import GenericRedisCacher from './GenericRedisCacher';
|
||||
|
||||
@@ -113,7 +113,7 @@ export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFiel
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): string {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${String(fieldName)}`);
|
||||
invariant(columnName, `database field mapping missing for ${fieldName}`);
|
||||
return this.context.makeKeyFn(
|
||||
this.context.cacheKeyPrefix,
|
||||
this.entityConfiguration.tableName,
|
||||
|
||||
+10
-13
@@ -52,9 +52,9 @@ describe(RedisCacheAdapter, () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
const entity1 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
const entity1 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
entity1Created.getID()
|
||||
);
|
||||
|
||||
const cachedJSON = await redisCacheAdapterContext.redisClient.get(
|
||||
cacheKeyMaker('id', entity1.getID())
|
||||
@@ -102,16 +102,14 @@ describe(RedisCacheAdapter, () => {
|
||||
);
|
||||
expect(entity1.getField('dateField')).toEqual(date);
|
||||
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1.getID());
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(entity1.getID());
|
||||
expect(entity2.getField('dateField')).toEqual(date);
|
||||
|
||||
// simulate new request
|
||||
const vc2 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
|
||||
const entity3 = await RedisTestEntity.loader(vc2).loadByIDAsync(entity1.getID());
|
||||
expect(entity3.getField('dateField')).toEqual(date);
|
||||
});
|
||||
|
||||
@@ -122,18 +120,17 @@ describe(RedisCacheAdapter, () => {
|
||||
const entity1 = await enforceAsyncResult(
|
||||
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
|
||||
);
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', '');
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'name',
|
||||
''
|
||||
);
|
||||
expect(entity2?.getID()).toEqual(entity1.getID());
|
||||
|
||||
// simulate new request
|
||||
const vc2 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity3 = await RedisTestEntity.loader(vc2)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', '');
|
||||
const entity3 = await RedisTestEntity.loader(vc2).loadByFieldEqualingAsync('name', '');
|
||||
expect(entity3?.getID()).toEqual(entity1.getID());
|
||||
});
|
||||
});
|
||||
@@ -3,14 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-database-adapter-knex",
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Knex database adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -33,7 +33,7 @@
|
||||
"knex": "^1.0.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.26.0",
|
||||
"@expo/entity": "^0.25.3",
|
||||
"pg": "^8.7.1"
|
||||
}
|
||||
}
|
||||
+86
-111
@@ -50,9 +50,7 @@ describe('postgres entity integration', () => {
|
||||
PostgresTestEntity.updater(entity).setField('hasADog', false).updateAsync(),
|
||||
]);
|
||||
|
||||
const loadedEntity = await PostgresTestEntity.loader(vc)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity.getID());
|
||||
const loadedEntity = await PostgresTestEntity.loader(vc).loadByIDAsync(entity.getID());
|
||||
|
||||
expect(loadedEntity.getField('hasACat')).toBe(true);
|
||||
expect(loadedEntity.getField('hasADog')).toBe(false);
|
||||
@@ -185,26 +183,22 @@ describe('postgres entity integration', () => {
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{
|
||||
fieldName: 'hasACat',
|
||||
fieldValue: false,
|
||||
},
|
||||
{
|
||||
fieldName: 'hasADog',
|
||||
fieldValue: true,
|
||||
},
|
||||
]);
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync([
|
||||
{
|
||||
fieldName: 'hasACat',
|
||||
fieldValue: false,
|
||||
},
|
||||
{
|
||||
fieldName: 'hasADog',
|
||||
fieldValue: true,
|
||||
},
|
||||
]);
|
||||
|
||||
expect(results).toHaveLength(2);
|
||||
|
||||
const results2 = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'hasADog', fieldValues: [true, false] },
|
||||
]);
|
||||
const results2 = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
|
||||
[{ fieldName: 'hasADog', fieldValues: [true, false] }]
|
||||
);
|
||||
expect(results2).toHaveLength(3);
|
||||
});
|
||||
|
||||
@@ -217,9 +211,9 @@ describe('postgres entity integration', () => {
|
||||
|
||||
await enforceAsyncResult(PostgresTestEntity.creator(vc1).setField('name', 'c').createAsync());
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([], {
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
|
||||
[],
|
||||
{
|
||||
limit: 2,
|
||||
offset: 1,
|
||||
orderBy: [
|
||||
@@ -228,7 +222,8 @@ describe('postgres entity integration', () => {
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
});
|
||||
}
|
||||
);
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results.map((e) => e.getField('name'))).toEqual(['b', 'a']);
|
||||
});
|
||||
@@ -260,28 +255,26 @@ describe('postgres entity integration', () => {
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([{ fieldName: 'name', fieldValue: null }]);
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'name', fieldValue: null },
|
||||
]);
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results[0]!.getField('name')).toBeNull();
|
||||
|
||||
const results2 = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync(
|
||||
[
|
||||
{ fieldName: 'name', fieldValues: ['a', null] },
|
||||
{ fieldName: 'hasADog', fieldValue: true },
|
||||
const results2 = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
|
||||
[
|
||||
{ fieldName: 'name', fieldValues: ['a', null] },
|
||||
{ fieldName: 'hasADog', fieldValue: true },
|
||||
],
|
||||
{
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
{
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
}
|
||||
);
|
||||
}
|
||||
);
|
||||
expect(results2).toHaveLength(2);
|
||||
expect(results2.map((e) => e.getField('name'))).toEqual([null, 'a']);
|
||||
});
|
||||
@@ -298,9 +291,10 @@ describe('postgres entity integration', () => {
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('name = ?', ['hello']);
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync(
|
||||
'name = ?',
|
||||
['hello']
|
||||
);
|
||||
|
||||
expect(results).toHaveLength(1);
|
||||
});
|
||||
@@ -316,9 +310,9 @@ describe('postgres entity integration', () => {
|
||||
);
|
||||
|
||||
await expect(
|
||||
PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('invalid_column = ?', ['hello'])
|
||||
PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync('invalid_column = ?', [
|
||||
'hello',
|
||||
])
|
||||
).rejects.toThrow();
|
||||
});
|
||||
|
||||
@@ -346,9 +340,10 @@ describe('postgres entity integration', () => {
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync(
|
||||
'has_a_dog = ?',
|
||||
[true],
|
||||
{
|
||||
limit: 2,
|
||||
offset: 1,
|
||||
orderBy: [
|
||||
@@ -357,25 +352,26 @@ describe('postgres entity integration', () => {
|
||||
order: OrderByOrdering.ASCENDING,
|
||||
},
|
||||
],
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results.map((e) => e.getField('name'))).toEqual(['b', 'c']);
|
||||
|
||||
const resultsMultipleOrderBy = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'hasADog',
|
||||
order: OrderByOrdering.ASCENDING,
|
||||
},
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
});
|
||||
const resultsMultipleOrderBy = await PostgresTestEntity.loader(
|
||||
vc1
|
||||
).loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'hasADog',
|
||||
order: OrderByOrdering.ASCENDING,
|
||||
},
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
expect(resultsMultipleOrderBy).toHaveLength(3);
|
||||
expect(resultsMultipleOrderBy.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
|
||||
@@ -395,9 +391,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeCreate');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeCreate')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeCreate')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -406,27 +400,21 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterCreate');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterCreate')
|
||||
PostgresTriggerTestEntity.loader(vc1).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')
|
||||
PostgresTriggerTestEntity.loader(vc1).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')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterAll')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -435,9 +423,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterCommit');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterCommit')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterCommit')
|
||||
).resolves.not.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -458,9 +444,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeUpdate');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeUpdate')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeUpdate')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -469,9 +453,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterUpdate');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterUpdate')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterUpdate')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -480,9 +462,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeAll');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeAll')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeAll')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -491,9 +471,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterAll');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterAll')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterAll')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -502,9 +480,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterCommit');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterCommit')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterCommit')
|
||||
).resolves.not.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -522,9 +498,7 @@ describe('postgres entity integration', () => {
|
||||
PostgresTriggerTestEntity.enforceDeleteAsync(entityBeforeDelete)
|
||||
).rejects.toThrowError('name cannot have value beforeDelete');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeDelete')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeDelete')
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
const entityAfterDelete = await PostgresTriggerTestEntity.creator(vc1)
|
||||
@@ -534,9 +508,7 @@ describe('postgres entity integration', () => {
|
||||
PostgresTriggerTestEntity.enforceDeleteAsync(entityAfterDelete)
|
||||
).rejects.toThrowError('name cannot have value afterDelete');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterDelete')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterDelete')
|
||||
).resolves.not.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -553,9 +525,10 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
|
||||
await expect(
|
||||
PostgresValidatorTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate')
|
||||
PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
|
||||
'name',
|
||||
'beforeCreateAndBeforeUpdate'
|
||||
)
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -575,9 +548,10 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
|
||||
await expect(
|
||||
PostgresValidatorTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate')
|
||||
PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
|
||||
'name',
|
||||
'beforeCreateAndBeforeUpdate'
|
||||
)
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -592,9 +566,10 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync();
|
||||
await PostgresValidatorTestEntity.enforceDeleteAsync(entityToDelete);
|
||||
await expect(
|
||||
PostgresValidatorTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'shouldBeDeleted')
|
||||
PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
|
||||
'name',
|
||||
'shouldBeDeleted'
|
||||
)
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
@@ -60,7 +60,7 @@ describe('postgres errors', () => {
|
||||
const vc2 = new ViewerContext(
|
||||
createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance)
|
||||
);
|
||||
await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow(
|
||||
await expect(ErrorsTestEntity.loader(vc2).loadByIDAsync(1)).rejects.toThrow(
|
||||
EntityDatabaseAdapterTransientError
|
||||
);
|
||||
await shortTimeoutKnexInstance.destroy();
|
||||
|
||||
@@ -3,14 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@expo/entity-example",
|
||||
"private": true,
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "An example integration of the @expo/entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
@@ -23,7 +23,7 @@
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@expo/entity": "^0.26.0",
|
||||
"@expo/entity": "^0.25.3",
|
||||
"apollo-server-koa": "^2.16.1",
|
||||
"graphql": "^15.3.0",
|
||||
"koa": "^2.13.0",
|
||||
|
||||
@@ -19,9 +19,10 @@ router.get('/', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
let notes: readonly NoteEntity[] = [];
|
||||
if (viewerContext.isUserViewerContext()) {
|
||||
notes = await NoteEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualingAsync('userID', viewerContext.userID);
|
||||
notes = await NoteEntity.loader(viewerContext).loadManyByFieldEqualingAsync(
|
||||
'userID',
|
||||
viewerContext.userID
|
||||
);
|
||||
}
|
||||
ctx.body = {
|
||||
notes: notes.map((note) => note.getAllFields()),
|
||||
@@ -30,7 +31,7 @@ router.get('/', async (ctx: ExampleContext) => {
|
||||
|
||||
router.get('/:id', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
const noteResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
|
||||
const noteResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||
if (!noteResult.ok) {
|
||||
ctx.throw(403, noteResult.reason);
|
||||
}
|
||||
@@ -69,7 +70,7 @@ router.put('/:id', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
const { title, body } = ctx.request.body;
|
||||
|
||||
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
|
||||
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||
if (!noteLoadResult.ok) {
|
||||
ctx.throw(403, noteLoadResult.reason);
|
||||
}
|
||||
@@ -90,7 +91,7 @@ router.put('/:id', async (ctx: ExampleContext) => {
|
||||
router.delete('/:id', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
|
||||
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
|
||||
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||
if (!noteLoadResult.ok) {
|
||||
ctx.throw(403, noteLoadResult.reason);
|
||||
}
|
||||
|
||||
@@ -46,16 +46,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
||||
return viewerContext.userID;
|
||||
},
|
||||
async noteByID(_root, args, { viewerContext }) {
|
||||
return await NoteEntity.loader(viewerContext).enforcing().loadByIDAsync(args.id);
|
||||
return await NoteEntity.loader(viewerContext).loadByIDAsync(args.id);
|
||||
},
|
||||
} as IResolverObject<any, GraphqlContext>,
|
||||
|
||||
User: {
|
||||
id: (root) => root,
|
||||
async notes(root, _args, { viewerContext }) {
|
||||
return await NoteEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualingAsync('userID', root);
|
||||
return await NoteEntity.loader(viewerContext).loadManyByFieldEqualingAsync('userID', root);
|
||||
},
|
||||
} as IResolverObject<string, GraphqlContext>,
|
||||
|
||||
@@ -79,18 +77,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
||||
.enforceCreateAsync();
|
||||
},
|
||||
async updateNote(_root, args, { viewerContext }) {
|
||||
const existingNote = await NoteEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(args.id);
|
||||
const existingNote = await NoteEntity.loader(viewerContext).loadByIDAsync(args.id);
|
||||
return await NoteEntity.updater(existingNote)
|
||||
.setField('title', args.note.title)
|
||||
.setField('body', args.note.body)
|
||||
.enforceUpdateAsync();
|
||||
},
|
||||
async deleteNote(_root, args, { viewerContext }) {
|
||||
const existingNote = await NoteEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(args.id);
|
||||
const existingNote = await NoteEntity.loader(viewerContext).loadByIDAsync(args.id);
|
||||
await NoteEntity.enforceDeleteAsync(existingNote);
|
||||
return existingNote;
|
||||
},
|
||||
|
||||
@@ -3,17 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@expo/entity-full-integration-tests",
|
||||
"private": true,
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Full redis and knex integration tests for the entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
@@ -27,8 +27,8 @@
|
||||
"@expo/entity-database-adapter-knex": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.26.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.26.0",
|
||||
"@expo/entity-database-adapter-knex": "^0.26.0"
|
||||
"@expo/entity": "^0.25.3",
|
||||
"@expo/entity-cache-adapter-redis": "^0.25.3",
|
||||
"@expo/entity-database-adapter-knex": "^0.25.3"
|
||||
}
|
||||
}
|
||||
+13
-13
@@ -92,8 +92,11 @@ async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
|
||||
}
|
||||
|
||||
async function dropPostgresTable(knex: Knex): Promise<void> {
|
||||
if (await knex.schema.hasTable('testentities')) {
|
||||
await knex.schema.dropTable('testentities');
|
||||
if (await knex.schema.hasTable('children')) {
|
||||
await knex.schema.dropTable('children');
|
||||
}
|
||||
if (await knex.schema.hasTable('parents')) {
|
||||
await knex.schema.dropTable('parents');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -150,10 +153,8 @@ describe('Entity cache inconsistency', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
// put entities in cache and dataloader
|
||||
await TestEntity.loader(viewerContext).enforcing().loadByIDAsync(entity1.getID());
|
||||
await TestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('other_string', 'hello');
|
||||
await TestEntity.loader(viewerContext).loadByIDAsync(entity1.getID());
|
||||
await TestEntity.loader(viewerContext).loadByFieldEqualingAsync('other_string', 'hello');
|
||||
|
||||
let openBarrier1: () => void;
|
||||
const barrier1 = new Promise<void>((resolve) => {
|
||||
@@ -176,7 +177,7 @@ describe('Entity cache inconsistency', () => {
|
||||
const viewerContextInternal = new ViewerContext(
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
await TestEntity.loader(viewerContextInternal).enforcing().loadByIDAsync(entity1.getID());
|
||||
await TestEntity.loader(viewerContextInternal).loadByIDAsync(entity1.getID());
|
||||
|
||||
openBarrier2!();
|
||||
})(),
|
||||
@@ -200,12 +201,11 @@ describe('Entity cache inconsistency', () => {
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const loadedById = await TestEntity.loader(viewerContextLast)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1.getID());
|
||||
const loadedByField = await TestEntity.loader(viewerContextLast)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('other_string', 'hello');
|
||||
const loadedById = await TestEntity.loader(viewerContextLast).loadByIDAsync(entity1.getID());
|
||||
const loadedByField = await TestEntity.loader(viewerContextLast).loadByFieldEqualingAsync(
|
||||
'other_string',
|
||||
'hello'
|
||||
);
|
||||
|
||||
expect(loadedById.getField('third_string')).toEqual('updated');
|
||||
expect(loadedByField!.getField('third_string')).toEqual('updated');
|
||||
|
||||
+4
-6
@@ -87,22 +87,20 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_id', parent.getID())
|
||||
ChildEntity.loader(viewerContext).loadByFieldEqualingAsync('parent_id', parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
await ParentEntity.enforceDeleteAsync(parent);
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
+9
-32
@@ -135,40 +135,26 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
|
||||
await knex.schema.createTable(othersTableName, (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY) {
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
|
||||
table
|
||||
.uuid('parent_category_id')
|
||||
.references('id')
|
||||
.inTable(categoriesTableName)
|
||||
.unique()
|
||||
.onDelete('cascade');
|
||||
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
|
||||
table
|
||||
.uuid('parent_category_id')
|
||||
.references('id')
|
||||
.inTable(categoriesTableName)
|
||||
.unique()
|
||||
.onDelete('set null');
|
||||
} else {
|
||||
table.uuid('parent_category_id').unique();
|
||||
}
|
||||
});
|
||||
|
||||
await knex.schema.alterTable(categoriesTableName, (table) => {
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY) {
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
|
||||
table
|
||||
.uuid('parent_other_id')
|
||||
.references('id')
|
||||
.inTable(othersTableName)
|
||||
.unique()
|
||||
.onDelete('cascade');
|
||||
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
|
||||
table
|
||||
.uuid('parent_other_id')
|
||||
.references('id')
|
||||
.inTable(othersTableName)
|
||||
.unique()
|
||||
.onDelete('set null');
|
||||
} else {
|
||||
table.uuid('parent_other_id').unique();
|
||||
}
|
||||
@@ -214,9 +200,8 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
|
||||
it.each([
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE,
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
|
||||
EntityEdgeDeletionBehavior.SET_NULL,
|
||||
EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY,
|
||||
])('behavior: %p', async (edgeDeletionBehavior) => {
|
||||
const { CategoryEntity, OtherEntity } = await makeEntityClasses(
|
||||
knexInstance,
|
||||
@@ -239,26 +224,18 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL) {
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(category1.getID())
|
||||
).resolves.toBeNull();
|
||||
const otherLoaded = await OtherEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDNullableAsync(other1.getID());
|
||||
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
|
||||
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||
).resolves.toBeNull();
|
||||
const otherLoaded = await OtherEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDNullableAsync(other1.getID());
|
||||
const otherLoaded = await OtherEntity.loader(viewerContext).loadByIDNullableAsync(
|
||||
other1.getID()
|
||||
);
|
||||
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
|
||||
} else {
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(category1.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
OtherEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(other1.getID())
|
||||
OtherEntity.loader(viewerContext).loadByIDNullableAsync(other1.getID())
|
||||
).resolves.toBeNull();
|
||||
}
|
||||
});
|
||||
|
||||
+1
-1
@@ -56,7 +56,7 @@ const childEntityConfiguration = new EntityConfiguration<ChildFields>({
|
||||
cache: true,
|
||||
association: {
|
||||
getAssociatedEntityClass: () => ParentEntity,
|
||||
edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
|
||||
edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
|
||||
},
|
||||
}),
|
||||
},
|
||||
|
||||
@@ -3,14 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-ip-address-field",
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "IP address EntityField definitions for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -28,7 +28,7 @@
|
||||
"ip-address": "^8.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.26.0",
|
||||
"@expo/entity": "^0.25.3",
|
||||
"@types/jsbn": "^1.2.29"
|
||||
},
|
||||
"peerDependencies": {
|
||||
|
||||
@@ -3,14 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-secondary-cache-local-memory",
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Local memory secondary cache for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -31,8 +31,8 @@
|
||||
"@expo/entity-cache-adapter-local-memory": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.26.0",
|
||||
"@expo/entity-cache-adapter-local-memory": "^0.26.0",
|
||||
"@expo/entity": "^0.25.3",
|
||||
"@expo/entity-cache-adapter-local-memory": "^0.25.3",
|
||||
"nullthrows": "^1.1.1"
|
||||
}
|
||||
}
|
||||
+3
-5
@@ -159,11 +159,9 @@ class TestSecondaryLocalMemoryCacheLoader extends EntitySecondaryCacheLoader<
|
||||
}
|
||||
return nullthrows(
|
||||
(
|
||||
await this.entityLoader
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
await this.entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
)[0]
|
||||
).getAllFields();
|
||||
});
|
||||
|
||||
@@ -3,17 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-secondary-cache-redis",
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Redis secondary cache for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -30,10 +30,12 @@
|
||||
"@expo/entity": "*",
|
||||
"@expo/entity-cache-adapter-redis": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"ioredis": "^4.17.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.26.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.26.0",
|
||||
"ioredis": "^5.0.4",
|
||||
"@expo/entity": "^0.25.3",
|
||||
"@expo/entity-cache-adapter-redis": "^0.25.3",
|
||||
"nullthrows": "^1.1.1"
|
||||
}
|
||||
}
|
||||
+3
-5
@@ -40,11 +40,9 @@ class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
|
||||
}
|
||||
return nullthrows(
|
||||
(
|
||||
await this.entityLoader
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
await this.entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
)[0]
|
||||
).getAllFields();
|
||||
});
|
||||
|
||||
@@ -3,17 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity",
|
||||
"version": "0.26.0",
|
||||
"version": "0.25.3",
|
||||
"description": "A privacy-first data model",
|
||||
"files": [
|
||||
"build",
|
||||
|
||||
@@ -1,144 +0,0 @@
|
||||
import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import { mapMap } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* Enforcing view on an entity loader. All loads through this loader will throw
|
||||
* if the loads are not successful.
|
||||
*/
|
||||
export default class EnforcingEntityLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
constructor(
|
||||
private readonly entityLoader: EntityLoader<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>
|
||||
) {}
|
||||
|
||||
/**
|
||||
* 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 Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly TEntity[]>> {
|
||||
const fieldValuesToResults = await this.entityLoader.loadManyByFieldEqualingManyAsync(
|
||||
fieldName,
|
||||
fieldValues
|
||||
);
|
||||
return mapMap(fieldValuesToResults, (results) =>
|
||||
results.map((result) => result.enforceValue())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.entityLoader.loadManyByFieldEqualingAsync(
|
||||
fieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @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 Pick<TFields, TSelectedFields>>(
|
||||
uniqueFieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<TEntity | null> {
|
||||
const entityResult = await this.entityLoader.loadByFieldEqualingAsync(
|
||||
uniqueFieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
|
||||
*/
|
||||
async loadByIDAsync(id: TID): Promise<TEntity> {
|
||||
const entityResult = await this.entityLoader.loadByIDAsync(id);
|
||||
return entityResult.enforceValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
|
||||
* @throws when multiple entities are found matching the condition
|
||||
*/
|
||||
async loadByIDNullableAsync(id: TID): Promise<TEntity | null> {
|
||||
const entityResult = await this.entityLoader.loadByIDNullableAsync(id);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, TEntity>> {
|
||||
const entityResults = await this.entityLoader.loadManyByIDsAsync(ids);
|
||||
return mapMap(entityResults, (result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.entityLoader.loadManyByFieldEqualityConjunctionAsync(
|
||||
fieldEqualityOperands,
|
||||
querySelectionModifiers
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.entityLoader.loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause,
|
||||
bindings,
|
||||
querySelectionModifiers
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
}
|
||||
@@ -69,7 +69,7 @@ export default abstract class Entity<
|
||||
return viewerContext
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getMutatorFactory()
|
||||
.forCreate(queryContext);
|
||||
.forCreate(queryContext, { cascadingDeleteCause: null });
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -111,7 +111,7 @@ export default abstract class Entity<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getMutatorFactory()
|
||||
.forUpdate(existingEntity, queryContext);
|
||||
.forUpdate(existingEntity, queryContext, { cascadingDeleteCause: null });
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -152,7 +152,7 @@ export default abstract class Entity<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getMutatorFactory()
|
||||
.forDelete(existingEntity, queryContext)
|
||||
.forDelete(existingEntity, queryContext, { cascadingDeleteCause: null })
|
||||
.deleteAsync();
|
||||
}
|
||||
|
||||
@@ -194,7 +194,7 @@ export default abstract class Entity<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getMutatorFactory()
|
||||
.forDelete(existingEntity, queryContext)
|
||||
.forDelete(existingEntity, queryContext, { cascadingDeleteCause: null })
|
||||
.enforceDeleteAsync();
|
||||
}
|
||||
|
||||
|
||||
@@ -71,7 +71,9 @@ export default class EntityAssociationLoader<
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
|
||||
return (await loader.loadByIDAsync(associatedEntityID as unknown as TAssociatedID)) as Result<
|
||||
return (await loader.resultLoader.loadByIDAsync(
|
||||
associatedEntityID as unknown as TAssociatedID
|
||||
)) as Result<
|
||||
null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity
|
||||
>;
|
||||
}
|
||||
@@ -124,7 +126,7 @@ export default class EntityAssociationLoader<
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
return await loader.loadManyByFieldEqualingAsync(
|
||||
return await loader.resultLoader.loadManyByFieldEqualingAsync(
|
||||
associatedEntityFieldContainingThisID,
|
||||
thisID as any
|
||||
);
|
||||
@@ -181,7 +183,7 @@ export default class EntityAssociationLoader<
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
return await loader.loadByFieldEqualingAsync(
|
||||
return await loader.resultLoader.loadByFieldEqualingAsync(
|
||||
associatedEntityLookupByField,
|
||||
associatedFieldValue as any
|
||||
);
|
||||
@@ -239,7 +241,7 @@ export default class EntityAssociationLoader<
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
return await loader.loadManyByFieldEqualingAsync(
|
||||
return await loader.resultLoader.loadManyByFieldEqualingAsync(
|
||||
associatedEntityLookupByField,
|
||||
associatedFieldValue as any
|
||||
);
|
||||
|
||||
@@ -5,21 +5,13 @@ import ViewerContext from './ViewerContext';
|
||||
|
||||
export enum EntityEdgeDeletionBehavior {
|
||||
/**
|
||||
* Invalidate the cache for all entities that reference the entity
|
||||
* 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 and the entity framework just needs to
|
||||
* keys and cascading deletes or set nulls and the entity framework just needs to
|
||||
* be kept consistent with the state of the database.
|
||||
*/
|
||||
CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
|
||||
|
||||
/**
|
||||
* Invalidate the cache for all entities that reference the entity
|
||||
* being deleted through this field. This is most useful when the database itself expresses
|
||||
* foreign keys and cascading "SET NULL"s and the entity framework just needs to be
|
||||
* kept consistent with the state of the database.
|
||||
*/
|
||||
SET_NULL_INVALIDATE_CACHE_ONLY,
|
||||
CASCADE_DELETE_INVALIDATE_CACHE,
|
||||
|
||||
/**
|
||||
* Delete all entities that reference the entity being deleted through this field. This is very similar
|
||||
@@ -82,17 +74,16 @@ export interface EntityAssociationDefinition<
|
||||
*
|
||||
* @remarks
|
||||
* The entity framework doesn't prescribe a one-size-fits-all solution for referential
|
||||
* integrity; instead it exposes mechanisms that support both database foreign key constraints
|
||||
* 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.CASCADE_DELETE_INVALIDATE_CACHE_ONLY} or
|
||||
* {@link EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY} are recommended.
|
||||
* 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;
|
||||
edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,23 +1,14 @@
|
||||
import { Result, asyncResult, result } from '@expo/results';
|
||||
import invariant from 'invariant';
|
||||
|
||||
import EnforcingEntityLoader from './EnforcingEntityLoader';
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import {
|
||||
FieldEqualityCondition,
|
||||
QuerySelectionModifiers,
|
||||
isSingleValueFieldEqualityCondition,
|
||||
} from './EntityDatabaseAdapter';
|
||||
import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import EntityResultLoader from './EntityResultLoader';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
|
||||
import EntityNotFoundError from './errors/EntityNotFoundError';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
import { mapMap } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* The primary interface for loading entities. All normal loads are batched,
|
||||
@@ -37,12 +28,24 @@ export default class EntityLoader<
|
||||
>,
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
/**
|
||||
* Result-based view on an entity loader. All loads through this loader will wrap their results in Result.
|
||||
*/
|
||||
public readonly resultLoader: EntityResultLoader<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>;
|
||||
|
||||
constructor(
|
||||
private readonly viewerContext: TViewerContext,
|
||||
private readonly queryContext: EntityQueryContext,
|
||||
private readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
@@ -50,135 +53,105 @@ export default class EntityLoader<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly privacyPolicy: TPrivacyPolicy,
|
||||
privacyPolicy: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Enforcing view on this entity loader. All loads through this view are
|
||||
* 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,
|
||||
TSelectedFields
|
||||
> {
|
||||
return new EnforcingEntityLoader(this);
|
||||
) {
|
||||
this.resultLoader = new EntityResultLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entityConfiguration,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load many entities where fieldName is one of fieldValues.
|
||||
* @param fieldName - entity field being queried
|
||||
* @param fieldValues - fieldName field values being queried
|
||||
* @returns map from fieldValue to entity results that match the query for that fieldValue,
|
||||
* where result errors can be UnauthorizedError
|
||||
* @returns map from fieldValue to entities that match the query for that fieldValue
|
||||
*/
|
||||
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
|
||||
this.validateFieldValues(fieldName, fieldValues);
|
||||
|
||||
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
|
||||
this.queryContext,
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly TEntity[]>> {
|
||||
const fieldValuesToResults = await this.resultLoader.loadManyByFieldEqualingManyAsync(
|
||||
fieldName,
|
||||
fieldValues
|
||||
);
|
||||
|
||||
return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects);
|
||||
return mapMap(fieldValuesToResults, (results) =>
|
||||
results.map((result) => result.enforceValue())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load many entities where fieldName equals fieldValue.
|
||||
* @param fieldName - entity field being queried
|
||||
* @param fieldValue - fieldName field value being queried
|
||||
* @returns array of entity results that match the query for fieldValue, where result error can be UnauthorizedError
|
||||
* @returns array of entities that match the query for fieldValue
|
||||
*/
|
||||
async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const entityResults = await this.loadManyByFieldEqualingManyAsync(fieldName, [fieldValue]);
|
||||
const entityResultsForFieldValue = entityResults.get(fieldValue);
|
||||
invariant(
|
||||
entityResultsForFieldValue !== undefined,
|
||||
`${fieldValue} should be guaranteed to be present in returned map of entities`
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.resultLoader.loadManyByFieldEqualingAsync(
|
||||
fieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResultsForFieldValue!;
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an entity where fieldName equals fieldValue, or null if no entity exists.
|
||||
* @param uniqueFieldName - entity field being queried
|
||||
* @param fieldValue - uniqueFieldName field value being queried
|
||||
* @returns entity result where uniqueFieldName equals fieldValue, or null if no entity matches the condition.
|
||||
* @returns entity where uniqueFieldName equals fieldValue, or null if no entity matches the condition.
|
||||
* @throws when multiple entities match the condition
|
||||
*/
|
||||
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
uniqueFieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<Result<TEntity> | null> {
|
||||
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue);
|
||||
invariant(
|
||||
entityResults.length <= 1,
|
||||
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${String(
|
||||
uniqueFieldName
|
||||
)}=${fieldValue}`
|
||||
): Promise<TEntity | null> {
|
||||
const entityResult = await this.resultLoader.loadByFieldEqualingAsync(
|
||||
uniqueFieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResults[0] ?? null;
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads an entity by a specified ID.
|
||||
* @param id - ID of the entity
|
||||
* @returns entity result for matching ID, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
* @returns entity for matching ID
|
||||
*/
|
||||
async loadByIDAsync(id: TID): Promise<Result<TEntity>> {
|
||||
const entityResults = await this.loadManyByIDsAsync([id]);
|
||||
const entityResult = entityResults.get(id);
|
||||
if (entityResult === undefined) {
|
||||
return result(
|
||||
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
|
||||
);
|
||||
}
|
||||
return entityResult;
|
||||
async loadByIDAsync(id: TID): Promise<TEntity> {
|
||||
const entityResult = await this.resultLoader.loadByIDAsync(id);
|
||||
return entityResult.enforceValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an entity by a specified ID, or return null if non-existent.
|
||||
* @param id - ID of the entity
|
||||
* @returns entity result for matching ID, or null if no entity exists for ID.
|
||||
* @returns entity 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 as TSelectedFields,
|
||||
id
|
||||
);
|
||||
async loadByIDNullableAsync(id: TID): Promise<TEntity | null> {
|
||||
const entityResult = await this.resultLoader.loadByIDNullableAsync(id);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entities for a list of IDs.
|
||||
* @param viewerContext - viewer context of loading user
|
||||
* @param ids - IDs of the entities to load
|
||||
* @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
* @returns map from ID to corresponding entity
|
||||
*/
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
|
||||
const entityResults = (await this.loadManyByFieldEqualingManyAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
ids
|
||||
)) 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))
|
||||
);
|
||||
});
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, TEntity>> {
|
||||
const entityResults = await this.resultLoader.loadManyByIDsAsync(ids);
|
||||
return mapMap(entityResults, (result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -193,41 +166,17 @@ export default class EntityLoader<
|
||||
*
|
||||
* @param fieldEqualityOperands - list of field equality WHERE clause operand specifications
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
* @returns array of entities that match the query
|
||||
*/
|
||||
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
for (const fieldEqualityOperand of fieldEqualityOperands) {
|
||||
const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
|
||||
? [fieldEqualityOperand.fieldValue]
|
||||
: fieldEqualityOperand.fieldValues;
|
||||
this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
|
||||
}
|
||||
|
||||
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
|
||||
this.queryContext,
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.resultLoader.loadManyByFieldEqualityConjunctionAsync(
|
||||
fieldEqualityOperands,
|
||||
querySelectionModifiers
|
||||
);
|
||||
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -250,7 +199,7 @@ export default class EntityLoader<
|
||||
* @param rawWhereClause - parameterized SQL WHERE clause with positional binding placeholders or named binding placeholders
|
||||
* @param bindings - array of positional bindings or object of named bindings
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
* @returns array of entities that match the query
|
||||
* @throws Error when rawWhereClause or bindings are invalid
|
||||
*
|
||||
* @deprecated prefer caching loaders
|
||||
@@ -259,30 +208,13 @@ export default class EntityLoader<
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync(
|
||||
this.queryContext,
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.resultLoader.loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause,
|
||||
bindings,
|
||||
querySelectionModifiers
|
||||
);
|
||||
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -301,63 +233,4 @@ export default class EntityLoader<
|
||||
async invalidateEntityAsync(entity: TEntity): Promise<void> {
|
||||
await this.invalidateFieldsAsync(entity.getAllDatabaseFields());
|
||||
}
|
||||
|
||||
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
|
||||
return fieldsObjects.map((fieldsObject) => {
|
||||
try {
|
||||
return result(new this.entityClass(this.viewerContext, fieldsObject));
|
||||
} catch (e) {
|
||||
if (!(e instanceof Error)) {
|
||||
throw e;
|
||||
}
|
||||
return result(e);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct and authorize entities from fields map, returning error results for entities that fail
|
||||
* to construct or fail to authorize.
|
||||
*
|
||||
* @param map - map from an arbitrary key type to an array of entity field objects
|
||||
*/
|
||||
public async constructAndAuthorizeEntitiesAsync<K>(
|
||||
map: ReadonlyMap<K, readonly Readonly<TFields>[]>
|
||||
): Promise<ReadonlyMap<K, readonly Result<TEntity>[]>> {
|
||||
const uncheckedEntityResultsMap = mapMap(map, (fieldObjects) =>
|
||||
this.tryConstructEntities(fieldObjects)
|
||||
);
|
||||
return await mapMapAsync(uncheckedEntityResultsMap, async (uncheckedEntityResults) => {
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
private validateFieldValues<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly TFields[N][]
|
||||
): void {
|
||||
const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
|
||||
invariant(fieldDefinition, `must have field definition for field = ${String(fieldName)}`);
|
||||
for (const fieldValue of fieldValues) {
|
||||
const isInputValid = fieldDefinition.validateInputValue(fieldValue);
|
||||
if (!isInputValid) {
|
||||
throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -20,7 +20,6 @@ export type EntityValidatorMutationInfo<
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -51,7 +50,6 @@ export type EntityTriggerMutationInfo<
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.DELETE;
|
||||
|
||||
@@ -18,7 +18,7 @@ import EntityMutationTriggerConfiguration, {
|
||||
EntityNonTransactionalMutationTrigger,
|
||||
} from './EntityMutationTriggerConfiguration';
|
||||
import EntityMutationValidator from './EntityMutationValidator';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -44,6 +44,7 @@ abstract class BaseMutator<
|
||||
constructor(
|
||||
protected readonly viewerContext: TViewerContext,
|
||||
protected readonly queryContext: EntityQueryContext,
|
||||
protected readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
protected readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
protected readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
@@ -182,7 +183,7 @@ export class CreateMutator<
|
||||
|
||||
/**
|
||||
* Commit the new entity after authorizing against creation privacy rules. Invalidates all caches for
|
||||
* queries that would return new entity.
|
||||
* queries that would return new entity and caches the new entity if not in a transactional query context.
|
||||
* @returns authorized, cached, newly-created entity result, where result error can be UnauthorizedError
|
||||
*/
|
||||
async createAsync(): Promise<Result<TEntity>> {
|
||||
@@ -220,7 +221,7 @@ export class CreateMutator<
|
||||
this.privacyPolicy.authorizeCreateAsync(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
{ cascadingDeleteCause: null },
|
||||
this.privacyPolicyEvaluationContext,
|
||||
temporaryEntityForPrivacyCheck,
|
||||
this.metricsAdapter
|
||||
)
|
||||
@@ -250,17 +251,17 @@ export class CreateMutator<
|
||||
|
||||
const insertResult = await this.databaseAdapter.insertAsync(queryContext, this.fieldsForEntity);
|
||||
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext, {
|
||||
cascadingDeleteCause: null,
|
||||
});
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
this.privacyPolicyEvaluationContext
|
||||
);
|
||||
queryContext.appendPostCommitInvalidationCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult)
|
||||
);
|
||||
|
||||
const unauthorizedEntityAfterInsert = new this.entityClass(this.viewerContext, insertResult);
|
||||
const newEntity = await entityLoader
|
||||
.enforcing()
|
||||
.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
|
||||
const newEntity = await entityLoader.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
|
||||
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterCreate,
|
||||
@@ -312,6 +313,7 @@ export class UpdateMutator<
|
||||
constructor(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
@@ -351,6 +353,7 @@ export class UpdateMutator<
|
||||
super(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entityConfiguration,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
@@ -377,7 +380,8 @@ export class UpdateMutator<
|
||||
|
||||
/**
|
||||
* Commit the changes to the entity after authorizing against update privacy rules.
|
||||
* Invalidates all caches for pre-update entity.
|
||||
* Invalidates all caches for pre-update entity and caches the updated entity if not in a
|
||||
* transactional query context.
|
||||
* @returns authorized updated entity result, where result error can be UnauthorizedError
|
||||
*/
|
||||
async updateAsync(): Promise<Result<TEntity>> {
|
||||
@@ -385,7 +389,7 @@ export class UpdateMutator<
|
||||
this.metricsAdapter,
|
||||
EntityMetricsMutationType.UPDATE,
|
||||
this.entityClass.name
|
||||
)(this.updateInTransactionAsync(false, null));
|
||||
)(this.updateInTransactionAsync());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -395,27 +399,14 @@ export class UpdateMutator<
|
||||
return await enforceAsyncResult(this.updateAsync());
|
||||
}
|
||||
|
||||
private async updateInTransactionAsync(
|
||||
skipDatabaseUpdate: true,
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo
|
||||
): Promise<Result<TEntity>>;
|
||||
private async updateInTransactionAsync(
|
||||
skipDatabaseUpdate: false,
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null
|
||||
): Promise<Result<TEntity>>;
|
||||
private async updateInTransactionAsync(
|
||||
skipDatabaseUpdate: boolean,
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null
|
||||
): Promise<Result<TEntity>> {
|
||||
private async updateInTransactionAsync(): Promise<Result<TEntity>> {
|
||||
return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
|
||||
this.updateInternalAsync(innerQueryContext, skipDatabaseUpdate, cascadingDeleteCause)
|
||||
this.updateInternalAsync(innerQueryContext)
|
||||
);
|
||||
}
|
||||
|
||||
private async updateInternalAsync(
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
skipDatabaseUpdate: boolean,
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null
|
||||
queryContext: EntityTransactionalQueryContext
|
||||
): Promise<Result<TEntity>> {
|
||||
this.validateFields(this.updatedFields);
|
||||
|
||||
@@ -424,7 +415,7 @@ export class UpdateMutator<
|
||||
this.privacyPolicy.authorizeUpdateAsync(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
{ cascadingDeleteCause },
|
||||
this.privacyPolicyEvaluationContext,
|
||||
entityAboutToBeUpdated,
|
||||
this.metricsAdapter
|
||||
)
|
||||
@@ -437,34 +428,33 @@ export class UpdateMutator<
|
||||
this.mutationValidators,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause }
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
);
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.beforeAll,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause }
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
);
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.beforeUpdate,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause }
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
);
|
||||
|
||||
// skip the database update when specified
|
||||
const updateResult = skipDatabaseUpdate
|
||||
? null
|
||||
: await this.databaseAdapter.updateAsync(
|
||||
queryContext,
|
||||
this.entityConfiguration.idField,
|
||||
entityAboutToBeUpdated.getID(),
|
||||
this.updatedFields
|
||||
);
|
||||
const updateResult = await this.databaseAdapter.updateAsync(
|
||||
queryContext,
|
||||
this.entityConfiguration.idField,
|
||||
entityAboutToBeUpdated.getID(),
|
||||
this.updatedFields
|
||||
);
|
||||
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext, {
|
||||
cascadingDeleteCause,
|
||||
});
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
this.privacyPolicyEvaluationContext
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitInvalidationCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(
|
||||
@@ -476,25 +466,20 @@ export class UpdateMutator<
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.fieldsForEntity)
|
||||
);
|
||||
|
||||
// when the database update was skipped, assume it succeeded and use the optimistic
|
||||
// entity to execute triggers
|
||||
const updatedEntity = updateResult
|
||||
? await entityLoader
|
||||
.enforcing()
|
||||
.loadByIDAsync(new this.entityClass(this.viewerContext, updateResult).getID())
|
||||
: entityAboutToBeUpdated;
|
||||
const unauthorizedEntityAfterUpdate = new this.entityClass(this.viewerContext, updateResult);
|
||||
const updatedEntity = await entityLoader.loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
|
||||
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterUpdate,
|
||||
queryContext,
|
||||
updatedEntity,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause }
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
);
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterAll,
|
||||
queryContext,
|
||||
updatedEntity,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause }
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
@@ -502,11 +487,7 @@ export class UpdateMutator<
|
||||
this,
|
||||
this.mutationTriggers.afterCommit,
|
||||
updatedEntity,
|
||||
{
|
||||
type: EntityMutationType.UPDATE,
|
||||
previousValue: this.originalEntity,
|
||||
cascadingDeleteCause,
|
||||
}
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
)
|
||||
);
|
||||
|
||||
@@ -534,6 +515,7 @@ export class DeleteMutator<
|
||||
constructor(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
@@ -573,6 +555,7 @@ export class DeleteMutator<
|
||||
super(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entityConfiguration,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
@@ -772,7 +755,7 @@ export class DeleteMutator<
|
||||
if (associatedEntityLookupByField) {
|
||||
inboundReferenceEntities = await loaderFactory
|
||||
.forLoad(queryContext, { cascadingDeleteCause: newCascadingDeleteCause })
|
||||
.enforcing()
|
||||
|
||||
.loadManyByFieldEqualingAsync(
|
||||
fieldName,
|
||||
entity.getField(associatedEntityLookupByField as any)
|
||||
@@ -780,39 +763,24 @@ export class DeleteMutator<
|
||||
} else {
|
||||
inboundReferenceEntities = await loaderFactory
|
||||
.forLoad(queryContext, { cascadingDeleteCause: newCascadingDeleteCause })
|
||||
.enforcing()
|
||||
|
||||
.loadManyByFieldEqualingAsync(fieldName, entity.getID());
|
||||
}
|
||||
|
||||
switch (association.edgeDeletionBehavior) {
|
||||
case EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY: {
|
||||
case undefined:
|
||||
case EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE: {
|
||||
await Promise.all(
|
||||
inboundReferenceEntities.map((inboundReferenceEntity) =>
|
||||
enforceAsyncResult(
|
||||
mutatorFactory
|
||||
.forDelete(inboundReferenceEntity, queryContext)
|
||||
.deleteInTransactionAsync(
|
||||
processedEntityIdentifiers,
|
||||
/* skipDatabaseDeletion */ true, // deletion is handled by DB
|
||||
newCascadingDeleteCause
|
||||
)
|
||||
)
|
||||
)
|
||||
);
|
||||
break;
|
||||
}
|
||||
case EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY: {
|
||||
await Promise.all(
|
||||
inboundReferenceEntities.map((inboundReferenceEntity) =>
|
||||
enforceAsyncResult(
|
||||
mutatorFactory
|
||||
.forUpdate(inboundReferenceEntity, queryContext)
|
||||
.setField(fieldName, null)
|
||||
['updateInTransactionAsync'](
|
||||
/* skipDatabaseUpdate */ true,
|
||||
newCascadingDeleteCause
|
||||
)
|
||||
)
|
||||
mutatorFactory
|
||||
.forDelete(inboundReferenceEntity, queryContext, {
|
||||
cascadingDeleteCause: newCascadingDeleteCause,
|
||||
})
|
||||
.deleteInTransactionAsync(
|
||||
processedEntityIdentifiers,
|
||||
/* skipDatabaseDeletion */ true, // deletion is handled by DB
|
||||
newCascadingDeleteCause
|
||||
)
|
||||
)
|
||||
);
|
||||
break;
|
||||
@@ -820,15 +788,12 @@ export class DeleteMutator<
|
||||
case EntityEdgeDeletionBehavior.SET_NULL: {
|
||||
await Promise.all(
|
||||
inboundReferenceEntities.map((inboundReferenceEntity) =>
|
||||
enforceAsyncResult(
|
||||
mutatorFactory
|
||||
.forUpdate(inboundReferenceEntity, queryContext)
|
||||
.setField(fieldName, null)
|
||||
['updateInTransactionAsync'](
|
||||
/* skipDatabaseUpdate */ false,
|
||||
newCascadingDeleteCause
|
||||
)
|
||||
)
|
||||
mutatorFactory
|
||||
.forUpdate(inboundReferenceEntity, queryContext, {
|
||||
cascadingDeleteCause: newCascadingDeleteCause,
|
||||
})
|
||||
.setField(fieldName, null)
|
||||
.enforceUpdateAsync()
|
||||
)
|
||||
);
|
||||
break;
|
||||
@@ -836,15 +801,15 @@ export class DeleteMutator<
|
||||
case EntityEdgeDeletionBehavior.CASCADE_DELETE: {
|
||||
await Promise.all(
|
||||
inboundReferenceEntities.map((inboundReferenceEntity) =>
|
||||
enforceAsyncResult(
|
||||
mutatorFactory
|
||||
.forDelete(inboundReferenceEntity, queryContext)
|
||||
.deleteInTransactionAsync(
|
||||
processedEntityIdentifiers,
|
||||
/* skipDatabaseDeletion */ false,
|
||||
newCascadingDeleteCause
|
||||
)
|
||||
)
|
||||
mutatorFactory
|
||||
.forDelete(inboundReferenceEntity, queryContext, {
|
||||
cascadingDeleteCause: newCascadingDeleteCause,
|
||||
})
|
||||
.deleteInTransactionAsync(
|
||||
processedEntityIdentifiers,
|
||||
/* skipDatabaseDeletion */ false,
|
||||
newCascadingDeleteCause
|
||||
)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
@@ -5,7 +5,7 @@ import EntityLoaderFactory from './EntityLoaderFactory';
|
||||
import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
|
||||
import EntityMutationValidator from './EntityMutationValidator';
|
||||
import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
@@ -72,11 +72,13 @@ export default class EntityMutatorFactory<
|
||||
*/
|
||||
forCreate(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return new CreateMutator(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
this.entityConfiguration,
|
||||
this.entityClass,
|
||||
this.privacyPolicy,
|
||||
@@ -96,11 +98,13 @@ export default class EntityMutatorFactory<
|
||||
*/
|
||||
forUpdate(
|
||||
existingEntity: TEntity,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return new UpdateMutator(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
this.entityConfiguration,
|
||||
this.entityClass,
|
||||
this.privacyPolicy,
|
||||
@@ -120,11 +124,13 @@ export default class EntityMutatorFactory<
|
||||
*/
|
||||
forDelete(
|
||||
existingEntity: TEntity,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return new DeleteMutator(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
this.entityConfiguration,
|
||||
this.entityClass,
|
||||
this.privacyPolicy,
|
||||
|
||||
@@ -19,24 +19,9 @@ export type EntityPrivacyPolicyEvaluationContext = {
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
};
|
||||
|
||||
/**
|
||||
* Evaluation mode for a {@link EntityPrivacyPolicy}. Useful when transitioning to
|
||||
* using Entity for privacy.
|
||||
*/
|
||||
export enum EntityPrivacyPolicyEvaluationMode {
|
||||
/**
|
||||
* Enforce this privacy policy. Throw upon denial.
|
||||
*/
|
||||
ENFORCE,
|
||||
|
||||
/**
|
||||
* Do not enforce this privacy policy. Always allow but log when it would have denied.
|
||||
*/
|
||||
DRY_RUN,
|
||||
|
||||
/**
|
||||
* Enforce this privacy policy. Throw and log upon denial.
|
||||
*/
|
||||
ENFORCE_AND_LOG,
|
||||
}
|
||||
|
||||
|
||||
@@ -29,12 +29,6 @@ export abstract class EntityQueryContext {
|
||||
): Promise<T>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Entity framework representation of a non-transactional query execution unit.
|
||||
* When supplied to {@link EntityMutator} and {@link EntityLoader} methods, they will be
|
||||
* run independently of any running transaction (though mutations start their own
|
||||
* independent transactions internally when not being run in a transaction).
|
||||
*/
|
||||
export class EntityNonTransactionalQueryContext extends EntityQueryContext {
|
||||
constructor(
|
||||
queryInterface: any,
|
||||
@@ -54,11 +48,6 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Entity framework representation of a transactional query execution unit. When supplied
|
||||
* to {@link EntityMutator} and {@link EntityLoader} methods, those methods and their
|
||||
* dependent triggers and validators will run within the transaction.
|
||||
*/
|
||||
export class EntityTransactionalQueryContext extends EntityQueryContext {
|
||||
private readonly postCommitInvalidationCallbacks: PostCommitCallback[] = [];
|
||||
private readonly postCommitCallbacks: PostCommitCallback[] = [];
|
||||
|
||||
@@ -0,0 +1,326 @@
|
||||
import { Result, asyncResult, result } from '@expo/results';
|
||||
import invariant from 'invariant';
|
||||
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import {
|
||||
FieldEqualityCondition,
|
||||
QuerySelectionModifiers,
|
||||
isSingleValueFieldEqualityCondition,
|
||||
} from './EntityDatabaseAdapter';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
|
||||
import EntityNotFoundError from './errors/EntityNotFoundError';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* Result-based view on an entity loader. All loads through this loader will wrap their results in Result.
|
||||
*/
|
||||
export default class EntityResultLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
constructor(
|
||||
private readonly viewerContext: TViewerContext,
|
||||
private readonly queryContext: EntityQueryContext,
|
||||
private readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly privacyPolicy: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Load many entity results where fieldName is one of fieldValues.
|
||||
* @param fieldName - entity field being queried
|
||||
* @param fieldValues - fieldName field values being queried
|
||||
* @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 Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
|
||||
this.validateFieldValues(fieldName, fieldValues);
|
||||
|
||||
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
|
||||
this.queryContext,
|
||||
fieldName,
|
||||
fieldValues
|
||||
);
|
||||
|
||||
return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load many entity results where fieldName equals fieldValue.
|
||||
* @param fieldName - entity field being queried
|
||||
* @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 Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const entityResults = await this.loadManyByFieldEqualingManyAsync(fieldName, [fieldValue]);
|
||||
const entityResultsForFieldValue = entityResults.get(fieldValue);
|
||||
invariant(
|
||||
entityResultsForFieldValue !== undefined,
|
||||
`${fieldValue} should be guaranteed to be present in returned map of entities`
|
||||
);
|
||||
return entityResultsForFieldValue!;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an entity result where fieldName equals fieldValue, or null if no entity exists.
|
||||
* @param uniqueFieldName - entity field being queried
|
||||
* @param fieldValue - uniqueFieldName field value being queried
|
||||
* @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 Pick<TFields, TSelectedFields>>(
|
||||
uniqueFieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<Result<TEntity> | null> {
|
||||
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue);
|
||||
invariant(
|
||||
entityResults.length <= 1,
|
||||
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${uniqueFieldName}=${fieldValue}`
|
||||
);
|
||||
return entityResults[0] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads an entityresult by a specified ID.
|
||||
* @param id - ID of the entity
|
||||
* @returns entity result for matching ID, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
*/
|
||||
async loadByIDAsync(id: TID): Promise<Result<TEntity>> {
|
||||
const entityResults = await this.loadManyByIDsAsync([id]);
|
||||
const entityResult = entityResults.get(id);
|
||||
if (entityResult === undefined) {
|
||||
return result(
|
||||
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
|
||||
);
|
||||
}
|
||||
return entityResult;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an entity result by a specified ID, or return null if non-existent.
|
||||
* @param id - ID of the entity
|
||||
* @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 as TSelectedFields,
|
||||
id
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entity results for a list of IDs.
|
||||
* @param viewerContext - viewer context of loading user
|
||||
* @param ids - IDs of the entities to load
|
||||
* @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
*/
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
|
||||
const entityResults = (await this.loadManyByFieldEqualingManyAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
ids
|
||||
)) 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))
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entity results matching the conjunction of WHERE clauses constructed from specified operands.
|
||||
* Entities loaded using this method are not batched or cached.
|
||||
*
|
||||
* @example
|
||||
* fieldEqualityOperands:
|
||||
* `[{fieldName: 'hello', fieldValue: 1}, {fieldName: 'world', fieldValues: [2, 3]}]`
|
||||
* Entities returned:
|
||||
* `WHERE hello = 1 AND world = ANY({2, 3})`
|
||||
*
|
||||
* @param fieldEqualityOperands - list of field equality WHERE clause operand specifications
|
||||
* @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 Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
for (const fieldEqualityOperand of fieldEqualityOperands) {
|
||||
const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
|
||||
? [fieldEqualityOperand.fieldValue]
|
||||
: fieldEqualityOperand.fieldValues;
|
||||
this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
|
||||
}
|
||||
|
||||
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
|
||||
this.queryContext,
|
||||
fieldEqualityOperands,
|
||||
querySelectionModifiers
|
||||
);
|
||||
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entity results matching the raw WHERE clause. Corresponds to the knex `whereRaw` argument format.
|
||||
*
|
||||
* @remarks
|
||||
* Important notes:
|
||||
* - Fields in clause are database column names instead of transformed entity field names.
|
||||
* - Entities loaded using this method are not batched or cached.
|
||||
* - Not all database adapters implement the ability to execute this method of fetching entities.
|
||||
*
|
||||
* @example
|
||||
* rawWhereClause: `id = ?`
|
||||
* bindings: `[1]`
|
||||
* Entites returned `WHERE id = 1`
|
||||
*
|
||||
* {@link http://knexjs.org/#Builder-whereRaw}
|
||||
* {@link http://knexjs.org/#Raw-Bindings}
|
||||
*
|
||||
* @param rawWhereClause - parameterized SQL WHERE clause with positional binding placeholders or named binding placeholders
|
||||
* @param bindings - array of positional bindings or object of named bindings
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
* @throws Error when rawWhereClause or bindings are invalid
|
||||
*
|
||||
* @deprecated prefer caching loaders
|
||||
*/
|
||||
async loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync(
|
||||
this.queryContext,
|
||||
rawWhereClause,
|
||||
bindings,
|
||||
querySelectionModifiers
|
||||
);
|
||||
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
|
||||
return fieldsObjects.map((fieldsObject) => {
|
||||
try {
|
||||
return result(new this.entityClass(this.viewerContext, fieldsObject));
|
||||
} catch (e) {
|
||||
if (!(e instanceof Error)) {
|
||||
throw e;
|
||||
}
|
||||
return result(e);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct and authorize entities from fields map, returning error results for entities that fail
|
||||
* to construct or fail to authorize.
|
||||
*
|
||||
* @param map - map from an arbitrary key type to an array of entity field objects
|
||||
*/
|
||||
public async constructAndAuthorizeEntitiesAsync<K>(
|
||||
map: ReadonlyMap<K, readonly Readonly<TFields>[]>
|
||||
): Promise<ReadonlyMap<K, readonly Result<TEntity>[]>> {
|
||||
const uncheckedEntityResultsMap = mapMap(map, (fieldObjects) =>
|
||||
this.tryConstructEntities(fieldObjects)
|
||||
);
|
||||
return await mapMapAsync(uncheckedEntityResultsMap, async (uncheckedEntityResults) => {
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
private validateFieldValues<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly TFields[N][]
|
||||
): void {
|
||||
const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
|
||||
invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
|
||||
for (const fieldValue of fieldValues) {
|
||||
const isInputValid = fieldDefinition.validateInputValue(fieldValue);
|
||||
if (!isInputValid) {
|
||||
throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
|
||||
import EntityMutatorFactory from './EntityMutatorFactory';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -35,22 +35,37 @@ export default class ViewerScopedEntityMutatorFactory<
|
||||
) {}
|
||||
|
||||
forCreate(
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return this.entityMutatorFactory.forCreate(this.viewerContext, queryContext);
|
||||
return this.entityMutatorFactory.forCreate(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext
|
||||
);
|
||||
}
|
||||
|
||||
forUpdate(
|
||||
existingEntity: TEntity,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return this.entityMutatorFactory.forUpdate(existingEntity, queryContext);
|
||||
return this.entityMutatorFactory.forUpdate(
|
||||
existingEntity,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext
|
||||
);
|
||||
}
|
||||
|
||||
forDelete(
|
||||
existingEntity: TEntity,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return this.entityMutatorFactory.forDelete(existingEntity, queryContext);
|
||||
return this.entityMutatorFactory.forDelete(
|
||||
existingEntity,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -95,7 +95,7 @@ class TestLocalCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): string {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${String(fieldName)}`);
|
||||
invariant(columnName, `database field mapping missing for ${fieldName}`);
|
||||
const parts = [
|
||||
this.entityConfiguration.tableName,
|
||||
`${this.entityConfiguration.cacheKeyVersion}`,
|
||||
|
||||
@@ -1,15 +1,17 @@
|
||||
import { result } from '@expo/results';
|
||||
import { mock, instance, when, anything } from 'ts-mockito';
|
||||
|
||||
import EnforcingEntityLoader from '../EnforcingEntityLoader';
|
||||
import EntityLoader from '../EntityLoader';
|
||||
import EnforcingEntityLoader from '../EntityResultLoader';
|
||||
|
||||
describe(EnforcingEntityLoader, () => {
|
||||
describe('loadManyByFieldEqualingManyAsync', () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadManyByFieldEqualingManyAsync(anything(), anything())).thenResolve(
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualingManyAsync(anything(), anything())
|
||||
).thenResolve(
|
||||
new Map(
|
||||
Object.entries({
|
||||
hello: [result(rejection)],
|
||||
@@ -26,7 +28,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadManyByFieldEqualingManyAsync(anything(), anything())).thenResolve(
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualingManyAsync(anything(), anything())
|
||||
).thenResolve(
|
||||
new Map(
|
||||
Object.entries({
|
||||
hello: [result(resolved)],
|
||||
@@ -51,9 +55,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadManyByFieldEqualingAsync(anything(), anything())).thenResolve([
|
||||
result(rejection),
|
||||
]);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve([result(rejection)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -64,9 +68,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadManyByFieldEqualingAsync(anything(), anything())).thenResolve([
|
||||
result(resolved),
|
||||
]);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve([result(resolved)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -79,9 +83,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
|
||||
result(rejection)
|
||||
);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve(result(rejection));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -92,9 +96,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
|
||||
result(resolved)
|
||||
);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve(result(resolved));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -105,9 +109,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns null when result is successful and no entity is found', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = null;
|
||||
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
|
||||
result(resolved)
|
||||
);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve(result(resolved));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -118,9 +122,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when multiple matching entities are found', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const multipleEntitiesError = new Error();
|
||||
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenReject(
|
||||
multipleEntitiesError
|
||||
);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
|
||||
).thenReject(multipleEntitiesError);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -133,7 +137,7 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadByIDAsync(anything())).thenResolve(result(rejection));
|
||||
when(entityLoaderMock.resultLoader.loadByIDAsync(anything())).thenResolve(result(rejection));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDAsync(anything())).rejects.toThrow(rejection);
|
||||
@@ -142,7 +146,7 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadByIDAsync(anything())).thenResolve(result(resolved));
|
||||
when(entityLoaderMock.resultLoader.loadByIDAsync(anything())).thenResolve(result(resolved));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDAsync(anything())).resolves.toEqual(resolved);
|
||||
@@ -153,7 +157,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(rejection));
|
||||
when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
|
||||
result(rejection)
|
||||
);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).rejects.toThrow(
|
||||
@@ -164,7 +170,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(resolved));
|
||||
when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
|
||||
result(resolved)
|
||||
);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).resolves.toEqual(
|
||||
@@ -175,7 +183,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns null when non-existent object', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = null;
|
||||
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(resolved));
|
||||
when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
|
||||
result(resolved)
|
||||
);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).resolves.toEqual(
|
||||
@@ -188,7 +198,7 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadManyByIDsAsync(anything())).thenResolve(
|
||||
when(entityLoaderMock.resultLoader.loadManyByIDsAsync(anything())).thenResolve(
|
||||
new Map(
|
||||
Object.entries({
|
||||
hello: result(rejection),
|
||||
@@ -203,7 +213,7 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadManyByIDsAsync(anything())).thenResolve(
|
||||
when(entityLoaderMock.resultLoader.loadManyByIDsAsync(anything())).thenResolve(
|
||||
new Map(
|
||||
Object.entries({
|
||||
hello: result(resolved),
|
||||
@@ -227,7 +237,10 @@ describe(EnforcingEntityLoader, () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(
|
||||
entityLoaderMock.loadManyByFieldEqualityConjunctionAsync(anything(), anything())
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualityConjunctionAsync(
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).thenResolve([result(rejection)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
@@ -240,7 +253,10 @@ describe(EnforcingEntityLoader, () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(
|
||||
entityLoaderMock.loadManyByFieldEqualityConjunctionAsync(anything(), anything())
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualityConjunctionAsync(
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).thenResolve([result(resolved)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
@@ -255,7 +271,11 @@ describe(EnforcingEntityLoader, () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(
|
||||
entityLoaderMock.loadManyByRawWhereClauseAsync(anything(), anything(), anything())
|
||||
entityLoaderMock.resultLoader.loadManyByRawWhereClauseAsync(
|
||||
anything(),
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).thenResolve([result(rejection)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
@@ -268,7 +288,11 @@ describe(EnforcingEntityLoader, () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(
|
||||
entityLoaderMock.loadManyByRawWhereClauseAsync(anything(), anything(), anything())
|
||||
entityLoaderMock.resultLoader.loadManyByRawWhereClauseAsync(
|
||||
anything(),
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).thenResolve([result(resolved)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
|
||||
@@ -129,15 +129,15 @@ it('runs through a common workflow', async () => {
|
||||
|
||||
// check that two people can't read each others data
|
||||
await expect(
|
||||
enforceAsyncResult(BlahEntity.loader(vc1).loadByIDAsync(blahOwner2.getID()))
|
||||
enforceAsyncResult(BlahEntity.loader(vc1).resultLoader.loadByIDAsync(blahOwner2.getID()))
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
await expect(
|
||||
enforceAsyncResult(BlahEntity.loader(vc2).loadByIDAsync(blahOwner1.getID()))
|
||||
enforceAsyncResult(BlahEntity.loader(vc2).resultLoader.loadByIDAsync(blahOwner1.getID()))
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
|
||||
// check that all of owner 1's objects can be loaded
|
||||
const results = await enforceResultsAsync(
|
||||
BlahEntity.loader(vc1).loadManyByFieldEqualingAsync('ownerID', vc1.getUserID()!)
|
||||
BlahEntity.loader(vc1).resultLoader.loadManyByFieldEqualingAsync('ownerID', vc1.getUserID()!)
|
||||
);
|
||||
expect(results).toHaveLength(2);
|
||||
|
||||
@@ -149,7 +149,10 @@ it('runs through a common workflow', async () => {
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
|
||||
// check that empty load many returns nothing
|
||||
const results2 = await BlahEntity.loader(vc1).loadManyByFieldEqualingManyAsync('ownerID', []);
|
||||
const results2 = await BlahEntity.loader(vc1).resultLoader.loadManyByFieldEqualingManyAsync(
|
||||
'ownerID',
|
||||
[]
|
||||
);
|
||||
for (const value in results2.values) {
|
||||
expect(value).toHaveLength(0);
|
||||
}
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
import invariant from 'invariant';
|
||||
|
||||
import Entity from '../Entity';
|
||||
import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
@@ -35,13 +33,9 @@ interface GrandChildFields {
|
||||
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
||||
const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
|
||||
const triggerExecutionCounts = {
|
||||
ParentEntityDeletion: 0,
|
||||
ChildEntityDeletion: 0,
|
||||
GrandChildEntityDeletion: 0,
|
||||
|
||||
ParentEntityUpdate: 0,
|
||||
ChildEntityUpdate: 0,
|
||||
GrandChildEntityUpdate: 0,
|
||||
ParentEntity: 0,
|
||||
ChildEntity: 0,
|
||||
GrandChildEntity: 0,
|
||||
};
|
||||
|
||||
const privacyPolicyEvaluationRecords = {
|
||||
@@ -113,7 +107,7 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
];
|
||||
}
|
||||
|
||||
class ParentCheckInfoDeletionTrigger extends EntityMutationTrigger<
|
||||
class ParentCheckInfoTrigger extends EntityMutationTrigger<
|
||||
ParentFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
@@ -125,37 +119,19 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
_entity: ParentEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<ParentFields, string, TestViewerContext, ParentEntity>
|
||||
): Promise<void> {
|
||||
invariant(mutationInfo.type === EntityMutationType.DELETE, 'invalid EntityMutationType');
|
||||
if (mutationInfo.type !== EntityMutationType.DELETE) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (mutationInfo.cascadingDeleteCause !== null) {
|
||||
throw new Error('Parent entity should not have casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.ParentEntityDeletion++;
|
||||
triggerExecutionCounts.ParentEntity++;
|
||||
}
|
||||
}
|
||||
|
||||
class ParentCheckInfoUpdateTrigger extends EntityMutationTrigger<
|
||||
ParentFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
ParentEntity
|
||||
> {
|
||||
async executeAsync(
|
||||
_viewerContext: TestViewerContext,
|
||||
_queryContext: EntityTransactionalQueryContext,
|
||||
_entity: ParentEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<ParentFields, string, TestViewerContext, ParentEntity>
|
||||
): Promise<void> {
|
||||
invariant(mutationInfo.type === EntityMutationType.UPDATE, 'invalid EntityMutationType');
|
||||
if (mutationInfo.cascadingDeleteCause !== null) {
|
||||
throw new Error('Parent entity should not have casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.ParentEntityUpdate++;
|
||||
}
|
||||
}
|
||||
|
||||
class ChildCheckInfoDeletionTrigger extends EntityMutationTrigger<
|
||||
class ChildCheckInfoTrigger extends EntityMutationTrigger<
|
||||
ChildFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
@@ -167,7 +143,10 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
_entity: ChildEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<ChildFields, string, TestViewerContext, ChildEntity>
|
||||
): Promise<void> {
|
||||
invariant(mutationInfo.type === EntityMutationType.DELETE, 'invalid EntityMutationType');
|
||||
if (mutationInfo.type !== EntityMutationType.DELETE) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (mutationInfo.cascadingDeleteCause === null) {
|
||||
throw new Error('Child entity should have casade delete cause');
|
||||
}
|
||||
@@ -183,43 +162,11 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
throw new Error('Child entity should not have two-level casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.ChildEntityDeletion++;
|
||||
triggerExecutionCounts.ChildEntity++;
|
||||
}
|
||||
}
|
||||
|
||||
class ChildCheckInfoUpdateTrigger extends EntityMutationTrigger<
|
||||
ChildFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
ChildEntity
|
||||
> {
|
||||
async executeAsync(
|
||||
_viewerContext: TestViewerContext,
|
||||
_queryContext: EntityTransactionalQueryContext,
|
||||
_entity: ChildEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<ChildFields, string, TestViewerContext, ChildEntity>
|
||||
): Promise<void> {
|
||||
invariant(mutationInfo.type === EntityMutationType.UPDATE, 'invalid EntityMutationType');
|
||||
if (mutationInfo.cascadingDeleteCause === null) {
|
||||
throw new Error('Child entity should have casade delete cause');
|
||||
}
|
||||
|
||||
const cascadingDeleteCauseEntity = mutationInfo.cascadingDeleteCause.entity;
|
||||
if (!(cascadingDeleteCauseEntity instanceof ParentEntity)) {
|
||||
throw new Error('Child entity should have casade delete cause entity of type ParentEntity');
|
||||
}
|
||||
|
||||
const secondLevelCascadingDeleteCause =
|
||||
mutationInfo.cascadingDeleteCause.cascadingDeleteCause;
|
||||
if (secondLevelCascadingDeleteCause) {
|
||||
throw new Error('Child entity should not have two-level casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.ChildEntityUpdate++;
|
||||
}
|
||||
}
|
||||
|
||||
class GrandChildCheckInfoDeletionTrigger extends EntityMutationTrigger<
|
||||
class GrandChildCheckInfoTrigger extends EntityMutationTrigger<
|
||||
GrandChildFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
@@ -236,7 +183,10 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
GrandChildEntity
|
||||
>
|
||||
): Promise<void> {
|
||||
invariant(mutationInfo.type === EntityMutationType.DELETE, 'invalid EntityMutationType');
|
||||
if (mutationInfo.type !== EntityMutationType.DELETE) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (mutationInfo.cascadingDeleteCause === null) {
|
||||
throw new Error('GrandChild entity should have cascade delete cause');
|
||||
}
|
||||
@@ -266,58 +216,7 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
throw new Error('GrandChild entity should not have three-level casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.GrandChildEntityDeletion++;
|
||||
}
|
||||
}
|
||||
|
||||
class GrandChildCheckInfoUpdateTrigger extends EntityMutationTrigger<
|
||||
GrandChildFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
GrandChildEntity
|
||||
> {
|
||||
async executeAsync(
|
||||
_viewerContext: TestViewerContext,
|
||||
_queryContext: EntityTransactionalQueryContext,
|
||||
_entity: GrandChildEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<
|
||||
GrandChildFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
GrandChildEntity
|
||||
>
|
||||
): Promise<void> {
|
||||
invariant(mutationInfo.type === EntityMutationType.UPDATE, 'invalid EntityMutationType');
|
||||
if (mutationInfo.cascadingDeleteCause === null) {
|
||||
throw new Error('GrandChild entity should have cascade delete cause');
|
||||
}
|
||||
|
||||
const cascadingDeleteCauseEntity = mutationInfo.cascadingDeleteCause.entity;
|
||||
if (!(cascadingDeleteCauseEntity instanceof ChildEntity)) {
|
||||
throw new Error(
|
||||
'GrandChild entity should have cascade delete cause entity of type ChildEntity'
|
||||
);
|
||||
}
|
||||
|
||||
const secondLevelCascadingDeleteCause =
|
||||
mutationInfo.cascadingDeleteCause.cascadingDeleteCause;
|
||||
if (!secondLevelCascadingDeleteCause) {
|
||||
throw new Error('GrandChild entity should have two-level casade delete cause');
|
||||
}
|
||||
|
||||
const secondLevelCascadingDeleteCauseEntity = secondLevelCascadingDeleteCause.entity;
|
||||
if (!(secondLevelCascadingDeleteCauseEntity instanceof ParentEntity)) {
|
||||
throw new Error(
|
||||
'GrandChild entity should have second level casade delete cause entity of type ParentEntity'
|
||||
);
|
||||
}
|
||||
|
||||
const thirdLevelCascadingDeleteCause = secondLevelCascadingDeleteCause.cascadingDeleteCause;
|
||||
if (thirdLevelCascadingDeleteCause) {
|
||||
throw new Error('GrandChild entity should not have three-level casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.GrandChildEntityUpdate++;
|
||||
triggerExecutionCounts.GrandChildEntity++;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -419,11 +318,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
entityConfiguration: parentEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
beforeDelete: [new ParentCheckInfoDeletionTrigger()],
|
||||
afterDelete: [new ParentCheckInfoDeletionTrigger()],
|
||||
|
||||
beforeUpdate: [new ParentCheckInfoUpdateTrigger()],
|
||||
afterUpdate: [new ParentCheckInfoUpdateTrigger()],
|
||||
beforeDelete: [new ParentCheckInfoTrigger()],
|
||||
afterDelete: [new ParentCheckInfoTrigger()],
|
||||
}),
|
||||
});
|
||||
|
||||
@@ -432,11 +328,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
entityConfiguration: childEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
beforeDelete: [new ChildCheckInfoDeletionTrigger()],
|
||||
afterDelete: [new ChildCheckInfoDeletionTrigger()],
|
||||
|
||||
beforeUpdate: [new ChildCheckInfoUpdateTrigger()],
|
||||
afterUpdate: [new ChildCheckInfoUpdateTrigger()],
|
||||
beforeDelete: [new ChildCheckInfoTrigger()],
|
||||
afterDelete: [new ChildCheckInfoTrigger()],
|
||||
}),
|
||||
});
|
||||
|
||||
@@ -445,11 +338,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
entityConfiguration: grandChildEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
beforeDelete: [new GrandChildCheckInfoDeletionTrigger()],
|
||||
afterDelete: [new GrandChildCheckInfoDeletionTrigger()],
|
||||
|
||||
beforeUpdate: [new GrandChildCheckInfoUpdateTrigger()],
|
||||
afterUpdate: [new GrandChildCheckInfoUpdateTrigger()],
|
||||
beforeDelete: [new GrandChildCheckInfoTrigger()],
|
||||
afterDelete: [new GrandChildCheckInfoTrigger()],
|
||||
}),
|
||||
});
|
||||
|
||||
@@ -484,13 +374,13 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
|
||||
GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
privacyPolicyEvaluationRecords.shouldRecord = true;
|
||||
@@ -498,24 +388,20 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
privacyPolicyEvaluationRecords.shouldRecord = false;
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
|
||||
GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
|
||||
).resolves.toBeNull();
|
||||
|
||||
// two calls for each trigger, one beforeDelete, one afterDelete
|
||||
expect(triggerExecutionCounts).toMatchObject({
|
||||
ParentEntityDeletion: 2,
|
||||
ChildEntityDeletion: 2,
|
||||
GrandChildEntityDeletion: 2,
|
||||
|
||||
ParentEntityUpdate: 0,
|
||||
ChildEntityUpdate: 0,
|
||||
GrandChildEntityUpdate: 0,
|
||||
ParentEntity: 2,
|
||||
ChildEntity: 2,
|
||||
GrandChildEntity: 2,
|
||||
});
|
||||
|
||||
expect(privacyPolicyEvaluationRecords).toMatchObject({
|
||||
@@ -602,13 +488,13 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
|
||||
GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
privacyPolicyEvaluationRecords.shouldRecord = true;
|
||||
@@ -616,29 +502,25 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
privacyPolicyEvaluationRecords.shouldRecord = false;
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).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());
|
||||
|
||||
// two calls for only parent trigger, one beforeDelete, one afterDelete
|
||||
// when using set null the descendants aren't deleted
|
||||
expect(triggerExecutionCounts).toMatchObject({
|
||||
ParentEntityDeletion: 2,
|
||||
ChildEntityDeletion: 0,
|
||||
GrandChildEntityDeletion: 0,
|
||||
|
||||
ParentEntityUpdate: 0,
|
||||
ChildEntityUpdate: 2,
|
||||
GrandChildEntityUpdate: 0,
|
||||
ParentEntity: 2,
|
||||
ChildEntity: 0,
|
||||
GrandChildEntity: 0,
|
||||
});
|
||||
|
||||
expect(privacyPolicyEvaluationRecords).toMatchObject({
|
||||
@@ -691,7 +573,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY', () => {
|
||||
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
it('invalidates the cache', async () => {
|
||||
const {
|
||||
ParentEntity,
|
||||
@@ -699,7 +581,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
GrandChildEntity,
|
||||
triggerExecutionCounts,
|
||||
privacyPolicyEvaluationRecords,
|
||||
} = makeEntityClasses(EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY);
|
||||
} = makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE);
|
||||
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new TestViewerContext(companionProvider);
|
||||
@@ -713,149 +595,16 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).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);
|
||||
|
||||
privacyPolicyEvaluationRecords.shouldRecord = true;
|
||||
await ParentEntity.enforceDeleteAsync(parent);
|
||||
privacyPolicyEvaluationRecords.shouldRecord = false;
|
||||
|
||||
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.HIT);
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
).resolves.toBeNull();
|
||||
|
||||
const loadedChild = await ChildEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(child.getID());
|
||||
expect(loadedChild).not.toBeNull();
|
||||
|
||||
const loadedGrandchild = await GrandChildEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(grandchild.getID());
|
||||
expect(loadedGrandchild.getField('parent_id')).toEqual(loadedChild.getID());
|
||||
|
||||
// two calls for only parent trigger, one beforeDelete, one afterDelete
|
||||
// when using set null the descendants aren't deleted
|
||||
expect(triggerExecutionCounts).toMatchObject({
|
||||
ParentEntityDeletion: 2,
|
||||
ChildEntityDeletion: 0,
|
||||
GrandChildEntityDeletion: 0,
|
||||
|
||||
ParentEntityUpdate: 0,
|
||||
ChildEntityUpdate: 2,
|
||||
GrandChildEntityUpdate: 0,
|
||||
});
|
||||
|
||||
expect(privacyPolicyEvaluationRecords).toMatchObject({
|
||||
ParentEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
// one DELETE auth action for parent (since it's being deleted)
|
||||
[EntityAuthorizationAction.DELETE]: [{ cascadingDeleteCause: null }],
|
||||
},
|
||||
ChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
|
||||
// one READ auth action for child in order to update via cascade
|
||||
// no other entities are read since it is not cascaded past first entity
|
||||
[EntityAuthorizationAction.READ]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
],
|
||||
// one UPDATE to set null
|
||||
[EntityAuthorizationAction.UPDATE]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
],
|
||||
[EntityAuthorizationAction.DELETE]: [],
|
||||
},
|
||||
GrandChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
[EntityAuthorizationAction.DELETE]: [],
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY', () => {
|
||||
it('invalidates the cache', async () => {
|
||||
const {
|
||||
ParentEntity,
|
||||
ChildEntity,
|
||||
GrandChildEntity,
|
||||
triggerExecutionCounts,
|
||||
privacyPolicyEvaluationRecords,
|
||||
} = makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY);
|
||||
|
||||
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();
|
||||
|
||||
@@ -890,24 +639,20 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
expect(grandChildCachedAfter.get(child.getID())?.status).toEqual(CacheStatus.MISS);
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
|
||||
GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
// two calls for each trigger, one beforeDelete, one afterDelete
|
||||
expect(triggerExecutionCounts).toMatchObject({
|
||||
ParentEntityDeletion: 2,
|
||||
ChildEntityDeletion: 2,
|
||||
GrandChildEntityDeletion: 2,
|
||||
|
||||
ParentEntityUpdate: 0,
|
||||
ChildEntityUpdate: 0,
|
||||
GrandChildEntityUpdate: 0,
|
||||
ParentEntity: 2,
|
||||
ChildEntity: 2,
|
||||
GrandChildEntity: 2,
|
||||
});
|
||||
|
||||
expect(privacyPolicyEvaluationRecords).toMatchObject({
|
||||
|
||||
@@ -165,14 +165,14 @@ describe(EntityLoader, () => {
|
||||
|
||||
let capturedThrownThing1: any;
|
||||
try {
|
||||
await entityLoader.loadByIDAsync(ID_SENTINEL_THROW_LITERAL);
|
||||
await entityLoader.resultLoader.loadByIDAsync(ID_SENTINEL_THROW_LITERAL);
|
||||
} catch (e) {
|
||||
capturedThrownThing1 = e;
|
||||
}
|
||||
expect(capturedThrownThing1).not.toBeInstanceOf(Error);
|
||||
expect(capturedThrownThing1).toEqual('hello');
|
||||
|
||||
const result = await entityLoader.loadByIDAsync(ID_SENTINEL_THROW_ERROR);
|
||||
const result = await entityLoader.resultLoader.loadByIDAsync(ID_SENTINEL_THROW_ERROR);
|
||||
expect(result.ok).toBe(false);
|
||||
expect(result.enforceError().message).toEqual('world');
|
||||
});
|
||||
|
||||
@@ -78,36 +78,39 @@ describe(EntityLoader, () => {
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
|
||||
const entity = await enforceAsyncResult(entityLoader.resultLoader.loadByIDAsync(id1));
|
||||
expect(entity.getID()).toEqual(id1);
|
||||
expect(entity.getField('dateField')).toEqual(dateToInsert);
|
||||
|
||||
const entities = await enforceResultsAsync(
|
||||
entityLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
entityLoader.resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
);
|
||||
expect(entities.map((m) => m.getID())).toEqual([id1, id2]);
|
||||
|
||||
const entityResultNumber3 = await entityLoader.loadByFieldEqualingAsync('intField', 3);
|
||||
const entityResultNumber3 = await entityLoader.resultLoader.loadByFieldEqualingAsync('intField', 3);
|
||||
expect(entityResultNumber3).not.toBeNull();
|
||||
expect(entityResultNumber3!.enforceValue().getID()).toEqual(id2);
|
||||
|
||||
const entityResultNumber4 = await entityLoader.loadByFieldEqualingAsync('intField', 4);
|
||||
const entityResultNumber4 = await entityLoader.resultLoader.loadByFieldEqualingAsync('intField', 4);
|
||||
expect(entityResultNumber4).toBeNull();
|
||||
|
||||
const entityResultDuplicateValues = await entityLoader
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualingManyAsync('stringField', ['huh', 'huh']);
|
||||
const entityResultDuplicateValues = await entityLoader.loadManyByFieldEqualingManyAsync(
|
||||
'stringField',
|
||||
['huh', 'huh']
|
||||
);
|
||||
expect(entityResultDuplicateValues.size).toBe(1);
|
||||
expect(entityResultDuplicateValues.get('huh')?.map((m) => m.getID())).toEqual([id1, id2]);
|
||||
|
||||
await expect(entityLoader.loadByFieldEqualingAsync('stringField', 'huh')).rejects.toThrowError(
|
||||
await expect(
|
||||
entityLoader.resultLoader.loadByFieldEqualingAsync('stringField', 'huh')
|
||||
).rejects.toThrowError(
|
||||
'loadByFieldEqualing: Multiple entities of type TestEntity found for stringField=huh'
|
||||
);
|
||||
|
||||
await expect(entityLoader.loadByIDNullableAsync(uuidv4())).resolves.toBeNull();
|
||||
await expect(entityLoader.loadByIDNullableAsync(id1)).resolves.not.toBeNull();
|
||||
await expect(entityLoader.resultLoader.loadByIDNullableAsync(uuidv4())).resolves.toBeNull();
|
||||
await expect(entityLoader.resultLoader.loadByIDNullableAsync(id1)).resolves.not.toBeNull();
|
||||
|
||||
await expect(entityLoader.loadByIDAsync('not-a-uuid')).rejects.toThrowError(
|
||||
await expect(entityLoader.resultLoader.loadByIDAsync('not-a-uuid')).rejects.toThrowError(
|
||||
'Entity field not valid: TestEntity (customIdField = not-a-uuid)'
|
||||
);
|
||||
});
|
||||
@@ -181,7 +184,7 @@ describe(EntityLoader, () => {
|
||||
metricsAdapter
|
||||
);
|
||||
const entities = await enforceResultsAsync(
|
||||
entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
entityLoader.resultLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{
|
||||
fieldName: 'stringField',
|
||||
fieldValue: 'huh',
|
||||
@@ -204,7 +207,7 @@ describe(EntityLoader, () => {
|
||||
).twice();
|
||||
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
entityLoader.resultLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'customIdField', fieldValue: 'not-a-uuid' },
|
||||
])
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (customIdField = not-a-uuid)');
|
||||
@@ -261,7 +264,7 @@ describe(EntityLoader, () => {
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
|
||||
const entity = await enforceAsyncResult(entityLoader.resultLoader.loadByIDAsync(id1));
|
||||
verify(
|
||||
spiedPrivacyPolicy.authorizeReadAsync(
|
||||
viewerContext,
|
||||
@@ -395,7 +398,7 @@ describe(EntityLoader, () => {
|
||||
metricsAdapter
|
||||
);
|
||||
|
||||
const entityResult = await entityLoader.loadByIDAsync(id1);
|
||||
const entityResult = await entityLoader.resultLoader.loadByIDAsync(id1);
|
||||
expect(entityResult.ok).toBe(false);
|
||||
expect(entityResult.reason).toEqual(rejectionError);
|
||||
expect(entityResult.value).toBe(undefined);
|
||||
@@ -430,21 +433,21 @@ describe(EntityLoader, () => {
|
||||
|
||||
const loadByValue = uuidv4();
|
||||
|
||||
await expect(entityLoader.resultLoader.loadByIDAsync(loadByValue)).rejects.toEqual(error);
|
||||
await expect(entityLoader.loadByIDAsync(loadByValue)).rejects.toEqual(error);
|
||||
await expect(entityLoader.enforcing().loadByIDAsync(loadByValue)).rejects.toEqual(error);
|
||||
await expect(entityLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
|
||||
await expect(entityLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
|
||||
await expect(entityLoader.resultLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
|
||||
await expect(entityLoader.resultLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.resultLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue)
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue)
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.enforcing().loadManyByFieldEqualingAsync('customIdField', loadByValue)
|
||||
entityLoader.resultLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.enforcing().loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
|
||||
).rejects.toEqual(error);
|
||||
});
|
||||
});
|
||||
@@ -78,7 +78,7 @@ class TestNonTransactionalMutationTrigger extends EntityNonTransactionalMutation
|
||||
): Promise<void> {
|
||||
if (mutationInfo.type === EntityMutationType.DELETE) {
|
||||
const entityLoaded = await BlahEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByIDNullableAsync(entity.getID());
|
||||
if (entityLoaded) {
|
||||
throw new Error(
|
||||
@@ -97,7 +97,7 @@ describe('EntityMutator', () => {
|
||||
// put it in cache
|
||||
const entity = await BlahEntity.creator(viewerContext).enforceCreateAsync();
|
||||
const entityLoaded = await BlahEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByIDAsync(entity.getID());
|
||||
|
||||
await BlahEntity.enforceDeleteAsync(entityLoaded);
|
||||
|
||||
@@ -341,6 +341,7 @@ describe(EntityMutatorFactory, () => {
|
||||
describe('forCreate', () => {
|
||||
it('creates entities', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -364,7 +365,7 @@ describe(EntityMutatorFactory, () => {
|
||||
},
|
||||
]);
|
||||
const newEntity = await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
expect(newEntity).toBeTruthy();
|
||||
@@ -372,6 +373,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('checks privacy', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -398,7 +400,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const spiedPrivacyPolicy = spy(privacyPolicy);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
|
||||
@@ -406,7 +408,7 @@ describe(EntityMutatorFactory, () => {
|
||||
spiedPrivacyPolicy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
deepEqual({ cascadingDeleteCause: null }),
|
||||
privacyPolicyEvaluationContext,
|
||||
anyOfClass(TestEntity),
|
||||
anything()
|
||||
)
|
||||
@@ -415,6 +417,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('executes triggers', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -441,7 +444,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
|
||||
@@ -462,6 +465,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('executes validators', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -488,7 +492,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
|
||||
@@ -526,11 +530,11 @@ describe(EntityMutatorFactory, () => {
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id2)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
|
||||
const updatedEntity = await entityMutatorFactory
|
||||
.forUpdate(existingEntity, queryContext)
|
||||
.forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
@@ -541,7 +545,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const reloadedEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id2)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
expect(reloadedEntity.getAllFields()).toMatchObject(updatedEntity.getAllFields());
|
||||
});
|
||||
@@ -578,11 +582,11 @@ describe(EntityMutatorFactory, () => {
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id2)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forUpdate(existingEntity, queryContext)
|
||||
.forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
@@ -590,7 +594,7 @@ describe(EntityMutatorFactory, () => {
|
||||
spiedPrivacyPolicy.authorizeUpdateAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
deepEqual({ cascadingDeleteCause: null }),
|
||||
privacyPolicyEvaluationContext,
|
||||
anyOfClass(TestEntity),
|
||||
anything()
|
||||
)
|
||||
@@ -629,11 +633,11 @@ describe(EntityMutatorFactory, () => {
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id2)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forUpdate(existingEntity, queryContext)
|
||||
.forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
@@ -648,11 +652,7 @@ describe(EntityMutatorFactory, () => {
|
||||
beforeDelete: false,
|
||||
afterDelete: false,
|
||||
},
|
||||
{
|
||||
type: EntityMutationType.UPDATE,
|
||||
previousValue: existingEntity,
|
||||
cascadingDeleteCause: null,
|
||||
}
|
||||
{ type: EntityMutationType.UPDATE, previousValue: existingEntity }
|
||||
);
|
||||
});
|
||||
it('executes validators', async () => {
|
||||
@@ -687,18 +687,17 @@ describe(EntityMutatorFactory, () => {
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id2)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forUpdate(existingEntity, queryContext)
|
||||
.forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 1, {
|
||||
type: EntityMutationType.UPDATE,
|
||||
previousValue: existingEntity,
|
||||
cascadingDeleteCause: null,
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -724,17 +723,19 @@ describe(EntityMutatorFactory, () => {
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id1)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
);
|
||||
expect(existingEntity).toBeTruthy();
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
await entityMutatorFactory
|
||||
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.enforceDeleteAsync();
|
||||
|
||||
await expect(
|
||||
enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id1)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
)
|
||||
).rejects.toBeInstanceOf(Error);
|
||||
});
|
||||
@@ -762,10 +763,12 @@ describe(EntityMutatorFactory, () => {
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id1)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
await entityMutatorFactory
|
||||
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.enforceDeleteAsync();
|
||||
|
||||
verify(
|
||||
spiedPrivacyPolicy.authorizeDeleteAsync(
|
||||
@@ -801,10 +804,12 @@ describe(EntityMutatorFactory, () => {
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id1)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
await entityMutatorFactory
|
||||
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.enforceDeleteAsync();
|
||||
|
||||
verifyTriggerCounts(
|
||||
viewerContext,
|
||||
@@ -844,10 +849,12 @@ describe(EntityMutatorFactory, () => {
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadByIDAsync(id1)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
await entityMutatorFactory
|
||||
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.enforceDeleteAsync();
|
||||
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 0, {
|
||||
type: EntityMutationType.DELETE as any,
|
||||
@@ -875,13 +882,13 @@ describe(EntityMutatorFactory, () => {
|
||||
const entites1 = await enforceResultsAsync(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
.resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
);
|
||||
expect(entites1).toHaveLength(1);
|
||||
|
||||
await enforceAsyncResult(
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.createAsync()
|
||||
);
|
||||
@@ -889,13 +896,14 @@ describe(EntityMutatorFactory, () => {
|
||||
const entities2 = await enforceResultsAsync(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
.resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
);
|
||||
expect(entities2).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('throws error when field not valid', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const id1 = uuidv4();
|
||||
const { entityMutatorFactory } = createEntityMutatorFactory([
|
||||
@@ -911,19 +919,19 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
await expect(
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 10 as any)
|
||||
.createAsync()
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
|
||||
|
||||
const createdEntity = await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
entityMutatorFactory
|
||||
.forUpdate(createdEntity, queryContext)
|
||||
.forUpdate(createdEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 10 as any)
|
||||
.updateAsync()
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
|
||||
@@ -931,6 +939,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('returns error result when not authorized to create', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicyMock = mock(SimpleTestEntityPrivacyPolicy);
|
||||
const databaseAdapter = instance(mock<EntityDatabaseAdapter<SimpleTestFields>>());
|
||||
@@ -990,7 +999,7 @@ describe(EntityMutatorFactory, () => {
|
||||
);
|
||||
|
||||
const entityCreateResult = await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.createAsync();
|
||||
expect(entityCreateResult.ok).toBe(false);
|
||||
expect(entityCreateResult.reason).toEqual(rejectionError);
|
||||
@@ -1002,14 +1011,14 @@ describe(EntityMutatorFactory, () => {
|
||||
});
|
||||
|
||||
const entityUpdateResult = await entityMutatorFactory
|
||||
.forUpdate(fakeEntity, queryContext)
|
||||
.forUpdate(fakeEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.updateAsync();
|
||||
expect(entityUpdateResult.ok).toBe(false);
|
||||
expect(entityUpdateResult.reason).toEqual(rejectionError);
|
||||
expect(entityUpdateResult.value).toBe(undefined);
|
||||
|
||||
const entityDeleteResult = await entityMutatorFactory
|
||||
.forDelete(fakeEntity, queryContext)
|
||||
.forDelete(fakeEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.deleteAsync();
|
||||
expect(entityDeleteResult.ok).toBe(false);
|
||||
expect(entityDeleteResult.reason).toEqual(rejectionError);
|
||||
@@ -1018,6 +1027,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('throws error when db adapter throws', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(SimpleTestEntityPrivacyPolicy));
|
||||
const databaseAdapterMock = mock<EntityDatabaseAdapter<SimpleTestFields>>();
|
||||
@@ -1073,37 +1083,48 @@ describe(EntityMutatorFactory, () => {
|
||||
});
|
||||
|
||||
await expect(
|
||||
entityMutatorFactory.forCreate(viewerContext, queryContext).createAsync()
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.createAsync()
|
||||
).rejects.toEqual(rejectionError);
|
||||
await expect(
|
||||
entityMutatorFactory.forUpdate(fakeEntity, queryContext).updateAsync()
|
||||
entityMutatorFactory
|
||||
.forUpdate(fakeEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.updateAsync()
|
||||
).rejects.toEqual(rejectionError);
|
||||
await expect(
|
||||
entityMutatorFactory.forDelete(fakeEntity, queryContext).deleteAsync()
|
||||
entityMutatorFactory
|
||||
.forDelete(fakeEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.deleteAsync()
|
||||
).rejects.toEqual(rejectionError);
|
||||
});
|
||||
|
||||
it('records metrics appropriately', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const { entityMutatorFactory, metricsAdapter } = createEntityMutatorFactory([]);
|
||||
const spiedMetricsAdapter = spy(metricsAdapter);
|
||||
|
||||
const newEntity = await enforceAsyncResult(
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
await enforceAsyncResult(
|
||||
entityMutatorFactory
|
||||
.forUpdate(newEntity, queryContext)
|
||||
.forUpdate(newEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'wat')
|
||||
.updateAsync()
|
||||
);
|
||||
|
||||
await enforceAsyncResult(entityMutatorFactory.forDelete(newEntity, queryContext).deleteAsync());
|
||||
await enforceAsyncResult(
|
||||
entityMutatorFactory
|
||||
.forDelete(newEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.deleteAsync()
|
||||
);
|
||||
|
||||
verify(
|
||||
spiedMetricsAdapter.logMutatorMutationEvent(
|
||||
|
||||
@@ -98,25 +98,25 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
await CategoryEntity.enforceDeleteAsync(parentCategory);
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
|
||||
@@ -137,10 +137,10 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
|
||||
await CategoryEntity.enforceDeleteAsync(categoryA);
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(categoryA.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(categoryA.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(categoryB.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(categoryB.getID())
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -161,29 +161,29 @@ describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
await CategoryEntity.enforceDeleteAsync(parentCategory);
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
|
||||
const loadedSubCategory = await CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(subCategory.getID());
|
||||
const loadedSubCategory = await CategoryEntity.loader(viewerContext).loadByIDAsync(
|
||||
subCategory.getID()
|
||||
);
|
||||
expect(loadedSubCategory.getField('parent_category_id')).toBeNull();
|
||||
|
||||
const loadedSubSubCategory = await CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(subSubCategory.getID());
|
||||
const loadedSubSubCategory = await CategoryEntity.loader(viewerContext).loadByIDAsync(
|
||||
subSubCategory.getID()
|
||||
);
|
||||
expect(loadedSubSubCategory.getField('parent_category_id')).not.toBeNull();
|
||||
});
|
||||
|
||||
@@ -203,9 +203,9 @@ describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
|
||||
|
||||
await CategoryEntity.enforceDeleteAsync(categoryA);
|
||||
|
||||
const loadedCategoryB = await CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(categoryB.getID());
|
||||
const loadedCategoryB = await CategoryEntity.loader(viewerContext).loadByIDAsync(
|
||||
categoryB.getID()
|
||||
);
|
||||
expect(loadedCategoryB.getField('parent_category_id')).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -213,7 +213,7 @@ describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
|
||||
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
it('invalidates the cache', async () => {
|
||||
const { CategoryEntity } = makeEntityClass(
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE
|
||||
);
|
||||
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
@@ -228,17 +228,19 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_category_id', parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'parent_category_id',
|
||||
parentCategory.getID()
|
||||
)
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_category_id', subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'parent_category_id',
|
||||
subCategory.getID()
|
||||
)
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
|
||||
@@ -271,19 +273,19 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
expect(subSubCategoryCachedAfter.get(subCategory.getID())?.status).toEqual(CacheStatus.MISS);
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
});
|
||||
|
||||
it('handles cycles', async () => {
|
||||
const { CategoryEntity } = makeEntityClass(
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE
|
||||
);
|
||||
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
@@ -298,14 +300,16 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
.enforceUpdateAsync();
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_category_id', categoryA.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'parent_category_id',
|
||||
categoryA.getID()
|
||||
)
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_category_id', categoryB.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'parent_category_id',
|
||||
categoryB.getID()
|
||||
)
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { mock, instance, verify } from 'ts-mockito';
|
||||
|
||||
import EntityMutatorFactory from '../EntityMutatorFactory';
|
||||
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import ViewerScopedEntityMutatorFactory from '../ViewerScopedEntityMutatorFactory';
|
||||
@@ -9,6 +10,7 @@ import TestEntity, { TestFields, TestEntityPrivacyPolicy } from '../testfixtures
|
||||
describe(ViewerScopedEntityMutatorFactory, () => {
|
||||
it('correctly scopes viewer to entity mutations', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const baseMutatorFactory =
|
||||
mock<
|
||||
@@ -25,8 +27,10 @@ describe(ViewerScopedEntityMutatorFactory, () => {
|
||||
keyof TestFields
|
||||
>(baseMutatorFactoryInstance, viewerContext);
|
||||
|
||||
viewerScopedEntityLoader.forCreate(queryContext);
|
||||
viewerScopedEntityLoader.forCreate(queryContext, privacyPolicyEvaluationContext);
|
||||
|
||||
verify(baseMutatorFactory.forCreate(viewerContext, queryContext)).once();
|
||||
verify(
|
||||
baseMutatorFactory.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
).once();
|
||||
});
|
||||
});
|
||||
@@ -28,17 +28,16 @@ describe('Two entities backed by the same table', () => {
|
||||
expect(two).toBeInstanceOf(TwoTestEntity);
|
||||
|
||||
await expect(
|
||||
TwoTestEntity.loader(viewerContext).enforcing().loadByIDAsync(one.getID())
|
||||
TwoTestEntity.loader(viewerContext).loadByIDAsync(one.getID())
|
||||
).rejects.toThrowError('TwoTestEntity must be instantiated with two data');
|
||||
|
||||
await expect(
|
||||
OneTestEntity.loader(viewerContext).enforcing().loadByIDAsync(two.getID())
|
||||
OneTestEntity.loader(viewerContext).loadByIDAsync(two.getID())
|
||||
).rejects.toThrowError('OneTestEntity must be instantiated with one data');
|
||||
|
||||
const manyResults = await OneTestEntity.loader(viewerContext).loadManyByFieldEqualingAsync(
|
||||
'common_other_field',
|
||||
'wat'
|
||||
);
|
||||
const manyResults = await OneTestEntity.loader(
|
||||
viewerContext
|
||||
).resultLoader.loadManyByFieldEqualingAsync('common_other_field', 'wat');
|
||||
const successfulManyResults = successfulResults(manyResults);
|
||||
const failedManyResults = failedResults(manyResults);
|
||||
|
||||
@@ -52,7 +51,7 @@ describe('Two entities backed by the same table', () => {
|
||||
|
||||
const fieldEqualityConjunctionResults = await OneTestEntity.loader(
|
||||
viewerContext
|
||||
).loadManyByFieldEqualityConjunctionAsync([
|
||||
).resultLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{
|
||||
fieldName: 'common_other_field',
|
||||
fieldValue: 'wat',
|
||||
|
||||
@@ -18,7 +18,7 @@ describe('Two entities backed by the same table', () => {
|
||||
expect(entity1).toBeInstanceOf(OneTestEntity);
|
||||
|
||||
const entity2 = await TwoTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByIDAsync(entity1.getID());
|
||||
expect(entity2).toBeInstanceOf(TwoTestEntity);
|
||||
|
||||
@@ -33,7 +33,7 @@ describe('Two entities backed by the same table', () => {
|
||||
});
|
||||
|
||||
const loaded1 = await OneTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByIDAsync(entity1.getID());
|
||||
expect(loaded1.getAllFields()).toMatchObject({
|
||||
id: updated2.getID(),
|
||||
@@ -51,7 +51,7 @@ describe('Two entities backed by the same table', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
const loadedEntity = await TwoTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByFieldEqualingAsync('other_field', 'huh');
|
||||
expect(loadedEntity?.getAllFields()).toMatchObject({
|
||||
id: entity.getID(),
|
||||
@@ -60,12 +60,12 @@ describe('Two entities backed by the same table', () => {
|
||||
});
|
||||
|
||||
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(),
|
||||
@@ -74,7 +74,7 @@ describe('Two entities backed by the same table', () => {
|
||||
});
|
||||
|
||||
const loaded22 = await TwoTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByFieldEqualingAsync('fake_field', 'world');
|
||||
expect(loaded22?.getAllFields()).toMatchObject({
|
||||
id: entity.getID(),
|
||||
|
||||
@@ -34,6 +34,6 @@ export default class EntityInvalidFieldValueError<
|
||||
fieldName: N,
|
||||
fieldValue?: TFields[N]
|
||||
) {
|
||||
super(`Entity field not valid: ${entityClass.name} (${String(fieldName)} = ${fieldValue})`);
|
||||
super(`Entity field not valid: ${entityClass.name} (${fieldName} = ${fieldValue})`);
|
||||
}
|
||||
}
|
||||
@@ -34,6 +34,6 @@ export default class EntityNotFoundError<
|
||||
fieldName: N,
|
||||
fieldValue: TFields[N]
|
||||
) {
|
||||
super(`Entity not found: ${entityClass.name} (${String(fieldName)} = ${fieldValue})`);
|
||||
super(`Entity not found: ${entityClass.name} (${fieldName} = ${fieldValue})`);
|
||||
}
|
||||
}
|
||||
@@ -7,7 +7,7 @@
|
||||
export { default as ComposedEntityCacheAdapter } from './ComposedEntityCacheAdapter';
|
||||
export { default as ComposedSecondaryEntityCache } from './ComposedSecondaryEntityCache';
|
||||
export { default as GenericSecondaryEntityCache } from './GenericSecondaryEntityCache';
|
||||
export { default as EnforcingEntityLoader } from './EnforcingEntityLoader';
|
||||
export { default as EntityResultLoader } from './EntityResultLoader';
|
||||
export { default as Entity } from './Entity';
|
||||
export * from './Entity';
|
||||
export { default as EntityAssociationLoader } from './EntityAssociationLoader';
|
||||
|
||||
@@ -11,10 +11,7 @@ import {
|
||||
timeAndLogLoadEventAsync,
|
||||
timeAndLogLoadMapEventAsync,
|
||||
} from '../metrics/EntityMetricsUtils';
|
||||
import IEntityMetricsAdapter, {
|
||||
EntityMetricsLoadType,
|
||||
IncrementLoadCountEventType,
|
||||
} from '../metrics/IEntityMetricsAdapter';
|
||||
import IEntityMetricsAdapter, { EntityMetricsLoadType } from '../metrics/IEntityMetricsAdapter';
|
||||
import { computeIfAbsent, zipToMap } from '../utils/collections/maps';
|
||||
import ReadThroughEntityCache from './ReadThroughEntityCache';
|
||||
|
||||
@@ -60,8 +57,7 @@ export default class EntityDataManager<TFields> {
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Readonly<TFields>[]>> {
|
||||
this.metricsAdapter.incrementDataManagerLoadCount({
|
||||
type: IncrementLoadCountEventType.CACHE,
|
||||
this.metricsAdapter.incrementDataManagerCacheLoadCount({
|
||||
fieldValueCount: fieldValues.length,
|
||||
entityClassName: this.entityClassName,
|
||||
});
|
||||
@@ -69,8 +65,7 @@ export default class EntityDataManager<TFields> {
|
||||
fieldName,
|
||||
fieldValues,
|
||||
async (fetcherValues) => {
|
||||
this.metricsAdapter.incrementDataManagerLoadCount({
|
||||
type: IncrementLoadCountEventType.DATABASE,
|
||||
this.metricsAdapter.incrementDataManagerDatabaseLoadCount({
|
||||
fieldValueCount: fieldValues.length,
|
||||
entityClassName: this.entityClassName,
|
||||
});
|
||||
@@ -113,9 +108,7 @@ export default class EntityDataManager<TFields> {
|
||||
);
|
||||
if (nullOrUndefinedValueIndex >= 0) {
|
||||
throw new Error(
|
||||
`Invalid load: ${this.entityClassName} (${String(fieldName)} = ${
|
||||
fieldValues[nullOrUndefinedValueIndex]
|
||||
})`
|
||||
`Invalid load: ${this.entityClassName} (${fieldName} = ${fieldValues[nullOrUndefinedValueIndex]})`
|
||||
);
|
||||
}
|
||||
|
||||
@@ -124,8 +117,7 @@ export default class EntityDataManager<TFields> {
|
||||
return await this.databaseAdapter.fetchManyWhereAsync(queryContext, fieldName, fieldValues);
|
||||
}
|
||||
|
||||
this.metricsAdapter.incrementDataManagerLoadCount({
|
||||
type: IncrementLoadCountEventType.DATALOADER,
|
||||
this.metricsAdapter.incrementDataManagerDataloaderLoadCount({
|
||||
fieldValueCount: fieldValues.length,
|
||||
entityClassName: this.entityClassName,
|
||||
});
|
||||
|
||||
@@ -24,7 +24,7 @@ export const getDatabaseFieldForEntityField = <TFields>(
|
||||
entityField: keyof TFields
|
||||
): string => {
|
||||
const databaseField = entityConfiguration.entityToDBFieldsKeyMapping.get(entityField);
|
||||
invariant(databaseField, `database field mapping missing for ${String(entityField)}`);
|
||||
invariant(databaseField, `database field mapping missing for ${entityField}`);
|
||||
return databaseField!;
|
||||
};
|
||||
|
||||
|
||||
@@ -102,9 +102,7 @@ export default class ReadThroughEntityCache<TFields> {
|
||||
// TODO(wschurman): emit or throw here since console may not be available
|
||||
// eslint-disable-next-line no-console
|
||||
console.warn(
|
||||
`unique key ${String(fieldName)} in ${
|
||||
this.entityConfiguration.tableName
|
||||
} returned multiple rows for ${fieldValue}`
|
||||
`unique key ${fieldName} in ${this.entityConfiguration.tableName} returned multiple rows for ${fieldValue}`
|
||||
);
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -4,6 +4,7 @@ import {
|
||||
when,
|
||||
anything,
|
||||
verify,
|
||||
anyNumber,
|
||||
objectContaining,
|
||||
spy,
|
||||
anyString,
|
||||
@@ -12,10 +13,7 @@ import {
|
||||
} from 'ts-mockito';
|
||||
|
||||
import EntityDatabaseAdapter from '../../EntityDatabaseAdapter';
|
||||
import IEntityMetricsAdapter, {
|
||||
EntityMetricsLoadType,
|
||||
IncrementLoadCountEventType,
|
||||
} from '../../metrics/IEntityMetricsAdapter';
|
||||
import IEntityMetricsAdapter, { EntityMetricsLoadType } from '../../metrics/IEntityMetricsAdapter';
|
||||
import NoOpEntityMetricsAdapter from '../../metrics/NoOpEntityMetricsAdapter';
|
||||
import TestEntity, { testEntityConfiguration, TestFields } from '../../testfixtures/TestEntity';
|
||||
import {
|
||||
@@ -521,27 +519,24 @@ describe(EntityDataManager, () => {
|
||||
).once();
|
||||
|
||||
verify(
|
||||
metricsAdapterMock.incrementDataManagerLoadCount(
|
||||
metricsAdapterMock.incrementDataManagerDataloaderLoadCount(
|
||||
deepEqual({
|
||||
type: IncrementLoadCountEventType.DATALOADER,
|
||||
fieldValueCount: 1,
|
||||
entityClassName: TestEntity.name,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
verify(
|
||||
metricsAdapterMock.incrementDataManagerLoadCount(
|
||||
metricsAdapterMock.incrementDataManagerCacheLoadCount(
|
||||
deepEqual({
|
||||
type: IncrementLoadCountEventType.CACHE,
|
||||
fieldValueCount: 1,
|
||||
entityClassName: TestEntity.name,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
verify(
|
||||
metricsAdapterMock.incrementDataManagerLoadCount(
|
||||
metricsAdapterMock.incrementDataManagerDatabaseLoadCount(
|
||||
deepEqual({
|
||||
type: IncrementLoadCountEventType.DATABASE,
|
||||
fieldValueCount: 1,
|
||||
entityClassName: TestEntity.name,
|
||||
})
|
||||
@@ -570,7 +565,9 @@ describe(EntityDataManager, () => {
|
||||
)
|
||||
).once();
|
||||
|
||||
verify(metricsAdapterMock.incrementDataManagerLoadCount(anything())).never();
|
||||
verify(metricsAdapterMock.incrementDataManagerDataloaderLoadCount(anyNumber())).never();
|
||||
verify(metricsAdapterMock.incrementDataManagerCacheLoadCount(anyNumber())).never();
|
||||
verify(metricsAdapterMock.incrementDataManagerDatabaseLoadCount(anyNumber())).never();
|
||||
});
|
||||
|
||||
it('throws when a load-by value is null or undefined', async () => {
|
||||
|
||||
@@ -9,28 +9,10 @@ export enum EntityMetricsLoadType {
|
||||
LOAD_MANY_RAW,
|
||||
}
|
||||
|
||||
/**
|
||||
* Event about a single call to an {@link EntityLoader} method.
|
||||
*/
|
||||
export interface EntityMetricsLoadEvent {
|
||||
/**
|
||||
* {@link EntityMetricsLoadType} for this load.
|
||||
*/
|
||||
type: EntityMetricsLoadType;
|
||||
|
||||
/**
|
||||
* Class name of the {@link Entity} being loaded.
|
||||
*/
|
||||
entityClassName: string;
|
||||
|
||||
/**
|
||||
* Total duration of this load, including fetch and construction of entities.
|
||||
*/
|
||||
duration: number;
|
||||
|
||||
/**
|
||||
* Number of entities returned for this load.
|
||||
*/
|
||||
count: number;
|
||||
}
|
||||
|
||||
@@ -41,57 +23,13 @@ export enum EntityMetricsMutationType {
|
||||
}
|
||||
|
||||
export interface EntityMetricsMutationEvent {
|
||||
/**
|
||||
* {@link EntityMetricsMutationType} for this mutation.
|
||||
*/
|
||||
type: EntityMetricsMutationType;
|
||||
|
||||
/**
|
||||
* Class name of the {@link Entity} being mutated.
|
||||
*/
|
||||
entityClassName: string;
|
||||
|
||||
/**
|
||||
* Total duration of this mutation.
|
||||
*/
|
||||
duration: number;
|
||||
}
|
||||
|
||||
export enum IncrementLoadCountEventType {
|
||||
/**
|
||||
* Type for when a dataloader load is initiated via the standard load methods
|
||||
* since all loads go through a dataloader.
|
||||
*/
|
||||
DATALOADER,
|
||||
|
||||
/**
|
||||
* Type for when a cache load is initiated due to a dataloader miss.
|
||||
*/
|
||||
CACHE,
|
||||
|
||||
/**
|
||||
* Type for when a database load is initiated due to a dataloader and cache miss, when an entity query doesn't support caching, or during a transaction.
|
||||
*/
|
||||
DATABASE,
|
||||
}
|
||||
|
||||
/**
|
||||
* Event used to record dataloader, cache, and database load counts in {@link EntityDataManager}.
|
||||
*/
|
||||
export interface IncrementLoadCountEvent {
|
||||
/**
|
||||
* Type of this event.
|
||||
*/
|
||||
type: IncrementLoadCountEventType;
|
||||
|
||||
/**
|
||||
* Number of field values being loaded for this call.
|
||||
*/
|
||||
fieldValueCount: number;
|
||||
|
||||
/**
|
||||
* Class name of the {@link Entity} being loaded.
|
||||
*/
|
||||
entityClassName: string;
|
||||
}
|
||||
|
||||
@@ -100,13 +38,7 @@ export enum EntityMetricsAuthorizationResult {
|
||||
ALLOW,
|
||||
}
|
||||
|
||||
/**
|
||||
* Event used to record a singe {@link EntityPrivacyPolicy} authorization.
|
||||
*/
|
||||
export interface EntityMetricsAuthorizationEvent {
|
||||
/**
|
||||
* Class name of the {@link Entity} being authorized.
|
||||
*/
|
||||
entityClassName: string;
|
||||
action: EntityAuthorizationAction;
|
||||
evaluationResult: EntityMetricsAuthorizationResult;
|
||||
@@ -137,10 +69,25 @@ export default interface IEntityMetricsAdapter {
|
||||
logMutatorMutationEvent(mutationEvent: EntityMetricsMutationEvent): void;
|
||||
|
||||
/**
|
||||
* Called when a dataloader, cache, or database load is initiated via the standard
|
||||
* load methods (not equality conjunction or raw). Most commonly used for logging
|
||||
* a waterfall to determine dataloader and cache hit rates and ratios.
|
||||
* Called when a dataloader load is initiated via the standard
|
||||
* load methods (not equality conjunction or raw).
|
||||
* @param fieldValueCount - count of field values being loaded for a field
|
||||
*/
|
||||
incrementDataManagerLoadCount(incrementLoadCountEvent: IncrementLoadCountEvent): void;
|
||||
incrementDataManagerDataloaderLoadCount(incrementLoadCountEvent: IncrementLoadCountEvent): void;
|
||||
|
||||
/**
|
||||
* Called when a cache load is initiated via the standard
|
||||
* load methods (not equality conjunction or raw). Occurs upon a dataloader
|
||||
* miss.
|
||||
* @param fieldValueCount - count of field values being loaded for a field
|
||||
*/
|
||||
incrementDataManagerCacheLoadCount(incrementLoadCountEvent: IncrementLoadCountEvent): void;
|
||||
|
||||
/**
|
||||
* Called when a database load is initiated via the standard
|
||||
* load methods (not equality conjunction or raw). Occurs upon a cache
|
||||
* miss or when fetching an uncacheable field.
|
||||
* @param fieldValueCount - count of field values being loaded for a field
|
||||
*/
|
||||
incrementDataManagerDatabaseLoadCount(incrementLoadCountEvent: IncrementLoadCountEvent): void;
|
||||
}
|
||||
@@ -9,5 +9,9 @@ export default class NoOpEntityMetricsAdapter implements IEntityMetricsAdapter {
|
||||
logAuthorizationEvent(_authorizationEvent: EntityMetricsAuthorizationEvent): void {}
|
||||
logDataManagerLoadEvent(_loadEvent: EntityMetricsLoadEvent): void {}
|
||||
logMutatorMutationEvent(_mutationEvent: EntityMetricsMutationEvent): void {}
|
||||
incrementDataManagerLoadCount(_incrementLoadCountEvent: IncrementLoadCountEvent): void {}
|
||||
incrementDataManagerDataloaderLoadCount(
|
||||
_incrementLoadCountEvent: IncrementLoadCountEvent
|
||||
): void {}
|
||||
incrementDataManagerCacheLoadCount(_incrementLoadCountEvent: IncrementLoadCountEvent): void {}
|
||||
incrementDataManagerDatabaseLoadCount(_incrementLoadCountEvent: IncrementLoadCountEvent): void {}
|
||||
}
|
||||
@@ -158,10 +158,7 @@ export default class StubDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
|
||||
|
||||
private generateRandomID(): any {
|
||||
const idSchemaField = this.entityConfiguration2.schema.get(this.entityConfiguration2.idField);
|
||||
invariant(
|
||||
idSchemaField,
|
||||
`No schema field found for ${String(this.entityConfiguration2.idField)}`
|
||||
);
|
||||
invariant(idSchemaField, `No schema field found for ${this.entityConfiguration2.idField}`);
|
||||
if (idSchemaField instanceof StringField) {
|
||||
return uuidv4();
|
||||
} else if (idSchemaField instanceof IntField) {
|
||||
|
||||
Reference in new issue
Block a user