mirror of
https://github.com/expo/entity.git
synced 2026-11-15 13:18:13 -10:00
Compare commits
27
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1b749a0633 | ||
|
|
d731b0ddb7 | ||
|
|
293868b1a7 | ||
|
|
02d2f24bb6 | ||
|
|
e76ca8c2f7 | ||
|
|
0736e20987 | ||
|
|
5c82edcd9f | ||
|
|
96e1023d40 | ||
|
|
3a81a4c059 | ||
|
|
6b6e70e75f | ||
|
|
bc378b6c79 | ||
|
|
fefa4100fc | ||
|
|
85d35752fa | ||
|
|
09d48a617c | ||
|
|
0adcf7238f | ||
|
|
41bd0722c9 | ||
|
|
03a1fce067 | ||
|
|
a2c6dd7488 | ||
|
|
e1b0ee5281 | ||
|
|
5d39fa928f | ||
|
|
f1d9847210 | ||
|
|
99657196f8 | ||
|
|
3727191767 | ||
|
|
efa131ef29 | ||
|
|
c4df889d50 | ||
|
|
7cf54d83c5 | ||
|
|
1405a9126e |
No files matched your search
+119
@@ -3,6 +3,125 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* lock lru-cache to v6.0.0 ([#170](https://github.com/expo/entity/issues/170)) ([293868b](https://github.com/expo/entity/commit/293868b1a73df9f749216af68b1ae94ac22ac2b9))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* lru-cache yarn workspace version resolution ([#168](https://github.com/expo/entity/issues/168)) ([e76ca8c](https://github.com/expo/entity/commit/e76ca8c2f72da84aa372a64ef1898ade220ed0a8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add composed cache to index ([#166](https://github.com/expo/entity/issues/166)) ([5c82edc](https://github.com/expo/entity/commit/5c82edcd9f26854878d29950a05852e117bbd723))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
* privacy policy evaluation context ([#162](https://github.com/expo/entity/issues/162)) ([3a81a4c](https://github.com/expo/entity/commit/3a81a4c059e2e995eb800e35e76b3d432c22b23f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add local memory cache package ([#158](https://github.com/expo/entity/issues/158)) ([85d3575](https://github.com/expo/entity/commit/85d35752fa0919a62efb776a762a6829e83ca7af))
|
||||
|
||||
### Chores
|
||||
|
||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
### Breaking changes
|
||||
|
||||
* Move data transforming responsibilities to the CacheAdapter instead of the ReadThroughEntityCache. Affects any classes extending the EntityCacheAdapter and relying on the transformation behavior of the ReadThroughEntityCache. ([#153](https://github.com/expo/entity/pull/153))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Upgrade knex to 1.x in `@expo/entity-database-adapter-knex` ([#150](https://github.com/expo/entity/issues/150)) ([e1b0ee5](https://github.com/expo/entity/commit/e1b0ee528175646239d88aa71ffce73983eeb52f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* separate post-commit invalidation callbacks from trigger and user callbacks ([#144](https://github.com/expo/entity/issues/144)) ([efa131e](https://github.com/expo/entity/commit/efa131ef29532accf0e51b6d867ffe15a27b4c90))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add authorization metrics ([#142](https://github.com/expo/entity/issues/142)) ([7cf54d8](https://github.com/expo/entity/commit/7cf54d83c52e104159a3e2e675cdda2d29afe204))
|
||||
* add IP support ([#138](https://github.com/expo/entity/issues/138)) ([1405a91](https://github.com/expo/entity/commit/1405a9126ee3a56c3e2a38bf3b697283744f5b5d))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -4,5 +4,5 @@
|
||||
],
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true,
|
||||
"version": "0.18.0"
|
||||
"version": "0.25.3"
|
||||
}
|
||||
@@ -21,6 +21,8 @@
|
||||
"@types/invariant": "^2.2.33",
|
||||
"@types/ioredis": "^4.26.4",
|
||||
"@types/jest": "^26.0.10",
|
||||
"@types/jsbn": "^1.2.29",
|
||||
"@types/lru-cache": "^5.1.1",
|
||||
"@types/node": "^14.6.0",
|
||||
"@types/uuid": "^8.3.0",
|
||||
"@typescript-eslint/eslint-plugin": "^4.14.0",
|
||||
@@ -31,6 +33,7 @@
|
||||
"eslint-plugin-tsdoc": "^0.2.11",
|
||||
"jest": "^26.6.3",
|
||||
"lerna": "^4.0.0",
|
||||
"lru-cache": "^6.0.0",
|
||||
"nullthrows": "^1.1.1",
|
||||
"pg": "^8.6.0",
|
||||
"prettier": "^2.3.2",
|
||||
@@ -42,8 +45,11 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"@expo/entity": "file:packages/entity",
|
||||
"@expo/entity-cache-adapter-local-memory": "file:packages/entity-cache-adapter-local-memory",
|
||||
"@expo/entity-cache-adapter-redis": "file:packages/entity-cache-adapter-redis",
|
||||
"@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex",
|
||||
"@expo/entity-ip-address-field": "file:packages/entity-ip-address-field",
|
||||
"@expo/entity-secondary-cache-local-memory": "file:packages/entity-secondary-cache-local-memory",
|
||||
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* lock lru-cache to v6.0.0 ([#170](https://github.com/expo/entity/issues/170)) ([293868b](https://github.com/expo/entity/commit/293868b1a73df9f749216af68b1ae94ac22ac2b9))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* lru-cache yarn workspace version resolution ([#168](https://github.com/expo/entity/issues/168)) ([e76ca8c](https://github.com/expo/entity/commit/e76ca8c2f72da84aa372a64ef1898ade220ed0a8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add local memory cache package ([#158](https://github.com/expo/entity/issues/158)) ([85d3575](https://github.com/expo/entity/commit/85d35752fa0919a62efb776a762a6829e83ca7af))
|
||||
@@ -0,0 +1,49 @@
|
||||
# `@expo/entity-cache-adapter-local-memory`
|
||||
|
||||
Cross-request [LRU](https://github.com/isaacs/node-lru-cache) cache adapter for `@expo/entity`. Use
|
||||
this cache with caution - it is nonstandard. The cache is shared between requests in the node process.
|
||||
|
||||
Note: This uses version 6.0.0 of `node-lru-cache` since it the most tuned version for our use case (low TTL + LRU). Upgrading
|
||||
to 7.x will cause high memory usage for the entity cache adapter use case since it allocates fixed-size data structures up front to tune for the non-TTL use case: https://github.com/isaacs/node-lru-cache/issues/208.
|
||||
|
||||
[Documentation](https://expo.github.io/entity/modules/_expo_cache_adapter_local_memory.html)
|
||||
|
||||
## Why NOT use this cache
|
||||
|
||||
Because this is an in-memory cache, cross-machine invalidation is not possible. Do not use this cache
|
||||
if you have the following use cases:
|
||||
|
||||
- The objects stored are mutable
|
||||
- Reading a stale object from the cache is not acceptable in your application
|
||||
- Cross-machine invalidation is not possible
|
||||
|
||||
## Typical use cases
|
||||
|
||||
If your application sees many requests fetching the same objects, you can save a trip to your cache
|
||||
cluster and backing datastore by using this in-memory cache. Here are some good use cases:
|
||||
|
||||
- The objects stored are mostly immutable, and reading a stale object for a short TTL is acceptable
|
||||
- You have a low TTL setting in your cache
|
||||
|
||||
## Usage
|
||||
|
||||
During `EntityCompanionProvider` instantiation:
|
||||
|
||||
```typescript
|
||||
export const createDefaultEntityCompanionProvider = (
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
{
|
||||
...
|
||||
},
|
||||
{
|
||||
['local-memory']: {
|
||||
cacheAdapterProvider: new LocalMemoryCacheAdapterProvider.getProvider(),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
```
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-local-memory",
|
||||
"version": "0.25.3",
|
||||
"description": "Cross-request local memory cache adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
"src"
|
||||
],
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"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": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"lru-cache": "^6.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.25.3"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
import { CacheLoadResult, CacheStatus, IEntityGenericCacher } from '@expo/entity';
|
||||
import LRUCache from 'lru-cache';
|
||||
|
||||
// Sentinel value we store in local memory to negatively cache a database miss.
|
||||
// The sentinel value is distinct from any (positively) cached value.
|
||||
export const DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = Symbol('doesNotExist');
|
||||
type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
|
||||
export type LocalMemoryCache<TFields> = LRUCache<string, LocalMemoryCacheValue<TFields>>;
|
||||
|
||||
export default class GenericLocalMemoryCacher<TFields> implements IEntityGenericCacher<TFields> {
|
||||
constructor(private readonly localMemoryCache: LocalMemoryCache<TFields>) {}
|
||||
|
||||
static createLRUCache<TFields>(
|
||||
options: { maxSize?: number; ttlSeconds?: number } = {}
|
||||
): LocalMemoryCache<TFields> {
|
||||
const DEFAULT_LRU_CACHE_MAX_AGE_SECONDS = 10;
|
||||
const DEFAULT_LRU_CACHE_SIZE = 10000;
|
||||
const maxAgeSeconds = options.ttlSeconds ?? DEFAULT_LRU_CACHE_MAX_AGE_SECONDS;
|
||||
return new LRUCache<string, LocalMemoryCacheValue<TFields>>({
|
||||
max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE,
|
||||
length: (value) => (value === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1),
|
||||
maxAge: maxAgeSeconds * 1000, // convert to ms
|
||||
});
|
||||
}
|
||||
|
||||
static createNoOpCache<TFields>(): LocalMemoryCache<TFields> {
|
||||
return new LRUCache<string, LocalMemoryCacheValue<TFields>>({
|
||||
max: 0,
|
||||
maxAge: -1,
|
||||
});
|
||||
}
|
||||
|
||||
public async loadManyAsync(
|
||||
keys: readonly string[]
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
||||
const cacheResults = new Map<string, CacheLoadResult<TFields>>();
|
||||
for (const key of keys) {
|
||||
const cacheResult = this.localMemoryCache.get(key);
|
||||
if (cacheResult === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE) {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
} else if (cacheResult) {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.HIT,
|
||||
item: cacheResult as unknown as TFields,
|
||||
});
|
||||
} else {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
}
|
||||
return cacheResults;
|
||||
}
|
||||
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void> {
|
||||
for (const [key, item] of objectMap) {
|
||||
this.localMemoryCache.set(key, item);
|
||||
}
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync(keys: readonly string[]): Promise<void> {
|
||||
for (const key of keys) {
|
||||
this.localMemoryCache.set(key, DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||
}
|
||||
}
|
||||
|
||||
public async invalidateManyAsync(keys: readonly string[]): Promise<void> {
|
||||
for (const key of keys) {
|
||||
this.localMemoryCache.del(key);
|
||||
}
|
||||
}
|
||||
|
||||
public makeCacheKey(parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||
);
|
||||
return escapedParts.join(delimiter);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
import { EntityCacheAdapter, CacheLoadResult, EntityConfiguration, mapKeys } from '@expo/entity';
|
||||
import invariant from 'invariant';
|
||||
|
||||
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
|
||||
|
||||
export default class LocalMemoryCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
|
||||
private readonly genericLocalMemoryCacher: GenericLocalMemoryCacher<TFields>;
|
||||
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
localMemoryCache: LocalMemoryCache<TFields>
|
||||
) {
|
||||
super(entityConfiguration);
|
||||
this.genericLocalMemoryCacher = new GenericLocalMemoryCacher(localMemoryCache);
|
||||
}
|
||||
|
||||
public async loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>> {
|
||||
const localMemoryCacheKeyToFieldValueMapping = new Map(
|
||||
fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue])
|
||||
);
|
||||
const cacheResults = await this.genericLocalMemoryCacher.loadManyAsync(
|
||||
Array.from(localMemoryCacheKeyToFieldValueMapping.keys())
|
||||
);
|
||||
|
||||
return mapKeys(cacheResults, (cacheKey) => {
|
||||
const fieldValue = localMemoryCacheKeyToFieldValueMapping.get(cacheKey);
|
||||
invariant(
|
||||
fieldValue !== undefined,
|
||||
'Unspecified cache key %s returned from generic local memory cacher',
|
||||
cacheKey
|
||||
);
|
||||
return fieldValue;
|
||||
});
|
||||
}
|
||||
|
||||
public async cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>
|
||||
): Promise<void> {
|
||||
await this.genericLocalMemoryCacher.cacheManyAsync(
|
||||
mapKeys(objectMap, (fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
await this.genericLocalMemoryCacher.cacheDBMissesAsync(
|
||||
fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
}
|
||||
|
||||
public async invalidateManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
await this.genericLocalMemoryCacher.invalidateManyAsync(
|
||||
fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
}
|
||||
|
||||
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}`);
|
||||
const parts = [
|
||||
this.entityConfiguration.tableName,
|
||||
`${this.entityConfiguration.cacheKeyVersion}`,
|
||||
columnName,
|
||||
String(fieldValue),
|
||||
];
|
||||
return this.genericLocalMemoryCacher.makeCacheKey(parts);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
import {
|
||||
computeIfAbsent,
|
||||
EntityCacheAdapter,
|
||||
EntityConfiguration,
|
||||
IEntityCacheAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
|
||||
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
|
||||
import LocalMemoryCacheAdapter from './LocalMemoryCacheAdapter';
|
||||
|
||||
export default class LocalMemoryCacheAdapterProvider implements IEntityCacheAdapterProvider {
|
||||
// local memory cache adapters should be shared/reused across requests
|
||||
static localMemoryCacheAdapterMap = new Map<string, LocalMemoryCacheAdapter<any>>();
|
||||
|
||||
static getNoOpProvider(): IEntityCacheAdapterProvider {
|
||||
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
|
||||
GenericLocalMemoryCacher.createNoOpCache<TFields>()
|
||||
);
|
||||
}
|
||||
|
||||
static getProvider(
|
||||
options: { maxSize?: number; ttlSeconds?: number } = {}
|
||||
): IEntityCacheAdapterProvider {
|
||||
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
|
||||
GenericLocalMemoryCacher.createLRUCache<TFields>(options)
|
||||
);
|
||||
}
|
||||
|
||||
private constructor(
|
||||
private readonly localMemoryCacheCreator: <TFields>() => LocalMemoryCache<TFields>
|
||||
) {}
|
||||
|
||||
public getCacheAdapter<TFields>(
|
||||
entityConfiguration: EntityConfiguration<TFields>
|
||||
): EntityCacheAdapter<TFields> {
|
||||
return computeIfAbsent(
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap,
|
||||
entityConfiguration.tableName,
|
||||
() => {
|
||||
const localMemoryCache = this.localMemoryCacheCreator<TFields>();
|
||||
return new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
import GenericLocalMemoryCacher from '../GenericLocalMemoryCacher';
|
||||
|
||||
describe(GenericLocalMemoryCacher, () => {
|
||||
describe(GenericLocalMemoryCacher.createLRUCache, () => {
|
||||
it('creates a cache with default options', () => {
|
||||
const cache = GenericLocalMemoryCacher.createLRUCache();
|
||||
expect(cache.max).toBe(10000);
|
||||
expect(cache.maxAge).toBe(10000);
|
||||
});
|
||||
|
||||
it('respects specified options', () => {
|
||||
const cache = GenericLocalMemoryCacher.createLRUCache({
|
||||
ttlSeconds: 3,
|
||||
maxSize: 10,
|
||||
});
|
||||
expect(cache.max).toBe(10);
|
||||
expect(cache.maxAge).toBe(3000);
|
||||
});
|
||||
});
|
||||
|
||||
describe(GenericLocalMemoryCacher.createNoOpCache, () => {
|
||||
it('creates a no-op cache', () => {
|
||||
const cache = GenericLocalMemoryCacher.createNoOpCache<{ hello: 'world' }>();
|
||||
cache.set('a', { hello: 'world' });
|
||||
expect(cache.get('a')).toBeUndefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
+172
@@ -0,0 +1,172 @@
|
||||
import { CacheStatus, ViewerContext } from '@expo/entity';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import GenericLocalMemoryCacher from '../GenericLocalMemoryCacher';
|
||||
import LocalMemoryCacheAdapter from '../LocalMemoryCacheAdapter';
|
||||
import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider';
|
||||
import LocalMemoryTestEntity from '../testfixtures/LocalMemoryTestEntity';
|
||||
import {
|
||||
createLocalMemoryTestEntityCompanionProvider,
|
||||
createNoopLocalMemoryIntegrationTestEntityCompanionProvider,
|
||||
} from '../testfixtures/createLocalMemoryTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(LocalMemoryCacheAdapter, () => {
|
||||
beforeEach(async () => {
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.clear();
|
||||
});
|
||||
|
||||
it('has correct caching behavior', async () => {
|
||||
const viewerContext = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider());
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
|
||||
const date = new Date();
|
||||
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
const entity1 = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
entity1Created.getID()
|
||||
);
|
||||
|
||||
const entitySpecificGenericCacher =
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
|
||||
LocalMemoryTestEntity.getCompanionDefinition().entityConfiguration.tableName
|
||||
)!['genericLocalMemoryCacher'];
|
||||
const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', entity1.getID()),
|
||||
]);
|
||||
const cachedValue = cachedResult.get(cacheKeyMaker('id', entity1.getID()))!;
|
||||
expect(cachedValue).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: {
|
||||
id: entity1.getID(),
|
||||
name: 'blah',
|
||||
dateField: date,
|
||||
},
|
||||
});
|
||||
|
||||
// simulate non existent db fetch, should write negative result ('') to cache
|
||||
const nonExistentId = uuidv4();
|
||||
|
||||
const entityNonExistentResult = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
expect(entityNonExistentResult.ok).toBe(false);
|
||||
|
||||
const nonExistentCachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', nonExistentId),
|
||||
]);
|
||||
expect(nonExistentCachedResult.get(cacheKeyMaker('id', nonExistentId))).toMatchObject({
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
|
||||
// load again through entities framework to ensure it reads negative result
|
||||
const entityNonExistentResult2 = await LocalMemoryTestEntity.loader(
|
||||
viewerContext
|
||||
).loadByIDAsync(nonExistentId);
|
||||
expect(entityNonExistentResult2.ok).toBe(false);
|
||||
|
||||
// invalidate from cache to ensure it invalidates correctly
|
||||
await LocalMemoryTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
|
||||
const cachedResultMiss = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', entity1.getID()),
|
||||
]);
|
||||
const cachedValueMiss = cachedResultMiss.get(cacheKeyMaker('id', entity1.getID()));
|
||||
expect(cachedValueMiss).toMatchObject({ status: CacheStatus.MISS });
|
||||
});
|
||||
|
||||
it('shares the cache between different requests', async () => {
|
||||
const genericLocalMemoryCacherLoadManySpy = jest.spyOn(
|
||||
GenericLocalMemoryCacher.prototype as unknown as any,
|
||||
'loadManyAsync'
|
||||
);
|
||||
const viewerContext = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider());
|
||||
|
||||
const date = new Date();
|
||||
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(entity1Created.getID());
|
||||
|
||||
// load entity with a different request
|
||||
const viewerContext2 = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider());
|
||||
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2).loadByIDAsync(
|
||||
entity1Created.getID()
|
||||
);
|
||||
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
expect(entity1WithVc2.getAllFields()).toMatchObject({
|
||||
id: entity1WithVc2.getID(),
|
||||
name: 'blah',
|
||||
dateField: date,
|
||||
});
|
||||
expect(genericLocalMemoryCacherLoadManySpy).toBeCalledWith([
|
||||
cacheKeyMaker('id', entity1WithVc2.getID()),
|
||||
]);
|
||||
expect(genericLocalMemoryCacherLoadManySpy).toBeCalledTimes(2);
|
||||
});
|
||||
|
||||
it('respects the parameters of a noop cache', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createNoopLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||
);
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
|
||||
const date = new Date();
|
||||
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity will try to put it in cache but it's a noop cache, so it should be a miss
|
||||
const entity1 = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
entity1Created.getID()
|
||||
);
|
||||
|
||||
const entitySpecificGenericCacher =
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
|
||||
LocalMemoryTestEntity.getCompanionDefinition().entityConfiguration.tableName
|
||||
)!['genericLocalMemoryCacher'];
|
||||
const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', entity1.getID()),
|
||||
]);
|
||||
const cachedValue = cachedResult.get(cacheKeyMaker('id', entity1.getID()))!;
|
||||
expect(cachedValue).toMatchObject({
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
|
||||
// a non existent db fetch should try to write negative result ('') but it's a noop cache, so it should be a miss
|
||||
const nonExistentId = uuidv4();
|
||||
|
||||
const entityNonExistentResult = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
expect(entityNonExistentResult.ok).toBe(false);
|
||||
|
||||
const nonExistentCachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', nonExistentId),
|
||||
]);
|
||||
expect(nonExistentCachedResult.get(cacheKeyMaker('id', nonExistentId))).toMatchObject({
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
});
|
||||
});
|
||||
+107
@@ -0,0 +1,107 @@
|
||||
import { CacheStatus, UUIDField, EntityConfiguration } from '@expo/entity';
|
||||
|
||||
import GenericLocalMemoryCacher, {
|
||||
DOES_NOT_EXIST_LOCAL_MEMORY_CACHE,
|
||||
} from '../GenericLocalMemoryCacher';
|
||||
import LocalMemoryCacheAdapter from '../LocalMemoryCacheAdapter';
|
||||
|
||||
type BlahFields = {
|
||||
id: string;
|
||||
};
|
||||
|
||||
const entityConfiguration = new EntityConfiguration<BlahFields>({
|
||||
idField: 'id',
|
||||
tableName: 'blah',
|
||||
schema: {
|
||||
id: new UUIDField({ columnName: 'id', cache: true }),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'local-memory',
|
||||
});
|
||||
|
||||
describe(LocalMemoryCacheAdapter, () => {
|
||||
describe('loadManyAsync', () => {
|
||||
it('returns appropriate cache results', async () => {
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||
entityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache()
|
||||
);
|
||||
|
||||
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
|
||||
await cacheAdapter.cacheManyAsync('id', cacheHits);
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', [
|
||||
'test-id-1',
|
||||
'test-id-2',
|
||||
'test-id-3',
|
||||
]);
|
||||
|
||||
expect(results.get('test-id-1')).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: { id: 'test-id-1' },
|
||||
});
|
||||
expect(results.get('test-id-2')).toMatchObject({ status: CacheStatus.NEGATIVE });
|
||||
expect(results.get('test-id-3')).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.size).toBe(3);
|
||||
});
|
||||
|
||||
it('returns empty map when passed empty array of fieldValues', async () => {
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||
entityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache()
|
||||
);
|
||||
const results = await cacheAdapter.loadManyAsync('id', []);
|
||||
expect(results).toEqual(new Map());
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheManyAsync', () => {
|
||||
it('correctly caches all objects', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
||||
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
||||
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(localMemoryCache.get(cacheKey)).toMatchObject({
|
||||
id: 'test-id-1',
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheDBMissesAsync', () => {
|
||||
it('correctly caches misses', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
||||
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']);
|
||||
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(localMemoryCache.get(cacheKey)).toEqual(DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||
});
|
||||
});
|
||||
|
||||
describe('invalidateManyAsync', () => {
|
||||
it('invalidates correctly', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
||||
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
await cacheAdapter.invalidateManyAsync('id', ['test-id-1', 'test-id-2']);
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', ['test-id-1', 'test-id-2']);
|
||||
expect(results.get('test-id-1')).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.get('test-id-2')).toMatchObject({ status: CacheStatus.MISS });
|
||||
});
|
||||
|
||||
it('returns when passed empty array of fieldValues', async () => {
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||
entityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache<BlahFields>({})
|
||||
);
|
||||
await cacheAdapter.invalidateManyAsync('id', []);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,10 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-cache-adapter-local-memory
|
||||
*/
|
||||
|
||||
export { default as GenericLocalMemoryCacher } from './GenericLocalMemoryCacher';
|
||||
export * from './GenericLocalMemoryCacher';
|
||||
export { default as LocalMemoryCacheAdapter } from './LocalMemoryCacheAdapter';
|
||||
export { default as LocalMemoryCacheAdapterProvider } from './LocalMemoryCacheAdapterProvider';
|
||||
@@ -0,0 +1,100 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
ViewerContext,
|
||||
UUIDField,
|
||||
DateField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
|
||||
export type LocalMemoryTestEntityFields = {
|
||||
id: string;
|
||||
name: string;
|
||||
dateField: Date | null;
|
||||
};
|
||||
|
||||
export default class LocalMemoryTestEntity extends Entity<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext
|
||||
> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntityPrivacyPolicy
|
||||
> {
|
||||
return localMemoryTestEntityCompanionDefinition;
|
||||
}
|
||||
}
|
||||
|
||||
export class LocalMemoryTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const localMemoryTestEntityConfiguration =
|
||||
new EntityConfiguration<LocalMemoryTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'local_memory_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
cache: true,
|
||||
}),
|
||||
dateField: new DateField({
|
||||
columnName: 'date_field',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'local-memory',
|
||||
});
|
||||
|
||||
const localMemoryTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: LocalMemoryTestEntity,
|
||||
entityConfiguration: localMemoryTestEntityConfiguration,
|
||||
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
|
||||
});
|
||||
+48
@@ -0,0 +1,48 @@
|
||||
import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
|
||||
import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider';
|
||||
|
||||
export const createLocalMemoryTestEntityCompanionProvider = (
|
||||
localMemoryOptions: { maxSize?: number; ttlSeconds?: number } = {},
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
const localMemoryCacheAdapterProvider =
|
||||
localMemoryOptions.maxSize === 0 && localMemoryOptions.ttlSeconds === 0
|
||||
? LocalMemoryCacheAdapterProvider.getNoOpProvider()
|
||||
: LocalMemoryCacheAdapterProvider.getProvider(localMemoryOptions);
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'local-memory',
|
||||
{
|
||||
cacheAdapterProvider: localMemoryCacheAdapterProvider,
|
||||
},
|
||||
],
|
||||
])
|
||||
);
|
||||
};
|
||||
|
||||
export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = (
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return createLocalMemoryTestEntityCompanionProvider(
|
||||
{ maxSize: 0, ttlSeconds: 0 },
|
||||
metricsAdapter
|
||||
);
|
||||
};
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -3,6 +3,89 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
### Chores
|
||||
|
||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
### Chores
|
||||
|
||||
* Move data transforming responsibilities to the CacheAdapter instead of the ReadThroughEntityCache. ([#153](https://github.com/expo/entity/pull/153))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-redis",
|
||||
"version": "0.18.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Redis cache adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -33,6 +33,6 @@
|
||||
"ioredis": "^4.27.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.18.0"
|
||||
"@expo/entity": "^0.25.3"
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,14 @@
|
||||
import { CacheLoadResult, CacheStatus } from '@expo/entity';
|
||||
import {
|
||||
CacheLoadResult,
|
||||
CacheStatus,
|
||||
EntityConfiguration,
|
||||
transformCacheObjectToFields,
|
||||
transformFieldsToCacheObject,
|
||||
IEntityGenericCacher,
|
||||
} from '@expo/entity';
|
||||
import { Redis } from 'ioredis';
|
||||
|
||||
import { redisTransformerMap } from './RedisCommon';
|
||||
import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
|
||||
|
||||
// Sentinel value we store in Redis to negatively cache a database miss.
|
||||
@@ -26,12 +34,15 @@ export interface GenericRedisCacheContext {
|
||||
ttlSecondsNegative: number;
|
||||
}
|
||||
|
||||
export default class GenericRedisCacher {
|
||||
constructor(private readonly context: GenericRedisCacheContext) {}
|
||||
export default class GenericRedisCacher<TFields> implements IEntityGenericCacher<TFields> {
|
||||
constructor(
|
||||
private readonly context: GenericRedisCacheContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>
|
||||
) {}
|
||||
|
||||
public async loadManyAsync(
|
||||
keys: readonly string[]
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult>> {
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
||||
if (keys.length === 0) {
|
||||
return new Map();
|
||||
}
|
||||
@@ -40,7 +51,7 @@ export default class GenericRedisCacher {
|
||||
this.context.redisClient.mget(...keys)
|
||||
);
|
||||
|
||||
const results = new Map<string, CacheLoadResult>();
|
||||
const results = new Map<string, CacheLoadResult<TFields>>();
|
||||
for (let i = 0; i < keys.length; i++) {
|
||||
const key = keys[i]!;
|
||||
const redisResult = redisResults[i];
|
||||
@@ -52,7 +63,11 @@ export default class GenericRedisCacher {
|
||||
} else if (redisResult) {
|
||||
results.set(key, {
|
||||
status: CacheStatus.HIT,
|
||||
item: JSON.parse(redisResult),
|
||||
item: transformCacheObjectToFields(
|
||||
this.entityConfiguration,
|
||||
redisTransformerMap,
|
||||
JSON.parse(redisResult)
|
||||
),
|
||||
});
|
||||
} else {
|
||||
results.set(key, {
|
||||
@@ -63,7 +78,7 @@ export default class GenericRedisCacher {
|
||||
return results;
|
||||
}
|
||||
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, object>): Promise<void> {
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void> {
|
||||
if (objectMap.size === 0) {
|
||||
return;
|
||||
}
|
||||
@@ -72,7 +87,9 @@ export default class GenericRedisCacher {
|
||||
objectMap.forEach((object, key) => {
|
||||
redisTransaction = redisTransaction.set(
|
||||
key,
|
||||
JSON.stringify(object),
|
||||
JSON.stringify(
|
||||
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
|
||||
),
|
||||
'EX',
|
||||
this.context.ttlSecondsPositive
|
||||
);
|
||||
@@ -80,7 +97,7 @@ export default class GenericRedisCacher {
|
||||
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync(keys: string[]): Promise<void> {
|
||||
public async cacheDBMissesAsync(keys: readonly string[]): Promise<void> {
|
||||
if (keys.length === 0) {
|
||||
return;
|
||||
}
|
||||
@@ -97,7 +114,7 @@ export default class GenericRedisCacher {
|
||||
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
||||
}
|
||||
|
||||
public async invalidateManyAsync(keys: string[]): Promise<void> {
|
||||
public async invalidateManyAsync(keys: readonly string[]): Promise<void> {
|
||||
if (keys.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -1,15 +1,8 @@
|
||||
import {
|
||||
EntityCacheAdapter,
|
||||
EntityConfiguration,
|
||||
CacheLoadResult,
|
||||
FieldTransformerMap,
|
||||
mapKeys,
|
||||
} from '@expo/entity';
|
||||
import { EntityCacheAdapter, EntityConfiguration, CacheLoadResult, mapKeys } from '@expo/entity';
|
||||
import invariant from 'invariant';
|
||||
import { Redis } from 'ioredis';
|
||||
|
||||
import GenericRedisCacher from './GenericRedisCacher';
|
||||
import { redisTransformerMap } from './RedisCommon';
|
||||
|
||||
export interface RedisCacheAdapterContext {
|
||||
/**
|
||||
@@ -49,28 +42,27 @@ export interface RedisCacheAdapterContext {
|
||||
}
|
||||
|
||||
export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
|
||||
private readonly genericRedisCacher: GenericRedisCacher;
|
||||
private readonly genericRedisCacher: GenericRedisCacher<TFields>;
|
||||
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 {
|
||||
return redisTransformerMap;
|
||||
this.genericRedisCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: context.redisClient,
|
||||
ttlSecondsNegative: context.ttlSecondsNegative,
|
||||
ttlSecondsPositive: context.ttlSecondsPositive,
|
||||
},
|
||||
entityConfiguration
|
||||
);
|
||||
}
|
||||
|
||||
public async loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult>> {
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>> {
|
||||
const redisCacheKeyToFieldValueMapping = new Map(
|
||||
fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue])
|
||||
);
|
||||
@@ -91,7 +83,7 @@ export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFiel
|
||||
|
||||
public async cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, object>
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>
|
||||
): Promise<void> {
|
||||
await this.genericRedisCacher.cacheManyAsync(
|
||||
mapKeys(objectMap, (fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
|
||||
+125
@@ -0,0 +1,125 @@
|
||||
import { CacheStatus, ViewerContext } from '@expo/entity';
|
||||
import Redis from 'ioredis';
|
||||
import { URL } from 'url';
|
||||
|
||||
import GenericRedisCacher from '../GenericRedisCacher';
|
||||
import { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||
import RedisTestEntity, {
|
||||
redisTestEntityConfiguration,
|
||||
RedisTestEntityFields,
|
||||
} from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(GenericRedisCacher, () => {
|
||||
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();
|
||||
});
|
||||
afterAll(async () => {
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
it('has correct caching and loading behavior', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const genericRedisCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: redisCacheAdapterContext.redisClient,
|
||||
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||
},
|
||||
redisTestEntityConfiguration
|
||||
);
|
||||
const date = new Date();
|
||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
const testKey = `test-id-key-${entity1Created.getID()}`;
|
||||
const objectMap = new Map<string, Readonly<RedisTestEntityFields>>([
|
||||
[testKey, entity1Created.getAllFields()],
|
||||
]);
|
||||
await genericRedisCacher.cacheManyAsync(objectMap);
|
||||
|
||||
const cachedJSON = await redisCacheAdapterContext.redisClient.get(testKey);
|
||||
const cachedValue = JSON.parse(cachedJSON!);
|
||||
expect(cachedValue).toMatchObject({
|
||||
id: entity1Created.getID(),
|
||||
dateField: date.toISOString(),
|
||||
});
|
||||
|
||||
const loadedObjectMap = await genericRedisCacher.loadManyAsync([testKey]);
|
||||
const cacheLoadResult = loadedObjectMap.get(testKey)!;
|
||||
expect(cacheLoadResult).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: entity1Created.getAllFields(),
|
||||
});
|
||||
expect(loadedObjectMap.size).toBe(1);
|
||||
});
|
||||
it('has correct negative caching behaviour', async () => {
|
||||
const genericRedisCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: redisCacheAdapterContext.redisClient,
|
||||
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||
},
|
||||
redisTestEntityConfiguration
|
||||
);
|
||||
|
||||
const testKey = `test-id-key-non-existent-id`;
|
||||
await genericRedisCacher.cacheDBMissesAsync([testKey]);
|
||||
const loadedObjectMap = await genericRedisCacher.loadManyAsync([testKey]);
|
||||
const cacheLoadResult = loadedObjectMap.get(testKey)!;
|
||||
expect(cacheLoadResult.status).toBe(CacheStatus.NEGATIVE);
|
||||
});
|
||||
it('has correct invalidation behaviour', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const genericRedisCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: redisCacheAdapterContext.redisClient,
|
||||
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||
},
|
||||
redisTestEntityConfiguration
|
||||
);
|
||||
const date = new Date();
|
||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
const testKey = `test-id-key-${entity1Created.getID()}`;
|
||||
const objectMap = new Map<string, Readonly<RedisTestEntityFields>>([
|
||||
[testKey, entity1Created.getAllFields()],
|
||||
]);
|
||||
await genericRedisCacher.cacheManyAsync(objectMap);
|
||||
|
||||
await genericRedisCacher.invalidateManyAsync([testKey]);
|
||||
|
||||
const loadedObjectMap = await genericRedisCacher.loadManyAsync([testKey]);
|
||||
const cacheLoadResult = loadedObjectMap.get(testKey)!;
|
||||
expect(cacheLoadResult.status).toBe(CacheStatus.MISS);
|
||||
});
|
||||
});
|
||||
+10
-13
@@ -52,9 +52,9 @@ describe(RedisCacheAdapter, () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
const entity1 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
const entity1 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
entity1Created.getID()
|
||||
);
|
||||
|
||||
const cachedJSON = await redisCacheAdapterContext.redisClient.get(
|
||||
cacheKeyMaker('id', entity1.getID())
|
||||
@@ -102,16 +102,14 @@ describe(RedisCacheAdapter, () => {
|
||||
);
|
||||
expect(entity1.getField('dateField')).toEqual(date);
|
||||
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1.getID());
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(entity1.getID());
|
||||
expect(entity2.getField('dateField')).toEqual(date);
|
||||
|
||||
// simulate new request
|
||||
const vc2 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
|
||||
const entity3 = await RedisTestEntity.loader(vc2).loadByIDAsync(entity1.getID());
|
||||
expect(entity3.getField('dateField')).toEqual(date);
|
||||
});
|
||||
|
||||
@@ -122,18 +120,17 @@ describe(RedisCacheAdapter, () => {
|
||||
const entity1 = await enforceAsyncResult(
|
||||
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
|
||||
);
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', '');
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'name',
|
||||
''
|
||||
);
|
||||
expect(entity2?.getID()).toEqual(entity1.getID());
|
||||
|
||||
// simulate new request
|
||||
const vc2 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity3 = await RedisTestEntity.loader(vc2)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', '');
|
||||
const entity3 = await RedisTestEntity.loader(vc2).loadByFieldEqualingAsync('name', '');
|
||||
expect(entity3?.getID()).toEqual(entity1.getID());
|
||||
});
|
||||
});
|
||||
@@ -3,6 +3,95 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Upgrade knex to 1.x in `@expo/entity-database-adapter-knex` ([#150](https://github.com/expo/entity/issues/150)) ([e1b0ee5](https://github.com/expo/entity/commit/e1b0ee528175646239d88aa71ffce73983eeb52f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-database-adapter-knex",
|
||||
"version": "0.18.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Knex database adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -30,9 +30,10 @@
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"knex": "^0.95.6"
|
||||
"knex": "^1.0.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.18.0"
|
||||
"@expo/entity": "^0.25.3",
|
||||
"pg": "^8.7.1"
|
||||
}
|
||||
}
|
||||
+119
-111
@@ -50,9 +50,7 @@ describe('postgres entity integration', () => {
|
||||
PostgresTestEntity.updater(entity).setField('hasADog', false).updateAsync(),
|
||||
]);
|
||||
|
||||
const loadedEntity = await PostgresTestEntity.loader(vc)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity.getID());
|
||||
const loadedEntity = await PostgresTestEntity.loader(vc).loadByIDAsync(entity.getID());
|
||||
|
||||
expect(loadedEntity.getField('hasACat')).toBe(true);
|
||||
expect(loadedEntity.getField('hasADog')).toBe(false);
|
||||
@@ -185,26 +183,22 @@ describe('postgres entity integration', () => {
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{
|
||||
fieldName: 'hasACat',
|
||||
fieldValue: false,
|
||||
},
|
||||
{
|
||||
fieldName: 'hasADog',
|
||||
fieldValue: true,
|
||||
},
|
||||
]);
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync([
|
||||
{
|
||||
fieldName: 'hasACat',
|
||||
fieldValue: false,
|
||||
},
|
||||
{
|
||||
fieldName: 'hasADog',
|
||||
fieldValue: true,
|
||||
},
|
||||
]);
|
||||
|
||||
expect(results).toHaveLength(2);
|
||||
|
||||
const results2 = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'hasADog', fieldValues: [true, false] },
|
||||
]);
|
||||
const results2 = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
|
||||
[{ fieldName: 'hasADog', fieldValues: [true, false] }]
|
||||
);
|
||||
expect(results2).toHaveLength(3);
|
||||
});
|
||||
|
||||
@@ -217,9 +211,9 @@ describe('postgres entity integration', () => {
|
||||
|
||||
await enforceAsyncResult(PostgresTestEntity.creator(vc1).setField('name', 'c').createAsync());
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([], {
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
|
||||
[],
|
||||
{
|
||||
limit: 2,
|
||||
offset: 1,
|
||||
orderBy: [
|
||||
@@ -228,7 +222,8 @@ describe('postgres entity integration', () => {
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
});
|
||||
}
|
||||
);
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results.map((e) => e.getField('name'))).toEqual(['b', 'a']);
|
||||
});
|
||||
@@ -260,28 +255,26 @@ describe('postgres entity integration', () => {
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([{ fieldName: 'name', fieldValue: null }]);
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'name', fieldValue: null },
|
||||
]);
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results[0]!.getField('name')).toBeNull();
|
||||
|
||||
const results2 = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync(
|
||||
[
|
||||
{ fieldName: 'name', fieldValues: ['a', null] },
|
||||
{ fieldName: 'hasADog', fieldValue: true },
|
||||
const results2 = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
|
||||
[
|
||||
{ fieldName: 'name', fieldValues: ['a', null] },
|
||||
{ fieldName: 'hasADog', fieldValue: true },
|
||||
],
|
||||
{
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
{
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
}
|
||||
);
|
||||
}
|
||||
);
|
||||
expect(results2).toHaveLength(2);
|
||||
expect(results2.map((e) => e.getField('name'))).toEqual([null, 'a']);
|
||||
});
|
||||
@@ -298,9 +291,10 @@ describe('postgres entity integration', () => {
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('name = ?', ['hello']);
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync(
|
||||
'name = ?',
|
||||
['hello']
|
||||
);
|
||||
|
||||
expect(results).toHaveLength(1);
|
||||
});
|
||||
@@ -316,9 +310,9 @@ describe('postgres entity integration', () => {
|
||||
);
|
||||
|
||||
await expect(
|
||||
PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('invalid_column = ?', ['hello'])
|
||||
PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync('invalid_column = ?', [
|
||||
'hello',
|
||||
])
|
||||
).rejects.toThrow();
|
||||
});
|
||||
|
||||
@@ -346,9 +340,10 @@ describe('postgres entity integration', () => {
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
|
||||
const results = await PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync(
|
||||
'has_a_dog = ?',
|
||||
[true],
|
||||
{
|
||||
limit: 2,
|
||||
offset: 1,
|
||||
orderBy: [
|
||||
@@ -357,25 +352,26 @@ describe('postgres entity integration', () => {
|
||||
order: OrderByOrdering.ASCENDING,
|
||||
},
|
||||
],
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results.map((e) => e.getField('name'))).toEqual(['b', 'c']);
|
||||
|
||||
const resultsMultipleOrderBy = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'hasADog',
|
||||
order: OrderByOrdering.ASCENDING,
|
||||
},
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
});
|
||||
const resultsMultipleOrderBy = await PostgresTestEntity.loader(
|
||||
vc1
|
||||
).loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'hasADog',
|
||||
order: OrderByOrdering.ASCENDING,
|
||||
},
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
expect(resultsMultipleOrderBy).toHaveLength(3);
|
||||
expect(resultsMultipleOrderBy.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
|
||||
@@ -395,9 +391,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeCreate');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeCreate')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeCreate')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -406,27 +400,21 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterCreate');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterCreate')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterCreate')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.creator(vc1).setField('name', 'beforeAll').enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeAll');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeAll')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeAll')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.creator(vc1).setField('name', 'afterAll').enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterAll');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterAll')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterAll')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -435,9 +423,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterCommit');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterCommit')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterCommit')
|
||||
).resolves.not.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -458,9 +444,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeUpdate');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeUpdate')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeUpdate')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -469,9 +453,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterUpdate');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterUpdate')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterUpdate')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -480,9 +462,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeAll');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeAll')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeAll')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -491,9 +471,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterAll');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterAll')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterAll')
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
@@ -502,9 +480,7 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value afterCommit');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterCommit')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterCommit')
|
||||
).resolves.not.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -522,9 +498,7 @@ describe('postgres entity integration', () => {
|
||||
PostgresTriggerTestEntity.enforceDeleteAsync(entityBeforeDelete)
|
||||
).rejects.toThrowError('name cannot have value beforeDelete');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeDelete')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeDelete')
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
const entityAfterDelete = await PostgresTriggerTestEntity.creator(vc1)
|
||||
@@ -534,9 +508,7 @@ describe('postgres entity integration', () => {
|
||||
PostgresTriggerTestEntity.enforceDeleteAsync(entityAfterDelete)
|
||||
).rejects.toThrowError('name cannot have value afterDelete');
|
||||
await expect(
|
||||
PostgresTriggerTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'afterDelete')
|
||||
PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterDelete')
|
||||
).resolves.not.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -553,9 +525,10 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
|
||||
await expect(
|
||||
PostgresValidatorTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate')
|
||||
PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
|
||||
'name',
|
||||
'beforeCreateAndBeforeUpdate'
|
||||
)
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -575,9 +548,10 @@ describe('postgres entity integration', () => {
|
||||
.enforceUpdateAsync()
|
||||
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
|
||||
await expect(
|
||||
PostgresValidatorTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate')
|
||||
PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
|
||||
'name',
|
||||
'beforeCreateAndBeforeUpdate'
|
||||
)
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -592,12 +566,46 @@ describe('postgres entity integration', () => {
|
||||
.enforceCreateAsync();
|
||||
await PostgresValidatorTestEntity.enforceDeleteAsync(entityToDelete);
|
||||
await expect(
|
||||
PostgresValidatorTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', 'shouldBeDeleted')
|
||||
PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
|
||||
'name',
|
||||
'shouldBeDeleted'
|
||||
)
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('queryContext callback behavior', () => {
|
||||
it('calls callbacks correctly', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
let preCommitCallCount = 0;
|
||||
let postCommitCallCount = 0;
|
||||
|
||||
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
queryContext.appendPostCommitCallback(async () => {
|
||||
postCommitCallCount++;
|
||||
});
|
||||
queryContext.appendPreCommitCallback(async () => {
|
||||
preCommitCallCount++;
|
||||
}, 0);
|
||||
});
|
||||
|
||||
await expect(
|
||||
vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
queryContext.appendPostCommitCallback(async () => {
|
||||
postCommitCallCount++;
|
||||
});
|
||||
queryContext.appendPreCommitCallback(async () => {
|
||||
preCommitCallCount++;
|
||||
throw Error('wat');
|
||||
}, 0);
|
||||
})
|
||||
).rejects.toThrowError('wat');
|
||||
|
||||
expect(preCommitCallCount).toBe(2);
|
||||
expect(postCommitCallCount).toBe(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -60,7 +60,7 @@ describe('postgres errors', () => {
|
||||
const vc2 = new ViewerContext(
|
||||
createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance)
|
||||
);
|
||||
await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow(
|
||||
await expect(ErrorsTestEntity.loader(vc2).loadByIDAsync(1)).rejects.toThrow(
|
||||
EntityDatabaseAdapterTransientError
|
||||
);
|
||||
await shortTimeoutKnexInstance.destroy();
|
||||
|
||||
@@ -10,7 +10,7 @@ import {
|
||||
EntityMutationTrigger,
|
||||
EntityQueryContext,
|
||||
EntityNonTransactionalMutationTrigger,
|
||||
EntityMutationInfo,
|
||||
EntityTriggerMutationInfo,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
@@ -111,7 +111,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
entity: PostgresTriggerTestEntity,
|
||||
_mutationInfo: EntityMutationInfo<
|
||||
_mutationInfo: EntityTriggerMutationInfo<
|
||||
PostgresTriggerTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
|
||||
+2
-2
@@ -9,7 +9,7 @@ import {
|
||||
Entity,
|
||||
EntityMutationTrigger,
|
||||
EntityQueryContext,
|
||||
EntityMutationInfo,
|
||||
EntityValidatorMutationInfo,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
@@ -113,7 +113,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
entity: PostgresValidatorTestEntity,
|
||||
_mutationInfo: EntityMutationInfo<
|
||||
_mutationInfo: EntityValidatorMutationInfo<
|
||||
PostgresValidatorTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
|
||||
@@ -3,6 +3,89 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* privacy policy evaluation context ([#162](https://github.com/expo/entity/issues/162)) ([3a81a4c](https://github.com/expo/entity/commit/3a81a4c059e2e995eb800e35e76b3d432c22b23f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@expo/entity-example",
|
||||
"private": true,
|
||||
"version": "0.18.0",
|
||||
"version": "0.25.3",
|
||||
"description": "An example integration of the @expo/entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
@@ -23,7 +23,7 @@
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@expo/entity": "^0.18.0",
|
||||
"@expo/entity": "^0.25.3",
|
||||
"apollo-server-koa": "^2.16.1",
|
||||
"graphql": "^15.3.0",
|
||||
"koa": "^2.13.0",
|
||||
|
||||
@@ -3,6 +3,7 @@ import {
|
||||
ReadonlyEntity,
|
||||
EntityQueryContext,
|
||||
RuleEvaluationResult,
|
||||
EntityPrivacyPolicyEvaluationContext,
|
||||
} from '@expo/entity';
|
||||
|
||||
import { ExampleViewerContext } from '../viewerContexts';
|
||||
@@ -34,6 +35,7 @@ export default class AllowIfUserOwnerPrivacyRule<
|
||||
async evaluateAsync(
|
||||
viewerContext: ExampleViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: TEntity
|
||||
): Promise<RuleEvaluationResult> {
|
||||
if (viewerContext.isUserViewerContext()) {
|
||||
|
||||
@@ -19,9 +19,10 @@ router.get('/', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
let notes: readonly NoteEntity[] = [];
|
||||
if (viewerContext.isUserViewerContext()) {
|
||||
notes = await NoteEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualingAsync('userID', viewerContext.userID);
|
||||
notes = await NoteEntity.loader(viewerContext).loadManyByFieldEqualingAsync(
|
||||
'userID',
|
||||
viewerContext.userID
|
||||
);
|
||||
}
|
||||
ctx.body = {
|
||||
notes: notes.map((note) => note.getAllFields()),
|
||||
|
||||
@@ -46,16 +46,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
||||
return viewerContext.userID;
|
||||
},
|
||||
async noteByID(_root, args, { viewerContext }) {
|
||||
return await NoteEntity.loader(viewerContext).enforcing().loadByIDAsync(args.id);
|
||||
return await NoteEntity.loader(viewerContext).loadByIDAsync(args.id);
|
||||
},
|
||||
} as IResolverObject<any, GraphqlContext>,
|
||||
|
||||
User: {
|
||||
id: (root) => root,
|
||||
async notes(root, _args, { viewerContext }) {
|
||||
return await NoteEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualingAsync('userID', root);
|
||||
return await NoteEntity.loader(viewerContext).loadManyByFieldEqualingAsync('userID', root);
|
||||
},
|
||||
} as IResolverObject<string, GraphqlContext>,
|
||||
|
||||
@@ -79,18 +77,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
||||
.enforceCreateAsync();
|
||||
},
|
||||
async updateNote(_root, args, { viewerContext }) {
|
||||
const existingNote = await NoteEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(args.id);
|
||||
const existingNote = await NoteEntity.loader(viewerContext).loadByIDAsync(args.id);
|
||||
return await NoteEntity.updater(existingNote)
|
||||
.setField('title', args.note.title)
|
||||
.setField('body', args.note.body)
|
||||
.enforceUpdateAsync();
|
||||
},
|
||||
async deleteNote(_root, args, { viewerContext }) {
|
||||
const existingNote = await NoteEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(args.id);
|
||||
const existingNote = await NoteEntity.loader(viewerContext).loadByIDAsync(args.id);
|
||||
await NoteEntity.enforceDeleteAsync(existingNote);
|
||||
return existingNote;
|
||||
},
|
||||
|
||||
@@ -3,6 +3,86 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@expo/entity-full-integration-tests",
|
||||
"private": true,
|
||||
"version": "0.18.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Full redis and knex integration tests for the entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
@@ -27,8 +27,8 @@
|
||||
"@expo/entity-database-adapter-knex": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.18.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.18.0",
|
||||
"@expo/entity-database-adapter-knex": "^0.18.0"
|
||||
"@expo/entity": "^0.25.3",
|
||||
"@expo/entity-cache-adapter-redis": "^0.25.3",
|
||||
"@expo/entity-database-adapter-knex": "^0.25.3"
|
||||
}
|
||||
}
|
||||
+8
-11
@@ -153,10 +153,8 @@ describe('Entity cache inconsistency', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
// put entities in cache and dataloader
|
||||
await TestEntity.loader(viewerContext).enforcing().loadByIDAsync(entity1.getID());
|
||||
await TestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('other_string', 'hello');
|
||||
await TestEntity.loader(viewerContext).loadByIDAsync(entity1.getID());
|
||||
await TestEntity.loader(viewerContext).loadByFieldEqualingAsync('other_string', 'hello');
|
||||
|
||||
let openBarrier1: () => void;
|
||||
const barrier1 = new Promise<void>((resolve) => {
|
||||
@@ -179,7 +177,7 @@ describe('Entity cache inconsistency', () => {
|
||||
const viewerContextInternal = new ViewerContext(
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
await TestEntity.loader(viewerContextInternal).enforcing().loadByIDAsync(entity1.getID());
|
||||
await TestEntity.loader(viewerContextInternal).loadByIDAsync(entity1.getID());
|
||||
|
||||
openBarrier2!();
|
||||
})(),
|
||||
@@ -203,12 +201,11 @@ describe('Entity cache inconsistency', () => {
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const loadedById = await TestEntity.loader(viewerContextLast)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1.getID());
|
||||
const loadedByField = await TestEntity.loader(viewerContextLast)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('other_string', 'hello');
|
||||
const loadedById = await TestEntity.loader(viewerContextLast).loadByIDAsync(entity1.getID());
|
||||
const loadedByField = await TestEntity.loader(viewerContextLast).loadByFieldEqualingAsync(
|
||||
'other_string',
|
||||
'hello'
|
||||
);
|
||||
|
||||
expect(loadedById.getField('third_string')).toEqual('updated');
|
||||
expect(loadedByField!.getField('third_string')).toEqual('updated');
|
||||
|
||||
+4
-6
@@ -87,22 +87,20 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_id', parent.getID())
|
||||
ChildEntity.loader(viewerContext).loadByFieldEqualingAsync('parent_id', parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
await ParentEntity.enforceDeleteAsync(parent);
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.toBeNull();
|
||||
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
+6
-6
@@ -224,18 +224,18 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL) {
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(category1.getID())
|
||||
).resolves.toBeNull();
|
||||
const otherLoaded = await OtherEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDNullableAsync(other1.getID());
|
||||
const otherLoaded = await OtherEntity.loader(viewerContext).loadByIDNullableAsync(
|
||||
other1.getID()
|
||||
);
|
||||
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
|
||||
} else {
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(category1.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
OtherEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(other1.getID())
|
||||
OtherEntity.loader(viewerContext).loadByIDNullableAsync(other1.getID())
|
||||
).resolves.toBeNull();
|
||||
}
|
||||
});
|
||||
|
||||
@@ -0,0 +1,98 @@
|
||||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add IP support ([#138](https://github.com/expo/entity/issues/138)) ([1405a91](https://github.com/expo/entity/commit/1405a9126ee3a56c3e2a38bf3b697283744f5b5d))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* lands @expo/entity-ip-address-field ([#138](https://github.com/expo/entity/pull/138))
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* expose describeFieldTestCase for use in other packages ([#139](https://github.com/expo/entity/issues/139)) ([1220477](https://github.com/expo/entity/commit/1220477aa331349b482ad015b44f76fa2bda7b90))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
* use better QueryContext types for transactional triggers and validators ([#136](https://github.com/expo/entity/issues/136)) ([5c7efe1](https://github.com/expo/entity/commit/5c7efe1678424ff907687e9327175bdc2538c3e0))
|
||||
@@ -0,0 +1,3 @@
|
||||
# @expo/entity-ip-address-field
|
||||
|
||||
A package containing the IP address EntityField definitions for @expo/entity. Supports addresses with either IPv4 or IPv6 syntax.
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"name": "@expo/entity-ip-address-field",
|
||||
"version": "0.25.3",
|
||||
"description": "IP address EntityField definitions for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
"src"
|
||||
],
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
],
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"ip-address": "^8.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.25.3",
|
||||
"@types/jsbn": "^1.2.29"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
import { EntityFieldDefinition } from '@expo/entity';
|
||||
import { Address4, Address6 } from 'ip-address';
|
||||
|
||||
export class IPAddressField extends EntityFieldDefinition<string> {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return Address4.isValid(value) || Address6.isValid(value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
import { describeFieldTestCase } from '@expo/entity';
|
||||
|
||||
import { IPAddressField } from '../EntityFields';
|
||||
|
||||
describeFieldTestCase(
|
||||
new IPAddressField({ columnName: 'wat' }),
|
||||
[
|
||||
'192.168.1.1',
|
||||
'198.24.10.0/24',
|
||||
'10.0.0.0',
|
||||
'0:1:2:3:4:5:6:7',
|
||||
'1:2:3:4:5:6:7:8/64',
|
||||
'fedc:ba98:7654:3210:fedc:ba98:7654:3210',
|
||||
],
|
||||
['', 'abs', '0.0.0.x/0', '123.21.23', '1:2:3:4:5:6', '198.10/8']
|
||||
);
|
||||
@@ -0,0 +1,7 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-ip-address-field
|
||||
*/
|
||||
|
||||
export * from './EntityFields';
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
@@ -0,0 +1,24 @@
|
||||
# `@expo/entity-secondary-cache-local-memory`
|
||||
|
||||
Cross-request [LRU](https://github.com/isaacs/node-lru-cache) secondary cache for `@expo/entity`. Use
|
||||
this cache with caution - it is nonstandard. The cache is shared between requests in the node process.
|
||||
|
||||
[Documentation](https://expo.github.io/entity/modules/_expo_secondary_cache_local_memory.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 `LocalMemorySecondaryEntityCache`.
|
||||
```typescript
|
||||
const secondaryCacheLoader = new TestSecondaryLocalMemoryCacheLoader(
|
||||
new LocalMemorySecondaryEntityCache(
|
||||
GenericLocalMemoryCacher.createLRUCache<LocalMemoryTestEntityFields>({})
|
||||
),
|
||||
LocalMemoryTestEntity.loader(viewerContext)
|
||||
);
|
||||
```
|
||||
3. Load entities through it:
|
||||
```typescript
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
```
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"name": "@expo/entity-secondary-cache-local-memory",
|
||||
"version": "0.25.3",
|
||||
"description": "Local memory secondary cache for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
"src"
|
||||
],
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
],
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*",
|
||||
"@expo/entity-cache-adapter-local-memory": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.25.3",
|
||||
"@expo/entity-cache-adapter-local-memory": "^0.25.3",
|
||||
"nullthrows": "^1.1.1"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
import { GenericSecondaryEntityCache } from '@expo/entity';
|
||||
import {
|
||||
GenericLocalMemoryCacher,
|
||||
LocalMemoryCache,
|
||||
} from '@expo/entity-cache-adapter-local-memory';
|
||||
|
||||
/**
|
||||
* A local memory {@link GenericSecondaryEntityCache}.
|
||||
*
|
||||
* @remarks
|
||||
*
|
||||
* TLoadParams must be JSON stringifyable.
|
||||
*/
|
||||
export default class LocalMemorySecondaryEntityCache<
|
||||
TFields,
|
||||
TLoadParams
|
||||
> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
|
||||
constructor(localMemoryCache: LocalMemoryCache<TFields>) {
|
||||
super(new GenericLocalMemoryCacher(localMemoryCache), (params) => JSON.stringify(params));
|
||||
}
|
||||
}
|
||||
+226
@@ -0,0 +1,226 @@
|
||||
import {
|
||||
EntitySecondaryCacheLoader,
|
||||
mapMapAsync,
|
||||
ViewerContext,
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
GenericLocalMemoryCacher,
|
||||
LocalMemoryCacheAdapterProvider,
|
||||
} from '@expo/entity-cache-adapter-local-memory';
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import LocalMemorySecondaryEntityCache from '../LocalMemorySecondaryEntityCache';
|
||||
|
||||
export type LocalMemoryTestEntityFields = {
|
||||
id: string;
|
||||
name: string;
|
||||
};
|
||||
|
||||
export default class LocalMemoryTestEntity extends Entity<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext
|
||||
> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntityPrivacyPolicy
|
||||
> {
|
||||
return localMemoryTestEntityCompanionDefinition;
|
||||
}
|
||||
}
|
||||
|
||||
export class LocalMemoryTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const localMemoryTestEntityConfiguration =
|
||||
new EntityConfiguration<LocalMemoryTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'local_memory_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'local-memory',
|
||||
});
|
||||
|
||||
const localMemoryTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: LocalMemoryTestEntity,
|
||||
entityConfiguration: localMemoryTestEntityConfiguration,
|
||||
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
|
||||
});
|
||||
|
||||
export const createTestEntityCompanionProvider = (
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'local-memory',
|
||||
{
|
||||
cacheAdapterProvider: LocalMemoryCacheAdapterProvider.getProvider(),
|
||||
},
|
||||
],
|
||||
])
|
||||
);
|
||||
};
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
type TestLoadParams = { id: string };
|
||||
|
||||
const FAKE_ID = 'fake';
|
||||
|
||||
class TestSecondaryLocalMemoryCacheLoader extends EntitySecondaryCacheLoader<
|
||||
TestLoadParams,
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntityPrivacyPolicy
|
||||
> {
|
||||
public databaseLoadCount = 0;
|
||||
|
||||
protected async fetchObjectsFromDatabaseAsync(
|
||||
loadParamsArray: readonly Readonly<TestLoadParams>[]
|
||||
): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<LocalMemoryTestEntityFields> | null>> {
|
||||
this.databaseLoadCount += loadParamsArray.length;
|
||||
|
||||
const emptyMap = new Map(loadParamsArray.map((p) => [p, null]));
|
||||
return await mapMapAsync(emptyMap, async (_value, loadParams) => {
|
||||
if (loadParams.id === FAKE_ID) {
|
||||
return null;
|
||||
}
|
||||
return nullthrows(
|
||||
(
|
||||
await this.entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
)[0]
|
||||
).getAllFields();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
describe(LocalMemorySecondaryEntityCache, () => {
|
||||
it('Loads through secondary loader, caches, and invalidates', async () => {
|
||||
const viewerContext = new TestViewerContext(createTestEntityCompanionProvider());
|
||||
|
||||
const createdEntity = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'wat')
|
||||
.enforceCreateAsync();
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryLocalMemoryCacheLoader(
|
||||
new LocalMemorySecondaryEntityCache(
|
||||
GenericLocalMemoryCacher.createLRUCache<LocalMemoryTestEntityFields>({})
|
||||
),
|
||||
LocalMemoryTestEntity.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(createTestEntityCompanionProvider());
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryLocalMemoryCacheLoader(
|
||||
new LocalMemorySecondaryEntityCache(
|
||||
GenericLocalMemoryCacher.createLRUCache<LocalMemoryTestEntityFields>({})
|
||||
),
|
||||
LocalMemoryTestEntity.loader(viewerContext)
|
||||
);
|
||||
|
||||
const loadParams = { id: FAKE_ID };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(results.size).toBe(1);
|
||||
expect(results.get(loadParams)).toBe(null);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,7 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-secondary-cache-local-memory
|
||||
*/
|
||||
|
||||
export { default as LocalMemorySecondaryEntityCache } from './LocalMemorySecondaryEntityCache';
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -3,6 +3,91 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
### Chores
|
||||
|
||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
### Chores
|
||||
|
||||
* Move data transforming responsibilities to the CacheAdapter instead of the RedisSecondaryEntityCache. ([#153](https://github.com/expo/entity/pull/153))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-secondary-cache-redis",
|
||||
"version": "0.18.0",
|
||||
"version": "0.25.3",
|
||||
"description": "Redis secondary cache for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -34,8 +34,8 @@
|
||||
"ioredis": "^4.17.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.18.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.18.0",
|
||||
"@expo/entity": "^0.25.3",
|
||||
"@expo/entity-cache-adapter-redis": "^0.25.3",
|
||||
"nullthrows": "^1.1.1"
|
||||
}
|
||||
}
|
||||
@@ -1,136 +1,18 @@
|
||||
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';
|
||||
import { EntityConfiguration, GenericSecondaryEntityCache } from '@expo/entity';
|
||||
import { GenericRedisCacheContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* A redis {@link GenericSecondaryEntityCache}.
|
||||
*/
|
||||
export default class RedisSecondaryEntityCache<TFields, TLoadParams>
|
||||
implements ISecondaryEntityCache<TFields, TLoadParams>
|
||||
{
|
||||
private readonly genericRedisCacher: GenericRedisCacher;
|
||||
|
||||
export default class RedisSecondaryEntityCache<
|
||||
TFields,
|
||||
TLoadParams
|
||||
> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
|
||||
constructor(
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
genericRedisCacheContext: GenericRedisCacheContext,
|
||||
private readonly constructRedisKey: (params: Readonly<TLoadParams>) => string
|
||||
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));
|
||||
super(new GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
|
||||
}
|
||||
}
|
||||
+3
-5
@@ -40,11 +40,9 @@ class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
|
||||
}
|
||||
return nullthrows(
|
||||
(
|
||||
await this.entityLoader
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
await this.entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
)[0]
|
||||
).getAllFields();
|
||||
});
|
||||
|
||||
@@ -3,6 +3,112 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add composed cache to index ([#166](https://github.com/expo/entity/issues/166)) ([5c82edc](https://github.com/expo/entity/commit/5c82edcd9f26854878d29950a05852e117bbd723))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
* privacy policy evaluation context ([#162](https://github.com/expo/entity/issues/162)) ([3a81a4c](https://github.com/expo/entity/commit/3a81a4c059e2e995eb800e35e76b3d432c22b23f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Chores
|
||||
|
||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
### Breaking changes
|
||||
|
||||
* Move data transforming responsibilities to the CacheAdapter instead of the ReadThroughEntityCache. Affects any classes extending the EntityCacheAdapter and relying on the transformation behavior of the ReadThroughEntityCache. ([#153](https://github.com/expo/entity/pull/153))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* separate post-commit invalidation callbacks from trigger and user callbacks ([#144](https://github.com/expo/entity/issues/144)) ([efa131e](https://github.com/expo/entity/commit/efa131ef29532accf0e51b6d867ffe15a27b4c90))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add authorization metrics ([#142](https://github.com/expo/entity/issues/142)) ([7cf54d8](https://github.com/expo/entity/commit/7cf54d83c52e104159a3e2e675cdda2d29afe204))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity",
|
||||
"version": "0.18.0",
|
||||
"version": "0.25.3",
|
||||
"description": "A privacy-first data model",
|
||||
"files": [
|
||||
"build",
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import EntityCacheAdapter from './EntityCacheAdapter';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import { CacheStatus, CacheLoadResult } from './internal/ReadThroughEntityCache';
|
||||
|
||||
export default class ComposedEntityCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
|
||||
/**
|
||||
* A {@link EntityCacheAdapter} that composes other {@link EntityCacheAdapter} instances.
|
||||
*
|
||||
* @param entityConfiguration - configuration for entity being loaded
|
||||
* @param cacheAdapters - list of cache adapters to compose in order of precedence.
|
||||
* Earlier cache adapters are read from first and written to (including invalidations) last.
|
||||
* Typically, caches closer to the application should be ordered before caches closer to the database.
|
||||
*/
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly cacheAdapters: EntityCacheAdapter<TFields>[]
|
||||
) {
|
||||
super(entityConfiguration);
|
||||
}
|
||||
|
||||
public async loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>> {
|
||||
const retMap = new Map<NonNullable<TFields[N]>, CacheLoadResult<TFields>>();
|
||||
|
||||
let unfulfilledFieldValues = fieldValues;
|
||||
for (const cacheAdapter of this.cacheAdapters) {
|
||||
const cacheResultsFromAdapter = await cacheAdapter.loadManyAsync(
|
||||
fieldName,
|
||||
unfulfilledFieldValues
|
||||
);
|
||||
|
||||
const newUnfulfilledFieldValues = [];
|
||||
for (const [fieldValue, cacheResult] of cacheResultsFromAdapter) {
|
||||
if (cacheResult.status === CacheStatus.MISS) {
|
||||
newUnfulfilledFieldValues.push(fieldValue);
|
||||
} else {
|
||||
retMap.set(fieldValue, cacheResult);
|
||||
}
|
||||
}
|
||||
unfulfilledFieldValues = newUnfulfilledFieldValues;
|
||||
}
|
||||
|
||||
for (const fieldValue of unfulfilledFieldValues) {
|
||||
retMap.set(fieldValue, { status: CacheStatus.MISS });
|
||||
}
|
||||
|
||||
return retMap;
|
||||
}
|
||||
|
||||
public async cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>
|
||||
): Promise<void> {
|
||||
// write to lower layers first
|
||||
for (let i = this.cacheAdapters.length - 1; i >= 0; i--) {
|
||||
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
|
||||
await cacheAdapter.cacheManyAsync(fieldName, objectMap);
|
||||
}
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
// write to lower layers first
|
||||
for (let i = this.cacheAdapters.length - 1; i >= 0; i--) {
|
||||
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
|
||||
await cacheAdapter.cacheDBMissesAsync(fieldName, fieldValues);
|
||||
}
|
||||
}
|
||||
|
||||
public async invalidateManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
// delete from lower layers first
|
||||
for (let i = this.cacheAdapters.length - 1; i >= 0; i--) {
|
||||
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
|
||||
await cacheAdapter.invalidateManyAsync(fieldName, fieldValues);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import { ISecondaryEntityCache } from './EntitySecondaryCacheLoader';
|
||||
|
||||
export default class ComposedSecondaryEntityCache<TLoadParams, TFields>
|
||||
implements ISecondaryEntityCache<TFields, TLoadParams>
|
||||
{
|
||||
/**
|
||||
* A {@link ISecondaryEntityCache} that composes other {@link ISecondaryEntityCache} instances.
|
||||
*
|
||||
* @param secondaryEntityCaches - list of caches to compose in order of precedence.
|
||||
* Earlier caches are read from first and written to (including invalidations) last.
|
||||
* Typically, caches closer to the application should be ordered before caches closer to the database.
|
||||
*/
|
||||
constructor(
|
||||
private readonly secondaryEntityCaches: ISecondaryEntityCache<TFields, TLoadParams>[]
|
||||
) {}
|
||||
|
||||
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>> {
|
||||
return await ComposedSecondaryEntityCache.loadManyThroughRecursivelyAsync(
|
||||
this.secondaryEntityCaches,
|
||||
loadParamsArray,
|
||||
fetcher
|
||||
);
|
||||
}
|
||||
|
||||
private static async loadManyThroughRecursivelyAsync<TLoadParams, TFields>(
|
||||
secondaryEntityCaches: ISecondaryEntityCache<TFields, TLoadParams>[],
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[],
|
||||
fetcher: (
|
||||
fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
|
||||
): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>> {
|
||||
if (secondaryEntityCaches.length === 0) {
|
||||
return await fetcher(loadParamsArray);
|
||||
}
|
||||
|
||||
const [firstCache, ...restCaches] = secondaryEntityCaches;
|
||||
|
||||
return await nullthrows(firstCache).loadManyThroughAsync(
|
||||
loadParamsArray,
|
||||
(fetcherLoadParamsArray) =>
|
||||
ComposedSecondaryEntityCache.loadManyThroughRecursivelyAsync(
|
||||
restCaches,
|
||||
fetcherLoadParamsArray,
|
||||
fetcher
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
async invalidateManyAsync(loadParamsArray: readonly Readonly<TLoadParams>[]): Promise<void> {
|
||||
// invalidate lower layers first
|
||||
for (let i = this.secondaryEntityCaches.length - 1; i >= 0; i--) {
|
||||
const secondaryEntityCache = nullthrows(this.secondaryEntityCaches[i]);
|
||||
await secondaryEntityCache.invalidateManyAsync(loadParamsArray);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,144 +0,0 @@
|
||||
import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import { mapMap } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* Enforcing view on an entity loader. All loads through this loader will throw
|
||||
* if the loads are not successful.
|
||||
*/
|
||||
export default class EnforcingEntityLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
constructor(
|
||||
private readonly entityLoader: EntityLoader<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly TEntity[]>> {
|
||||
const fieldValuesToResults = await this.entityLoader.loadManyByFieldEqualingManyAsync(
|
||||
fieldName,
|
||||
fieldValues
|
||||
);
|
||||
return mapMap(fieldValuesToResults, (results) =>
|
||||
results.map((result) => result.enforceValue())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.entityLoader.loadManyByFieldEqualingAsync(
|
||||
fieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
|
||||
* @throws when multiple entities are found matching the condition
|
||||
*/
|
||||
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
uniqueFieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<TEntity | null> {
|
||||
const entityResult = await this.entityLoader.loadByFieldEqualingAsync(
|
||||
uniqueFieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
|
||||
*/
|
||||
async loadByIDAsync(id: TID): Promise<TEntity> {
|
||||
const entityResult = await this.entityLoader.loadByIDAsync(id);
|
||||
return entityResult.enforceValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
|
||||
* @throws when multiple entities are found matching the condition
|
||||
*/
|
||||
async loadByIDNullableAsync(id: TID): Promise<TEntity | null> {
|
||||
const entityResult = await this.entityLoader.loadByIDNullableAsync(id);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, TEntity>> {
|
||||
const entityResults = await this.entityLoader.loadManyByIDsAsync(ids);
|
||||
return mapMap(entityResults, (result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.entityLoader.loadManyByFieldEqualityConjunctionAsync(
|
||||
fieldEqualityOperands,
|
||||
querySelectionModifiers
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.entityLoader.loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause,
|
||||
bindings,
|
||||
querySelectionModifiers
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
}
|
||||
@@ -69,7 +69,7 @@ export default abstract class Entity<
|
||||
return viewerContext
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getMutatorFactory()
|
||||
.forCreate(queryContext);
|
||||
.forCreate(queryContext, { cascadingDeleteCause: null });
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -111,7 +111,7 @@ export default abstract class Entity<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getMutatorFactory()
|
||||
.forUpdate(existingEntity, queryContext);
|
||||
.forUpdate(existingEntity, queryContext, { cascadingDeleteCause: null });
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -152,7 +152,7 @@ export default abstract class Entity<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getMutatorFactory()
|
||||
.forDelete(existingEntity, queryContext)
|
||||
.forDelete(existingEntity, queryContext, { cascadingDeleteCause: null })
|
||||
.deleteAsync();
|
||||
}
|
||||
|
||||
@@ -194,7 +194,7 @@ export default abstract class Entity<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getMutatorFactory()
|
||||
.forDelete(existingEntity, queryContext)
|
||||
.forDelete(existingEntity, queryContext, { cascadingDeleteCause: null })
|
||||
.enforceDeleteAsync();
|
||||
}
|
||||
|
||||
@@ -243,12 +243,17 @@ export default abstract class Entity<
|
||||
.getQueryContextProvider()
|
||||
.getQueryContext()
|
||||
): Promise<boolean> {
|
||||
const companion = existingEntity
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this);
|
||||
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
|
||||
const evaluationResult = await asyncResult(
|
||||
privacyPolicy.authorizeUpdateAsync(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
existingEntity
|
||||
{ cascadingDeleteCause: null },
|
||||
existingEntity,
|
||||
companion.getMetricsAdapter()
|
||||
)
|
||||
);
|
||||
return evaluationResult.ok;
|
||||
@@ -292,12 +297,17 @@ export default abstract class Entity<
|
||||
.getQueryContextProvider()
|
||||
.getQueryContext()
|
||||
): Promise<boolean> {
|
||||
const companion = existingEntity
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this);
|
||||
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
|
||||
const evaluationResult = await asyncResult(
|
||||
privacyPolicy.authorizeDeleteAsync(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
existingEntity
|
||||
{ cascadingDeleteCause: null },
|
||||
existingEntity,
|
||||
companion.getMetricsAdapter()
|
||||
)
|
||||
);
|
||||
return evaluationResult.ok;
|
||||
|
||||
@@ -69,9 +69,11 @@ export default class EntityAssociationLoader<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext);
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
|
||||
return (await loader.loadByIDAsync(associatedEntityID as unknown as TAssociatedID)) as Result<
|
||||
return (await loader.resultLoader.loadByIDAsync(
|
||||
associatedEntityID as unknown as TAssociatedID
|
||||
)) as Result<
|
||||
null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity
|
||||
>;
|
||||
}
|
||||
@@ -123,8 +125,8 @@ export default class EntityAssociationLoader<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext);
|
||||
return await loader.loadManyByFieldEqualingAsync(
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
return await loader.resultLoader.loadManyByFieldEqualingAsync(
|
||||
associatedEntityFieldContainingThisID,
|
||||
thisID as any
|
||||
);
|
||||
@@ -180,8 +182,8 @@ export default class EntityAssociationLoader<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext);
|
||||
return await loader.loadByFieldEqualingAsync(
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
return await loader.resultLoader.loadByFieldEqualingAsync(
|
||||
associatedEntityLookupByField,
|
||||
associatedFieldValue as any
|
||||
);
|
||||
@@ -238,8 +240,8 @@ export default class EntityAssociationLoader<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext);
|
||||
return await loader.loadManyByFieldEqualingAsync(
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
return await loader.resultLoader.loadManyByFieldEqualingAsync(
|
||||
associatedEntityLookupByField,
|
||||
associatedFieldValue as any
|
||||
);
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import { FieldTransformerMap } from './internal/EntityFieldTransformationUtils';
|
||||
import { CacheLoadResult } from './internal/ReadThroughEntityCache';
|
||||
|
||||
/**
|
||||
@@ -9,13 +8,6 @@ import { CacheLoadResult } from './internal/ReadThroughEntityCache';
|
||||
export default abstract class EntityCacheAdapter<TFields> {
|
||||
constructor(protected readonly entityConfiguration: EntityConfiguration<TFields>) {}
|
||||
|
||||
/**
|
||||
* Transformer definitions for field types. Used to modify values as they are read from or written to
|
||||
* the cache. Override in concrete subclasses to change transformation behavior.
|
||||
* If a field type is not present in the map, then fields of that type will not be transformed.
|
||||
*/
|
||||
public abstract getFieldTransformerMap(): FieldTransformerMap;
|
||||
|
||||
/**
|
||||
* Load many objects from cache.
|
||||
* @param fieldName - object field being queried
|
||||
@@ -25,7 +17,7 @@ export default abstract class EntityCacheAdapter<TFields> {
|
||||
public abstract loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult>>;
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>>;
|
||||
|
||||
/**
|
||||
* Cache many objects fetched from the DB.
|
||||
@@ -34,7 +26,7 @@ export default abstract class EntityCacheAdapter<TFields> {
|
||||
*/
|
||||
public abstract cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, object>
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>
|
||||
): Promise<void>;
|
||||
|
||||
/**
|
||||
|
||||
@@ -73,7 +73,7 @@ export default class EntityCompanion<
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
metricsAdapter: IEntityMetricsAdapter
|
||||
private readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {
|
||||
const privacyPolicy = new PrivacyPolicyClass();
|
||||
this.entityLoaderFactory = new EntityLoaderFactory<
|
||||
@@ -87,7 +87,8 @@ export default class EntityCompanion<
|
||||
tableDataCoordinator.entityConfiguration,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
tableDataCoordinator.dataManager
|
||||
tableDataCoordinator.dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
this.entityMutatorFactory = new EntityMutatorFactory(
|
||||
tableDataCoordinator.entityConfiguration,
|
||||
@@ -129,4 +130,11 @@ export default class EntityCompanion<
|
||||
getQueryContextProvider(): EntityQueryContextProvider {
|
||||
return this.tableDataCoordinator.getQueryContextProvider();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the {@link IEntityMetricsAdapter} for this companion.
|
||||
*/
|
||||
getMetricsAdapter(): IEntityMetricsAdapter {
|
||||
return this.metricsAdapter;
|
||||
}
|
||||
}
|
||||
@@ -174,7 +174,7 @@ export default class EntityCompanionProvider {
|
||||
* @param cacheAdapterFlavors - Cache adapter configurations for this instance
|
||||
*/
|
||||
constructor(
|
||||
private metricsAdapter: IEntityMetricsAdapter,
|
||||
public readonly metricsAdapter: IEntityMetricsAdapter,
|
||||
private databaseAdapterFlavors: ReadonlyMap<
|
||||
DatabaseAdapterFlavor,
|
||||
DatabaseAdapterFlavorDefinition
|
||||
|
||||
@@ -28,6 +28,9 @@ export enum EntityEdgeDeletionBehavior {
|
||||
SET_NULL,
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines an association between entities. An association is primarily used to define cascading deletion behavior.
|
||||
*/
|
||||
export interface EntityAssociationDefinition<
|
||||
TViewerContext extends ViewerContext,
|
||||
TAssociatedFields,
|
||||
@@ -83,6 +86,10 @@ export interface EntityAssociationDefinition<
|
||||
edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
|
||||
}
|
||||
|
||||
/**
|
||||
* Definition for a field referencing a column in the underlying database. Specifies things like
|
||||
* cache behavior and associations, and handles input validation.
|
||||
*/
|
||||
export abstract class EntityFieldDefinition<T> {
|
||||
readonly columnName: string;
|
||||
readonly cache: boolean;
|
||||
@@ -93,6 +100,7 @@ export abstract class EntityFieldDefinition<T> {
|
||||
* @param cache - Whether or not to cache loaded instances of the entity by this field. The column name is
|
||||
* used to derive a cache key for the cache entry. If true, this column must be able uniquely
|
||||
* identify the entity.
|
||||
* @param association - Defines the association behavior for an entity that this column references.
|
||||
*/
|
||||
constructor({
|
||||
columnName,
|
||||
|
||||
@@ -2,59 +2,104 @@ import { validate as validateUUID } from 'uuid';
|
||||
|
||||
import { EntityFieldDefinition } from './EntityFieldDefinition';
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS string type.
|
||||
*/
|
||||
export class StringField extends EntityFieldDefinition<string> {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return typeof value === 'string';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS string type.
|
||||
* Enforces that the string is a valid UUID.
|
||||
*/
|
||||
export class UUIDField extends StringField {
|
||||
protected override validateInputValueInternal(value: string): boolean {
|
||||
return validateUUID(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS Date type.
|
||||
*/
|
||||
export class DateField extends EntityFieldDefinition<Date> {
|
||||
protected validateInputValueInternal(value: Date): boolean {
|
||||
return value instanceof Date;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS boolean type.
|
||||
*/
|
||||
export class BooleanField extends EntityFieldDefinition<boolean> {
|
||||
protected validateInputValueInternal(value: boolean): boolean {
|
||||
return typeof value === 'boolean';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS number type.
|
||||
* Enforces that the number is an integer.
|
||||
*/
|
||||
export class IntField extends EntityFieldDefinition<number> {
|
||||
protected validateInputValueInternal(value: number): boolean {
|
||||
return typeof value === 'number' && Number.isInteger(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS number type.
|
||||
* Enforces that the number is a float (which includes integers in JS).
|
||||
*/
|
||||
export class FloatField extends EntityFieldDefinition<number> {
|
||||
protected validateInputValueInternal(value: number): boolean {
|
||||
return typeof value === 'number';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS string array type.
|
||||
* Enforces that every member of the string array is a string.
|
||||
*/
|
||||
export class StringArrayField extends EntityFieldDefinition<string[]> {
|
||||
protected validateInputValueInternal(value: string[]): boolean {
|
||||
return Array.isArray(value) && value.every((subValue) => typeof subValue === 'string');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS JSON object type.
|
||||
*/
|
||||
export class JSONObjectField extends EntityFieldDefinition<object> {
|
||||
protected validateInputValueInternal(value: object): boolean {
|
||||
return typeof value === 'object' && !Array.isArray(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a enum column with a JS string or number type.
|
||||
*/
|
||||
export class EnumField extends EntityFieldDefinition<string | number> {
|
||||
protected validateInputValueInternal(value: string | number): boolean {
|
||||
return typeof value === 'number' || typeof value === 'string';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS JSON array type.
|
||||
*/
|
||||
export class JSONArrayField extends EntityFieldDefinition<any[]> {
|
||||
protected validateInputValueInternal(value: any[]): boolean {
|
||||
return Array.isArray(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column that may be a JS JSON array type.
|
||||
* Does not do any validation.
|
||||
*/
|
||||
export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
|
||||
protected validateInputValueInternal(_value: any): boolean {
|
||||
return true;
|
||||
|
||||
@@ -1,22 +1,14 @@
|
||||
import { Result, asyncResult, result } from '@expo/results';
|
||||
import invariant from 'invariant';
|
||||
|
||||
import EnforcingEntityLoader from './EnforcingEntityLoader';
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import {
|
||||
FieldEqualityCondition,
|
||||
QuerySelectionModifiers,
|
||||
isSingleValueFieldEqualityCondition,
|
||||
} from './EntityDatabaseAdapter';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import EntityResultLoader from './EntityResultLoader';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
|
||||
import EntityNotFoundError from './errors/EntityNotFoundError';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
import { mapMap } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* The primary interface for loading entities. All normal loads are batched,
|
||||
@@ -36,11 +28,24 @@ export default class EntityLoader<
|
||||
>,
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
/**
|
||||
* Result-based view on an entity loader. All loads through this loader will wrap their results in Result.
|
||||
*/
|
||||
public readonly resultLoader: EntityResultLoader<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>;
|
||||
|
||||
constructor(
|
||||
private readonly viewerContext: TViewerContext,
|
||||
private readonly queryContext: EntityQueryContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
@@ -48,132 +53,105 @@ export default class EntityLoader<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly privacyPolicy: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Enforcing view on this entity loader. All loads through this view are
|
||||
* guaranteed to be the values of successful results (or null for some loader methods),
|
||||
* and will throw otherwise.
|
||||
*/
|
||||
enforcing(): EnforcingEntityLoader<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
> {
|
||||
return new EnforcingEntityLoader(this);
|
||||
privacyPolicy: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {
|
||||
this.resultLoader = new EntityResultLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entityConfiguration,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load many entities where fieldName is one of fieldValues.
|
||||
* @param fieldName - entity field being queried
|
||||
* @param fieldValues - fieldName field values being queried
|
||||
* @returns map from fieldValue to entity results that match the query for that fieldValue,
|
||||
* where result errors can be UnauthorizedError
|
||||
* @returns map from fieldValue to entities that match the query for that fieldValue
|
||||
*/
|
||||
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
|
||||
this.validateFieldValues(fieldName, fieldValues);
|
||||
|
||||
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
|
||||
this.queryContext,
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly TEntity[]>> {
|
||||
const fieldValuesToResults = await this.resultLoader.loadManyByFieldEqualingManyAsync(
|
||||
fieldName,
|
||||
fieldValues
|
||||
);
|
||||
|
||||
return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects);
|
||||
return mapMap(fieldValuesToResults, (results) =>
|
||||
results.map((result) => result.enforceValue())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load many entities where fieldName equals fieldValue.
|
||||
* @param fieldName - entity field being queried
|
||||
* @param fieldValue - fieldName field value being queried
|
||||
* @returns array of entity results that match the query for fieldValue, where result error can be UnauthorizedError
|
||||
* @returns array of entities that match the query for fieldValue
|
||||
*/
|
||||
async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const entityResults = await this.loadManyByFieldEqualingManyAsync(fieldName, [fieldValue]);
|
||||
const entityResultsForFieldValue = entityResults.get(fieldValue);
|
||||
invariant(
|
||||
entityResultsForFieldValue !== undefined,
|
||||
`${fieldValue} should be guaranteed to be present in returned map of entities`
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.resultLoader.loadManyByFieldEqualingAsync(
|
||||
fieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResultsForFieldValue!;
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an entity where fieldName equals fieldValue, or null if no entity exists.
|
||||
* @param uniqueFieldName - entity field being queried
|
||||
* @param fieldValue - uniqueFieldName field value being queried
|
||||
* @returns entity result where uniqueFieldName equals fieldValue, or null if no entity matches the condition.
|
||||
* @returns entity where uniqueFieldName equals fieldValue, or null if no entity matches the condition.
|
||||
* @throws when multiple entities match the condition
|
||||
*/
|
||||
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
uniqueFieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<Result<TEntity> | null> {
|
||||
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue);
|
||||
invariant(
|
||||
entityResults.length <= 1,
|
||||
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${uniqueFieldName}=${fieldValue}`
|
||||
): Promise<TEntity | null> {
|
||||
const entityResult = await this.resultLoader.loadByFieldEqualingAsync(
|
||||
uniqueFieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResults[0] ?? null;
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads an entity by a specified ID.
|
||||
* @param id - ID of the entity
|
||||
* @returns entity result for matching ID, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
* @returns entity for matching ID
|
||||
*/
|
||||
async loadByIDAsync(id: TID): Promise<Result<TEntity>> {
|
||||
const entityResults = await this.loadManyByIDsAsync([id]);
|
||||
const entityResult = entityResults.get(id);
|
||||
if (entityResult === undefined) {
|
||||
return result(
|
||||
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
|
||||
);
|
||||
}
|
||||
return entityResult;
|
||||
async loadByIDAsync(id: TID): Promise<TEntity> {
|
||||
const entityResult = await this.resultLoader.loadByIDAsync(id);
|
||||
return entityResult.enforceValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an entity by a specified ID, or return null if non-existent.
|
||||
* @param id - ID of the entity
|
||||
* @returns entity result for matching ID, or null if no entity exists for ID.
|
||||
* @returns entity for matching ID, or null if no entity exists for ID.
|
||||
*/
|
||||
async loadByIDNullableAsync(id: TID): Promise<Result<TEntity> | null> {
|
||||
return await this.loadByFieldEqualingAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
id
|
||||
);
|
||||
async loadByIDNullableAsync(id: TID): Promise<TEntity | null> {
|
||||
const entityResult = await this.resultLoader.loadByIDNullableAsync(id);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entities for a list of IDs.
|
||||
* @param viewerContext - viewer context of loading user
|
||||
* @param ids - IDs of the entities to load
|
||||
* @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
* @returns map from ID to corresponding entity
|
||||
*/
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
|
||||
const entityResults = (await this.loadManyByFieldEqualingManyAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
ids
|
||||
)) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
|
||||
return mapMap(entityResults, (entityResultsForId, id) => {
|
||||
const entityResult = entityResultsForId[0];
|
||||
return (
|
||||
entityResult ??
|
||||
result(new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id))
|
||||
);
|
||||
});
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, TEntity>> {
|
||||
const entityResults = await this.resultLoader.loadManyByIDsAsync(ids);
|
||||
return mapMap(entityResults, (result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -188,39 +166,17 @@ export default class EntityLoader<
|
||||
*
|
||||
* @param fieldEqualityOperands - list of field equality WHERE clause operand specifications
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
* @returns array of entities that match the query
|
||||
*/
|
||||
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
for (const fieldEqualityOperand of fieldEqualityOperands) {
|
||||
const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
|
||||
? [fieldEqualityOperand.fieldValue]
|
||||
: fieldEqualityOperand.fieldValues;
|
||||
this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
|
||||
}
|
||||
|
||||
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
|
||||
this.queryContext,
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.resultLoader.loadManyByFieldEqualityConjunctionAsync(
|
||||
fieldEqualityOperands,
|
||||
querySelectionModifiers
|
||||
);
|
||||
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
uncheckedEntityResult.value
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -243,7 +199,7 @@ export default class EntityLoader<
|
||||
* @param rawWhereClause - parameterized SQL WHERE clause with positional binding placeholders or named binding placeholders
|
||||
* @param bindings - array of positional bindings or object of named bindings
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
* @returns array of entities that match the query
|
||||
* @throws Error when rawWhereClause or bindings are invalid
|
||||
*
|
||||
* @deprecated prefer caching loaders
|
||||
@@ -252,28 +208,13 @@ export default class EntityLoader<
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync(
|
||||
this.queryContext,
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.resultLoader.loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause,
|
||||
bindings,
|
||||
querySelectionModifiers
|
||||
);
|
||||
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
uncheckedEntityResult.value
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
return entityResults.map((result) => result.enforceValue());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -292,61 +233,4 @@ export default class EntityLoader<
|
||||
async invalidateEntityAsync(entity: TEntity): Promise<void> {
|
||||
await this.invalidateFieldsAsync(entity.getAllDatabaseFields());
|
||||
}
|
||||
|
||||
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
|
||||
return fieldsObjects.map((fieldsObject) => {
|
||||
try {
|
||||
return result(new this.entityClass(this.viewerContext, fieldsObject));
|
||||
} catch (e) {
|
||||
if (!(e instanceof Error)) {
|
||||
throw e;
|
||||
}
|
||||
return result(e);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct and authorize entities from fields map, returning error results for entities that fail
|
||||
* to construct or fail to authorize.
|
||||
*
|
||||
* @param map - map from an arbitrary key type to an array of entity field objects
|
||||
*/
|
||||
public async constructAndAuthorizeEntitiesAsync<K>(
|
||||
map: ReadonlyMap<K, readonly Readonly<TFields>[]>
|
||||
): Promise<ReadonlyMap<K, readonly Result<TEntity>[]>> {
|
||||
const uncheckedEntityResultsMap = mapMap(map, (fieldObjects) =>
|
||||
this.tryConstructEntities(fieldObjects)
|
||||
);
|
||||
return await mapMapAsync(uncheckedEntityResultsMap, async (uncheckedEntityResults) => {
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
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,11 +1,12 @@
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
|
||||
/**
|
||||
* The primary entry point for loading entities.
|
||||
@@ -35,7 +36,8 @@ export default class EntityLoaderFactory<
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly privacyPolicyClass: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {}
|
||||
|
||||
/**
|
||||
@@ -45,15 +47,18 @@ export default class EntityLoaderFactory<
|
||||
*/
|
||||
forLoad(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
this.entityConfiguration,
|
||||
this.entityClass,
|
||||
this.privacyPolicyClass,
|
||||
this.dataManager
|
||||
this.dataManager,
|
||||
this.metricsAdapter
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
import Entity from './Entity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
export enum EntityMutationType {
|
||||
CREATE,
|
||||
UPDATE,
|
||||
DELETE,
|
||||
}
|
||||
|
||||
export type EntityValidatorMutationInfo<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> =
|
||||
| {
|
||||
type: EntityMutationType.CREATE;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
};
|
||||
|
||||
/**
|
||||
* Information about a cascading deletion.
|
||||
*/
|
||||
export type EntityCascadingDeletionInfo = {
|
||||
/**
|
||||
* The entity that is being mutated at this step in the cascaded deletion.
|
||||
*/
|
||||
entity: Entity<any, any, any, any>;
|
||||
|
||||
/**
|
||||
* The cascade deletion that caused this mutation.
|
||||
*/
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
};
|
||||
|
||||
export type EntityTriggerMutationInfo<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> =
|
||||
| {
|
||||
type: EntityMutationType.CREATE;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.DELETE;
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
};
|
||||
@@ -1,4 +1,4 @@
|
||||
import { EntityMutationInfo } from './EntityMutator';
|
||||
import { EntityTriggerMutationInfo } from './EntityMutationInfo';
|
||||
import { EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -80,7 +80,7 @@ export abstract class EntityMutationTrigger<
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
): Promise<void>;
|
||||
}
|
||||
|
||||
@@ -98,6 +98,6 @@ export abstract class EntityNonTransactionalMutationTrigger<
|
||||
abstract executeAsync(
|
||||
viewerContext: TViewerContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
): Promise<void>;
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
import { EntityMutationInfo } from './EntityMutator';
|
||||
import { EntityValidatorMutationInfo } from './EntityMutationInfo';
|
||||
import { EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -18,6 +18,12 @@ export default abstract class EntityMutationValidator<
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
mutationInfo: EntityValidatorMutationInfo<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>
|
||||
): Promise<void>;
|
||||
}
|
||||
@@ -7,12 +7,18 @@ import EntityConfiguration from './EntityConfiguration';
|
||||
import EntityDatabaseAdapter from './EntityDatabaseAdapter';
|
||||
import { EntityEdgeDeletionBehavior } from './EntityFieldDefinition';
|
||||
import EntityLoaderFactory from './EntityLoaderFactory';
|
||||
import {
|
||||
EntityValidatorMutationInfo,
|
||||
EntityMutationType,
|
||||
EntityTriggerMutationInfo,
|
||||
EntityCascadingDeletionInfo,
|
||||
} from './EntityMutationInfo';
|
||||
import EntityMutationTriggerConfiguration, {
|
||||
EntityMutationTrigger,
|
||||
EntityNonTransactionalMutationTrigger,
|
||||
} from './EntityMutationTriggerConfiguration';
|
||||
import EntityMutationValidator from './EntityMutationValidator';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -21,30 +27,6 @@ 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]>,
|
||||
@@ -62,6 +44,7 @@ abstract class BaseMutator<
|
||||
constructor(
|
||||
protected readonly viewerContext: TViewerContext,
|
||||
protected readonly queryContext: EntityQueryContext,
|
||||
protected readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
protected readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
protected readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
@@ -110,26 +93,44 @@ abstract class BaseMutator<
|
||||
}
|
||||
}
|
||||
|
||||
protected async executeMutationTriggersOrValidatorsAsync(
|
||||
triggersOrValidators:
|
||||
| EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
|
||||
| EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
|
||||
| undefined,
|
||||
protected async executeMutationValidatorsAsync(
|
||||
validators: EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
mutationInfo: EntityValidatorMutationInfo<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>
|
||||
): Promise<void> {
|
||||
if (!triggersOrValidators) {
|
||||
return;
|
||||
}
|
||||
await Promise.all(
|
||||
triggersOrValidators.map((triggerOrValidator) =>
|
||||
triggerOrValidator.executeAsync(this.viewerContext, queryContext, entity, mutationInfo)
|
||||
validators.map((validator) =>
|
||||
validator.executeAsync(this.viewerContext, queryContext, entity, mutationInfo)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
protected async executeNonTransactionalMutationTriggersOrValidatorsAsync(
|
||||
protected async executeMutationTriggersAsync(
|
||||
triggers:
|
||||
| EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
|
||||
| undefined,
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
): Promise<void> {
|
||||
if (!triggers) {
|
||||
return;
|
||||
}
|
||||
await Promise.all(
|
||||
triggers.map((trigger) =>
|
||||
trigger.executeAsync(this.viewerContext, queryContext, entity, mutationInfo)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
protected async executeNonTransactionalMutationTriggersAsync(
|
||||
triggers:
|
||||
| EntityNonTransactionalMutationTrigger<
|
||||
TFields,
|
||||
@@ -140,7 +141,7 @@ abstract class BaseMutator<
|
||||
>[]
|
||||
| undefined,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
): Promise<void> {
|
||||
if (!triggers) {
|
||||
return;
|
||||
@@ -220,26 +221,28 @@ export class CreateMutator<
|
||||
this.privacyPolicy.authorizeCreateAsync(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
temporaryEntityForPrivacyCheck
|
||||
this.privacyPolicyEvaluationContext,
|
||||
temporaryEntityForPrivacyCheck,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
if (!authorizeCreateResult.ok) {
|
||||
return authorizeCreateResult;
|
||||
}
|
||||
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationValidatorsAsync(
|
||||
this.mutationValidators,
|
||||
queryContext,
|
||||
temporaryEntityForPrivacyCheck,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.beforeAll,
|
||||
queryContext,
|
||||
temporaryEntityForPrivacyCheck,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.beforeCreate,
|
||||
queryContext,
|
||||
temporaryEntityForPrivacyCheck,
|
||||
@@ -248,23 +251,25 @@ export class CreateMutator<
|
||||
|
||||
const insertResult = await this.databaseAdapter.insertAsync(queryContext, this.fieldsForEntity);
|
||||
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
|
||||
queryContext.appendPostCommitCallback(
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
this.privacyPolicyEvaluationContext
|
||||
);
|
||||
queryContext.appendPostCommitInvalidationCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult)
|
||||
);
|
||||
|
||||
const unauthorizedEntityAfterInsert = new this.entityClass(this.viewerContext, insertResult);
|
||||
const newEntity = await entityLoader
|
||||
.enforcing()
|
||||
.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
|
||||
const newEntity = await entityLoader.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
|
||||
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterCreate,
|
||||
queryContext,
|
||||
newEntity,
|
||||
{ type: EntityMutationType.CREATE }
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterAll,
|
||||
queryContext,
|
||||
newEntity,
|
||||
@@ -272,7 +277,7 @@ export class CreateMutator<
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
|
||||
this.executeNonTransactionalMutationTriggersAsync.bind(
|
||||
this,
|
||||
this.mutationTriggers.afterCommit,
|
||||
newEntity,
|
||||
@@ -308,6 +313,7 @@ export class UpdateMutator<
|
||||
constructor(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
@@ -347,6 +353,7 @@ export class UpdateMutator<
|
||||
super(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entityConfiguration,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
@@ -408,26 +415,28 @@ export class UpdateMutator<
|
||||
this.privacyPolicy.authorizeUpdateAsync(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated
|
||||
this.privacyPolicyEvaluationContext,
|
||||
entityAboutToBeUpdated,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
if (!authorizeUpdateResult.ok) {
|
||||
return authorizeUpdateResult;
|
||||
}
|
||||
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationValidatorsAsync(
|
||||
this.mutationValidators,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.beforeAll,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.beforeUpdate,
|
||||
queryContext,
|
||||
entityAboutToBeUpdated,
|
||||
@@ -441,30 +450,32 @@ export class UpdateMutator<
|
||||
this.updatedFields
|
||||
);
|
||||
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
this.privacyPolicyEvaluationContext
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
queryContext.appendPostCommitInvalidationCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(
|
||||
entityLoader,
|
||||
this.originalEntity.getAllDatabaseFields()
|
||||
)
|
||||
);
|
||||
queryContext.appendPostCommitCallback(
|
||||
queryContext.appendPostCommitInvalidationCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.fieldsForEntity)
|
||||
);
|
||||
|
||||
const unauthorizedEntityAfterUpdate = new this.entityClass(this.viewerContext, updateResult);
|
||||
const updatedEntity = await entityLoader
|
||||
.enforcing()
|
||||
.loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
|
||||
const updatedEntity = await entityLoader.loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
|
||||
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterUpdate,
|
||||
queryContext,
|
||||
updatedEntity,
|
||||
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterAll,
|
||||
queryContext,
|
||||
updatedEntity,
|
||||
@@ -472,7 +483,7 @@ export class UpdateMutator<
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
|
||||
this.executeNonTransactionalMutationTriggersAsync.bind(
|
||||
this,
|
||||
this.mutationTriggers.afterCommit,
|
||||
updatedEntity,
|
||||
@@ -504,6 +515,7 @@ export class DeleteMutator<
|
||||
constructor(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
@@ -543,6 +555,7 @@ export class DeleteMutator<
|
||||
super(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entityConfiguration,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
@@ -563,7 +576,7 @@ export class DeleteMutator<
|
||||
this.metricsAdapter,
|
||||
EntityMetricsMutationType.DELETE,
|
||||
this.entityClass.name
|
||||
)(this.deleteInTransactionAsync());
|
||||
)(this.deleteInTransactionAsync(new Set(), false, null));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -574,14 +587,16 @@ export class DeleteMutator<
|
||||
}
|
||||
|
||||
private async deleteInTransactionAsync(
|
||||
processedEntityIdentifiersFromTransitiveDeletions: Set<string> = new Set(),
|
||||
skipDatabaseDeletion: boolean = false
|
||||
processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
|
||||
skipDatabaseDeletion: boolean,
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null
|
||||
): Promise<Result<void>> {
|
||||
return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
|
||||
this.deleteInternalAsync(
|
||||
innerQueryContext,
|
||||
processedEntityIdentifiersFromTransitiveDeletions,
|
||||
skipDatabaseDeletion
|
||||
skipDatabaseDeletion,
|
||||
cascadingDeleteCause
|
||||
)
|
||||
);
|
||||
}
|
||||
@@ -589,10 +604,17 @@ export class DeleteMutator<
|
||||
private async deleteInternalAsync(
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
|
||||
skipDatabaseDeletion: boolean
|
||||
skipDatabaseDeletion: boolean,
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null
|
||||
): Promise<Result<void>> {
|
||||
const authorizeDeleteResult = await asyncResult(
|
||||
this.privacyPolicy.authorizeDeleteAsync(this.viewerContext, queryContext, this.entity)
|
||||
this.privacyPolicy.authorizeDeleteAsync(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
{ cascadingDeleteCause },
|
||||
this.entity,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
if (!authorizeDeleteResult.ok) {
|
||||
return authorizeDeleteResult;
|
||||
@@ -601,20 +623,21 @@ export class DeleteMutator<
|
||||
await this.processEntityDeletionForInboundEdgesAsync(
|
||||
this.entity,
|
||||
queryContext,
|
||||
processedEntityIdentifiersFromTransitiveDeletions
|
||||
processedEntityIdentifiersFromTransitiveDeletions,
|
||||
cascadingDeleteCause
|
||||
);
|
||||
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.beforeAll,
|
||||
queryContext,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
{ type: EntityMutationType.DELETE, cascadingDeleteCause }
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.beforeDelete,
|
||||
queryContext,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
{ type: EntityMutationType.DELETE, cascadingDeleteCause }
|
||||
);
|
||||
|
||||
if (!skipDatabaseDeletion) {
|
||||
@@ -625,30 +648,32 @@ export class DeleteMutator<
|
||||
);
|
||||
}
|
||||
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
|
||||
queryContext.appendPostCommitCallback(
|
||||
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext, {
|
||||
cascadingDeleteCause,
|
||||
});
|
||||
queryContext.appendPostCommitInvalidationCallback(
|
||||
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.entity.getAllDatabaseFields())
|
||||
);
|
||||
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterDelete,
|
||||
queryContext,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
{ type: EntityMutationType.DELETE, cascadingDeleteCause }
|
||||
);
|
||||
await this.executeMutationTriggersOrValidatorsAsync(
|
||||
await this.executeMutationTriggersAsync(
|
||||
this.mutationTriggers.afterAll,
|
||||
queryContext,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
{ type: EntityMutationType.DELETE, cascadingDeleteCause }
|
||||
);
|
||||
|
||||
queryContext.appendPostCommitCallback(
|
||||
this.executeNonTransactionalMutationTriggersOrValidatorsAsync.bind(
|
||||
this.executeNonTransactionalMutationTriggersAsync.bind(
|
||||
this,
|
||||
this.mutationTriggers.afterCommit,
|
||||
this.entity,
|
||||
{ type: EntityMutationType.DELETE }
|
||||
{ type: EntityMutationType.DELETE, cascadingDeleteCause }
|
||||
)
|
||||
);
|
||||
|
||||
@@ -672,7 +697,8 @@ export class DeleteMutator<
|
||||
private async processEntityDeletionForInboundEdgesAsync(
|
||||
entity: TEntity,
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
processedEntityIdentifiers: Set<string>
|
||||
processedEntityIdentifiers: Set<string>,
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null
|
||||
): Promise<void> {
|
||||
// prevent infinite reference cycles by keeping track of entities already processed
|
||||
if (processedEntityIdentifiers.has(entity.getUniqueIdentifier())) {
|
||||
@@ -720,19 +746,24 @@ export class DeleteMutator<
|
||||
.getViewerScopedEntityCompanionForClass(entityClass)
|
||||
.getMutatorFactory();
|
||||
|
||||
const newCascadingDeleteCause = {
|
||||
entity,
|
||||
cascadingDeleteCause,
|
||||
};
|
||||
|
||||
let inboundReferenceEntities: readonly ReadonlyEntity<any, any, any, any>[];
|
||||
if (associatedEntityLookupByField) {
|
||||
inboundReferenceEntities = await loaderFactory
|
||||
.forLoad(queryContext)
|
||||
.enforcing()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: newCascadingDeleteCause })
|
||||
|
||||
.loadManyByFieldEqualingAsync(
|
||||
fieldName,
|
||||
entity.getField(associatedEntityLookupByField as any)
|
||||
);
|
||||
} else {
|
||||
inboundReferenceEntities = await loaderFactory
|
||||
.forLoad(queryContext)
|
||||
.enforcing()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: newCascadingDeleteCause })
|
||||
|
||||
.loadManyByFieldEqualingAsync(fieldName, entity.getID());
|
||||
}
|
||||
|
||||
@@ -742,10 +773,13 @@ export class DeleteMutator<
|
||||
await Promise.all(
|
||||
inboundReferenceEntities.map((inboundReferenceEntity) =>
|
||||
mutatorFactory
|
||||
.forDelete(inboundReferenceEntity, queryContext)
|
||||
.forDelete(inboundReferenceEntity, queryContext, {
|
||||
cascadingDeleteCause: newCascadingDeleteCause,
|
||||
})
|
||||
.deleteInTransactionAsync(
|
||||
processedEntityIdentifiers,
|
||||
/* skipDatabaseDeletion */ true // deletion is handled by DB
|
||||
/* skipDatabaseDeletion */ true, // deletion is handled by DB
|
||||
newCascadingDeleteCause
|
||||
)
|
||||
)
|
||||
);
|
||||
@@ -755,7 +789,9 @@ export class DeleteMutator<
|
||||
await Promise.all(
|
||||
inboundReferenceEntities.map((inboundReferenceEntity) =>
|
||||
mutatorFactory
|
||||
.forUpdate(inboundReferenceEntity, queryContext)
|
||||
.forUpdate(inboundReferenceEntity, queryContext, {
|
||||
cascadingDeleteCause: newCascadingDeleteCause,
|
||||
})
|
||||
.setField(fieldName, null)
|
||||
.enforceUpdateAsync()
|
||||
)
|
||||
@@ -766,10 +802,13 @@ export class DeleteMutator<
|
||||
await Promise.all(
|
||||
inboundReferenceEntities.map((inboundReferenceEntity) =>
|
||||
mutatorFactory
|
||||
.forDelete(inboundReferenceEntity, queryContext)
|
||||
.forDelete(inboundReferenceEntity, queryContext, {
|
||||
cascadingDeleteCause: newCascadingDeleteCause,
|
||||
})
|
||||
.deleteInTransactionAsync(
|
||||
processedEntityIdentifiers,
|
||||
/* skipDatabaseDeletion */ false
|
||||
/* skipDatabaseDeletion */ false,
|
||||
newCascadingDeleteCause
|
||||
)
|
||||
)
|
||||
);
|
||||
|
||||
@@ -5,7 +5,7 @@ import EntityLoaderFactory from './EntityLoaderFactory';
|
||||
import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
|
||||
import EntityMutationValidator from './EntityMutationValidator';
|
||||
import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
@@ -72,11 +72,13 @@ export default class EntityMutatorFactory<
|
||||
*/
|
||||
forCreate(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return new CreateMutator(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
this.entityConfiguration,
|
||||
this.entityClass,
|
||||
this.privacyPolicy,
|
||||
@@ -96,11 +98,13 @@ export default class EntityMutatorFactory<
|
||||
*/
|
||||
forUpdate(
|
||||
existingEntity: TEntity,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return new UpdateMutator(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
this.entityConfiguration,
|
||||
this.entityClass,
|
||||
this.privacyPolicy,
|
||||
@@ -120,11 +124,13 @@ export default class EntityMutatorFactory<
|
||||
*/
|
||||
forDelete(
|
||||
existingEntity: TEntity,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return new DeleteMutator(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
this.entityConfiguration,
|
||||
this.entityClass,
|
||||
this.privacyPolicy,
|
||||
|
||||
@@ -1,9 +1,24 @@
|
||||
import { EntityCascadingDeletionInfo } from './EntityMutationInfo';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityNotAuthorizedError from './errors/EntityNotAuthorizedError';
|
||||
import IEntityMetricsAdapter, {
|
||||
EntityMetricsAuthorizationResult,
|
||||
} from './metrics/IEntityMetricsAdapter';
|
||||
import PrivacyPolicyRule, { RuleEvaluationResult } from './rules/PrivacyPolicyRule';
|
||||
|
||||
/**
|
||||
* Information about the reason this privacy policy is being evaluated.
|
||||
*/
|
||||
export type EntityPrivacyPolicyEvaluationContext = {
|
||||
/**
|
||||
* When this privacy policy is being evaluated as a result of a cascading deletion, this will be populated
|
||||
* with information on the cascading delete.
|
||||
*/
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
};
|
||||
|
||||
export enum EntityPrivacyPolicyEvaluationMode {
|
||||
ENFORCE,
|
||||
DRY_RUN,
|
||||
@@ -124,14 +139,18 @@ export default abstract class EntityPrivacyPolicy<
|
||||
async authorizeCreateAsync(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity
|
||||
evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: TEntity,
|
||||
metricsAdapter: IEntityMetricsAdapter
|
||||
): Promise<TEntity> {
|
||||
return await this.authorizeForRulesetAsync(
|
||||
this.createRules,
|
||||
viewerContext,
|
||||
queryContext,
|
||||
evaluationContext,
|
||||
entity,
|
||||
EntityAuthorizationAction.CREATE
|
||||
EntityAuthorizationAction.CREATE,
|
||||
metricsAdapter
|
||||
);
|
||||
}
|
||||
|
||||
@@ -146,14 +165,18 @@ export default abstract class EntityPrivacyPolicy<
|
||||
async authorizeReadAsync(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity
|
||||
evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: TEntity,
|
||||
metricsAdapter: IEntityMetricsAdapter
|
||||
): Promise<TEntity> {
|
||||
return await this.authorizeForRulesetAsync(
|
||||
this.readRules,
|
||||
viewerContext,
|
||||
queryContext,
|
||||
evaluationContext,
|
||||
entity,
|
||||
EntityAuthorizationAction.READ
|
||||
EntityAuthorizationAction.READ,
|
||||
metricsAdapter
|
||||
);
|
||||
}
|
||||
|
||||
@@ -168,14 +191,18 @@ export default abstract class EntityPrivacyPolicy<
|
||||
async authorizeUpdateAsync(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity
|
||||
evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: TEntity,
|
||||
metricsAdapter: IEntityMetricsAdapter
|
||||
): Promise<TEntity> {
|
||||
return await this.authorizeForRulesetAsync(
|
||||
this.updateRules,
|
||||
viewerContext,
|
||||
queryContext,
|
||||
evaluationContext,
|
||||
entity,
|
||||
EntityAuthorizationAction.UPDATE
|
||||
EntityAuthorizationAction.UPDATE,
|
||||
metricsAdapter
|
||||
);
|
||||
}
|
||||
|
||||
@@ -190,14 +217,18 @@ export default abstract class EntityPrivacyPolicy<
|
||||
async authorizeDeleteAsync(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity
|
||||
evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: TEntity,
|
||||
metricsAdapter: IEntityMetricsAdapter
|
||||
): Promise<TEntity> {
|
||||
return await this.authorizeForRulesetAsync(
|
||||
this.deleteRules,
|
||||
viewerContext,
|
||||
queryContext,
|
||||
evaluationContext,
|
||||
entity,
|
||||
EntityAuthorizationAction.DELETE
|
||||
EntityAuthorizationAction.DELETE,
|
||||
metricsAdapter
|
||||
);
|
||||
}
|
||||
|
||||
@@ -205,49 +236,100 @@ export default abstract class EntityPrivacyPolicy<
|
||||
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: TEntity,
|
||||
action: EntityAuthorizationAction
|
||||
action: EntityAuthorizationAction,
|
||||
metricsAdapter: IEntityMetricsAdapter
|
||||
): Promise<TEntity> {
|
||||
const privacyPolicyEvaluator = this.getPrivacyPolicyEvaluator(viewerContext);
|
||||
switch (privacyPolicyEvaluator.mode) {
|
||||
case EntityPrivacyPolicyEvaluationMode.ENFORCE:
|
||||
return await this.authorizeForRulesetInnerAsync(
|
||||
ruleset,
|
||||
viewerContext,
|
||||
queryContext,
|
||||
entity,
|
||||
action
|
||||
);
|
||||
case EntityPrivacyPolicyEvaluationMode.ENFORCE_AND_LOG:
|
||||
try {
|
||||
return await this.authorizeForRulesetInnerAsync(
|
||||
const result = await this.authorizeForRulesetInnerAsync(
|
||||
ruleset,
|
||||
viewerContext,
|
||||
queryContext,
|
||||
evaluationContext,
|
||||
entity,
|
||||
action
|
||||
);
|
||||
metricsAdapter.logAuthorizationEvent({
|
||||
entityClassName: entity.constructor.name,
|
||||
action,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
|
||||
privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
|
||||
});
|
||||
return result;
|
||||
} catch (e) {
|
||||
if (!(e instanceof EntityNotAuthorizedError)) {
|
||||
throw e;
|
||||
}
|
||||
metricsAdapter.logAuthorizationEvent({
|
||||
entityClassName: entity.constructor.name,
|
||||
action,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.DENY,
|
||||
privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
|
||||
});
|
||||
throw e;
|
||||
}
|
||||
case EntityPrivacyPolicyEvaluationMode.ENFORCE_AND_LOG:
|
||||
try {
|
||||
const result = await this.authorizeForRulesetInnerAsync(
|
||||
ruleset,
|
||||
viewerContext,
|
||||
queryContext,
|
||||
evaluationContext,
|
||||
entity,
|
||||
action
|
||||
);
|
||||
metricsAdapter.logAuthorizationEvent({
|
||||
entityClassName: entity.constructor.name,
|
||||
action,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
|
||||
privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
|
||||
});
|
||||
return result;
|
||||
} catch (e) {
|
||||
if (!(e instanceof EntityNotAuthorizedError)) {
|
||||
throw e;
|
||||
}
|
||||
privacyPolicyEvaluator.denyHandler(e);
|
||||
metricsAdapter.logAuthorizationEvent({
|
||||
entityClassName: entity.constructor.name,
|
||||
action,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.DENY,
|
||||
privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
|
||||
});
|
||||
throw e;
|
||||
}
|
||||
case EntityPrivacyPolicyEvaluationMode.DRY_RUN:
|
||||
try {
|
||||
return await this.authorizeForRulesetInnerAsync(
|
||||
const result = await this.authorizeForRulesetInnerAsync(
|
||||
ruleset,
|
||||
viewerContext,
|
||||
queryContext,
|
||||
evaluationContext,
|
||||
entity,
|
||||
action
|
||||
);
|
||||
metricsAdapter.logAuthorizationEvent({
|
||||
entityClassName: entity.constructor.name,
|
||||
action,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
|
||||
privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
|
||||
});
|
||||
return result;
|
||||
} catch (e) {
|
||||
if (!(e instanceof EntityNotAuthorizedError)) {
|
||||
throw e;
|
||||
}
|
||||
privacyPolicyEvaluator.denyHandler(e);
|
||||
metricsAdapter.logAuthorizationEvent({
|
||||
entityClassName: entity.constructor.name,
|
||||
action,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.DENY,
|
||||
privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
|
||||
});
|
||||
return entity;
|
||||
}
|
||||
}
|
||||
@@ -257,12 +339,18 @@ export default abstract class EntityPrivacyPolicy<
|
||||
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: TEntity,
|
||||
action: EntityAuthorizationAction
|
||||
): Promise<TEntity> {
|
||||
for (let i = 0; i < ruleset.length; i++) {
|
||||
const rule = ruleset[i]!;
|
||||
const ruleEvaluationResult = await rule.evaluateAsync(viewerContext, queryContext, entity);
|
||||
const ruleEvaluationResult = await rule.evaluateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
evaluationContext,
|
||||
entity
|
||||
);
|
||||
switch (ruleEvaluationResult) {
|
||||
case RuleEvaluationResult.DENY:
|
||||
throw new EntityNotAuthorizedError<
|
||||
|
||||
@@ -1,6 +1,12 @@
|
||||
import assert from 'assert';
|
||||
|
||||
import EntityQueryContextProvider from './EntityQueryContextProvider';
|
||||
|
||||
export type PostCommitCallback = (...args: any) => Promise<any>;
|
||||
export type PreCommitCallback = (
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
...args: any
|
||||
) => Promise<any>;
|
||||
|
||||
/**
|
||||
* Entity framework representation of transactional and non-transactional database
|
||||
@@ -43,13 +49,61 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
|
||||
}
|
||||
|
||||
export class EntityTransactionalQueryContext extends EntityQueryContext {
|
||||
private readonly postCommitInvalidationCallbacks: PostCommitCallback[] = [];
|
||||
private readonly postCommitCallbacks: PostCommitCallback[] = [];
|
||||
|
||||
private readonly preCommitCallbacks: { callback: PreCommitCallback; order: number }[] = [];
|
||||
|
||||
/**
|
||||
* Schedule a pre-commit callback. These will be run within the transaction right before it is
|
||||
* committed, and will be run in the order specified. Ordering of callbacks scheduled with the
|
||||
* same value for the order parameter is undefined within that ordering group.
|
||||
* @param callback - callback to schedule
|
||||
* @param order - order in which this should be run relative to other scheduled pre-commit callbacks,
|
||||
* with higher numbers running later than lower numbers.
|
||||
*/
|
||||
public appendPreCommitCallback(callback: PreCommitCallback, order: number): void {
|
||||
assert(
|
||||
order >= Number.MIN_SAFE_INTEGER && order <= Number.MAX_SAFE_INTEGER,
|
||||
`Invalid order specified: ${order}`
|
||||
);
|
||||
this.preCommitCallbacks.push({ callback, order });
|
||||
}
|
||||
|
||||
/**
|
||||
* Schedule a post-commit cache invalidation callback. These are run before normal
|
||||
* post-commit callbacks in order to have cache consistency in normal post-commit callbacks.
|
||||
* @param callback - callback to schedule
|
||||
*/
|
||||
public appendPostCommitInvalidationCallback(callback: PostCommitCallback): void {
|
||||
this.postCommitInvalidationCallbacks.push(callback);
|
||||
}
|
||||
|
||||
/**
|
||||
* Schedule a post-commit callback. These will be run after the transaction has
|
||||
* been committed.
|
||||
* @param callback - callback to schedule
|
||||
*/
|
||||
public appendPostCommitCallback(callback: PostCommitCallback): void {
|
||||
this.postCommitCallbacks.push(callback);
|
||||
}
|
||||
|
||||
public async runPreCommitCallbacksAsync(): Promise<void> {
|
||||
const callbacks = [...this.preCommitCallbacks]
|
||||
.sort((a, b) => a.order - b.order)
|
||||
.map((c) => c.callback);
|
||||
this.preCommitCallbacks.length = 0;
|
||||
|
||||
for (const callback of callbacks) {
|
||||
await callback(this);
|
||||
}
|
||||
}
|
||||
|
||||
public async runPostCommitCallbacksAsync(): Promise<void> {
|
||||
const invalidationCallbacks = [...this.postCommitInvalidationCallbacks];
|
||||
this.postCommitInvalidationCallbacks.length = 0;
|
||||
await Promise.all(invalidationCallbacks.map((callback) => callback()));
|
||||
|
||||
const callbacks = [...this.postCommitCallbacks];
|
||||
this.postCommitCallbacks.length = 0;
|
||||
await Promise.all(callbacks.map((callback) => callback()));
|
||||
|
||||
@@ -38,6 +38,7 @@ export default abstract class EntityQueryContextProvider {
|
||||
>()(async (queryInterface) => {
|
||||
const queryContext = new EntityTransactionalQueryContext(queryInterface);
|
||||
const result = await transactionScope(queryContext);
|
||||
await queryContext.runPreCommitCallbacksAsync();
|
||||
return [result, queryContext];
|
||||
});
|
||||
await queryContext.runPostCommitCallbacksAsync();
|
||||
|
||||
@@ -0,0 +1,326 @@
|
||||
import { Result, asyncResult, result } from '@expo/results';
|
||||
import invariant from 'invariant';
|
||||
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import {
|
||||
FieldEqualityCondition,
|
||||
QuerySelectionModifiers,
|
||||
isSingleValueFieldEqualityCondition,
|
||||
} from './EntityDatabaseAdapter';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
|
||||
import EntityNotFoundError from './errors/EntityNotFoundError';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* Result-based view on an entity loader. All loads through this loader will wrap their results in Result.
|
||||
*/
|
||||
export default class EntityResultLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
constructor(
|
||||
private readonly viewerContext: TViewerContext,
|
||||
private readonly queryContext: EntityQueryContext,
|
||||
private readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly privacyPolicy: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Load many entity results where fieldName is one of fieldValues.
|
||||
* @param fieldName - entity field being queried
|
||||
* @param fieldValues - fieldName field values being queried
|
||||
* @returns map from fieldValue to entity results that match the query for that fieldValue,
|
||||
* where result errors can be UnauthorizedError
|
||||
*/
|
||||
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
|
||||
this.validateFieldValues(fieldName, fieldValues);
|
||||
|
||||
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
|
||||
this.queryContext,
|
||||
fieldName,
|
||||
fieldValues
|
||||
);
|
||||
|
||||
return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load many entity results where fieldName equals fieldValue.
|
||||
* @param fieldName - entity field being queried
|
||||
* @param fieldValue - fieldName field value being queried
|
||||
* @returns array of entity results that match the query for fieldValue, where result error can be UnauthorizedError
|
||||
*/
|
||||
async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const entityResults = await this.loadManyByFieldEqualingManyAsync(fieldName, [fieldValue]);
|
||||
const entityResultsForFieldValue = entityResults.get(fieldValue);
|
||||
invariant(
|
||||
entityResultsForFieldValue !== undefined,
|
||||
`${fieldValue} should be guaranteed to be present in returned map of entities`
|
||||
);
|
||||
return entityResultsForFieldValue!;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an entity result where fieldName equals fieldValue, or null if no entity exists.
|
||||
* @param uniqueFieldName - entity field being queried
|
||||
* @param fieldValue - uniqueFieldName field value being queried
|
||||
* @returns entity result where uniqueFieldName equals fieldValue, or null if no entity matches the condition.
|
||||
* @throws when multiple entities match the condition
|
||||
*/
|
||||
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
uniqueFieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<Result<TEntity> | null> {
|
||||
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue);
|
||||
invariant(
|
||||
entityResults.length <= 1,
|
||||
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${uniqueFieldName}=${fieldValue}`
|
||||
);
|
||||
return entityResults[0] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads an entityresult by a specified ID.
|
||||
* @param id - ID of the entity
|
||||
* @returns entity result for matching ID, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
*/
|
||||
async loadByIDAsync(id: TID): Promise<Result<TEntity>> {
|
||||
const entityResults = await this.loadManyByIDsAsync([id]);
|
||||
const entityResult = entityResults.get(id);
|
||||
if (entityResult === undefined) {
|
||||
return result(
|
||||
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
|
||||
);
|
||||
}
|
||||
return entityResult;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an entity result by a specified ID, or return null if non-existent.
|
||||
* @param id - ID of the entity
|
||||
* @returns entity result for matching ID, or null if no entity exists for ID.
|
||||
*/
|
||||
async loadByIDNullableAsync(id: TID): Promise<Result<TEntity> | null> {
|
||||
return await this.loadByFieldEqualingAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
id
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entity results for a list of IDs.
|
||||
* @param viewerContext - viewer context of loading user
|
||||
* @param ids - IDs of the entities to load
|
||||
* @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
*/
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
|
||||
const entityResults = (await this.loadManyByFieldEqualingManyAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
ids
|
||||
)) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
|
||||
return mapMap(entityResults, (entityResultsForId, id) => {
|
||||
const entityResult = entityResultsForId[0];
|
||||
return (
|
||||
entityResult ??
|
||||
result(new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id))
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entity results matching the conjunction of WHERE clauses constructed from specified operands.
|
||||
* Entities loaded using this method are not batched or cached.
|
||||
*
|
||||
* @example
|
||||
* fieldEqualityOperands:
|
||||
* `[{fieldName: 'hello', fieldValue: 1}, {fieldName: 'world', fieldValues: [2, 3]}]`
|
||||
* Entities returned:
|
||||
* `WHERE hello = 1 AND world = ANY({2, 3})`
|
||||
*
|
||||
* @param fieldEqualityOperands - list of field equality WHERE clause operand specifications
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
*/
|
||||
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
for (const fieldEqualityOperand of fieldEqualityOperands) {
|
||||
const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
|
||||
? [fieldEqualityOperand.fieldValue]
|
||||
: fieldEqualityOperand.fieldValues;
|
||||
this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
|
||||
}
|
||||
|
||||
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
|
||||
this.queryContext,
|
||||
fieldEqualityOperands,
|
||||
querySelectionModifiers
|
||||
);
|
||||
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entity results matching the raw WHERE clause. Corresponds to the knex `whereRaw` argument format.
|
||||
*
|
||||
* @remarks
|
||||
* Important notes:
|
||||
* - Fields in clause are database column names instead of transformed entity field names.
|
||||
* - Entities loaded using this method are not batched or cached.
|
||||
* - Not all database adapters implement the ability to execute this method of fetching entities.
|
||||
*
|
||||
* @example
|
||||
* rawWhereClause: `id = ?`
|
||||
* bindings: `[1]`
|
||||
* Entites returned `WHERE id = 1`
|
||||
*
|
||||
* {@link http://knexjs.org/#Builder-whereRaw}
|
||||
* {@link http://knexjs.org/#Raw-Bindings}
|
||||
*
|
||||
* @param rawWhereClause - parameterized SQL WHERE clause with positional binding placeholders or named binding placeholders
|
||||
* @param bindings - array of positional bindings or object of named bindings
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
* @throws Error when rawWhereClause or bindings are invalid
|
||||
*
|
||||
* @deprecated prefer caching loaders
|
||||
*/
|
||||
async loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync(
|
||||
this.queryContext,
|
||||
rawWhereClause,
|
||||
bindings,
|
||||
querySelectionModifiers
|
||||
);
|
||||
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
|
||||
return fieldsObjects.map((fieldsObject) => {
|
||||
try {
|
||||
return result(new this.entityClass(this.viewerContext, fieldsObject));
|
||||
} catch (e) {
|
||||
if (!(e instanceof Error)) {
|
||||
throw e;
|
||||
}
|
||||
return result(e);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct and authorize entities from fields map, returning error results for entities that fail
|
||||
* to construct or fail to authorize.
|
||||
*
|
||||
* @param map - map from an arbitrary key type to an array of entity field objects
|
||||
*/
|
||||
public async constructAndAuthorizeEntitiesAsync<K>(
|
||||
map: ReadonlyMap<K, readonly Readonly<TFields>[]>
|
||||
): Promise<ReadonlyMap<K, readonly Result<TEntity>[]>> {
|
||||
const uncheckedEntityResultsMap = mapMap(map, (fieldObjects) =>
|
||||
this.tryConstructEntities(fieldObjects)
|
||||
);
|
||||
return await mapMapAsync(uncheckedEntityResultsMap, async (uncheckedEntityResults) => {
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
private validateFieldValues<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly TFields[N][]
|
||||
): void {
|
||||
const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
|
||||
invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
|
||||
for (const fieldValue of fieldValues) {
|
||||
const isInputValid = fieldDefinition.validateInputValue(fieldValue);
|
||||
if (!isInputValid) {
|
||||
throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
import invariant from 'invariant';
|
||||
|
||||
import { ISecondaryEntityCache } from './EntitySecondaryCacheLoader';
|
||||
import IEntityGenericCacher from './IEntityGenericCacher';
|
||||
import { CacheStatus } from './internal/ReadThroughEntityCache';
|
||||
import { filterMap, zipToMap } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* 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 abstract class GenericSecondaryEntityCache<TFields, TLoadParams>
|
||||
implements ISecondaryEntityCache<TFields, TLoadParams>
|
||||
{
|
||||
constructor(
|
||||
protected readonly cacher: IEntityGenericCacher<TFields>,
|
||||
protected readonly constructCacheKey: (params: Readonly<TLoadParams>) => string
|
||||
) {}
|
||||
|
||||
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 cacheKeys = loadParamsArray.map(this.constructCacheKey);
|
||||
const cacheKeyToLoadParamsMap = zipToMap(cacheKeys, loadParamsArray);
|
||||
|
||||
const cacheLoadResults = await this.cacher.loadManyAsync(cacheKeys);
|
||||
|
||||
invariant(
|
||||
cacheLoadResults.size === loadParamsArray.length,
|
||||
`${this.constructor.name} loadMany should return a result for each key`
|
||||
);
|
||||
|
||||
const cacheKeysToFetch = Array.from(
|
||||
filterMap(
|
||||
cacheLoadResults,
|
||||
(cacheLoadResult) => cacheLoadResult.status === CacheStatus.MISS
|
||||
).keys()
|
||||
);
|
||||
|
||||
// put cache hits in result map
|
||||
const results: Map<Readonly<TLoadParams>, Readonly<TFields> | null> = new Map();
|
||||
cacheLoadResults.forEach((cacheLoadResult, cacheKey) => {
|
||||
if (cacheLoadResult.status === CacheStatus.HIT) {
|
||||
const loadParams = cacheKeyToLoadParamsMap.get(cacheKey);
|
||||
invariant(loadParams !== undefined, 'load params should be in cache key map');
|
||||
results.set(loadParams, cacheLoadResult.item);
|
||||
}
|
||||
});
|
||||
|
||||
// fetch any misses from DB, add DB objects to results, cache DB results, inform cache of any missing DB results
|
||||
if (cacheKeysToFetch.length > 0) {
|
||||
const loadParamsToFetch = cacheKeysToFetch.map((cacheKey) => {
|
||||
const loadParams = cacheKeyToLoadParamsMap.get(cacheKey);
|
||||
invariant(loadParams !== undefined, 'load params should be in cache 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, Readonly<TFields>> = new Map();
|
||||
for (const [loadParams, object] of fetchResults.entries()) {
|
||||
if (object) {
|
||||
objectsToCache.set(this.constructCacheKey(loadParams), object);
|
||||
results.set(loadParams, object);
|
||||
}
|
||||
}
|
||||
|
||||
await Promise.all([
|
||||
this.cacher.cacheManyAsync(objectsToCache),
|
||||
this.cacher.cacheDBMissesAsync(fetchMisses.map(this.constructCacheKey)),
|
||||
]);
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate the cache for objects cached by constructCacheKey(loadParams).
|
||||
*
|
||||
* @param loadParamsArray - load params to invalidate
|
||||
*/
|
||||
public invalidateManyAsync(loadParamsArray: readonly Readonly<TLoadParams>[]): Promise<void> {
|
||||
const cacheKeys = loadParamsArray.map(this.constructCacheKey);
|
||||
return this.cacher.invalidateManyAsync(cacheKeys);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import { CacheLoadResult } from './internal/ReadThroughEntityCache';
|
||||
|
||||
/**
|
||||
* A cacher stores and loads key-value pairs. It also supports negative caching - it stores the absence
|
||||
* of keys that don't exist in the backing datastore.
|
||||
*/
|
||||
export default interface IEntityGenericCacher<TFields> {
|
||||
loadManyAsync(keys: readonly string[]): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>>;
|
||||
|
||||
cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void>;
|
||||
|
||||
cacheDBMissesAsync(keys: readonly string[]): Promise<void>;
|
||||
|
||||
invalidateManyAsync(keys: readonly string[]): Promise<void>;
|
||||
}
|
||||
@@ -156,6 +156,6 @@ export default abstract class ReadonlyEntity<
|
||||
return viewerContext
|
||||
.getViewerScopedEntityCompanionForClass(this)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext);
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,7 @@ import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import ViewerScopedEntityLoaderFactory from './ViewerScopedEntityLoaderFactory';
|
||||
import ViewerScopedEntityMutatorFactory from './ViewerScopedEntityMutatorFactory';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
|
||||
/**
|
||||
* Provides a simpler API for loading and mutating entities by injecting the {@link ViewerContext}
|
||||
@@ -76,4 +77,11 @@ export default class ViewerScopedEntityCompanion<
|
||||
getQueryContextProvider(): EntityQueryContextProvider {
|
||||
return this.entityCompanion.getQueryContextProvider();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the {@link IEntityMetricsAdapter} for this companion.
|
||||
*/
|
||||
getMetricsAdapter(): IEntityMetricsAdapter {
|
||||
return this.entityCompanion.getMetricsAdapter();
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityLoaderFactory from './EntityLoaderFactory';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -35,8 +35,13 @@ export default class ViewerScopedEntityLoaderFactory<
|
||||
) {}
|
||||
|
||||
forLoad(
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
|
||||
return this.entityLoaderFactory.forLoad(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
|
||||
import EntityMutatorFactory from './EntityMutatorFactory';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -35,22 +35,37 @@ export default class ViewerScopedEntityMutatorFactory<
|
||||
) {}
|
||||
|
||||
forCreate(
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return this.entityMutatorFactory.forCreate(this.viewerContext, queryContext);
|
||||
return this.entityMutatorFactory.forCreate(
|
||||
this.viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext
|
||||
);
|
||||
}
|
||||
|
||||
forUpdate(
|
||||
existingEntity: TEntity,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return this.entityMutatorFactory.forUpdate(existingEntity, queryContext);
|
||||
return this.entityMutatorFactory.forUpdate(
|
||||
existingEntity,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext
|
||||
);
|
||||
}
|
||||
|
||||
forDelete(
|
||||
existingEntity: TEntity,
|
||||
queryContext: EntityQueryContext
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return this.entityMutatorFactory.forDelete(existingEntity, queryContext);
|
||||
return this.entityMutatorFactory.forDelete(
|
||||
existingEntity,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,280 @@
|
||||
import invariant from 'invariant';
|
||||
|
||||
import ComposedEntityCacheAdapter from '../ComposedEntityCacheAdapter';
|
||||
import EntityCacheAdapter from '../EntityCacheAdapter';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { UUIDField } from '../EntityFields';
|
||||
import { CacheLoadResult, CacheStatus } from '../internal/ReadThroughEntityCache';
|
||||
|
||||
type BlahFields = {
|
||||
id: string;
|
||||
};
|
||||
|
||||
const entityConfiguration = new EntityConfiguration<BlahFields>({
|
||||
idField: 'id',
|
||||
tableName: 'blah',
|
||||
schema: {
|
||||
id: new UUIDField({ columnName: 'id', cache: true }),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'local-memory-and-redis',
|
||||
});
|
||||
|
||||
export const DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = Symbol('doesNotExist');
|
||||
type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
|
||||
|
||||
class TestLocalCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly cache: Map<string, LocalMemoryCacheValue<TFields>>
|
||||
) {
|
||||
super(entityConfiguration);
|
||||
}
|
||||
|
||||
public async loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>> {
|
||||
const localMemoryCacheKeyToFieldValueMapping = new Map(
|
||||
fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue])
|
||||
);
|
||||
const cacheResults = new Map<NonNullable<TFields[N]>, CacheLoadResult<TFields>>();
|
||||
for (const [cacheKey, fieldValue] of localMemoryCacheKeyToFieldValueMapping) {
|
||||
const cacheResult = this.cache.get(cacheKey);
|
||||
if (cacheResult === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE) {
|
||||
cacheResults.set(fieldValue, {
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
} else if (cacheResult) {
|
||||
cacheResults.set(fieldValue, {
|
||||
status: CacheStatus.HIT,
|
||||
item: cacheResult,
|
||||
});
|
||||
} else {
|
||||
cacheResults.set(fieldValue, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
return cacheResults;
|
||||
}
|
||||
|
||||
public async cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>
|
||||
): Promise<void> {
|
||||
for (const [fieldValue, item] of objectMap) {
|
||||
const cacheKey = this.makeCacheKey(fieldName, fieldValue);
|
||||
this.cache.set(cacheKey, item);
|
||||
}
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
for (const fieldValue of fieldValues) {
|
||||
const cacheKey = this.makeCacheKey(fieldName, fieldValue);
|
||||
this.cache.set(cacheKey, DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||
}
|
||||
}
|
||||
|
||||
public async invalidateManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
for (const fieldValue of fieldValues) {
|
||||
const cacheKey = this.makeCacheKey(fieldName, fieldValue);
|
||||
this.cache.delete(cacheKey);
|
||||
}
|
||||
}
|
||||
|
||||
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}`);
|
||||
const parts = [
|
||||
this.entityConfiguration.tableName,
|
||||
`${this.entityConfiguration.cacheKeyVersion}`,
|
||||
columnName,
|
||||
String(fieldValue),
|
||||
];
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||
);
|
||||
return escapedParts.join(delimiter);
|
||||
}
|
||||
}
|
||||
|
||||
function makeTestCacheAdapters(): {
|
||||
primaryCache: Map<string, LocalMemoryCacheValue<BlahFields>>;
|
||||
primaryCacheAdapter: TestLocalCacheAdapter<BlahFields>;
|
||||
fallbackCache: Map<string, LocalMemoryCacheValue<BlahFields>>;
|
||||
fallbackCacheAdapter: TestLocalCacheAdapter<BlahFields>;
|
||||
cacheAdapter: ComposedEntityCacheAdapter<BlahFields>;
|
||||
} {
|
||||
const primaryCache = new Map();
|
||||
const primaryCacheAdapter = new TestLocalCacheAdapter(entityConfiguration, primaryCache);
|
||||
|
||||
const fallbackCache = new Map();
|
||||
const fallbackCacheAdapter = new TestLocalCacheAdapter(entityConfiguration, fallbackCache);
|
||||
|
||||
const cacheAdapter = new ComposedEntityCacheAdapter(entityConfiguration, [
|
||||
primaryCacheAdapter,
|
||||
fallbackCacheAdapter,
|
||||
]);
|
||||
|
||||
return {
|
||||
primaryCache,
|
||||
primaryCacheAdapter,
|
||||
fallbackCache,
|
||||
fallbackCacheAdapter,
|
||||
cacheAdapter,
|
||||
};
|
||||
}
|
||||
|
||||
describe(ComposedEntityCacheAdapter, () => {
|
||||
describe('loadManyAsync', () => {
|
||||
it('returns primary results when populated', async () => {
|
||||
const { primaryCacheAdapter, cacheAdapter } = makeTestCacheAdapters();
|
||||
|
||||
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
|
||||
await primaryCacheAdapter.cacheManyAsync('id', cacheHits);
|
||||
await primaryCacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', [
|
||||
'test-id-1',
|
||||
'test-id-2',
|
||||
'test-id-3',
|
||||
]);
|
||||
|
||||
expect(results.get('test-id-1')).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: { id: 'test-id-1' },
|
||||
});
|
||||
expect(results.get('test-id-2')).toMatchObject({ status: CacheStatus.NEGATIVE });
|
||||
expect(results.get('test-id-3')).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.size).toBe(3);
|
||||
});
|
||||
|
||||
it('returns fallback adapter results primary is empty', async () => {
|
||||
const { primaryCacheAdapter, cacheAdapter } = makeTestCacheAdapters();
|
||||
|
||||
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
|
||||
await primaryCacheAdapter.cacheManyAsync('id', cacheHits);
|
||||
await primaryCacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', [
|
||||
'test-id-1',
|
||||
'test-id-2',
|
||||
'test-id-3',
|
||||
]);
|
||||
|
||||
expect(results.get('test-id-1')).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: { id: 'test-id-1' },
|
||||
});
|
||||
expect(results.get('test-id-2')).toMatchObject({ status: CacheStatus.NEGATIVE });
|
||||
expect(results.get('test-id-3')).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.size).toBe(3);
|
||||
});
|
||||
|
||||
it('returns empty map when passed empty array of fieldValues', async () => {
|
||||
const { cacheAdapter } = makeTestCacheAdapters();
|
||||
const results = await cacheAdapter.loadManyAsync('id', []);
|
||||
expect(results).toEqual(new Map());
|
||||
});
|
||||
|
||||
it('handles 0 cache adapter compose case', async () => {
|
||||
const cacheAdapter = new ComposedEntityCacheAdapter(entityConfiguration, []);
|
||||
const results = await cacheAdapter.loadManyAsync('id', []);
|
||||
expect(results).toEqual(new Map());
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheManyAsync', () => {
|
||||
it('correctly caches all objects', async () => {
|
||||
const {
|
||||
primaryCache,
|
||||
primaryCacheAdapter,
|
||||
fallbackCache,
|
||||
fallbackCacheAdapter,
|
||||
cacheAdapter,
|
||||
} = makeTestCacheAdapters();
|
||||
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
||||
|
||||
const primaryLocalMemoryCacheKey = primaryCacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(primaryCache.get(primaryLocalMemoryCacheKey)).toMatchObject({
|
||||
id: 'test-id-1',
|
||||
});
|
||||
|
||||
const fallbackLocalMemoryCacheKey = fallbackCacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(fallbackCache.get(fallbackLocalMemoryCacheKey)).toMatchObject({
|
||||
id: 'test-id-1',
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheDBMissesAsync', () => {
|
||||
it('correctly caches misses', async () => {
|
||||
const {
|
||||
primaryCache,
|
||||
primaryCacheAdapter,
|
||||
fallbackCache,
|
||||
fallbackCacheAdapter,
|
||||
cacheAdapter,
|
||||
} = makeTestCacheAdapters();
|
||||
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']);
|
||||
|
||||
const primaryLocalMemoryCacheKey = primaryCacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(primaryCache.get(primaryLocalMemoryCacheKey)).toBe(DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||
|
||||
const fallbackLocalMemoryCacheKey = fallbackCacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(fallbackCache.get(fallbackLocalMemoryCacheKey)).toBe(
|
||||
DOES_NOT_EXIST_LOCAL_MEMORY_CACHE
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('invalidateManyAsync', () => {
|
||||
it('invalidates correctly', async () => {
|
||||
const {
|
||||
primaryCache,
|
||||
primaryCacheAdapter,
|
||||
fallbackCache,
|
||||
fallbackCacheAdapter,
|
||||
cacheAdapter,
|
||||
} = makeTestCacheAdapters();
|
||||
|
||||
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
|
||||
await primaryCacheAdapter.cacheManyAsync('id', cacheHits);
|
||||
await primaryCacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
await fallbackCacheAdapter.cacheManyAsync('id', cacheHits);
|
||||
await fallbackCacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
|
||||
await cacheAdapter.invalidateManyAsync('id', ['test-id-1', 'test-id-2']);
|
||||
|
||||
const primaryLocalMemoryCacheKey1 = primaryCacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(primaryCache.get(primaryLocalMemoryCacheKey1)).toBe(undefined);
|
||||
const primaryLocalMemoryCacheKey2 = primaryCacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(primaryCache.get(primaryLocalMemoryCacheKey2)).toBe(undefined);
|
||||
|
||||
const fallbackLocalMemoryCacheKey1 = fallbackCacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(fallbackCache.get(fallbackLocalMemoryCacheKey1)).toBe(undefined);
|
||||
const fallbackLocalMemoryCacheKey2 = fallbackCacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||
expect(fallbackCache.get(fallbackLocalMemoryCacheKey2)).toBe(undefined);
|
||||
});
|
||||
|
||||
it('returns when passed empty array of fieldValues', async () => {
|
||||
const { cacheAdapter } = makeTestCacheAdapters();
|
||||
|
||||
await cacheAdapter.invalidateManyAsync('id', []);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,101 @@
|
||||
import invariant from 'invariant';
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import ComposedSecondaryEntityCache from '../ComposedSecondaryEntityCache';
|
||||
import { ISecondaryEntityCache } from '../EntitySecondaryCacheLoader';
|
||||
|
||||
type TestFields = { id: string };
|
||||
type TestLoadParams = { lp: string };
|
||||
|
||||
class TestEntitySecondaryCache implements ISecondaryEntityCache<TestFields, TestLoadParams> {
|
||||
constructor(
|
||||
private readonly prefilledResults: Map<Readonly<TestLoadParams>, Readonly<TestFields>>
|
||||
) {}
|
||||
|
||||
async loadManyThroughAsync(
|
||||
loadParamsArray: readonly Readonly<TestLoadParams>[],
|
||||
fetcher: (
|
||||
fetcherLoadParamsArray: readonly Readonly<TestLoadParams>[]
|
||||
) => Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<TestFields> | null>>
|
||||
): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<TestFields> | null>> {
|
||||
// this does an unusual method of calling fetcher, but there's no constraint that says fetcher can only be called once
|
||||
// so this tests that
|
||||
|
||||
const retMap = new Map<Readonly<TestLoadParams>, Readonly<TestFields> | null>();
|
||||
for (const loadParams of loadParamsArray) {
|
||||
if (this.prefilledResults.has(loadParams)) {
|
||||
retMap.set(loadParams, nullthrows(this.prefilledResults.get(loadParams)));
|
||||
} else {
|
||||
const fetcherResult = await fetcher([loadParams]);
|
||||
const toSet = fetcherResult.get(loadParams);
|
||||
invariant(toSet !== undefined, 'should be set');
|
||||
retMap.set(loadParams, toSet);
|
||||
}
|
||||
}
|
||||
return retMap;
|
||||
}
|
||||
|
||||
async invalidateManyAsync(loadParamsArray: readonly Readonly<TestLoadParams>[]): Promise<void> {
|
||||
for (const loadParams of loadParamsArray) {
|
||||
this.prefilledResults.delete(loadParams);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
describe(ComposedSecondaryEntityCache, () => {
|
||||
it('composes correctly', async () => {
|
||||
// TODO(wschurman): investigate whether we can use immutable or something to do better object equality for the map keys
|
||||
const lp1 = { lp: '1' };
|
||||
const lp2 = { lp: '2' };
|
||||
const lp3 = { lp: '3' };
|
||||
|
||||
const primarySecondaryEntityCache = new TestEntitySecondaryCache(
|
||||
new Map([[lp1, { id: 'primary-1' }]])
|
||||
);
|
||||
const fallbackSecondaryEntityCache = new TestEntitySecondaryCache(
|
||||
new Map([[lp2, { id: 'fallback-2' }]])
|
||||
);
|
||||
|
||||
const composedSecondaryEntityCache = new ComposedSecondaryEntityCache([
|
||||
primarySecondaryEntityCache,
|
||||
fallbackSecondaryEntityCache,
|
||||
]);
|
||||
|
||||
const results = await composedSecondaryEntityCache.loadManyThroughAsync(
|
||||
[lp1, lp2, lp3],
|
||||
async (fetcherLoadParamsArray) =>
|
||||
new Map(fetcherLoadParamsArray.map((flp) => [flp, { id: `db-fetched-${flp.lp}` }]))
|
||||
);
|
||||
|
||||
expect(results.get(lp1)).toEqual({ id: 'primary-1' });
|
||||
expect(results.get(lp2)).toEqual({ id: 'fallback-2' });
|
||||
expect(results.get(lp3)).toEqual({ id: 'db-fetched-3' });
|
||||
|
||||
await composedSecondaryEntityCache.invalidateManyAsync([lp1, lp2, lp3]);
|
||||
|
||||
const resultsAfterInvalidate = await composedSecondaryEntityCache.loadManyThroughAsync(
|
||||
[lp1, lp2, lp3],
|
||||
async (fetcherLoadParamsArray) =>
|
||||
new Map(fetcherLoadParamsArray.map((flp) => [flp, { id: `db-fetched-${flp.lp}` }]))
|
||||
);
|
||||
|
||||
expect(resultsAfterInvalidate.get(lp1)).toEqual({ id: 'db-fetched-1' });
|
||||
expect(resultsAfterInvalidate.get(lp2)).toEqual({ id: 'db-fetched-2' });
|
||||
expect(resultsAfterInvalidate.get(lp3)).toEqual({ id: 'db-fetched-3' });
|
||||
});
|
||||
|
||||
it('handles n=0 compose case', async () => {
|
||||
const lp1 = { lp: '1' };
|
||||
const composedSecondaryEntityCache = new ComposedSecondaryEntityCache<
|
||||
TestLoadParams,
|
||||
TestFields
|
||||
>([]);
|
||||
const results = await composedSecondaryEntityCache.loadManyThroughAsync(
|
||||
[lp1],
|
||||
async (fetcherLoadParamsArray) =>
|
||||
new Map(fetcherLoadParamsArray.map((flp) => [flp, { id: `db-fetched-${flp.lp}` }]))
|
||||
);
|
||||
|
||||
expect(results.get(lp1)).toEqual({ id: 'db-fetched-1' });
|
||||
});
|
||||
});
|
||||
@@ -1,15 +1,17 @@
|
||||
import { result } from '@expo/results';
|
||||
import { mock, instance, when, anything } from 'ts-mockito';
|
||||
|
||||
import EnforcingEntityLoader from '../EnforcingEntityLoader';
|
||||
import EntityLoader from '../EntityLoader';
|
||||
import EnforcingEntityLoader from '../EntityResultLoader';
|
||||
|
||||
describe(EnforcingEntityLoader, () => {
|
||||
describe('loadManyByFieldEqualingManyAsync', () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadManyByFieldEqualingManyAsync(anything(), anything())).thenResolve(
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualingManyAsync(anything(), anything())
|
||||
).thenResolve(
|
||||
new Map(
|
||||
Object.entries({
|
||||
hello: [result(rejection)],
|
||||
@@ -26,7 +28,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadManyByFieldEqualingManyAsync(anything(), anything())).thenResolve(
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualingManyAsync(anything(), anything())
|
||||
).thenResolve(
|
||||
new Map(
|
||||
Object.entries({
|
||||
hello: [result(resolved)],
|
||||
@@ -51,9 +55,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadManyByFieldEqualingAsync(anything(), anything())).thenResolve([
|
||||
result(rejection),
|
||||
]);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve([result(rejection)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -64,9 +68,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadManyByFieldEqualingAsync(anything(), anything())).thenResolve([
|
||||
result(resolved),
|
||||
]);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve([result(resolved)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -79,9 +83,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
|
||||
result(rejection)
|
||||
);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve(result(rejection));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -92,9 +96,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
|
||||
result(resolved)
|
||||
);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve(result(resolved));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -105,9 +109,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns null when result is successful and no entity is found', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = null;
|
||||
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve(
|
||||
result(resolved)
|
||||
);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
|
||||
).thenResolve(result(resolved));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -118,9 +122,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when multiple matching entities are found', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const multipleEntitiesError = new Error();
|
||||
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenReject(
|
||||
multipleEntitiesError
|
||||
);
|
||||
when(
|
||||
entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
|
||||
).thenReject(multipleEntitiesError);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(
|
||||
@@ -133,7 +137,7 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadByIDAsync(anything())).thenResolve(result(rejection));
|
||||
when(entityLoaderMock.resultLoader.loadByIDAsync(anything())).thenResolve(result(rejection));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDAsync(anything())).rejects.toThrow(rejection);
|
||||
@@ -142,7 +146,7 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadByIDAsync(anything())).thenResolve(result(resolved));
|
||||
when(entityLoaderMock.resultLoader.loadByIDAsync(anything())).thenResolve(result(resolved));
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDAsync(anything())).resolves.toEqual(resolved);
|
||||
@@ -153,7 +157,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(rejection));
|
||||
when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
|
||||
result(rejection)
|
||||
);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).rejects.toThrow(
|
||||
@@ -164,7 +170,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(resolved));
|
||||
when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
|
||||
result(resolved)
|
||||
);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).resolves.toEqual(
|
||||
@@ -175,7 +183,9 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns null when non-existent object', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = null;
|
||||
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(resolved));
|
||||
when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
|
||||
result(resolved)
|
||||
);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).resolves.toEqual(
|
||||
@@ -188,7 +198,7 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('throws when result is unsuccessful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(entityLoaderMock.loadManyByIDsAsync(anything())).thenResolve(
|
||||
when(entityLoaderMock.resultLoader.loadManyByIDsAsync(anything())).thenResolve(
|
||||
new Map(
|
||||
Object.entries({
|
||||
hello: result(rejection),
|
||||
@@ -203,7 +213,7 @@ describe(EnforcingEntityLoader, () => {
|
||||
it('returns value when result is successful', async () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(entityLoaderMock.loadManyByIDsAsync(anything())).thenResolve(
|
||||
when(entityLoaderMock.resultLoader.loadManyByIDsAsync(anything())).thenResolve(
|
||||
new Map(
|
||||
Object.entries({
|
||||
hello: result(resolved),
|
||||
@@ -227,7 +237,10 @@ describe(EnforcingEntityLoader, () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(
|
||||
entityLoaderMock.loadManyByFieldEqualityConjunctionAsync(anything(), anything())
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualityConjunctionAsync(
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).thenResolve([result(rejection)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
@@ -240,7 +253,10 @@ describe(EnforcingEntityLoader, () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(
|
||||
entityLoaderMock.loadManyByFieldEqualityConjunctionAsync(anything(), anything())
|
||||
entityLoaderMock.resultLoader.loadManyByFieldEqualityConjunctionAsync(
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).thenResolve([result(resolved)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
@@ -255,7 +271,11 @@ describe(EnforcingEntityLoader, () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const rejection = new Error();
|
||||
when(
|
||||
entityLoaderMock.loadManyByRawWhereClauseAsync(anything(), anything(), anything())
|
||||
entityLoaderMock.resultLoader.loadManyByRawWhereClauseAsync(
|
||||
anything(),
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).thenResolve([result(rejection)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
@@ -268,7 +288,11 @@ describe(EnforcingEntityLoader, () => {
|
||||
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
|
||||
const resolved = {};
|
||||
when(
|
||||
entityLoaderMock.loadManyByRawWhereClauseAsync(anything(), anything(), anything())
|
||||
entityLoaderMock.resultLoader.loadManyByRawWhereClauseAsync(
|
||||
anything(),
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).thenResolve([result(resolved)]);
|
||||
const entityLoader = instance(entityLoaderMock);
|
||||
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
|
||||
|
||||
@@ -5,7 +5,7 @@ import Entity from '../Entity';
|
||||
import EntityCompanionProvider, { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { UUIDField } from '../EntityFields';
|
||||
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import { enforceResultsAsync } from '../entityUtils';
|
||||
@@ -51,6 +51,7 @@ class DenyIfNotOwnerPrivacyPolicyRule extends PrivacyPolicyRule<
|
||||
async evaluateAsync(
|
||||
viewerContext: TestUserViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: BlahEntity
|
||||
): Promise<RuleEvaluationResult> {
|
||||
if (viewerContext.getUserID() === entity.getField('ownerID')) {
|
||||
@@ -128,15 +129,15 @@ it('runs through a common workflow', async () => {
|
||||
|
||||
// check that two people can't read each others data
|
||||
await expect(
|
||||
enforceAsyncResult(BlahEntity.loader(vc1).loadByIDAsync(blahOwner2.getID()))
|
||||
enforceAsyncResult(BlahEntity.loader(vc1).resultLoader.loadByIDAsync(blahOwner2.getID()))
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
await expect(
|
||||
enforceAsyncResult(BlahEntity.loader(vc2).loadByIDAsync(blahOwner1.getID()))
|
||||
enforceAsyncResult(BlahEntity.loader(vc2).resultLoader.loadByIDAsync(blahOwner1.getID()))
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
|
||||
// check that all of owner 1's objects can be loaded
|
||||
const results = await enforceResultsAsync(
|
||||
BlahEntity.loader(vc1).loadManyByFieldEqualingAsync('ownerID', vc1.getUserID()!)
|
||||
BlahEntity.loader(vc1).resultLoader.loadManyByFieldEqualingAsync('ownerID', vc1.getUserID()!)
|
||||
);
|
||||
expect(results).toHaveLength(2);
|
||||
|
||||
@@ -148,7 +149,10 @@ it('runs through a common workflow', async () => {
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
|
||||
// check that empty load many returns nothing
|
||||
const results2 = await BlahEntity.loader(vc1).loadManyByFieldEqualingManyAsync('ownerID', []);
|
||||
const results2 = await BlahEntity.loader(vc1).resultLoader.loadManyByFieldEqualingManyAsync(
|
||||
'ownerID',
|
||||
[]
|
||||
);
|
||||
for (const value in results2.values) {
|
||||
expect(value).toHaveLength(0);
|
||||
}
|
||||
|
||||
@@ -3,9 +3,15 @@ import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { EntityEdgeDeletionBehavior } from '../EntityFieldDefinition';
|
||||
import { UUIDField } from '../EntityFields';
|
||||
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
|
||||
import { EntityTriggerMutationInfo, EntityMutationType } from '../EntityMutationInfo';
|
||||
import { EntityMutationTrigger } from '../EntityMutationTriggerConfiguration';
|
||||
import EntityPrivacyPolicy, {
|
||||
EntityPrivacyPolicyEvaluationContext,
|
||||
EntityAuthorizationAction,
|
||||
} from '../EntityPrivacyPolicy';
|
||||
import { EntityTransactionalQueryContext, EntityQueryContext } from '../EntityQueryContext';
|
||||
import { CacheStatus } from '../internal/ReadThroughEntityCache';
|
||||
import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
|
||||
import PrivacyPolicyRule, { RuleEvaluationResult } from '../rules/PrivacyPolicyRule';
|
||||
import TestViewerContext from '../testfixtures/TestViewerContext';
|
||||
import { InMemoryFullCacheStubCacheAdapter } from '../utils/testing/StubCacheAdapter';
|
||||
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
|
||||
@@ -24,29 +30,196 @@ interface GrandChildFields {
|
||||
parent_id: string;
|
||||
}
|
||||
|
||||
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
any,
|
||||
string,
|
||||
TestViewerContext,
|
||||
any,
|
||||
any
|
||||
> {
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
|
||||
];
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
||||
const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
|
||||
const triggerExecutionCounts = {
|
||||
ParentEntity: 0,
|
||||
ChildEntity: 0,
|
||||
GrandChildEntity: 0,
|
||||
};
|
||||
|
||||
const privacyPolicyEvaluationRecords = {
|
||||
shouldRecord: false,
|
||||
ParentEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
[EntityAuthorizationAction.DELETE]: [],
|
||||
},
|
||||
ChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
[EntityAuthorizationAction.DELETE]: [],
|
||||
},
|
||||
GrandChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
[EntityAuthorizationAction.DELETE]: [],
|
||||
},
|
||||
};
|
||||
|
||||
class AlwaysAllowPrivacyPolicyRuleThatRecords extends PrivacyPolicyRule<
|
||||
any,
|
||||
string,
|
||||
TestViewerContext,
|
||||
any,
|
||||
any
|
||||
> {
|
||||
constructor(private readonly action: EntityAuthorizationAction) {
|
||||
super();
|
||||
}
|
||||
|
||||
async evaluateAsync(
|
||||
_viewerContext: TestViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: any
|
||||
): Promise<RuleEvaluationResult> {
|
||||
if (privacyPolicyEvaluationRecords.shouldRecord) {
|
||||
(privacyPolicyEvaluationRecords as any)[entity.constructor.name][this.action].push(
|
||||
evaluationContext
|
||||
);
|
||||
}
|
||||
return RuleEvaluationResult.ALLOW;
|
||||
}
|
||||
}
|
||||
|
||||
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
any,
|
||||
string,
|
||||
TestViewerContext,
|
||||
any,
|
||||
any
|
||||
> {
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.READ),
|
||||
];
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.CREATE),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.UPDATE),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.DELETE),
|
||||
];
|
||||
}
|
||||
|
||||
class ParentCheckInfoTrigger extends EntityMutationTrigger<
|
||||
ParentFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
ParentEntity
|
||||
> {
|
||||
async executeAsync(
|
||||
_viewerContext: TestViewerContext,
|
||||
_queryContext: EntityTransactionalQueryContext,
|
||||
_entity: ParentEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<ParentFields, string, TestViewerContext, ParentEntity>
|
||||
): Promise<void> {
|
||||
if (mutationInfo.type !== EntityMutationType.DELETE) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (mutationInfo.cascadingDeleteCause !== null) {
|
||||
throw new Error('Parent entity should not have casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.ParentEntity++;
|
||||
}
|
||||
}
|
||||
|
||||
class ChildCheckInfoTrigger extends EntityMutationTrigger<
|
||||
ChildFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
ChildEntity
|
||||
> {
|
||||
async executeAsync(
|
||||
_viewerContext: TestViewerContext,
|
||||
_queryContext: EntityTransactionalQueryContext,
|
||||
_entity: ChildEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<ChildFields, string, TestViewerContext, ChildEntity>
|
||||
): Promise<void> {
|
||||
if (mutationInfo.type !== EntityMutationType.DELETE) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (mutationInfo.cascadingDeleteCause === null) {
|
||||
throw new Error('Child entity should have casade delete cause');
|
||||
}
|
||||
|
||||
const cascadingDeleteCauseEntity = mutationInfo.cascadingDeleteCause.entity;
|
||||
if (!(cascadingDeleteCauseEntity instanceof ParentEntity)) {
|
||||
throw new Error('Child entity should have casade delete cause entity of type ParentEntity');
|
||||
}
|
||||
|
||||
const secondLevelCascadingDeleteCause =
|
||||
mutationInfo.cascadingDeleteCause.cascadingDeleteCause;
|
||||
if (secondLevelCascadingDeleteCause) {
|
||||
throw new Error('Child entity should not have two-level casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.ChildEntity++;
|
||||
}
|
||||
}
|
||||
|
||||
class GrandChildCheckInfoTrigger extends EntityMutationTrigger<
|
||||
GrandChildFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
GrandChildEntity
|
||||
> {
|
||||
async executeAsync(
|
||||
_viewerContext: TestViewerContext,
|
||||
_queryContext: EntityTransactionalQueryContext,
|
||||
_entity: GrandChildEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<
|
||||
GrandChildFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
GrandChildEntity
|
||||
>
|
||||
): Promise<void> {
|
||||
if (mutationInfo.type !== EntityMutationType.DELETE) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (mutationInfo.cascadingDeleteCause === null) {
|
||||
throw new Error('GrandChild entity should have cascade delete cause');
|
||||
}
|
||||
|
||||
const cascadingDeleteCauseEntity = mutationInfo.cascadingDeleteCause.entity;
|
||||
if (!(cascadingDeleteCauseEntity instanceof ChildEntity)) {
|
||||
throw new Error(
|
||||
'GrandChild entity should have cascade delete cause entity of type ChildEntity'
|
||||
);
|
||||
}
|
||||
|
||||
const secondLevelCascadingDeleteCause =
|
||||
mutationInfo.cascadingDeleteCause.cascadingDeleteCause;
|
||||
if (!secondLevelCascadingDeleteCause) {
|
||||
throw new Error('GrandChild entity should have two-level casade delete cause');
|
||||
}
|
||||
|
||||
const secondLevelCascadingDeleteCauseEntity = secondLevelCascadingDeleteCause.entity;
|
||||
if (!(secondLevelCascadingDeleteCauseEntity instanceof ParentEntity)) {
|
||||
throw new Error(
|
||||
'GrandChild entity should have second level casade delete cause entity of type ParentEntity'
|
||||
);
|
||||
}
|
||||
|
||||
const thirdLevelCascadingDeleteCause = secondLevelCascadingDeleteCause.cascadingDeleteCause;
|
||||
if (thirdLevelCascadingDeleteCause) {
|
||||
throw new Error('GrandChild entity should not have three-level casade delete cause');
|
||||
}
|
||||
|
||||
triggerExecutionCounts.GrandChildEntity++;
|
||||
}
|
||||
}
|
||||
|
||||
class ParentEntity extends Entity<ParentFields, string, TestViewerContext> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
ParentFields,
|
||||
@@ -144,33 +317,51 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
|
||||
entityClass: ParentEntity,
|
||||
entityConfiguration: parentEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
beforeDelete: [new ParentCheckInfoTrigger()],
|
||||
afterDelete: [new ParentCheckInfoTrigger()],
|
||||
}),
|
||||
});
|
||||
|
||||
const childEntityCompanion = new EntityCompanionDefinition({
|
||||
entityClass: ChildEntity,
|
||||
entityConfiguration: childEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
beforeDelete: [new ChildCheckInfoTrigger()],
|
||||
afterDelete: [new ChildCheckInfoTrigger()],
|
||||
}),
|
||||
});
|
||||
|
||||
const grandChildEntityCompanion = new EntityCompanionDefinition({
|
||||
entityClass: GrandChildEntity,
|
||||
entityConfiguration: grandChildEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
beforeDelete: [new GrandChildCheckInfoTrigger()],
|
||||
afterDelete: [new GrandChildCheckInfoTrigger()],
|
||||
}),
|
||||
});
|
||||
|
||||
return {
|
||||
ParentEntity,
|
||||
ChildEntity,
|
||||
GrandChildEntity,
|
||||
triggerExecutionCounts,
|
||||
privacyPolicyEvaluationRecords,
|
||||
};
|
||||
};
|
||||
|
||||
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
|
||||
it('deletes', async () => {
|
||||
const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE
|
||||
);
|
||||
const {
|
||||
ParentEntity,
|
||||
ChildEntity,
|
||||
GrandChildEntity,
|
||||
triggerExecutionCounts,
|
||||
privacyPolicyEvaluationRecords,
|
||||
} = makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE);
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new TestViewerContext(companionProvider);
|
||||
|
||||
@@ -183,34 +374,107 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
|
||||
GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
privacyPolicyEvaluationRecords.shouldRecord = true;
|
||||
await ParentEntity.enforceDeleteAsync(parent);
|
||||
privacyPolicyEvaluationRecords.shouldRecord = false;
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
|
||||
GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
|
||||
).resolves.toBeNull();
|
||||
|
||||
// two calls for each trigger, one beforeDelete, one afterDelete
|
||||
expect(triggerExecutionCounts).toMatchObject({
|
||||
ParentEntity: 2,
|
||||
ChildEntity: 2,
|
||||
GrandChildEntity: 2,
|
||||
});
|
||||
|
||||
expect(privacyPolicyEvaluationRecords).toMatchObject({
|
||||
ParentEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
// one DELETE auth action for parent (since it's being deleted)
|
||||
[EntityAuthorizationAction.DELETE]: [{ cascadingDeleteCause: null }],
|
||||
},
|
||||
ChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
// one READ auth action for child in order to delete via cascade
|
||||
[EntityAuthorizationAction.READ]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
// one DELETE auth action for child (since it's being deleted via cascade)
|
||||
[EntityAuthorizationAction.DELETE]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
GrandChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
// one READ auth action for grandchild in order to delete via cascade
|
||||
[EntityAuthorizationAction.READ]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ChildEntity),
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
// one DELETE auth action for grandchild (since it's being deleted via cascade)
|
||||
[EntityAuthorizationAction.DELETE]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ChildEntity),
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
|
||||
it('sets null', async () => {
|
||||
const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
|
||||
EntityEdgeDeletionBehavior.SET_NULL
|
||||
);
|
||||
const {
|
||||
ParentEntity,
|
||||
ChildEntity,
|
||||
GrandChildEntity,
|
||||
triggerExecutionCounts,
|
||||
privacyPolicyEvaluationRecords,
|
||||
} = makeEntityClasses(EntityEdgeDeletionBehavior.SET_NULL);
|
||||
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new TestViewerContext(companionProvider);
|
||||
@@ -224,38 +488,100 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
|
||||
GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
privacyPolicyEvaluationRecords.shouldRecord = true;
|
||||
await ParentEntity.enforceDeleteAsync(parent);
|
||||
privacyPolicyEvaluationRecords.shouldRecord = false;
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.toBeNull();
|
||||
|
||||
const loadedChild = await ChildEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByIDAsync(child.getID());
|
||||
expect(loadedChild.getField('parent_id')).toBeNull();
|
||||
|
||||
const loadedGrandchild = await GrandChildEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByIDAsync(grandchild.getID());
|
||||
expect(loadedGrandchild.getField('parent_id')).toEqual(loadedChild.getID());
|
||||
|
||||
// two calls for only parent trigger, one beforeDelete, one afterDelete
|
||||
// when using set null the descendants aren't deleted
|
||||
expect(triggerExecutionCounts).toMatchObject({
|
||||
ParentEntity: 2,
|
||||
ChildEntity: 0,
|
||||
GrandChildEntity: 0,
|
||||
});
|
||||
|
||||
expect(privacyPolicyEvaluationRecords).toMatchObject({
|
||||
ParentEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
// one DELETE auth action for parent (since it's being deleted)
|
||||
[EntityAuthorizationAction.DELETE]: [{ cascadingDeleteCause: null }],
|
||||
},
|
||||
ChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
|
||||
// two READs auth action for Child during parent deletion:
|
||||
// 1. Read to initiate the SET_NULL (to update the entity)
|
||||
// 1. Read automatically post-update
|
||||
// no other entities are read since it is not cascaded past first entity
|
||||
[EntityAuthorizationAction.READ]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
],
|
||||
// one UPDATE to set null
|
||||
[EntityAuthorizationAction.UPDATE]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
],
|
||||
[EntityAuthorizationAction.DELETE]: [],
|
||||
},
|
||||
GrandChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
[EntityAuthorizationAction.DELETE]: [],
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
it('invalidates the cache', async () => {
|
||||
const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE
|
||||
);
|
||||
const {
|
||||
ParentEntity,
|
||||
ChildEntity,
|
||||
GrandChildEntity,
|
||||
triggerExecutionCounts,
|
||||
privacyPolicyEvaluationRecords,
|
||||
} = makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE);
|
||||
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new TestViewerContext(companionProvider);
|
||||
@@ -269,16 +595,16 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByFieldEqualingAsync('parent_id', parent.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
|
||||
.loadByFieldEqualingAsync('parent_id', child.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
@@ -300,7 +626,9 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
]);
|
||||
expect(grandChildCachedBefore.get(child.getID())?.status).toEqual(CacheStatus.HIT);
|
||||
|
||||
privacyPolicyEvaluationRecords.shouldRecord = true;
|
||||
await ParentEntity.enforceDeleteAsync(parent);
|
||||
privacyPolicyEvaluationRecords.shouldRecord = false;
|
||||
|
||||
const childCachedAfter = await childCacheAdapter.loadManyAsync('parent_id', [parent.getID()]);
|
||||
expect(childCachedAfter.get(parent.getID())?.status).toEqual(CacheStatus.MISS);
|
||||
@@ -311,14 +639,81 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
expect(grandChildCachedAfter.get(child.getID())?.status).toEqual(CacheStatus.MISS);
|
||||
|
||||
await expect(
|
||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||
ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||
ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
|
||||
GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
// two calls for each trigger, one beforeDelete, one afterDelete
|
||||
expect(triggerExecutionCounts).toMatchObject({
|
||||
ParentEntity: 2,
|
||||
ChildEntity: 2,
|
||||
GrandChildEntity: 2,
|
||||
});
|
||||
|
||||
expect(privacyPolicyEvaluationRecords).toMatchObject({
|
||||
ParentEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
[EntityAuthorizationAction.READ]: [],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
// one DELETE auth action for parent (since it's being deleted)
|
||||
[EntityAuthorizationAction.DELETE]: [{ cascadingDeleteCause: null }],
|
||||
},
|
||||
ChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
// one READ auth action for child in order to delete via cascade
|
||||
[EntityAuthorizationAction.READ]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
// one DELETE auth action for child (since it's being deleted via cascade)
|
||||
[EntityAuthorizationAction.DELETE]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
GrandChildEntity: {
|
||||
[EntityAuthorizationAction.CREATE]: [],
|
||||
// one READ auth action for grandchild in order to delete via cascade
|
||||
[EntityAuthorizationAction.READ]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ChildEntity),
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
[EntityAuthorizationAction.UPDATE]: [],
|
||||
// one DELETE auth action for grandchild (since it's being deleted via cascade)
|
||||
[EntityAuthorizationAction.DELETE]: [
|
||||
{
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ChildEntity),
|
||||
cascadingDeleteCause: {
|
||||
entity: expect.any(ParentEntity),
|
||||
cascadingDeleteCause: null,
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -5,7 +5,7 @@ import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { StringField } from '../EntityFields';
|
||||
import EntityLoader from '../EntityLoader';
|
||||
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import EntityDataManager from '../internal/EntityDataManager';
|
||||
import ReadThroughEntityCache from '../internal/ReadThroughEntityCache';
|
||||
@@ -118,6 +118,8 @@ export const testEntityCompanion = new EntityCompanionDefinition({
|
||||
describe(EntityLoader, () => {
|
||||
it('handles thrown errors and literals from constructor', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
|
||||
@@ -147,28 +149,30 @@ describe(EntityLoader, () => {
|
||||
databaseAdapter,
|
||||
entityCache,
|
||||
StubQueryContextProvider,
|
||||
instance(mock<IEntityMetricsAdapter>()),
|
||||
metricsAdapter,
|
||||
TestEntity.name
|
||||
);
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
|
||||
let capturedThrownThing1: any;
|
||||
try {
|
||||
await entityLoader.loadByIDAsync(ID_SENTINEL_THROW_LITERAL);
|
||||
await entityLoader.resultLoader.loadByIDAsync(ID_SENTINEL_THROW_LITERAL);
|
||||
} catch (e) {
|
||||
capturedThrownThing1 = e;
|
||||
}
|
||||
expect(capturedThrownThing1).not.toBeInstanceOf(Error);
|
||||
expect(capturedThrownThing1).toEqual('hello');
|
||||
|
||||
const result = await entityLoader.loadByIDAsync(ID_SENTINEL_THROW_ERROR);
|
||||
const result = await entityLoader.resultLoader.loadByIDAsync(ID_SENTINEL_THROW_ERROR);
|
||||
expect(result.ok).toBe(false);
|
||||
expect(result.enforceError().message).toEqual('world');
|
||||
});
|
||||
|
||||
@@ -3,6 +3,7 @@ import { mock, instance, verify, spy, deepEqual, anyOfClass, anything, when } fr
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import EntityLoader from '../EntityLoader';
|
||||
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import { enforceResultsAsync } from '../entityUtils';
|
||||
import EntityDataManager from '../internal/EntityDataManager';
|
||||
@@ -21,6 +22,8 @@ describe(EntityLoader, () => {
|
||||
it('loads entities', async () => {
|
||||
const dateToInsert = new Date();
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -68,41 +71,46 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
|
||||
const entity = await enforceAsyncResult(entityLoader.resultLoader.loadByIDAsync(id1));
|
||||
expect(entity.getID()).toEqual(id1);
|
||||
expect(entity.getField('dateField')).toEqual(dateToInsert);
|
||||
|
||||
const entities = await enforceResultsAsync(
|
||||
entityLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
entityLoader.resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
);
|
||||
expect(entities.map((m) => m.getID())).toEqual([id1, id2]);
|
||||
|
||||
const entityResultNumber3 = await entityLoader.loadByFieldEqualingAsync('intField', 3);
|
||||
const entityResultNumber3 = await entityLoader.resultLoader.loadByFieldEqualingAsync('intField', 3);
|
||||
expect(entityResultNumber3).not.toBeNull();
|
||||
expect(entityResultNumber3!.enforceValue().getID()).toEqual(id2);
|
||||
|
||||
const entityResultNumber4 = await entityLoader.loadByFieldEqualingAsync('intField', 4);
|
||||
const entityResultNumber4 = await entityLoader.resultLoader.loadByFieldEqualingAsync('intField', 4);
|
||||
expect(entityResultNumber4).toBeNull();
|
||||
|
||||
const entityResultDuplicateValues = await entityLoader
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualingManyAsync('stringField', ['huh', 'huh']);
|
||||
const entityResultDuplicateValues = await entityLoader.loadManyByFieldEqualingManyAsync(
|
||||
'stringField',
|
||||
['huh', 'huh']
|
||||
);
|
||||
expect(entityResultDuplicateValues.size).toBe(1);
|
||||
expect(entityResultDuplicateValues.get('huh')?.map((m) => m.getID())).toEqual([id1, id2]);
|
||||
|
||||
await expect(entityLoader.loadByFieldEqualingAsync('stringField', 'huh')).rejects.toThrowError(
|
||||
await expect(
|
||||
entityLoader.resultLoader.loadByFieldEqualingAsync('stringField', 'huh')
|
||||
).rejects.toThrowError(
|
||||
'loadByFieldEqualing: Multiple entities of type TestEntity found for stringField=huh'
|
||||
);
|
||||
|
||||
await expect(entityLoader.loadByIDNullableAsync(uuidv4())).resolves.toBeNull();
|
||||
await expect(entityLoader.loadByIDNullableAsync(id1)).resolves.not.toBeNull();
|
||||
await expect(entityLoader.resultLoader.loadByIDNullableAsync(uuidv4())).resolves.toBeNull();
|
||||
await expect(entityLoader.resultLoader.loadByIDNullableAsync(id1)).resolves.not.toBeNull();
|
||||
|
||||
await expect(entityLoader.loadByIDAsync('not-a-uuid')).rejects.toThrowError(
|
||||
await expect(entityLoader.resultLoader.loadByIDAsync('not-a-uuid')).rejects.toThrowError(
|
||||
'Entity field not valid: TestEntity (customIdField = not-a-uuid)'
|
||||
);
|
||||
});
|
||||
@@ -111,6 +119,8 @@ describe(EntityLoader, () => {
|
||||
const privacyPolicy = new TestEntityPrivacyPolicy();
|
||||
const spiedPrivacyPolicy = spy(privacyPolicy);
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -166,13 +176,15 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
const entities = await enforceResultsAsync(
|
||||
entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
entityLoader.resultLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{
|
||||
fieldName: 'stringField',
|
||||
fieldValue: 'huh',
|
||||
@@ -185,11 +197,17 @@ describe(EntityLoader, () => {
|
||||
);
|
||||
expect(entities).toHaveLength(2);
|
||||
verify(
|
||||
spiedPrivacyPolicy.authorizeReadAsync(viewerContext, queryContext, anyOfClass(TestEntity))
|
||||
spiedPrivacyPolicy.authorizeReadAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
anyOfClass(TestEntity),
|
||||
anything()
|
||||
)
|
||||
).twice();
|
||||
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
entityLoader.resultLoader.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'customIdField', fieldValue: 'not-a-uuid' },
|
||||
])
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (customIdField = not-a-uuid)');
|
||||
@@ -200,6 +218,8 @@ describe(EntityLoader, () => {
|
||||
const spiedPrivacyPolicy = spy(privacyPolicy);
|
||||
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -237,17 +257,29 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
|
||||
verify(spiedPrivacyPolicy.authorizeReadAsync(viewerContext, queryContext, entity)).once();
|
||||
const entity = await enforceAsyncResult(entityLoader.resultLoader.loadByIDAsync(id1));
|
||||
verify(
|
||||
spiedPrivacyPolicy.authorizeReadAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
anything()
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('invalidates upon invalidate one', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
@@ -257,10 +289,12 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
dataManagerInstance,
|
||||
metricsAdapter
|
||||
);
|
||||
await entityLoader.invalidateFieldsAsync({ customIdField: id1 } as any);
|
||||
|
||||
@@ -271,6 +305,8 @@ describe(EntityLoader, () => {
|
||||
|
||||
it('invalidates upon invalidate by field', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
@@ -280,10 +316,12 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
dataManagerInstance,
|
||||
metricsAdapter
|
||||
);
|
||||
await entityLoader.invalidateFieldsAsync({ customIdField: id1 } as any);
|
||||
verify(
|
||||
@@ -293,6 +331,8 @@ describe(EntityLoader, () => {
|
||||
|
||||
it('invalidates upon invalidate by entity', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
@@ -306,10 +346,12 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
dataManagerInstance,
|
||||
metricsAdapter
|
||||
);
|
||||
await entityLoader.invalidateEntityAsync(entityInstance);
|
||||
verify(
|
||||
@@ -319,6 +361,8 @@ describe(EntityLoader, () => {
|
||||
|
||||
it('returns error result when not allowed', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicyMock = mock(TestEntityPrivacyPolicy);
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
@@ -331,7 +375,13 @@ describe(EntityLoader, () => {
|
||||
const rejectionError = new Error();
|
||||
|
||||
when(
|
||||
privacyPolicyMock.authorizeReadAsync(viewerContext, queryContext, anyOfClass(TestEntity))
|
||||
privacyPolicyMock.authorizeReadAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
anyOfClass(TestEntity),
|
||||
anything()
|
||||
)
|
||||
).thenReject(rejectionError);
|
||||
|
||||
const privacyPolicy = instance(privacyPolicyMock);
|
||||
@@ -340,13 +390,15 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
dataManagerInstance,
|
||||
metricsAdapter
|
||||
);
|
||||
|
||||
const entityResult = await entityLoader.loadByIDAsync(id1);
|
||||
const entityResult = await entityLoader.resultLoader.loadByIDAsync(id1);
|
||||
expect(entityResult.ok).toBe(false);
|
||||
expect(entityResult.reason).toEqual(rejectionError);
|
||||
expect(entityResult.value).toBe(undefined);
|
||||
@@ -354,6 +406,8 @@ describe(EntityLoader, () => {
|
||||
|
||||
it('throws upon database adapter error', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
|
||||
const dataManagerMock = mock<EntityDataManager<TestFields>>();
|
||||
@@ -369,29 +423,31 @@ describe(EntityLoader, () => {
|
||||
const entityLoader = new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManagerInstance
|
||||
dataManagerInstance,
|
||||
metricsAdapter
|
||||
);
|
||||
|
||||
const loadByValue = uuidv4();
|
||||
|
||||
await expect(entityLoader.resultLoader.loadByIDAsync(loadByValue)).rejects.toEqual(error);
|
||||
await expect(entityLoader.loadByIDAsync(loadByValue)).rejects.toEqual(error);
|
||||
await expect(entityLoader.enforcing().loadByIDAsync(loadByValue)).rejects.toEqual(error);
|
||||
await expect(entityLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
|
||||
await expect(entityLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
|
||||
await expect(entityLoader.resultLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
|
||||
await expect(entityLoader.resultLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.resultLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue)
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue)
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.enforcing().loadManyByFieldEqualingAsync('customIdField', loadByValue)
|
||||
entityLoader.resultLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
|
||||
).rejects.toEqual(error);
|
||||
await expect(
|
||||
entityLoader.enforcing().loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
|
||||
).rejects.toEqual(error);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,105 @@
|
||||
import Entity from '../Entity';
|
||||
import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
import EntityConfiguration from '../EntityConfiguration';
|
||||
import { UUIDField } from '../EntityFields';
|
||||
import { EntityMutationType, EntityTriggerMutationInfo } from '../EntityMutationInfo';
|
||||
import { EntityNonTransactionalMutationTrigger } from '../EntityMutationTriggerConfiguration';
|
||||
import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
|
||||
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
|
||||
|
||||
type BlahFields = {
|
||||
id: string;
|
||||
};
|
||||
|
||||
class BlahEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
BlahFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
BlahEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
|
||||
];
|
||||
}
|
||||
|
||||
class BlahEntity extends Entity<BlahFields, string, ViewerContext> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
BlahFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
BlahEntity,
|
||||
BlahEntityPrivacyPolicy
|
||||
> {
|
||||
return blahCompanion;
|
||||
}
|
||||
}
|
||||
|
||||
const blahCompanion = new EntityCompanionDefinition({
|
||||
entityClass: BlahEntity,
|
||||
entityConfiguration: new EntityConfiguration<BlahFields>({
|
||||
idField: 'id',
|
||||
tableName: 'blah_table',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
}),
|
||||
privacyPolicyClass: BlahEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
afterCommit: [new TestNonTransactionalMutationTrigger()],
|
||||
}),
|
||||
});
|
||||
|
||||
class TestNonTransactionalMutationTrigger extends EntityNonTransactionalMutationTrigger<
|
||||
BlahFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
BlahEntity
|
||||
> {
|
||||
async executeAsync(
|
||||
viewerContext: ViewerContext,
|
||||
entity: BlahEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<BlahFields, string, ViewerContext, BlahEntity>
|
||||
): Promise<void> {
|
||||
if (mutationInfo.type === EntityMutationType.DELETE) {
|
||||
const entityLoaded = await BlahEntity.loader(viewerContext)
|
||||
|
||||
.loadByIDNullableAsync(entity.getID());
|
||||
if (entityLoaded) {
|
||||
throw new Error(
|
||||
'should not have been able to re-load the entity after delete. this means the cache has not been cleared'
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
describe('EntityMutator', () => {
|
||||
test('cache consistency with post-commit callbacks', async () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new ViewerContext(companionProvider);
|
||||
|
||||
// put it in cache
|
||||
const entity = await BlahEntity.creator(viewerContext).enforceCreateAsync();
|
||||
const entityLoaded = await BlahEntity.loader(viewerContext)
|
||||
|
||||
.loadByIDAsync(entity.getID());
|
||||
|
||||
await BlahEntity.enforceDeleteAsync(entityLoaded);
|
||||
});
|
||||
});
|
||||
@@ -14,13 +14,18 @@ import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import EntityDatabaseAdapter from '../EntityDatabaseAdapter';
|
||||
import EntityLoaderFactory from '../EntityLoaderFactory';
|
||||
import {
|
||||
EntityMutationType,
|
||||
EntityTriggerMutationInfo,
|
||||
EntityValidatorMutationInfo,
|
||||
} from '../EntityMutationInfo';
|
||||
import EntityMutationTriggerConfiguration, {
|
||||
EntityMutationTrigger,
|
||||
EntityNonTransactionalMutationTrigger,
|
||||
} from '../EntityMutationTriggerConfiguration';
|
||||
import EntityMutationValidator from '../EntityMutationValidator';
|
||||
import { EntityMutationInfo, EntityMutationType } from '../EntityMutator';
|
||||
import EntityMutatorFactory from '../EntityMutatorFactory';
|
||||
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
|
||||
import { EntityTransactionalQueryContext, EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import { enforceResultsAsync } from '../entityUtils';
|
||||
@@ -53,7 +58,7 @@ class TestMutationTrigger extends EntityMutationTrigger<
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
_entity: TestEntity,
|
||||
_mutationInfo: EntityMutationInfo<
|
||||
_mutationInfo: EntityTriggerMutationInfo<
|
||||
TestFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
@@ -95,7 +100,13 @@ const verifyValidatorCounts = (
|
||||
keyof TestFields
|
||||
>[],
|
||||
expectedCalls: number,
|
||||
mutationInfo: EntityMutationInfo<TestFields, string, ViewerContext, TestEntity, keyof TestFields>
|
||||
mutationInfo: EntityValidatorMutationInfo<
|
||||
TestFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
TestEntity,
|
||||
keyof TestFields
|
||||
>
|
||||
): void => {
|
||||
for (const validator of mutationValidatorSpies) {
|
||||
verify(
|
||||
@@ -164,7 +175,13 @@ const verifyTriggerCounts = (
|
||||
>,
|
||||
boolean
|
||||
>,
|
||||
mutationInfo: EntityMutationInfo<TestFields, string, ViewerContext, TestEntity, keyof TestFields>
|
||||
mutationInfo: EntityTriggerMutationInfo<
|
||||
TestFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
TestEntity,
|
||||
keyof TestFields
|
||||
>
|
||||
): void => {
|
||||
Object.keys(executed).forEach((s) => {
|
||||
if ((executed as any)[s]) {
|
||||
@@ -297,7 +314,8 @@ const createEntityMutatorFactory = (
|
||||
testEntityConfiguration,
|
||||
TestEntity,
|
||||
privacyPolicy,
|
||||
dataManager
|
||||
dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
const entityMutatorFactory = new EntityMutatorFactory(
|
||||
testEntityConfiguration,
|
||||
@@ -323,6 +341,7 @@ describe(EntityMutatorFactory, () => {
|
||||
describe('forCreate', () => {
|
||||
it('creates entities', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -346,7 +365,7 @@ describe(EntityMutatorFactory, () => {
|
||||
},
|
||||
]);
|
||||
const newEntity = await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
expect(newEntity).toBeTruthy();
|
||||
@@ -354,6 +373,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('checks privacy', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -380,7 +400,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const spiedPrivacyPolicy = spy(privacyPolicy);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
|
||||
@@ -388,13 +408,16 @@ describe(EntityMutatorFactory, () => {
|
||||
spiedPrivacyPolicy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(TestEntity)
|
||||
privacyPolicyEvaluationContext,
|
||||
anyOfClass(TestEntity),
|
||||
anything()
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('executes triggers', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -421,7 +444,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
|
||||
@@ -442,6 +465,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('executes validators', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -468,7 +492,7 @@ describe(EntityMutatorFactory, () => {
|
||||
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.enforceCreateAsync();
|
||||
|
||||
@@ -479,6 +503,7 @@ describe(EntityMutatorFactory, () => {
|
||||
describe('forUpdate', () => {
|
||||
it('updates entities', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -503,11 +528,13 @@ describe(EntityMutatorFactory, () => {
|
||||
]);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
|
||||
const updatedEntity = await entityMutatorFactory
|
||||
.forUpdate(existingEntity, queryContext)
|
||||
.forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
@@ -516,13 +543,16 @@ describe(EntityMutatorFactory, () => {
|
||||
expect(updatedEntity.getField('stringField')).toEqual('huh2');
|
||||
|
||||
const reloadedEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
expect(reloadedEntity.getAllFields()).toMatchObject(updatedEntity.getAllFields());
|
||||
});
|
||||
|
||||
it('checks privacy', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -550,11 +580,13 @@ describe(EntityMutatorFactory, () => {
|
||||
const spiedPrivacyPolicy = spy(privacyPolicy);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forUpdate(existingEntity, queryContext)
|
||||
.forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
@@ -562,13 +594,16 @@ describe(EntityMutatorFactory, () => {
|
||||
spiedPrivacyPolicy.authorizeUpdateAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(TestEntity)
|
||||
privacyPolicyEvaluationContext,
|
||||
anyOfClass(TestEntity),
|
||||
anything()
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('executes triggers', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -596,11 +631,13 @@ describe(EntityMutatorFactory, () => {
|
||||
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forUpdate(existingEntity, queryContext)
|
||||
.forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
@@ -620,6 +657,7 @@ describe(EntityMutatorFactory, () => {
|
||||
});
|
||||
it('executes validators', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -647,11 +685,13 @@ describe(EntityMutatorFactory, () => {
|
||||
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id2)
|
||||
);
|
||||
|
||||
await entityMutatorFactory
|
||||
.forUpdate(existingEntity, queryContext)
|
||||
.forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
@@ -665,6 +705,7 @@ describe(EntityMutatorFactory, () => {
|
||||
describe('forDelete', () => {
|
||||
it('deletes entities', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -680,21 +721,28 @@ describe(EntityMutatorFactory, () => {
|
||||
]);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
);
|
||||
expect(existingEntity).toBeTruthy();
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
await entityMutatorFactory
|
||||
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.enforceDeleteAsync();
|
||||
|
||||
await expect(
|
||||
enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
)
|
||||
).rejects.toBeInstanceOf(Error);
|
||||
});
|
||||
|
||||
it('checks privacy', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -713,22 +761,29 @@ describe(EntityMutatorFactory, () => {
|
||||
const spiedPrivacyPolicy = spy(privacyPolicy);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
await entityMutatorFactory
|
||||
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.enforceDeleteAsync();
|
||||
|
||||
verify(
|
||||
spiedPrivacyPolicy.authorizeDeleteAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(TestEntity)
|
||||
anything(),
|
||||
anyOfClass(TestEntity),
|
||||
anything()
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('executes triggers', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -747,10 +802,14 @@ describe(EntityMutatorFactory, () => {
|
||||
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
await entityMutatorFactory
|
||||
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.enforceDeleteAsync();
|
||||
|
||||
verifyTriggerCounts(
|
||||
viewerContext,
|
||||
@@ -763,12 +822,13 @@ describe(EntityMutatorFactory, () => {
|
||||
beforeDelete: true,
|
||||
afterDelete: true,
|
||||
},
|
||||
{ type: EntityMutationType.DELETE }
|
||||
{ type: EntityMutationType.DELETE, cascadingDeleteCause: null }
|
||||
);
|
||||
});
|
||||
|
||||
it('does not execute validators', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -787,17 +847,24 @@ describe(EntityMutatorFactory, () => {
|
||||
const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
|
||||
|
||||
const existingEntity = await enforceAsyncResult(
|
||||
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadByIDAsync(id1)
|
||||
);
|
||||
|
||||
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
|
||||
await entityMutatorFactory
|
||||
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.enforceDeleteAsync();
|
||||
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 0, { type: EntityMutationType.DELETE });
|
||||
verifyValidatorCounts(viewerContext, validatorSpies, 0, {
|
||||
type: EntityMutationType.DELETE as any,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('invalidates cache for fields upon create', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
|
||||
const id1 = uuidv4();
|
||||
@@ -814,28 +881,29 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
const entites1 = await enforceResultsAsync(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext)
|
||||
.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
);
|
||||
expect(entites1).toHaveLength(1);
|
||||
|
||||
await enforceAsyncResult(
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const entities2 = await enforceResultsAsync(
|
||||
entityLoaderFactory
|
||||
.forLoad(viewerContext, queryContext)
|
||||
.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
|
||||
);
|
||||
expect(entities2).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('throws error when field not valid', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const id1 = uuidv4();
|
||||
const { entityMutatorFactory } = createEntityMutatorFactory([
|
||||
@@ -851,19 +919,19 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
await expect(
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 10 as any)
|
||||
.createAsync()
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
|
||||
|
||||
const createdEntity = await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
entityMutatorFactory
|
||||
.forUpdate(createdEntity, queryContext)
|
||||
.forUpdate(createdEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 10 as any)
|
||||
.updateAsync()
|
||||
).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
|
||||
@@ -871,6 +939,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('returns error result when not authorized to create', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicyMock = mock(SimpleTestEntityPrivacyPolicy);
|
||||
const databaseAdapter = instance(mock<EntityDatabaseAdapter<SimpleTestFields>>());
|
||||
@@ -894,21 +963,27 @@ describe(EntityMutatorFactory, () => {
|
||||
privacyPolicyMock.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(SimpleTestEntity)
|
||||
anything(),
|
||||
anyOfClass(SimpleTestEntity),
|
||||
anything()
|
||||
)
|
||||
).thenReject(rejectionError);
|
||||
when(
|
||||
privacyPolicyMock.authorizeUpdateAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(SimpleTestEntity)
|
||||
anything(),
|
||||
anyOfClass(SimpleTestEntity),
|
||||
anything()
|
||||
)
|
||||
).thenReject(rejectionError);
|
||||
when(
|
||||
privacyPolicyMock.authorizeDeleteAsync(
|
||||
viewerContext,
|
||||
anyOfClass(EntityTransactionalQueryContext),
|
||||
anyOfClass(SimpleTestEntity)
|
||||
anything(),
|
||||
anyOfClass(SimpleTestEntity),
|
||||
anything()
|
||||
)
|
||||
).thenReject(rejectionError);
|
||||
|
||||
@@ -924,7 +999,7 @@ describe(EntityMutatorFactory, () => {
|
||||
);
|
||||
|
||||
const entityCreateResult = await entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.createAsync();
|
||||
expect(entityCreateResult.ok).toBe(false);
|
||||
expect(entityCreateResult.reason).toEqual(rejectionError);
|
||||
@@ -936,14 +1011,14 @@ describe(EntityMutatorFactory, () => {
|
||||
});
|
||||
|
||||
const entityUpdateResult = await entityMutatorFactory
|
||||
.forUpdate(fakeEntity, queryContext)
|
||||
.forUpdate(fakeEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.updateAsync();
|
||||
expect(entityUpdateResult.ok).toBe(false);
|
||||
expect(entityUpdateResult.reason).toEqual(rejectionError);
|
||||
expect(entityUpdateResult.value).toBe(undefined);
|
||||
|
||||
const entityDeleteResult = await entityMutatorFactory
|
||||
.forDelete(fakeEntity, queryContext)
|
||||
.forDelete(fakeEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.deleteAsync();
|
||||
expect(entityDeleteResult.ok).toBe(false);
|
||||
expect(entityDeleteResult.reason).toEqual(rejectionError);
|
||||
@@ -952,6 +1027,7 @@ describe(EntityMutatorFactory, () => {
|
||||
|
||||
it('throws error when db adapter throws', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const privacyPolicy = instance(mock(SimpleTestEntityPrivacyPolicy));
|
||||
const databaseAdapterMock = mock<EntityDatabaseAdapter<SimpleTestFields>>();
|
||||
@@ -1007,37 +1083,48 @@ describe(EntityMutatorFactory, () => {
|
||||
});
|
||||
|
||||
await expect(
|
||||
entityMutatorFactory.forCreate(viewerContext, queryContext).createAsync()
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.createAsync()
|
||||
).rejects.toEqual(rejectionError);
|
||||
await expect(
|
||||
entityMutatorFactory.forUpdate(fakeEntity, queryContext).updateAsync()
|
||||
entityMutatorFactory
|
||||
.forUpdate(fakeEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.updateAsync()
|
||||
).rejects.toEqual(rejectionError);
|
||||
await expect(
|
||||
entityMutatorFactory.forDelete(fakeEntity, queryContext).deleteAsync()
|
||||
entityMutatorFactory
|
||||
.forDelete(fakeEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.deleteAsync()
|
||||
).rejects.toEqual(rejectionError);
|
||||
});
|
||||
|
||||
it('records metrics appropriately', async () => {
|
||||
const viewerContext = mock<ViewerContext>();
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = StubQueryContextProvider.getQueryContext();
|
||||
const { entityMutatorFactory, metricsAdapter } = createEntityMutatorFactory([]);
|
||||
const spiedMetricsAdapter = spy(metricsAdapter);
|
||||
|
||||
const newEntity = await enforceAsyncResult(
|
||||
entityMutatorFactory
|
||||
.forCreate(viewerContext, queryContext)
|
||||
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'huh')
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
await enforceAsyncResult(
|
||||
entityMutatorFactory
|
||||
.forUpdate(newEntity, queryContext)
|
||||
.forUpdate(newEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.setField('stringField', 'wat')
|
||||
.updateAsync()
|
||||
);
|
||||
|
||||
await enforceAsyncResult(entityMutatorFactory.forDelete(newEntity, queryContext).deleteAsync());
|
||||
await enforceAsyncResult(
|
||||
entityMutatorFactory
|
||||
.forDelete(newEntity, queryContext, privacyPolicyEvaluationContext)
|
||||
.deleteAsync()
|
||||
);
|
||||
|
||||
verify(
|
||||
spiedMetricsAdapter.logMutatorMutationEvent(
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { mock, instance, spy, verify, anyOfClass } from 'ts-mockito';
|
||||
import { mock, instance, spy, verify, anyOfClass, anything, objectContaining } from 'ts-mockito';
|
||||
|
||||
import Entity from '../Entity';
|
||||
import { EntityCompanionDefinition } from '../EntityCompanionProvider';
|
||||
@@ -6,11 +6,16 @@ import EntityConfiguration from '../EntityConfiguration';
|
||||
import { UUIDField } from '../EntityFields';
|
||||
import EntityPrivacyPolicy, {
|
||||
EntityPrivacyPolicyEvaluator,
|
||||
EntityAuthorizationAction,
|
||||
EntityPrivacyPolicyEvaluationMode,
|
||||
EntityPrivacyPolicyEvaluationContext,
|
||||
} from '../EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import EntityNotAuthorizedError from '../errors/EntityNotAuthorizedError';
|
||||
import IEntityMetricsAdapter, {
|
||||
EntityMetricsAuthorizationResult,
|
||||
} from '../metrics/IEntityMetricsAdapter';
|
||||
import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
|
||||
import AlwaysDenyPrivacyPolicyRule from '../rules/AlwaysDenyPrivacyPolicyRule';
|
||||
import AlwaysSkipPrivacyPolicyRule from '../rules/AlwaysSkipPrivacyPolicyRule';
|
||||
@@ -162,6 +167,7 @@ class AlwaysThrowPrivacyPolicyRule extends PrivacyPolicyRule<
|
||||
evaluateAsync(
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
_entity: BlahEntity
|
||||
): Promise<RuleEvaluationResult> {
|
||||
throw new Error('WooHoo!');
|
||||
@@ -237,143 +243,333 @@ const blahEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
});
|
||||
|
||||
describe(EntityPrivacyPolicy, () => {
|
||||
it('throws EntityNotAuthorizedError when deny', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new AlwaysDenyPolicy();
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(viewerContext, queryContext, entity)
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
describe(EntityPrivacyPolicyEvaluationMode.ENFORCE.toString(), () => {
|
||||
it('throws EntityNotAuthorizedError when deny', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new AlwaysDenyPolicy();
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
)
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
verify(
|
||||
metricsAdapterMock.logAuthorizationEvent(
|
||||
objectContaining({
|
||||
entityClassName: entity.constructor.name,
|
||||
action: EntityAuthorizationAction.CREATE,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.DENY,
|
||||
privacyPolicyEvaluationMode: EntityPrivacyPolicyEvaluationMode.ENFORCE,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('returns entity when allowed', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new AlwaysAllowPolicy();
|
||||
const approvedEntity = await policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
);
|
||||
expect(approvedEntity).toEqual(entity);
|
||||
verify(
|
||||
metricsAdapterMock.logAuthorizationEvent(
|
||||
objectContaining({
|
||||
entityClassName: entity.constructor.name,
|
||||
action: EntityAuthorizationAction.CREATE,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
|
||||
privacyPolicyEvaluationMode: EntityPrivacyPolicyEvaluationMode.ENFORCE,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('throws EntityNotAuthorizedError when all skipped', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new SkipAllPolicy();
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
)
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
verify(
|
||||
metricsAdapterMock.logAuthorizationEvent(
|
||||
objectContaining({
|
||||
entityClassName: entity.constructor.name,
|
||||
action: EntityAuthorizationAction.CREATE,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.DENY,
|
||||
privacyPolicyEvaluationMode: EntityPrivacyPolicyEvaluationMode.ENFORCE,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('throws EntityNotAuthorizedError when empty policy', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new EmptyPolicy();
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
)
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
verify(
|
||||
metricsAdapterMock.logAuthorizationEvent(
|
||||
objectContaining({
|
||||
entityClassName: entity.constructor.name,
|
||||
action: EntityAuthorizationAction.CREATE,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.DENY,
|
||||
privacyPolicyEvaluationMode: EntityPrivacyPolicyEvaluationMode.ENFORCE,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('throws when rule throws', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new ThrowAllPolicy();
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
)
|
||||
).rejects.toThrowError('WooHoo!');
|
||||
verify(metricsAdapterMock.logAuthorizationEvent(anything())).never();
|
||||
});
|
||||
});
|
||||
|
||||
it('returns entity when allowed', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new AlwaysAllowPolicy();
|
||||
const approvedEntity = await policy.authorizeCreateAsync(viewerContext, queryContext, entity);
|
||||
expect(approvedEntity).toEqual(entity);
|
||||
});
|
||||
|
||||
it('throws EntityNotAuthorizedError when all skipped', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new SkipAllPolicy();
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(viewerContext, queryContext, entity)
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
});
|
||||
|
||||
it('throws EntityNotAuthorizedError when empty policy', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new EmptyPolicy();
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(viewerContext, queryContext, entity)
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
});
|
||||
|
||||
it('throws when rule throws', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new ThrowAllPolicy();
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(viewerContext, queryContext, entity)
|
||||
).rejects.toThrowError('WooHoo!');
|
||||
});
|
||||
|
||||
describe('dry run', () => {
|
||||
describe(EntityPrivacyPolicyEvaluationMode.DRY_RUN.toString(), () => {
|
||||
it('returns entity when denied but calls denialHandler', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new DryRunAlwaysDenyPolicy();
|
||||
|
||||
const policySpy = spy(policy);
|
||||
|
||||
const approvedEntity = await policy.authorizeCreateAsync(viewerContext, queryContext, entity);
|
||||
const approvedEntity = await policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
);
|
||||
expect(approvedEntity).toEqual(entity);
|
||||
|
||||
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).once();
|
||||
|
||||
verify(
|
||||
metricsAdapterMock.logAuthorizationEvent(
|
||||
objectContaining({
|
||||
entityClassName: entity.constructor.name,
|
||||
action: EntityAuthorizationAction.CREATE,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.DENY,
|
||||
privacyPolicyEvaluationMode: EntityPrivacyPolicyEvaluationMode.DRY_RUN,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('does not log when not denied', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new DryRunAlwaysAllowPolicy();
|
||||
|
||||
const policySpy = spy(policy);
|
||||
|
||||
const approvedEntity = await policy.authorizeCreateAsync(viewerContext, queryContext, entity);
|
||||
const approvedEntity = await policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
);
|
||||
expect(approvedEntity).toEqual(entity);
|
||||
|
||||
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).never();
|
||||
|
||||
verify(
|
||||
metricsAdapterMock.logAuthorizationEvent(
|
||||
objectContaining({
|
||||
entityClassName: entity.constructor.name,
|
||||
action: EntityAuthorizationAction.CREATE,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
|
||||
privacyPolicyEvaluationMode: EntityPrivacyPolicyEvaluationMode.DRY_RUN,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('passes through other errors', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new DryRunThrowAllPolicy();
|
||||
|
||||
const policySpy = spy(policy);
|
||||
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(viewerContext, queryContext, entity)
|
||||
policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
)
|
||||
).rejects.toThrowError('WooHoo!');
|
||||
|
||||
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).never();
|
||||
|
||||
verify(metricsAdapterMock.logAuthorizationEvent(anything())).never();
|
||||
});
|
||||
});
|
||||
|
||||
describe('logging enforce', () => {
|
||||
describe(EntityPrivacyPolicyEvaluationMode.ENFORCE_AND_LOG.toString(), () => {
|
||||
it('denies when denied but calls denialHandler', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new LoggingEnforceAlwaysDenyPolicy();
|
||||
|
||||
const policySpy = spy(policy);
|
||||
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(viewerContext, queryContext, entity)
|
||||
policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
)
|
||||
).rejects.toBeInstanceOf(EntityNotAuthorizedError);
|
||||
|
||||
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).once();
|
||||
|
||||
verify(
|
||||
metricsAdapterMock.logAuthorizationEvent(
|
||||
objectContaining({
|
||||
entityClassName: entity.constructor.name,
|
||||
action: EntityAuthorizationAction.CREATE,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.DENY,
|
||||
privacyPolicyEvaluationMode: EntityPrivacyPolicyEvaluationMode.ENFORCE_AND_LOG,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('does not log when not denied', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new LoggingEnforceAlwaysAllowPolicy();
|
||||
|
||||
const policySpy = spy(policy);
|
||||
|
||||
const approvedEntity = await policy.authorizeCreateAsync(viewerContext, queryContext, entity);
|
||||
const approvedEntity = await policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
);
|
||||
expect(approvedEntity).toEqual(entity);
|
||||
|
||||
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).never();
|
||||
|
||||
verify(
|
||||
metricsAdapterMock.logAuthorizationEvent(
|
||||
objectContaining({
|
||||
entityClassName: entity.constructor.name,
|
||||
action: EntityAuthorizationAction.CREATE,
|
||||
evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
|
||||
privacyPolicyEvaluationMode: EntityPrivacyPolicyEvaluationMode.ENFORCE_AND_LOG,
|
||||
})
|
||||
)
|
||||
).once();
|
||||
});
|
||||
|
||||
it('passes through other errors', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const metricsAdapterMock = mock<IEntityMetricsAdapter>();
|
||||
const metricsAdapter = instance(metricsAdapterMock);
|
||||
const entity = new BlahEntity(viewerContext, { id: '1' });
|
||||
const policy = new LoggingEnforceThrowAllPolicy();
|
||||
|
||||
const policySpy = spy(policy);
|
||||
|
||||
await expect(
|
||||
policy.authorizeCreateAsync(viewerContext, queryContext, entity)
|
||||
policy.authorizeCreateAsync(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
entity,
|
||||
metricsAdapter
|
||||
)
|
||||
).rejects.toThrowError('WooHoo!');
|
||||
|
||||
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).never();
|
||||
|
||||
verify(metricsAdapterMock.logAuthorizationEvent(anything())).never();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,82 @@
|
||||
import invariant from 'invariant';
|
||||
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
|
||||
|
||||
describe(EntityQueryContext, () => {
|
||||
describe('callbacks', () => {
|
||||
it('calls all callbacks, and calls invalidation first', async () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new ViewerContext(companionProvider);
|
||||
|
||||
const preCommitFirstCallback = jest.fn(async (): Promise<void> => {});
|
||||
const preCommitSecondCallback = jest.fn(async (): Promise<void> => {});
|
||||
const postCommitInvalidationCallback = jest.fn(async (): Promise<void> => {
|
||||
invariant(
|
||||
preCommitFirstCallback.mock.calls.length === 1,
|
||||
'preCommit should be called before postCommitInvalidation'
|
||||
);
|
||||
invariant(
|
||||
preCommitSecondCallback.mock.calls.length === 1,
|
||||
'preCommit should be called before postCommitInvalidation'
|
||||
);
|
||||
});
|
||||
const postCommitCallback = jest.fn(async (): Promise<void> => {
|
||||
invariant(
|
||||
preCommitFirstCallback.mock.calls.length === 1,
|
||||
'preCommit should be called before postCommit'
|
||||
);
|
||||
invariant(
|
||||
preCommitSecondCallback.mock.calls.length === 1,
|
||||
'preCommit should be called before postCommit'
|
||||
);
|
||||
invariant(
|
||||
postCommitInvalidationCallback.mock.calls.length === 1,
|
||||
'postCommitInvalidation should be called before postCommit'
|
||||
);
|
||||
});
|
||||
|
||||
await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
|
||||
'postgres',
|
||||
async (queryContext) => {
|
||||
queryContext.appendPostCommitCallback(postCommitCallback);
|
||||
queryContext.appendPostCommitInvalidationCallback(postCommitInvalidationCallback);
|
||||
queryContext.appendPreCommitCallback(preCommitSecondCallback, 2);
|
||||
queryContext.appendPreCommitCallback(preCommitFirstCallback, 1);
|
||||
}
|
||||
);
|
||||
|
||||
expect(preCommitFirstCallback).toHaveBeenCalledTimes(1);
|
||||
expect(preCommitSecondCallback).toHaveBeenCalledTimes(1);
|
||||
expect(postCommitCallback).toHaveBeenCalledTimes(1);
|
||||
expect(postCommitInvalidationCallback).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('prevents transaction from finishing when precommit throws (post commit callbacks are not called)', async () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const viewerContext = new ViewerContext(companionProvider);
|
||||
|
||||
const preCommitCallback = jest.fn(async (): Promise<void> => {
|
||||
throw new Error('wat');
|
||||
});
|
||||
const postCommitInvalidationCallback = jest.fn(async (): Promise<void> => {});
|
||||
const postCommitCallback = jest.fn(async (): Promise<void> => {});
|
||||
|
||||
await expect(
|
||||
viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
|
||||
'postgres',
|
||||
async (queryContext) => {
|
||||
queryContext.appendPostCommitCallback(postCommitCallback);
|
||||
queryContext.appendPostCommitInvalidationCallback(postCommitInvalidationCallback);
|
||||
queryContext.appendPreCommitCallback(preCommitCallback, 0);
|
||||
}
|
||||
)
|
||||
).rejects.toThrowError('wat');
|
||||
|
||||
expect(preCommitCallback).toHaveBeenCalledTimes(1);
|
||||
expect(postCommitCallback).toHaveBeenCalledTimes(0);
|
||||
expect(postCommitInvalidationCallback).toHaveBeenCalledTimes(0);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -78,6 +78,8 @@ describe(EntitySecondaryCacheLoader, () => {
|
||||
spiedPrivacyPolicy.authorizeReadAsync(
|
||||
vc1,
|
||||
anyOfClass(EntityNonTransactionalQueryContext),
|
||||
anything(),
|
||||
anything(),
|
||||
anything()
|
||||
)
|
||||
).once();
|
||||
|
||||
@@ -98,25 +98,25 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
await CategoryEntity.enforceDeleteAsync(parentCategory);
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
|
||||
@@ -137,10 +137,10 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
|
||||
await CategoryEntity.enforceDeleteAsync(categoryA);
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(categoryA.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(categoryA.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(categoryB.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(categoryB.getID())
|
||||
).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -161,29 +161,29 @@ describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
await CategoryEntity.enforceDeleteAsync(parentCategory);
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
|
||||
const loadedSubCategory = await CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(subCategory.getID());
|
||||
const loadedSubCategory = await CategoryEntity.loader(viewerContext).loadByIDAsync(
|
||||
subCategory.getID()
|
||||
);
|
||||
expect(loadedSubCategory.getField('parent_category_id')).toBeNull();
|
||||
|
||||
const loadedSubSubCategory = await CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(subSubCategory.getID());
|
||||
const loadedSubSubCategory = await CategoryEntity.loader(viewerContext).loadByIDAsync(
|
||||
subSubCategory.getID()
|
||||
);
|
||||
expect(loadedSubSubCategory.getField('parent_category_id')).not.toBeNull();
|
||||
});
|
||||
|
||||
@@ -203,9 +203,9 @@ describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
|
||||
|
||||
await CategoryEntity.enforceDeleteAsync(categoryA);
|
||||
|
||||
const loadedCategoryB = await CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(categoryB.getID());
|
||||
const loadedCategoryB = await CategoryEntity.loader(viewerContext).loadByIDAsync(
|
||||
categoryB.getID()
|
||||
);
|
||||
expect(loadedCategoryB.getField('parent_category_id')).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -228,17 +228,19 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_category_id', parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'parent_category_id',
|
||||
parentCategory.getID()
|
||||
)
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_category_id', subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'parent_category_id',
|
||||
subCategory.getID()
|
||||
)
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
|
||||
@@ -271,13 +273,13 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
expect(subSubCategoryCachedAfter.get(subCategory.getID())?.status).toEqual(CacheStatus.MISS);
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
|
||||
).resolves.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
|
||||
).resolves.not.toBeNull();
|
||||
});
|
||||
|
||||
@@ -298,14 +300,16 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
|
||||
.enforceUpdateAsync();
|
||||
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_category_id', categoryA.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'parent_category_id',
|
||||
categoryA.getID()
|
||||
)
|
||||
).resolves.not.toBeNull();
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('parent_category_id', categoryB.getID())
|
||||
CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
|
||||
'parent_category_id',
|
||||
categoryB.getID()
|
||||
)
|
||||
).resolves.not.toBeNull();
|
||||
|
||||
const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { mock, verify, instance } from 'ts-mockito';
|
||||
|
||||
import EntityLoaderFactory from '../EntityLoaderFactory';
|
||||
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import ViewerScopedEntityLoaderFactory from '../ViewerScopedEntityLoaderFactory';
|
||||
@@ -8,6 +9,7 @@ import ViewerScopedEntityLoaderFactory from '../ViewerScopedEntityLoaderFactory'
|
||||
describe(ViewerScopedEntityLoaderFactory, () => {
|
||||
it('correctly scopes viewer to entity loads', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const baseLoader = mock<EntityLoaderFactory<any, any, any, any, any, any>>(EntityLoaderFactory);
|
||||
const baseLoaderInstance = instance(baseLoader);
|
||||
@@ -21,8 +23,8 @@ describe(ViewerScopedEntityLoaderFactory, () => {
|
||||
any
|
||||
>(baseLoaderInstance, viewerContext);
|
||||
|
||||
viewerScopedEntityLoader.forLoad(queryContext);
|
||||
viewerScopedEntityLoader.forLoad(queryContext, privacyPolicyEvaluationContext);
|
||||
|
||||
verify(baseLoader.forLoad(viewerContext, queryContext)).once();
|
||||
verify(baseLoader.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)).once();
|
||||
});
|
||||
});
|
||||
@@ -1,6 +1,7 @@
|
||||
import { mock, instance, verify } from 'ts-mockito';
|
||||
|
||||
import EntityMutatorFactory from '../EntityMutatorFactory';
|
||||
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from '../EntityQueryContext';
|
||||
import ViewerContext from '../ViewerContext';
|
||||
import ViewerScopedEntityMutatorFactory from '../ViewerScopedEntityMutatorFactory';
|
||||
@@ -9,6 +10,7 @@ import TestEntity, { TestFields, TestEntityPrivacyPolicy } from '../testfixtures
|
||||
describe(ViewerScopedEntityMutatorFactory, () => {
|
||||
it('correctly scopes viewer to entity mutations', async () => {
|
||||
const viewerContext = instance(mock(ViewerContext));
|
||||
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
|
||||
const queryContext = instance(mock(EntityQueryContext));
|
||||
const baseMutatorFactory =
|
||||
mock<
|
||||
@@ -25,8 +27,10 @@ describe(ViewerScopedEntityMutatorFactory, () => {
|
||||
keyof TestFields
|
||||
>(baseMutatorFactoryInstance, viewerContext);
|
||||
|
||||
viewerScopedEntityLoader.forCreate(queryContext);
|
||||
viewerScopedEntityLoader.forCreate(queryContext, privacyPolicyEvaluationContext);
|
||||
|
||||
verify(baseMutatorFactory.forCreate(viewerContext, queryContext)).once();
|
||||
verify(
|
||||
baseMutatorFactory.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
|
||||
).once();
|
||||
});
|
||||
});
|
||||
Loaded 100 of 117 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user