mirror of
https://github.com/expo/entity.git
synced 2026-11-13 20:28:06 -10:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6222f0f464 |
No files matched your search
@@ -10,8 +10,7 @@
|
||||
"rules": {
|
||||
"no-restricted-imports": ["error",{ "paths": [".", "..", "../.."] }],
|
||||
"tsdoc/syntax": "warn",
|
||||
"no-console": "warn",
|
||||
"handle-callback-err": "off"
|
||||
"no-console": "warn"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
|
||||
-108
@@ -3,114 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
|
||||
* upgrade some other packages to fix dependabot alerts ([#126](https://github.com/expo/entity/issues/126)) ([226bffe](https://github.com/expo/entity/commit/226bffe0a95d7b8a3e9e9d46aebdb0edf1eeec1a))
|
||||
* use column name instead of field name for redis cache key ([#124](https://github.com/expo/entity/issues/124)) ([d78f452](https://github.com/expo/entity/commit/d78f452bb3ac5527069813a03f5b2264375bd8ab))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add mutation type to validator and trigger execute functions ([#119](https://github.com/expo/entity/issues/119)) ([ef40fa5](https://github.com/expo/entity/commit/ef40fa5e9cdf53e25e78a9423c698e6d1c9737af))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* allow undefined value for all fields ([#114](https://github.com/expo/entity/issues/114)) ([022e0e9](https://github.com/expo/entity/commit/022e0e9b88a5e84e0c1bc6c8810c850beb05f0cf))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better typing on filterMap for use with predicates ([#106](https://github.com/expo/entity/issues/106)) ([01b3bfe](https://github.com/expo/entity/commit/01b3bfef7c6da55e7d89d8cccb52a0050187aee8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add type generic default in test utils ([#104](https://github.com/expo/entity/issues/104)) ([fe2917e](https://github.com/expo/entity/commit/fe2917e6b5af808f166aa354d476e168c41e6d21))
|
||||
* maps utils invariants for collections containing undefined values ([#103](https://github.com/expo/entity/issues/103)) ([29c1a43](https://github.com/expo/entity/commit/29c1a434ab6cd8d30e9f0e7c742065c8d46d8d8a))
|
||||
* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
|
||||
* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -4,5 +4,5 @@
|
||||
],
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true,
|
||||
"version": "0.16.0"
|
||||
"version": "0.10.0"
|
||||
}
|
||||
+14
-17
@@ -1,9 +1,7 @@
|
||||
{
|
||||
"name": "root",
|
||||
"private": true,
|
||||
"workspaces": [
|
||||
"packages/*"
|
||||
],
|
||||
"workspaces": ["packages/*"],
|
||||
"scripts": {
|
||||
"tsc": "lerna run tsc",
|
||||
"clean": "lerna run clean",
|
||||
@@ -18,31 +16,30 @@
|
||||
"@expo/entity": "file:packages/entity",
|
||||
"@expo/results": "^1.0.0",
|
||||
"@types/invariant": "^2.2.33",
|
||||
"@types/ioredis": "^4.26.4",
|
||||
"@types/ioredis": "^4.17.3",
|
||||
"@types/jest": "^26.0.10",
|
||||
"@types/node": "^14.6.0",
|
||||
"@types/uuid": "^8.3.0",
|
||||
"@typescript-eslint/eslint-plugin": "^4.14.0",
|
||||
"@typescript-eslint/parser": "^4.14.0",
|
||||
"@typescript-eslint/eslint-plugin": "^3.10.1",
|
||||
"@typescript-eslint/parser": "^3.10.1",
|
||||
"barrelsby": "^2.2.0",
|
||||
"eslint": "^7.7.0",
|
||||
"eslint-config-universe": "^7.0.0",
|
||||
"eslint-plugin-tsdoc": "^0.2.11",
|
||||
"jest": "^26.6.3",
|
||||
"lerna": "^4.0.0",
|
||||
"nullthrows": "^1.1.1",
|
||||
"pg": "^8.6.0",
|
||||
"eslint-config-universe": "^4.0.0",
|
||||
"eslint-plugin-tsdoc": "^0.2.6",
|
||||
"jest": "^26.4.2",
|
||||
"lerna": "^3.22.1",
|
||||
"pg": "^8.3.2",
|
||||
"prettier": "^2.1.0",
|
||||
"ts-jest": "~26.4.4",
|
||||
"ts-jest": "~26.2.0",
|
||||
"ts-mockito": "^2.6.1",
|
||||
"typedoc": "^0.20.36",
|
||||
"typescript": "^4.1.3",
|
||||
"typedoc": "^0.17.6",
|
||||
"typedoc-plugin-lerna-packages": "^0.3.0",
|
||||
"typescript": "^4.0.2",
|
||||
"uuid": "^8.3.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@expo/entity": "file:packages/entity",
|
||||
"@expo/entity-cache-adapter-redis": "file:packages/entity-cache-adapter-redis",
|
||||
"@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex",
|
||||
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis"
|
||||
"@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex"
|
||||
}
|
||||
}
|
||||
@@ -3,77 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
|
||||
* use column name instead of field name for redis cache key ([#124](https://github.com/expo/entity/issues/124)) ([d78f452](https://github.com/expo/entity/commit/d78f452bb3ac5527069813a03f5b2264375bd8ab))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
@@ -35,7 +35,7 @@ export const createDefaultEntityCompanionProvider = (
|
||||
...
|
||||
},
|
||||
{
|
||||
['redis']: {
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-redis",
|
||||
"version": "0.16.0",
|
||||
"version": "0.10.0",
|
||||
"description": "Redis cache adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -11,7 +11,7 @@
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
@@ -29,9 +29,9 @@
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"ioredis": "^4.27.3"
|
||||
"ioredis": "^4.17.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.16.0"
|
||||
"@expo/entity": "^0.10.0"
|
||||
}
|
||||
}
|
||||
@@ -1,105 +0,0 @@
|
||||
import { CacheLoadResult, CacheStatus } from '@expo/entity';
|
||||
import { Redis } from 'ioredis';
|
||||
|
||||
import wrapNativeRedisCall from './errors/wrapNativeRedisCall';
|
||||
|
||||
// Sentinel value we store in Redis to negatively cache a database miss.
|
||||
// The sentinel value is distinct from any (positively) cached value.
|
||||
const DOES_NOT_EXIST_REDIS = '';
|
||||
|
||||
export interface GenericRedisCacheContext {
|
||||
/**
|
||||
* Instance of ioredis.Redis
|
||||
*/
|
||||
redisClient: Redis;
|
||||
|
||||
/**
|
||||
* TTL for caching database hits. Successive entity loads within this TTL
|
||||
* will be read from cache (unless invalidated).
|
||||
*/
|
||||
ttlSecondsPositive: number;
|
||||
|
||||
/**
|
||||
* TTL for negatively caching database misses. Successive entity loads within
|
||||
* this TTL will be assumed not present in the database (unless invalidated).
|
||||
*/
|
||||
ttlSecondsNegative: number;
|
||||
}
|
||||
|
||||
export default class GenericRedisCacher {
|
||||
constructor(private readonly context: GenericRedisCacheContext) {}
|
||||
|
||||
public async loadManyAsync(
|
||||
keys: readonly string[]
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult>> {
|
||||
if (keys.length === 0) {
|
||||
return new Map();
|
||||
}
|
||||
|
||||
const redisResults = await wrapNativeRedisCall(() => this.context.redisClient.mget(...keys));
|
||||
|
||||
const results = new Map<string, CacheLoadResult>();
|
||||
for (let i = 0; i < keys.length; i++) {
|
||||
const key = keys[i];
|
||||
const redisResult = redisResults[i];
|
||||
|
||||
if (redisResult === DOES_NOT_EXIST_REDIS) {
|
||||
results.set(key, {
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
} else if (redisResult) {
|
||||
results.set(key, {
|
||||
status: CacheStatus.HIT,
|
||||
item: JSON.parse(redisResult),
|
||||
});
|
||||
} else {
|
||||
results.set(key, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, object>): Promise<void> {
|
||||
if (objectMap.size === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
let redisTransaction = this.context.redisClient.multi();
|
||||
objectMap.forEach((object, key) => {
|
||||
redisTransaction = redisTransaction.set(
|
||||
key,
|
||||
JSON.stringify(object),
|
||||
'EX',
|
||||
this.context.ttlSecondsPositive
|
||||
);
|
||||
});
|
||||
await wrapNativeRedisCall(() => redisTransaction.exec());
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync(keys: string[]): Promise<void> {
|
||||
if (keys.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
let redisTransaction = this.context.redisClient.multi();
|
||||
keys.forEach((key) => {
|
||||
redisTransaction = redisTransaction.set(
|
||||
key,
|
||||
DOES_NOT_EXIST_REDIS,
|
||||
'EX',
|
||||
this.context.ttlSecondsNegative
|
||||
);
|
||||
});
|
||||
await wrapNativeRedisCall(() => redisTransaction.exec());
|
||||
}
|
||||
|
||||
public async invalidateManyAsync(keys: string[]): Promise<void> {
|
||||
if (keys.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
await wrapNativeRedisCall(() => this.context.redisClient.del(...keys));
|
||||
}
|
||||
}
|
||||
@@ -1,16 +1,18 @@
|
||||
import {
|
||||
EntityCacheAdapter,
|
||||
EntityConfiguration,
|
||||
CacheLoadResult,
|
||||
FieldTransformerMap,
|
||||
mapKeys,
|
||||
CacheLoadResult,
|
||||
CacheStatus,
|
||||
} from '@expo/entity';
|
||||
import invariant from 'invariant';
|
||||
import { Redis } from 'ioredis';
|
||||
|
||||
import GenericRedisCacher from './GenericRedisCacher';
|
||||
import { redisTransformerMap } from './RedisCommon';
|
||||
|
||||
// Sentinel value we store in Redis to negatively cache a database miss.
|
||||
// The sentinel value is distinct from any (positively) cached value.
|
||||
const DOES_NOT_EXIST_REDIS = '';
|
||||
|
||||
export interface RedisCacheAdapterContext {
|
||||
/**
|
||||
* Instance of ioredis.Redis
|
||||
@@ -49,18 +51,11 @@ export interface RedisCacheAdapterContext {
|
||||
}
|
||||
|
||||
export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
|
||||
private readonly genericRedisCacher: GenericRedisCacher;
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly context: RedisCacheAdapterContext
|
||||
) {
|
||||
super(entityConfiguration);
|
||||
|
||||
this.genericRedisCacher = new GenericRedisCacher({
|
||||
redisClient: context.redisClient,
|
||||
ttlSecondsNegative: context.ttlSecondsNegative,
|
||||
ttlSecondsPositive: context.ttlSecondsPositive,
|
||||
});
|
||||
}
|
||||
|
||||
public getFieldTransformerMap(): FieldTransformerMap {
|
||||
@@ -71,62 +66,99 @@ export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFiel
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult>> {
|
||||
const redisCacheKeyToFieldValueMapping = new Map(
|
||||
fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue])
|
||||
);
|
||||
const cacheResults = await this.genericRedisCacher.loadManyAsync(
|
||||
Array.from(redisCacheKeyToFieldValueMapping.keys())
|
||||
);
|
||||
if (fieldValues.length === 0) {
|
||||
return new Map();
|
||||
}
|
||||
|
||||
return mapKeys(cacheResults, (redisCacheKey) => {
|
||||
const fieldValue = redisCacheKeyToFieldValueMapping.get(redisCacheKey);
|
||||
invariant(
|
||||
fieldValue !== undefined,
|
||||
'Unspecified cache key %s returned from generic Redis cacher',
|
||||
redisCacheKey
|
||||
);
|
||||
return fieldValue;
|
||||
});
|
||||
const redisKeys = fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue));
|
||||
const redisResults = await this.context.redisClient.mget(...redisKeys);
|
||||
|
||||
const results = new Map<NonNullable<TFields[N]>, CacheLoadResult>();
|
||||
for (let i = 0; i < fieldValues.length; i++) {
|
||||
const fieldValue = fieldValues[i];
|
||||
const redisResult = redisResults[i];
|
||||
|
||||
if (redisResult === DOES_NOT_EXIST_REDIS) {
|
||||
results.set(fieldValue, {
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
} else if (redisResult) {
|
||||
results.set(fieldValue, {
|
||||
status: CacheStatus.HIT,
|
||||
item: JSON.parse(redisResult),
|
||||
});
|
||||
} else {
|
||||
results.set(fieldValue, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
public async cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, object>
|
||||
): Promise<void> {
|
||||
await this.genericRedisCacher.cacheManyAsync(
|
||||
mapKeys(objectMap, (fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
if (objectMap.size === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
let redisTransaction = this.context.redisClient.multi();
|
||||
objectMap.forEach((object, fieldValue) => {
|
||||
const redisKey = this.makeCacheKey(fieldName, fieldValue);
|
||||
redisTransaction = redisTransaction.set(
|
||||
redisKey,
|
||||
JSON.stringify(object),
|
||||
'EX',
|
||||
this.context.ttlSecondsPositive
|
||||
);
|
||||
});
|
||||
await redisTransaction.exec();
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
await this.genericRedisCacher.cacheDBMissesAsync(
|
||||
fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
if (fieldValues.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
let redisTransaction = this.context.redisClient.multi();
|
||||
fieldValues.forEach((fieldValue) => {
|
||||
const redisKey = this.makeCacheKey(fieldName, fieldValue);
|
||||
redisTransaction = redisTransaction.set(
|
||||
redisKey,
|
||||
DOES_NOT_EXIST_REDIS,
|
||||
'EX',
|
||||
this.context.ttlSecondsNegative
|
||||
);
|
||||
});
|
||||
await redisTransaction.exec();
|
||||
}
|
||||
|
||||
public async invalidateManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
await this.genericRedisCacher.invalidateManyAsync(
|
||||
fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
if (fieldValues.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
const redisKeys = fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue));
|
||||
await this.context.redisClient.del(...redisKeys);
|
||||
}
|
||||
|
||||
private makeCacheKey<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): string {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${fieldName}`);
|
||||
return this.context.makeKeyFn(
|
||||
this.context.cacheKeyPrefix,
|
||||
this.entityConfiguration.tableName,
|
||||
`v2.${this.entityConfiguration.cacheKeyVersion}`,
|
||||
columnName,
|
||||
`v${this.entityConfiguration.cacheKeyVersion}`,
|
||||
fieldName as string,
|
||||
String(fieldValue)
|
||||
);
|
||||
}
|
||||
|
||||
+10
-38
@@ -38,21 +38,21 @@ describe(RedisCacheAdapter, () => {
|
||||
});
|
||||
|
||||
it('has correct caching behavior', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
const vc1 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
const cacheAdapter = vc1.entityCompanionProvider.getCompanionForEntity(
|
||||
RedisTestEntity,
|
||||
RedisTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
|
||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||
const entity1Created = await RedisTestEntity.creator(vc1)
|
||||
.setField('name', 'blah')
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
const entity1 = await RedisTestEntity.loader(viewerContext)
|
||||
const entity1 = await RedisTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
@@ -68,9 +68,7 @@ describe(RedisCacheAdapter, () => {
|
||||
// simulate non existent db fetch, should write negative result ('') to cache
|
||||
const nonExistentId = uuidv4();
|
||||
|
||||
const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
const entityNonExistentResult = await RedisTestEntity.loader(vc1).loadByIDAsync(nonExistentId);
|
||||
expect(entityNonExistentResult.ok).toBe(false);
|
||||
|
||||
const nonExistentCachedValue = await redisCacheAdapterContext.redisClient.get(
|
||||
@@ -79,13 +77,11 @@ describe(RedisCacheAdapter, () => {
|
||||
expect(nonExistentCachedValue).toEqual('');
|
||||
|
||||
// load again through entities framework to ensure it reads negative result
|
||||
const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
const entityNonExistentResult2 = await RedisTestEntity.loader(vc1).loadByIDAsync(nonExistentId);
|
||||
expect(entityNonExistentResult2.ok).toBe(false);
|
||||
|
||||
// invalidate from cache to ensure it invalidates correctly
|
||||
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
|
||||
await RedisTestEntity.loader(vc1).invalidateFieldsAsync(entity1.getAllFields());
|
||||
const cachedValueNull = await redisCacheAdapterContext.redisClient.get(
|
||||
cacheKeyMaker('id', entity1.getID())
|
||||
);
|
||||
@@ -93,18 +89,16 @@ describe(RedisCacheAdapter, () => {
|
||||
});
|
||||
|
||||
it('caches and restores date fields', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
const vc1 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const date = new Date();
|
||||
const entity1 = await enforceAsyncResult(
|
||||
RedisTestEntity.creator(viewerContext).setField('dateField', date).createAsync()
|
||||
RedisTestEntity.creator(vc1).setField('dateField', date).createAsync()
|
||||
);
|
||||
expect(entity1.getField('dateField')).toEqual(date);
|
||||
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1.getID());
|
||||
const entity2 = await RedisTestEntity.loader(vc1).enforcing().loadByIDAsync(entity1.getID());
|
||||
expect(entity2.getField('dateField')).toEqual(date);
|
||||
|
||||
// simulate new request
|
||||
@@ -114,26 +108,4 @@ describe(RedisCacheAdapter, () => {
|
||||
const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
|
||||
expect(entity3.getField('dateField')).toEqual(date);
|
||||
});
|
||||
|
||||
it('caches and restores empty string field keys', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity1 = await enforceAsyncResult(
|
||||
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
|
||||
);
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', '');
|
||||
expect(entity2?.getID()).toEqual(entity1.getID());
|
||||
|
||||
// simulate new request
|
||||
const vc2 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity3 = await RedisTestEntity.loader(vc2)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', '');
|
||||
expect(entity3?.getID()).toEqual(entity1.getID());
|
||||
});
|
||||
});
|
||||
@@ -1,46 +0,0 @@
|
||||
import { EntityCacheAdapterTransientError, ViewerContext } from '@expo/entity';
|
||||
import Redis from 'ioredis';
|
||||
import { URL } from 'url';
|
||||
|
||||
import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(RedisCacheAdapter, () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||
);
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
|
||||
it('throws when redis is disconnected', async () => {
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
|
||||
const vc1 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
await expect(
|
||||
RedisTestEntity.creator(vc1).setField('name', 'blah').enforceCreateAsync()
|
||||
).rejects.toThrow(EntityCacheAdapterTransientError);
|
||||
});
|
||||
});
|
||||
@@ -1,4 +1,10 @@
|
||||
import { CacheStatus, UUIDField, EntityConfiguration } from '@expo/entity';
|
||||
import {
|
||||
CacheStatus,
|
||||
UUIDField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
} from '@expo/entity';
|
||||
import { Redis, Pipeline } from 'ioredis';
|
||||
import { mock, when, instance, anything, verify } from 'ts-mockito';
|
||||
|
||||
@@ -14,8 +20,8 @@ const entityConfiguration = new EntityConfiguration<BlahFields>({
|
||||
schema: {
|
||||
id: new UUIDField({ columnName: 'id', cache: true }),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
describe(RedisCacheAdapter, () => {
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
import { EntityCacheAdapterTransientError } from '@expo/entity';
|
||||
|
||||
export default async function wrapNativeRedisCall<T>(fn: () => Promise<T>): Promise<T> {
|
||||
try {
|
||||
return await fn();
|
||||
} catch (e) {
|
||||
const error = new EntityCacheAdapterTransientError(e.message, e);
|
||||
error.stack = e.stack;
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
@@ -1,12 +1,8 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-cache-adapter-redis
|
||||
* Automatically generated by barrelsby.
|
||||
*/
|
||||
|
||||
export { default as RedisCacheAdapter } from './RedisCacheAdapter';
|
||||
export * from './RedisCacheAdapter';
|
||||
export { default as RedisCacheAdapterProvider } from './RedisCacheAdapterProvider';
|
||||
export * from './RedisCommon';
|
||||
export { default as GenericRedisCacher } from './GenericRedisCacher';
|
||||
export * from './GenericRedisCacher';
|
||||
@@ -6,6 +6,8 @@ import {
|
||||
DateField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
@@ -28,7 +30,7 @@ export default class RedisTestEntity extends Entity<RedisTestEntityFields, strin
|
||||
}
|
||||
}
|
||||
|
||||
export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
@@ -78,14 +80,13 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
cache: true,
|
||||
}),
|
||||
dateField: new DateField({
|
||||
columnName: 'date_field',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
|
||||
+13
-17
@@ -2,6 +2,8 @@ import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
@@ -15,22 +17,16 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
{
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
},
|
||||
{
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -3,90 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
|
||||
* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
@@ -9,9 +9,9 @@
|
||||
During `EntityCompanionProvider` instantiation:
|
||||
|
||||
```typescript
|
||||
import { knex, Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
const knexInstance = knex({
|
||||
const knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env.PGUSER,
|
||||
@@ -29,7 +29,7 @@ export const createDefaultEntityCompanionProvider = (
|
||||
metricsAdapter,
|
||||
{
|
||||
// add the knex database adapter flavor
|
||||
['postgres']: {
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapter: PostgresEntityDatabaseAdapter,
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knexInstance),
|
||||
},
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-database-adapter-knex",
|
||||
"version": "0.16.0",
|
||||
"version": "0.10.0",
|
||||
"description": "Knex database adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -11,7 +11,7 @@
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
@@ -29,9 +29,9 @@
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"knex": "^0.95.6"
|
||||
"knex": "^0.21.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.16.0"
|
||||
"@expo/entity": "^0.10.0"
|
||||
}
|
||||
}
|
||||
@@ -8,9 +8,7 @@ import {
|
||||
TableFieldSingleValueEqualityCondition,
|
||||
TableFieldMultiValueEqualityCondition,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
import wrapNativePostgresCall from './errors/wrapNativePostgresCall';
|
||||
import Knex from 'knex';
|
||||
|
||||
export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDatabaseAdapter<TFields> {
|
||||
protected getFieldTransformerMap(): FieldTransformerMap {
|
||||
@@ -45,12 +43,10 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
tableField: string,
|
||||
tableValues: readonly any[]
|
||||
): Promise<object[]> {
|
||||
return await wrapNativePostgresCall(() =>
|
||||
queryInterface
|
||||
.select()
|
||||
.from(tableName)
|
||||
.whereRaw('?? = ANY(?)', [tableField, tableValues as any[]])
|
||||
);
|
||||
return await queryInterface
|
||||
.select()
|
||||
.from(tableName)
|
||||
.whereRaw('?? = ANY(?)', [tableField, tableValues as any[]]);
|
||||
}
|
||||
|
||||
private applyQueryModifiersToQuery(
|
||||
@@ -89,41 +85,20 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
|
||||
if (tableFieldSingleValueEqualityOperands.length > 0) {
|
||||
const whereObject: { [key: string]: any } = {};
|
||||
const nonNullTableFieldSingleValueEqualityOperands = tableFieldSingleValueEqualityOperands.filter(
|
||||
({ tableValue }) => tableValue !== null
|
||||
);
|
||||
const nullTableFieldSingleValueEqualityOperands = tableFieldSingleValueEqualityOperands.filter(
|
||||
({ tableValue }) => tableValue === null
|
||||
);
|
||||
|
||||
if (nonNullTableFieldSingleValueEqualityOperands.length > 0) {
|
||||
for (const { tableField, tableValue } of nonNullTableFieldSingleValueEqualityOperands) {
|
||||
whereObject[tableField] = tableValue;
|
||||
}
|
||||
query = query.where(whereObject);
|
||||
}
|
||||
if (nullTableFieldSingleValueEqualityOperands.length > 0) {
|
||||
for (const { tableField } of nullTableFieldSingleValueEqualityOperands) {
|
||||
query = query.whereNull(tableField);
|
||||
}
|
||||
for (const { tableField, tableValue } of tableFieldSingleValueEqualityOperands) {
|
||||
whereObject[tableField] = tableValue;
|
||||
}
|
||||
query = query.where(whereObject);
|
||||
}
|
||||
|
||||
if (tableFieldMultiValueEqualityOperands.length > 0) {
|
||||
for (const { tableField, tableValues } of tableFieldMultiValueEqualityOperands) {
|
||||
const nonNullTableValues = tableValues.filter((tableValue) => tableValue !== null);
|
||||
query = query.where((builder) => {
|
||||
builder.whereRaw('?? = ANY(?)', [tableField, [...nonNullTableValues]]);
|
||||
// there was at least one null, allow null in this equality clause
|
||||
if (nonNullTableValues.length !== tableValues.length) {
|
||||
builder.orWhereNull(tableField);
|
||||
}
|
||||
});
|
||||
query = query.whereRaw('?? = ANY(?)', [tableField, tableValues]);
|
||||
}
|
||||
}
|
||||
|
||||
query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
|
||||
return await wrapNativePostgresCall(() => query);
|
||||
return await query;
|
||||
}
|
||||
|
||||
protected async fetchManyByRawWhereClauseInternalAsync(
|
||||
@@ -138,7 +113,7 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
.from(tableName)
|
||||
.whereRaw(rawWhereClause, bindings as any);
|
||||
query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
|
||||
return await wrapNativePostgresCall(() => query);
|
||||
return await query;
|
||||
}
|
||||
|
||||
protected async insertInternalAsync(
|
||||
@@ -146,9 +121,7 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
tableName: string,
|
||||
object: object
|
||||
): Promise<object[]> {
|
||||
return await wrapNativePostgresCall(() =>
|
||||
queryInterface.insert(object).into(tableName).returning('*')
|
||||
);
|
||||
return await queryInterface.insert(object).into(tableName).returning('*');
|
||||
}
|
||||
|
||||
protected async updateInternalAsync(
|
||||
@@ -158,9 +131,11 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
id: any,
|
||||
object: object
|
||||
): Promise<object[]> {
|
||||
return await wrapNativePostgresCall(() =>
|
||||
queryInterface.update(object).into(tableName).where(tableIdField, id).returning('*')
|
||||
);
|
||||
return await queryInterface
|
||||
.update(object)
|
||||
.into(tableName)
|
||||
.where(tableIdField, id)
|
||||
.returning('*');
|
||||
}
|
||||
|
||||
protected async deleteInternalAsync(
|
||||
@@ -169,8 +144,6 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
tableIdField: string,
|
||||
id: any
|
||||
): Promise<number> {
|
||||
return await wrapNativePostgresCall(() =>
|
||||
queryInterface.into(tableName).where(tableIdField, id).del()
|
||||
);
|
||||
return await queryInterface.into(tableName).where(tableIdField, id).del();
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
import { EntityQueryContextProvider } from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
/**
|
||||
* Query context provider for knex (postgres).
|
||||
|
||||
+3
-56
@@ -5,7 +5,7 @@ import {
|
||||
ViewerContext,
|
||||
} from '@expo/entity';
|
||||
import { enforceAsyncResult } from '@expo/results';
|
||||
import { knex, Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
import PostgresTestEntity from '../testfixtures/PostgresTestEntity';
|
||||
import PostgresTriggerTestEntity from '../testfixtures/PostgresTriggerTestEntity';
|
||||
@@ -16,7 +16,7 @@ describe('postgres entity integration', () => {
|
||||
let knexInstance: Knex;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env.PGUSER,
|
||||
@@ -94,7 +94,7 @@ describe('postgres entity integration', () => {
|
||||
const errorToThrow = new Error('Intentional error');
|
||||
|
||||
await expect(
|
||||
vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
PostgresTestEntity.runInTransactionAsync(vc1, async (queryContext) => {
|
||||
// put another in the DB that will be rolled back due to error thrown
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1, queryContext).setField('name', 'hello').createAsync()
|
||||
@@ -231,59 +231,6 @@ describe('postgres entity integration', () => {
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results.map((e) => e.getField('name'))).toEqual(['b', 'a']);
|
||||
});
|
||||
|
||||
it('supports null field values', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1)
|
||||
.setField('name', 'a')
|
||||
.setField('hasADog', true)
|
||||
.createAsync()
|
||||
);
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1)
|
||||
.setField('name', 'b')
|
||||
.setField('hasADog', true)
|
||||
.createAsync()
|
||||
);
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1)
|
||||
.setField('name', null)
|
||||
.setField('hasADog', true)
|
||||
.createAsync()
|
||||
);
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1)
|
||||
.setField('name', null)
|
||||
.setField('hasADog', false)
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([{ fieldName: 'name', fieldValue: null }]);
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results[0].getField('name')).toBeNull();
|
||||
|
||||
const results2 = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync(
|
||||
[
|
||||
{ fieldName: 'name', fieldValues: ['a', null] },
|
||||
{ fieldName: 'hasADog', fieldValue: true },
|
||||
],
|
||||
{
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
}
|
||||
);
|
||||
expect(results2).toHaveLength(2);
|
||||
expect(results2.map((e) => e.getField('name'))).toEqual([null, 'a']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('raw where clause loading', () => {
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
import { ViewerContext } from '@expo/entity';
|
||||
import { enforceAsyncResult } from '@expo/results';
|
||||
import { knex, Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
import InvalidTestEntity from '../testfixtures/InvalidTestEntity';
|
||||
import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
|
||||
@@ -9,7 +9,7 @@ describe('postgres entity integration', () => {
|
||||
let knexInstance: Knex;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env.PGUSER,
|
||||
|
||||
@@ -1,170 +0,0 @@
|
||||
import {
|
||||
ViewerContext,
|
||||
EntityDatabaseAdapterCheckConstraintError,
|
||||
EntityDatabaseAdapterExclusionConstraintError,
|
||||
EntityDatabaseAdapterForeignKeyConstraintError,
|
||||
EntityDatabaseAdapterNotNullConstraintError,
|
||||
EntityDatabaseAdapterTransientError,
|
||||
EntityDatabaseAdapterUniqueConstraintError,
|
||||
EntityDatabaseAdapterUnknownError,
|
||||
} from '@expo/entity';
|
||||
import { knex, Knex } from 'knex';
|
||||
|
||||
import ErrorsTestEntity from '../testfixtures/ErrorsTestEntity';
|
||||
import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
|
||||
|
||||
describe('postgres errors', () => {
|
||||
let knexInstance: Knex;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env.PGUSER,
|
||||
password: process.env.PGPASSWORD,
|
||||
host: 'localhost',
|
||||
port: parseInt(process.env.PGPORT!, 10),
|
||||
database: process.env.PGDATABASE,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await ErrorsTestEntity.createOrTruncatePostgresTable(knexInstance);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await ErrorsTestEntity.dropPostgresTable(knexInstance);
|
||||
await knexInstance.destroy();
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterTransientError on Knex timeout', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
const shortTimeoutKnexInstance = knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env.PGUSER,
|
||||
password: process.env.PGPASSWORD,
|
||||
host: 'localhost',
|
||||
port: parseInt(process.env.PGPORT!, 10),
|
||||
database: process.env.PGDATABASE,
|
||||
},
|
||||
acquireConnectionTimeout: 1,
|
||||
});
|
||||
const vc2 = new ViewerContext(
|
||||
createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance)
|
||||
);
|
||||
await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow(
|
||||
EntityDatabaseAdapterTransientError
|
||||
);
|
||||
await shortTimeoutKnexInstance.destroy();
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterNotNullConstraintError when not null is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', null as any)
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterNotNullConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterForeignKeyConstraintError when foreign key is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldForeignKey', 2)
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterForeignKeyConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterUniqueConstraintError when primary key unique constraint is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
await ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterUniqueConstraintError when unique constraint is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 2)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldUnique', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldUnique', 'hello')
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterCheckConstraintError when check constraint is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('checkLessThan5', 2)
|
||||
.enforceCreateAsync()
|
||||
).resolves.toBeTruthy();
|
||||
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 2)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('checkLessThan5', 10)
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterCheckConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterExclusionConstraintError when exclusion constraint is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldExclusion', 'what')
|
||||
.enforceCreateAsync()
|
||||
).resolves.toBeTruthy();
|
||||
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 2)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldExclusion', 'what')
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterExclusionConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterUnknownError otherwise', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('nonExistentColumn', 'what')
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterUnknownError);
|
||||
});
|
||||
});
|
||||
@@ -1,50 +0,0 @@
|
||||
import {
|
||||
EntityDatabaseAdapterError,
|
||||
EntityDatabaseAdapterCheckConstraintError,
|
||||
EntityDatabaseAdapterExclusionConstraintError,
|
||||
EntityDatabaseAdapterForeignKeyConstraintError,
|
||||
EntityDatabaseAdapterNotNullConstraintError,
|
||||
EntityDatabaseAdapterTransientError,
|
||||
EntityDatabaseAdapterUniqueConstraintError,
|
||||
EntityDatabaseAdapterUnknownError,
|
||||
} from '@expo/entity';
|
||||
import { knex } from 'knex';
|
||||
|
||||
function wrapNativePostgresError(
|
||||
error: Error & { code: string | undefined }
|
||||
): EntityDatabaseAdapterError & Error {
|
||||
const ret = translatePostgresError(error);
|
||||
ret.stack = error.stack;
|
||||
return ret;
|
||||
}
|
||||
|
||||
function translatePostgresError(
|
||||
error: Error & { code: string | undefined }
|
||||
): EntityDatabaseAdapterError & Error {
|
||||
if (error instanceof knex.KnexTimeoutError) {
|
||||
return new EntityDatabaseAdapterTransientError(error.message, error);
|
||||
}
|
||||
|
||||
switch (error.code) {
|
||||
case '23502':
|
||||
return new EntityDatabaseAdapterNotNullConstraintError(error.message, error);
|
||||
case '23503':
|
||||
return new EntityDatabaseAdapterForeignKeyConstraintError(error.message, error);
|
||||
case '23505':
|
||||
return new EntityDatabaseAdapterUniqueConstraintError(error.message, error);
|
||||
case '23514':
|
||||
return new EntityDatabaseAdapterCheckConstraintError(error.message, error);
|
||||
case '23P01':
|
||||
return new EntityDatabaseAdapterExclusionConstraintError(error.message, error);
|
||||
default:
|
||||
return new EntityDatabaseAdapterUnknownError(error.message, error);
|
||||
}
|
||||
}
|
||||
|
||||
export default async function wrapNativePostgresCall<T>(fn: () => Promise<T>): Promise<T> {
|
||||
try {
|
||||
return await fn();
|
||||
} catch (e) {
|
||||
throw wrapNativePostgresError(e);
|
||||
}
|
||||
}
|
||||
@@ -1,9 +1,3 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-database-adapter-knex
|
||||
*/
|
||||
|
||||
export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter';
|
||||
export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider';
|
||||
export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider';
|
||||
@@ -1,177 +0,0 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
ViewerContext,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
NumberField,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
type ErrorsTestEntityFields = {
|
||||
id: number;
|
||||
fieldNonNull: string;
|
||||
fieldForeignKey: number | null;
|
||||
fieldUnique: string | null;
|
||||
checkLessThan5: number | null;
|
||||
fieldExclusion: string | null;
|
||||
nonExistentColumn: string | null;
|
||||
};
|
||||
|
||||
const foreignTableName = 'foreign_table';
|
||||
|
||||
export default class ErrorsTestEntity extends Entity<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext
|
||||
> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity,
|
||||
ErrorsTestEntityPrivacyPolicy
|
||||
> {
|
||||
return errorsTestEntityCompanionDefinition;
|
||||
}
|
||||
|
||||
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
|
||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "btree_gist"'); // for gist exclusion on varchar
|
||||
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
|
||||
const hasForeignTable = await knex.schema.hasTable(foreignTableName);
|
||||
if (!hasForeignTable) {
|
||||
await knex.schema.createTable(foreignTableName, (table) => {
|
||||
table.integer('id').primary();
|
||||
});
|
||||
}
|
||||
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (!hasTable) {
|
||||
await knex.schema.createTable(tableName, (table) => {
|
||||
table.integer('id').primary();
|
||||
table.string('field_non_null').notNullable();
|
||||
table.integer('field_foreign_key').references(`${foreignTableName}.id`);
|
||||
table.string('field_unique').unique();
|
||||
table.integer('check_less_than_5');
|
||||
table.string('field_exclusion');
|
||||
});
|
||||
|
||||
await knex.raw(
|
||||
`
|
||||
ALTER TABLE :tableName:
|
||||
ADD CONSTRAINT check_less_than_5_check_constraint
|
||||
CHECK (check_less_than_5 IS NULL OR check_less_than_5 < 5);`,
|
||||
{
|
||||
tableName,
|
||||
}
|
||||
);
|
||||
|
||||
await knex.raw(
|
||||
`
|
||||
ALTER TABLE :tableName:
|
||||
ADD CONSTRAINT field_exclusion_exclusion_constraint
|
||||
EXCLUDE USING gist (field_exclusion WITH =);
|
||||
`,
|
||||
{
|
||||
tableName,
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
await knex(tableName).delete();
|
||||
await knex(foreignTableName).delete();
|
||||
}
|
||||
|
||||
public static async dropPostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (hasTable) {
|
||||
await knex.schema.dropTable(tableName);
|
||||
}
|
||||
|
||||
const hasForeignTable = await knex.schema.hasTable(foreignTableName);
|
||||
if (hasForeignTable) {
|
||||
await knex.schema.dropTable(foreignTableName);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class ErrorsTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
> {
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const ErrorsTestEntityConfiguration = new EntityConfiguration<ErrorsTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'postgres_test_entities',
|
||||
schema: {
|
||||
id: new NumberField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
fieldNonNull: new StringField({
|
||||
columnName: 'field_non_null',
|
||||
}),
|
||||
fieldForeignKey: new NumberField({
|
||||
columnName: 'field_foreign_key',
|
||||
}),
|
||||
fieldUnique: new StringField({
|
||||
columnName: 'field_unique',
|
||||
}),
|
||||
checkLessThan5: new NumberField({
|
||||
columnName: 'check_less_than_5',
|
||||
}),
|
||||
fieldExclusion: new StringField({
|
||||
columnName: 'field_exclusion',
|
||||
}),
|
||||
nonExistentColumn: new StringField({
|
||||
columnName: 'non_existent_column',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const errorsTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: ErrorsTestEntity,
|
||||
entityConfiguration: ErrorsTestEntityConfiguration,
|
||||
privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
|
||||
});
|
||||
@@ -4,11 +4,13 @@ import {
|
||||
ViewerContext,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
NumberField,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
type InvalidTestEntityFields = {
|
||||
id: number;
|
||||
@@ -102,8 +104,8 @@ export const invalidTestEntityConfiguration = new EntityConfiguration<InvalidTes
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const invalidTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
|
||||
@@ -11,10 +11,12 @@ import {
|
||||
DateField,
|
||||
MaybeJSONArrayField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
type PostgresTestEntityFields = {
|
||||
id: string;
|
||||
@@ -148,8 +150,8 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
|
||||
columnName: 'maybe_json_array_field',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
|
||||
+8
-13
@@ -5,14 +5,15 @@ import {
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
EntityMutationTrigger,
|
||||
EntityQueryContext,
|
||||
EntityNonTransactionalMutationTrigger,
|
||||
EntityMutationInfo,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
type PostgresTriggerTestEntityFields = {
|
||||
id: string;
|
||||
@@ -110,13 +111,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
||||
async executeAsync(
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
entity: PostgresTriggerTestEntity,
|
||||
_mutationInfo: EntityMutationInfo<
|
||||
PostgresTriggerTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresTriggerTestEntity
|
||||
>
|
||||
entity: PostgresTriggerTestEntity
|
||||
): Promise<void> {
|
||||
if (entity.getField(this.fieldName) === this.badValue) {
|
||||
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
||||
@@ -158,15 +153,15 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: PostgresTriggerTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresTriggerTestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
mutationTriggers: {
|
||||
beforeCreate: [new ThrowConditionallyTrigger('name', 'beforeCreate')],
|
||||
afterCreate: [new ThrowConditionallyTrigger('name', 'afterCreate')],
|
||||
beforeUpdate: [new ThrowConditionallyTrigger('name', 'beforeUpdate')],
|
||||
@@ -176,5 +171,5 @@ const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
beforeAll: [new ThrowConditionallyTrigger('name', 'beforeAll')],
|
||||
afterAll: [new ThrowConditionallyTrigger('name', 'afterAll')],
|
||||
afterCommit: [new ThrowConditionallyNonTransactionalTrigger('name', 'afterCommit')],
|
||||
}),
|
||||
},
|
||||
});
|
||||
+7
-12
@@ -5,13 +5,14 @@ import {
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
EntityMutationTrigger,
|
||||
EntityQueryContext,
|
||||
EntityMutationInfo,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
type PostgresValidatorTestEntityFields = {
|
||||
id: string;
|
||||
@@ -112,13 +113,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
||||
async executeAsync(
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
entity: PostgresValidatorTestEntity,
|
||||
_mutationInfo: EntityMutationInfo<
|
||||
PostgresValidatorTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresValidatorTestEntity
|
||||
>
|
||||
entity: PostgresValidatorTestEntity
|
||||
): Promise<void> {
|
||||
if (entity.getField(this.fieldName) === this.badValue) {
|
||||
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
||||
@@ -140,13 +135,13 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: PostgresValidatorTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
|
||||
mutationValidators: () => [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
|
||||
mutationValidators: [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
|
||||
});
|
||||
+14
-18
@@ -2,9 +2,11 @@ import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
InMemoryFullCacheStubCacheAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
import PostgresEntityDatabaseAdapterProvider from '../PostgresEntityDatabaseAdapterProvider';
|
||||
import PostgresEntityQueryContextProvider from '../PostgresEntityQueryContextProvider';
|
||||
@@ -15,22 +17,16 @@ export const createKnexIntegrationTestEntityCompanionProvider = (
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||
},
|
||||
],
|
||||
])
|
||||
{
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
|
||||
},
|
||||
},
|
||||
{
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -3,74 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@expo/entity-example",
|
||||
"private": true,
|
||||
"version": "0.16.0",
|
||||
"version": "0.10.0",
|
||||
"description": "An example integration of the @expo/entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
@@ -22,7 +22,7 @@
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@expo/entity": "^0.16.0",
|
||||
"@expo/entity": "^0.10.0",
|
||||
"apollo-server-koa": "^2.16.1",
|
||||
"graphql": "^15.3.0",
|
||||
"koa": "^2.13.0",
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { createUnitTestEntityCompanionProvider } from '@expo/entity';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import NoteEntity from '../entities/NoteEntity';
|
||||
import { UserViewerContext } from '../viewerContexts';
|
||||
@@ -7,18 +6,17 @@ import { UserViewerContext } from '../viewerContexts';
|
||||
describe(NoteEntity, () => {
|
||||
test('demonstrate usage of business logic test utilities', async () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const userId = uuidv4();
|
||||
const viewerContext = new UserViewerContext(companionProvider, userId);
|
||||
const viewerContext = new UserViewerContext(companionProvider, '4');
|
||||
|
||||
const createdEntityResult = await NoteEntity.creator(viewerContext)
|
||||
.setField('userID', userId)
|
||||
.setField('userID', '4')
|
||||
.setField('body', 'image')
|
||||
.setField('title', 'page')
|
||||
.createAsync();
|
||||
expect(createdEntityResult.ok).toBe(true);
|
||||
|
||||
const createdEntityResultImpersonate = await NoteEntity.creator(viewerContext)
|
||||
.setField('userID', uuidv4()) // a different user
|
||||
.setField('userID', '5')
|
||||
.setField('body', 'image')
|
||||
.setField('title', 'page')
|
||||
.createAsync();
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import http from 'http';
|
||||
import request from 'supertest';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import app from '../app';
|
||||
|
||||
@@ -8,15 +7,14 @@ describe('graphql', () => {
|
||||
it('allows CRUD of user notes', async () => {
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
const responseEmpty = await server.post('/graphql').set('totally-secure-user-id', userId).send({
|
||||
const responseEmpty = await server.post('/graphql').set('totally-secure-user-id', '4').send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
expect(responseEmpty.body.data.me.notes).toEqual([]);
|
||||
|
||||
const createResponse1 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -33,7 +31,7 @@ describe('graphql', () => {
|
||||
|
||||
const createResponse2 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -44,17 +42,14 @@ describe('graphql', () => {
|
||||
},
|
||||
});
|
||||
|
||||
const responseLength2 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
const responseLength2 = await server.post('/graphql').set('totally-secure-user-id', '4').send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
expect(responseLength2.body.data.me.notes).toHaveLength(2);
|
||||
|
||||
const responseGetSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `query($id: ID!) { noteByID(id: $id) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -69,7 +64,7 @@ describe('graphql', () => {
|
||||
|
||||
const responseUpdateSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($id: ID!, $note: NoteInput!) { updateNote(id: $id, note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -89,7 +84,7 @@ describe('graphql', () => {
|
||||
|
||||
const responseDeleteSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($id: ID!) { deleteNote(id: $id) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -107,12 +102,9 @@ describe('graphql', () => {
|
||||
body: 'boarding',
|
||||
});
|
||||
|
||||
const responseLength1 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
const responseLength1 = await server.post('/graphql').set('totally-secure-user-id', '4').send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
expect(responseLength1.body.data.me.notes).toHaveLength(1);
|
||||
});
|
||||
|
||||
@@ -135,11 +127,9 @@ describe('graphql', () => {
|
||||
it('disallows cross-user note impersonation', async () => {
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
const userId2 = uuidv4();
|
||||
const createResponse1 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -153,7 +143,7 @@ describe('graphql', () => {
|
||||
// notes are public
|
||||
const responseGetSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId2)
|
||||
.set('totally-secure-user-id', '5')
|
||||
.send({
|
||||
query: `query($id: ID!) { noteByID(id: $id) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -169,7 +159,7 @@ describe('graphql', () => {
|
||||
// but can only be updated by the owner
|
||||
const responseUpdateSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId2)
|
||||
.set('totally-secure-user-id', '5')
|
||||
.send({
|
||||
query: `mutation($id: ID!, $note: NoteInput!) { updateNote(id: $id, note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import http from 'http';
|
||||
import request from 'supertest';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import app from '../app';
|
||||
|
||||
@@ -12,74 +11,59 @@ describe('notesRouter', () => {
|
||||
|
||||
it('allows CRUD of user notes', async () => {
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
|
||||
const responseEmpty = await server.get('/notes/').set('totally-secure-user-id', userId).send();
|
||||
const responseEmpty = await server.get('/notes/').set('totally-secure-user-id', '4').send();
|
||||
expect(responseEmpty.body.notes).toEqual([]);
|
||||
|
||||
const createResponse1 = await server
|
||||
.post('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
const createResponse1 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
expect(createResponse1.body.note).toMatchObject({
|
||||
userID: userId,
|
||||
userID: '4',
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
|
||||
const createResponse2 = await server
|
||||
.post('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
title: 'nine',
|
||||
body: 'lotion',
|
||||
});
|
||||
const createResponse2 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
|
||||
title: 'nine',
|
||||
body: 'lotion',
|
||||
});
|
||||
|
||||
const responseLength2 = await server
|
||||
.get('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send();
|
||||
const responseLength2 = await server.get('/notes/').set('totally-secure-user-id', '4').send();
|
||||
expect(responseLength2.body.notes).toHaveLength(2);
|
||||
|
||||
const responseGetSingle = await server
|
||||
.get(`/notes/${createResponse2.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send();
|
||||
expect(responseGetSingle.body.note).toMatchObject({
|
||||
id: createResponse2.body.note.id,
|
||||
userID: userId,
|
||||
userID: '4',
|
||||
title: 'nine',
|
||||
body: 'lotion',
|
||||
});
|
||||
|
||||
const responseUpdateSingle = await server
|
||||
.put(`/notes/${createResponse2.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
title: 'wave',
|
||||
body: 'boarding',
|
||||
});
|
||||
expect(responseUpdateSingle.body.note).toMatchObject({
|
||||
id: responseGetSingle.body.note.id,
|
||||
userID: userId,
|
||||
userID: '4',
|
||||
title: 'wave',
|
||||
body: 'boarding',
|
||||
});
|
||||
|
||||
const responseDeleteSingle = await server
|
||||
.delete(`/notes/${createResponse2.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send();
|
||||
expect(responseDeleteSingle.body.status).toEqual('ok');
|
||||
|
||||
const responseLength1 = await server
|
||||
.get('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send();
|
||||
const responseLength1 = await server.get('/notes/').set('totally-secure-user-id', '4').send();
|
||||
expect(responseLength1.body.notes).toHaveLength(1);
|
||||
});
|
||||
|
||||
@@ -95,28 +79,23 @@ describe('notesRouter', () => {
|
||||
|
||||
it('disallows cross-user note impersonation', async () => {
|
||||
const server = request(http.createServer(app.callback()));
|
||||
const userId = uuidv4();
|
||||
const userId2 = uuidv4();
|
||||
const createResponse1 = await server
|
||||
.post('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
const createResponse1 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
expect(createResponse1.ok).toBe(true);
|
||||
|
||||
// notes are public
|
||||
const responseGetSingleOtherUser = await server
|
||||
.get(`/notes/${createResponse1.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId2)
|
||||
.set('totally-secure-user-id', '5')
|
||||
.send();
|
||||
expect(responseGetSingleOtherUser.ok).toBe(true);
|
||||
|
||||
// but can only be updated by the owner
|
||||
const responseUpdateSingle = await server
|
||||
.put(`/notes/${createResponse1.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId2)
|
||||
.set('totally-secure-user-id', '5')
|
||||
.send({
|
||||
title: 'wave',
|
||||
body: 'boarding',
|
||||
|
||||
@@ -3,6 +3,8 @@ import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
InMemoryFullCacheStubCacheAdapterProvider,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
} from '@expo/entity';
|
||||
|
||||
import { InMemoryDatabaseAdapterProvider } from './adapters/InMemoryDatabaseAdapter';
|
||||
@@ -19,26 +21,20 @@ export const createEntityCompanionProvider = (
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
// An in-memory DB is used for demonstration purposes, but generally this would be
|
||||
// instantiated with PostgresEntityDatabaseAdapter and PostgresEntityQueryContextProvider
|
||||
{
|
||||
adapterProvider: new InMemoryDatabaseAdapterProvider(),
|
||||
queryContextProvider: new InMemoryQueryContextProvider(),
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
// An in-memory cache is used for demonstration purposes, but generally this would be
|
||||
// instantiated with a RedisCacheAdapterProvider
|
||||
{
|
||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||
},
|
||||
],
|
||||
])
|
||||
{
|
||||
// An in-memory DB is used for demonstration purposes, but generally this would be
|
||||
// instantiated with PostgresEntityDatabaseAdapter and PostgresEntityQueryContextProvider
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapterProvider: new InMemoryDatabaseAdapterProvider(),
|
||||
queryContextProvider: new InMemoryQueryContextProvider(),
|
||||
},
|
||||
},
|
||||
{
|
||||
// An in-memory cache is used for demonstration purposes, but generally this would be
|
||||
// instantiated with a RedisCacheAdapterProvider
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -23,9 +23,8 @@ import { ExampleViewerContext } from '../viewerContexts';
|
||||
*/
|
||||
export default class AllowIfUserOwnerPrivacyRule<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
TID,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>
|
||||
> extends PrivacyPolicyRule<TFields, TID, ExampleViewerContext, TEntity> {
|
||||
constructor(private readonly entityOwnerField: keyof TFields) {
|
||||
super();
|
||||
|
||||
@@ -3,6 +3,8 @@ import {
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
UUIDField,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
StringField,
|
||||
} from '@expo/entity';
|
||||
|
||||
@@ -55,8 +57,8 @@ export const noteEntityCompanion = new EntityCompanionDefinition({
|
||||
columnName: 'body',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
}),
|
||||
privacyPolicyClass: NotePrivacyPolicy,
|
||||
});
|
||||
@@ -3,80 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@expo/entity-full-integration-tests",
|
||||
"private": true,
|
||||
"version": "0.16.0",
|
||||
"version": "0.10.0",
|
||||
"description": "Full redis and knex integration tests for the entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
@@ -26,8 +26,8 @@
|
||||
"@expo/entity-database-adapter-knex": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.16.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.16.0",
|
||||
"@expo/entity-database-adapter-knex": "^0.16.0"
|
||||
"@expo/entity": "^0.10.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.10.0",
|
||||
"@expo/entity-database-adapter-knex": "^0.10.0"
|
||||
}
|
||||
}
|
||||
+22
-32
@@ -5,12 +5,13 @@ import {
|
||||
Entity,
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
UUIDField,
|
||||
StringField,
|
||||
} from '@expo/entity';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
import { URL } from 'url';
|
||||
|
||||
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
||||
@@ -27,18 +28,10 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ViewerContext,
|
||||
TestEntity
|
||||
> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
class TestEntity extends Entity<TestFields, string, ViewerContext> {
|
||||
@@ -61,16 +54,16 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
other_string: new StringField({
|
||||
other_string: new UUIDField({
|
||||
columnName: 'other_string',
|
||||
cache: true,
|
||||
}),
|
||||
third_string: new StringField({
|
||||
third_string: new UUIDField({
|
||||
columnName: 'third_string',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const testEntityCompanion = new EntityCompanionDefinition({
|
||||
@@ -104,7 +97,7 @@ describe('Entity cache inconsistency', () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env.PGUSER,
|
||||
@@ -158,12 +151,12 @@ describe('Entity cache inconsistency', () => {
|
||||
.loadByFieldEqualingAsync('other_string', 'hello');
|
||||
|
||||
let openBarrier1: () => void;
|
||||
const barrier1 = new Promise<void>((resolve) => {
|
||||
const barrier1 = new Promise((resolve) => {
|
||||
openBarrier1 = resolve;
|
||||
});
|
||||
|
||||
let openBarrier2: () => void;
|
||||
const barrier2 = new Promise<void>((resolve) => {
|
||||
const barrier2 = new Promise((resolve) => {
|
||||
openBarrier2 = resolve;
|
||||
});
|
||||
|
||||
@@ -182,19 +175,16 @@ describe('Entity cache inconsistency', () => {
|
||||
|
||||
openBarrier2!();
|
||||
})(),
|
||||
viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
|
||||
'postgres',
|
||||
async (queryContext) => {
|
||||
await TestEntity.updater(entity1, queryContext)
|
||||
.setField('third_string', 'updated')
|
||||
.enforceUpdateAsync();
|
||||
TestEntity.runInTransactionAsync(viewerContext, async (queryContext) => {
|
||||
await TestEntity.updater(entity1, queryContext)
|
||||
.setField('third_string', 'updated')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
openBarrier1();
|
||||
openBarrier1();
|
||||
|
||||
// wait for to ensure the transaction isn't committed until after load above occurs
|
||||
await barrier2;
|
||||
}
|
||||
),
|
||||
// wait for to ensure the transaction isn't committed until after load above occurs
|
||||
await barrier2;
|
||||
}),
|
||||
]);
|
||||
|
||||
// ensure cache consistency
|
||||
|
||||
+2
-2
@@ -1,7 +1,7 @@
|
||||
import { ViewerContext } from '@expo/entity';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
import { URL } from 'url';
|
||||
|
||||
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
||||
@@ -37,7 +37,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env.PGUSER,
|
||||
|
||||
+12
-18
@@ -5,12 +5,14 @@ import {
|
||||
Entity,
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
UUIDField,
|
||||
EntityEdgeDeletionBehavior,
|
||||
} from '@expo/entity';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
import { URL } from 'url';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
@@ -27,18 +29,10 @@ interface OtherFields {
|
||||
}
|
||||
|
||||
class PrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
||||
@@ -88,8 +82,8 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const categoryEntityCompanion = new EntityCompanionDefinition({
|
||||
@@ -116,8 +110,8 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const otherEntityCompanion = new EntityCompanionDefinition({
|
||||
@@ -166,7 +160,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env.PGUSER,
|
||||
|
||||
+8
-14
@@ -1,5 +1,7 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
Entity,
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
@@ -17,18 +19,10 @@ interface ChildFields {
|
||||
}
|
||||
|
||||
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
export default class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
|
||||
@@ -60,8 +54,8 @@ const childEntityConfiguration = new EntityConfiguration<ChildFields>({
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const childEntityCompanion = new EntityCompanionDefinition({
|
||||
|
||||
+8
-14
@@ -1,5 +1,7 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
Entity,
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
@@ -15,18 +17,10 @@ interface ParentFields {
|
||||
}
|
||||
|
||||
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
export default class ParentEntity extends Entity<ParentFields, string, ViewerContext> {
|
||||
@@ -51,8 +45,8 @@ const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
|
||||
cache: true,
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const parentEntityCompanion = new EntityCompanionDefinition({
|
||||
|
||||
+14
-18
@@ -2,6 +2,8 @@ import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
RedisCacheAdapterContext,
|
||||
@@ -11,7 +13,7 @@ import {
|
||||
PostgresEntityDatabaseAdapterProvider,
|
||||
PostgresEntityQueryContextProvider,
|
||||
} from '@expo/entity-database-adapter-knex';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
export const createFullIntegrationTestEntityCompanionProvider = (
|
||||
knex: Knex,
|
||||
@@ -20,22 +22,16 @@ export const createFullIntegrationTestEntityCompanionProvider = (
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
{
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
|
||||
},
|
||||
},
|
||||
{
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -1,19 +0,0 @@
|
||||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
@@ -1,25 +0,0 @@
|
||||
# `@expo/entity-secondary-cache-redis`
|
||||
|
||||
[ioredis](https://github.com/luin/ioredis) secondary cache for `@expo/entity`.
|
||||
|
||||
[Documentation](https://expo.github.io/entity/modules/_expo_secondary_cache_redis.html)
|
||||
|
||||
## Usage
|
||||
|
||||
1. Create a concrete implementation of abstract class `EntitySecondaryCacheLoader`, in this example `TestEntitySecondaryCacheLoader`. The underlying data can come from anywhere, but an entity is constructed from the data and then authorized for the viewer.
|
||||
2. Create an instance of your `EntitySecondaryCacheLoader`, passing in a `RedisSecondaryEntityCache`.
|
||||
```typescript
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
redisCacheAdapterContext,
|
||||
(loadParams) => `${loadParams.id}`
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
);
|
||||
```
|
||||
3. Load entities through it:
|
||||
```typescript
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
```
|
||||
@@ -1,40 +0,0 @@
|
||||
{
|
||||
"name": "@expo/entity-secondary-cache-redis",
|
||||
"version": "0.16.0",
|
||||
"description": "Redis secondary cache for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
"src"
|
||||
],
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
],
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*",
|
||||
"@expo/entity-cache-adapter-redis": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"ioredis": "^4.17.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.16.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.16.0",
|
||||
"nullthrows": "^1.1.1"
|
||||
}
|
||||
}
|
||||
@@ -1,135 +0,0 @@
|
||||
import {
|
||||
CacheStatus,
|
||||
EntityConfiguration,
|
||||
filterMap,
|
||||
ISecondaryEntityCache,
|
||||
transformCacheObjectToFields,
|
||||
transformFieldsToCacheObject,
|
||||
zipToMap,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
GenericRedisCacheContext,
|
||||
GenericRedisCacher,
|
||||
redisTransformerMap,
|
||||
} from '@expo/entity-cache-adapter-redis';
|
||||
import invariant from 'invariant';
|
||||
|
||||
/**
|
||||
* A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
|
||||
* single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
|
||||
* a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
|
||||
*/
|
||||
export default class RedisSecondaryEntityCache<TFields, TLoadParams>
|
||||
implements ISecondaryEntityCache<TFields, TLoadParams> {
|
||||
private readonly genericRedisCacher: GenericRedisCacher;
|
||||
|
||||
constructor(
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
genericRedisCacheContext: GenericRedisCacheContext,
|
||||
private readonly constructRedisKey: (params: Readonly<TLoadParams>) => string
|
||||
) {
|
||||
this.genericRedisCacher = new GenericRedisCacher(genericRedisCacheContext);
|
||||
}
|
||||
|
||||
/**
|
||||
* Read-through cache function. Steps:
|
||||
*
|
||||
* 1. Check for cached objects
|
||||
* 2. Query the fetcher for loadParams not in the cache
|
||||
* 3. Cache the results from the fetcher
|
||||
* 4. Negatively cache anything missing from the fetcher
|
||||
* 5. Return the full set of data for the query.
|
||||
*
|
||||
* @param loadParamsArray - array of loadParams to load from the cache
|
||||
* @param fetcher - closure used to provide underlying data source objects for loadParams
|
||||
* @returns map from loadParams to the entity field object
|
||||
*/
|
||||
public async loadManyThroughAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[],
|
||||
fetcher: (
|
||||
fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
|
||||
): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>> {
|
||||
const redisKeys = loadParamsArray.map(this.constructRedisKey);
|
||||
const redisKeyToLoadParamsMap = zipToMap(redisKeys, loadParamsArray);
|
||||
|
||||
const cacheLoadResults = await this.genericRedisCacher.loadManyAsync(redisKeys);
|
||||
|
||||
invariant(
|
||||
cacheLoadResults.size === loadParamsArray.length,
|
||||
`${this.constructor.name} loadMany should return a result for each key`
|
||||
);
|
||||
|
||||
const redisKeysToFetch = Array.from(
|
||||
filterMap(
|
||||
cacheLoadResults,
|
||||
(cacheLoadResult) => cacheLoadResult.status === CacheStatus.MISS
|
||||
).keys()
|
||||
);
|
||||
|
||||
// put transformed cache hits in result map
|
||||
const results: Map<Readonly<TLoadParams>, Readonly<TFields> | null> = new Map();
|
||||
cacheLoadResults.forEach((cacheLoadResult, redisKey) => {
|
||||
if (cacheLoadResult.status === CacheStatus.HIT) {
|
||||
const loadParams = redisKeyToLoadParamsMap.get(redisKey);
|
||||
invariant(loadParams !== undefined, 'load params should be in redis key map');
|
||||
results.set(
|
||||
loadParams,
|
||||
transformCacheObjectToFields(
|
||||
this.entityConfiguration,
|
||||
redisTransformerMap,
|
||||
cacheLoadResult.item
|
||||
)
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
// fetch any misses from DB, add DB objects to results, cache DB results, inform cache of any missing DB results
|
||||
if (redisKeysToFetch.length > 0) {
|
||||
const loadParamsToFetch = redisKeysToFetch.map((redisKey) => {
|
||||
const loadParams = redisKeyToLoadParamsMap.get(redisKey);
|
||||
invariant(loadParams !== undefined, 'load params should be in redis key map');
|
||||
return loadParams;
|
||||
});
|
||||
const fetchResults = await fetcher(loadParamsToFetch);
|
||||
|
||||
const fetchMisses = loadParamsToFetch.filter((loadParams) => {
|
||||
// all values of fetchResults should be field objects or undefined
|
||||
return !fetchResults.get(loadParams);
|
||||
});
|
||||
|
||||
for (const fetchMiss of fetchMisses) {
|
||||
results.set(fetchMiss, null);
|
||||
}
|
||||
|
||||
const objectsToCache: Map<string, object> = new Map();
|
||||
for (const [loadParams, object] of fetchResults.entries()) {
|
||||
if (object) {
|
||||
objectsToCache.set(
|
||||
this.constructRedisKey(loadParams),
|
||||
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
|
||||
);
|
||||
results.set(loadParams, object);
|
||||
}
|
||||
}
|
||||
|
||||
await Promise.all([
|
||||
this.genericRedisCacher.cacheManyAsync(objectsToCache),
|
||||
this.genericRedisCacher.cacheDBMissesAsync(fetchMisses.map(this.constructRedisKey)),
|
||||
]);
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate the cache for objects cached by constructRedisKey(loadParams).
|
||||
*
|
||||
* @param loadParamsArray - load params to invalidate
|
||||
*/
|
||||
public async invalidateManyAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
): Promise<void> {
|
||||
await this.genericRedisCacher.invalidateManyAsync(loadParamsArray.map(this.constructRedisKey));
|
||||
}
|
||||
}
|
||||
-135
@@ -1,135 +0,0 @@
|
||||
import { EntitySecondaryCacheLoader, mapMapAsync, ViewerContext } from '@expo/entity';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import nullthrows from 'nullthrows';
|
||||
import { URL } from 'url';
|
||||
|
||||
import RedisSecondaryEntityCache from '../RedisSecondaryEntityCache';
|
||||
import RedisTestEntity, {
|
||||
redisTestEntityConfiguration,
|
||||
RedisTestEntityFields,
|
||||
RedisTestEntityPrivacyPolicy,
|
||||
} from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
type TestLoadParams = { id: string };
|
||||
|
||||
const FAKE_ID = 'fake';
|
||||
|
||||
class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
|
||||
TestLoadParams,
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
RedisTestEntity,
|
||||
RedisTestEntityPrivacyPolicy
|
||||
> {
|
||||
public databaseLoadCount = 0;
|
||||
|
||||
protected async fetchObjectsFromDatabaseAsync(
|
||||
loadParamsArray: readonly Readonly<TestLoadParams>[]
|
||||
): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<RedisTestEntityFields> | null>> {
|
||||
this.databaseLoadCount += loadParamsArray.length;
|
||||
|
||||
const emptyMap = new Map(loadParamsArray.map((p) => [p, null]));
|
||||
return await mapMapAsync(emptyMap, async (_value, loadParams) => {
|
||||
if (loadParams.id === FAKE_ID) {
|
||||
return null;
|
||||
}
|
||||
return (
|
||||
await this.entityLoader
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([{ fieldName: 'id', fieldValue: loadParams.id }])
|
||||
)[0].getAllFields();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
describe(RedisSecondaryEntityCache, () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
|
||||
makeKeyFn(..._parts: string[]): string {
|
||||
throw new Error('should not be used by this test');
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
afterAll(async () => {
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
it('Loads through secondary loader, caches, and invalidates', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const createdEntity = await RedisTestEntity.creator(viewerContext)
|
||||
.setField('name', 'wat')
|
||||
.enforceCreateAsync();
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
redisCacheAdapterContext,
|
||||
(loadParams) => `test-key-${loadParams.id}`
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
);
|
||||
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
||||
|
||||
const results2 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results2.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
||||
|
||||
await secondaryCacheLoader.invalidateManyAsync([loadParams]);
|
||||
|
||||
const results3 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results3.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(2);
|
||||
});
|
||||
|
||||
it('correctly handles uncached and unfetchable load params', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
redisCacheAdapterContext,
|
||||
(loadParams) => `test-key-${loadParams.id}`
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
);
|
||||
|
||||
const loadParams = { id: FAKE_ID };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(results.size).toBe(1);
|
||||
expect(results.get(loadParams)).toBe(null);
|
||||
});
|
||||
});
|
||||
@@ -1,7 +0,0 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-secondary-cache-redis
|
||||
*/
|
||||
|
||||
export { default as RedisSecondaryEntityCache } from './RedisSecondaryEntityCache';
|
||||
@@ -1,88 +0,0 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
ViewerContext,
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
|
||||
export type RedisTestEntityFields = {
|
||||
id: string;
|
||||
name: string;
|
||||
};
|
||||
|
||||
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity,
|
||||
RedisTestEntityPrivacyPolicy
|
||||
> {
|
||||
return redisTestEntityCompanionDefinition;
|
||||
}
|
||||
}
|
||||
|
||||
export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
> {
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'redis_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: RedisTestEntity,
|
||||
entityConfiguration: redisTestEntityConfiguration,
|
||||
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
||||
});
|
||||
-37
@@ -1,37 +0,0 @@
|
||||
import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
RedisCacheAdapterContext,
|
||||
RedisCacheAdapterProvider,
|
||||
} from '@expo/entity-cache-adapter-redis';
|
||||
|
||||
export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
redisCacheAdapterContext: RedisCacheAdapterContext,
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
);
|
||||
};
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -3,107 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add mutation type to validator and trigger execute functions ([#119](https://github.com/expo/entity/issues/119)) ([ef40fa5](https://github.com/expo/entity/commit/ef40fa5e9cdf53e25e78a9423c698e6d1c9737af))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* allow undefined value for all fields ([#114](https://github.com/expo/entity/issues/114)) ([022e0e9](https://github.com/expo/entity/commit/022e0e9b88a5e84e0c1bc6c8810c850beb05f0cf))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better typing on filterMap for use with predicates ([#106](https://github.com/expo/entity/issues/106)) ([01b3bfe](https://github.com/expo/entity/commit/01b3bfef7c6da55e7d89d8cccb52a0050187aee8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add type generic default in test utils ([#104](https://github.com/expo/entity/issues/104)) ([fe2917e](https://github.com/expo/entity/commit/fe2917e6b5af808f166aa354d476e168c41e6d21))
|
||||
* maps utils invariants for collections containing undefined values ([#103](https://github.com/expo/entity/issues/103)) ([29c1a43](https://github.com/expo/entity/commit/29c1a434ab6cd8d30e9f0e7c742065c8d46d8d8a))
|
||||
* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
|
||||
* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity",
|
||||
"version": "0.16.0",
|
||||
"version": "0.10.0",
|
||||
"description": "A privacy-first data model",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -11,7 +11,7 @@
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
|
||||
@@ -11,7 +11,7 @@ import { mapMap } from './utils/collections/maps';
|
||||
*/
|
||||
export default class EnforcingEntityLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
|
||||
@@ -27,7 +27,7 @@ import ViewerContext from './ViewerContext';
|
||||
*/
|
||||
export default abstract class Entity<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields> {
|
||||
@@ -39,7 +39,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static creator<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMViewerContext2 extends TMViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
@@ -80,7 +80,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static updater<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -121,7 +121,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static deleteAsync<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -163,7 +163,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static enforceDeleteAsync<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -216,7 +216,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static async canViewerUpdateAsync<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -265,7 +265,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static async canViewerDeleteAsync<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -309,7 +309,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
export interface IEntityClass<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
|
||||
@@ -8,7 +8,7 @@ import ViewerContext from './ViewerContext';
|
||||
|
||||
export default class EntityAssociationLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields
|
||||
@@ -25,7 +25,7 @@ export default class EntityAssociationLoader<
|
||||
async loadAssociatedEntityAsync<
|
||||
TIdentifyingField extends keyof Pick<TFields, TSelectedFields>,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -87,7 +87,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadManyAssociatedEntitiesAsync<
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -140,7 +140,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadAssociatedEntityByFieldEqualingAsync<
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -197,7 +197,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadManyAssociatedEntitiesByFieldEqualingAsync<
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -253,7 +253,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TID2,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
TFields2,
|
||||
@@ -287,7 +287,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TID2,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
TFields2,
|
||||
@@ -297,7 +297,7 @@ export default class EntityAssociationLoader<
|
||||
TSelectedFields2
|
||||
>,
|
||||
TFields3,
|
||||
TID3 extends NonNullable<TFields3[TSelectedFields3]>,
|
||||
TID3,
|
||||
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
|
||||
TPrivacyPolicy3 extends EntityPrivacyPolicy<
|
||||
TFields3,
|
||||
@@ -342,7 +342,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TID2,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
TFields2,
|
||||
@@ -352,7 +352,7 @@ export default class EntityAssociationLoader<
|
||||
TSelectedFields2
|
||||
>,
|
||||
TFields3,
|
||||
TID3 extends NonNullable<TFields3[TSelectedFields3]>,
|
||||
TID3,
|
||||
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
|
||||
TPrivacyPolicy3 extends EntityPrivacyPolicy<
|
||||
TFields3,
|
||||
@@ -362,7 +362,7 @@ export default class EntityAssociationLoader<
|
||||
TSelectedFields3
|
||||
>,
|
||||
TFields4,
|
||||
TID4 extends NonNullable<TFields4[TSelectedFields4]>,
|
||||
TID4,
|
||||
TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext, TSelectedFields4>,
|
||||
TPrivacyPolicy4 extends EntityPrivacyPolicy<
|
||||
TFields4,
|
||||
@@ -478,7 +478,7 @@ export interface EntityLoadThroughDirective<
|
||||
TViewerContext extends ViewerContext,
|
||||
TFields,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
|
||||
@@ -19,7 +19,7 @@ export interface IPrivacyPolicyClass<TPrivacyPolicy> {
|
||||
*/
|
||||
export default class EntityCompanion<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -84,7 +84,7 @@ export default class EntityCompanion<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>(
|
||||
tableDataCoordinator.entityConfiguration,
|
||||
tableDataCoordinator.entityConfiguration.idField as keyof Pick<TFields, TSelectedFields>,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
tableDataCoordinator.dataManager
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
import invariant from 'invariant';
|
||||
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityCompanion, { IPrivacyPolicyClass } from './EntityCompanion';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
@@ -18,14 +16,25 @@ import { computeIfAbsent } from './utils/collections/maps';
|
||||
/**
|
||||
* Backing database and transaction type for an entity. The definitions and implementations
|
||||
* are provided by injection in the root EntityCompanionProvider to allow for mocking and sharing.
|
||||
*
|
||||
* Note: this enum will likely be modified soon to be more flexible.
|
||||
*/
|
||||
export type DatabaseAdapterFlavor = string;
|
||||
export enum DatabaseAdapterFlavor {
|
||||
/**
|
||||
* Knex postgres adapter, using postgres table and postgres transactions.
|
||||
*/
|
||||
POSTGRES = 'postgres',
|
||||
}
|
||||
|
||||
/**
|
||||
* Cache system for an entity. The definitions and implementations are provided by injection
|
||||
* in the root EntityCompanionProvider to allow for mocking and sharing.
|
||||
*
|
||||
* Note: this enum will likely be modified soon to be more flexible.
|
||||
*/
|
||||
export type CacheAdapterFlavor = string;
|
||||
export enum CacheAdapterFlavor {
|
||||
REDIS = 'redis',
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines a set interfaces for a entity database adapter flavor. An entity that uses a flavor
|
||||
@@ -51,7 +60,7 @@ export interface CacheAdapterFlavorDefinition {
|
||||
*/
|
||||
export class EntityCompanionDefinition<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -73,14 +82,14 @@ export class EntityCompanionDefinition<
|
||||
>;
|
||||
readonly entityConfiguration: EntityConfiguration<TFields>;
|
||||
readonly privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
|
||||
readonly mutationValidators: () => EntityMutationValidator<
|
||||
readonly mutationValidators: EntityMutationValidator<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>[];
|
||||
readonly mutationTriggers: () => EntityMutationTriggerConfiguration<
|
||||
readonly mutationTriggers: EntityMutationTriggerConfiguration<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
@@ -93,13 +102,10 @@ export class EntityCompanionDefinition<
|
||||
entityClass,
|
||||
entityConfiguration,
|
||||
privacyPolicyClass,
|
||||
mutationValidators = () => [],
|
||||
mutationTriggers = () => ({}),
|
||||
mutationValidators = [],
|
||||
mutationTriggers = {},
|
||||
entitySelectedFields = Array.from(entityConfiguration.schema.keys()) as TSelectedFields[],
|
||||
}: {
|
||||
/**
|
||||
* The concrete Entity class for which this is the definition.
|
||||
*/
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -108,39 +114,22 @@ export class EntityCompanionDefinition<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>;
|
||||
/**
|
||||
* The {@link EntityConfiguration} for this entity.
|
||||
*/
|
||||
entityConfiguration: EntityConfiguration<TFields>;
|
||||
/**
|
||||
* The {@link EntityPrivacyPolicy} class for this entity.
|
||||
*/
|
||||
privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
|
||||
/**
|
||||
* An optional list of {@link EntityMutationValidator} for this entity.
|
||||
*/
|
||||
mutationValidators?: () => EntityMutationValidator<
|
||||
mutationValidators?: EntityMutationValidator<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>[];
|
||||
/**
|
||||
* An optional list of {@link EntityMutationTrigger} for this entity.
|
||||
*/
|
||||
mutationTriggers?: () => EntityMutationTriggerConfiguration<
|
||||
mutationTriggers?: EntityMutationTriggerConfiguration<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>;
|
||||
/**
|
||||
* An optional subset of fields defined in the {@link EntityConfiguration} which belong to this entity.
|
||||
* For use when multiple types of entities are backed by a single table ({@link EntityConfiguration}) yet
|
||||
* only expose a subset of the fields.
|
||||
*/
|
||||
entitySelectedFields?: TSelectedFields[];
|
||||
}) {
|
||||
this.entityClass = entityClass;
|
||||
@@ -179,11 +168,8 @@ export default class EntityCompanionProvider {
|
||||
*/
|
||||
constructor(
|
||||
private metricsAdapter: IEntityMetricsAdapter,
|
||||
private databaseAdapterFlavors: ReadonlyMap<
|
||||
DatabaseAdapterFlavor,
|
||||
DatabaseAdapterFlavorDefinition
|
||||
>,
|
||||
private cacheAdapterFlavors: ReadonlyMap<CacheAdapterFlavor, CacheAdapterFlavorDefinition>
|
||||
private databaseAdapterFlavors: Record<DatabaseAdapterFlavor, DatabaseAdapterFlavorDefinition>,
|
||||
private cacheAdapterFlavors: Record<CacheAdapterFlavor, CacheAdapterFlavorDefinition>
|
||||
) {}
|
||||
|
||||
/**
|
||||
@@ -195,7 +181,7 @@ export default class EntityCompanionProvider {
|
||||
*/
|
||||
getCompanionForEntity<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -233,46 +219,24 @@ export default class EntityCompanionProvider {
|
||||
entityCompanionDefinition.entityClass,
|
||||
tableDataCoordinator,
|
||||
entityCompanionDefinition.privacyPolicyClass,
|
||||
entityCompanionDefinition.mutationValidators(),
|
||||
entityCompanionDefinition.mutationTriggers(),
|
||||
entityCompanionDefinition.mutationValidators,
|
||||
entityCompanionDefinition.mutationTriggers,
|
||||
this.metricsAdapter
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
getQueryContextProviderForDatabaseAdaptorFlavor(
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor
|
||||
): EntityQueryContextProvider {
|
||||
const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors.get(databaseAdapterFlavor);
|
||||
invariant(
|
||||
entityDatabaseAdapterFlavor,
|
||||
`No database adaptor configuration found for flavor: ${databaseAdapterFlavor}`
|
||||
);
|
||||
|
||||
return entityDatabaseAdapterFlavor.queryContextProvider;
|
||||
}
|
||||
|
||||
private getTableDataCoordinatorForEntity<TFields>(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityClassName: string
|
||||
): EntityTableDataCoordinator<TFields> {
|
||||
return computeIfAbsent(this.tableDataCoordinatorMap, entityConfiguration.tableName, () => {
|
||||
const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors.get(
|
||||
const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors[
|
||||
entityConfiguration.databaseAdapterFlavor
|
||||
);
|
||||
invariant(
|
||||
entityDatabaseAdapterFlavor,
|
||||
`No database adaptor configuration found for flavor: ${entityConfiguration.databaseAdapterFlavor}`
|
||||
);
|
||||
|
||||
const entityCacheAdapterFlavor = this.cacheAdapterFlavors.get(
|
||||
];
|
||||
const entityCacheAdapterFlavor = this.cacheAdapterFlavors[
|
||||
entityConfiguration.cacheAdapterFlavor
|
||||
);
|
||||
invariant(
|
||||
entityCacheAdapterFlavor,
|
||||
`No cache adaptor configuration found for flavor: ${entityConfiguration.cacheAdapterFlavor}`
|
||||
);
|
||||
|
||||
];
|
||||
return new EntityTableDataCoordinator(
|
||||
entityConfiguration,
|
||||
entityDatabaseAdapterFlavor.adapterProvider,
|
||||
|
||||
@@ -14,7 +14,7 @@ export default class EntityConfiguration<TFields> {
|
||||
readonly cacheKeyVersion: number;
|
||||
|
||||
readonly getInboundEdges: () => IEntityClass<any, any, any, any, any, any>[];
|
||||
readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>;
|
||||
readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>;
|
||||
readonly entityToDBFieldsKeyMapping: ReadonlyMap<keyof TFields, string>;
|
||||
readonly dbToEntityFieldsKeyMapping: ReadonlyMap<string, keyof TFields>;
|
||||
|
||||
@@ -30,40 +30,12 @@ export default class EntityConfiguration<TFields> {
|
||||
databaseAdapterFlavor,
|
||||
cacheAdapterFlavor,
|
||||
}: {
|
||||
/**
|
||||
* The field used to identify this entity. Must be a unique field in the table.
|
||||
*/
|
||||
idField: keyof TFields;
|
||||
|
||||
/**
|
||||
* The name of the table where entities of this type are stored.
|
||||
*/
|
||||
tableName: string;
|
||||
|
||||
/**
|
||||
* Map from each entity field to an {@link EntityFieldDefinition} specifying information about the field.
|
||||
*/
|
||||
schema: Record<keyof TFields, EntityFieldDefinition<any>>;
|
||||
|
||||
/**
|
||||
* List of other entity types that reference this type in {@link EntityFieldDefinition} associations.
|
||||
*/
|
||||
schema: Record<keyof TFields, EntityFieldDefinition>;
|
||||
getInboundEdges?: () => IEntityClass<any, any, any, any, any, any>[];
|
||||
|
||||
/**
|
||||
* Cache key version for this entity type. Should be bumped when a field is added to, removed from, or changed
|
||||
* in this entity and the underlying database table.
|
||||
*/
|
||||
cacheKeyVersion?: number;
|
||||
|
||||
/**
|
||||
* Backing database and transaction type for this entity.
|
||||
*/
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor;
|
||||
|
||||
/**
|
||||
* Cache system for this entity.
|
||||
*/
|
||||
cacheAdapterFlavor: CacheAdapterFlavor;
|
||||
}) {
|
||||
this.idField = idField;
|
||||
@@ -87,7 +59,7 @@ export default class EntityConfiguration<TFields> {
|
||||
}
|
||||
|
||||
private static computeCacheableKeys<TFields>(
|
||||
schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>
|
||||
schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>
|
||||
): ReadonlySet<keyof TFields> {
|
||||
return reduceMap(
|
||||
schema,
|
||||
@@ -102,7 +74,7 @@ export default class EntityConfiguration<TFields> {
|
||||
}
|
||||
|
||||
private static computeEntityToDBFieldsKeyMapping<TFields>(
|
||||
schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>
|
||||
schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>
|
||||
): ReadonlyMap<keyof TFields, string> {
|
||||
return mapMap(schema, (v) => v.columnName);
|
||||
}
|
||||
|
||||
@@ -14,17 +14,14 @@ interface SingleValueFieldEqualityCondition<TFields, N extends keyof TFields = k
|
||||
|
||||
interface MultiValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
|
||||
fieldName: N;
|
||||
fieldValues: readonly TFields[N][];
|
||||
fieldValues: TFields[N][];
|
||||
}
|
||||
|
||||
export type FieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> =
|
||||
| SingleValueFieldEqualityCondition<TFields, N>
|
||||
| MultiValueFieldEqualityCondition<TFields, N>;
|
||||
|
||||
export function isSingleValueFieldEqualityCondition<
|
||||
TFields,
|
||||
N extends keyof TFields = keyof TFields
|
||||
>(
|
||||
function isSingleValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields>(
|
||||
condition: FieldEqualityCondition<TFields, N>
|
||||
): condition is SingleValueFieldEqualityCondition<TFields, N> {
|
||||
return (condition as SingleValueFieldEqualityCondition<TFields, N>).fieldValue !== undefined;
|
||||
@@ -37,7 +34,7 @@ export interface TableFieldSingleValueEqualityCondition {
|
||||
|
||||
export interface TableFieldMultiValueEqualityCondition {
|
||||
tableField: string;
|
||||
tableValues: readonly any[];
|
||||
tableValues: any[];
|
||||
}
|
||||
|
||||
export enum OrderByOrdering {
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
import ES6Error from 'es6-error';
|
||||
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityPrivacyPolicy, { EntityAuthorizationAction } from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
export abstract class EntityError extends ES6Error {}
|
||||
|
||||
export class EntityNotFoundError<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
N extends keyof TFields,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> extends EntityError {
|
||||
constructor(
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
fieldName: N,
|
||||
fieldValue: TFields[N]
|
||||
) {
|
||||
super(`Entity not found: ${entityClass.name} (${fieldName} = ${fieldValue})`);
|
||||
}
|
||||
}
|
||||
|
||||
export class EntityNotAuthorizedError<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> extends EntityError {
|
||||
public readonly entityClassName: string;
|
||||
|
||||
constructor(
|
||||
entity: TEntity,
|
||||
viewerContext: TViewerContext,
|
||||
action: EntityAuthorizationAction,
|
||||
ruleIndex: number
|
||||
) {
|
||||
super(
|
||||
`Entity not authorized: ${entity} (viewer = ${viewerContext}, action = ${EntityAuthorizationAction[action]}, ruleIndex = ${ruleIndex})`
|
||||
);
|
||||
this.entityClassName = entity.constructor.name;
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,3 @@
|
||||
import { validate as validateUUID } from 'uuid';
|
||||
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
@@ -33,7 +31,7 @@ export enum EntityEdgeDeletionBehavior {
|
||||
export interface EntityAssociationDefinition<
|
||||
TViewerContext extends ViewerContext,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -85,7 +83,7 @@ export interface EntityAssociationDefinition<
|
||||
edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
|
||||
}
|
||||
|
||||
export abstract class EntityFieldDefinition<T> {
|
||||
export abstract class EntityFieldDefinition {
|
||||
readonly columnName: string;
|
||||
readonly cache: boolean;
|
||||
readonly association?: EntityAssociationDefinition<any, any, any, any, any, any>;
|
||||
@@ -109,69 +107,15 @@ export abstract class EntityFieldDefinition<T> {
|
||||
this.cache = cache;
|
||||
this.association = association;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates input value for a field of this type. Null and undefined are considered valid by default. This is used for things like:
|
||||
* - EntityLoader.loadByFieldValue - to ensure the value being loaded by is a valid value
|
||||
* - EntityMutator.setField - to ensure the value being set is a valid value
|
||||
*/
|
||||
public validateInputValue(value: T | null | undefined): boolean {
|
||||
if (value === null || value === undefined) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return this.validateInputValueInternal(value);
|
||||
}
|
||||
protected abstract validateInputValueInternal(value: T): boolean;
|
||||
}
|
||||
|
||||
export class StringField extends EntityFieldDefinition<string> {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return typeof value === 'string';
|
||||
}
|
||||
}
|
||||
export class UUIDField extends StringField {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return validateUUID(value);
|
||||
}
|
||||
}
|
||||
export class DateField extends EntityFieldDefinition<Date> {
|
||||
protected validateInputValueInternal(value: Date): boolean {
|
||||
return value instanceof Date;
|
||||
}
|
||||
}
|
||||
export class BooleanField extends EntityFieldDefinition<boolean> {
|
||||
protected validateInputValueInternal(value: boolean): boolean {
|
||||
return typeof value === 'boolean';
|
||||
}
|
||||
}
|
||||
export class NumberField extends EntityFieldDefinition<number> {
|
||||
protected validateInputValueInternal(value: number): boolean {
|
||||
return typeof value === 'number';
|
||||
}
|
||||
}
|
||||
export class StringArrayField extends EntityFieldDefinition<string[]> {
|
||||
protected validateInputValueInternal(value: string[]): boolean {
|
||||
return Array.isArray(value) && value.every((subValue) => typeof subValue === 'string');
|
||||
}
|
||||
}
|
||||
export class JSONObjectField extends EntityFieldDefinition<object> {
|
||||
protected validateInputValueInternal(value: object): boolean {
|
||||
return typeof value === 'object' && !Array.isArray(value);
|
||||
}
|
||||
}
|
||||
export class EnumField extends EntityFieldDefinition<string | number> {
|
||||
protected validateInputValueInternal(value: string | number): boolean {
|
||||
return typeof value === 'number' || typeof value === 'string';
|
||||
}
|
||||
}
|
||||
export class JSONArrayField extends EntityFieldDefinition<any[]> {
|
||||
protected validateInputValueInternal(value: any[]): boolean {
|
||||
return Array.isArray(value);
|
||||
}
|
||||
}
|
||||
export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
|
||||
protected validateInputValueInternal(_value: any): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
export class StringField extends EntityFieldDefinition {}
|
||||
export class UUIDField extends StringField {}
|
||||
export class DateField extends EntityFieldDefinition {}
|
||||
export class BooleanField extends EntityFieldDefinition {}
|
||||
export class NumberField extends EntityFieldDefinition {}
|
||||
export class StringArrayField extends EntityFieldDefinition {}
|
||||
export class JSONObjectField extends EntityFieldDefinition {}
|
||||
export class EnumField extends EntityFieldDefinition {}
|
||||
export class JSONArrayField extends EntityFieldDefinition {}
|
||||
export class MaybeJSONArrayField extends EntityFieldDefinition {}
|
||||
@@ -3,18 +3,12 @@ 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 { EntityNotFoundError } from './EntityErrors';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
|
||||
import EntityNotFoundError from './errors/EntityNotFoundError';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
|
||||
@@ -24,7 +18,7 @@ import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
*/
|
||||
export default class EntityLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -39,7 +33,7 @@ export default class EntityLoader<
|
||||
constructor(
|
||||
private readonly viewerContext: TViewerContext,
|
||||
private readonly queryContext: EntityQueryContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly idField: keyof Pick<TFields, TSelectedFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -79,15 +73,34 @@ export default class EntityLoader<
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
|
||||
this.validateFieldValues(fieldName, fieldValues);
|
||||
|
||||
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
|
||||
this.queryContext,
|
||||
fieldName,
|
||||
fieldValues
|
||||
);
|
||||
const fieldValuesToUncheckedEntityResults = mapMap(fieldValuesToFieldObjects, (fieldObjects) =>
|
||||
this.tryConstructEntities(fieldObjects)
|
||||
);
|
||||
|
||||
return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects);
|
||||
return await mapMapAsync(
|
||||
fieldValuesToUncheckedEntityResults,
|
||||
async (uncheckedEntityResults) => {
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
uncheckedEntityResult.value
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -137,9 +150,7 @@ export default class EntityLoader<
|
||||
const entityResults = await this.loadManyByIDsAsync([id]);
|
||||
const entityResult = entityResults.get(id);
|
||||
if (entityResult === undefined) {
|
||||
return result(
|
||||
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
|
||||
);
|
||||
return result(new EntityNotFoundError(this.entityClass, this.idField, id as any));
|
||||
}
|
||||
return entityResult;
|
||||
}
|
||||
@@ -150,10 +161,7 @@ export default class EntityLoader<
|
||||
* @returns entity result for matching ID, or null if no entity exists for ID.
|
||||
*/
|
||||
async loadByIDNullableAsync(id: TID): Promise<Result<TEntity> | null> {
|
||||
return await this.loadByFieldEqualingAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
id
|
||||
);
|
||||
return await this.loadByFieldEqualingAsync(this.idField, id as any);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -163,15 +171,14 @@ export default class EntityLoader<
|
||||
* @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
*/
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
|
||||
const entityResults = (await this.loadManyByFieldEqualingManyAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
ids
|
||||
)) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
|
||||
const entityResults = ((await this.loadManyByFieldEqualingManyAsync(
|
||||
this.idField,
|
||||
ids as any
|
||||
)) as any) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
|
||||
return mapMap(entityResults, (entityResultsForId, id) => {
|
||||
const entityResult = entityResultsForId[0];
|
||||
return (
|
||||
entityResult ??
|
||||
result(new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id))
|
||||
entityResult ?? result(new EntityNotFoundError(this.entityClass, this.idField, id as any))
|
||||
);
|
||||
});
|
||||
}
|
||||
@@ -194,13 +201,6 @@ export default class EntityLoader<
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
for (const fieldEqualityOperand of fieldEqualityOperands) {
|
||||
const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
|
||||
? [fieldEqualityOperand.fieldValue]
|
||||
: fieldEqualityOperand.fieldValues;
|
||||
this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
|
||||
}
|
||||
|
||||
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
|
||||
this.queryContext,
|
||||
fieldEqualityOperands,
|
||||
@@ -284,6 +284,13 @@ export default class EntityLoader<
|
||||
await this.dataManager.invalidateObjectFieldsAsync(objectFields);
|
||||
}
|
||||
|
||||
async invalidateFieldsTransactionalAsync(objectFields: Readonly<TFields>): Promise<void> {
|
||||
await this.dataManager.invalidateObjectFieldsTransactionalAsync(
|
||||
this.queryContext,
|
||||
objectFields
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate all caches for an entity. One potential use case would be to keep the entity
|
||||
* framework in sync with changes made to data outside of the framework.
|
||||
@@ -293,6 +300,11 @@ export default class EntityLoader<
|
||||
await this.invalidateFieldsAsync(entity.getAllDatabaseFields());
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrap entity construction in try/catch and return Results. Used to prevent constructor errors
|
||||
* thrown for one entity instantiation from interfering with other entity instantiatons of the same query.
|
||||
* @param fieldsObjects - array of entity data objects to construct entities
|
||||
*/
|
||||
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
|
||||
return fieldsObjects.map((fieldsObject) => {
|
||||
try {
|
||||
@@ -302,48 +314,4 @@ export default class EntityLoader<
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct and authorize entities from fields map, returning error results for entities that fail
|
||||
* to construct or fail to authorize.
|
||||
*
|
||||
* @param map - map from an arbitrary key type to an array of entity field objects
|
||||
*/
|
||||
public async constructAndAuthorizeEntitiesAsync<K>(
|
||||
map: ReadonlyMap<K, readonly Readonly<TFields>[]>
|
||||
): Promise<ReadonlyMap<K, readonly Result<TEntity>[]>> {
|
||||
const uncheckedEntityResultsMap = mapMap(map, (fieldObjects) =>
|
||||
this.tryConstructEntities(fieldObjects)
|
||||
);
|
||||
return await mapMapAsync(uncheckedEntityResultsMap, async (uncheckedEntityResults) => {
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
uncheckedEntityResult.value
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
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,5 +1,4 @@
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
@@ -12,7 +11,7 @@ import EntityDataManager from './internal/EntityDataManager';
|
||||
*/
|
||||
export default class EntityLoaderFactory<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -25,7 +24,7 @@ export default class EntityLoaderFactory<
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
constructor(
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly idField: keyof Pick<TFields, TSelectedFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -50,7 +49,7 @@ export default class EntityLoaderFactory<
|
||||
return new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
this.entityConfiguration,
|
||||
this.idField,
|
||||
this.entityClass,
|
||||
this.privacyPolicyClass,
|
||||
this.dataManager
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
import { EntityMutationInfo } from './EntityMutator';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -8,7 +7,7 @@ import ViewerContext from './ViewerContext';
|
||||
*/
|
||||
export default interface EntityMutationTriggerConfiguration<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
@@ -71,16 +70,15 @@ export default interface EntityMutationTriggerConfiguration<
|
||||
*/
|
||||
export abstract class EntityMutationTrigger<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
abstract executeAsync(
|
||||
abstract async executeAsync(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
entity: TEntity
|
||||
): Promise<void>;
|
||||
}
|
||||
|
||||
@@ -90,14 +88,10 @@ export abstract class EntityMutationTrigger<
|
||||
*/
|
||||
export abstract class EntityNonTransactionalMutationTrigger<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
abstract executeAsync(
|
||||
viewerContext: TViewerContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
): Promise<void>;
|
||||
abstract async executeAsync(viewerContext: TViewerContext, entity: TEntity): Promise<void>;
|
||||
}
|
||||
@@ -1,23 +1,21 @@
|
||||
import { EntityMutationInfo } from './EntityMutator';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
/**
|
||||
/*
|
||||
* A validator is a way to specify entity mutation validation that runs within the
|
||||
* same transaction as the mutation itself before creating or updating an entity.
|
||||
*/
|
||||
export default abstract class EntityMutationValidator<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
abstract executeAsync(
|
||||
abstract async executeAsync(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
entity: TEntity
|
||||
): Promise<void>;
|
||||
}
|
||||
@@ -1,5 +1,4 @@
|
||||
import { Result, asyncResult, result, enforceAsyncResult } from '@expo/results';
|
||||
import invariant from 'invariant';
|
||||
|
||||
import Entity, { IEntityClass } from './Entity';
|
||||
import { EntityCompanionDefinition } from './EntityCompanionProvider';
|
||||
@@ -16,38 +15,13 @@ import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
|
||||
import { timeAndLogMutationEventAsync } from './metrics/EntityMetricsUtils';
|
||||
import IEntityMetricsAdapter, { EntityMetricsMutationType } from './metrics/IEntityMetricsAdapter';
|
||||
import { mapMapAsync } from './utils/collections/maps';
|
||||
|
||||
export enum EntityMutationType {
|
||||
CREATE,
|
||||
UPDATE,
|
||||
DELETE,
|
||||
}
|
||||
|
||||
export type EntityMutationInfo<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> =
|
||||
| {
|
||||
type: EntityMutationType.CREATE;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.DELETE;
|
||||
};
|
||||
|
||||
abstract class BaseMutator<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -98,33 +72,20 @@ abstract class BaseMutator<
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {}
|
||||
|
||||
protected validateFields(fields: Partial<TFields>): void {
|
||||
for (const fieldName in fields) {
|
||||
const fieldValue = fields[fieldName];
|
||||
const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
|
||||
invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
|
||||
const isInputValid = fieldDefinition.validateInputValue(fieldValue);
|
||||
if (!isInputValid) {
|
||||
throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
protected async executeMutationTriggersOrValidatorsAsync(
|
||||
triggersOrValidators:
|
||||
| EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
|
||||
| EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
|
||||
| undefined,
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
entity: TEntity
|
||||
): Promise<void> {
|
||||
if (!triggersOrValidators) {
|
||||
return;
|
||||
}
|
||||
await Promise.all(
|
||||
triggersOrValidators.map((triggerOrValidator) =>
|
||||
triggerOrValidator.executeAsync(this.viewerContext, queryContext, entity, mutationInfo)
|
||||
triggerOrValidator.executeAsync(this.viewerContext, queryContext, entity)
|
||||
)
|
||||
);
|
||||
}
|
||||
@@ -139,15 +100,12 @@ abstract class BaseMutator<
|
||||
TSelectedFields
|
||||
>[]
|
||||
| undefined,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
entity: TEntity
|
||||
): Promise<void> {
|
||||
if (!triggers) {
|
||||
return;
|
||||
}
|
||||
await Promise.all(
|
||||
triggers.map((trigger) => trigger.executeAsync(this.viewerContext, entity, mutationInfo))
|
||||
);
|
||||
await Promise.all(triggers.map((trigger) => trigger.executeAsync(this.viewerContext, entity)));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -156,7 +114,7 @@ abstract class BaseMutator<
|
||||
*/
|
||||
export class CreateMutator<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -209,8 +167,6 @@ export class CreateMutator<
|
||||
private async createInternalAsync(
|
||||
queryContext: EntityTransactionalQueryContext
|
||||
): Promise<Result<TEntity>> {
|
||||
this.validateFields(this.fieldsForEntity);
|
||||
|
||||
const temporaryEntityForPrivacyCheck = new this.entityClass(this.viewerContext, ({
|
||||
[this.entityConfiguration.idField]: '00000000-0000-0000-0000-000000000000', // zero UUID
|
||||
...this.fieldsForEntity,
|
||||
@@ -230,20 +186,17 @@ export class CreateMutator<
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationValidators,
|
||||
queryContext,
|
||||
temporaryEntityForPrivacyCheck,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
temporaryEntityForPrivacyCheck
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.beforeAll,
|
||||
queryContext,
|
||||
temporaryEntityForPrivacyCheck,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
temporaryEntityForPrivacyCheck
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.beforeCreate,
|
||||
queryContext,
|
||||
temporaryEntityForPrivacyCheck,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
temporaryEntityForPrivacyCheck
|
||||
);
|
||||
|
||||
const insertResult = await this.databaseAdapter.insertAsync(queryContext, this.fieldsForEntity);
|
||||
@@ -252,6 +205,7 @@ export class CreateMutator<
|
||||
queryContext.appendPostCommitCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult)
|
||||
);
|
||||
await entityLoader.invalidateFieldsTransactionalAsync(insertResult);
|
||||
|
||||
const unauthorizedEntityAfterInsert = new this.entityClass(this.viewerContext, insertResult);
|
||||
const newEntity = await entityLoader
|
||||
@@ -261,22 +215,19 @@ export class CreateMutator<
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.afterCreate,
|
||||
queryContext,
|
||||
newEntity,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
newEntity
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.afterAll,
|
||||
queryContext,
|
||||
newEntity,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
newEntity
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
|
||||
this,
|
||||
this.mutationTriggers.afterCommit,
|
||||
newEntity,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
newEntity
|
||||
)
|
||||
);
|
||||
|
||||
@@ -289,7 +240,7 @@ export class CreateMutator<
|
||||
*/
|
||||
export class UpdateMutator<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -301,7 +252,7 @@ export class UpdateMutator<
|
||||
>,
|
||||
TSelectedFields extends keyof TFields
|
||||
> extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
private readonly originalEntity: TEntity;
|
||||
private readonly originalFieldsForEntity: Readonly<TFields>;
|
||||
private readonly fieldsForEntity: TFields;
|
||||
private readonly updatedFields: Partial<TFields> = {};
|
||||
|
||||
@@ -342,7 +293,7 @@ export class UpdateMutator<
|
||||
>,
|
||||
databaseAdapter: EntityDatabaseAdapter<TFields>,
|
||||
metricsAdapter: IEntityMetricsAdapter,
|
||||
originalEntity: TEntity
|
||||
fieldsForEntity: Readonly<TFields>
|
||||
) {
|
||||
super(
|
||||
viewerContext,
|
||||
@@ -356,8 +307,8 @@ export class UpdateMutator<
|
||||
databaseAdapter,
|
||||
metricsAdapter
|
||||
);
|
||||
this.originalEntity = originalEntity;
|
||||
this.fieldsForEntity = { ...originalEntity.getAllDatabaseFields() };
|
||||
this.originalFieldsForEntity = { ...fieldsForEntity };
|
||||
this.fieldsForEntity = { ...fieldsForEntity };
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -401,8 +352,6 @@ export class UpdateMutator<
|
||||
private async updateInternalAsync(
|
||||
queryContext: EntityTransactionalQueryContext
|
||||
): Promise<Result<TEntity>> {
|
||||
this.validateFields(this.updatedFields);
|
||||
|
||||
const entityAboutToBeUpdated = new this.entityClass(this.viewerContext, this.fieldsForEntity);
|
||||
const authorizeUpdateResult = await asyncResult(
|
||||
this.privacyPolicy.authorizeUpdateAsync(
|
||||
@@ -418,20 +367,17 @@ export class UpdateMutator<
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationValidators,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
entityAboutToBeUpdated
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.beforeAll,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
entityAboutToBeUpdated
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.beforeUpdate,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
entityAboutToBeUpdated
|
||||
);
|
||||
|
||||
const updateResult = await this.databaseAdapter.updateAsync(
|
||||
@@ -444,15 +390,17 @@ export class UpdateMutator<
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(
|
||||
entityLoader,
|
||||
this.originalEntity.getAllDatabaseFields()
|
||||
)
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.originalFieldsForEntity)
|
||||
);
|
||||
queryContext.appendPostCommitCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.fieldsForEntity)
|
||||
);
|
||||
|
||||
await Promise.all([
|
||||
entityLoader.invalidateFieldsTransactionalAsync(this.originalFieldsForEntity),
|
||||
entityLoader.invalidateFieldsTransactionalAsync(this.fieldsForEntity),
|
||||
]);
|
||||
|
||||
const unauthorizedEntityAfterUpdate = new this.entityClass(this.viewerContext, updateResult);
|
||||
const updatedEntity = await entityLoader
|
||||
.enforcing()
|
||||
@@ -461,22 +409,19 @@ export class UpdateMutator<
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.afterUpdate,
|
||||
queryContext,
|
||||
updatedEntity,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
updatedEntity
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.afterAll,
|
||||
queryContext,
|
||||
updatedEntity,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
updatedEntity
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
|
||||
this,
|
||||
this.mutationTriggers.afterCommit,
|
||||
updatedEntity,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
updatedEntity
|
||||
)
|
||||
);
|
||||
|
||||
@@ -489,7 +434,7 @@ export class UpdateMutator<
|
||||
*/
|
||||
export class DeleteMutator<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -598,7 +543,7 @@ export class DeleteMutator<
|
||||
return authorizeDeleteResult;
|
||||
}
|
||||
|
||||
await this.processEntityDeletionForInboundEdgesAsync(
|
||||
await DeleteMutator.processEntityDeletionForInboundEdgesAsync(
|
||||
this.entity,
|
||||
queryContext,
|
||||
processedEntityIdentifiersFromTransitiveDeletions
|
||||
@@ -607,14 +552,12 @@ export class DeleteMutator<
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.beforeAll,
|
||||
queryContext,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
this.entity
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.beforeDelete,
|
||||
queryContext,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
this.entity
|
||||
);
|
||||
|
||||
if (!skipDatabaseDeletion) {
|
||||
@@ -629,26 +572,24 @@ export class DeleteMutator<
|
||||
queryContext.appendPostCommitCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.entity.getAllDatabaseFields())
|
||||
);
|
||||
await entityLoader.invalidateFieldsTransactionalAsync(this.entity.getAllDatabaseFields());
|
||||
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.afterDelete,
|
||||
queryContext,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
this.entity
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
this.mutationTriggers.afterAll,
|
||||
queryContext,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
this.entity
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
|
||||
this,
|
||||
this.mutationTriggers.afterCommit,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
this.entity
|
||||
)
|
||||
);
|
||||
|
||||
@@ -669,8 +610,14 @@ export class DeleteMutator<
|
||||
*
|
||||
* @param entity - entity to find all references to
|
||||
*/
|
||||
private async processEntityDeletionForInboundEdgesAsync(
|
||||
entity: TEntity,
|
||||
private static async processEntityDeletionForInboundEdgesAsync<
|
||||
TMFields,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMSelectedFields extends keyof TMFields
|
||||
>(
|
||||
entity: TMEntity,
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
processedEntityIdentifiers: Set<string>
|
||||
): Promise<void> {
|
||||
@@ -681,12 +628,12 @@ export class DeleteMutator<
|
||||
processedEntityIdentifiers.add(entity.getUniqueIdentifier());
|
||||
|
||||
const companionDefinition = (entity.constructor as any).getCompanionDefinition() as EntityCompanionDefinition<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
TMFields,
|
||||
TMID,
|
||||
TMViewerContext,
|
||||
TMEntity,
|
||||
EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity, TMSelectedFields>,
|
||||
TMSelectedFields
|
||||
>;
|
||||
const entityConfiguration = companionDefinition.entityConfiguration;
|
||||
const inboundEdges = entityConfiguration.getInboundEdges();
|
||||
|
||||
@@ -15,7 +15,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
*/
|
||||
export default class EntityMutatorFactory<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -109,7 +109,7 @@ export default class EntityMutatorFactory<
|
||||
this.entityLoaderFactory,
|
||||
this.databaseAdapter,
|
||||
this.metricsAdapter,
|
||||
existingEntity
|
||||
existingEntity.getAllDatabaseFields()
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { EntityNotAuthorizedError } from './EntityErrors';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityNotAuthorizedError from './errors/EntityNotAuthorizedError';
|
||||
import PrivacyPolicyRule, { RuleEvaluationResult } from './rules/PrivacyPolicyRule';
|
||||
|
||||
export enum EntityPrivacyPolicyEvaluationMode {
|
||||
@@ -12,7 +12,7 @@ export enum EntityPrivacyPolicyEvaluationMode {
|
||||
|
||||
export type EntityPrivacyPolicyEvaluator<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
@@ -63,7 +63,7 @@ export enum EntityAuthorizationAction {
|
||||
*/
|
||||
export default abstract class EntityPrivacyPolicy<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
@@ -265,13 +265,7 @@ export default abstract class EntityPrivacyPolicy<
|
||||
const ruleEvaluationResult = await rule.evaluateAsync(viewerContext, queryContext, entity);
|
||||
switch (ruleEvaluationResult) {
|
||||
case RuleEvaluationResult.DENY:
|
||||
throw new EntityNotAuthorizedError<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>(entity, viewerContext, action, i);
|
||||
throw new EntityNotAuthorizedError(entity, viewerContext, action, i);
|
||||
case RuleEvaluationResult.SKIP:
|
||||
continue;
|
||||
case RuleEvaluationResult.ALLOW:
|
||||
@@ -281,11 +275,6 @@ export default abstract class EntityPrivacyPolicy<
|
||||
}
|
||||
}
|
||||
|
||||
throw new EntityNotAuthorizedError<TFields, TID, TViewerContext, TEntity, TSelectedFields>(
|
||||
entity,
|
||||
viewerContext,
|
||||
action,
|
||||
-1
|
||||
);
|
||||
throw new EntityNotAuthorizedError(entity, viewerContext, action, -1);
|
||||
}
|
||||
}
|
||||
@@ -1,3 +1,5 @@
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import EntityQueryContextProvider from './EntityQueryContextProvider';
|
||||
|
||||
export type PostCommitCallback = (...args: any) => Promise<any>;
|
||||
@@ -12,13 +14,13 @@ export type PostCommitCallback = (...args: any) => Promise<any>;
|
||||
export abstract class EntityQueryContext {
|
||||
constructor(private readonly queryInterface: any) {}
|
||||
|
||||
abstract isInTransaction(): boolean;
|
||||
abstract isInTransaction(): this is EntityTransactionalQueryContext;
|
||||
|
||||
getQueryInterface(): any {
|
||||
return this.queryInterface;
|
||||
}
|
||||
|
||||
abstract runInTransactionIfNotInTransactionAsync<T>(
|
||||
abstract async runInTransactionIfNotInTransactionAsync<T>(
|
||||
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
|
||||
): Promise<T>;
|
||||
}
|
||||
@@ -31,7 +33,7 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
|
||||
super(queryInterface);
|
||||
}
|
||||
|
||||
isInTransaction(): boolean {
|
||||
isInTransaction(): this is EntityTransactionalQueryContext {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -43,6 +45,8 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
|
||||
}
|
||||
|
||||
export class EntityTransactionalQueryContext extends EntityQueryContext {
|
||||
public readonly transactionID = uuidv4();
|
||||
|
||||
private readonly postCommitCallbacks: PostCommitCallback[] = [];
|
||||
|
||||
public appendPostCommitCallback(callback: PostCommitCallback): void {
|
||||
@@ -55,7 +59,7 @@ export class EntityTransactionalQueryContext extends EntityQueryContext {
|
||||
await Promise.all(callbacks.map((callback) => callback()));
|
||||
}
|
||||
|
||||
isInTransaction(): boolean {
|
||||
isInTransaction(): this is EntityTransactionalQueryContext {
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,112 +0,0 @@
|
||||
import { Result } from '@expo/results';
|
||||
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import { mapMap } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* An interface that knows how to load many objects from a cache by load params and invalidate
|
||||
* those same load params.
|
||||
*/
|
||||
export interface ISecondaryEntityCache<TFields, TLoadParams> {
|
||||
/**
|
||||
* Read-through cache function.
|
||||
* @param loadParamsArray - array of loadParams to load from the cache
|
||||
* @param fetcher - closure used to provide underlying data source objects for loadParams
|
||||
* @returns map from loadParams to the entity field object
|
||||
*/
|
||||
loadManyThroughAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[],
|
||||
fetcher: (
|
||||
fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
|
||||
): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>;
|
||||
|
||||
/**
|
||||
* Invalidate the cache for objects cached by loadParams.
|
||||
*
|
||||
* @param loadParamsArray - array of load params objects to invalidate
|
||||
*/
|
||||
invalidateManyAsync(loadParamsArray: readonly Readonly<TLoadParams>[]): Promise<void>;
|
||||
}
|
||||
|
||||
/**
|
||||
* A secondary cache loader allows for arbitrary cache keying for load params, which are a set of params used to load
|
||||
* a single entity field object.
|
||||
*
|
||||
* Note that this cache cannot be automatically invalidated like other entity caches so it must be manually invalidated
|
||||
* when the underlying data of a cache key could be stale.
|
||||
*
|
||||
* This is most commonly used to further optimize hot paths that cannot make use of normal entity cache loading
|
||||
* due to use of a non-unique-field-based {@link EntityLoader} method like `loadManyByFieldEqualityConjunctionAsync` or
|
||||
* `loadManyByRawWhereClauseAsync`.
|
||||
*/
|
||||
export default abstract class EntitySecondaryCacheLoader<
|
||||
TLoadParams,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
constructor(
|
||||
private readonly secondaryEntityCache: ISecondaryEntityCache<TFields, TLoadParams>,
|
||||
protected readonly entityLoader: EntityLoader<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Load many by load params objects
|
||||
*
|
||||
* @param loadParamsArray - array of loadParams to load through the cache
|
||||
*/
|
||||
public async loadManyAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
): Promise<ReadonlyMap<Readonly<TLoadParams>, Result<TEntity> | null>> {
|
||||
const loadParamsToFieldObjects = await this.secondaryEntityCache.loadManyThroughAsync(
|
||||
loadParamsArray,
|
||||
this.fetchObjectsFromDatabaseAsync.bind(this)
|
||||
);
|
||||
|
||||
// convert value to and from array to reuse complex code
|
||||
const entitiesMap = await this.entityLoader.constructAndAuthorizeEntitiesAsync(
|
||||
mapMap(loadParamsToFieldObjects, (fieldObject) => (fieldObject ? [fieldObject] : []))
|
||||
);
|
||||
return mapMap(entitiesMap, (fieldObjects) => fieldObjects[0] ?? null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate the cache for objects cached by loadParams.
|
||||
*
|
||||
* @param loadParamsArray - array of load params objects to invalidate
|
||||
*/
|
||||
public async invalidateManyAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
): Promise<void> {
|
||||
await this.secondaryEntityCache.invalidateManyAsync(loadParamsArray);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load through method called to fetch objects when load params objects are not in the cache
|
||||
*
|
||||
* @param loadParamsArray - array of load params objects to load
|
||||
*/
|
||||
protected abstract fetchObjectsFromDatabaseAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
): Promise<ReadonlyMap<Readonly<Readonly<TLoadParams>>, Readonly<TFields> | null>>;
|
||||
}
|
||||
@@ -5,7 +5,7 @@ import EntityAssociationLoader from './EntityAssociationLoader';
|
||||
import { EntityCompanionDefinition } from './EntityCompanionProvider';
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import { pick } from './entityUtils';
|
||||
|
||||
@@ -19,7 +19,7 @@ import { pick } from './entityUtils';
|
||||
*/
|
||||
export default abstract class ReadonlyEntity<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
@@ -118,6 +118,80 @@ export default abstract class ReadonlyEntity<
|
||||
return { ...this.databaseFields };
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the regular (non-transactional) query context for this entity.
|
||||
* @param viewerContext - viewer context of calling user
|
||||
*/
|
||||
static getQueryContext<
|
||||
TMFields,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMViewerContext2 extends TMViewerContext,
|
||||
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TMFields,
|
||||
TMID,
|
||||
TMViewerContext,
|
||||
TMEntity,
|
||||
TMSelectedFields
|
||||
>,
|
||||
TMSelectedFields extends keyof TMFields = keyof TMFields
|
||||
>(
|
||||
this: IEntityClass<
|
||||
TMFields,
|
||||
TMID,
|
||||
TMViewerContext,
|
||||
TMEntity,
|
||||
TMPrivacyPolicy,
|
||||
TMSelectedFields
|
||||
>,
|
||||
viewerContext: TMViewerContext2
|
||||
): EntityQueryContext {
|
||||
return viewerContext
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getQueryContextProvider()
|
||||
.getQueryContext();
|
||||
}
|
||||
|
||||
/**
|
||||
* Start a transaction and execute the provided transaction-scoped closure within the transaction.
|
||||
* @param viewerContext - viewer context of calling user
|
||||
* @param transactionScope - async callback to execute within the transaction
|
||||
*/
|
||||
static async runInTransactionAsync<
|
||||
TResult,
|
||||
TMFields,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMViewerContext2 extends TMViewerContext,
|
||||
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TMFields,
|
||||
TMID,
|
||||
TMViewerContext,
|
||||
TMEntity,
|
||||
TMSelectedFields
|
||||
>,
|
||||
TMSelectedFields extends keyof TMFields = keyof TMFields
|
||||
>(
|
||||
this: IEntityClass<
|
||||
TMFields,
|
||||
TMID,
|
||||
TMViewerContext,
|
||||
TMEntity,
|
||||
TMPrivacyPolicy,
|
||||
TMSelectedFields
|
||||
>,
|
||||
viewerContext: TMViewerContext2,
|
||||
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
|
||||
): Promise<TResult> {
|
||||
return await viewerContext
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getQueryContextProvider()
|
||||
.getQueryContext()
|
||||
.runInTransactionIfNotInTransactionAsync(transactionScope);
|
||||
}
|
||||
|
||||
/**
|
||||
* Vend loader for loading an entity in a given query context.
|
||||
* @param viewerContext - viewer context of loading user
|
||||
@@ -125,7 +199,7 @@ export default abstract class ReadonlyEntity<
|
||||
*/
|
||||
static loader<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMViewerContext2 extends TMViewerContext,
|
||||
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityCompanionProvider, { DatabaseAdapterFlavor } from './EntityCompanionProvider';
|
||||
import EntityCompanionProvider from './EntityCompanionProvider';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerScopedEntityCompanion from './ViewerScopedEntityCompanion';
|
||||
import ViewerScopedEntityCompanionProvider from './ViewerScopedEntityCompanionProvider';
|
||||
@@ -28,7 +27,7 @@ export default class ViewerContext {
|
||||
|
||||
getViewerScopedEntityCompanionForClass<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -61,32 +60,4 @@ export default class ViewerContext {
|
||||
entityClass.getCompanionDefinition()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the regular (non-transactional) query context for a database adaptor flavor.
|
||||
* @param databaseAdaptorFlavor - database adaptor flavor
|
||||
*/
|
||||
getQueryContextForDatabaseAdaptorFlavor(
|
||||
databaseAdaptorFlavor: DatabaseAdapterFlavor
|
||||
): EntityQueryContext {
|
||||
return this.entityCompanionProvider
|
||||
.getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
|
||||
.getQueryContext();
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a transaction of specified database adaptor flavor and execute the provided
|
||||
* transaction-scoped closure within the transaction.
|
||||
* @param databaseAdaptorFlavor - databaseAdaptorFlavor
|
||||
* @param transactionScope - async callback to execute within the transaction
|
||||
*/
|
||||
async runInTransactionForDatabaseAdaptorFlavorAsync<TResult>(
|
||||
databaseAdaptorFlavor: DatabaseAdapterFlavor,
|
||||
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
|
||||
): Promise<TResult> {
|
||||
return await this.entityCompanionProvider
|
||||
.getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
|
||||
.getQueryContext()
|
||||
.runInTransactionIfNotInTransactionAsync(transactionScope);
|
||||
}
|
||||
}
|
||||
@@ -12,7 +12,7 @@ import ViewerScopedEntityMutatorFactory from './ViewerScopedEntityMutatorFactory
|
||||
*/
|
||||
export default class ViewerScopedEntityCompanion<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
|
||||
@@ -23,7 +23,7 @@ export default class ViewerScopedEntityCompanionProvider {
|
||||
*/
|
||||
getViewerScopedCompanionForEntity<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
|
||||
@@ -10,7 +10,7 @@ import ViewerContext from './ViewerContext';
|
||||
*/
|
||||
export default class ViewerScopedEntityLoaderFactory<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
|
||||
@@ -10,7 +10,7 @@ import ViewerContext from './ViewerContext';
|
||||
*/
|
||||
export default class ViewerScopedEntityMutatorFactory<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
|
||||
@@ -287,9 +287,8 @@ describe(EnforcingEntityLoader, () => {
|
||||
'enforcing',
|
||||
'invalidateFieldsAsync',
|
||||
'invalidateEntityAsync',
|
||||
'invalidateFieldsTransactionalAsync',
|
||||
'tryConstructEntities',
|
||||
'validateFieldValues',
|
||||
'constructAndAuthorizeEntitiesAsync',
|
||||
];
|
||||
expect(loaderProperties).toEqual(expect.arrayContaining(knownLoaderOnlyDifferences));
|
||||
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
import Entity from '../Entity';
|
||||
import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import {
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
} from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { UUIDField } from '../EntityFields';
|
||||
import { CreateMutator, UpdateMutator } from '../EntityMutator';
|
||||
@@ -92,8 +96,8 @@ const testEntityConfiguration = new EntityConfiguration<TestEntityFields>({
|
||||
columnName: 'custom_id',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -102,38 +106,10 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ViewerContext,
|
||||
SimpleTestDenyUpdateEntity
|
||||
> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
TestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestDenyUpdateEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
TestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestDenyUpdateEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysDenyPrivacyPolicyRule<
|
||||
TestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestDenyUpdateEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
TestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestDenyUpdateEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysDenyPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -142,38 +118,10 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ViewerContext,
|
||||
SimpleTestDenyDeleteEntity
|
||||
> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
TestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestDenyDeleteEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
TestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestDenyDeleteEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
TestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestDenyDeleteEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysDenyPrivacyPolicyRule<
|
||||
TestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestDenyDeleteEntity
|
||||
>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysDenyPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, ViewerContext> {
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { enforceAsyncResult } from '@expo/results';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import EntityAssociationLoader from '../EntityAssociationLoader';
|
||||
import { enforceResultsAsync } from '../entityUtils';
|
||||
@@ -75,7 +74,7 @@ describe(EntityAssociationLoader, () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new TestViewerContext(companionProvider);
|
||||
const testEntity = await enforceAsyncResult(
|
||||
TestEntity.creator(viewerContext).setField('stringField', uuidv4()).createAsync()
|
||||
TestEntity.creator(viewerContext).setField('stringField', 'blah').createAsync()
|
||||
);
|
||||
const loadedOtherResult = await testEntity
|
||||
.associationLoader()
|
||||
@@ -197,7 +196,7 @@ describe(EntityAssociationLoader, () => {
|
||||
const viewerContext = new TestViewerContext(companionProvider);
|
||||
|
||||
const testEntity = await enforceAsyncResult(
|
||||
TestEntity2.creator(viewerContext).setField('foreignKey', uuidv4()).createAsync()
|
||||
TestEntity2.creator(viewerContext).setField('foreignKey', 'fake').createAsync()
|
||||
);
|
||||
|
||||
const loadResult = await testEntity.associationLoader().loadAssociatedEntityThroughAsync([
|
||||
@@ -213,12 +212,11 @@ describe(EntityAssociationLoader, () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new TestViewerContext(companionProvider);
|
||||
|
||||
const fieldValue = uuidv4();
|
||||
const testEntity2 = await enforceAsyncResult(
|
||||
TestEntity.creator(viewerContext).setField('stringField', fieldValue).createAsync()
|
||||
TestEntity.creator(viewerContext).setField('stringField', 'blah').createAsync()
|
||||
);
|
||||
const testEntity = await enforceAsyncResult(
|
||||
TestEntity2.creator(viewerContext).setField('foreignKey', fieldValue).createAsync()
|
||||
TestEntity2.creator(viewerContext).setField('foreignKey', 'blah').createAsync()
|
||||
);
|
||||
|
||||
const loaded2Result = await testEntity.associationLoader().loadAssociatedEntityThroughAsync([
|
||||
@@ -236,7 +234,7 @@ describe(EntityAssociationLoader, () => {
|
||||
const viewerContext = new TestViewerContext(companionProvider);
|
||||
|
||||
const testEntity = await enforceAsyncResult(
|
||||
TestEntity2.creator(viewerContext).setField('foreignKey', uuidv4()).createAsync()
|
||||
TestEntity2.creator(viewerContext).setField('foreignKey', 'blah').createAsync()
|
||||
);
|
||||
|
||||
const loaded2Result = await testEntity.associationLoader().loadAssociatedEntityThroughAsync([
|
||||
|
||||
@@ -1,15 +1,18 @@
|
||||
import { enforceAsyncResult } from '@expo/results';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import Entity from '../Entity';
|
||||
import EntityCompanionProvider, { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import EntityCompanionProvider, {
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
} from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { EntityNotAuthorizedError } from '../EntityErrors';
|
||||
import { UUIDField } from '../EntityFields';
|
||||
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import { enforceResultsAsync } from '../entityUtils';
|
||||
import EntityNotAuthorizedError from '../errors/EntityNotAuthorizedError';
|
||||
import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
|
||||
import AlwaysDenyPrivacyPolicyRule from '../rules/AlwaysDenyPrivacyPolicyRule';
|
||||
import PrivacyPolicyRule, { RuleEvaluationResult } from '../rules/PrivacyPolicyRule';
|
||||
@@ -97,8 +100,8 @@ const blahCompanion = new EntityCompanionDefinition({
|
||||
columnName: 'owner_id',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
}),
|
||||
privacyPolicyClass: BlahEntityPrivacyPolicy,
|
||||
});
|
||||
@@ -107,8 +110,8 @@ it('runs through a common workflow', async () => {
|
||||
// will be one entity companion provider for each request, so
|
||||
// share amongst all VCs created in that request
|
||||
const entityCompanionProvider = createUnitTestEntityCompanionProvider();
|
||||
const vc1 = new TestUserViewerContext(entityCompanionProvider, uuidv4());
|
||||
const vc2 = new TestUserViewerContext(entityCompanionProvider, uuidv4());
|
||||
const vc1 = new TestUserViewerContext(entityCompanionProvider, '1');
|
||||
const vc2 = new TestUserViewerContext(entityCompanionProvider, '2');
|
||||
|
||||
const blahOwner1 = await enforceAsyncResult(
|
||||
BlahEntity.creator(vc1).setField('ownerID', vc1.getUserID()!).createAsync()
|
||||
|
||||
@@ -8,12 +8,11 @@ import IEntityMetricsAdapter from '../metrics/IEntityMetricsAdapter';
|
||||
import TestEntity, {
|
||||
TestEntityPrivacyPolicy,
|
||||
testEntityConfiguration,
|
||||
TestFields,
|
||||
} from '../testfixtures/TestEntity';
|
||||
|
||||
describe(EntityCompanion, () => {
|
||||
it('correctly instantiates mutator and loader factories', () => {
|
||||
const tableDataCoordinatorMock = mock<EntityTableDataCoordinator<TestFields>>();
|
||||
const tableDataCoordinatorMock = mock(EntityTableDataCoordinator);
|
||||
when(tableDataCoordinatorMock.entityConfiguration).thenReturn(testEntityConfiguration);
|
||||
|
||||
const companion = new EntityCompanion(
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
import Entity from '../Entity';
|
||||
import EntityCompanionProvider, { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import EntityCompanionProvider, {
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
} from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { StringField } from '../EntityFields';
|
||||
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
|
||||
@@ -18,8 +22,8 @@ const blahConfiguration = new EntityConfiguration<BlahFields>({
|
||||
columnName: 'hello',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
class Blah1Entity extends Entity<BlahFields, string, ViewerContext> {
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { DatabaseAdapterFlavor, CacheAdapterFlavor } from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { UUIDField, StringField } from '../EntityFields';
|
||||
|
||||
@@ -27,15 +28,15 @@ describe(EntityConfiguration, () => {
|
||||
columnName: 'unique_but_not_cacheable',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
it('returns correct fields', () => {
|
||||
expect(blahEntityConfiguration.idField).toEqual('id');
|
||||
expect(blahEntityConfiguration.tableName).toEqual('blah_table');
|
||||
expect(blahEntityConfiguration.databaseAdapterFlavor).toEqual('postgres');
|
||||
expect(blahEntityConfiguration.cacheAdapterFlavor).toEqual('redis');
|
||||
expect(blahEntityConfiguration.databaseAdapterFlavor).toEqual(DatabaseAdapterFlavor.POSTGRES);
|
||||
expect(blahEntityConfiguration.cacheAdapterFlavor).toEqual(CacheAdapterFlavor.REDIS);
|
||||
});
|
||||
|
||||
it('filters cacheable fields', () => {
|
||||
@@ -52,8 +53,8 @@ describe(EntityConfiguration, () => {
|
||||
columnName: 'id',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
expect(entityConfiguration.cacheKeyVersion).toEqual(0);
|
||||
});
|
||||
@@ -67,8 +68,8 @@ describe(EntityConfiguration, () => {
|
||||
columnName: 'id',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
cacheKeyVersion: 100,
|
||||
});
|
||||
expect(entityConfiguration.cacheKeyVersion).toEqual(100);
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
import Entity from '../Entity';
|
||||
import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import {
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
} from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { UUIDField, EntityEdgeDeletionBehavior } from '../EntityFields';
|
||||
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
|
||||
@@ -30,18 +34,10 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
any,
|
||||
any
|
||||
> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
||||
@@ -92,8 +88,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
cache: true,
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const childEntityConfiguration = new EntityConfiguration<ChildFields>({
|
||||
@@ -114,8 +110,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const grandChildEntityConfiguration = new EntityConfiguration<GrandChildFields>({
|
||||
@@ -135,8 +131,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const parentEntityCompanion = new EntityCompanionDefinition({
|
||||
|
||||
@@ -1,24 +1,6 @@
|
||||
import { v1 as uuidv1, v3 as uuidv3, v4 as uuidv4, v5 as uuidv5 } from 'uuid';
|
||||
import { EntityFieldDefinition } from '../EntityFields';
|
||||
|
||||
import {
|
||||
EntityFieldDefinition,
|
||||
StringField,
|
||||
UUIDField,
|
||||
DateField,
|
||||
BooleanField,
|
||||
NumberField,
|
||||
StringArrayField,
|
||||
JSONObjectField,
|
||||
EnumField,
|
||||
JSONArrayField,
|
||||
MaybeJSONArrayField,
|
||||
} from '../EntityFields';
|
||||
|
||||
class TestFieldDefinition extends EntityFieldDefinition<string> {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return value === 'helloworld';
|
||||
}
|
||||
}
|
||||
class TestFieldDefinition extends EntityFieldDefinition {}
|
||||
|
||||
describe(EntityFieldDefinition, () => {
|
||||
it('returns correct column name and defaults cache to false', () => {
|
||||
@@ -30,71 +12,4 @@ describe(EntityFieldDefinition, () => {
|
||||
expect(fieldDefinition2.columnName).toEqual('wat');
|
||||
expect(fieldDefinition2.cache).toEqual(true);
|
||||
});
|
||||
|
||||
test('validator returns true when value is null', () => {
|
||||
const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
|
||||
expect(fieldDefinition.validateInputValue(null)).toBe(true);
|
||||
});
|
||||
|
||||
test('validator returns true when value is undefined', () => {
|
||||
const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
|
||||
expect(fieldDefinition.validateInputValue(undefined)).toBe(true);
|
||||
});
|
||||
|
||||
test('validator returns false when value is invalid', () => {
|
||||
const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
|
||||
expect(fieldDefinition.validateInputValue('nothelloworld')).toBe(false);
|
||||
});
|
||||
|
||||
test('validator returns true when value is valid', () => {
|
||||
const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
|
||||
expect(fieldDefinition.validateInputValue('helloworld')).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
const describeFieldTestCase = <T>(
|
||||
fieldDefinition: EntityFieldDefinition<T>,
|
||||
validValues: T[],
|
||||
invalidValues: any[]
|
||||
): void => {
|
||||
describe(fieldDefinition.constructor.name, () => {
|
||||
if (validValues.length > 0) {
|
||||
test.each(validValues)(`${fieldDefinition.constructor.name}.valid %p`, (value) => {
|
||||
expect(fieldDefinition.validateInputValue(value)).toBe(true);
|
||||
});
|
||||
}
|
||||
|
||||
if (invalidValues.length > 0) {
|
||||
test.each(invalidValues)(`${fieldDefinition.constructor.name}.invalid %p`, (value) => {
|
||||
expect(fieldDefinition.validateInputValue(value)).toBe(false);
|
||||
});
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
describeFieldTestCase(new StringField({ columnName: 'wat' }), ['hello', ''], [1, true, {}, [[]]]);
|
||||
describeFieldTestCase(
|
||||
new UUIDField({ columnName: 'wat' }),
|
||||
[uuidv1(), uuidv3('wat', uuidv3.DNS), uuidv4(), uuidv5('wat', uuidv5.DNS)],
|
||||
[uuidv4().replace('-', ''), '', 'hello']
|
||||
);
|
||||
describeFieldTestCase(new DateField({ columnName: 'wat' }), [new Date()], [Date.now()]);
|
||||
describeFieldTestCase(new BooleanField({ columnName: 'wat' }), [true, false], [0, 1, '']);
|
||||
describeFieldTestCase(new NumberField({ columnName: 'wat' }), [1, 0.5, -0.5], ['1']);
|
||||
describeFieldTestCase(
|
||||
new StringArrayField({ columnName: 'wat' }),
|
||||
[[['what']] as any, [[]] as any], // jest test cases need extra wrapping array
|
||||
['hello']
|
||||
);
|
||||
describeFieldTestCase(new JSONObjectField({ columnName: 'wat' }), [{}], [true, 'hello']);
|
||||
describeFieldTestCase(new EnumField({ columnName: 'wat' }), ['hello', 1], [true]);
|
||||
describeFieldTestCase(
|
||||
new JSONArrayField({ columnName: 'wat' }),
|
||||
[[[1, 2]] as any, [['hello']] as any], // jest test cases need extra wrapping array
|
||||
[1, 'hello']
|
||||
);
|
||||
describeFieldTestCase(
|
||||
new MaybeJSONArrayField({ columnName: 'wat' }),
|
||||
[1, 'hello', [['hello']]], // jest test cases need extra wrapping array
|
||||
[]
|
||||
);
|
||||
@@ -1,6 +1,5 @@
|
||||
import { enforceAsyncResult } from '@expo/results';
|
||||
import { mock, instance, verify, spy, deepEqual, anyOfClass, anything, when } from 'ts-mockito';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import EntityLoader from '../EntityLoader';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
@@ -23,8 +22,6 @@ describe(EntityLoader, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
|
||||
testEntityConfiguration,
|
||||
StubDatabaseAdapter.convertFieldObjectsToDataStore(
|
||||
@@ -34,7 +31,7 @@ describe(EntityLoader, () => {
|
||||
testEntityConfiguration.tableName,
|
||||
[
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
testIndexedField: 'h1',
|
||||
numberField: 5,
|
||||
stringField: 'huh',
|
||||
@@ -42,7 +39,7 @@ describe(EntityLoader, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
testIndexedField: 'h2',
|
||||
numberField: 3,
|
||||
stringField: 'huh',
|
||||
@@ -68,43 +65,33 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
);
|
||||
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
|
||||
expect(entity.getID()).toEqual(id1);
|
||||
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync('hello'));
|
||||
expect(entity.getID()).toEqual('hello');
|
||||
expect(entity.getField('dateField')).toEqual(dateToInsert);
|
||||
|
||||
const entities = await enforceResultsAsync(
|
||||
entityLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
);
|
||||
expect(entities.map((m) => m.getID())).toEqual([id1, id2]);
|
||||
expect(entities.map((m) => m.getID())).toEqual(['hello', 'world']);
|
||||
|
||||
const entityResultNumber3 = await entityLoader.loadByFieldEqualingAsync('numberField', 3);
|
||||
expect(entityResultNumber3).not.toBeNull();
|
||||
expect(entityResultNumber3!.enforceValue().getID()).toEqual(id2);
|
||||
expect(entityResultNumber3!.enforceValue().getID()).toEqual('world');
|
||||
|
||||
const entityResultNumber4 = await entityLoader.loadByFieldEqualingAsync('numberField', 4);
|
||||
expect(entityResultNumber4).toBeNull();
|
||||
|
||||
const entityResultDuplicateValues = await entityLoader
|
||||
.enforcing()
|
||||
.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(
|
||||
'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.loadByIDAsync('not-a-uuid')).rejects.toThrowError(
|
||||
'Entity field not valid: TestEntity (customIdField = not-a-uuid)'
|
||||
);
|
||||
await expect(entityLoader.loadByIDNullableAsync('fake')).resolves.toBeNull();
|
||||
await expect(entityLoader.loadByIDNullableAsync('hello')).resolves.not.toBeNull();
|
||||
});
|
||||
|
||||
it('loads entities with loadManyByFieldEqualityConjunction', async () => {
|
||||
@@ -113,9 +100,6 @@ describe(EntityLoader, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const id3 = uuidv4();
|
||||
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
|
||||
testEntityConfiguration,
|
||||
StubDatabaseAdapter.convertFieldObjectsToDataStore(
|
||||
@@ -125,7 +109,7 @@ describe(EntityLoader, () => {
|
||||
testEntityConfiguration.tableName,
|
||||
[
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
numberField: 4,
|
||||
testIndexedField: '4',
|
||||
@@ -133,7 +117,7 @@ describe(EntityLoader, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
numberField: 4,
|
||||
testIndexedField: '5',
|
||||
@@ -141,7 +125,7 @@ describe(EntityLoader, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id3,
|
||||
customIdField: 'blah',
|
||||
stringField: 'huh2',
|
||||
numberField: 4,
|
||||
testIndexedField: '6',
|
||||
@@ -166,7 +150,7 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
@@ -187,12 +171,6 @@ describe(EntityLoader, () => {
|
||||
verify(
|
||||
spiedPrivacyPolicy.authorizeReadAsync(viewerContext, queryContext, anyOfClass(TestEntity))
|
||||
).twice();
|
||||
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'customIdField', fieldValue: 'not-a-uuid' },
|
||||
])
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (customIdField = not-a-uuid)');
|
||||
});
|
||||
|
||||
it('authorizes loaded entities', async () => {
|
||||
@@ -202,7 +180,6 @@ describe(EntityLoader, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
|
||||
testEntityConfiguration,
|
||||
StubDatabaseAdapter.convertFieldObjectsToDataStore(
|
||||
@@ -212,7 +189,7 @@ describe(EntityLoader, () => {
|
||||
testEntityConfiguration.tableName,
|
||||
[
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '1',
|
||||
numberField: 3,
|
||||
@@ -237,12 +214,12 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
);
|
||||
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
|
||||
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync('hello'));
|
||||
verify(spiedPrivacyPolicy.authorizeReadAsync(viewerContext, queryContext, entity)).once();
|
||||
});
|
||||
|
||||
@@ -250,22 +227,21 @@ describe(EntityLoader, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
const dataManagerMock = mock(EntityDataManager);
|
||||
const dataManagerInstance = instance(dataManagerMock);
|
||||
|
||||
const id1 = uuidv4();
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
);
|
||||
await entityLoader.invalidateFieldsAsync({ customIdField: id1 } as any);
|
||||
await entityLoader.invalidateFieldsAsync({ customIdField: 'hello' } as any);
|
||||
|
||||
verify(
|
||||
dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: id1 } as any))
|
||||
dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: 'hello' }))
|
||||
).once();
|
||||
});
|
||||
|
||||
@@ -273,21 +249,20 @@ describe(EntityLoader, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
const dataManagerMock = mock(EntityDataManager);
|
||||
const dataManagerInstance = instance(dataManagerMock);
|
||||
|
||||
const id1 = uuidv4();
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
);
|
||||
await entityLoader.invalidateFieldsAsync({ customIdField: id1 } as any);
|
||||
await entityLoader.invalidateFieldsAsync({ customIdField: 'hello' } as any);
|
||||
verify(
|
||||
dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: id1 } as any))
|
||||
dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: 'hello' }))
|
||||
).once();
|
||||
});
|
||||
|
||||
@@ -295,25 +270,24 @@ describe(EntityLoader, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
const dataManagerMock = mock(EntityDataManager);
|
||||
const dataManagerInstance = instance(dataManagerMock);
|
||||
|
||||
const id1 = uuidv4();
|
||||
const entityMock = mock(TestEntity);
|
||||
when(entityMock.getAllDatabaseFields()).thenReturn({ customIdField: id1 } as any);
|
||||
when(entityMock.getAllDatabaseFields()).thenReturn({ customIdField: 'hello' } as any);
|
||||
const entityInstance = instance(entityMock);
|
||||
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
);
|
||||
await entityLoader.invalidateEntityAsync(entityInstance);
|
||||
verify(
|
||||
dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: id1 } as any))
|
||||
dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: 'hello' }))
|
||||
).once();
|
||||
});
|
||||
|
||||
@@ -321,12 +295,11 @@ describe(EntityLoader, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicyMock = mock(TestEntityPrivacyPolicy);
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
const dataManagerMock = mock(EntityDataManager);
|
||||
|
||||
const id1 = uuidv4();
|
||||
when(
|
||||
dataManagerMock.loadManyByFieldEqualingAsync(anything(), anything(), anything())
|
||||
).thenResolve(new Map().set(id1, [{ customIdField: id1 }]));
|
||||
).thenResolve(new Map().set('hello', [{ customIdField: 'hello' }]));
|
||||
|
||||
const rejectionError = new Error();
|
||||
|
||||
@@ -340,13 +313,13 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
);
|
||||
|
||||
const entityResult = await entityLoader.loadByIDAsync(id1);
|
||||
const entityResult = await entityLoader.loadByIDAsync('hello');
|
||||
expect(entityResult.ok).toBe(false);
|
||||
expect(entityResult.reason).toEqual(rejectionError);
|
||||
expect(entityResult.value).toBe(undefined);
|
||||
@@ -356,7 +329,7 @@ describe(EntityLoader, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
const dataManagerMock = mock(EntityDataManager);
|
||||
|
||||
const error = new Error();
|
||||
|
||||
@@ -369,29 +342,27 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
);
|
||||
|
||||
const loadByValue = uuidv4();
|
||||
|
||||
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.loadByIDAsync('hello')).rejects.toEqual(error);
|
||||
await expect(entityLoader.enforcing().loadByIDAsync('hello')).rejects.toEqual(error);
|
||||
await expect(entityLoader.loadManyByIDsAsync(['hello'])).rejects.toEqual(error);
|
||||
await expect(entityLoader.loadManyByIDsAsync(['hello'])).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue)
|
||||
entityLoader.loadManyByFieldEqualingAsync('customIdField', 'hello')
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.enforcing().loadManyByFieldEqualingAsync('customIdField', loadByValue)
|
||||
entityLoader.enforcing().loadManyByFieldEqualingAsync('customIdField', 'hello')
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
|
||||
entityLoader.loadManyByFieldEqualingManyAsync('customIdField', ['hello'])
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.enforcing().loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
|
||||
entityLoader.enforcing().loadManyByFieldEqualingManyAsync('customIdField', ['hello'])
|
||||
).rejects.toEqual(error);
|
||||
});
|
||||
});
|
||||
@@ -8,9 +8,7 @@ import {
|
||||
when,
|
||||
anything,
|
||||
objectContaining,
|
||||
deepEqual,
|
||||
} from 'ts-mockito';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import EntityDatabaseAdapter from '../EntityDatabaseAdapter';
|
||||
import EntityLoaderFactory from '../EntityLoaderFactory';
|
||||
@@ -19,7 +17,6 @@ import EntityMutationTriggerConfiguration, {
|
||||
EntityNonTransactionalMutationTrigger,
|
||||
} from '../EntityMutationTriggerConfiguration';
|
||||
import EntityMutationValidator from '../EntityMutationValidator';
|
||||
import { EntityMutationInfo, EntityMutationType } from '../EntityMutator';
|
||||
import EntityMutatorFactory from '../EntityMutatorFactory';
|
||||
import { EntityTransactionalQueryContext, EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
@@ -52,14 +49,7 @@ class TestMutationTrigger extends EntityMutationTrigger<
|
||||
async executeAsync(
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
_entity: TestEntity,
|
||||
_mutationInfo: EntityMutationInfo<
|
||||
TestFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
TestEntity,
|
||||
keyof TestFields
|
||||
>
|
||||
_entity: TestEntity
|
||||
): Promise<void> {}
|
||||
}
|
||||
|
||||
@@ -94,16 +84,14 @@ const verifyValidatorCounts = (
|
||||
TestEntity,
|
||||
keyof TestFields
|
||||
>[],
|
||||
expectedCalls: number,
|
||||
mutationInfo: EntityMutationInfo<TestFields, string, ViewerContext, TestEntity, keyof TestFields>
|
||||
expectedCalls: number
|
||||
): void => {
|
||||
for (const validator of mutationValidatorSpies) {
|
||||
verify(
|
||||
validator.executeAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(TestEntity),
|
||||
deepEqual(mutationInfo)
|
||||
anyOfClass(TestEntity)
|
||||
)
|
||||
).times(expectedCalls);
|
||||
}
|
||||
@@ -163,8 +151,7 @@ const verifyTriggerCounts = (
|
||||
| 'afterDelete'
|
||||
>,
|
||||
boolean
|
||||
>,
|
||||
mutationInfo: EntityMutationInfo<TestFields, string, ViewerContext, TestEntity, keyof TestFields>
|
||||
>
|
||||
): void => {
|
||||
Object.keys(executed).forEach((s) => {
|
||||
if ((executed as any)[s]) {
|
||||
@@ -172,8 +159,7 @@ const verifyTriggerCounts = (
|
||||
(mutationTriggerSpies as any)[s]![0].executeAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(TestEntity),
|
||||
deepEqual(mutationInfo)
|
||||
anyOfClass(TestEntity)
|
||||
)
|
||||
).once();
|
||||
} else {
|
||||
@@ -181,8 +167,7 @@ const verifyTriggerCounts = (
|
||||
(mutationTriggerSpies as any)[s]![0].executeAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(TestEntity),
|
||||
deepEqual(mutationInfo)
|
||||
anyOfClass(TestEntity)
|
||||
)
|
||||
).never();
|
||||
}
|
||||
@@ -192,8 +177,7 @@ const verifyTriggerCounts = (
|
||||
mutationTriggerSpies.beforeAll![0].executeAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(TestEntity),
|
||||
deepEqual(mutationInfo)
|
||||
anyOfClass(TestEntity)
|
||||
)
|
||||
).once();
|
||||
|
||||
@@ -201,17 +185,12 @@ const verifyTriggerCounts = (
|
||||
mutationTriggerSpies.afterAll![0].executeAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(TestEntity),
|
||||
deepEqual(mutationInfo)
|
||||
anyOfClass(TestEntity)
|
||||
)
|
||||
).once();
|
||||
|
||||
verify(
|
||||
mutationTriggerSpies.afterCommit![0].executeAsync(
|
||||
viewerContext,
|
||||
anyOfClass(TestEntity),
|
||||
deepEqual(mutationInfo)
|
||||
)
|
||||
mutationTriggerSpies.afterCommit![0].executeAsync(viewerContext, anyOfClass(TestEntity))
|
||||
).once();
|
||||
};
|
||||
|
||||
@@ -294,7 +273,7 @@ const createEntityMutatorFactory = (
|
||||
TestEntity.name
|
||||
);
|
||||
const entityLoaderFactory = new EntityLoaderFactory(
|
||||
testEntityConfiguration,
|
||||
testEntityConfiguration.idField,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
@@ -324,12 +303,9 @@ describe(EntityMutatorFactory, () => {
|
||||
it('creates entities', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const { entityMutatorFactory } = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '4',
|
||||
numberField: 1,
|
||||
@@ -337,7 +313,7 @@ describe(EntityMutatorFactory, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '5',
|
||||
numberField: 1,
|
||||
@@ -355,12 +331,9 @@ describe(EntityMutatorFactory, () => {
|
||||
it('checks privacy', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const { privacyPolicy, entityMutatorFactory } = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '4',
|
||||
numberField: 1,
|
||||
@@ -368,7 +341,7 @@ describe(EntityMutatorFactory, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '5',
|
||||
numberField: 1,
|
||||
@@ -396,12 +369,9 @@ describe(EntityMutatorFactory, () => {
|
||||
it('executes triggers', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const { mutationTriggers, entityMutatorFactory } = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '4',
|
||||
numberField: 1,
|
||||
@@ -409,7 +379,7 @@ describe(EntityMutatorFactory, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '5',
|
||||
numberField: 1,
|
||||
@@ -425,30 +395,22 @@ describe(EntityMutatorFactory, () => {
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
|
||||
verifyTriggerCounts(
|
||||
viewerContext,
|
||||
triggerSpies,
|
||||
{
|
||||
beforeCreate: true,
|
||||
afterCreate: true,
|
||||
beforeUpdate: false,
|
||||
afterUpdate: false,
|
||||
beforeDelete: false,
|
||||
afterDelete: false,
|
||||
},
|
||||
{ type: EntityMutationType.CREATE }
|
||||
);
|
||||
verifyTriggerCounts(viewerContext, triggerSpies, {
|
||||
beforeCreate: true,
|
||||
afterCreate: true,
|
||||
beforeUpdate: false,
|
||||
afterUpdate: false,
|
||||
beforeDelete: false,
|
||||
afterDelete: false,
|
||||
});
|
||||
});
|
||||
|
||||
it('executes validators', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const { mutationValidators, entityMutatorFactory } = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '4',
|
||||
numberField: 1,
|
||||
@@ -456,7 +418,7 @@ describe(EntityMutatorFactory, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '5',
|
||||
numberField: 1,
|
||||
@@ -472,7 +434,7 @@ describe(EntityMutatorFactory, () => {
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 1, { type: EntityMutationType.CREATE });
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 1);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -480,12 +442,9 @@ describe(EntityMutatorFactory, () => {
|
||||
it('updates entities', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -493,7 +452,7 @@ describe(EntityMutatorFactory, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '4',
|
||||
numberField: 3,
|
||||
@@ -503,7 +462,7 @@ describe(EntityMutatorFactory, () => {
|
||||
]);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
|
||||
const updatedEntity = await entityMutatorFactory
|
||||
@@ -516,7 +475,7 @@ describe(EntityMutatorFactory, () => {
|
||||
expect(updatedEntity.getField('stringField')).toEqual('huh2');
|
||||
|
||||
const reloadedEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
expect(reloadedEntity.getAllFields()).toMatchObject(updatedEntity.getAllFields());
|
||||
});
|
||||
@@ -524,16 +483,13 @@ describe(EntityMutatorFactory, () => {
|
||||
it('checks privacy', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const {
|
||||
privacyPolicy,
|
||||
entityMutatorFactory,
|
||||
entityLoaderFactory,
|
||||
} = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -541,7 +497,7 @@ describe(EntityMutatorFactory, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '4',
|
||||
numberField: 3,
|
||||
@@ -553,7 +509,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const spiedPrivacyPolicy = spy(privacyPolicy);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
@@ -573,16 +529,13 @@ describe(EntityMutatorFactory, () => {
|
||||
it('executes triggers', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const {
|
||||
mutationTriggers,
|
||||
entityMutatorFactory,
|
||||
entityLoaderFactory,
|
||||
} = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -590,7 +543,7 @@ describe(EntityMutatorFactory, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '4',
|
||||
numberField: 3,
|
||||
@@ -602,7 +555,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
@@ -610,33 +563,26 @@ describe(EntityMutatorFactory, () => {
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
verifyTriggerCounts(
|
||||
viewerContext,
|
||||
triggerSpies,
|
||||
{
|
||||
beforeCreate: false,
|
||||
afterCreate: false,
|
||||
beforeUpdate: true,
|
||||
afterUpdate: true,
|
||||
beforeDelete: false,
|
||||
afterDelete: false,
|
||||
},
|
||||
{ type: EntityMutationType.UPDATE, previousValue: existingEntity }
|
||||
);
|
||||
verifyTriggerCounts(viewerContext, triggerSpies, {
|
||||
beforeCreate: false,
|
||||
afterCreate: false,
|
||||
beforeUpdate: true,
|
||||
afterUpdate: true,
|
||||
beforeDelete: false,
|
||||
afterDelete: false,
|
||||
});
|
||||
});
|
||||
it('executes validators', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const id2 = uuidv4();
|
||||
const {
|
||||
mutationValidators,
|
||||
entityMutatorFactory,
|
||||
entityLoaderFactory,
|
||||
} = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'hello',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -644,7 +590,7 @@ describe(EntityMutatorFactory, () => {
|
||||
nullableField: null,
|
||||
},
|
||||
{
|
||||
customIdField: id2,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '4',
|
||||
numberField: 3,
|
||||
@@ -656,7 +602,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
@@ -664,10 +610,7 @@ describe(EntityMutatorFactory, () => {
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 1, {
|
||||
type: EntityMutationType.UPDATE,
|
||||
previousValue: existingEntity,
|
||||
});
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 1);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -675,11 +618,9 @@ describe(EntityMutatorFactory, () => {
|
||||
it('deletes entities', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -689,7 +630,7 @@ describe(EntityMutatorFactory, () => {
|
||||
]);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
expect(existingEntity).toBeTruthy();
|
||||
|
||||
@@ -697,7 +638,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
await expect(
|
||||
enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
)
|
||||
).rejects.toBeInstanceOf(Error);
|
||||
});
|
||||
@@ -705,15 +646,13 @@ describe(EntityMutatorFactory, () => {
|
||||
it('checks privacy', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const {
|
||||
privacyPolicy,
|
||||
entityMutatorFactory,
|
||||
entityLoaderFactory,
|
||||
} = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -725,7 +664,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const spiedPrivacyPolicy = spy(privacyPolicy);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
@@ -742,15 +681,13 @@ describe(EntityMutatorFactory, () => {
|
||||
it('executes triggers', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const {
|
||||
mutationTriggers,
|
||||
entityMutatorFactory,
|
||||
entityLoaderFactory,
|
||||
} = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -762,38 +699,31 @@ describe(EntityMutatorFactory, () => {
|
||||
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
|
||||
verifyTriggerCounts(
|
||||
viewerContext,
|
||||
triggerSpies,
|
||||
{
|
||||
beforeCreate: false,
|
||||
afterCreate: false,
|
||||
beforeUpdate: false,
|
||||
afterUpdate: false,
|
||||
beforeDelete: true,
|
||||
afterDelete: true,
|
||||
},
|
||||
{ type: EntityMutationType.DELETE }
|
||||
);
|
||||
verifyTriggerCounts(viewerContext, triggerSpies, {
|
||||
beforeCreate: false,
|
||||
afterCreate: false,
|
||||
beforeUpdate: false,
|
||||
afterUpdate: false,
|
||||
beforeDelete: true,
|
||||
afterDelete: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('does not execute validators', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const {
|
||||
mutationValidators,
|
||||
entityMutatorFactory,
|
||||
entityLoaderFactory,
|
||||
} = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -805,23 +735,21 @@ describe(EntityMutatorFactory, () => {
|
||||
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 0, { type: EntityMutationType.DELETE });
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 0);
|
||||
});
|
||||
});
|
||||
|
||||
it('invalidates cache for fields upon create', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
customIdField: 'world',
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
@@ -852,46 +780,11 @@ describe(EntityMutatorFactory, () => {
|
||||
expect(entities2).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('throws error when field not valid', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const id1 = uuidv4();
|
||||
const { entityMutatorFactory } = createEntityMutatorFactory([
|
||||
{
|
||||
customIdField: id1,
|
||||
stringField: 'huh',
|
||||
testIndexedField: '3',
|
||||
numberField: 3,
|
||||
dateField: new Date(),
|
||||
nullableField: null,
|
||||
},
|
||||
]);
|
||||
|
||||
await expect(
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.setField('stringField', 10 as any)
|
||||
.createAsync()
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
|
||||
|
||||
const createdEntity = await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.setField('stringField', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
entityMutatorFactory
|
||||
.forUpdate(createdEntity, queryContext)
|
||||
.setField('stringField', 10 as any)
|
||||
.updateAsync()
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
|
||||
});
|
||||
|
||||
it('returns error result when not authorized to create', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicyMock = mock(SimpleTestEntityPrivacyPolicy);
|
||||
const databaseAdapter = instance(mock<EntityDatabaseAdapter<SimpleTestFields>>());
|
||||
const databaseAdapter = instance(mock(EntityDatabaseAdapter));
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const entityLoaderFactory = instance(
|
||||
mock<
|
||||
@@ -948,9 +841,8 @@ describe(EntityMutatorFactory, () => {
|
||||
expect(entityCreateResult.reason).toEqual(rejectionError);
|
||||
expect(entityCreateResult.value).toBe(undefined);
|
||||
|
||||
const id1 = uuidv4();
|
||||
const fakeEntity = new SimpleTestEntity(viewerContext, {
|
||||
id: id1,
|
||||
id: 'hello',
|
||||
});
|
||||
|
||||
const entityUpdateResult = await entityMutatorFactory
|
||||
@@ -972,7 +864,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(SimpleTestEntityPrivacyPolicy));
|
||||
const databaseAdapterMock = mock<EntityDatabaseAdapter<SimpleTestFields>>();
|
||||
const databaseAdapterMock = mock(EntityDatabaseAdapter);
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const entityLoaderFactory = instance(
|
||||
mock<
|
||||
@@ -1019,9 +911,8 @@ describe(EntityMutatorFactory, () => {
|
||||
metricsAdapter
|
||||
);
|
||||
|
||||
const id1 = uuidv4();
|
||||
const fakeEntity = new SimpleTestEntity(viewerContext, {
|
||||
id: id1,
|
||||
id: 'hello',
|
||||
});
|
||||
|
||||
await expect(
|
||||
|
||||
@@ -1,8 +1,13 @@
|
||||
import { mock, instance, spy, verify, anyOfClass } from 'ts-mockito';
|
||||
|
||||
import Entity from '../Entity';
|
||||
import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import {
|
||||
EntityCompanionDefinition,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
} from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { EntityNotAuthorizedError } from '../EntityErrors';
|
||||
import { UUIDField } from '../EntityFields';
|
||||
import EntityPrivacyPolicy, {
|
||||
EntityPrivacyPolicyEvaluator,
|
||||
@@ -10,7 +15,6 @@ import EntityPrivacyPolicy, {
|
||||
} from '../EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import EntityNotAuthorizedError from '../errors/EntityNotAuthorizedError';
|
||||
import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
|
||||
import AlwaysDenyPrivacyPolicyRule from '../rules/AlwaysDenyPrivacyPolicyRule';
|
||||
import AlwaysSkipPrivacyPolicyRule from '../rules/AlwaysSkipPrivacyPolicyRule';
|
||||
@@ -230,8 +234,8 @@ const blahEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
columnName: 'id',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
}),
|
||||
privacyPolicyClass: AlwaysDenyPolicy,
|
||||
});
|
||||
|
||||
@@ -1,107 +0,0 @@
|
||||
import { anyOfClass, anything, deepEqual, instance, mock, spy, verify, when } from 'ts-mockito';
|
||||
|
||||
import { EntityNonTransactionalQueryContext } from '../EntityQueryContext';
|
||||
import EntitySecondaryCacheLoader, { ISecondaryEntityCache } from '../EntitySecondaryCacheLoader';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import SimpleTestEntity, {
|
||||
SimpleTestEntityPrivacyPolicy,
|
||||
SimpleTestFields,
|
||||
} from '../testfixtures/SimpleTestEntity';
|
||||
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
|
||||
|
||||
type TestLoadParams = { id: string };
|
||||
|
||||
class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
|
||||
TestLoadParams,
|
||||
SimpleTestFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
SimpleTestEntity,
|
||||
SimpleTestEntityPrivacyPolicy
|
||||
> {
|
||||
protected async fetchObjectsFromDatabaseAsync(
|
||||
_loadParamsArray: readonly Readonly<TestLoadParams>[]
|
||||
): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<SimpleTestFields>>> {
|
||||
// unused
|
||||
return new Map();
|
||||
}
|
||||
}
|
||||
|
||||
describe(EntitySecondaryCacheLoader, () => {
|
||||
describe('loadManyAsync', () => {
|
||||
it('calls into secondary cache with correct params', async () => {
|
||||
const vc1 = new ViewerContext(createUnitTestEntityCompanionProvider());
|
||||
|
||||
const createdEntity = await SimpleTestEntity.creator(vc1).enforceCreateAsync();
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
|
||||
const secondaryEntityCacheMock = mock<
|
||||
ISecondaryEntityCache<SimpleTestFields, TestLoadParams>
|
||||
>();
|
||||
when(
|
||||
secondaryEntityCacheMock.loadManyThroughAsync(deepEqual([loadParams]), anything())
|
||||
).thenResolve(new Map());
|
||||
const secondaryEntityCache = instance(secondaryEntityCacheMock);
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
secondaryEntityCache,
|
||||
SimpleTestEntity.loader(vc1)
|
||||
);
|
||||
|
||||
await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
|
||||
verify(
|
||||
secondaryEntityCacheMock.loadManyThroughAsync(deepEqual([loadParams]), anything())
|
||||
).once();
|
||||
});
|
||||
|
||||
it('constructs and authorizes entities', async () => {
|
||||
const vc1 = new ViewerContext(createUnitTestEntityCompanionProvider());
|
||||
|
||||
const createdEntity = await SimpleTestEntity.creator(vc1).enforceCreateAsync();
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
|
||||
const secondaryEntityCacheMock = mock<
|
||||
ISecondaryEntityCache<SimpleTestFields, TestLoadParams>
|
||||
>();
|
||||
when(
|
||||
secondaryEntityCacheMock.loadManyThroughAsync(deepEqual([loadParams]), anything())
|
||||
).thenResolve(new Map([[loadParams, createdEntity.getAllFields()]]));
|
||||
const secondaryEntityCache = instance(secondaryEntityCacheMock);
|
||||
|
||||
const loader = SimpleTestEntity.loader(vc1);
|
||||
const spiedPrivacyPolicy = spy(loader['privacyPolicy']);
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(secondaryEntityCache, loader);
|
||||
|
||||
const result = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(result.get(loadParams)?.enforceValue().getID()).toEqual(createdEntity.getID());
|
||||
|
||||
verify(
|
||||
spiedPrivacyPolicy.authorizeReadAsync(
|
||||
vc1,
|
||||
anyOfClass(EntityNonTransactionalQueryContext),
|
||||
anything()
|
||||
)
|
||||
).once();
|
||||
});
|
||||
});
|
||||
|
||||
describe('invalidateManyAsync', () => {
|
||||
it('calls invalidate on the secondary cache', async () => {
|
||||
const vc1 = new ViewerContext(createUnitTestEntityCompanionProvider());
|
||||
|
||||
const createdEntity = await SimpleTestEntity.creator(vc1).enforceCreateAsync();
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
|
||||
const secondaryEntityCacheMock = mock<
|
||||
ISecondaryEntityCache<SimpleTestFields, TestLoadParams>
|
||||
>();
|
||||
const secondaryEntityCache = instance(secondaryEntityCacheMock);
|
||||
const loader = SimpleTestEntity.loader(vc1);
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(secondaryEntityCache, loader);
|
||||
await secondaryCacheLoader.invalidateManyAsync([loadParams]);
|
||||
|
||||
verify(secondaryEntityCacheMock.invalidateManyAsync(deepEqual([loadParams]))).once();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,5 +1,9 @@
|
||||
import Entity from '../Entity';
|
||||
import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import {
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
} from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { UUIDField, EntityEdgeDeletionBehavior } from '../EntityFields';
|
||||
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
|
||||
@@ -21,18 +25,10 @@ class CategoryPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
any,
|
||||
any
|
||||
> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<CategoryFields, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<CategoryFields, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<CategoryFields, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<CategoryFields, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
||||
@@ -67,8 +63,8 @@ const makeEntityClass = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const categoryEntityCompanion = new EntityCompanionDefinition({
|
||||
|
||||
@@ -2,6 +2,7 @@ import { instance, mock } from 'ts-mockito';
|
||||
|
||||
import EntityAssociationLoader from '../EntityAssociationLoader';
|
||||
import EntityLoader from '../EntityLoader';
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ReadonlyEntity from '../ReadonlyEntity';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import SimpleTestEntity from '../testfixtures/SimpleTestEntity';
|
||||
@@ -107,6 +108,30 @@ describe(ReadonlyEntity, () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('getRegularEntityQueryContext', () => {
|
||||
it('creates a new regular query context', () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new ViewerContext(companionProvider);
|
||||
const queryContext = SimpleTestEntity.getQueryContext(viewerContext);
|
||||
expect(queryContext).toBeInstanceOf(EntityQueryContext);
|
||||
expect(queryContext.isInTransaction()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('runInTransactionAsync', () => {
|
||||
it('creates a new transactional query context', async () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new ViewerContext(companionProvider);
|
||||
const didCreateTransaction = await SimpleTestEntity.runInTransactionAsync(
|
||||
viewerContext,
|
||||
async (queryContext) => {
|
||||
return queryContext.isInTransaction();
|
||||
}
|
||||
);
|
||||
expect(didCreateTransaction).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('loader', () => {
|
||||
it('creates a new EntityLoader', async () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
|
||||
|
||||
describe(ViewerContext, () => {
|
||||
describe('getQueryContextForDatabaseAdaptorFlavor', () => {
|
||||
it('creates a new regular query context', () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new ViewerContext(companionProvider);
|
||||
const queryContext = viewerContext.getQueryContextForDatabaseAdaptorFlavor('postgres');
|
||||
expect(queryContext).toBeInstanceOf(EntityQueryContext);
|
||||
expect(queryContext.isInTransaction()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('runInTransactionForDatabaseAdaptorFlavorAsync', () => {
|
||||
it('creates a new transactional query context', async () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new ViewerContext(companionProvider);
|
||||
const didCreateTransaction = await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
|
||||
'postgres',
|
||||
async (queryContext) => {
|
||||
return queryContext.isInTransaction();
|
||||
}
|
||||
);
|
||||
expect(didCreateTransaction).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,5 +1,9 @@
|
||||
import Entity from '../../Entity';
|
||||
import { EntityCompanionDefinition } from '../../EntityCompanionProvider';
|
||||
import {
|
||||
EntityCompanionDefinition,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
} from '../../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../../EntityConfiguration';
|
||||
import { UUIDField, EnumField, StringField } from '../../EntityFields';
|
||||
import EntityPrivacyPolicy from '../../EntityPrivacyPolicy';
|
||||
@@ -102,23 +106,15 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
|
||||
columnName: 'entity_type',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
class OneTestEntity extends Entity<TestFields, string, ViewerContext, OneTestFields> {
|
||||
|
||||
Loaded 100 of 130 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user