Compare commits

...
86 changed files with 2644 additions and 922 deletions

No files matched your search

+45
View File
@@ -3,6 +3,51 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
+1 -1
View File
@@ -4,5 +4,5 @@
], ],
"npmClient": "yarn", "npmClient": "yarn",
"useWorkspaces": true, "useWorkspaces": true,
"version": "0.24.0" "version": "0.25.3"
} }
+5 -3
View File
@@ -18,11 +18,11 @@
"devDependencies": { "devDependencies": {
"@expo/entity": "file:packages/entity", "@expo/entity": "file:packages/entity",
"@expo/results": "^1.0.0", "@expo/results": "^1.0.0",
"@types/lru-cache": "^5.1.1",
"@types/invariant": "^2.2.33", "@types/invariant": "^2.2.33",
"@types/ioredis": "^4.26.4", "@types/ioredis": "^4.26.4",
"@types/jest": "^26.0.10", "@types/jest": "^26.0.10",
"@types/jsbn": "^1.2.29", "@types/jsbn": "^1.2.29",
"@types/lru-cache": "^5.1.1",
"@types/node": "^14.6.0", "@types/node": "^14.6.0",
"@types/uuid": "^8.3.0", "@types/uuid": "^8.3.0",
"@typescript-eslint/eslint-plugin": "^4.14.0", "@typescript-eslint/eslint-plugin": "^4.14.0",
@@ -33,6 +33,7 @@
"eslint-plugin-tsdoc": "^0.2.11", "eslint-plugin-tsdoc": "^0.2.11",
"jest": "^26.6.3", "jest": "^26.6.3",
"lerna": "^4.0.0", "lerna": "^4.0.0",
"lru-cache": "^6.0.0",
"nullthrows": "^1.1.1", "nullthrows": "^1.1.1",
"pg": "^8.6.0", "pg": "^8.6.0",
"prettier": "^2.3.2", "prettier": "^2.3.2",
@@ -47,7 +48,8 @@
"@expo/entity-cache-adapter-local-memory": "file:packages/entity-cache-adapter-local-memory", "@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-cache-adapter-redis": "file:packages/entity-cache-adapter-redis",
"@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex", "@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex",
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis", "@expo/entity-ip-address-field": "file:packages/entity-ip-address-field",
"@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"
} }
} }
@@ -3,6 +3,47 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
@@ -3,21 +3,26 @@
Cross-request [LRU](https://github.com/isaacs/node-lru-cache) cache adapter for `@expo/entity`. Use 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. 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 ## Why NOT use this cache
Because this is an in-memory cache, cross-box invalidation is not possible. Do 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: if you have the following use cases:
- The objects stored have high mutability - The objects stored are mutable
- Reading a stale object from the cache is not acceptable in your application - Reading a stale object from the cache is not acceptable in your application
- Cross-box invalidation is not possible - Cross-machine invalidation is not possible
## Typical use cases ## Typical use cases
If your application sees many requests fetching the same objects, you can save a trip to your cache 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: cluster and backing datastore by using this in-memory cache. Here are some good use cases:
- The objects stored are mostly immutable - 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 - You have a low TTL setting in your cache
## Usage ## Usage
@@ -1,6 +1,6 @@
{ {
"name": "@expo/entity-cache-adapter-local-memory", "name": "@expo/entity-cache-adapter-local-memory",
"version": "0.24.0", "version": "0.25.3",
"description": "Cross-request local memory cache adapter for @expo/entity", "description": "Cross-request local memory cache adapter for @expo/entity",
"files": [ "files": [
"build", "build",
@@ -30,9 +30,9 @@
"@expo/entity": "*" "@expo/entity": "*"
}, },
"dependencies": { "dependencies": {
"lru-cache": "^7.3.1" "lru-cache": "^6.0.0"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.24.0" "@expo/entity": "^0.25.3"
} }
} }
@@ -7,76 +7,6 @@ export const DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = Symbol('doesNotExist');
type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE; type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
export type LocalMemoryCache<TFields> = LRUCache<string, LocalMemoryCacheValue<TFields>>; export type LocalMemoryCache<TFields> = LRUCache<string, LocalMemoryCacheValue<TFields>>;
type LRUCacheOptionsV7<K, V> = {
/**
* the number of most recently used items to keep.
* note that we may store fewer items than this if maxSize is hit.
*/
max: number;
/**
* if you wish to track item size, you must provide a maxSize
* note that we still will only keep up to max *actual items*,
* so size tracking may cause fewer than max items to be stored.
* At the extreme, a single item of maxSize size will cause everything
* else in the cache to be dropped when it is added. Use with caution!
* Note also that size tracking can negatively impact performance,
* though for most cases, only minimally.
*/
maxSize?: number;
/**
* function to calculate size of items. useful if storing strings or
* buffers or other items where memory size depends on the object itself.
* also note that oversized items do NOT immediately get dropped from
* the cache, though they will cause faster turnover in the storage.
*/
sizeCalculation?: (value: V, key: K) => number;
/**
* function to call when the item is removed from the cache
* Note that using this can negatively impact performance.
*/
dispose?: (value: V, key: K) => void;
/**
* max time to live for items before they are considered stale
* note that stale items are NOT preemptively removed by default,
* and MAY live in the cache, contributing to its LRU max, long after
* they have expired.
* Also, as this cache is optimized for LRU/MRU operations, some of
* the staleness/TTL checks will reduce performance, as they will incur
* overhead by deleting items.
* Must be a positive integer in ms, defaults to 0, which means "no TTL"
*/
ttl?: number;
/**
* return stale items from cache.get() before disposing of them
* boolean, default false
*/
allowStale?: boolean;
/**
* update the age of items on cache.get(), renewing their TTL
* boolean, default false
*/
updateAgeOnGet?: boolean;
/**
* update the age of items on cache.has(), renewing their TTL
* boolean, default false
*/
updateAgeOnHas?: boolean;
/**
* update the "recently-used"-ness of items on cache.has()
* boolean, default false
*/
updateRecencyOnHas?: boolean;
};
export default class GenericLocalMemoryCacher<TFields> implements IEntityGenericCacher<TFields> { export default class GenericLocalMemoryCacher<TFields> implements IEntityGenericCacher<TFields> {
constructor(private readonly localMemoryCache: LocalMemoryCache<TFields>) {} constructor(private readonly localMemoryCache: LocalMemoryCache<TFields>) {}
@@ -86,13 +16,11 @@ export default class GenericLocalMemoryCacher<TFields> implements IEntityGeneric
const DEFAULT_LRU_CACHE_MAX_AGE_SECONDS = 10; const DEFAULT_LRU_CACHE_MAX_AGE_SECONDS = 10;
const DEFAULT_LRU_CACHE_SIZE = 10000; const DEFAULT_LRU_CACHE_SIZE = 10000;
const maxAgeSeconds = options.ttlSeconds ?? DEFAULT_LRU_CACHE_MAX_AGE_SECONDS; const maxAgeSeconds = options.ttlSeconds ?? DEFAULT_LRU_CACHE_MAX_AGE_SECONDS;
const lruCacheOptions: LRUCacheOptionsV7<string, TFields> = { return new LRUCache<string, LocalMemoryCacheValue<TFields>>({
max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE, max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE,
sizeCalculation: (value: LocalMemoryCacheValue<TFields>) => length: (value) => (value === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1),
value === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1, maxAge: maxAgeSeconds * 1000, // convert to ms
ttl: maxAgeSeconds * 1000, // convert to ms });
};
return new LRUCache<string, LocalMemoryCacheValue<TFields>>(lruCacheOptions as any);
} }
static createNoOpCache<TFields>(): LocalMemoryCache<TFields> { static createNoOpCache<TFields>(): LocalMemoryCache<TFields> {
@@ -8,7 +8,7 @@ import {
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher'; import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
import LocalMemoryCacheAdapter from './LocalMemoryCacheAdapter'; import LocalMemoryCacheAdapter from './LocalMemoryCacheAdapter';
export class LocalMemoryCacheAdapterProvider implements IEntityCacheAdapterProvider { export default class LocalMemoryCacheAdapterProvider implements IEntityCacheAdapterProvider {
// local memory cache adapters should be shared/reused across requests // local memory cache adapters should be shared/reused across requests
static localMemoryCacheAdapterMap = new Map<string, LocalMemoryCacheAdapter<any>>(); static localMemoryCacheAdapterMap = new Map<string, LocalMemoryCacheAdapter<any>>();
@@ -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();
});
});
});
@@ -3,12 +3,12 @@ import { v4 as uuidv4 } from 'uuid';
import GenericLocalMemoryCacher from '../GenericLocalMemoryCacher'; import GenericLocalMemoryCacher from '../GenericLocalMemoryCacher';
import LocalMemoryCacheAdapter from '../LocalMemoryCacheAdapter'; import LocalMemoryCacheAdapter from '../LocalMemoryCacheAdapter';
import { LocalMemoryCacheAdapterProvider } from '../LocalMemoryCacheAdapterProvider'; import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider';
import LocalMemoryTestEntity from '../testfixtures/LocalMemoryTestEntity'; import LocalMemoryTestEntity from '../testfixtures/LocalMemoryTestEntity';
import { import {
createLocalMemoryIntegrationTestEntityCompanionProvider, createLocalMemoryTestEntityCompanionProvider,
createNoopLocalMemoryIntegrationTestEntityCompanionProvider, createNoopLocalMemoryIntegrationTestEntityCompanionProvider,
} from '../testfixtures/createLocalMemoryIntegrationTestEntityCompanionProvider'; } from '../testfixtures/createLocalMemoryTestEntityCompanionProvider';
class TestViewerContext extends ViewerContext {} class TestViewerContext extends ViewerContext {}
@@ -18,9 +18,7 @@ describe(LocalMemoryCacheAdapter, () => {
}); });
it('has correct caching behavior', async () => { it('has correct caching behavior', async () => {
const viewerContext = new TestViewerContext( const viewerContext = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider());
createLocalMemoryIntegrationTestEntityCompanionProvider()
);
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity( const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
LocalMemoryTestEntity, LocalMemoryTestEntity,
LocalMemoryTestEntity.getCompanionDefinition() LocalMemoryTestEntity.getCompanionDefinition()
@@ -34,9 +32,9 @@ describe(LocalMemoryCacheAdapter, () => {
.enforceCreateAsync(); .enforceCreateAsync();
// loading an entity should put it in cache // loading an entity should put it in cache
const entity1 = await LocalMemoryTestEntity.loader(viewerContext) const entity1 = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
.enforcing() entity1Created.getID()
.loadByIDAsync(entity1Created.getID()); );
const entitySpecificGenericCacher = const entitySpecificGenericCacher =
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get( LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
@@ -90,9 +88,7 @@ describe(LocalMemoryCacheAdapter, () => {
GenericLocalMemoryCacher.prototype as unknown as any, GenericLocalMemoryCacher.prototype as unknown as any,
'loadManyAsync' 'loadManyAsync'
); );
const viewerContext = new TestViewerContext( const viewerContext = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider());
createLocalMemoryIntegrationTestEntityCompanionProvider()
);
const date = new Date(); const date = new Date();
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext) const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
@@ -101,17 +97,13 @@ describe(LocalMemoryCacheAdapter, () => {
.enforceCreateAsync(); .enforceCreateAsync();
// loading an entity should put it in cache // loading an entity should put it in cache
await LocalMemoryTestEntity.loader(viewerContext) await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(entity1Created.getID());
.enforcing()
.loadByIDAsync(entity1Created.getID());
// load entity with a different request // load entity with a different request
const viewerContext2 = new TestViewerContext( const viewerContext2 = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider());
createLocalMemoryIntegrationTestEntityCompanionProvider() const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2).loadByIDAsync(
entity1Created.getID()
); );
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2)
.enforcing()
.loadByIDAsync(entity1Created.getID());
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity( const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
LocalMemoryTestEntity, LocalMemoryTestEntity,
@@ -146,9 +138,9 @@ describe(LocalMemoryCacheAdapter, () => {
.enforceCreateAsync(); .enforceCreateAsync();
// loading an entity will try to put it in cache but it's a noop cache, so it should be a miss // 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) const entity1 = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
.enforcing() entity1Created.getID()
.loadByIDAsync(entity1Created.getID()); );
const entitySpecificGenericCacher = const entitySpecificGenericCacher =
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get( LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
@@ -24,10 +24,7 @@ describe(LocalMemoryCacheAdapter, () => {
it('returns appropriate cache results', async () => { it('returns appropriate cache results', async () => {
const cacheAdapter = new LocalMemoryCacheAdapter( const cacheAdapter = new LocalMemoryCacheAdapter(
entityConfiguration, entityConfiguration,
GenericLocalMemoryCacher.createLRUCache({ GenericLocalMemoryCacher.createLRUCache()
maxSize: Number.MAX_SAFE_INTEGER,
ttlSeconds: Number.MAX_SAFE_INTEGER,
})
); );
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]); const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
@@ -52,10 +49,7 @@ describe(LocalMemoryCacheAdapter, () => {
it('returns empty map when passed empty array of fieldValues', async () => { it('returns empty map when passed empty array of fieldValues', async () => {
const cacheAdapter = new LocalMemoryCacheAdapter( const cacheAdapter = new LocalMemoryCacheAdapter(
entityConfiguration, entityConfiguration,
GenericLocalMemoryCacher.createLRUCache({ GenericLocalMemoryCacher.createLRUCache()
maxSize: Number.MAX_SAFE_INTEGER,
ttlSeconds: Number.MAX_SAFE_INTEGER,
})
); );
const results = await cacheAdapter.loadManyAsync('id', []); const results = await cacheAdapter.loadManyAsync('id', []);
expect(results).toEqual(new Map()); expect(results).toEqual(new Map());
@@ -64,10 +58,7 @@ describe(LocalMemoryCacheAdapter, () => {
describe('cacheManyAsync', () => { describe('cacheManyAsync', () => {
it('correctly caches all objects', async () => { it('correctly caches all objects', async () => {
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({ const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
maxSize: Number.MAX_SAFE_INTEGER,
ttlSeconds: Number.MAX_SAFE_INTEGER,
});
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache); const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]])); await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
@@ -81,10 +72,7 @@ describe(LocalMemoryCacheAdapter, () => {
describe('cacheDBMissesAsync', () => { describe('cacheDBMissesAsync', () => {
it('correctly caches misses', async () => { it('correctly caches misses', async () => {
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({ const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
maxSize: Number.MAX_SAFE_INTEGER,
ttlSeconds: Number.MAX_SAFE_INTEGER,
});
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache); const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']); await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']);
@@ -96,10 +84,7 @@ describe(LocalMemoryCacheAdapter, () => {
describe('invalidateManyAsync', () => { describe('invalidateManyAsync', () => {
it('invalidates correctly', async () => { it('invalidates correctly', async () => {
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({ const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
maxSize: Number.MAX_SAFE_INTEGER,
ttlSeconds: Number.MAX_SAFE_INTEGER,
});
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache); const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]])); await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
@@ -114,10 +99,7 @@ describe(LocalMemoryCacheAdapter, () => {
it('returns when passed empty array of fieldValues', async () => { it('returns when passed empty array of fieldValues', async () => {
const cacheAdapter = new LocalMemoryCacheAdapter( const cacheAdapter = new LocalMemoryCacheAdapter(
entityConfiguration, entityConfiguration,
GenericLocalMemoryCacher.createLRUCache<BlahFields>({ GenericLocalMemoryCacher.createLRUCache<BlahFields>({})
maxSize: Number.MAX_SAFE_INTEGER,
ttlSeconds: Number.MAX_SAFE_INTEGER,
})
); );
await cacheAdapter.invalidateManyAsync('id', []); 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';
@@ -6,9 +6,9 @@ import {
StubDatabaseAdapterProvider, StubDatabaseAdapterProvider,
} from '@expo/entity'; } from '@expo/entity';
import { LocalMemoryCacheAdapterProvider } from '../LocalMemoryCacheAdapterProvider'; import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider';
export const createLocalMemoryIntegrationTestEntityCompanionProvider = ( export const createLocalMemoryTestEntityCompanionProvider = (
localMemoryOptions: { maxSize?: number; ttlSeconds?: number } = {}, localMemoryOptions: { maxSize?: number; ttlSeconds?: number } = {},
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter() metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => { ): EntityCompanionProvider => {
@@ -41,7 +41,7 @@ export const createLocalMemoryIntegrationTestEntityCompanionProvider = (
export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = ( export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = (
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter() metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => { ): EntityCompanionProvider => {
return createLocalMemoryIntegrationTestEntityCompanionProvider( return createLocalMemoryTestEntityCompanionProvider(
{ maxSize: 0, ttlSeconds: 0 }, { maxSize: 0, ttlSeconds: 0 },
metricsAdapter metricsAdapter
); );
@@ -3,6 +3,38 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
### Chores ### Chores
@@ -1,6 +1,6 @@
{ {
"name": "@expo/entity-cache-adapter-redis", "name": "@expo/entity-cache-adapter-redis",
"version": "0.24.0", "version": "0.25.3",
"description": "Redis cache adapter for @expo/entity", "description": "Redis cache adapter for @expo/entity",
"files": [ "files": [
"build", "build",
@@ -33,6 +33,6 @@
"ioredis": "^4.27.3" "ioredis": "^4.27.3"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.24.0" "@expo/entity": "^0.25.3"
} }
} }
@@ -52,9 +52,9 @@ describe(RedisCacheAdapter, () => {
.enforceCreateAsync(); .enforceCreateAsync();
// loading an entity should put it in cache // loading an entity should put it in cache
const entity1 = await RedisTestEntity.loader(viewerContext) const entity1 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
.enforcing() entity1Created.getID()
.loadByIDAsync(entity1Created.getID()); );
const cachedJSON = await redisCacheAdapterContext.redisClient.get( const cachedJSON = await redisCacheAdapterContext.redisClient.get(
cacheKeyMaker('id', entity1.getID()) cacheKeyMaker('id', entity1.getID())
@@ -102,16 +102,14 @@ describe(RedisCacheAdapter, () => {
); );
expect(entity1.getField('dateField')).toEqual(date); expect(entity1.getField('dateField')).toEqual(date);
const entity2 = await RedisTestEntity.loader(viewerContext) const entity2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(entity1.getID());
.enforcing()
.loadByIDAsync(entity1.getID());
expect(entity2.getField('dateField')).toEqual(date); expect(entity2.getField('dateField')).toEqual(date);
// simulate new request // simulate new request
const vc2 = new TestViewerContext( const vc2 = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext) 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); expect(entity3.getField('dateField')).toEqual(date);
}); });
@@ -122,18 +120,17 @@ describe(RedisCacheAdapter, () => {
const entity1 = await enforceAsyncResult( const entity1 = await enforceAsyncResult(
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync() RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
); );
const entity2 = await RedisTestEntity.loader(viewerContext) const entity2 = await RedisTestEntity.loader(viewerContext).loadByFieldEqualingAsync(
.enforcing() 'name',
.loadByFieldEqualingAsync('name', ''); ''
);
expect(entity2?.getID()).toEqual(entity1.getID()); expect(entity2?.getID()).toEqual(entity1.getID());
// simulate new request // simulate new request
const vc2 = new TestViewerContext( const vc2 = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext) createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
); );
const entity3 = await RedisTestEntity.loader(vc2) const entity3 = await RedisTestEntity.loader(vc2).loadByFieldEqualingAsync('name', '');
.enforcing()
.loadByFieldEqualingAsync('name', '');
expect(entity3?.getID()).toEqual(entity1.getID()); expect(entity3?.getID()).toEqual(entity1.getID());
}); });
}); });
@@ -3,6 +3,38 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [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 **Note:** Version bump only for package @expo/entity-database-adapter-knex
@@ -1,6 +1,6 @@
{ {
"name": "@expo/entity-database-adapter-knex", "name": "@expo/entity-database-adapter-knex",
"version": "0.24.0", "version": "0.25.3",
"description": "Knex database adapter for @expo/entity", "description": "Knex database adapter for @expo/entity",
"files": [ "files": [
"build", "build",
@@ -33,7 +33,7 @@
"knex": "^1.0.2" "knex": "^1.0.2"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.24.0", "@expo/entity": "^0.25.3",
"pg": "^8.7.1" "pg": "^8.7.1"
} }
} }
@@ -50,9 +50,7 @@ describe('postgres entity integration', () => {
PostgresTestEntity.updater(entity).setField('hasADog', false).updateAsync(), PostgresTestEntity.updater(entity).setField('hasADog', false).updateAsync(),
]); ]);
const loadedEntity = await PostgresTestEntity.loader(vc) const loadedEntity = await PostgresTestEntity.loader(vc).loadByIDAsync(entity.getID());
.enforcing()
.loadByIDAsync(entity.getID());
expect(loadedEntity.getField('hasACat')).toBe(true); expect(loadedEntity.getField('hasACat')).toBe(true);
expect(loadedEntity.getField('hasADog')).toBe(false); expect(loadedEntity.getField('hasADog')).toBe(false);
@@ -185,9 +183,7 @@ describe('postgres entity integration', () => {
.createAsync() .createAsync()
); );
const results = await PostgresTestEntity.loader(vc1) const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync([
.enforcing()
.loadManyByFieldEqualityConjunctionAsync([
{ {
fieldName: 'hasACat', fieldName: 'hasACat',
fieldValue: false, fieldValue: false,
@@ -200,11 +196,9 @@ describe('postgres entity integration', () => {
expect(results).toHaveLength(2); expect(results).toHaveLength(2);
const results2 = await PostgresTestEntity.loader(vc1) const results2 = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
.enforcing() [{ fieldName: 'hasADog', fieldValues: [true, false] }]
.loadManyByFieldEqualityConjunctionAsync([ );
{ fieldName: 'hasADog', fieldValues: [true, false] },
]);
expect(results2).toHaveLength(3); expect(results2).toHaveLength(3);
}); });
@@ -217,9 +211,9 @@ describe('postgres entity integration', () => {
await enforceAsyncResult(PostgresTestEntity.creator(vc1).setField('name', 'c').createAsync()); await enforceAsyncResult(PostgresTestEntity.creator(vc1).setField('name', 'c').createAsync());
const results = await PostgresTestEntity.loader(vc1) const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
.enforcing() [],
.loadManyByFieldEqualityConjunctionAsync([], { {
limit: 2, limit: 2,
offset: 1, offset: 1,
orderBy: [ orderBy: [
@@ -228,7 +222,8 @@ describe('postgres entity integration', () => {
order: OrderByOrdering.DESCENDING, order: OrderByOrdering.DESCENDING,
}, },
], ],
}); }
);
expect(results).toHaveLength(2); expect(results).toHaveLength(2);
expect(results.map((e) => e.getField('name'))).toEqual(['b', 'a']); expect(results.map((e) => e.getField('name'))).toEqual(['b', 'a']);
}); });
@@ -260,15 +255,13 @@ describe('postgres entity integration', () => {
.createAsync() .createAsync()
); );
const results = await PostgresTestEntity.loader(vc1) const results = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync([
.enforcing() { fieldName: 'name', fieldValue: null },
.loadManyByFieldEqualityConjunctionAsync([{ fieldName: 'name', fieldValue: null }]); ]);
expect(results).toHaveLength(2); expect(results).toHaveLength(2);
expect(results[0]!.getField('name')).toBeNull(); expect(results[0]!.getField('name')).toBeNull();
const results2 = await PostgresTestEntity.loader(vc1) const results2 = await PostgresTestEntity.loader(vc1).loadManyByFieldEqualityConjunctionAsync(
.enforcing()
.loadManyByFieldEqualityConjunctionAsync(
[ [
{ fieldName: 'name', fieldValues: ['a', null] }, { fieldName: 'name', fieldValues: ['a', null] },
{ fieldName: 'hasADog', fieldValue: true }, { fieldName: 'hasADog', fieldValue: true },
@@ -298,9 +291,10 @@ describe('postgres entity integration', () => {
.createAsync() .createAsync()
); );
const results = await PostgresTestEntity.loader(vc1) const results = await PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync(
.enforcing() 'name = ?',
.loadManyByRawWhereClauseAsync('name = ?', ['hello']); ['hello']
);
expect(results).toHaveLength(1); expect(results).toHaveLength(1);
}); });
@@ -316,9 +310,9 @@ describe('postgres entity integration', () => {
); );
await expect( await expect(
PostgresTestEntity.loader(vc1) PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync('invalid_column = ?', [
.enforcing() 'hello',
.loadManyByRawWhereClauseAsync('invalid_column = ?', ['hello']) ])
).rejects.toThrow(); ).rejects.toThrow();
}); });
@@ -346,9 +340,10 @@ describe('postgres entity integration', () => {
.createAsync() .createAsync()
); );
const results = await PostgresTestEntity.loader(vc1) const results = await PostgresTestEntity.loader(vc1).loadManyByRawWhereClauseAsync(
.enforcing() 'has_a_dog = ?',
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], { [true],
{
limit: 2, limit: 2,
offset: 1, offset: 1,
orderBy: [ orderBy: [
@@ -357,14 +352,15 @@ describe('postgres entity integration', () => {
order: OrderByOrdering.ASCENDING, order: OrderByOrdering.ASCENDING,
}, },
], ],
}); }
);
expect(results).toHaveLength(2); expect(results).toHaveLength(2);
expect(results.map((e) => e.getField('name'))).toEqual(['b', 'c']); expect(results.map((e) => e.getField('name'))).toEqual(['b', 'c']);
const resultsMultipleOrderBy = await PostgresTestEntity.loader(vc1) const resultsMultipleOrderBy = await PostgresTestEntity.loader(
.enforcing() vc1
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], { ).loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
orderBy: [ orderBy: [
{ {
fieldName: 'hasADog', fieldName: 'hasADog',
@@ -395,9 +391,7 @@ describe('postgres entity integration', () => {
.enforceCreateAsync() .enforceCreateAsync()
).rejects.toThrowError('name cannot have value beforeCreate'); ).rejects.toThrowError('name cannot have value beforeCreate');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeCreate')
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeCreate')
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
@@ -406,27 +400,21 @@ describe('postgres entity integration', () => {
.enforceCreateAsync() .enforceCreateAsync()
).rejects.toThrowError('name cannot have value afterCreate'); ).rejects.toThrowError('name cannot have value afterCreate');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterCreate')
.enforcing()
.loadByFieldEqualingAsync('name', 'afterCreate')
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
PostgresTriggerTestEntity.creator(vc1).setField('name', 'beforeAll').enforceCreateAsync() PostgresTriggerTestEntity.creator(vc1).setField('name', 'beforeAll').enforceCreateAsync()
).rejects.toThrowError('name cannot have value beforeAll'); ).rejects.toThrowError('name cannot have value beforeAll');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeAll')
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeAll')
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
PostgresTriggerTestEntity.creator(vc1).setField('name', 'afterAll').enforceCreateAsync() PostgresTriggerTestEntity.creator(vc1).setField('name', 'afterAll').enforceCreateAsync()
).rejects.toThrowError('name cannot have value afterAll'); ).rejects.toThrowError('name cannot have value afterAll');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterAll')
.enforcing()
.loadByFieldEqualingAsync('name', 'afterAll')
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
@@ -435,9 +423,7 @@ describe('postgres entity integration', () => {
.enforceCreateAsync() .enforceCreateAsync()
).rejects.toThrowError('name cannot have value afterCommit'); ).rejects.toThrowError('name cannot have value afterCommit');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterCommit')
.enforcing()
.loadByFieldEqualingAsync('name', 'afterCommit')
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
}); });
}); });
@@ -458,9 +444,7 @@ describe('postgres entity integration', () => {
.enforceUpdateAsync() .enforceUpdateAsync()
).rejects.toThrowError('name cannot have value beforeUpdate'); ).rejects.toThrowError('name cannot have value beforeUpdate');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeUpdate')
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeUpdate')
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
@@ -469,9 +453,7 @@ describe('postgres entity integration', () => {
.enforceUpdateAsync() .enforceUpdateAsync()
).rejects.toThrowError('name cannot have value afterUpdate'); ).rejects.toThrowError('name cannot have value afterUpdate');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterUpdate')
.enforcing()
.loadByFieldEqualingAsync('name', 'afterUpdate')
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
@@ -480,9 +462,7 @@ describe('postgres entity integration', () => {
.enforceUpdateAsync() .enforceUpdateAsync()
).rejects.toThrowError('name cannot have value beforeAll'); ).rejects.toThrowError('name cannot have value beforeAll');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeAll')
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeAll')
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
@@ -491,9 +471,7 @@ describe('postgres entity integration', () => {
.enforceUpdateAsync() .enforceUpdateAsync()
).rejects.toThrowError('name cannot have value afterAll'); ).rejects.toThrowError('name cannot have value afterAll');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterAll')
.enforcing()
.loadByFieldEqualingAsync('name', 'afterAll')
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
@@ -502,9 +480,7 @@ describe('postgres entity integration', () => {
.enforceUpdateAsync() .enforceUpdateAsync()
).rejects.toThrowError('name cannot have value afterCommit'); ).rejects.toThrowError('name cannot have value afterCommit');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterCommit')
.enforcing()
.loadByFieldEqualingAsync('name', 'afterCommit')
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
}); });
}); });
@@ -522,9 +498,7 @@ describe('postgres entity integration', () => {
PostgresTriggerTestEntity.enforceDeleteAsync(entityBeforeDelete) PostgresTriggerTestEntity.enforceDeleteAsync(entityBeforeDelete)
).rejects.toThrowError('name cannot have value beforeDelete'); ).rejects.toThrowError('name cannot have value beforeDelete');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'beforeDelete')
.enforcing()
.loadByFieldEqualingAsync('name', 'beforeDelete')
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
const entityAfterDelete = await PostgresTriggerTestEntity.creator(vc1) const entityAfterDelete = await PostgresTriggerTestEntity.creator(vc1)
@@ -534,9 +508,7 @@ describe('postgres entity integration', () => {
PostgresTriggerTestEntity.enforceDeleteAsync(entityAfterDelete) PostgresTriggerTestEntity.enforceDeleteAsync(entityAfterDelete)
).rejects.toThrowError('name cannot have value afterDelete'); ).rejects.toThrowError('name cannot have value afterDelete');
await expect( await expect(
PostgresTriggerTestEntity.loader(vc1) PostgresTriggerTestEntity.loader(vc1).loadByFieldEqualingAsync('name', 'afterDelete')
.enforcing()
.loadByFieldEqualingAsync('name', 'afterDelete')
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
}); });
}); });
@@ -553,9 +525,10 @@ describe('postgres entity integration', () => {
.enforceCreateAsync() .enforceCreateAsync()
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate'); ).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
await expect( await expect(
PostgresValidatorTestEntity.loader(vc1) PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
.enforcing() 'name',
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate') 'beforeCreateAndBeforeUpdate'
)
).resolves.toBeNull(); ).resolves.toBeNull();
}); });
}); });
@@ -575,9 +548,10 @@ describe('postgres entity integration', () => {
.enforceUpdateAsync() .enforceUpdateAsync()
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate'); ).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
await expect( await expect(
PostgresValidatorTestEntity.loader(vc1) PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
.enforcing() 'name',
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate') 'beforeCreateAndBeforeUpdate'
)
).resolves.toBeNull(); ).resolves.toBeNull();
}); });
}); });
@@ -592,9 +566,10 @@ describe('postgres entity integration', () => {
.enforceCreateAsync(); .enforceCreateAsync();
await PostgresValidatorTestEntity.enforceDeleteAsync(entityToDelete); await PostgresValidatorTestEntity.enforceDeleteAsync(entityToDelete);
await expect( await expect(
PostgresValidatorTestEntity.loader(vc1) PostgresValidatorTestEntity.loader(vc1).loadByFieldEqualingAsync(
.enforcing() 'name',
.loadByFieldEqualingAsync('name', 'shouldBeDeleted') 'shouldBeDeleted'
)
).resolves.toBeNull(); ).resolves.toBeNull();
}); });
}); });
@@ -60,7 +60,7 @@ describe('postgres errors', () => {
const vc2 = new ViewerContext( const vc2 = new ViewerContext(
createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance) createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance)
); );
await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow( await expect(ErrorsTestEntity.loader(vc2).loadByIDAsync(1)).rejects.toThrow(
EntityDatabaseAdapterTransientError EntityDatabaseAdapterTransientError
); );
await shortTimeoutKnexInstance.destroy(); await shortTimeoutKnexInstance.destroy();
+35
View File
@@ -3,6 +3,41 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [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 **Note:** Version bump only for package @expo/entity-example
+2 -2
View File
@@ -1,7 +1,7 @@
{ {
"name": "@expo/entity-example", "name": "@expo/entity-example",
"private": true, "private": true,
"version": "0.24.0", "version": "0.25.3",
"description": "An example integration of the @expo/entity framework", "description": "An example integration of the @expo/entity framework",
"scripts": { "scripts": {
"tsc": "tsc", "tsc": "tsc",
@@ -23,7 +23,7 @@
"author": "Expo", "author": "Expo",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@expo/entity": "^0.24.0", "@expo/entity": "^0.25.3",
"apollo-server-koa": "^2.16.1", "apollo-server-koa": "^2.16.1",
"graphql": "^15.3.0", "graphql": "^15.3.0",
"koa": "^2.13.0", "koa": "^2.13.0",
@@ -3,6 +3,7 @@ import {
ReadonlyEntity, ReadonlyEntity,
EntityQueryContext, EntityQueryContext,
RuleEvaluationResult, RuleEvaluationResult,
EntityPrivacyPolicyEvaluationContext,
} from '@expo/entity'; } from '@expo/entity';
import { ExampleViewerContext } from '../viewerContexts'; import { ExampleViewerContext } from '../viewerContexts';
@@ -34,6 +35,7 @@ export default class AllowIfUserOwnerPrivacyRule<
async evaluateAsync( async evaluateAsync(
viewerContext: ExampleViewerContext, viewerContext: ExampleViewerContext,
_queryContext: EntityQueryContext, _queryContext: EntityQueryContext,
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity entity: TEntity
): Promise<RuleEvaluationResult> { ): Promise<RuleEvaluationResult> {
if (viewerContext.isUserViewerContext()) { if (viewerContext.isUserViewerContext()) {
@@ -19,9 +19,10 @@ router.get('/', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext; const viewerContext = ctx.state.viewerContext;
let notes: readonly NoteEntity[] = []; let notes: readonly NoteEntity[] = [];
if (viewerContext.isUserViewerContext()) { if (viewerContext.isUserViewerContext()) {
notes = await NoteEntity.loader(viewerContext) notes = await NoteEntity.loader(viewerContext).loadManyByFieldEqualingAsync(
.enforcing() 'userID',
.loadManyByFieldEqualingAsync('userID', viewerContext.userID); viewerContext.userID
);
} }
ctx.body = { ctx.body = {
notes: notes.map((note) => note.getAllFields()), notes: notes.map((note) => note.getAllFields()),
+4 -10
View File
@@ -46,16 +46,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
return viewerContext.userID; return viewerContext.userID;
}, },
async noteByID(_root, args, { viewerContext }) { 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>, } as IResolverObject<any, GraphqlContext>,
User: { User: {
id: (root) => root, id: (root) => root,
async notes(root, _args, { viewerContext }) { async notes(root, _args, { viewerContext }) {
return await NoteEntity.loader(viewerContext) return await NoteEntity.loader(viewerContext).loadManyByFieldEqualingAsync('userID', root);
.enforcing()
.loadManyByFieldEqualingAsync('userID', root);
}, },
} as IResolverObject<string, GraphqlContext>, } as IResolverObject<string, GraphqlContext>,
@@ -79,18 +77,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
.enforceCreateAsync(); .enforceCreateAsync();
}, },
async updateNote(_root, args, { viewerContext }) { async updateNote(_root, args, { viewerContext }) {
const existingNote = await NoteEntity.loader(viewerContext) const existingNote = await NoteEntity.loader(viewerContext).loadByIDAsync(args.id);
.enforcing()
.loadByIDAsync(args.id);
return await NoteEntity.updater(existingNote) return await NoteEntity.updater(existingNote)
.setField('title', args.note.title) .setField('title', args.note.title)
.setField('body', args.note.body) .setField('body', args.note.body)
.enforceUpdateAsync(); .enforceUpdateAsync();
}, },
async deleteNote(_root, args, { viewerContext }) { async deleteNote(_root, args, { viewerContext }) {
const existingNote = await NoteEntity.loader(viewerContext) const existingNote = await NoteEntity.loader(viewerContext).loadByIDAsync(args.id);
.enforcing()
.loadByIDAsync(args.id);
await NoteEntity.enforceDeleteAsync(existingNote); await NoteEntity.enforceDeleteAsync(existingNote);
return existingNote; return existingNote;
}, },
@@ -3,6 +3,38 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [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 **Note:** Version bump only for package @expo/entity-full-integration-tests
@@ -1,7 +1,7 @@
{ {
"name": "@expo/entity-full-integration-tests", "name": "@expo/entity-full-integration-tests",
"private": true, "private": true,
"version": "0.24.0", "version": "0.25.3",
"description": "Full redis and knex integration tests for the entity framework", "description": "Full redis and knex integration tests for the entity framework",
"scripts": { "scripts": {
"tsc": "tsc", "tsc": "tsc",
@@ -27,8 +27,8 @@
"@expo/entity-database-adapter-knex": "*" "@expo/entity-database-adapter-knex": "*"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.24.0", "@expo/entity": "^0.25.3",
"@expo/entity-cache-adapter-redis": "^0.24.0", "@expo/entity-cache-adapter-redis": "^0.25.3",
"@expo/entity-database-adapter-knex": "^0.24.0" "@expo/entity-database-adapter-knex": "^0.25.3"
} }
} }
@@ -153,10 +153,8 @@ describe('Entity cache inconsistency', () => {
.enforceCreateAsync(); .enforceCreateAsync();
// put entities in cache and dataloader // put entities in cache and dataloader
await TestEntity.loader(viewerContext).enforcing().loadByIDAsync(entity1.getID()); await TestEntity.loader(viewerContext).loadByIDAsync(entity1.getID());
await TestEntity.loader(viewerContext) await TestEntity.loader(viewerContext).loadByFieldEqualingAsync('other_string', 'hello');
.enforcing()
.loadByFieldEqualingAsync('other_string', 'hello');
let openBarrier1: () => void; let openBarrier1: () => void;
const barrier1 = new Promise<void>((resolve) => { const barrier1 = new Promise<void>((resolve) => {
@@ -179,7 +177,7 @@ describe('Entity cache inconsistency', () => {
const viewerContextInternal = new ViewerContext( const viewerContextInternal = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext) createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
); );
await TestEntity.loader(viewerContextInternal).enforcing().loadByIDAsync(entity1.getID()); await TestEntity.loader(viewerContextInternal).loadByIDAsync(entity1.getID());
openBarrier2!(); openBarrier2!();
})(), })(),
@@ -203,12 +201,11 @@ describe('Entity cache inconsistency', () => {
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext) createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
); );
const loadedById = await TestEntity.loader(viewerContextLast) const loadedById = await TestEntity.loader(viewerContextLast).loadByIDAsync(entity1.getID());
.enforcing() const loadedByField = await TestEntity.loader(viewerContextLast).loadByFieldEqualingAsync(
.loadByIDAsync(entity1.getID()); 'other_string',
const loadedByField = await TestEntity.loader(viewerContextLast) 'hello'
.enforcing() );
.loadByFieldEqualingAsync('other_string', 'hello');
expect(loadedById.getField('third_string')).toEqual('updated'); expect(loadedById.getField('third_string')).toEqual('updated');
expect(loadedByField!.getField('third_string')).toEqual('updated'); expect(loadedByField!.getField('third_string')).toEqual('updated');
@@ -87,22 +87,20 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
.enforceCreateAsync(); .enforceCreateAsync();
await expect( await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()) ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
ChildEntity.loader(viewerContext) ChildEntity.loader(viewerContext).loadByFieldEqualingAsync('parent_id', parent.getID())
.enforcing()
.loadByFieldEqualingAsync('parent_id', parent.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await ParentEntity.enforceDeleteAsync(parent); await ParentEntity.enforceDeleteAsync(parent);
await expect( await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()) ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID()) ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
}); });
}); });
@@ -224,18 +224,18 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL) { if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL) {
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(category1.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
const otherLoaded = await OtherEntity.loader(viewerContext) const otherLoaded = await OtherEntity.loader(viewerContext).loadByIDNullableAsync(
.enforcing() other1.getID()
.loadByIDNullableAsync(other1.getID()); );
expect(otherLoaded?.getField('parent_category_id')).toBeNull(); expect(otherLoaded?.getField('parent_category_id')).toBeNull();
} else { } else {
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(category1.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
OtherEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(other1.getID()) OtherEntity.loader(viewerContext).loadByIDNullableAsync(other1.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
} }
}); });
@@ -3,6 +3,38 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [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 **Note:** Version bump only for package @expo/entity-ip-address-field
@@ -1,6 +1,6 @@
{ {
"name": "@expo/entity-ip-address-field", "name": "@expo/entity-ip-address-field",
"version": "0.24.0", "version": "0.25.3",
"description": "IP address EntityField definitions for @expo/entity", "description": "IP address EntityField definitions for @expo/entity",
"files": [ "files": [
"build", "build",
@@ -28,7 +28,7 @@
"ip-address": "^8.1.0" "ip-address": "^8.1.0"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.24.0", "@expo/entity": "^0.25.3",
"@types/jsbn": "^1.2.29" "@types/jsbn": "^1.2.29"
}, },
"peerDependencies": { "peerDependencies": {
@@ -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));
}
}
@@ -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,41 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
### Chores ### Chores
@@ -1,6 +1,6 @@
{ {
"name": "@expo/entity-secondary-cache-redis", "name": "@expo/entity-secondary-cache-redis",
"version": "0.24.0", "version": "0.25.3",
"description": "Redis secondary cache for @expo/entity", "description": "Redis secondary cache for @expo/entity",
"files": [ "files": [
"build", "build",
@@ -34,8 +34,8 @@
"ioredis": "^4.17.3" "ioredis": "^4.17.3"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.24.0", "@expo/entity": "^0.25.3",
"@expo/entity-cache-adapter-redis": "^0.24.0", "@expo/entity-cache-adapter-redis": "^0.25.3",
"nullthrows": "^1.1.1" "nullthrows": "^1.1.1"
} }
} }
@@ -2,9 +2,7 @@ import { EntityConfiguration, GenericSecondaryEntityCache } from '@expo/entity';
import { GenericRedisCacheContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis'; 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 * A redis {@link GenericSecondaryEntityCache}.
* single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
* a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
*/ */
export default class RedisSecondaryEntityCache< export default class RedisSecondaryEntityCache<
TFields, TFields,
@@ -40,9 +40,7 @@ class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
} }
return nullthrows( return nullthrows(
( (
await this.entityLoader await this.entityLoader.loadManyByFieldEqualityConjunctionAsync([
.enforcing()
.loadManyByFieldEqualityConjunctionAsync([
{ fieldName: 'id', fieldValue: loadParams.id }, { fieldName: 'id', fieldValue: loadParams.id },
]) ])
)[0] )[0]
+39
View File
@@ -3,6 +3,45 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 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) # [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 **Note:** Version bump only for package @expo/entity
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@expo/entity", "name": "@expo/entity",
"version": "0.24.0", "version": "0.25.3",
"description": "A privacy-first data model", "description": "A privacy-first data model",
"files": [ "files": [
"build", "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());
}
}
+6 -4
View File
@@ -69,7 +69,7 @@ export default abstract class Entity<
return viewerContext return viewerContext
.getViewerScopedEntityCompanionForClass(this) .getViewerScopedEntityCompanionForClass(this)
.getMutatorFactory() .getMutatorFactory()
.forCreate(queryContext); .forCreate(queryContext, { cascadingDeleteCause: null });
} }
/** /**
@@ -111,7 +111,7 @@ export default abstract class Entity<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(this) .getViewerScopedEntityCompanionForClass(this)
.getMutatorFactory() .getMutatorFactory()
.forUpdate(existingEntity, queryContext); .forUpdate(existingEntity, queryContext, { cascadingDeleteCause: null });
} }
/** /**
@@ -152,7 +152,7 @@ export default abstract class Entity<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(this) .getViewerScopedEntityCompanionForClass(this)
.getMutatorFactory() .getMutatorFactory()
.forDelete(existingEntity, queryContext) .forDelete(existingEntity, queryContext, { cascadingDeleteCause: null })
.deleteAsync(); .deleteAsync();
} }
@@ -194,7 +194,7 @@ export default abstract class Entity<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(this) .getViewerScopedEntityCompanionForClass(this)
.getMutatorFactory() .getMutatorFactory()
.forDelete(existingEntity, queryContext) .forDelete(existingEntity, queryContext, { cascadingDeleteCause: null })
.enforceDeleteAsync(); .enforceDeleteAsync();
} }
@@ -251,6 +251,7 @@ export default abstract class Entity<
privacyPolicy.authorizeUpdateAsync( privacyPolicy.authorizeUpdateAsync(
existingEntity.getViewerContext(), existingEntity.getViewerContext(),
queryContext, queryContext,
{ cascadingDeleteCause: null },
existingEntity, existingEntity,
companion.getMetricsAdapter() companion.getMetricsAdapter()
) )
@@ -304,6 +305,7 @@ export default abstract class Entity<
privacyPolicy.authorizeDeleteAsync( privacyPolicy.authorizeDeleteAsync(
existingEntity.getViewerContext(), existingEntity.getViewerContext(),
queryContext, queryContext,
{ cascadingDeleteCause: null },
existingEntity, existingEntity,
companion.getMetricsAdapter() companion.getMetricsAdapter()
) )
+10 -8
View File
@@ -69,9 +69,11 @@ export default class EntityAssociationLoader<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass) .getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory() .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 null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity
>; >;
} }
@@ -123,8 +125,8 @@ export default class EntityAssociationLoader<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass) .getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext); .forLoad(queryContext, { cascadingDeleteCause: null });
return await loader.loadManyByFieldEqualingAsync( return await loader.resultLoader.loadManyByFieldEqualingAsync(
associatedEntityFieldContainingThisID, associatedEntityFieldContainingThisID,
thisID as any thisID as any
); );
@@ -180,8 +182,8 @@ export default class EntityAssociationLoader<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass) .getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext); .forLoad(queryContext, { cascadingDeleteCause: null });
return await loader.loadByFieldEqualingAsync( return await loader.resultLoader.loadByFieldEqualingAsync(
associatedEntityLookupByField, associatedEntityLookupByField,
associatedFieldValue as any associatedFieldValue as any
); );
@@ -238,8 +240,8 @@ export default class EntityAssociationLoader<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass) .getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext); .forLoad(queryContext, { cascadingDeleteCause: null });
return await loader.loadManyByFieldEqualingAsync( return await loader.resultLoader.loadManyByFieldEqualingAsync(
associatedEntityLookupByField, associatedEntityLookupByField,
associatedFieldValue as any associatedFieldValue as any
); );
+71 -192
View File
@@ -1,23 +1,14 @@
import { Result, asyncResult, result } from '@expo/results';
import invariant from 'invariant';
import EnforcingEntityLoader from './EnforcingEntityLoader';
import { IEntityClass } from './Entity'; import { IEntityClass } from './Entity';
import EntityConfiguration from './EntityConfiguration'; import EntityConfiguration from './EntityConfiguration';
import { import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
FieldEqualityCondition, import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
QuerySelectionModifiers,
isSingleValueFieldEqualityCondition,
} from './EntityDatabaseAdapter';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext'; import { EntityQueryContext } from './EntityQueryContext';
import EntityResultLoader from './EntityResultLoader';
import ReadonlyEntity from './ReadonlyEntity'; import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
import EntityNotFoundError from './errors/EntityNotFoundError';
import EntityDataManager from './internal/EntityDataManager'; import EntityDataManager from './internal/EntityDataManager';
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter'; import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
import { mapMap, mapMapAsync } from './utils/collections/maps'; import { mapMap } from './utils/collections/maps';
/** /**
* The primary interface for loading entities. All normal loads are batched, * The primary interface for loading entities. All normal loads are batched,
@@ -37,11 +28,24 @@ export default class EntityLoader<
>, >,
TSelectedFields extends keyof TFields 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( constructor(
private readonly viewerContext: TViewerContext, viewerContext: TViewerContext,
private readonly queryContext: EntityQueryContext, queryContext: EntityQueryContext,
private readonly entityConfiguration: EntityConfiguration<TFields>, privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
private readonly entityClass: IEntityClass< entityConfiguration: EntityConfiguration<TFields>,
entityClass: IEntityClass<
TFields, TFields,
TID, TID,
TViewerContext, TViewerContext,
@@ -49,133 +53,105 @@ export default class EntityLoader<
TPrivacyPolicy, TPrivacyPolicy,
TSelectedFields TSelectedFields
>, >,
private readonly privacyPolicy: TPrivacyPolicy, privacyPolicy: TPrivacyPolicy,
private readonly dataManager: EntityDataManager<TFields>, private readonly dataManager: EntityDataManager<TFields>,
protected readonly metricsAdapter: IEntityMetricsAdapter protected readonly metricsAdapter: IEntityMetricsAdapter
) {} ) {
this.resultLoader = new EntityResultLoader(
/** viewerContext,
* Enforcing view on this entity loader. All loads through this view are queryContext,
* guaranteed to be the values of successful results (or null for some loader methods), privacyPolicyEvaluationContext,
* and will throw otherwise. entityConfiguration,
*/ entityClass,
enforcing(): EnforcingEntityLoader< privacyPolicy,
TFields, dataManager,
TID, metricsAdapter
TViewerContext, );
TEntity,
TPrivacyPolicy,
TSelectedFields
> {
return new EnforcingEntityLoader(this);
} }
/** /**
* Load many entities where fieldName is one of fieldValues. * Load many entities where fieldName is one of fieldValues.
* @param fieldName - entity field being queried * @param fieldName - entity field being queried
* @param fieldValues - fieldName field values being queried * @param fieldValues - fieldName field values being queried
* @returns map from fieldValue to entity results that match the query for that fieldValue, * @returns map from fieldValue to entities that match the query for that fieldValue
* where result errors can be UnauthorizedError
*/ */
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>( async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N, fieldName: N,
fieldValues: readonly NonNullable<TFields[N]>[] fieldValues: readonly NonNullable<TFields[N]>[]
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> { ): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly TEntity[]>> {
this.validateFieldValues(fieldName, fieldValues); const fieldValuesToResults = await this.resultLoader.loadManyByFieldEqualingManyAsync(
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
this.queryContext,
fieldName, fieldName,
fieldValues fieldValues
); );
return mapMap(fieldValuesToResults, (results) =>
return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects); results.map((result) => result.enforceValue())
);
} }
/** /**
* Load many entities where fieldName equals fieldValue. * Load many entities where fieldName equals fieldValue.
* @param fieldName - entity field being queried * @param fieldName - entity field being queried
* @param fieldValue - fieldName field value 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>>( async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N, fieldName: N,
fieldValue: NonNullable<TFields[N]> fieldValue: NonNullable<TFields[N]>
): Promise<readonly Result<TEntity>[]> { ): Promise<readonly TEntity[]> {
const entityResults = await this.loadManyByFieldEqualingManyAsync(fieldName, [fieldValue]); const entityResults = await this.resultLoader.loadManyByFieldEqualingAsync(
const entityResultsForFieldValue = entityResults.get(fieldValue); fieldName,
invariant( fieldValue
entityResultsForFieldValue !== undefined,
`${fieldValue} should be guaranteed to be present in returned map of entities`
); );
return entityResultsForFieldValue!; return entityResults.map((result) => result.enforceValue());
} }
/** /**
* Load an entity where fieldName equals fieldValue, or null if no entity exists. * Load an entity where fieldName equals fieldValue, or null if no entity exists.
* @param uniqueFieldName - entity field being queried * @param uniqueFieldName - entity field being queried
* @param fieldValue - uniqueFieldName field value 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 * @throws when multiple entities match the condition
*/ */
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>( async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
uniqueFieldName: N, uniqueFieldName: N,
fieldValue: NonNullable<TFields[N]> fieldValue: NonNullable<TFields[N]>
): Promise<Result<TEntity> | null> { ): Promise<TEntity | null> {
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue); const entityResult = await this.resultLoader.loadByFieldEqualingAsync(
invariant( uniqueFieldName,
entityResults.length <= 1, fieldValue
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${uniqueFieldName}=${fieldValue}`
); );
return entityResults[0] ?? null; return entityResult ? entityResult.enforceValue() : null;
} }
/** /**
* Loads an entity by a specified ID. * Loads an entity by a specified ID.
* @param id - ID of the entity * @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>> { async loadByIDAsync(id: TID): Promise<TEntity> {
const entityResults = await this.loadManyByIDsAsync([id]); const entityResult = await this.resultLoader.loadByIDAsync(id);
const entityResult = entityResults.get(id); return entityResult.enforceValue();
if (entityResult === undefined) {
return result(
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
);
}
return entityResult;
} }
/** /**
* Load an entity by a specified ID, or return null if non-existent. * Load an entity by a specified ID, or return null if non-existent.
* @param id - ID of the entity * @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> { async loadByIDNullableAsync(id: TID): Promise<TEntity | null> {
return await this.loadByFieldEqualingAsync( const entityResult = await this.resultLoader.loadByIDNullableAsync(id);
this.entityConfiguration.idField as TSelectedFields, return entityResult ? entityResult.enforceValue() : null;
id
);
} }
/** /**
* Loads many entities for a list of IDs. * Loads many entities for a list of IDs.
* @param viewerContext - viewer context of loading user * @param viewerContext - viewer context of loading user
* @param ids - IDs of the entities to load * @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>>> { async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, TEntity>> {
const entityResults = (await this.loadManyByFieldEqualingManyAsync( const entityResults = await this.resultLoader.loadManyByIDsAsync(ids);
this.entityConfiguration.idField as TSelectedFields, return mapMap(entityResults, (result) => result.enforceValue());
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))
);
});
} }
/** /**
@@ -190,40 +166,17 @@ export default class EntityLoader<
* *
* @param fieldEqualityOperands - list of field equality WHERE clause operand specifications * @param fieldEqualityOperands - list of field equality WHERE clause operand specifications
* @param querySelectionModifiers - limit, offset, and orderBy for the query * @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>>( async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[], fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
querySelectionModifiers: QuerySelectionModifiers<TFields> = {} querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly Result<TEntity>[]> { ): Promise<readonly TEntity[]> {
for (const fieldEqualityOperand of fieldEqualityOperands) { const entityResults = await this.resultLoader.loadManyByFieldEqualityConjunctionAsync(
const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
? [fieldEqualityOperand.fieldValue]
: fieldEqualityOperand.fieldValues;
this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
}
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
this.queryContext,
fieldEqualityOperands, fieldEqualityOperands,
querySelectionModifiers querySelectionModifiers
); );
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects); return entityResults.map((result) => result.enforceValue());
return await Promise.all(
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
if (!uncheckedEntityResult.ok) {
return uncheckedEntityResult;
}
return await asyncResult(
this.privacyPolicy.authorizeReadAsync(
this.viewerContext,
this.queryContext,
uncheckedEntityResult.value,
this.metricsAdapter
)
);
})
);
} }
/** /**
@@ -246,7 +199,7 @@ export default class EntityLoader<
* @param rawWhereClause - parameterized SQL WHERE clause with positional binding placeholders or named binding placeholders * @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 bindings - array of positional bindings or object of named bindings
* @param querySelectionModifiers - limit, offset, and orderBy for the query * @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 * @throws Error when rawWhereClause or bindings are invalid
* *
* @deprecated prefer caching loaders * @deprecated prefer caching loaders
@@ -255,29 +208,13 @@ export default class EntityLoader<
rawWhereClause: string, rawWhereClause: string,
bindings: any[] | object, bindings: any[] | object,
querySelectionModifiers: QuerySelectionModifiers<TFields> = {} querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly Result<TEntity>[]> { ): Promise<readonly TEntity[]> {
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync( const entityResults = await this.resultLoader.loadManyByRawWhereClauseAsync(
this.queryContext,
rawWhereClause, rawWhereClause,
bindings, bindings,
querySelectionModifiers querySelectionModifiers
); );
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects); return entityResults.map((result) => result.enforceValue());
return await Promise.all(
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
if (!uncheckedEntityResult.ok) {
return uncheckedEntityResult;
}
return await asyncResult(
this.privacyPolicy.authorizeReadAsync(
this.viewerContext,
this.queryContext,
uncheckedEntityResult.value,
this.metricsAdapter
)
);
})
);
} }
/** /**
@@ -296,62 +233,4 @@ export default class EntityLoader<
async invalidateEntityAsync(entity: TEntity): Promise<void> { async invalidateEntityAsync(entity: TEntity): Promise<void> {
await this.invalidateFieldsAsync(entity.getAllDatabaseFields()); 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,
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);
}
}
}
} }
+4 -2
View File
@@ -1,7 +1,7 @@
import { IEntityClass } from './Entity'; import { IEntityClass } from './Entity';
import EntityConfiguration from './EntityConfiguration'; import EntityConfiguration from './EntityConfiguration';
import EntityLoader from './EntityLoader'; import EntityLoader from './EntityLoader';
import EntityPrivacyPolicy from './EntityPrivacyPolicy'; import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext'; import { EntityQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity'; import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
@@ -47,11 +47,13 @@ export default class EntityLoaderFactory<
*/ */
forLoad( forLoad(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> { ): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new EntityLoader( return new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
this.entityConfiguration, this.entityConfiguration,
this.entityClass, this.entityClass,
this.privacyPolicyClass, this.privacyPolicyClass,
+13 -3
View File
@@ -22,9 +22,19 @@ export type EntityValidatorMutationInfo<
previousValue: TEntity; previousValue: TEntity;
}; };
export type EntityMutationTriggerDeleteCascadeInfo<> = { /**
* 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>; entity: Entity<any, any, any, any>;
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null;
/**
* The cascade deletion that caused this mutation.
*/
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
}; };
export type EntityTriggerMutationInfo< export type EntityTriggerMutationInfo<
@@ -43,5 +53,5 @@ export type EntityTriggerMutationInfo<
} }
| { | {
type: EntityMutationType.DELETE; type: EntityMutationType.DELETE;
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null; cascadingDeleteCause: EntityCascadingDeletionInfo | null;
}; };
+48 -29
View File
@@ -11,14 +11,14 @@ import {
EntityValidatorMutationInfo, EntityValidatorMutationInfo,
EntityMutationType, EntityMutationType,
EntityTriggerMutationInfo, EntityTriggerMutationInfo,
EntityMutationTriggerDeleteCascadeInfo, EntityCascadingDeletionInfo,
} from './EntityMutationInfo'; } from './EntityMutationInfo';
import EntityMutationTriggerConfiguration, { import EntityMutationTriggerConfiguration, {
EntityMutationTrigger, EntityMutationTrigger,
EntityNonTransactionalMutationTrigger, EntityNonTransactionalMutationTrigger,
} from './EntityMutationTriggerConfiguration'; } from './EntityMutationTriggerConfiguration';
import EntityMutationValidator from './EntityMutationValidator'; import EntityMutationValidator from './EntityMutationValidator';
import EntityPrivacyPolicy from './EntityPrivacyPolicy'; import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext'; import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity'; import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
@@ -44,6 +44,7 @@ abstract class BaseMutator<
constructor( constructor(
protected readonly viewerContext: TViewerContext, protected readonly viewerContext: TViewerContext,
protected readonly queryContext: EntityQueryContext, protected readonly queryContext: EntityQueryContext,
protected readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
protected readonly entityConfiguration: EntityConfiguration<TFields>, protected readonly entityConfiguration: EntityConfiguration<TFields>,
protected readonly entityClass: IEntityClass< protected readonly entityClass: IEntityClass<
TFields, TFields,
@@ -220,6 +221,7 @@ export class CreateMutator<
this.privacyPolicy.authorizeCreateAsync( this.privacyPolicy.authorizeCreateAsync(
this.viewerContext, this.viewerContext,
queryContext, queryContext,
this.privacyPolicyEvaluationContext,
temporaryEntityForPrivacyCheck, temporaryEntityForPrivacyCheck,
this.metricsAdapter this.metricsAdapter
) )
@@ -249,15 +251,17 @@ export class CreateMutator<
const insertResult = await this.databaseAdapter.insertAsync(queryContext, this.fieldsForEntity); const insertResult = await this.databaseAdapter.insertAsync(queryContext, this.fieldsForEntity);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext); const entityLoader = this.entityLoaderFactory.forLoad(
this.viewerContext,
queryContext,
this.privacyPolicyEvaluationContext
);
queryContext.appendPostCommitInvalidationCallback( queryContext.appendPostCommitInvalidationCallback(
entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult) entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult)
); );
const unauthorizedEntityAfterInsert = new this.entityClass(this.viewerContext, insertResult); const unauthorizedEntityAfterInsert = new this.entityClass(this.viewerContext, insertResult);
const newEntity = await entityLoader const newEntity = await entityLoader.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
.enforcing()
.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
await this.executeMutationTriggersAsync( await this.executeMutationTriggersAsync(
this.mutationTriggers.afterCreate, this.mutationTriggers.afterCreate,
@@ -309,6 +313,7 @@ export class UpdateMutator<
constructor( constructor(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
entityConfiguration: EntityConfiguration<TFields>, entityConfiguration: EntityConfiguration<TFields>,
entityClass: IEntityClass< entityClass: IEntityClass<
TFields, TFields,
@@ -348,6 +353,7 @@ export class UpdateMutator<
super( super(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
entityConfiguration, entityConfiguration,
entityClass, entityClass,
privacyPolicy, privacyPolicy,
@@ -409,6 +415,7 @@ export class UpdateMutator<
this.privacyPolicy.authorizeUpdateAsync( this.privacyPolicy.authorizeUpdateAsync(
this.viewerContext, this.viewerContext,
queryContext, queryContext,
this.privacyPolicyEvaluationContext,
entityAboutToBeUpdated, entityAboutToBeUpdated,
this.metricsAdapter this.metricsAdapter
) )
@@ -443,7 +450,11 @@ export class UpdateMutator<
this.updatedFields this.updatedFields
); );
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext); const entityLoader = this.entityLoaderFactory.forLoad(
this.viewerContext,
queryContext,
this.privacyPolicyEvaluationContext
);
queryContext.appendPostCommitInvalidationCallback( queryContext.appendPostCommitInvalidationCallback(
entityLoader.invalidateFieldsAsync.bind( entityLoader.invalidateFieldsAsync.bind(
@@ -456,9 +467,7 @@ export class UpdateMutator<
); );
const unauthorizedEntityAfterUpdate = new this.entityClass(this.viewerContext, updateResult); const unauthorizedEntityAfterUpdate = new this.entityClass(this.viewerContext, updateResult);
const updatedEntity = await entityLoader const updatedEntity = await entityLoader.loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
.enforcing()
.loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
await this.executeMutationTriggersAsync( await this.executeMutationTriggersAsync(
this.mutationTriggers.afterUpdate, this.mutationTriggers.afterUpdate,
@@ -506,6 +515,7 @@ export class DeleteMutator<
constructor( constructor(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
entityConfiguration: EntityConfiguration<TFields>, entityConfiguration: EntityConfiguration<TFields>,
entityClass: IEntityClass< entityClass: IEntityClass<
TFields, TFields,
@@ -545,6 +555,7 @@ export class DeleteMutator<
super( super(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
entityConfiguration, entityConfiguration,
entityClass, entityClass,
privacyPolicy, privacyPolicy,
@@ -578,7 +589,7 @@ export class DeleteMutator<
private async deleteInTransactionAsync( private async deleteInTransactionAsync(
processedEntityIdentifiersFromTransitiveDeletions: Set<string>, processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
skipDatabaseDeletion: boolean, skipDatabaseDeletion: boolean,
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null cascadingDeleteCause: EntityCascadingDeletionInfo | null
): Promise<Result<void>> { ): Promise<Result<void>> {
return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) => return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
this.deleteInternalAsync( this.deleteInternalAsync(
@@ -594,12 +605,13 @@ export class DeleteMutator<
queryContext: EntityTransactionalQueryContext, queryContext: EntityTransactionalQueryContext,
processedEntityIdentifiersFromTransitiveDeletions: Set<string>, processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
skipDatabaseDeletion: boolean, skipDatabaseDeletion: boolean,
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null cascadingDeleteCause: EntityCascadingDeletionInfo | null
): Promise<Result<void>> { ): Promise<Result<void>> {
const authorizeDeleteResult = await asyncResult( const authorizeDeleteResult = await asyncResult(
this.privacyPolicy.authorizeDeleteAsync( this.privacyPolicy.authorizeDeleteAsync(
this.viewerContext, this.viewerContext,
queryContext, queryContext,
{ cascadingDeleteCause },
this.entity, this.entity,
this.metricsAdapter this.metricsAdapter
) )
@@ -636,7 +648,9 @@ export class DeleteMutator<
); );
} }
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext); const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext, {
cascadingDeleteCause,
});
queryContext.appendPostCommitInvalidationCallback( queryContext.appendPostCommitInvalidationCallback(
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.entity.getAllDatabaseFields()) entityLoader.invalidateFieldsAsync.bind(entityLoader, this.entity.getAllDatabaseFields())
); );
@@ -684,7 +698,7 @@ export class DeleteMutator<
entity: TEntity, entity: TEntity,
queryContext: EntityTransactionalQueryContext, queryContext: EntityTransactionalQueryContext,
processedEntityIdentifiers: Set<string>, processedEntityIdentifiers: Set<string>,
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null cascadingDeleteCause: EntityCascadingDeletionInfo | null
): Promise<void> { ): Promise<void> {
// prevent infinite reference cycles by keeping track of entities already processed // prevent infinite reference cycles by keeping track of entities already processed
if (processedEntityIdentifiers.has(entity.getUniqueIdentifier())) { if (processedEntityIdentifiers.has(entity.getUniqueIdentifier())) {
@@ -732,19 +746,24 @@ export class DeleteMutator<
.getViewerScopedEntityCompanionForClass(entityClass) .getViewerScopedEntityCompanionForClass(entityClass)
.getMutatorFactory(); .getMutatorFactory();
const newCascadingDeleteCause = {
entity,
cascadingDeleteCause,
};
let inboundReferenceEntities: readonly ReadonlyEntity<any, any, any, any>[]; let inboundReferenceEntities: readonly ReadonlyEntity<any, any, any, any>[];
if (associatedEntityLookupByField) { if (associatedEntityLookupByField) {
inboundReferenceEntities = await loaderFactory inboundReferenceEntities = await loaderFactory
.forLoad(queryContext) .forLoad(queryContext, { cascadingDeleteCause: newCascadingDeleteCause })
.enforcing()
.loadManyByFieldEqualingAsync( .loadManyByFieldEqualingAsync(
fieldName, fieldName,
entity.getField(associatedEntityLookupByField as any) entity.getField(associatedEntityLookupByField as any)
); );
} else { } else {
inboundReferenceEntities = await loaderFactory inboundReferenceEntities = await loaderFactory
.forLoad(queryContext) .forLoad(queryContext, { cascadingDeleteCause: newCascadingDeleteCause })
.enforcing()
.loadManyByFieldEqualingAsync(fieldName, entity.getID()); .loadManyByFieldEqualingAsync(fieldName, entity.getID());
} }
@@ -754,14 +773,13 @@ export class DeleteMutator<
await Promise.all( await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) => inboundReferenceEntities.map((inboundReferenceEntity) =>
mutatorFactory mutatorFactory
.forDelete(inboundReferenceEntity, queryContext) .forDelete(inboundReferenceEntity, queryContext, {
cascadingDeleteCause: newCascadingDeleteCause,
})
.deleteInTransactionAsync( .deleteInTransactionAsync(
processedEntityIdentifiers, processedEntityIdentifiers,
/* skipDatabaseDeletion */ true, // deletion is handled by DB /* skipDatabaseDeletion */ true, // deletion is handled by DB
{ newCascadingDeleteCause
entity,
cascadingDeleteCause,
}
) )
) )
); );
@@ -771,7 +789,9 @@ export class DeleteMutator<
await Promise.all( await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) => inboundReferenceEntities.map((inboundReferenceEntity) =>
mutatorFactory mutatorFactory
.forUpdate(inboundReferenceEntity, queryContext) .forUpdate(inboundReferenceEntity, queryContext, {
cascadingDeleteCause: newCascadingDeleteCause,
})
.setField(fieldName, null) .setField(fieldName, null)
.enforceUpdateAsync() .enforceUpdateAsync()
) )
@@ -782,14 +802,13 @@ export class DeleteMutator<
await Promise.all( await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) => inboundReferenceEntities.map((inboundReferenceEntity) =>
mutatorFactory mutatorFactory
.forDelete(inboundReferenceEntity, queryContext) .forDelete(inboundReferenceEntity, queryContext, {
cascadingDeleteCause: newCascadingDeleteCause,
})
.deleteInTransactionAsync( .deleteInTransactionAsync(
processedEntityIdentifiers, processedEntityIdentifiers,
/* skipDatabaseDeletion */ false, /* skipDatabaseDeletion */ false,
{ newCascadingDeleteCause
entity,
cascadingDeleteCause,
}
) )
) )
); );
+10 -4
View File
@@ -5,7 +5,7 @@ import EntityLoaderFactory from './EntityLoaderFactory';
import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration'; import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
import EntityMutationValidator from './EntityMutationValidator'; import EntityMutationValidator from './EntityMutationValidator';
import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator'; import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
import EntityPrivacyPolicy from './EntityPrivacyPolicy'; import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext'; import { EntityQueryContext } from './EntityQueryContext';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter'; import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
@@ -72,11 +72,13 @@ export default class EntityMutatorFactory<
*/ */
forCreate( forCreate(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> { ): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new CreateMutator( return new CreateMutator(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
this.entityConfiguration, this.entityConfiguration,
this.entityClass, this.entityClass,
this.privacyPolicy, this.privacyPolicy,
@@ -96,11 +98,13 @@ export default class EntityMutatorFactory<
*/ */
forUpdate( forUpdate(
existingEntity: TEntity, existingEntity: TEntity,
queryContext: EntityQueryContext queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> { ): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new UpdateMutator( return new UpdateMutator(
existingEntity.getViewerContext(), existingEntity.getViewerContext(),
queryContext, queryContext,
privacyPolicyEvaluationContext,
this.entityConfiguration, this.entityConfiguration,
this.entityClass, this.entityClass,
this.privacyPolicy, this.privacyPolicy,
@@ -120,11 +124,13 @@ export default class EntityMutatorFactory<
*/ */
forDelete( forDelete(
existingEntity: TEntity, existingEntity: TEntity,
queryContext: EntityQueryContext queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> { ): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new DeleteMutator( return new DeleteMutator(
existingEntity.getViewerContext(), existingEntity.getViewerContext(),
queryContext, queryContext,
privacyPolicyEvaluationContext,
this.entityConfiguration, this.entityConfiguration,
this.entityClass, this.entityClass,
this.privacyPolicy, this.privacyPolicy,
+31 -1
View File
@@ -1,3 +1,4 @@
import { EntityCascadingDeletionInfo } from './EntityMutationInfo';
import { EntityQueryContext } from './EntityQueryContext'; import { EntityQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity'; import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
@@ -7,6 +8,17 @@ import IEntityMetricsAdapter, {
} from './metrics/IEntityMetricsAdapter'; } from './metrics/IEntityMetricsAdapter';
import PrivacyPolicyRule, { RuleEvaluationResult } from './rules/PrivacyPolicyRule'; 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 { export enum EntityPrivacyPolicyEvaluationMode {
ENFORCE, ENFORCE,
DRY_RUN, DRY_RUN,
@@ -127,6 +139,7 @@ export default abstract class EntityPrivacyPolicy<
async authorizeCreateAsync( async authorizeCreateAsync(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity, entity: TEntity,
metricsAdapter: IEntityMetricsAdapter metricsAdapter: IEntityMetricsAdapter
): Promise<TEntity> { ): Promise<TEntity> {
@@ -134,6 +147,7 @@ export default abstract class EntityPrivacyPolicy<
this.createRules, this.createRules,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
EntityAuthorizationAction.CREATE, EntityAuthorizationAction.CREATE,
metricsAdapter metricsAdapter
@@ -151,6 +165,7 @@ export default abstract class EntityPrivacyPolicy<
async authorizeReadAsync( async authorizeReadAsync(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity, entity: TEntity,
metricsAdapter: IEntityMetricsAdapter metricsAdapter: IEntityMetricsAdapter
): Promise<TEntity> { ): Promise<TEntity> {
@@ -158,6 +173,7 @@ export default abstract class EntityPrivacyPolicy<
this.readRules, this.readRules,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
EntityAuthorizationAction.READ, EntityAuthorizationAction.READ,
metricsAdapter metricsAdapter
@@ -175,6 +191,7 @@ export default abstract class EntityPrivacyPolicy<
async authorizeUpdateAsync( async authorizeUpdateAsync(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity, entity: TEntity,
metricsAdapter: IEntityMetricsAdapter metricsAdapter: IEntityMetricsAdapter
): Promise<TEntity> { ): Promise<TEntity> {
@@ -182,6 +199,7 @@ export default abstract class EntityPrivacyPolicy<
this.updateRules, this.updateRules,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
EntityAuthorizationAction.UPDATE, EntityAuthorizationAction.UPDATE,
metricsAdapter metricsAdapter
@@ -199,6 +217,7 @@ export default abstract class EntityPrivacyPolicy<
async authorizeDeleteAsync( async authorizeDeleteAsync(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity, entity: TEntity,
metricsAdapter: IEntityMetricsAdapter metricsAdapter: IEntityMetricsAdapter
): Promise<TEntity> { ): Promise<TEntity> {
@@ -206,6 +225,7 @@ export default abstract class EntityPrivacyPolicy<
this.deleteRules, this.deleteRules,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
EntityAuthorizationAction.DELETE, EntityAuthorizationAction.DELETE,
metricsAdapter metricsAdapter
@@ -216,6 +236,7 @@ export default abstract class EntityPrivacyPolicy<
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[], ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity, entity: TEntity,
action: EntityAuthorizationAction, action: EntityAuthorizationAction,
metricsAdapter: IEntityMetricsAdapter metricsAdapter: IEntityMetricsAdapter
@@ -228,6 +249,7 @@ export default abstract class EntityPrivacyPolicy<
ruleset, ruleset,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
action action
); );
@@ -256,6 +278,7 @@ export default abstract class EntityPrivacyPolicy<
ruleset, ruleset,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
action action
); );
@@ -285,6 +308,7 @@ export default abstract class EntityPrivacyPolicy<
ruleset, ruleset,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
action action
); );
@@ -315,12 +339,18 @@ export default abstract class EntityPrivacyPolicy<
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[], ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity, entity: TEntity,
action: EntityAuthorizationAction action: EntityAuthorizationAction
): Promise<TEntity> { ): Promise<TEntity> {
for (let i = 0; i < ruleset.length; i++) { for (let i = 0; i < ruleset.length; i++) {
const rule = ruleset[i]!; const rule = ruleset[i]!;
const ruleEvaluationResult = await rule.evaluateAsync(viewerContext, queryContext, entity); const ruleEvaluationResult = await rule.evaluateAsync(
viewerContext,
queryContext,
evaluationContext,
entity
);
switch (ruleEvaluationResult) { switch (ruleEvaluationResult) {
case RuleEvaluationResult.DENY: case RuleEvaluationResult.DENY:
throw new EntityNotAuthorizedError< throw new EntityNotAuthorizedError<
+326
View File
@@ -0,0 +1,326 @@
import { Result, asyncResult, result } from '@expo/results';
import invariant from 'invariant';
import { IEntityClass } from './Entity';
import EntityConfiguration from './EntityConfiguration';
import {
FieldEqualityCondition,
QuerySelectionModifiers,
isSingleValueFieldEqualityCondition,
} from './EntityDatabaseAdapter';
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
import EntityNotFoundError from './errors/EntityNotFoundError';
import EntityDataManager from './internal/EntityDataManager';
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
import { mapMap, mapMapAsync } from './utils/collections/maps';
/**
* Result-based view on an entity loader. All loads through this loader will wrap their results in Result.
*/
export default class EntityResultLoader<
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
TPrivacyPolicy extends EntityPrivacyPolicy<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
TSelectedFields extends keyof TFields
> {
constructor(
private readonly viewerContext: TViewerContext,
private readonly queryContext: EntityQueryContext,
private readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
private readonly entityConfiguration: EntityConfiguration<TFields>,
private readonly entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
private readonly privacyPolicy: TPrivacyPolicy,
private readonly dataManager: EntityDataManager<TFields>,
protected readonly metricsAdapter: IEntityMetricsAdapter
) {}
/**
* Load many entity results where fieldName is one of fieldValues.
* @param fieldName - entity field being queried
* @param fieldValues - fieldName field values being queried
* @returns map from fieldValue to entity results that match the query for that fieldValue,
* where result errors can be UnauthorizedError
*/
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N,
fieldValues: readonly NonNullable<TFields[N]>[]
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
this.validateFieldValues(fieldName, fieldValues);
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
this.queryContext,
fieldName,
fieldValues
);
return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects);
}
/**
* Load many entity results where fieldName equals fieldValue.
* @param fieldName - entity field being queried
* @param fieldValue - fieldName field value being queried
* @returns array of entity results that match the query for fieldValue, where result error can be UnauthorizedError
*/
async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N,
fieldValue: NonNullable<TFields[N]>
): Promise<readonly Result<TEntity>[]> {
const entityResults = await this.loadManyByFieldEqualingManyAsync(fieldName, [fieldValue]);
const entityResultsForFieldValue = entityResults.get(fieldValue);
invariant(
entityResultsForFieldValue !== undefined,
`${fieldValue} should be guaranteed to be present in returned map of entities`
);
return entityResultsForFieldValue!;
}
/**
* Load an entity result where fieldName equals fieldValue, or null if no entity exists.
* @param uniqueFieldName - entity field being queried
* @param fieldValue - uniqueFieldName field value being queried
* @returns entity result where uniqueFieldName equals fieldValue, or null if no entity matches the condition.
* @throws when multiple entities match the condition
*/
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
uniqueFieldName: N,
fieldValue: NonNullable<TFields[N]>
): Promise<Result<TEntity> | null> {
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue);
invariant(
entityResults.length <= 1,
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${uniqueFieldName}=${fieldValue}`
);
return entityResults[0] ?? null;
}
/**
* Loads an entityresult by a specified ID.
* @param id - ID of the entity
* @returns entity result for matching ID, where result error can be UnauthorizedError or EntityNotFoundError.
*/
async loadByIDAsync(id: TID): Promise<Result<TEntity>> {
const entityResults = await this.loadManyByIDsAsync([id]);
const entityResult = entityResults.get(id);
if (entityResult === undefined) {
return result(
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
);
}
return entityResult;
}
/**
* Load an entity result by a specified ID, or return null if non-existent.
* @param id - ID of the entity
* @returns entity result for matching ID, or null if no entity exists for ID.
*/
async loadByIDNullableAsync(id: TID): Promise<Result<TEntity> | null> {
return await this.loadByFieldEqualingAsync(
this.entityConfiguration.idField as TSelectedFields,
id
);
}
/**
* Loads many entity results for a list of IDs.
* @param viewerContext - viewer context of loading user
* @param ids - IDs of the entities to load
* @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
*/
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
const entityResults = (await this.loadManyByFieldEqualingManyAsync(
this.entityConfiguration.idField as TSelectedFields,
ids
)) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
return mapMap(entityResults, (entityResultsForId, id) => {
const entityResult = entityResultsForId[0];
return (
entityResult ??
result(new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id))
);
});
}
/**
* Loads many entity results matching the conjunction of WHERE clauses constructed from specified operands.
* Entities loaded using this method are not batched or cached.
*
* @example
* fieldEqualityOperands:
* `[{fieldName: 'hello', fieldValue: 1}, {fieldName: 'world', fieldValues: [2, 3]}]`
* Entities returned:
* `WHERE hello = 1 AND world = ANY({2, 3})`
*
* @param fieldEqualityOperands - list of field equality WHERE clause operand specifications
* @param querySelectionModifiers - limit, offset, and orderBy for the query
* @returns array of entity results that match the query, where result error can be UnauthorizedError
*/
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly Result<TEntity>[]> {
for (const fieldEqualityOperand of fieldEqualityOperands) {
const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
? [fieldEqualityOperand.fieldValue]
: fieldEqualityOperand.fieldValues;
this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
}
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
this.queryContext,
fieldEqualityOperands,
querySelectionModifiers
);
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
return await Promise.all(
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
if (!uncheckedEntityResult.ok) {
return uncheckedEntityResult;
}
return await asyncResult(
this.privacyPolicy.authorizeReadAsync(
this.viewerContext,
this.queryContext,
this.privacyPolicyEvaluationContext,
uncheckedEntityResult.value,
this.metricsAdapter
)
);
})
);
}
/**
* Loads many entity results matching the raw WHERE clause. Corresponds to the knex `whereRaw` argument format.
*
* @remarks
* Important notes:
* - Fields in clause are database column names instead of transformed entity field names.
* - Entities loaded using this method are not batched or cached.
* - Not all database adapters implement the ability to execute this method of fetching entities.
*
* @example
* rawWhereClause: `id = ?`
* bindings: `[1]`
* Entites returned `WHERE id = 1`
*
* {@link http://knexjs.org/#Builder-whereRaw}
* {@link http://knexjs.org/#Raw-Bindings}
*
* @param rawWhereClause - parameterized SQL WHERE clause with positional binding placeholders or named binding placeholders
* @param bindings - array of positional bindings or object of named bindings
* @param querySelectionModifiers - limit, offset, and orderBy for the query
* @returns array of entity results that match the query, where result error can be UnauthorizedError
* @throws Error when rawWhereClause or bindings are invalid
*
* @deprecated prefer caching loaders
*/
async loadManyByRawWhereClauseAsync(
rawWhereClause: string,
bindings: any[] | object,
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly Result<TEntity>[]> {
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync(
this.queryContext,
rawWhereClause,
bindings,
querySelectionModifiers
);
const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
return await Promise.all(
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
if (!uncheckedEntityResult.ok) {
return uncheckedEntityResult;
}
return await asyncResult(
this.privacyPolicy.authorizeReadAsync(
this.viewerContext,
this.queryContext,
this.privacyPolicyEvaluationContext,
uncheckedEntityResult.value,
this.metricsAdapter
)
);
})
);
}
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
return fieldsObjects.map((fieldsObject) => {
try {
return result(new this.entityClass(this.viewerContext, fieldsObject));
} catch (e) {
if (!(e instanceof Error)) {
throw e;
}
return result(e);
}
});
}
/**
* Construct and authorize entities from fields map, returning error results for entities that fail
* to construct or fail to authorize.
*
* @param map - map from an arbitrary key type to an array of entity field objects
*/
public async constructAndAuthorizeEntitiesAsync<K>(
map: ReadonlyMap<K, readonly Readonly<TFields>[]>
): Promise<ReadonlyMap<K, readonly Result<TEntity>[]>> {
const uncheckedEntityResultsMap = mapMap(map, (fieldObjects) =>
this.tryConstructEntities(fieldObjects)
);
return await mapMapAsync(uncheckedEntityResultsMap, async (uncheckedEntityResults) => {
return await Promise.all(
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
if (!uncheckedEntityResult.ok) {
return uncheckedEntityResult;
}
return await asyncResult(
this.privacyPolicy.authorizeReadAsync(
this.viewerContext,
this.queryContext,
this.privacyPolicyEvaluationContext,
uncheckedEntityResult.value,
this.metricsAdapter
)
);
})
);
});
}
private validateFieldValues<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N,
fieldValues: readonly TFields[N][]
): void {
const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
for (const fieldValue of fieldValues) {
const isInputValid = fieldDefinition.validateInputValue(fieldValue);
if (!isInputValid) {
throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
}
}
}
}
+1 -1
View File
@@ -156,6 +156,6 @@ export default abstract class ReadonlyEntity<
return viewerContext return viewerContext
.getViewerScopedEntityCompanionForClass(this) .getViewerScopedEntityCompanionForClass(this)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext); .forLoad(queryContext, { cascadingDeleteCause: null });
} }
} }
@@ -1,6 +1,6 @@
import EntityLoader from './EntityLoader'; import EntityLoader from './EntityLoader';
import EntityLoaderFactory from './EntityLoaderFactory'; import EntityLoaderFactory from './EntityLoaderFactory';
import EntityPrivacyPolicy from './EntityPrivacyPolicy'; import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext'; import { EntityQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity'; import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
@@ -35,8 +35,13 @@ export default class ViewerScopedEntityLoaderFactory<
) {} ) {}
forLoad( forLoad(
queryContext: EntityQueryContext queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> { ): 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 { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
import EntityMutatorFactory from './EntityMutatorFactory'; import EntityMutatorFactory from './EntityMutatorFactory';
import EntityPrivacyPolicy from './EntityPrivacyPolicy'; import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext'; import { EntityQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity'; import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
@@ -35,22 +35,37 @@ export default class ViewerScopedEntityMutatorFactory<
) {} ) {}
forCreate( forCreate(
queryContext: EntityQueryContext queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> { ): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return this.entityMutatorFactory.forCreate(this.viewerContext, queryContext); return this.entityMutatorFactory.forCreate(
this.viewerContext,
queryContext,
privacyPolicyEvaluationContext
);
} }
forUpdate( forUpdate(
existingEntity: TEntity, existingEntity: TEntity,
queryContext: EntityQueryContext queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> { ): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return this.entityMutatorFactory.forUpdate(existingEntity, queryContext); return this.entityMutatorFactory.forUpdate(
existingEntity,
queryContext,
privacyPolicyEvaluationContext
);
} }
forDelete( forDelete(
existingEntity: TEntity, existingEntity: TEntity,
queryContext: EntityQueryContext queryContext: EntityQueryContext,
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> { ): 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 { result } from '@expo/results';
import { mock, instance, when, anything } from 'ts-mockito'; import { mock, instance, when, anything } from 'ts-mockito';
import EnforcingEntityLoader from '../EnforcingEntityLoader';
import EntityLoader from '../EntityLoader'; import EntityLoader from '../EntityLoader';
import EnforcingEntityLoader from '../EntityResultLoader';
describe(EnforcingEntityLoader, () => { describe(EnforcingEntityLoader, () => {
describe('loadManyByFieldEqualingManyAsync', () => { describe('loadManyByFieldEqualingManyAsync', () => {
it('throws when result is unsuccessful', async () => { it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error(); const rejection = new Error();
when(entityLoaderMock.loadManyByFieldEqualingManyAsync(anything(), anything())).thenResolve( when(
entityLoaderMock.resultLoader.loadManyByFieldEqualingManyAsync(anything(), anything())
).thenResolve(
new Map( new Map(
Object.entries({ Object.entries({
hello: [result(rejection)], hello: [result(rejection)],
@@ -26,7 +28,9 @@ describe(EnforcingEntityLoader, () => {
it('returns value when result is successful', async () => { it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {}; const resolved = {};
when(entityLoaderMock.loadManyByFieldEqualingManyAsync(anything(), anything())).thenResolve( when(
entityLoaderMock.resultLoader.loadManyByFieldEqualingManyAsync(anything(), anything())
).thenResolve(
new Map( new Map(
Object.entries({ Object.entries({
hello: [result(resolved)], hello: [result(resolved)],
@@ -51,9 +55,9 @@ describe(EnforcingEntityLoader, () => {
it('throws when result is unsuccessful', async () => { it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error(); const rejection = new Error();
when(entityLoaderMock.loadManyByFieldEqualingAsync(anything(), anything())).thenResolve([ when(
result(rejection), entityLoaderMock.resultLoader.loadManyByFieldEqualingAsync(anything(), anything())
]); ).thenResolve([result(rejection)]);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect( await expect(
@@ -64,9 +68,9 @@ describe(EnforcingEntityLoader, () => {
it('returns value when result is successful', async () => { it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {}; const resolved = {};
when(entityLoaderMock.loadManyByFieldEqualingAsync(anything(), anything())).thenResolve([ when(
result(resolved), entityLoaderMock.resultLoader.loadManyByFieldEqualingAsync(anything(), anything())
]); ).thenResolve([result(resolved)]);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect( await expect(
@@ -79,9 +83,9 @@ describe(EnforcingEntityLoader, () => {
it('throws when result is unsuccessful', async () => { it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error(); const rejection = new Error();
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve( when(
result(rejection) entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
); ).thenResolve(result(rejection));
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect( await expect(
@@ -92,9 +96,9 @@ describe(EnforcingEntityLoader, () => {
it('returns value when result is successful', async () => { it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {}; const resolved = {};
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve( when(
result(resolved) entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
); ).thenResolve(result(resolved));
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect( await expect(
@@ -105,9 +109,9 @@ describe(EnforcingEntityLoader, () => {
it('returns null when result is successful and no entity is found', async () => { 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 entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = null; const resolved = null;
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenResolve( when(
result(resolved) entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
); ).thenResolve(result(resolved));
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect( await expect(
@@ -118,9 +122,9 @@ describe(EnforcingEntityLoader, () => {
it('throws when multiple matching entities are found', async () => { it('throws when multiple matching entities are found', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const multipleEntitiesError = new Error(); const multipleEntitiesError = new Error();
when(entityLoaderMock.loadByFieldEqualingAsync(anything(), anything())).thenReject( when(
multipleEntitiesError entityLoaderMock.resultLoader.loadByFieldEqualingAsync(anything(), anything())
); ).thenReject(multipleEntitiesError);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect( await expect(
@@ -133,7 +137,7 @@ describe(EnforcingEntityLoader, () => {
it('throws when result is unsuccessful', async () => { it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error(); const rejection = new Error();
when(entityLoaderMock.loadByIDAsync(anything())).thenResolve(result(rejection)); when(entityLoaderMock.resultLoader.loadByIDAsync(anything())).thenResolve(result(rejection));
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect(enforcingEntityLoader.loadByIDAsync(anything())).rejects.toThrow(rejection); await expect(enforcingEntityLoader.loadByIDAsync(anything())).rejects.toThrow(rejection);
@@ -142,7 +146,7 @@ describe(EnforcingEntityLoader, () => {
it('returns value when result is successful', async () => { it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {}; const resolved = {};
when(entityLoaderMock.loadByIDAsync(anything())).thenResolve(result(resolved)); when(entityLoaderMock.resultLoader.loadByIDAsync(anything())).thenResolve(result(resolved));
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect(enforcingEntityLoader.loadByIDAsync(anything())).resolves.toEqual(resolved); await expect(enforcingEntityLoader.loadByIDAsync(anything())).resolves.toEqual(resolved);
@@ -153,7 +157,9 @@ describe(EnforcingEntityLoader, () => {
it('throws when result is unsuccessful', async () => { it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error(); const rejection = new Error();
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(rejection)); when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
result(rejection)
);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).rejects.toThrow( await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).rejects.toThrow(
@@ -164,7 +170,9 @@ describe(EnforcingEntityLoader, () => {
it('returns value when result is successful', async () => { it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {}; const resolved = {};
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(resolved)); when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
result(resolved)
);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).resolves.toEqual( await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).resolves.toEqual(
@@ -175,7 +183,9 @@ describe(EnforcingEntityLoader, () => {
it('returns null when non-existent object', async () => { it('returns null when non-existent object', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = null; const resolved = null;
when(entityLoaderMock.loadByIDNullableAsync(anything())).thenResolve(result(resolved)); when(entityLoaderMock.resultLoader.loadByIDNullableAsync(anything())).thenResolve(
result(resolved)
);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).resolves.toEqual( await expect(enforcingEntityLoader.loadByIDNullableAsync(anything())).resolves.toEqual(
@@ -188,7 +198,7 @@ describe(EnforcingEntityLoader, () => {
it('throws when result is unsuccessful', async () => { it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error(); const rejection = new Error();
when(entityLoaderMock.loadManyByIDsAsync(anything())).thenResolve( when(entityLoaderMock.resultLoader.loadManyByIDsAsync(anything())).thenResolve(
new Map( new Map(
Object.entries({ Object.entries({
hello: result(rejection), hello: result(rejection),
@@ -203,7 +213,7 @@ describe(EnforcingEntityLoader, () => {
it('returns value when result is successful', async () => { it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {}; const resolved = {};
when(entityLoaderMock.loadManyByIDsAsync(anything())).thenResolve( when(entityLoaderMock.resultLoader.loadManyByIDsAsync(anything())).thenResolve(
new Map( new Map(
Object.entries({ Object.entries({
hello: result(resolved), hello: result(resolved),
@@ -227,7 +237,10 @@ describe(EnforcingEntityLoader, () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error(); const rejection = new Error();
when( when(
entityLoaderMock.loadManyByFieldEqualityConjunctionAsync(anything(), anything()) entityLoaderMock.resultLoader.loadManyByFieldEqualityConjunctionAsync(
anything(),
anything()
)
).thenResolve([result(rejection)]); ).thenResolve([result(rejection)]);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
@@ -240,7 +253,10 @@ describe(EnforcingEntityLoader, () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {}; const resolved = {};
when( when(
entityLoaderMock.loadManyByFieldEqualityConjunctionAsync(anything(), anything()) entityLoaderMock.resultLoader.loadManyByFieldEqualityConjunctionAsync(
anything(),
anything()
)
).thenResolve([result(resolved)]); ).thenResolve([result(resolved)]);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
@@ -255,7 +271,11 @@ describe(EnforcingEntityLoader, () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error(); const rejection = new Error();
when( when(
entityLoaderMock.loadManyByRawWhereClauseAsync(anything(), anything(), anything()) entityLoaderMock.resultLoader.loadManyByRawWhereClauseAsync(
anything(),
anything(),
anything()
)
).thenResolve([result(rejection)]); ).thenResolve([result(rejection)]);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
@@ -268,7 +288,11 @@ describe(EnforcingEntityLoader, () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader); const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {}; const resolved = {};
when( when(
entityLoaderMock.loadManyByRawWhereClauseAsync(anything(), anything(), anything()) entityLoaderMock.resultLoader.loadManyByRawWhereClauseAsync(
anything(),
anything(),
anything()
)
).thenResolve([result(resolved)]); ).thenResolve([result(resolved)]);
const entityLoader = instance(entityLoaderMock); const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader); const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
@@ -5,7 +5,7 @@ import Entity from '../Entity';
import EntityCompanionProvider, { EntityCompanionDefinition } from '../EntityCompanionProvider'; import EntityCompanionProvider, { EntityCompanionDefinition } from '../EntityCompanionProvider';
import EntityConfiguration from '../EntityConfiguration'; import EntityConfiguration from '../EntityConfiguration';
import { UUIDField } from '../EntityFields'; import { UUIDField } from '../EntityFields';
import EntityPrivacyPolicy from '../EntityPrivacyPolicy'; import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import { EntityQueryContext } from '../EntityQueryContext'; import { EntityQueryContext } from '../EntityQueryContext';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
import { enforceResultsAsync } from '../entityUtils'; import { enforceResultsAsync } from '../entityUtils';
@@ -51,6 +51,7 @@ class DenyIfNotOwnerPrivacyPolicyRule extends PrivacyPolicyRule<
async evaluateAsync( async evaluateAsync(
viewerContext: TestUserViewerContext, viewerContext: TestUserViewerContext,
_queryContext: EntityQueryContext, _queryContext: EntityQueryContext,
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: BlahEntity entity: BlahEntity
): Promise<RuleEvaluationResult> { ): Promise<RuleEvaluationResult> {
if (viewerContext.getUserID() === entity.getField('ownerID')) { 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 // check that two people can't read each others data
await expect( await expect(
enforceAsyncResult(BlahEntity.loader(vc1).loadByIDAsync(blahOwner2.getID())) enforceAsyncResult(BlahEntity.loader(vc1).resultLoader.loadByIDAsync(blahOwner2.getID()))
).rejects.toBeInstanceOf(EntityNotAuthorizedError); ).rejects.toBeInstanceOf(EntityNotAuthorizedError);
await expect( await expect(
enforceAsyncResult(BlahEntity.loader(vc2).loadByIDAsync(blahOwner1.getID())) enforceAsyncResult(BlahEntity.loader(vc2).resultLoader.loadByIDAsync(blahOwner1.getID()))
).rejects.toBeInstanceOf(EntityNotAuthorizedError); ).rejects.toBeInstanceOf(EntityNotAuthorizedError);
// check that all of owner 1's objects can be loaded // check that all of owner 1's objects can be loaded
const results = await enforceResultsAsync( const results = await enforceResultsAsync(
BlahEntity.loader(vc1).loadManyByFieldEqualingAsync('ownerID', vc1.getUserID()!) BlahEntity.loader(vc1).resultLoader.loadManyByFieldEqualingAsync('ownerID', vc1.getUserID()!)
); );
expect(results).toHaveLength(2); expect(results).toHaveLength(2);
@@ -148,7 +149,10 @@ it('runs through a common workflow', async () => {
).rejects.toBeInstanceOf(EntityNotAuthorizedError); ).rejects.toBeInstanceOf(EntityNotAuthorizedError);
// check that empty load many returns nothing // 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) { for (const value in results2.values) {
expect(value).toHaveLength(0); expect(value).toHaveLength(0);
} }
+292 -51
View File
@@ -5,10 +5,13 @@ import { EntityEdgeDeletionBehavior } from '../EntityFieldDefinition';
import { UUIDField } from '../EntityFields'; import { UUIDField } from '../EntityFields';
import { EntityTriggerMutationInfo, EntityMutationType } from '../EntityMutationInfo'; import { EntityTriggerMutationInfo, EntityMutationType } from '../EntityMutationInfo';
import { EntityMutationTrigger } from '../EntityMutationTriggerConfiguration'; import { EntityMutationTrigger } from '../EntityMutationTriggerConfiguration';
import EntityPrivacyPolicy from '../EntityPrivacyPolicy'; import EntityPrivacyPolicy, {
import { EntityTransactionalQueryContext } from '../EntityQueryContext'; EntityPrivacyPolicyEvaluationContext,
EntityAuthorizationAction,
} from '../EntityPrivacyPolicy';
import { EntityTransactionalQueryContext, EntityQueryContext } from '../EntityQueryContext';
import { CacheStatus } from '../internal/ReadThroughEntityCache'; import { CacheStatus } from '../internal/ReadThroughEntityCache';
import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule'; import PrivacyPolicyRule, { RuleEvaluationResult } from '../rules/PrivacyPolicyRule';
import TestViewerContext from '../testfixtures/TestViewerContext'; import TestViewerContext from '../testfixtures/TestViewerContext';
import { InMemoryFullCacheStubCacheAdapter } from '../utils/testing/StubCacheAdapter'; import { InMemoryFullCacheStubCacheAdapter } from '../utils/testing/StubCacheAdapter';
import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider'; import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
@@ -27,6 +30,62 @@ interface GrandChildFields {
parent_id: string; parent_id: string;
} }
// 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< class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
any, any,
string, string,
@@ -35,27 +94,19 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
any any
> { > {
protected override readonly readRules = [ protected override readonly readRules = [
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(), new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.READ),
]; ];
protected override readonly createRules = [ protected override readonly createRules = [
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(), new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.CREATE),
]; ];
protected override readonly updateRules = [ protected override readonly updateRules = [
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(), new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.UPDATE),
]; ];
protected override readonly deleteRules = [ protected override readonly deleteRules = [
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(), new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.DELETE),
]; ];
} }
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
const triggerExecutionCounts = {
parent: 0,
child: 0,
grandchild: 0,
};
class ParentCheckInfoTrigger extends EntityMutationTrigger< class ParentCheckInfoTrigger extends EntityMutationTrigger<
ParentFields, ParentFields,
string, string,
@@ -76,7 +127,7 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
throw new Error('Parent entity should not have casade delete cause'); throw new Error('Parent entity should not have casade delete cause');
} }
triggerExecutionCounts.parent++; triggerExecutionCounts.ParentEntity++;
} }
} }
@@ -111,7 +162,7 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
throw new Error('Child entity should not have two-level casade delete cause'); throw new Error('Child entity should not have two-level casade delete cause');
} }
triggerExecutionCounts.child++; triggerExecutionCounts.ChildEntity++;
} }
} }
@@ -165,7 +216,7 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
throw new Error('GrandChild entity should not have three-level casade delete cause'); throw new Error('GrandChild entity should not have three-level casade delete cause');
} }
triggerExecutionCounts.grandchild++; triggerExecutionCounts.GrandChildEntity++;
} }
} }
@@ -297,14 +348,20 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
ChildEntity, ChildEntity,
GrandChildEntity, GrandChildEntity,
triggerExecutionCounts, triggerExecutionCounts,
privacyPolicyEvaluationRecords,
}; };
}; };
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => { describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => { describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
it('deletes', async () => { it('deletes', async () => {
const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } = const {
makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE); ParentEntity,
ChildEntity,
GrandChildEntity,
triggerExecutionCounts,
privacyPolicyEvaluationRecords,
} = makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE);
const companionProvider = createUnitTestEntityCompanionProvider(); const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider); const viewerContext = new TestViewerContext(companionProvider);
@@ -317,40 +374,107 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
.enforceCreateAsync(); .enforceCreateAsync();
await expect( await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()) ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID()) ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID()) GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
privacyPolicyEvaluationRecords.shouldRecord = true;
await ParentEntity.enforceDeleteAsync(parent); await ParentEntity.enforceDeleteAsync(parent);
privacyPolicyEvaluationRecords.shouldRecord = false;
await expect( await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()) ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID()) ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID()) GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
// two calls for each trigger, one beforeDelete, one afterDelete // two calls for each trigger, one beforeDelete, one afterDelete
expect(triggerExecutionCounts).toMatchObject({ expect(triggerExecutionCounts).toMatchObject({
parent: 2, ParentEntity: 2,
child: 2, ChildEntity: 2,
grandchild: 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', () => { describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
it('sets null', async () => { it('sets null', async () => {
const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } = const {
makeEntityClasses(EntityEdgeDeletionBehavior.SET_NULL); ParentEntity,
ChildEntity,
GrandChildEntity,
triggerExecutionCounts,
privacyPolicyEvaluationRecords,
} = makeEntityClasses(EntityEdgeDeletionBehavior.SET_NULL);
const companionProvider = createUnitTestEntityCompanionProvider(); const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider); const viewerContext = new TestViewerContext(companionProvider);
@@ -364,45 +488,100 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
.enforceCreateAsync(); .enforceCreateAsync();
await expect( await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()) ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID()) ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID()) GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
privacyPolicyEvaluationRecords.shouldRecord = true;
await ParentEntity.enforceDeleteAsync(parent); await ParentEntity.enforceDeleteAsync(parent);
privacyPolicyEvaluationRecords.shouldRecord = false;
await expect( await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()) ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
const loadedChild = await ChildEntity.loader(viewerContext) const loadedChild = await ChildEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(child.getID()); .loadByIDAsync(child.getID());
expect(loadedChild.getField('parent_id')).toBeNull(); expect(loadedChild.getField('parent_id')).toBeNull();
const loadedGrandchild = await GrandChildEntity.loader(viewerContext) const loadedGrandchild = await GrandChildEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(grandchild.getID()); .loadByIDAsync(grandchild.getID());
expect(loadedGrandchild.getField('parent_id')).toEqual(loadedChild.getID()); expect(loadedGrandchild.getField('parent_id')).toEqual(loadedChild.getID());
// two calls for only parent trigger, one beforeDelete, one afterDelete // two calls for only parent trigger, one beforeDelete, one afterDelete
// when using set null the descendants aren't deleted // when using set null the descendants aren't deleted
expect(triggerExecutionCounts).toMatchObject({ expect(triggerExecutionCounts).toMatchObject({
parent: 2, ParentEntity: 2,
child: 0, ChildEntity: 0,
grandchild: 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', () => { describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
it('invalidates the cache', async () => { it('invalidates the cache', async () => {
const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } = const {
makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE); ParentEntity,
ChildEntity,
GrandChildEntity,
triggerExecutionCounts,
privacyPolicyEvaluationRecords,
} = makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE);
const companionProvider = createUnitTestEntityCompanionProvider(); const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider); const viewerContext = new TestViewerContext(companionProvider);
@@ -416,16 +595,16 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
.enforceCreateAsync(); .enforceCreateAsync();
await expect( await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()) ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
ChildEntity.loader(viewerContext) ChildEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_id', parent.getID()) .loadByFieldEqualingAsync('parent_id', parent.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
GrandChildEntity.loader(viewerContext) GrandChildEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_id', child.getID()) .loadByFieldEqualingAsync('parent_id', child.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
@@ -447,7 +626,9 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
]); ]);
expect(grandChildCachedBefore.get(child.getID())?.status).toEqual(CacheStatus.HIT); expect(grandChildCachedBefore.get(child.getID())?.status).toEqual(CacheStatus.HIT);
privacyPolicyEvaluationRecords.shouldRecord = true;
await ParentEntity.enforceDeleteAsync(parent); await ParentEntity.enforceDeleteAsync(parent);
privacyPolicyEvaluationRecords.shouldRecord = false;
const childCachedAfter = await childCacheAdapter.loadManyAsync('parent_id', [parent.getID()]); const childCachedAfter = await childCacheAdapter.loadManyAsync('parent_id', [parent.getID()]);
expect(childCachedAfter.get(parent.getID())?.status).toEqual(CacheStatus.MISS); expect(childCachedAfter.get(parent.getID())?.status).toEqual(CacheStatus.MISS);
@@ -458,20 +639,80 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
expect(grandChildCachedAfter.get(child.getID())?.status).toEqual(CacheStatus.MISS); expect(grandChildCachedAfter.get(child.getID())?.status).toEqual(CacheStatus.MISS);
await expect( await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()) ParentEntity.loader(viewerContext).loadByIDNullableAsync(parent.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID()) ChildEntity.loader(viewerContext).loadByIDNullableAsync(child.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID()) GrandChildEntity.loader(viewerContext).loadByIDNullableAsync(grandchild.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
// two calls for each trigger, one beforeDelete, one afterDelete // two calls for each trigger, one beforeDelete, one afterDelete
expect(triggerExecutionCounts).toMatchObject({ expect(triggerExecutionCounts).toMatchObject({
parent: 2, ParentEntity: 2,
child: 2, ChildEntity: 2,
grandchild: 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 EntityConfiguration from '../EntityConfiguration';
import { StringField } from '../EntityFields'; import { StringField } from '../EntityFields';
import EntityLoader from '../EntityLoader'; import EntityLoader from '../EntityLoader';
import EntityPrivacyPolicy from '../EntityPrivacyPolicy'; import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
import EntityDataManager from '../internal/EntityDataManager'; import EntityDataManager from '../internal/EntityDataManager';
import ReadThroughEntityCache from '../internal/ReadThroughEntityCache'; import ReadThroughEntityCache from '../internal/ReadThroughEntityCache';
@@ -118,6 +118,7 @@ export const testEntityCompanion = new EntityCompanionDefinition({
describe(EntityLoader, () => { describe(EntityLoader, () => {
it('handles thrown errors and literals from constructor', async () => { it('handles thrown errors and literals from constructor', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
@@ -154,6 +155,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -163,14 +165,14 @@ describe(EntityLoader, () => {
let capturedThrownThing1: any; let capturedThrownThing1: any;
try { try {
await entityLoader.loadByIDAsync(ID_SENTINEL_THROW_LITERAL); await entityLoader.resultLoader.loadByIDAsync(ID_SENTINEL_THROW_LITERAL);
} catch (e) { } catch (e) {
capturedThrownThing1 = e; capturedThrownThing1 = e;
} }
expect(capturedThrownThing1).not.toBeInstanceOf(Error); expect(capturedThrownThing1).not.toBeInstanceOf(Error);
expect(capturedThrownThing1).toEqual('hello'); 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.ok).toBe(false);
expect(result.enforceError().message).toEqual('world'); 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 { v4 as uuidv4 } from 'uuid';
import EntityLoader from '../EntityLoader'; import EntityLoader from '../EntityLoader';
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
import { enforceResultsAsync } from '../entityUtils'; import { enforceResultsAsync } from '../entityUtils';
import EntityDataManager from '../internal/EntityDataManager'; import EntityDataManager from '../internal/EntityDataManager';
@@ -21,6 +22,7 @@ describe(EntityLoader, () => {
it('loads entities', async () => { it('loads entities', async () => {
const dateToInsert = new Date(); const dateToInsert = new Date();
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
@@ -69,42 +71,46 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
dataManager, dataManager,
metricsAdapter metricsAdapter
); );
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1)); const entity = await enforceAsyncResult(entityLoader.resultLoader.loadByIDAsync(id1));
expect(entity.getID()).toEqual(id1); expect(entity.getID()).toEqual(id1);
expect(entity.getField('dateField')).toEqual(dateToInsert); expect(entity.getField('dateField')).toEqual(dateToInsert);
const entities = await enforceResultsAsync( const entities = await enforceResultsAsync(
entityLoader.loadManyByFieldEqualingAsync('stringField', 'huh') entityLoader.resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
); );
expect(entities.map((m) => m.getID())).toEqual([id1, id2]); 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).not.toBeNull();
expect(entityResultNumber3!.enforceValue().getID()).toEqual(id2); expect(entityResultNumber3!.enforceValue().getID()).toEqual(id2);
const entityResultNumber4 = await entityLoader.loadByFieldEqualingAsync('intField', 4); const entityResultNumber4 = await entityLoader.resultLoader.loadByFieldEqualingAsync('intField', 4);
expect(entityResultNumber4).toBeNull(); expect(entityResultNumber4).toBeNull();
const entityResultDuplicateValues = await entityLoader const entityResultDuplicateValues = await entityLoader.loadManyByFieldEqualingManyAsync(
.enforcing() 'stringField',
.loadManyByFieldEqualingManyAsync('stringField', ['huh', 'huh']); ['huh', 'huh']
);
expect(entityResultDuplicateValues.size).toBe(1); expect(entityResultDuplicateValues.size).toBe(1);
expect(entityResultDuplicateValues.get('huh')?.map((m) => m.getID())).toEqual([id1, id2]); 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' 'loadByFieldEqualing: Multiple entities of type TestEntity found for stringField=huh'
); );
await expect(entityLoader.loadByIDNullableAsync(uuidv4())).resolves.toBeNull(); await expect(entityLoader.resultLoader.loadByIDNullableAsync(uuidv4())).resolves.toBeNull();
await expect(entityLoader.loadByIDNullableAsync(id1)).resolves.not.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)' 'Entity field not valid: TestEntity (customIdField = not-a-uuid)'
); );
}); });
@@ -113,6 +119,7 @@ describe(EntityLoader, () => {
const privacyPolicy = new TestEntityPrivacyPolicy(); const privacyPolicy = new TestEntityPrivacyPolicy();
const spiedPrivacyPolicy = spy(privacyPolicy); const spiedPrivacyPolicy = spy(privacyPolicy);
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
@@ -169,6 +176,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -176,7 +184,7 @@ describe(EntityLoader, () => {
metricsAdapter metricsAdapter
); );
const entities = await enforceResultsAsync( const entities = await enforceResultsAsync(
entityLoader.loadManyByFieldEqualityConjunctionAsync([ entityLoader.resultLoader.loadManyByFieldEqualityConjunctionAsync([
{ {
fieldName: 'stringField', fieldName: 'stringField',
fieldValue: 'huh', fieldValue: 'huh',
@@ -192,13 +200,14 @@ describe(EntityLoader, () => {
spiedPrivacyPolicy.authorizeReadAsync( spiedPrivacyPolicy.authorizeReadAsync(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
).twice(); ).twice();
await expect( await expect(
entityLoader.loadManyByFieldEqualityConjunctionAsync([ entityLoader.resultLoader.loadManyByFieldEqualityConjunctionAsync([
{ fieldName: 'customIdField', fieldValue: 'not-a-uuid' }, { fieldName: 'customIdField', fieldValue: 'not-a-uuid' },
]) ])
).rejects.toThrowError('Entity field not valid: TestEntity (customIdField = not-a-uuid)'); ).rejects.toThrowError('Entity field not valid: TestEntity (customIdField = not-a-uuid)');
@@ -209,6 +218,7 @@ describe(EntityLoader, () => {
const spiedPrivacyPolicy = spy(privacyPolicy); const spiedPrivacyPolicy = spy(privacyPolicy);
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
@@ -247,20 +257,28 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
dataManager, dataManager,
metricsAdapter metricsAdapter
); );
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1)); const entity = await enforceAsyncResult(entityLoader.resultLoader.loadByIDAsync(id1));
verify( verify(
spiedPrivacyPolicy.authorizeReadAsync(viewerContext, queryContext, entity, anything()) spiedPrivacyPolicy.authorizeReadAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
entity,
anything()
)
).once(); ).once();
}); });
it('invalidates upon invalidate one', async () => { it('invalidates upon invalidate one', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy)); const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
@@ -271,6 +289,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -286,6 +305,7 @@ describe(EntityLoader, () => {
it('invalidates upon invalidate by field', async () => { it('invalidates upon invalidate by field', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy)); const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
@@ -296,6 +316,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -310,6 +331,7 @@ describe(EntityLoader, () => {
it('invalidates upon invalidate by entity', async () => { it('invalidates upon invalidate by entity', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy)); const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
@@ -324,6 +346,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -338,6 +361,7 @@ describe(EntityLoader, () => {
it('returns error result when not allowed', async () => { it('returns error result when not allowed', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicyMock = mock(TestEntityPrivacyPolicy); const privacyPolicyMock = mock(TestEntityPrivacyPolicy);
@@ -354,6 +378,7 @@ describe(EntityLoader, () => {
privacyPolicyMock.authorizeReadAsync( privacyPolicyMock.authorizeReadAsync(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -365,6 +390,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -372,7 +398,7 @@ describe(EntityLoader, () => {
metricsAdapter metricsAdapter
); );
const entityResult = await entityLoader.loadByIDAsync(id1); const entityResult = await entityLoader.resultLoader.loadByIDAsync(id1);
expect(entityResult.ok).toBe(false); expect(entityResult.ok).toBe(false);
expect(entityResult.reason).toEqual(rejectionError); expect(entityResult.reason).toEqual(rejectionError);
expect(entityResult.value).toBe(undefined); expect(entityResult.value).toBe(undefined);
@@ -380,6 +406,7 @@ describe(EntityLoader, () => {
it('throws upon database adapter error', async () => { it('throws upon database adapter error', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>()); const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(TestEntityPrivacyPolicy)); const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
@@ -396,6 +423,7 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -405,21 +433,21 @@ describe(EntityLoader, () => {
const loadByValue = uuidv4(); const loadByValue = uuidv4();
await expect(entityLoader.resultLoader.loadByIDAsync(loadByValue)).rejects.toEqual(error);
await expect(entityLoader.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.resultLoader.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.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error); await expect(
entityLoader.resultLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue)
).rejects.toEqual(error);
await expect( await expect(
entityLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue) entityLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue)
).rejects.toEqual(error); ).rejects.toEqual(error);
await expect( await expect(
entityLoader.enforcing().loadManyByFieldEqualingAsync('customIdField', loadByValue) entityLoader.resultLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
).rejects.toEqual(error); ).rejects.toEqual(error);
await expect( await expect(
entityLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue]) entityLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
).rejects.toEqual(error); ).rejects.toEqual(error);
await expect(
entityLoader.enforcing().loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
).rejects.toEqual(error);
}); });
}); });
@@ -78,7 +78,7 @@ class TestNonTransactionalMutationTrigger extends EntityNonTransactionalMutation
): Promise<void> { ): Promise<void> {
if (mutationInfo.type === EntityMutationType.DELETE) { if (mutationInfo.type === EntityMutationType.DELETE) {
const entityLoaded = await BlahEntity.loader(viewerContext) const entityLoaded = await BlahEntity.loader(viewerContext)
.enforcing()
.loadByIDNullableAsync(entity.getID()); .loadByIDNullableAsync(entity.getID());
if (entityLoaded) { if (entityLoaded) {
throw new Error( throw new Error(
@@ -97,7 +97,7 @@ describe('EntityMutator', () => {
// put it in cache // put it in cache
const entity = await BlahEntity.creator(viewerContext).enforceCreateAsync(); const entity = await BlahEntity.creator(viewerContext).enforceCreateAsync();
const entityLoaded = await BlahEntity.loader(viewerContext) const entityLoaded = await BlahEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity.getID()); .loadByIDAsync(entity.getID());
await BlahEntity.enforceDeleteAsync(entityLoaded); await BlahEntity.enforceDeleteAsync(entityLoaded);
@@ -25,6 +25,7 @@ import EntityMutationTriggerConfiguration, {
} from '../EntityMutationTriggerConfiguration'; } from '../EntityMutationTriggerConfiguration';
import EntityMutationValidator from '../EntityMutationValidator'; import EntityMutationValidator from '../EntityMutationValidator';
import EntityMutatorFactory from '../EntityMutatorFactory'; import EntityMutatorFactory from '../EntityMutatorFactory';
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import { EntityTransactionalQueryContext, EntityQueryContext } from '../EntityQueryContext'; import { EntityTransactionalQueryContext, EntityQueryContext } from '../EntityQueryContext';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
import { enforceResultsAsync } from '../entityUtils'; import { enforceResultsAsync } from '../entityUtils';
@@ -340,6 +341,7 @@ describe(EntityMutatorFactory, () => {
describe('forCreate', () => { describe('forCreate', () => {
it('creates entities', async () => { it('creates entities', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -363,7 +365,7 @@ describe(EntityMutatorFactory, () => {
}, },
]); ]);
const newEntity = await entityMutatorFactory const newEntity = await entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh') .setField('stringField', 'huh')
.enforceCreateAsync(); .enforceCreateAsync();
expect(newEntity).toBeTruthy(); expect(newEntity).toBeTruthy();
@@ -371,6 +373,7 @@ describe(EntityMutatorFactory, () => {
it('checks privacy', async () => { it('checks privacy', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -397,7 +400,7 @@ describe(EntityMutatorFactory, () => {
const spiedPrivacyPolicy = spy(privacyPolicy); const spiedPrivacyPolicy = spy(privacyPolicy);
await entityMutatorFactory await entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh') .setField('stringField', 'huh')
.enforceCreateAsync(); .enforceCreateAsync();
@@ -405,6 +408,7 @@ describe(EntityMutatorFactory, () => {
spiedPrivacyPolicy.authorizeCreateAsync( spiedPrivacyPolicy.authorizeCreateAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
privacyPolicyEvaluationContext,
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -413,6 +417,7 @@ describe(EntityMutatorFactory, () => {
it('executes triggers', async () => { it('executes triggers', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -439,7 +444,7 @@ describe(EntityMutatorFactory, () => {
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers); const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
await entityMutatorFactory await entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh') .setField('stringField', 'huh')
.enforceCreateAsync(); .enforceCreateAsync();
@@ -460,6 +465,7 @@ describe(EntityMutatorFactory, () => {
it('executes validators', async () => { it('executes validators', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -486,7 +492,7 @@ describe(EntityMutatorFactory, () => {
const validatorSpies = setUpMutationValidatorSpies(mutationValidators); const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
await entityMutatorFactory await entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh') .setField('stringField', 'huh')
.enforceCreateAsync(); .enforceCreateAsync();
@@ -497,6 +503,7 @@ describe(EntityMutatorFactory, () => {
describe('forUpdate', () => { describe('forUpdate', () => {
it('updates entities', async () => { it('updates entities', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -521,11 +528,13 @@ describe(EntityMutatorFactory, () => {
]); ]);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2) entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.resultLoader.loadByIDAsync(id2)
); );
const updatedEntity = await entityMutatorFactory const updatedEntity = await entityMutatorFactory
.forUpdate(existingEntity, queryContext) .forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh2') .setField('stringField', 'huh2')
.enforceUpdateAsync(); .enforceUpdateAsync();
@@ -534,13 +543,16 @@ describe(EntityMutatorFactory, () => {
expect(updatedEntity.getField('stringField')).toEqual('huh2'); expect(updatedEntity.getField('stringField')).toEqual('huh2');
const reloadedEntity = await enforceAsyncResult( const reloadedEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2) entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.resultLoader.loadByIDAsync(id2)
); );
expect(reloadedEntity.getAllFields()).toMatchObject(updatedEntity.getAllFields()); expect(reloadedEntity.getAllFields()).toMatchObject(updatedEntity.getAllFields());
}); });
it('checks privacy', async () => { it('checks privacy', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -568,11 +580,13 @@ describe(EntityMutatorFactory, () => {
const spiedPrivacyPolicy = spy(privacyPolicy); const spiedPrivacyPolicy = spy(privacyPolicy);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2) entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.resultLoader.loadByIDAsync(id2)
); );
await entityMutatorFactory await entityMutatorFactory
.forUpdate(existingEntity, queryContext) .forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh2') .setField('stringField', 'huh2')
.enforceUpdateAsync(); .enforceUpdateAsync();
@@ -580,6 +594,7 @@ describe(EntityMutatorFactory, () => {
spiedPrivacyPolicy.authorizeUpdateAsync( spiedPrivacyPolicy.authorizeUpdateAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
privacyPolicyEvaluationContext,
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -588,6 +603,7 @@ describe(EntityMutatorFactory, () => {
it('executes triggers', async () => { it('executes triggers', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -615,11 +631,13 @@ describe(EntityMutatorFactory, () => {
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers); const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2) entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.resultLoader.loadByIDAsync(id2)
); );
await entityMutatorFactory await entityMutatorFactory
.forUpdate(existingEntity, queryContext) .forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh2') .setField('stringField', 'huh2')
.enforceUpdateAsync(); .enforceUpdateAsync();
@@ -639,6 +657,7 @@ describe(EntityMutatorFactory, () => {
}); });
it('executes validators', async () => { it('executes validators', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -666,11 +685,13 @@ describe(EntityMutatorFactory, () => {
const validatorSpies = setUpMutationValidatorSpies(mutationValidators); const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2) entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.resultLoader.loadByIDAsync(id2)
); );
await entityMutatorFactory await entityMutatorFactory
.forUpdate(existingEntity, queryContext) .forUpdate(existingEntity, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh2') .setField('stringField', 'huh2')
.enforceUpdateAsync(); .enforceUpdateAsync();
@@ -684,6 +705,7 @@ describe(EntityMutatorFactory, () => {
describe('forDelete', () => { describe('forDelete', () => {
it('deletes entities', async () => { it('deletes entities', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -699,21 +721,28 @@ describe(EntityMutatorFactory, () => {
]); ]);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1) entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.resultLoader.loadByIDAsync(id1)
); );
expect(existingEntity).toBeTruthy(); expect(existingEntity).toBeTruthy();
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync(); await entityMutatorFactory
.forDelete(existingEntity, queryContext, privacyPolicyEvaluationContext)
.enforceDeleteAsync();
await expect( await expect(
enforceAsyncResult( enforceAsyncResult(
entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1) entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.resultLoader.loadByIDAsync(id1)
) )
).rejects.toBeInstanceOf(Error); ).rejects.toBeInstanceOf(Error);
}); });
it('checks privacy', async () => { it('checks privacy', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -732,15 +761,20 @@ describe(EntityMutatorFactory, () => {
const spiedPrivacyPolicy = spy(privacyPolicy); const spiedPrivacyPolicy = spy(privacyPolicy);
const existingEntity = await enforceAsyncResult( 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( verify(
spiedPrivacyPolicy.authorizeDeleteAsync( spiedPrivacyPolicy.authorizeDeleteAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
anything(),
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -749,6 +783,7 @@ describe(EntityMutatorFactory, () => {
it('executes triggers', async () => { it('executes triggers', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -767,10 +802,14 @@ describe(EntityMutatorFactory, () => {
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers); const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
const existingEntity = await enforceAsyncResult( 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( verifyTriggerCounts(
viewerContext, viewerContext,
@@ -789,6 +828,7 @@ describe(EntityMutatorFactory, () => {
it('does not execute validators', async () => { it('does not execute validators', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -807,10 +847,14 @@ describe(EntityMutatorFactory, () => {
const validatorSpies = setUpMutationValidatorSpies(mutationValidators); const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
const existingEntity = await enforceAsyncResult( 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, { verifyValidatorCounts(viewerContext, validatorSpies, 0, {
type: EntityMutationType.DELETE as any, type: EntityMutationType.DELETE as any,
@@ -820,6 +864,7 @@ describe(EntityMutatorFactory, () => {
it('invalidates cache for fields upon create', async () => { it('invalidates cache for fields upon create', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
@@ -836,28 +881,29 @@ describe(EntityMutatorFactory, () => {
const entites1 = await enforceResultsAsync( const entites1 = await enforceResultsAsync(
entityLoaderFactory entityLoaderFactory
.forLoad(viewerContext, queryContext) .forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadManyByFieldEqualingAsync('stringField', 'huh') .resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
); );
expect(entites1).toHaveLength(1); expect(entites1).toHaveLength(1);
await enforceAsyncResult( await enforceAsyncResult(
entityMutatorFactory entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh') .setField('stringField', 'huh')
.createAsync() .createAsync()
); );
const entities2 = await enforceResultsAsync( const entities2 = await enforceResultsAsync(
entityLoaderFactory entityLoaderFactory
.forLoad(viewerContext, queryContext) .forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadManyByFieldEqualingAsync('stringField', 'huh') .resultLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
); );
expect(entities2).toHaveLength(2); expect(entities2).toHaveLength(2);
}); });
it('throws error when field not valid', async () => { it('throws error when field not valid', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4(); const id1 = uuidv4();
const { entityMutatorFactory } = createEntityMutatorFactory([ const { entityMutatorFactory } = createEntityMutatorFactory([
@@ -873,19 +919,19 @@ describe(EntityMutatorFactory, () => {
await expect( await expect(
entityMutatorFactory entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 10 as any) .setField('stringField', 10 as any)
.createAsync() .createAsync()
).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)'); ).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
const createdEntity = await entityMutatorFactory const createdEntity = await entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'hello') .setField('stringField', 'hello')
.enforceCreateAsync(); .enforceCreateAsync();
await expect( await expect(
entityMutatorFactory entityMutatorFactory
.forUpdate(createdEntity, queryContext) .forUpdate(createdEntity, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 10 as any) .setField('stringField', 10 as any)
.updateAsync() .updateAsync()
).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)'); ).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
@@ -893,6 +939,7 @@ describe(EntityMutatorFactory, () => {
it('returns error result when not authorized to create', async () => { it('returns error result when not authorized to create', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicyMock = mock(SimpleTestEntityPrivacyPolicy); const privacyPolicyMock = mock(SimpleTestEntityPrivacyPolicy);
const databaseAdapter = instance(mock<EntityDatabaseAdapter<SimpleTestFields>>()); const databaseAdapter = instance(mock<EntityDatabaseAdapter<SimpleTestFields>>());
@@ -916,6 +963,7 @@ describe(EntityMutatorFactory, () => {
privacyPolicyMock.authorizeCreateAsync( privacyPolicyMock.authorizeCreateAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
anything(),
anyOfClass(SimpleTestEntity), anyOfClass(SimpleTestEntity),
anything() anything()
) )
@@ -924,6 +972,7 @@ describe(EntityMutatorFactory, () => {
privacyPolicyMock.authorizeUpdateAsync( privacyPolicyMock.authorizeUpdateAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
anything(),
anyOfClass(SimpleTestEntity), anyOfClass(SimpleTestEntity),
anything() anything()
) )
@@ -932,6 +981,7 @@ describe(EntityMutatorFactory, () => {
privacyPolicyMock.authorizeDeleteAsync( privacyPolicyMock.authorizeDeleteAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
anything(),
anyOfClass(SimpleTestEntity), anyOfClass(SimpleTestEntity),
anything() anything()
) )
@@ -949,7 +999,7 @@ describe(EntityMutatorFactory, () => {
); );
const entityCreateResult = await entityMutatorFactory const entityCreateResult = await entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.createAsync(); .createAsync();
expect(entityCreateResult.ok).toBe(false); expect(entityCreateResult.ok).toBe(false);
expect(entityCreateResult.reason).toEqual(rejectionError); expect(entityCreateResult.reason).toEqual(rejectionError);
@@ -961,14 +1011,14 @@ describe(EntityMutatorFactory, () => {
}); });
const entityUpdateResult = await entityMutatorFactory const entityUpdateResult = await entityMutatorFactory
.forUpdate(fakeEntity, queryContext) .forUpdate(fakeEntity, queryContext, privacyPolicyEvaluationContext)
.updateAsync(); .updateAsync();
expect(entityUpdateResult.ok).toBe(false); expect(entityUpdateResult.ok).toBe(false);
expect(entityUpdateResult.reason).toEqual(rejectionError); expect(entityUpdateResult.reason).toEqual(rejectionError);
expect(entityUpdateResult.value).toBe(undefined); expect(entityUpdateResult.value).toBe(undefined);
const entityDeleteResult = await entityMutatorFactory const entityDeleteResult = await entityMutatorFactory
.forDelete(fakeEntity, queryContext) .forDelete(fakeEntity, queryContext, privacyPolicyEvaluationContext)
.deleteAsync(); .deleteAsync();
expect(entityDeleteResult.ok).toBe(false); expect(entityDeleteResult.ok).toBe(false);
expect(entityDeleteResult.reason).toEqual(rejectionError); expect(entityDeleteResult.reason).toEqual(rejectionError);
@@ -977,6 +1027,7 @@ describe(EntityMutatorFactory, () => {
it('throws error when db adapter throws', async () => { it('throws error when db adapter throws', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const privacyPolicy = instance(mock(SimpleTestEntityPrivacyPolicy)); const privacyPolicy = instance(mock(SimpleTestEntityPrivacyPolicy));
const databaseAdapterMock = mock<EntityDatabaseAdapter<SimpleTestFields>>(); const databaseAdapterMock = mock<EntityDatabaseAdapter<SimpleTestFields>>();
@@ -1032,37 +1083,48 @@ describe(EntityMutatorFactory, () => {
}); });
await expect( await expect(
entityMutatorFactory.forCreate(viewerContext, queryContext).createAsync() entityMutatorFactory
.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.createAsync()
).rejects.toEqual(rejectionError); ).rejects.toEqual(rejectionError);
await expect( await expect(
entityMutatorFactory.forUpdate(fakeEntity, queryContext).updateAsync() entityMutatorFactory
.forUpdate(fakeEntity, queryContext, privacyPolicyEvaluationContext)
.updateAsync()
).rejects.toEqual(rejectionError); ).rejects.toEqual(rejectionError);
await expect( await expect(
entityMutatorFactory.forDelete(fakeEntity, queryContext).deleteAsync() entityMutatorFactory
.forDelete(fakeEntity, queryContext, privacyPolicyEvaluationContext)
.deleteAsync()
).rejects.toEqual(rejectionError); ).rejects.toEqual(rejectionError);
}); });
it('records metrics appropriately', async () => { it('records metrics appropriately', async () => {
const viewerContext = mock<ViewerContext>(); const viewerContext = mock<ViewerContext>();
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = StubQueryContextProvider.getQueryContext(); const queryContext = StubQueryContextProvider.getQueryContext();
const { entityMutatorFactory, metricsAdapter } = createEntityMutatorFactory([]); const { entityMutatorFactory, metricsAdapter } = createEntityMutatorFactory([]);
const spiedMetricsAdapter = spy(metricsAdapter); const spiedMetricsAdapter = spy(metricsAdapter);
const newEntity = await enforceAsyncResult( const newEntity = await enforceAsyncResult(
entityMutatorFactory entityMutatorFactory
.forCreate(viewerContext, queryContext) .forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'huh') .setField('stringField', 'huh')
.createAsync() .createAsync()
); );
await enforceAsyncResult( await enforceAsyncResult(
entityMutatorFactory entityMutatorFactory
.forUpdate(newEntity, queryContext) .forUpdate(newEntity, queryContext, privacyPolicyEvaluationContext)
.setField('stringField', 'wat') .setField('stringField', 'wat')
.updateAsync() .updateAsync()
); );
await enforceAsyncResult(entityMutatorFactory.forDelete(newEntity, queryContext).deleteAsync()); await enforceAsyncResult(
entityMutatorFactory
.forDelete(newEntity, queryContext, privacyPolicyEvaluationContext)
.deleteAsync()
);
verify( verify(
spiedMetricsAdapter.logMutatorMutationEvent( spiedMetricsAdapter.logMutatorMutationEvent(
@@ -8,6 +8,7 @@ import EntityPrivacyPolicy, {
EntityPrivacyPolicyEvaluator, EntityPrivacyPolicyEvaluator,
EntityAuthorizationAction, EntityAuthorizationAction,
EntityPrivacyPolicyEvaluationMode, EntityPrivacyPolicyEvaluationMode,
EntityPrivacyPolicyEvaluationContext,
} from '../EntityPrivacyPolicy'; } from '../EntityPrivacyPolicy';
import { EntityQueryContext } from '../EntityQueryContext'; import { EntityQueryContext } from '../EntityQueryContext';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
@@ -166,6 +167,7 @@ class AlwaysThrowPrivacyPolicyRule extends PrivacyPolicyRule<
evaluateAsync( evaluateAsync(
_viewerContext: ViewerContext, _viewerContext: ViewerContext,
_queryContext: EntityQueryContext, _queryContext: EntityQueryContext,
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
_entity: BlahEntity _entity: BlahEntity
): Promise<RuleEvaluationResult> { ): Promise<RuleEvaluationResult> {
throw new Error('WooHoo!'); throw new Error('WooHoo!');
@@ -245,12 +247,19 @@ describe(EntityPrivacyPolicy, () => {
it('throws EntityNotAuthorizedError when deny', async () => { it('throws EntityNotAuthorizedError when deny', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
const policy = new AlwaysDenyPolicy(); const policy = new AlwaysDenyPolicy();
await expect( await expect(
policy.authorizeCreateAsync(viewerContext, queryContext, entity, metricsAdapter) policy.authorizeCreateAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
entity,
metricsAdapter
)
).rejects.toBeInstanceOf(EntityNotAuthorizedError); ).rejects.toBeInstanceOf(EntityNotAuthorizedError);
verify( verify(
metricsAdapterMock.logAuthorizationEvent( metricsAdapterMock.logAuthorizationEvent(
@@ -267,6 +276,7 @@ describe(EntityPrivacyPolicy, () => {
it('returns entity when allowed', async () => { it('returns entity when allowed', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
@@ -274,6 +284,7 @@ describe(EntityPrivacyPolicy, () => {
const approvedEntity = await policy.authorizeCreateAsync( const approvedEntity = await policy.authorizeCreateAsync(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
entity, entity,
metricsAdapter metricsAdapter
); );
@@ -293,12 +304,19 @@ describe(EntityPrivacyPolicy, () => {
it('throws EntityNotAuthorizedError when all skipped', async () => { it('throws EntityNotAuthorizedError when all skipped', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
const policy = new SkipAllPolicy(); const policy = new SkipAllPolicy();
await expect( await expect(
policy.authorizeCreateAsync(viewerContext, queryContext, entity, metricsAdapter) policy.authorizeCreateAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
entity,
metricsAdapter
)
).rejects.toBeInstanceOf(EntityNotAuthorizedError); ).rejects.toBeInstanceOf(EntityNotAuthorizedError);
verify( verify(
metricsAdapterMock.logAuthorizationEvent( metricsAdapterMock.logAuthorizationEvent(
@@ -315,12 +333,19 @@ describe(EntityPrivacyPolicy, () => {
it('throws EntityNotAuthorizedError when empty policy', async () => { it('throws EntityNotAuthorizedError when empty policy', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
const policy = new EmptyPolicy(); const policy = new EmptyPolicy();
await expect( await expect(
policy.authorizeCreateAsync(viewerContext, queryContext, entity, metricsAdapter) policy.authorizeCreateAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
entity,
metricsAdapter
)
).rejects.toBeInstanceOf(EntityNotAuthorizedError); ).rejects.toBeInstanceOf(EntityNotAuthorizedError);
verify( verify(
metricsAdapterMock.logAuthorizationEvent( metricsAdapterMock.logAuthorizationEvent(
@@ -337,12 +362,19 @@ describe(EntityPrivacyPolicy, () => {
it('throws when rule throws', async () => { it('throws when rule throws', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
const policy = new ThrowAllPolicy(); const policy = new ThrowAllPolicy();
await expect( await expect(
policy.authorizeCreateAsync(viewerContext, queryContext, entity, metricsAdapter) policy.authorizeCreateAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
entity,
metricsAdapter
)
).rejects.toThrowError('WooHoo!'); ).rejects.toThrowError('WooHoo!');
verify(metricsAdapterMock.logAuthorizationEvent(anything())).never(); verify(metricsAdapterMock.logAuthorizationEvent(anything())).never();
}); });
@@ -352,6 +384,7 @@ describe(EntityPrivacyPolicy, () => {
it('returns entity when denied but calls denialHandler', async () => { it('returns entity when denied but calls denialHandler', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
@@ -362,6 +395,7 @@ describe(EntityPrivacyPolicy, () => {
const approvedEntity = await policy.authorizeCreateAsync( const approvedEntity = await policy.authorizeCreateAsync(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
entity, entity,
metricsAdapter metricsAdapter
); );
@@ -384,6 +418,7 @@ describe(EntityPrivacyPolicy, () => {
it('does not log when not denied', async () => { it('does not log when not denied', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
@@ -394,6 +429,7 @@ describe(EntityPrivacyPolicy, () => {
const approvedEntity = await policy.authorizeCreateAsync( const approvedEntity = await policy.authorizeCreateAsync(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
entity, entity,
metricsAdapter metricsAdapter
); );
@@ -416,6 +452,7 @@ describe(EntityPrivacyPolicy, () => {
it('passes through other errors', async () => { it('passes through other errors', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
@@ -424,7 +461,13 @@ describe(EntityPrivacyPolicy, () => {
const policySpy = spy(policy); const policySpy = spy(policy);
await expect( await expect(
policy.authorizeCreateAsync(viewerContext, queryContext, entity, metricsAdapter) policy.authorizeCreateAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
entity,
metricsAdapter
)
).rejects.toThrowError('WooHoo!'); ).rejects.toThrowError('WooHoo!');
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).never(); verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).never();
@@ -437,6 +480,7 @@ describe(EntityPrivacyPolicy, () => {
it('denies when denied but calls denialHandler', async () => { it('denies when denied but calls denialHandler', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
@@ -445,7 +489,13 @@ describe(EntityPrivacyPolicy, () => {
const policySpy = spy(policy); const policySpy = spy(policy);
await expect( await expect(
policy.authorizeCreateAsync(viewerContext, queryContext, entity, metricsAdapter) policy.authorizeCreateAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
entity,
metricsAdapter
)
).rejects.toBeInstanceOf(EntityNotAuthorizedError); ).rejects.toBeInstanceOf(EntityNotAuthorizedError);
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).once(); verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).once();
@@ -465,6 +515,7 @@ describe(EntityPrivacyPolicy, () => {
it('does not log when not denied', async () => { it('does not log when not denied', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
@@ -475,6 +526,7 @@ describe(EntityPrivacyPolicy, () => {
const approvedEntity = await policy.authorizeCreateAsync( const approvedEntity = await policy.authorizeCreateAsync(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
entity, entity,
metricsAdapter metricsAdapter
); );
@@ -497,6 +549,7 @@ describe(EntityPrivacyPolicy, () => {
it('passes through other errors', async () => { it('passes through other errors', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapterMock = mock<IEntityMetricsAdapter>(); const metricsAdapterMock = mock<IEntityMetricsAdapter>();
const metricsAdapter = instance(metricsAdapterMock); const metricsAdapter = instance(metricsAdapterMock);
const entity = new BlahEntity(viewerContext, { id: '1' }); const entity = new BlahEntity(viewerContext, { id: '1' });
@@ -505,7 +558,13 @@ describe(EntityPrivacyPolicy, () => {
const policySpy = spy(policy); const policySpy = spy(policy);
await expect( await expect(
policy.authorizeCreateAsync(viewerContext, queryContext, entity, metricsAdapter) policy.authorizeCreateAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
entity,
metricsAdapter
)
).rejects.toThrowError('WooHoo!'); ).rejects.toThrowError('WooHoo!');
verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).never(); verify(policySpy.denyHandler(anyOfClass(EntityNotAuthorizedError))).never();
@@ -79,6 +79,7 @@ describe(EntitySecondaryCacheLoader, () => {
vc1, vc1,
anyOfClass(EntityNonTransactionalQueryContext), anyOfClass(EntityNonTransactionalQueryContext),
anything(), anything(),
anything(),
anything() anything()
) )
).once(); ).once();
@@ -98,25 +98,25 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
.enforceCreateAsync(); .enforceCreateAsync();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await CategoryEntity.enforceDeleteAsync(parentCategory); await CategoryEntity.enforceDeleteAsync(parentCategory);
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
}); });
@@ -137,10 +137,10 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
await CategoryEntity.enforceDeleteAsync(categoryA); await CategoryEntity.enforceDeleteAsync(categoryA);
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(categoryA.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(categoryA.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(categoryB.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(categoryB.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
}); });
}); });
@@ -161,29 +161,29 @@ describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
.enforceCreateAsync(); .enforceCreateAsync();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await CategoryEntity.enforceDeleteAsync(parentCategory); await CategoryEntity.enforceDeleteAsync(parentCategory);
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
const loadedSubCategory = await CategoryEntity.loader(viewerContext) const loadedSubCategory = await CategoryEntity.loader(viewerContext).loadByIDAsync(
.enforcing() subCategory.getID()
.loadByIDAsync(subCategory.getID()); );
expect(loadedSubCategory.getField('parent_category_id')).toBeNull(); expect(loadedSubCategory.getField('parent_category_id')).toBeNull();
const loadedSubSubCategory = await CategoryEntity.loader(viewerContext) const loadedSubSubCategory = await CategoryEntity.loader(viewerContext).loadByIDAsync(
.enforcing() subSubCategory.getID()
.loadByIDAsync(subSubCategory.getID()); );
expect(loadedSubSubCategory.getField('parent_category_id')).not.toBeNull(); expect(loadedSubSubCategory.getField('parent_category_id')).not.toBeNull();
}); });
@@ -203,9 +203,9 @@ describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
await CategoryEntity.enforceDeleteAsync(categoryA); await CategoryEntity.enforceDeleteAsync(categoryA);
const loadedCategoryB = await CategoryEntity.loader(viewerContext) const loadedCategoryB = await CategoryEntity.loader(viewerContext).loadByIDAsync(
.enforcing() categoryB.getID()
.loadByIDAsync(categoryB.getID()); );
expect(loadedCategoryB.getField('parent_category_id')).toBeNull(); expect(loadedCategoryB.getField('parent_category_id')).toBeNull();
}); });
}); });
@@ -228,17 +228,19 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
.enforceCreateAsync(); .enforceCreateAsync();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext) CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
.enforcing() 'parent_category_id',
.loadByFieldEqualingAsync('parent_category_id', parentCategory.getID()) parentCategory.getID()
)
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext) CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
.enforcing() 'parent_category_id',
.loadByFieldEqualingAsync('parent_category_id', subCategory.getID()) subCategory.getID()
)
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass( const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
@@ -271,13 +273,13 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
expect(subSubCategoryCachedAfter.get(subCategory.getID())?.status).toEqual(CacheStatus.MISS); expect(subSubCategoryCachedAfter.get(subCategory.getID())?.status).toEqual(CacheStatus.MISS);
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parentCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(parentCategory.getID())
).resolves.toBeNull(); ).resolves.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(subSubCategory.getID()) CategoryEntity.loader(viewerContext).loadByIDNullableAsync(subSubCategory.getID())
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
}); });
@@ -298,14 +300,16 @@ describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
.enforceUpdateAsync(); .enforceUpdateAsync();
await expect( await expect(
CategoryEntity.loader(viewerContext) CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
.enforcing() 'parent_category_id',
.loadByFieldEqualingAsync('parent_category_id', categoryA.getID()) categoryA.getID()
)
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
await expect( await expect(
CategoryEntity.loader(viewerContext) CategoryEntity.loader(viewerContext).loadByFieldEqualingAsync(
.enforcing() 'parent_category_id',
.loadByFieldEqualingAsync('parent_category_id', categoryB.getID()) categoryB.getID()
)
).resolves.not.toBeNull(); ).resolves.not.toBeNull();
const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass( const categoryCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
@@ -1,6 +1,7 @@
import { mock, verify, instance } from 'ts-mockito'; import { mock, verify, instance } from 'ts-mockito';
import EntityLoaderFactory from '../EntityLoaderFactory'; import EntityLoaderFactory from '../EntityLoaderFactory';
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import { EntityQueryContext } from '../EntityQueryContext'; import { EntityQueryContext } from '../EntityQueryContext';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
import ViewerScopedEntityLoaderFactory from '../ViewerScopedEntityLoaderFactory'; import ViewerScopedEntityLoaderFactory from '../ViewerScopedEntityLoaderFactory';
@@ -8,6 +9,7 @@ import ViewerScopedEntityLoaderFactory from '../ViewerScopedEntityLoaderFactory'
describe(ViewerScopedEntityLoaderFactory, () => { describe(ViewerScopedEntityLoaderFactory, () => {
it('correctly scopes viewer to entity loads', async () => { it('correctly scopes viewer to entity loads', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const baseLoader = mock<EntityLoaderFactory<any, any, any, any, any, any>>(EntityLoaderFactory); const baseLoader = mock<EntityLoaderFactory<any, any, any, any, any, any>>(EntityLoaderFactory);
const baseLoaderInstance = instance(baseLoader); const baseLoaderInstance = instance(baseLoader);
@@ -21,8 +23,8 @@ describe(ViewerScopedEntityLoaderFactory, () => {
any any
>(baseLoaderInstance, viewerContext); >(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 { mock, instance, verify } from 'ts-mockito';
import EntityMutatorFactory from '../EntityMutatorFactory'; import EntityMutatorFactory from '../EntityMutatorFactory';
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import { EntityQueryContext } from '../EntityQueryContext'; import { EntityQueryContext } from '../EntityQueryContext';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
import ViewerScopedEntityMutatorFactory from '../ViewerScopedEntityMutatorFactory'; import ViewerScopedEntityMutatorFactory from '../ViewerScopedEntityMutatorFactory';
@@ -9,6 +10,7 @@ import TestEntity, { TestFields, TestEntityPrivacyPolicy } from '../testfixtures
describe(ViewerScopedEntityMutatorFactory, () => { describe(ViewerScopedEntityMutatorFactory, () => {
it('correctly scopes viewer to entity mutations', async () => { it('correctly scopes viewer to entity mutations', async () => {
const viewerContext = instance(mock(ViewerContext)); const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const queryContext = instance(mock(EntityQueryContext)); const queryContext = instance(mock(EntityQueryContext));
const baseMutatorFactory = const baseMutatorFactory =
mock< mock<
@@ -25,8 +27,10 @@ describe(ViewerScopedEntityMutatorFactory, () => {
keyof TestFields keyof TestFields
>(baseMutatorFactoryInstance, viewerContext); >(baseMutatorFactoryInstance, viewerContext);
viewerScopedEntityLoader.forCreate(queryContext); viewerScopedEntityLoader.forCreate(queryContext, privacyPolicyEvaluationContext);
verify(baseMutatorFactory.forCreate(viewerContext, queryContext)).once(); verify(
baseMutatorFactory.forCreate(viewerContext, queryContext, privacyPolicyEvaluationContext)
).once();
}); });
}); });
@@ -28,17 +28,16 @@ describe('Two entities backed by the same table', () => {
expect(two).toBeInstanceOf(TwoTestEntity); expect(two).toBeInstanceOf(TwoTestEntity);
await expect( await expect(
TwoTestEntity.loader(viewerContext).enforcing().loadByIDAsync(one.getID()) TwoTestEntity.loader(viewerContext).loadByIDAsync(one.getID())
).rejects.toThrowError('TwoTestEntity must be instantiated with two data'); ).rejects.toThrowError('TwoTestEntity must be instantiated with two data');
await expect( await expect(
OneTestEntity.loader(viewerContext).enforcing().loadByIDAsync(two.getID()) OneTestEntity.loader(viewerContext).loadByIDAsync(two.getID())
).rejects.toThrowError('OneTestEntity must be instantiated with one data'); ).rejects.toThrowError('OneTestEntity must be instantiated with one data');
const manyResults = await OneTestEntity.loader(viewerContext).loadManyByFieldEqualingAsync( const manyResults = await OneTestEntity.loader(
'common_other_field', viewerContext
'wat' ).resultLoader.loadManyByFieldEqualingAsync('common_other_field', 'wat');
);
const successfulManyResults = successfulResults(manyResults); const successfulManyResults = successfulResults(manyResults);
const failedManyResults = failedResults(manyResults); const failedManyResults = failedResults(manyResults);
@@ -52,7 +51,7 @@ describe('Two entities backed by the same table', () => {
const fieldEqualityConjunctionResults = await OneTestEntity.loader( const fieldEqualityConjunctionResults = await OneTestEntity.loader(
viewerContext viewerContext
).loadManyByFieldEqualityConjunctionAsync([ ).resultLoader.loadManyByFieldEqualityConjunctionAsync([
{ {
fieldName: 'common_other_field', fieldName: 'common_other_field',
fieldValue: 'wat', fieldValue: 'wat',
@@ -18,7 +18,7 @@ describe('Two entities backed by the same table', () => {
expect(entity1).toBeInstanceOf(OneTestEntity); expect(entity1).toBeInstanceOf(OneTestEntity);
const entity2 = await TwoTestEntity.loader(viewerContext) const entity2 = await TwoTestEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity1.getID()); .loadByIDAsync(entity1.getID());
expect(entity2).toBeInstanceOf(TwoTestEntity); expect(entity2).toBeInstanceOf(TwoTestEntity);
@@ -33,7 +33,7 @@ describe('Two entities backed by the same table', () => {
}); });
const loaded1 = await OneTestEntity.loader(viewerContext) const loaded1 = await OneTestEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity1.getID()); .loadByIDAsync(entity1.getID());
expect(loaded1.getAllFields()).toMatchObject({ expect(loaded1.getAllFields()).toMatchObject({
id: updated2.getID(), id: updated2.getID(),
@@ -51,7 +51,7 @@ describe('Two entities backed by the same table', () => {
.enforceCreateAsync(); .enforceCreateAsync();
const loadedEntity = await TwoTestEntity.loader(viewerContext) const loadedEntity = await TwoTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('other_field', 'huh'); .loadByFieldEqualingAsync('other_field', 'huh');
expect(loadedEntity?.getAllFields()).toMatchObject({ expect(loadedEntity?.getAllFields()).toMatchObject({
id: entity.getID(), id: entity.getID(),
@@ -60,12 +60,12 @@ describe('Two entities backed by the same table', () => {
}); });
const loaded1 = await OneTestEntity.loader(viewerContext) const loaded1 = await OneTestEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity.getID()); .loadByIDAsync(entity.getID());
await OneTestEntity.updater(loaded1).setField('fake_field', 'world').enforceUpdateAsync(); await OneTestEntity.updater(loaded1).setField('fake_field', 'world').enforceUpdateAsync();
const loaded2 = await TwoTestEntity.loader(viewerContext) const loaded2 = await TwoTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('other_field', 'huh'); .loadByFieldEqualingAsync('other_field', 'huh');
expect(loaded2?.getAllFields()).toMatchObject({ expect(loaded2?.getAllFields()).toMatchObject({
id: entity.getID(), id: entity.getID(),
@@ -74,7 +74,7 @@ describe('Two entities backed by the same table', () => {
}); });
const loaded22 = await TwoTestEntity.loader(viewerContext) const loaded22 = await TwoTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('fake_field', 'world'); .loadByFieldEqualingAsync('fake_field', 'world');
expect(loaded22?.getAllFields()).toMatchObject({ expect(loaded22?.getAllFields()).toMatchObject({
id: entity.getID(), id: entity.getID(),
+3 -1
View File
@@ -4,8 +4,10 @@
* @module @expo/entity * @module @expo/entity
*/ */
export { default as ComposedEntityCacheAdapter } from './ComposedEntityCacheAdapter';
export { default as ComposedSecondaryEntityCache } from './ComposedSecondaryEntityCache';
export { default as GenericSecondaryEntityCache } from './GenericSecondaryEntityCache'; export { default as GenericSecondaryEntityCache } from './GenericSecondaryEntityCache';
export { default as EnforcingEntityLoader } from './EnforcingEntityLoader'; export { default as EntityResultLoader } from './EntityResultLoader';
export { default as Entity } from './Entity'; export { default as Entity } from './Entity';
export * from './Entity'; export * from './Entity';
export { default as EntityAssociationLoader } from './EntityAssociationLoader'; export { default as EntityAssociationLoader } from './EntityAssociationLoader';
@@ -1,3 +1,4 @@
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import { EntityQueryContext } from '../EntityQueryContext'; import { EntityQueryContext } from '../EntityQueryContext';
import ReadonlyEntity from '../ReadonlyEntity'; import ReadonlyEntity from '../ReadonlyEntity';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
@@ -16,6 +17,7 @@ export default class AlwaysAllowPrivacyPolicyRule<
async evaluateAsync( async evaluateAsync(
_viewerContext: TViewerContext, _viewerContext: TViewerContext,
_queryContext: EntityQueryContext, _queryContext: EntityQueryContext,
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
_entity: TEntity _entity: TEntity
): Promise<RuleEvaluationResult> { ): Promise<RuleEvaluationResult> {
return RuleEvaluationResult.ALLOW; return RuleEvaluationResult.ALLOW;
@@ -1,3 +1,4 @@
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import { EntityQueryContext } from '../EntityQueryContext'; import { EntityQueryContext } from '../EntityQueryContext';
import ReadonlyEntity from '../ReadonlyEntity'; import ReadonlyEntity from '../ReadonlyEntity';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
@@ -16,6 +17,7 @@ export default class AlwaysDenyPrivacyPolicyRule<
async evaluateAsync( async evaluateAsync(
_viewerContext: TViewerContext, _viewerContext: TViewerContext,
_queryContext: EntityQueryContext, _queryContext: EntityQueryContext,
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
_entity: TEntity _entity: TEntity
): Promise<RuleEvaluationResult> { ): Promise<RuleEvaluationResult> {
return RuleEvaluationResult.DENY; return RuleEvaluationResult.DENY;
@@ -1,3 +1,4 @@
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import { EntityQueryContext } from '../EntityQueryContext'; import { EntityQueryContext } from '../EntityQueryContext';
import ReadonlyEntity from '../ReadonlyEntity'; import ReadonlyEntity from '../ReadonlyEntity';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
@@ -16,6 +17,7 @@ export default class AlwaysSkipPrivacyPolicyRule<
async evaluateAsync( async evaluateAsync(
_viewerContext: TViewerContext, _viewerContext: TViewerContext,
_queryContext: EntityQueryContext, _queryContext: EntityQueryContext,
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
_entity: TEntity _entity: TEntity
): Promise<RuleEvaluationResult> { ): Promise<RuleEvaluationResult> {
return RuleEvaluationResult.SKIP; return RuleEvaluationResult.SKIP;
@@ -1,3 +1,4 @@
import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
import { EntityQueryContext } from '../EntityQueryContext'; import { EntityQueryContext } from '../EntityQueryContext';
import ReadonlyEntity from '../ReadonlyEntity'; import ReadonlyEntity from '../ReadonlyEntity';
import ViewerContext from '../ViewerContext'; import ViewerContext from '../ViewerContext';
@@ -45,6 +46,7 @@ export default abstract class PrivacyPolicyRule<
abstract evaluateAsync( abstract evaluateAsync(
viewerContext: TViewerContext, viewerContext: TViewerContext,
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity entity: TEntity
): Promise<RuleEvaluationResult>; ): Promise<RuleEvaluationResult>;
} }
@@ -1,5 +1,6 @@
import { mock, instance, anything } from 'ts-mockito'; import { mock, instance, anything } from 'ts-mockito';
import { EntityPrivacyPolicyEvaluationContext } from '../../EntityPrivacyPolicy';
import { EntityQueryContext } from '../../EntityQueryContext'; import { EntityQueryContext } from '../../EntityQueryContext';
import ViewerContext from '../../ViewerContext'; import ViewerContext from '../../ViewerContext';
import { describePrivacyPolicyRule } from '../../utils/testing/PrivacyPolicyRuleTestUtils'; import { describePrivacyPolicyRule } from '../../utils/testing/PrivacyPolicyRuleTestUtils';
@@ -10,6 +11,7 @@ describePrivacyPolicyRule(new AlwaysAllowPrivacyPolicyRule(), {
{ {
viewerContext: instance(mock(ViewerContext)), viewerContext: instance(mock(ViewerContext)),
queryContext: instance(mock(EntityQueryContext)), queryContext: instance(mock(EntityQueryContext)),
evaluationContext: instance(mock<EntityPrivacyPolicyEvaluationContext>()),
entity: anything(), entity: anything(),
}, },
], ],
@@ -1,5 +1,6 @@
import { mock, instance, anything } from 'ts-mockito'; import { mock, instance, anything } from 'ts-mockito';
import { EntityPrivacyPolicyEvaluationContext } from '../../EntityPrivacyPolicy';
import { EntityQueryContext } from '../../EntityQueryContext'; import { EntityQueryContext } from '../../EntityQueryContext';
import ViewerContext from '../../ViewerContext'; import ViewerContext from '../../ViewerContext';
import { describePrivacyPolicyRule } from '../../utils/testing/PrivacyPolicyRuleTestUtils'; import { describePrivacyPolicyRule } from '../../utils/testing/PrivacyPolicyRuleTestUtils';
@@ -10,6 +11,7 @@ describePrivacyPolicyRule(new AlwaysDenyPrivacyPolicyRule(), {
{ {
viewerContext: instance(mock(ViewerContext)), viewerContext: instance(mock(ViewerContext)),
queryContext: instance(mock(EntityQueryContext)), queryContext: instance(mock(EntityQueryContext)),
evaluationContext: instance(mock<EntityPrivacyPolicyEvaluationContext>()),
entity: anything(), entity: anything(),
}, },
], ],
@@ -1,5 +1,6 @@
import { mock, instance, anything } from 'ts-mockito'; import { mock, instance, anything } from 'ts-mockito';
import { EntityPrivacyPolicyEvaluationContext } from '../../EntityPrivacyPolicy';
import { EntityQueryContext } from '../../EntityQueryContext'; import { EntityQueryContext } from '../../EntityQueryContext';
import ViewerContext from '../../ViewerContext'; import ViewerContext from '../../ViewerContext';
import { describePrivacyPolicyRule } from '../../utils/testing/PrivacyPolicyRuleTestUtils'; import { describePrivacyPolicyRule } from '../../utils/testing/PrivacyPolicyRuleTestUtils';
@@ -10,6 +11,7 @@ describePrivacyPolicyRule(new AlwaysSkipPrivacyPolicyRule(), {
{ {
viewerContext: instance(mock(ViewerContext)), viewerContext: instance(mock(ViewerContext)),
queryContext: instance(mock(EntityQueryContext)), queryContext: instance(mock(EntityQueryContext)),
evaluationContext: instance(mock<EntityPrivacyPolicyEvaluationContext>()),
entity: anything(), entity: anything(),
}, },
], ],
@@ -1,3 +1,4 @@
import { EntityPrivacyPolicyEvaluationContext } from '../../EntityPrivacyPolicy';
import { EntityQueryContext } from '../../EntityQueryContext'; import { EntityQueryContext } from '../../EntityQueryContext';
import ReadonlyEntity from '../../ReadonlyEntity'; import ReadonlyEntity from '../../ReadonlyEntity';
import ViewerContext from '../../ViewerContext'; import ViewerContext from '../../ViewerContext';
@@ -12,6 +13,7 @@ export interface Case<
> { > {
viewerContext: TViewerContext; viewerContext: TViewerContext;
queryContext: EntityQueryContext; queryContext: EntityQueryContext;
evaluationContext: EntityPrivacyPolicyEvaluationContext;
entity: TEntity; entity: TEntity;
} }
@@ -48,9 +50,11 @@ export const describePrivacyPolicyRuleWithAsyncTestCase = <
if (allowCases && allowCases.size > 0) { if (allowCases && allowCases.size > 0) {
describe('allow cases', () => { describe('allow cases', () => {
test.each(Array.from(allowCases.keys()))('%p', async (caseKey) => { test.each(Array.from(allowCases.keys()))('%p', async (caseKey) => {
const { viewerContext, queryContext, entity } = await allowCases.get(caseKey)!(); const { viewerContext, queryContext, evaluationContext, entity } = await allowCases.get(
caseKey
)!();
await expect( await expect(
privacyPolicyRule.evaluateAsync(viewerContext, queryContext, entity) privacyPolicyRule.evaluateAsync(viewerContext, queryContext, evaluationContext, entity)
).resolves.toEqual(RuleEvaluationResult.ALLOW); ).resolves.toEqual(RuleEvaluationResult.ALLOW);
}); });
}); });
@@ -59,9 +63,11 @@ export const describePrivacyPolicyRuleWithAsyncTestCase = <
if (skipCases && skipCases.size > 0) { if (skipCases && skipCases.size > 0) {
describe('skip cases', () => { describe('skip cases', () => {
test.each(Array.from(skipCases.keys()))('%p', async (caseKey) => { test.each(Array.from(skipCases.keys()))('%p', async (caseKey) => {
const { viewerContext, queryContext, entity } = await skipCases.get(caseKey)!(); const { viewerContext, queryContext, evaluationContext, entity } = await skipCases.get(
caseKey
)!();
await expect( await expect(
privacyPolicyRule.evaluateAsync(viewerContext, queryContext, entity) privacyPolicyRule.evaluateAsync(viewerContext, queryContext, evaluationContext, entity)
).resolves.toEqual(RuleEvaluationResult.SKIP); ).resolves.toEqual(RuleEvaluationResult.SKIP);
}); });
}); });
@@ -70,9 +76,11 @@ export const describePrivacyPolicyRuleWithAsyncTestCase = <
if (denyCases && denyCases.size > 0) { if (denyCases && denyCases.size > 0) {
describe('deny cases', () => { describe('deny cases', () => {
test.each(Array.from(denyCases.keys()))('%p', async (caseKey) => { test.each(Array.from(denyCases.keys()))('%p', async (caseKey) => {
const { viewerContext, queryContext, entity } = await denyCases.get(caseKey)!(); const { viewerContext, queryContext, evaluationContext, entity } = await denyCases.get(
caseKey
)!();
await expect( await expect(
privacyPolicyRule.evaluateAsync(viewerContext, queryContext, entity) privacyPolicyRule.evaluateAsync(viewerContext, queryContext, evaluationContext, entity)
).resolves.toEqual(RuleEvaluationResult.DENY); ).resolves.toEqual(RuleEvaluationResult.DENY);
}); });
}); });
+10 -12
View File
@@ -508,32 +508,35 @@
minimist "^1.2.0" minimist "^1.2.0"
"@expo/entity-cache-adapter-local-memory@file:packages/entity-cache-adapter-local-memory": "@expo/entity-cache-adapter-local-memory@file:packages/entity-cache-adapter-local-memory":
version "0.23.0" version "0.25.2"
dependencies: dependencies:
lru-cache "^7.3.1" lru-cache "^6.0.0"
"@expo/entity-cache-adapter-redis@file:packages/entity-cache-adapter-redis": "@expo/entity-cache-adapter-redis@file:packages/entity-cache-adapter-redis":
version "0.23.0" version "0.25.2"
dependencies: dependencies:
ioredis "^4.27.3" ioredis "^4.27.3"
"@expo/entity-database-adapter-knex@file:packages/entity-database-adapter-knex": "@expo/entity-database-adapter-knex@file:packages/entity-database-adapter-knex":
version "0.23.0" version "0.25.2"
dependencies: dependencies:
knex "^1.0.2" knex "^1.0.2"
"@expo/entity-ip-address-field@file:packages/entity-ip-address-field": "@expo/entity-ip-address-field@file:packages/entity-ip-address-field":
version "0.23.0" version "0.25.2"
dependencies: dependencies:
ip-address "^8.1.0" ip-address "^8.1.0"
"@expo/entity-secondary-cache-local-memory@file:packages/entity-secondary-cache-local-memory":
version "0.25.2"
"@expo/entity-secondary-cache-redis@file:packages/entity-secondary-cache-redis": "@expo/entity-secondary-cache-redis@file:packages/entity-secondary-cache-redis":
version "0.23.0" version "0.25.2"
dependencies: dependencies:
ioredis "^4.17.3" ioredis "^4.17.3"
"@expo/entity@file:packages/entity": "@expo/entity@file:packages/entity":
version "0.23.0" version "0.25.2"
dependencies: dependencies:
"@expo/results" "^1.0.0" "@expo/results" "^1.0.0"
dataloader "^2.0.0" dataloader "^2.0.0"
@@ -6575,11 +6578,6 @@ lru-cache@^6.0.0:
dependencies: dependencies:
yallist "^4.0.0" yallist "^4.0.0"
lru-cache@^7.3.1:
version "7.3.1"
resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-7.3.1.tgz#7702e80694ec2bf19865567a469f2b081fcf53f5"
integrity sha512-nX1x4qUrKqwbIAhv4s9et4FIUVzNOpeY07bsjGUy8gwJrXH/wScImSQqXErmo/b2jZY2r0mohbLA9zVj7u1cNw==
lunr@^2.3.9: lunr@^2.3.9:
version "2.3.9" version "2.3.9"
resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1" resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1"