Compare commits

..
Author SHA1 Message Date
Quinlan Jung b61341057b [cache-adapter-local-memory] export classes 2022-03-09 17:53:23 -08:00
127 changed files with 4775 additions and 7827 deletions

No files matched your search

+3 -3
View File
@@ -3,16 +3,16 @@ name: docs
on: on:
push: push:
branches: branches:
- main - master
jobs: jobs:
deploy: deploy:
runs-on: ubuntu-latest runs-on: ubuntu-18.04
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- uses: actions/setup-node@v1 - uses: actions/setup-node@v1
with: with:
node-version: 18.x node-version: 12.x
- name: Cache Node.js modules - name: Cache Node.js modules
uses: actions/cache@v1 uses: actions/cache@v1
with: with:
+2 -2
View File
@@ -2,7 +2,7 @@ name: tests
on: on:
push: push:
branches: [ main ] branches: [ master ]
pull_request: pull_request:
jobs: jobs:
@@ -14,7 +14,7 @@ jobs:
ref: ${{ github.event.pull_request.head.sha }} ref: ${{ github.event.pull_request.head.sha }}
- uses: actions/setup-node@v1 - uses: actions/setup-node@v1
with: with:
node-version: 18.x node-version: 12.x
- name: Cache Node.js modules - name: Cache Node.js modules
uses: actions/cache@v1 uses: actions/cache@v1
with: with:
+1 -131
View File
@@ -3,136 +3,6 @@
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.31.1](https://github.com/expo/entity/compare/v0.31.0...v0.31.1) (2023-03-06)
### Features
* add loadFirstByFieldEqualityConjunction, a convenience method ([#206](https://github.com/expo/entity/pull/206)) ([1934216](https://github.com/expo/entity/commit/1934216b70572cf2b9693e0f14939f49b90427dd))
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package root
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package root
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
### Features
* add example of redis mget batching using @expo/batcher ([#199](https://github.com/expo/entity/issues/199)) ([684f91b](https://github.com/expo/entity/commit/684f91b1f270851dbe331df2e2620664eea17266))
* change redis cache adapter to use redis-like interface ([#200](https://github.com/expo/entity/issues/200)) ([e381f5b](https://github.com/expo/entity/commit/e381f5b2acfc17dcade2cf6e8506fa1c1c255e73))
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
### Features
* add BigIntField ([#193](https://github.com/expo/entity/issues/193)) ([acbad82](https://github.com/expo/entity/commit/acbad826a37bb5a054b4dcf9be91d11aa5f7f29a))
* nested transactions ([#194](https://github.com/expo/entity/issues/194)) ([a77b914](https://github.com/expo/entity/commit/a77b914ad6dc018d1e309c9caf4971088a553ecf))
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
### Features
* add orderByRaw to loadManyByRawWhereClauseAsync ([#185](https://github.com/expo/entity/issues/185)) ([2817d78](https://github.com/expo/entity/commit/2817d78392dfecd0093111c24d581bdf01dba06d))
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
### Features
* recache to higher cache levels when loading from a composed cache ([#182](https://github.com/expo/entity/pull/182))
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
### Bug Fixes
* fix workflow branch specification ([#179](https://github.com/expo/entity/issues/179)) ([25d14bf](https://github.com/expo/entity/commit/25d14bf8c1688524ad488aa2b63221393a4f0b05))
### Features
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
### 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)
@@ -142,7 +12,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
### Chores ### Chores
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157)) * Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
+12 -4
View File
@@ -4,7 +4,7 @@ Entity is a privacy-aware data layer for defining, caching, and authorizing acce
[![tests](https://github.com/expo/entity/workflows/tests/badge.svg)](https://github.com/expo/entity/actions?query=workflow%3Atests) [![tests](https://github.com/expo/entity/workflows/tests/badge.svg)](https://github.com/expo/entity/actions?query=workflow%3Atests)
[![docs](https://github.com/expo/entity/workflows/docs/badge.svg)](https://expo.github.io/entity/) [![docs](https://github.com/expo/entity/workflows/docs/badge.svg)](https://expo.github.io/entity/)
[![codecov](https://codecov.io/gh/expo/entity/branch/main/graph/badge.svg)](https://codecov.io/gh/expo/entity) [![codecov](https://codecov.io/gh/expo/entity/branch/master/graph/badge.svg)](https://codecov.io/gh/expo/entity)
[![npm](https://img.shields.io/npm/v/@expo/entity)](https://www.npmjs.com/package/@expo/entity) [![npm](https://img.shields.io/npm/v/@expo/entity)](https://www.npmjs.com/package/@expo/entity)
[![NPM](https://img.shields.io/npm/l/@expo/entity)](https://www.npmjs.com/package/@expo/entity) [![NPM](https://img.shields.io/npm/l/@expo/entity)](https://www.npmjs.com/package/@expo/entity)
@@ -80,10 +80,18 @@ Note: The entity framework instance should not be shared across multiple request
## Releasing ## Releasing
To release a new version: To release a new version, let's say `v1.0.0` for example:
1. `git checkout main` 1. `git checkout -b bump-v1.0.0`
1. `yarn lerna publish [patch|minor|major] -- --conventional-commits` 1. `yarn lerna version minor -- --no-push --conventional-commits`
1. `git push -u origin bump-v1.0.0`
1. Create a PR from the `bump-v1.0.0` branch, wait for tests, and commit the PR using GitHub interface.
1. `git checkout master && git pull`
1. `git tag -d v1.0.0`
1. `git tag v1.0.0`
1. `git push origin v1.0.0`
1. In GitHub release interface, create a new release from the tag, copy changelog changes to release description. 1. In GitHub release interface, create a new release from the tag, copy changelog changes to release description.
1. `yarn clean && yarn tsc`
1. In each public subpackage, run `npm publish` and enter 2FA token.
## License ## License
+1 -1
View File
@@ -4,5 +4,5 @@
], ],
"npmClient": "yarn", "npmClient": "yarn",
"useWorkspaces": true, "useWorkspaces": true,
"version": "0.31.1" "version": "0.24.0"
} }
+8 -11
View File
@@ -16,13 +16,13 @@
"barrelsby": "lerna run barrelsby" "barrelsby": "lerna run barrelsby"
}, },
"devDependencies": { "devDependencies": {
"@expo/batcher": "^1.0.0",
"@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/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",
@@ -30,18 +30,16 @@
"barrelsby": "^2.2.0", "barrelsby": "^2.2.0",
"eslint": "^7.7.0", "eslint": "^7.7.0",
"eslint-config-universe": "^7.0.0", "eslint-config-universe": "^7.0.0",
"eslint-plugin-tsdoc": "^0.2.16", "eslint-plugin-tsdoc": "^0.2.11",
"ioredis": "^5.2.5",
"jest": "^26.6.3", "jest": "^26.6.3",
"lerna": "^5.4.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",
"ts-jest": "~26.4.4", "ts-jest": "~26.4.4",
"ts-mockito": "^2.6.1", "ts-mockito": "^2.6.1",
"typedoc": "^0.23.10", "typedoc": "^0.21.9",
"typescript": "^4.6.3", "typescript": "^4.4.2",
"uuid": "^8.3.0" "uuid": "^8.3.0"
}, },
"dependencies": { "dependencies": {
@@ -49,8 +47,7 @@
"@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-ip-address-field": "file:packages/entity-ip-address-field", "@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis",
"@expo/entity-secondary-cache-local-memory": "file:packages/entity-secondary-cache-local-memory", "@expo/entity-ip-address-field": "file:packages/entity-ip-address-field"
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis"
} }
} }
@@ -3,103 +3,6 @@
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.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
### 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,26 +3,21 @@
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-machine invalidation is not possible. Do not use this cache Because this is an in-memory cache, cross-box 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 are mutable - The objects stored have high mutability
- 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-machine invalidation is not possible - Cross-box 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, and reading a stale object for a short TTL is acceptable - The objects stored are mostly immutable
- 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.31.1", "version": "0.24.0",
"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": "^6.0.0" "lru-cache": "^7.3.1"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.31.1" "@expo/entity": "^0.24.0"
} }
} }
@@ -7,6 +7,76 @@ 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>) {}
@@ -16,11 +86,13 @@ 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;
return new LRUCache<string, LocalMemoryCacheValue<TFields>>({ const lruCacheOptions: LRUCacheOptionsV7<string, TFields> = {
max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE, max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE,
length: (value) => (value === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1), sizeCalculation: (value: LocalMemoryCacheValue<TFields>) =>
maxAge: maxAgeSeconds * 1000, // convert to ms value === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1,
}); 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> {
@@ -68,7 +68,7 @@ export default class LocalMemoryCacheAdapter<TFields> extends EntityCacheAdapter
fieldValue: NonNullable<TFields[N]> fieldValue: NonNullable<TFields[N]>
): string { ): string {
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName); const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
invariant(columnName, `database field mapping missing for ${String(fieldName)}`); invariant(columnName, `database field mapping missing for ${fieldName}`);
const parts = [ const parts = [
this.entityConfiguration.tableName, this.entityConfiguration.tableName,
`${this.entityConfiguration.cacheKeyVersion}`, `${this.entityConfiguration.cacheKeyVersion}`,
@@ -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 {
createLocalMemoryTestEntityCompanionProvider, createLocalMemoryIntegrationTestEntityCompanionProvider,
createNoopLocalMemoryIntegrationTestEntityCompanionProvider, createNoopLocalMemoryIntegrationTestEntityCompanionProvider,
} from '../testfixtures/createLocalMemoryTestEntityCompanionProvider'; } from '../testfixtures/createLocalMemoryIntegrationTestEntityCompanionProvider';
class TestViewerContext extends ViewerContext {} class TestViewerContext extends ViewerContext {}
@@ -18,7 +18,9 @@ describe(LocalMemoryCacheAdapter, () => {
}); });
it('has correct caching behavior', async () => { it('has correct caching behavior', async () => {
const viewerContext = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider()); const viewerContext = new TestViewerContext(
createLocalMemoryIntegrationTestEntityCompanionProvider()
);
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity( const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
LocalMemoryTestEntity, LocalMemoryTestEntity,
LocalMemoryTestEntity.getCompanionDefinition() LocalMemoryTestEntity.getCompanionDefinition()
@@ -88,7 +90,9 @@ describe(LocalMemoryCacheAdapter, () => {
GenericLocalMemoryCacher.prototype as unknown as any, GenericLocalMemoryCacher.prototype as unknown as any,
'loadManyAsync' 'loadManyAsync'
); );
const viewerContext = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider()); const viewerContext = new TestViewerContext(
createLocalMemoryIntegrationTestEntityCompanionProvider()
);
const date = new Date(); const date = new Date();
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext) const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
@@ -102,7 +106,9 @@ describe(LocalMemoryCacheAdapter, () => {
.loadByIDAsync(entity1Created.getID()); .loadByIDAsync(entity1Created.getID());
// load entity with a different request // load entity with a different request
const viewerContext2 = new TestViewerContext(createLocalMemoryTestEntityCompanionProvider()); const viewerContext2 = new TestViewerContext(
createLocalMemoryIntegrationTestEntityCompanionProvider()
);
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2) const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2)
.enforcing() .enforcing()
.loadByIDAsync(entity1Created.getID()); .loadByIDAsync(entity1Created.getID());
@@ -1,28 +0,0 @@
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();
});
});
});
@@ -24,7 +24,10 @@ 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' }]]);
@@ -49,7 +52,10 @@ 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());
@@ -58,7 +64,10 @@ 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' }]]));
@@ -72,7 +81,10 @@ 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']);
@@ -84,7 +96,10 @@ 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' }]]));
@@ -99,7 +114,10 @@ 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', []);
}); });
@@ -4,7 +4,7 @@
* @module @expo/entity-cache-adapter-local-memory * @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 LocalMemoryCacheAdapter } from './LocalMemoryCacheAdapter';
export { default as LocalMemoryCacheAdapterProvider } from './LocalMemoryCacheAdapterProvider'; export { default as LocalMemoryCacheAdapterProvider } from './LocalMemoryCacheAdapterProvider';
export { default as GenericLocalMemoryCacher } from './GenericLocalMemoryCacher';
export * from './GenericLocalMemoryCacher';
@@ -6,9 +6,9 @@ import {
StubDatabaseAdapterProvider, StubDatabaseAdapterProvider,
} from '@expo/entity'; } from '@expo/entity';
import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider'; import { LocalMemoryCacheAdapterProvider } from '../LocalMemoryCacheAdapterProvider';
export const createLocalMemoryTestEntityCompanionProvider = ( export const createLocalMemoryIntegrationTestEntityCompanionProvider = (
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 createLocalMemoryTestEntityCompanionProvider = (
export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = ( export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = (
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter() metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => { ): EntityCompanionProvider => {
return createLocalMemoryTestEntityCompanionProvider( return createLocalMemoryIntegrationTestEntityCompanionProvider(
{ maxSize: 0, ttlSeconds: 0 }, { maxSize: 0, ttlSeconds: 0 },
metricsAdapter metricsAdapter
); );
@@ -3,101 +3,6 @@
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.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
### Features
* add example of redis mget batching using @expo/batcher ([#199](https://github.com/expo/entity/issues/199)) ([684f91b](https://github.com/expo/entity/commit/684f91b1f270851dbe331df2e2620664eea17266))
* change redis cache adapter to use redis-like interface ([#200](https://github.com/expo/entity/issues/200)) ([e381f5b](https://github.com/expo/entity/commit/e381f5b2acfc17dcade2cf6e8506fa1c1c255e73))
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
### Features
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
## [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.31.1", "version": "0.24.0",
"description": "Redis cache adapter for @expo/entity", "description": "Redis cache adapter for @expo/entity",
"files": [ "files": [
"build", "build",
@@ -27,11 +27,12 @@
"author": "Expo", "author": "Expo",
"license": "MIT", "license": "MIT",
"peerDependencies": { "peerDependencies": {
"@expo/entity": "*", "@expo/entity": "*"
"ioredis": ">=5" },
"dependencies": {
"ioredis": "^4.27.3"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.31.1", "@expo/entity": "^0.24.0"
"ioredis": "^5.2.5"
} }
} }
@@ -6,6 +6,7 @@ import {
transformFieldsToCacheObject, transformFieldsToCacheObject,
IEntityGenericCacher, IEntityGenericCacher,
} from '@expo/entity'; } from '@expo/entity';
import { Redis } from 'ioredis';
import { redisTransformerMap } from './RedisCommon'; import { redisTransformerMap } from './RedisCommon';
import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync'; import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
@@ -14,22 +15,11 @@ import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
// The sentinel value is distinct from any (positively) cached value. // The sentinel value is distinct from any (positively) cached value.
const DOES_NOT_EXIST_REDIS = ''; const DOES_NOT_EXIST_REDIS = '';
export interface IRedisTransaction {
set(key: string, value: string, secondsToken: 'EX', seconds: number): this;
exec(): Promise<any>;
}
export interface IRedis {
mget(...args: [...keys: string[]]): Promise<(string | null)[]>;
multi(): IRedisTransaction;
del(...args: [...keys: string[]]): Promise<any>;
}
export interface GenericRedisCacheContext { export interface GenericRedisCacheContext {
/** /**
* Instance of ioredis.Redis * Instance of ioredis.Redis
*/ */
redisClient: IRedis; redisClient: Redis;
/** /**
* TTL for caching database hits. Successive entity loads within this TTL * TTL for caching database hits. Successive entity loads within this TTL
@@ -1,13 +1,14 @@
import { EntityCacheAdapter, EntityConfiguration, CacheLoadResult, mapKeys } from '@expo/entity'; import { EntityCacheAdapter, EntityConfiguration, CacheLoadResult, mapKeys } from '@expo/entity';
import invariant from 'invariant'; import invariant from 'invariant';
import { Redis } from 'ioredis';
import GenericRedisCacher, { IRedis } from './GenericRedisCacher'; import GenericRedisCacher from './GenericRedisCacher';
export interface RedisCacheAdapterContext { export interface RedisCacheAdapterContext {
/** /**
* Instance of ioredis.Redis * Instance of ioredis.Redis
*/ */
redisClient: IRedis; redisClient: Redis;
/** /**
* Create a key string for key parts (cache key prefix, versions, entity name, etc). * Create a key string for key parts (cache key prefix, versions, entity name, etc).
@@ -112,7 +113,7 @@ export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFiel
fieldValue: NonNullable<TFields[N]> fieldValue: NonNullable<TFields[N]>
): string { ): string {
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName); const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
invariant(columnName, `database field mapping missing for ${String(fieldName)}`); invariant(columnName, `database field mapping missing for ${fieldName}`);
return this.context.makeKeyFn( return this.context.makeKeyFn(
this.context.cacheKeyPrefix, this.context.cacheKeyPrefix,
this.entityConfiguration.tableName, this.entityConfiguration.tableName,
@@ -1,164 +0,0 @@
import { Batcher } from '@expo/batcher';
import { ViewerContext, zipToMap } from '@expo/entity';
import invariant from 'invariant';
import Redis from 'ioredis';
import nullthrows from 'nullthrows';
import { URL } from 'url';
import { v4 as uuidv4 } from 'uuid';
import { IRedis, IRedisTransaction } from '../GenericRedisCacher';
import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
import RedisTestEntity from '../testfixtures/RedisTestEntity';
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
class BatchedRedis implements IRedis {
private readonly mgetBatcher = new Batcher<string[], (string | null)[]>(
this.batchMgetAsync.bind(this),
{
maxBatchInterval: 0,
}
);
constructor(private readonly redis: Redis) {}
private async batchMgetAsync(keySets: string[][]): Promise<(string | null)[][]> {
// ordered distinct keys to fetch
const allKeysToFetch = [...new Set(keySets.flat())];
// fetch the distinct keys
const allResults = await this.redis.mget(...allKeysToFetch);
// put them into a map for fast lookup
const keysToResults = zipToMap(allKeysToFetch, allResults);
// re-associate them with original key sets
return keySets.map((keySet) =>
keySet.map((key) => {
const result = keysToResults.get(key);
invariant(result !== undefined, 'result should not be undefined');
return result;
})
);
}
async mget(...args: string[]): Promise<(string | null)[]> {
return await this.mgetBatcher.batchAsync(args);
}
multi(): IRedisTransaction {
return this.redis.multi();
}
async del(...args: string[]): Promise<void> {
await this.redis.del(...args);
}
}
describe(RedisCacheAdapter, () => {
const redis = new Redis(new URL(process.env['REDIS_URL']!).toString());
const redisClient = new BatchedRedis(redis);
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
redisCacheAdapterContext = {
redisClient,
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
const escapedParts = parts.map((part) =>
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
);
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
});
beforeEach(async () => {
await redis.flushdb();
});
afterAll(async () => {
redis.disconnect();
});
it('has correct caching behavior', async () => {
// simulate two requests
const viewerContext = new ViewerContext(
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const mgetSpy = jest.spyOn(redis, 'mget');
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
RedisTestEntity,
RedisTestEntity.getCompanionDefinition()
)['tableDataCoordinator']['cacheAdapter'];
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
const entity1Created = await RedisTestEntity.creator(viewerContext)
.setField('name', 'blah')
.enforceCreateAsync();
// loading an entity should put it in cache. load by multiple requests and multiple fields in same tick to ensure batch works
mgetSpy.mockClear();
const viewerContext1 = new ViewerContext(
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const viewerContext2 = new ViewerContext(
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const viewerContext3 = new ViewerContext(
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const [entity1, entity2, entity3] = await Promise.all([
RedisTestEntity.loader(viewerContext1).enforcing().loadByIDAsync(entity1Created.getID()),
RedisTestEntity.loader(viewerContext2).enforcing().loadByIDAsync(entity1Created.getID()),
RedisTestEntity.loader(viewerContext3)
.enforcing()
.loadByFieldEqualingAsync('name', entity1Created.getField('name')),
]);
expect(mgetSpy).toHaveBeenCalledTimes(1);
expect(mgetSpy.mock.calls[0]).toHaveLength(2); // should dedupe the first two loads
expect(entity1.getID()).toEqual(entity2.getID());
expect(entity2.getID()).toEqual(nullthrows(entity3).getID());
const cacheKeyEntity1 = cacheKeyMaker('id', entity1Created.getID());
const cachedJSON = await redis.get(cacheKeyEntity1);
const cachedValue = JSON.parse(cachedJSON!);
expect(cachedValue).toMatchObject({
id: entity1.getID(),
name: 'blah',
});
const cacheKeyEntity1NameField = cacheKeyMaker('name', entity1Created.getField('name'));
await RedisTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('name', entity1Created.getField('name'));
await expect(redis.get(cacheKeyEntity1NameField)).resolves.toEqual(cachedJSON);
// simulate non existent db fetch, should write negative result ('') to cache
const nonExistentId = uuidv4();
const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
nonExistentId
);
expect(entityNonExistentResult.ok).toBe(false);
const cacheKeyNonExistent = cacheKeyMaker('id', nonExistentId);
const nonExistentCachedValue = await redis.get(cacheKeyNonExistent);
expect(nonExistentCachedValue).toEqual('');
// load again through entities framework to ensure it reads negative result
const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
nonExistentId
);
expect(entityNonExistentResult2.ok).toBe(false);
// invalidate from cache to ensure it invalidates correctly in both caches
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
await expect(redis.get(cacheKeyEntity1)).resolves.toBeNull();
await expect(redis.get(cacheKeyEntity1NameField)).resolves.toBeNull();
});
});
@@ -13,12 +13,11 @@ import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtur
class TestViewerContext extends ViewerContext {} class TestViewerContext extends ViewerContext {}
describe(GenericRedisCacher, () => { describe(GenericRedisCacher, () => {
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let redisCacheAdapterContext: RedisCacheAdapterContext; let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => { beforeAll(() => {
redisCacheAdapterContext = { redisCacheAdapterContext = {
redisClient, redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string { makeKeyFn(...parts: string[]): string {
const delimiter = ':'; const delimiter = ':';
const escapedParts = parts.map((part) => const escapedParts = parts.map((part) =>
@@ -34,10 +33,10 @@ describe(GenericRedisCacher, () => {
}); });
beforeEach(async () => { beforeEach(async () => {
await redisClient.flushdb(); await redisCacheAdapterContext.redisClient.flushdb();
}); });
afterAll(async () => { afterAll(async () => {
redisClient.disconnect(); redisCacheAdapterContext.redisClient.disconnect();
}); });
it('has correct caching and loading behavior', async () => { it('has correct caching and loading behavior', async () => {
@@ -63,7 +62,7 @@ describe(GenericRedisCacher, () => {
]); ]);
await genericRedisCacher.cacheManyAsync(objectMap); await genericRedisCacher.cacheManyAsync(objectMap);
const cachedJSON = await redisClient.get(testKey); const cachedJSON = await redisCacheAdapterContext.redisClient.get(testKey);
const cachedValue = JSON.parse(cachedJSON!); const cachedValue = JSON.parse(cachedJSON!);
expect(cachedValue).toMatchObject({ expect(cachedValue).toMatchObject({
id: entity1Created.getID(), id: entity1Created.getID(),
@@ -11,12 +11,11 @@ import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtur
class TestViewerContext extends ViewerContext {} class TestViewerContext extends ViewerContext {}
describe(RedisCacheAdapter, () => { describe(RedisCacheAdapter, () => {
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let redisCacheAdapterContext: RedisCacheAdapterContext; let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => { beforeAll(() => {
redisCacheAdapterContext = { redisCacheAdapterContext = {
redisClient, redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string { makeKeyFn(...parts: string[]): string {
const delimiter = ':'; const delimiter = ':';
const escapedParts = parts.map((part) => const escapedParts = parts.map((part) =>
@@ -32,10 +31,10 @@ describe(RedisCacheAdapter, () => {
}); });
beforeEach(async () => { beforeEach(async () => {
await redisClient.flushdb(); await redisCacheAdapterContext.redisClient.flushdb();
}); });
afterAll(async () => { afterAll(async () => {
redisClient.disconnect(); redisCacheAdapterContext.redisClient.disconnect();
}); });
it('has correct caching behavior', async () => { it('has correct caching behavior', async () => {
@@ -57,7 +56,9 @@ describe(RedisCacheAdapter, () => {
.enforcing() .enforcing()
.loadByIDAsync(entity1Created.getID()); .loadByIDAsync(entity1Created.getID());
const cachedJSON = await redisClient.get(cacheKeyMaker('id', entity1.getID())); const cachedJSON = await redisCacheAdapterContext.redisClient.get(
cacheKeyMaker('id', entity1.getID())
);
const cachedValue = JSON.parse(cachedJSON!); const cachedValue = JSON.parse(cachedJSON!);
expect(cachedValue).toMatchObject({ expect(cachedValue).toMatchObject({
id: entity1.getID(), id: entity1.getID(),
@@ -72,7 +73,9 @@ describe(RedisCacheAdapter, () => {
); );
expect(entityNonExistentResult.ok).toBe(false); expect(entityNonExistentResult.ok).toBe(false);
const nonExistentCachedValue = await redisClient.get(cacheKeyMaker('id', nonExistentId)); const nonExistentCachedValue = await redisCacheAdapterContext.redisClient.get(
cacheKeyMaker('id', nonExistentId)
);
expect(nonExistentCachedValue).toEqual(''); expect(nonExistentCachedValue).toEqual('');
// load again through entities framework to ensure it reads negative result // load again through entities framework to ensure it reads negative result
@@ -83,7 +86,9 @@ describe(RedisCacheAdapter, () => {
// invalidate from cache to ensure it invalidates correctly // invalidate from cache to ensure it invalidates correctly
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields()); await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
const cachedValueNull = await redisClient.get(cacheKeyMaker('id', entity1.getID())); const cachedValueNull = await redisCacheAdapterContext.redisClient.get(
cacheKeyMaker('id', entity1.getID())
);
expect(cachedValueNull).toBe(null); expect(cachedValueNull).toBe(null);
}); });
@@ -9,12 +9,11 @@ import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtur
class TestViewerContext extends ViewerContext {} class TestViewerContext extends ViewerContext {}
describe(RedisCacheAdapter, () => { describe(RedisCacheAdapter, () => {
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let redisCacheAdapterContext: RedisCacheAdapterContext; let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => { beforeAll(() => {
redisCacheAdapterContext = { redisCacheAdapterContext = {
redisClient, redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string { makeKeyFn(...parts: string[]): string {
const delimiter = ':'; const delimiter = ':';
const escapedParts = parts.map((part) => const escapedParts = parts.map((part) =>
@@ -30,11 +29,11 @@ describe(RedisCacheAdapter, () => {
}); });
beforeEach(async () => { beforeEach(async () => {
await redisClient.flushdb(); await redisCacheAdapterContext.redisClient.flushdb();
}); });
it('throws when redis is disconnected', async () => { it('throws when redis is disconnected', async () => {
redisClient.disconnect(); redisCacheAdapterContext.redisClient.disconnect();
const vc1 = new TestViewerContext( const vc1 = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext) createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
@@ -9,9 +9,6 @@ import {
import { RedisCacheAdapterContext } from '../RedisCacheAdapter'; import { RedisCacheAdapterContext } from '../RedisCacheAdapter';
import RedisCacheAdapterProvider from '../RedisCacheAdapterProvider'; import RedisCacheAdapterProvider from '../RedisCacheAdapterProvider';
// share across all in calls in test to simulate postgres
const adapterProvider = new StubDatabaseAdapterProvider();
export const createRedisIntegrationTestEntityCompanionProvider = ( export const createRedisIntegrationTestEntityCompanionProvider = (
redisCacheAdapterContext: RedisCacheAdapterContext, redisCacheAdapterContext: RedisCacheAdapterContext,
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter() metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
@@ -22,7 +19,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
[ [
'postgres', 'postgres',
{ {
adapterProvider, adapterProvider: new StubDatabaseAdapterProvider(),
queryContextProvider: StubQueryContextProvider, queryContextProvider: StubQueryContextProvider,
}, },
], ],
@@ -3,101 +3,6 @@
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.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity-database-adapter-knex
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity-database-adapter-knex
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
**Note:** Version bump only for package @expo/entity-database-adapter-knex
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
### Features
* add BigIntField ([#193](https://github.com/expo/entity/issues/193)) ([acbad82](https://github.com/expo/entity/commit/acbad826a37bb5a054b4dcf9be91d11aa5f7f29a))
* nested transactions ([#194](https://github.com/expo/entity/issues/194)) ([a77b914](https://github.com/expo/entity/commit/a77b914ad6dc018d1e309c9caf4971088a553ecf))
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
### Features
* add orderByRaw to loadManyByRawWhereClauseAsync ([#185](https://github.com/expo/entity/issues/185)) ([2817d78](https://github.com/expo/entity/commit/2817d78392dfecd0093111c24d581bdf01dba06d))
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
**Note:** Version bump only for package @expo/entity-database-adapter-knex
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
**Note:** Version bump only for package @expo/entity-database-adapter-knex
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
**Note:** Version bump only for package @expo/entity-database-adapter-knex
## [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.31.1", "version": "0.24.0",
"description": "Knex database adapter for @expo/entity", "description": "Knex database adapter for @expo/entity",
"files": [ "files": [
"build", "build",
@@ -30,10 +30,10 @@
"@expo/entity": "*" "@expo/entity": "*"
}, },
"dependencies": { "dependencies": {
"knex": "^2.4.1" "knex": "^1.0.2"
}, },
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.31.1", "@expo/entity": "^0.24.0",
"pg": "^8.7.1" "pg": "^8.7.1"
} }
} }
@@ -1,29 +0,0 @@
import { EntityFieldDefinition } from '@expo/entity';
/**
* EntityFieldDefinition for a Postres column with a JS JSON array type.
*/
export class JSONArrayField extends EntityFieldDefinition<any[]> {
protected validateInputValueInternal(value: any[]): boolean {
return Array.isArray(value);
}
}
/**
* EntityFieldDefinition for a Postgres column that may be a JS JSON array type.
* Does not do any validation.
*/
export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
protected validateInputValueInternal(_value: any): boolean {
return true;
}
}
/**
* EntityFieldDefinition for a Postgres BIGINT column.
*/
export class BigIntField extends EntityFieldDefinition<string> {
protected validateInputValueInternal(value: string): boolean {
return typeof value === 'string';
}
}
@@ -2,14 +2,14 @@ import {
EntityDatabaseAdapter, EntityDatabaseAdapter,
FieldTransformerMap, FieldTransformerMap,
FieldTransformer, FieldTransformer,
JSONArrayField,
MaybeJSONArrayField,
TableQuerySelectionModifiers, TableQuerySelectionModifiers,
TableFieldSingleValueEqualityCondition, TableFieldSingleValueEqualityCondition,
TableFieldMultiValueEqualityCondition, TableFieldMultiValueEqualityCondition,
TableQuerySelectionModifiersWithOrderByRaw,
} from '@expo/entity'; } from '@expo/entity';
import { Knex } from 'knex'; import { Knex } from 'knex';
import { JSONArrayField, MaybeJSONArrayField } from './EntityFields';
import wrapNativePostgresCallAsync from './errors/wrapNativePostgresCallAsync'; import wrapNativePostgresCallAsync from './errors/wrapNativePostgresCallAsync';
export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDatabaseAdapter<TFields> { export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDatabaseAdapter<TFields> {
@@ -53,20 +53,6 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
); );
} }
private applyQueryModifiersToQueryOrderByRaw(
query: Knex.QueryBuilder,
querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw
): Knex.QueryBuilder {
let ret = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
const { orderByRaw } = querySelectionModifiers;
if (orderByRaw !== undefined) {
ret = ret.orderByRaw(orderByRaw);
}
return ret;
}
private applyQueryModifiersToQuery( private applyQueryModifiersToQuery(
query: Knex.QueryBuilder, query: Knex.QueryBuilder,
querySelectionModifiers: TableQuerySelectionModifiers querySelectionModifiers: TableQuerySelectionModifiers
@@ -143,13 +129,13 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
tableName: string, tableName: string,
rawWhereClause: string, rawWhereClause: string,
bindings: object | any[], bindings: object | any[],
querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw querySelectionModifiers: TableQuerySelectionModifiers
): Promise<object[]> { ): Promise<object[]> {
let query = queryInterface let query = queryInterface
.select() .select()
.from(tableName) .from(tableName)
.whereRaw(rawWhereClause, bindings as any); .whereRaw(rawWhereClause, bindings as any);
query = this.applyQueryModifiersToQueryOrderByRaw(query, querySelectionModifiers); query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
return await wrapNativePostgresCallAsync(() => query); return await wrapNativePostgresCallAsync(() => query);
} }
@@ -18,10 +18,4 @@ export default class PostgresEntityQueryContextProvider extends EntityQueryConte
) => Promise<T> { ) => Promise<T> {
return (transactionScope) => this.knexInstance.transaction(transactionScope); return (transactionScope) => this.knexInstance.transaction(transactionScope);
} }
protected createNestedTransactionRunner<T>(
outerQueryInterface: any
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
return (transactionScope) => (outerQueryInterface as Knex).transaction(transactionScope);
}
} }
@@ -157,27 +157,6 @@ describe('postgres entity integration', () => {
}); });
}); });
describe('BIGINT fields', () => {
it('supports BIGINT fields', async () => {
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
let entity = await enforceAsyncResult(
PostgresTestEntity.creator(vc1).setField('bigintField', '72057594037928038').createAsync()
);
expect(entity.getField('bigintField')).toEqual('72057594037928038');
entity = await enforceAsyncResult(
PostgresTestEntity.updater(entity).setField('bigintField', '10').updateAsync()
);
expect(entity.getField('bigintField')).toEqual('10');
entity = await enforceAsyncResult(
PostgresTestEntity.updater(entity).setField('bigintField', '-10').updateAsync()
);
expect(entity.getField('bigintField')).toEqual('-10');
});
});
describe('conjunction field equality loading', () => { describe('conjunction field equality loading', () => {
it('supports single fieldValue and multiple fieldValues', async () => { it('supports single fieldValue and multiple fieldValues', async () => {
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance)); const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
@@ -400,15 +379,6 @@ describe('postgres entity integration', () => {
expect(resultsMultipleOrderBy).toHaveLength(3); expect(resultsMultipleOrderBy).toHaveLength(3);
expect(resultsMultipleOrderBy.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']); expect(resultsMultipleOrderBy.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
const resultsOrderByRaw = await PostgresTestEntity.loader(vc1)
.enforcing()
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
orderByRaw: 'has_a_dog ASC, name DESC',
});
expect(resultsOrderByRaw).toHaveLength(3);
expect(resultsOrderByRaw.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
}); });
}); });
@@ -636,7 +606,6 @@ describe('postgres entity integration', () => {
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance)); const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
let preCommitCallCount = 0; let preCommitCallCount = 0;
let preCommitInnerCallCount = 0;
let postCommitCallCount = 0; let postCommitCallCount = 0;
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => { await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
@@ -646,28 +615,6 @@ describe('postgres entity integration', () => {
queryContext.appendPreCommitCallback(async () => { queryContext.appendPreCommitCallback(async () => {
preCommitCallCount++; preCommitCallCount++;
}, 0); }, 0);
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
innerQueryContext.appendPostCommitCallback(async () => {
postCommitCallCount++;
});
innerQueryContext.appendPreCommitCallback(async () => {
preCommitInnerCallCount++;
}, 0);
});
// this one throws so its post commit shouldn't execute
try {
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
innerQueryContext.appendPostCommitCallback(async () => {
postCommitCallCount++;
});
innerQueryContext.appendPreCommitCallback(async () => {
preCommitInnerCallCount++;
throw Error('wat');
}, 0);
});
} catch {}
}); });
await expect( await expect(
@@ -683,8 +630,7 @@ describe('postgres entity integration', () => {
).rejects.toThrowError('wat'); ).rejects.toThrowError('wat');
expect(preCommitCallCount).toBe(2); expect(preCommitCallCount).toBe(2);
expect(preCommitInnerCallCount).toBe(2); expect(postCommitCallCount).toBe(1);
expect(postCommitCallCount).toBe(2);
}); });
}); });
}); });
@@ -1,101 +0,0 @@
import { ViewerContext } from '@expo/entity';
import { knex, Knex } from 'knex';
import nullthrows from 'nullthrows';
import PostgresEntityQueryContextProvider from '../PostgresEntityQueryContextProvider';
import PostgresUniqueTestEntity from '../testfixtures/PostgresUniqueTestEntity';
import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
describe(PostgresEntityQueryContextProvider, () => {
let knexInstance: Knex;
beforeAll(() => {
knexInstance = knex({
client: 'pg',
connection: {
user: nullthrows(process.env['PGUSER']),
password: nullthrows(process.env['PGPASSWORD']),
host: 'localhost',
port: parseInt(nullthrows(process.env['PGPORT']), 10),
database: nullthrows(process.env['PGDATABASE']),
},
});
});
beforeEach(async () => {
await PostgresUniqueTestEntity.createOrTruncatePostgresTable(knexInstance);
});
afterAll(async () => {
await PostgresUniqueTestEntity.dropPostgresTable(knexInstance);
await knexInstance.destroy();
});
it('supports nested transactions', async () => {
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
await PostgresUniqueTestEntity.creator(vc1).setField('name', 'unique').enforceCreateAsync();
const id = (
await PostgresUniqueTestEntity.creator(vc1).setField('name', 'wat').enforceCreateAsync()
).getID();
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
const entity = await PostgresUniqueTestEntity.loader(vc1, queryContext)
.enforcing()
.loadByIDAsync(id);
await PostgresUniqueTestEntity.updater(entity, queryContext)
.setField('name', 'wat2')
.enforceUpdateAsync();
// ensure the outer transaction is not aborted due to postgres error in inner transaction,
// in this case the error triggered is a unique constraint violation
try {
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
const entity = await PostgresUniqueTestEntity.loader(vc1, innerQueryContext)
.enforcing()
.loadByIDAsync(id);
await PostgresUniqueTestEntity.updater(entity, innerQueryContext)
.setField('name', 'unique')
.enforceUpdateAsync();
});
} catch {}
const entity2 = await PostgresUniqueTestEntity.loader(vc1, queryContext)
.enforcing()
.loadByIDAsync(id);
await PostgresUniqueTestEntity.updater(entity2, queryContext)
.setField('name', 'wat3')
.enforceUpdateAsync();
});
const entityLoaded = await PostgresUniqueTestEntity.loader(vc1).enforcing().loadByIDAsync(id);
expect(entityLoaded.getField('name')).toEqual('wat3');
});
it('supports multi-nested transactions', async () => {
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
const id = (
await PostgresUniqueTestEntity.creator(vc1).setField('name', 'wat').enforceCreateAsync()
).getID();
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
await innerQueryContext.runInNestedTransactionAsync(async (innerQueryContex2) => {
await innerQueryContex2.runInNestedTransactionAsync(async (innerQueryContex3) => {
const entity = await PostgresUniqueTestEntity.loader(vc1, innerQueryContex3)
.enforcing()
.loadByIDAsync(id);
await PostgresUniqueTestEntity.updater(entity, innerQueryContex3)
.setField('name', 'wat3')
.enforceUpdateAsync();
});
});
});
});
const entityLoaded = await PostgresUniqueTestEntity.loader(vc1).enforcing().loadByIDAsync(id);
expect(entityLoaded.getField('name')).toEqual('wat3');
});
});
@@ -1,19 +0,0 @@
import { describeFieldTestCase } from '@expo/entity';
import { BigIntField, JSONArrayField, MaybeJSONArrayField } from '../EntityFields';
describeFieldTestCase(
new JSONArrayField({ columnName: 'wat' }),
[[[1, 2]] as any, [['hello']] as any],
[1, 'hello']
);
describeFieldTestCase(
new MaybeJSONArrayField({ columnName: 'wat' }),
[1, 'hello', [['hello']]],
[]
);
describeFieldTestCase(
new BigIntField({ columnName: 'wat' }),
['123457682149816498126412896', '123', '-1', '-124147812641876482716841'],
[1, false, -1, 1e6, {}]
);
@@ -7,4 +7,3 @@
export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter'; export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter';
export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider'; export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider';
export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider'; export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider';
export * from './EntityFields';
@@ -6,16 +6,16 @@ import {
StringField, StringField,
BooleanField, BooleanField,
StringArrayField, StringArrayField,
JSONArrayField,
JSONObjectField, JSONObjectField,
DateField, DateField,
MaybeJSONArrayField,
EntityConfiguration, EntityConfiguration,
EntityCompanionDefinition, EntityCompanionDefinition,
Entity, Entity,
} from '@expo/entity'; } from '@expo/entity';
import { Knex } from 'knex'; import { Knex } from 'knex';
import { BigIntField, JSONArrayField, MaybeJSONArrayField } from '../EntityFields';
type PostgresTestEntityFields = { type PostgresTestEntityFields = {
id: string; id: string;
name: string | null; name: string | null;
@@ -28,7 +28,6 @@ type PostgresTestEntityFields = {
} | null; } | null;
dateField: Date | null; dateField: Date | null;
maybeJsonArrayField: string[] | { hello: string } | null; maybeJsonArrayField: string[] | { hello: string } | null;
bigintField: string | null;
}; };
export default class PostgresTestEntity extends Entity< export default class PostgresTestEntity extends Entity<
@@ -47,11 +46,13 @@ export default class PostgresTestEntity extends Entity<
} }
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> { public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
const tableName = this.getCompanionDefinition().entityConfiguration.tableName; const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName); const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) { if (!hasTable) {
await knex.schema.createTable(tableName, (table) => { await knex.schema.createTable(tableName, (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary(); table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.string('name'); table.string('name');
table.boolean('has_a_dog'); table.boolean('has_a_dog');
table.boolean('has_a_cat'); table.boolean('has_a_cat');
@@ -60,7 +61,6 @@ export default class PostgresTestEntity extends Entity<
table.jsonb('json_object_field'); table.jsonb('json_object_field');
table.dateTime('date_field', { useTz: true }); table.dateTime('date_field', { useTz: true });
table.jsonb('maybe_json_array_field'); table.jsonb('maybe_json_array_field');
table.bigint('bigint_field');
}); });
} }
await knex.into(tableName).truncate(); await knex.into(tableName).truncate();
@@ -147,9 +147,6 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
maybeJsonArrayField: new MaybeJSONArrayField({ maybeJsonArrayField: new MaybeJSONArrayField({
columnName: 'maybe_json_array_field', columnName: 'maybe_json_array_field',
}), }),
bigintField: new BigIntField({
columnName: 'bigint_field',
}),
}, },
databaseAdapterFlavor: 'postgres', databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis', cacheAdapterFlavor: 'redis',
@@ -35,11 +35,13 @@ export default class PostgresTriggerTestEntity extends Entity<
} }
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> { public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
const tableName = this.getCompanionDefinition().entityConfiguration.tableName; const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName); const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) { if (!hasTable) {
await knex.schema.createTable(tableName, (table) => { await knex.schema.createTable(tableName, (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary(); table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.string('name'); table.string('name');
}); });
} }
@@ -1,115 +0,0 @@
import {
AlwaysAllowPrivacyPolicyRule,
EntityPrivacyPolicy,
ViewerContext,
UUIDField,
StringField,
EntityConfiguration,
EntityCompanionDefinition,
Entity,
} from '@expo/entity';
import { Knex } from 'knex';
type PostgresUniqueTestEntityFields = {
id: string;
name: string | null;
};
export default class PostgresUniqueTestEntity extends Entity<
PostgresUniqueTestEntityFields,
string,
ViewerContext
> {
static getCompanionDefinition(): EntityCompanionDefinition<
PostgresUniqueTestEntityFields,
string,
ViewerContext,
PostgresUniqueTestEntity,
PostgresUniqueTestEntityPrivacyPolicy
> {
return postgresTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) {
await knex.schema.createTable(tableName, (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
table.string('name').unique();
});
}
await knex.into(tableName).truncate();
}
public static async dropPostgresTable(knex: Knex): Promise<void> {
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (hasTable) {
await knex.schema.dropTable(tableName);
}
}
}
class PostgresUniqueTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
PostgresUniqueTestEntityFields,
string,
ViewerContext,
PostgresUniqueTestEntity
> {
protected override readonly createRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresUniqueTestEntityFields,
string,
ViewerContext,
PostgresUniqueTestEntity
>(),
];
protected override readonly readRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresUniqueTestEntityFields,
string,
ViewerContext,
PostgresUniqueTestEntity
>(),
];
protected override readonly updateRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresUniqueTestEntityFields,
string,
ViewerContext,
PostgresUniqueTestEntity
>(),
];
protected override readonly deleteRules = [
new AlwaysAllowPrivacyPolicyRule<
PostgresUniqueTestEntityFields,
string,
ViewerContext,
PostgresUniqueTestEntity
>(),
];
}
export const postgresTestEntityConfiguration =
new EntityConfiguration<PostgresUniqueTestEntityFields>({
idField: 'id',
tableName: 'postgres_test_entities',
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
name: new StringField({
columnName: 'name',
}),
},
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: PostgresUniqueTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresUniqueTestEntityPrivacyPolicy,
});
@@ -34,11 +34,13 @@ export default class PostgresValidatorTestEntity extends Entity<
} }
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> { public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
const tableName = this.getCompanionDefinition().entityConfiguration.tableName; const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName); const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) { if (!hasTable) {
await knex.schema.createTable(tableName, (table) => { await knex.schema.createTable(tableName, (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary(); table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.string('name'); table.string('name');
}); });
} }
-94
View File
@@ -3,100 +3,6 @@
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.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity-example
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity-example
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
**Note:** Version bump only for package @expo/entity-example
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
### Features
* nested transactions ([#194](https://github.com/expo/entity/issues/194)) ([a77b914](https://github.com/expo/entity/commit/a77b914ad6dc018d1e309c9caf4971088a553ecf))
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
**Note:** Version bump only for package @expo/entity-example
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
**Note:** Version bump only for package @expo/entity-example
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
**Note:** Version bump only for package @expo/entity-example
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
**Note:** Version bump only for package @expo/entity-example
## [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.31.1", "version": "0.24.0",
"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.31.1", "@expo/entity": "^0.24.0",
"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",
@@ -10,10 +10,4 @@ export default class InMemoryQueryContextProvider extends EntityQueryContextProv
) => Promise<T> { ) => Promise<T> {
return (transactionScope) => Promise.resolve(transactionScope({})); return (transactionScope) => Promise.resolve(transactionScope({}));
} }
protected createNestedTransactionRunner<T>(
_outerQueryInterface: any
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
return (transactionScope) => Promise.resolve(transactionScope({}));
}
} }
@@ -3,7 +3,6 @@ import {
ReadonlyEntity, ReadonlyEntity,
EntityQueryContext, EntityQueryContext,
RuleEvaluationResult, RuleEvaluationResult,
EntityPrivacyPolicyEvaluationContext,
} from '@expo/entity'; } from '@expo/entity';
import { ExampleViewerContext } from '../viewerContexts'; import { ExampleViewerContext } from '../viewerContexts';
@@ -35,7 +34,6 @@ 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()) {
@@ -30,7 +30,7 @@ router.get('/', async (ctx: ExampleContext) => {
router.get('/:id', async (ctx: ExampleContext) => { router.get('/:id', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext; const viewerContext = ctx.state.viewerContext;
const noteResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!); const noteResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
if (!noteResult.ok) { if (!noteResult.ok) {
ctx.throw(403, noteResult.reason); ctx.throw(403, noteResult.reason);
} }
@@ -69,7 +69,7 @@ router.put('/:id', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext; const viewerContext = ctx.state.viewerContext;
const { title, body } = ctx.request.body; const { title, body } = ctx.request.body;
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!); const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
if (!noteLoadResult.ok) { if (!noteLoadResult.ok) {
ctx.throw(403, noteLoadResult.reason); ctx.throw(403, noteLoadResult.reason);
} }
@@ -90,7 +90,7 @@ router.put('/:id', async (ctx: ExampleContext) => {
router.delete('/:id', async (ctx: ExampleContext) => { router.delete('/:id', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext; const viewerContext = ctx.state.viewerContext;
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!); const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
if (!noteLoadResult.ok) { if (!noteLoadResult.ok) {
ctx.throw(403, noteLoadResult.reason); ctx.throw(403, noteLoadResult.reason);
} }
@@ -3,100 +3,6 @@
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.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity-full-integration-tests
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity-full-integration-tests
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
### Features
* change redis cache adapter to use redis-like interface ([#200](https://github.com/expo/entity/issues/200)) ([e381f5b](https://github.com/expo/entity/commit/e381f5b2acfc17dcade2cf6e8506fa1c1c255e73))
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
**Note:** Version bump only for package @expo/entity-full-integration-tests
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
**Note:** Version bump only for package @expo/entity-full-integration-tests
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
**Note:** Version bump only for package @expo/entity-full-integration-tests
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
### Features
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
**Note:** Version bump only for package @expo/entity-full-integration-tests
## [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.31.1", "version": "0.24.0",
"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.31.1", "@expo/entity": "^0.24.0",
"@expo/entity-cache-adapter-redis": "^0.31.1", "@expo/entity-cache-adapter-redis": "^0.24.0",
"@expo/entity-database-adapter-knex": "^0.31.1" "@expo/entity-database-adapter-knex": "^0.24.0"
} }
} }
@@ -81,8 +81,10 @@ const testEntityCompanion = new EntityCompanionDefinition({
}); });
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> { async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
await knex.schema.createTable('testentities', (table) => { await knex.schema.createTable('testentities', (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary(); table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.string('other_string').notNullable(); table.string('other_string').notNullable();
table.string('third_string').notNullable(); table.string('third_string').notNullable();
}); });
@@ -90,14 +92,16 @@ async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
} }
async function dropPostgresTable(knex: Knex): Promise<void> { async function dropPostgresTable(knex: Knex): Promise<void> {
if (await knex.schema.hasTable('testentities')) { if (await knex.schema.hasTable('children')) {
await knex.schema.dropTable('testentities'); await knex.schema.dropTable('children');
}
if (await knex.schema.hasTable('parents')) {
await knex.schema.dropTable('parents');
} }
} }
describe('Entity cache inconsistency', () => { describe('Entity cache inconsistency', () => {
let knexInstance: Knex; let knexInstance: Knex;
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let redisCacheAdapterContext: RedisCacheAdapterContext; let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => { beforeAll(() => {
@@ -112,7 +116,7 @@ describe('Entity cache inconsistency', () => {
}, },
}); });
redisCacheAdapterContext = { redisCacheAdapterContext = {
redisClient, redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string { makeKeyFn(...parts: string[]): string {
const delimiter = ':'; const delimiter = ':';
const escapedParts = parts.map((part) => const escapedParts = parts.map((part) =>
@@ -129,13 +133,13 @@ describe('Entity cache inconsistency', () => {
beforeEach(async () => { beforeEach(async () => {
await createOrTruncatePostgresTables(knexInstance); await createOrTruncatePostgresTables(knexInstance);
await redisClient.flushdb(); await redisCacheAdapterContext.redisClient.flushdb();
}); });
afterAll(async () => { afterAll(async () => {
await dropPostgresTable(knexInstance); await dropPostgresTable(knexInstance);
await knexInstance.destroy(); await knexInstance.destroy();
redisClient.disconnect(); redisCacheAdapterContext.redisClient.disconnect();
}); });
test('lots of updates in long-ish running transactions', async () => { test('lots of updates in long-ish running transactions', async () => {
@@ -10,13 +10,15 @@ import ChildEntity from './entities/ChildEntity';
import ParentEntity from './entities/ParentEntity'; import ParentEntity from './entities/ParentEntity';
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> { async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
await knex.schema.createTable('parents', (table) => { await knex.schema.createTable('parents', (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary(); table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
}); });
await knex.into('parents').truncate(); await knex.into('parents').truncate();
await knex.schema.createTable('children', (table) => { await knex.schema.createTable('children', (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary(); table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
table.uuid('parent_id').references('id').inTable('parents').onDelete('cascade').unique(); table.uuid('parent_id').references('id').inTable('parents').onDelete('cascade').unique();
}); });
await knex.into('children').truncate(); await knex.into('children').truncate();
@@ -33,7 +35,6 @@ async function dropPostgresTable(knex: Knex): Promise<void> {
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => { describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
let knexInstance: Knex; let knexInstance: Knex;
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let redisCacheAdapterContext: RedisCacheAdapterContext; let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => { beforeAll(() => {
@@ -48,7 +49,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
}, },
}); });
redisCacheAdapterContext = { redisCacheAdapterContext = {
redisClient, redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string { makeKeyFn(...parts: string[]): string {
const delimiter = ':'; const delimiter = ':';
const escapedParts = parts.map((part) => const escapedParts = parts.map((part) =>
@@ -65,13 +66,13 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
beforeEach(async () => { beforeEach(async () => {
await createOrTruncatePostgresTables(knexInstance); await createOrTruncatePostgresTables(knexInstance);
await redisClient.flushdb(); await redisCacheAdapterContext.redisClient.flushdb();
}); });
afterAll(async () => { afterAll(async () => {
await dropPostgresTable(knexInstance); await dropPostgresTable(knexInstance);
await knexInstance.destroy(); await knexInstance.destroy();
redisClient.disconnect(); redisCacheAdapterContext.redisClient.disconnect();
}); });
describe('EntityEdgeDeletionBehavior.INVALIDATE_CACHE', () => { describe('EntityEdgeDeletionBehavior.INVALIDATE_CACHE', () => {
@@ -127,46 +127,34 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
privacyPolicyClass: PrivacyPolicy, privacyPolicyClass: PrivacyPolicy,
}); });
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
await knex.schema.createTable(categoriesTableName, (table) => { await knex.schema.createTable(categoriesTableName, (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary(); table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
}); });
await knex.schema.createTable(othersTableName, (table) => { await knex.schema.createTable(othersTableName, (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary(); table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY) { if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
table table
.uuid('parent_category_id') .uuid('parent_category_id')
.references('id') .references('id')
.inTable(categoriesTableName) .inTable(categoriesTableName)
.unique() .unique()
.onDelete('cascade'); .onDelete('cascade');
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
table
.uuid('parent_category_id')
.references('id')
.inTable(categoriesTableName)
.unique()
.onDelete('set null');
} else { } else {
table.uuid('parent_category_id').unique(); table.uuid('parent_category_id').unique();
} }
}); });
await knex.schema.alterTable(categoriesTableName, (table) => { await knex.schema.alterTable(categoriesTableName, (table) => {
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY) { if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
table table
.uuid('parent_other_id') .uuid('parent_other_id')
.references('id') .references('id')
.inTable(othersTableName) .inTable(othersTableName)
.unique() .unique()
.onDelete('cascade'); .onDelete('cascade');
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
table
.uuid('parent_other_id')
.references('id')
.inTable(othersTableName)
.unique()
.onDelete('set null');
} else { } else {
table.uuid('parent_other_id').unique(); table.uuid('parent_other_id').unique();
} }
@@ -176,7 +164,6 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
}; };
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => { describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
let knexInstance: Knex; let knexInstance: Knex;
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let redisCacheAdapterContext: RedisCacheAdapterContext; let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => { beforeAll(() => {
@@ -191,7 +178,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
}, },
}); });
redisCacheAdapterContext = { redisCacheAdapterContext = {
redisClient, redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string { makeKeyFn(...parts: string[]): string {
const delimiter = ':'; const delimiter = ':';
const escapedParts = parts.map((part) => const escapedParts = parts.map((part) =>
@@ -208,14 +195,13 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
afterAll(async () => { afterAll(async () => {
await knexInstance.destroy(); await knexInstance.destroy();
redisClient.disconnect(); redisCacheAdapterContext.redisClient.disconnect();
}); });
it.each([ it.each([
EntityEdgeDeletionBehavior.CASCADE_DELETE, EntityEdgeDeletionBehavior.CASCADE_DELETE,
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY, EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
EntityEdgeDeletionBehavior.SET_NULL, EntityEdgeDeletionBehavior.SET_NULL,
EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY,
])('behavior: %p', async (edgeDeletionBehavior) => { ])('behavior: %p', async (edgeDeletionBehavior) => {
const { CategoryEntity, OtherEntity } = await makeEntityClasses( const { CategoryEntity, OtherEntity } = await makeEntityClasses(
knexInstance, knexInstance,
@@ -244,14 +230,6 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
.enforcing() .enforcing()
.loadByIDNullableAsync(other1.getID()); .loadByIDNullableAsync(other1.getID());
expect(otherLoaded?.getField('parent_category_id')).toBeNull(); expect(otherLoaded?.getField('parent_category_id')).toBeNull();
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
).resolves.toBeNull();
const otherLoaded = await OtherEntity.loader(viewerContext)
.enforcing()
.loadByIDNullableAsync(other1.getID());
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
} else { } else {
await expect( await expect(
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID()) CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
@@ -56,7 +56,7 @@ const childEntityConfiguration = new EntityConfiguration<ChildFields>({
cache: true, cache: true,
association: { association: {
getAssociatedEntityClass: () => ParentEntity, getAssociatedEntityClass: () => ParentEntity,
edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY, edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
}, },
}), }),
}, },
@@ -3,94 +3,6 @@
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.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity-ip-address-field
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity-ip-address-field
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
**Note:** Version bump only for package @expo/entity-ip-address-field
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
**Note:** Version bump only for package @expo/entity-ip-address-field
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
**Note:** Version bump only for package @expo/entity-ip-address-field
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
**Note:** Version bump only for package @expo/entity-ip-address-field
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
**Note:** Version bump only for package @expo/entity-ip-address-field
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
**Note:** Version bump only for package @expo/entity-ip-address-field
## [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.31.1", "version": "0.24.0",
"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.31.1", "@expo/entity": "^0.24.0",
"@types/jsbn": "^1.2.29" "@types/jsbn": "^1.2.29"
}, },
"peerDependencies": { "peerDependencies": {
@@ -1,91 +0,0 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
## [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))
@@ -1,24 +0,0 @@
# `@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]);
```
@@ -1,38 +0,0 @@
{
"name": "@expo/entity-secondary-cache-local-memory",
"version": "0.31.1",
"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.31.1",
"@expo/entity-cache-adapter-local-memory": "^0.31.1",
"nullthrows": "^1.1.1"
}
}
@@ -1,21 +0,0 @@
import { GenericSecondaryEntityCache } from '@expo/entity';
import {
GenericLocalMemoryCacher,
LocalMemoryCache,
} from '@expo/entity-cache-adapter-local-memory';
/**
* A local memory 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));
}
}
@@ -1,228 +0,0 @@
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
.enforcing()
.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);
});
});
@@ -1,7 +0,0 @@
/* eslint-disable tsdoc/syntax */
/**
* @packageDocumentation
* @module @expo/entity-secondary-cache-local-memory
*/
export { default as LocalMemorySecondaryEntityCache } from './LocalMemorySecondaryEntityCache';
@@ -1,7 +0,0 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"outDir": "build",
},
"include": ["src"]
}
@@ -3,103 +3,6 @@
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.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
### Features
* change redis cache adapter to use redis-like interface ([#200](https://github.com/expo/entity/issues/200)) ([e381f5b](https://github.com/expo/entity/commit/e381f5b2acfc17dcade2cf6e8506fa1c1c255e73))
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
### Features
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
## [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.31.1", "version": "0.24.0",
"description": "Redis secondary cache for @expo/entity", "description": "Redis secondary cache for @expo/entity",
"files": [ "files": [
"build", "build",
@@ -30,10 +30,12 @@
"@expo/entity": "*", "@expo/entity": "*",
"@expo/entity-cache-adapter-redis": "*" "@expo/entity-cache-adapter-redis": "*"
}, },
"dependencies": {
"ioredis": "^4.17.3"
},
"devDependencies": { "devDependencies": {
"@expo/entity": "^0.31.1", "@expo/entity": "^0.24.0",
"@expo/entity-cache-adapter-redis": "^0.31.1", "@expo/entity-cache-adapter-redis": "^0.24.0",
"ioredis": "^5.2.5",
"nullthrows": "^1.1.1" "nullthrows": "^1.1.1"
} }
} }
@@ -2,7 +2,9 @@ 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 redis GenericSecondaryEntityCache. * A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
* single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
* a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
*/ */
export default class RedisSecondaryEntityCache< export default class RedisSecondaryEntityCache<
TFields, TFields,
@@ -52,12 +52,11 @@ class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
} }
describe(RedisSecondaryEntityCache, () => { describe(RedisSecondaryEntityCache, () => {
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let redisCacheAdapterContext: RedisCacheAdapterContext; let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => { beforeAll(() => {
redisCacheAdapterContext = { redisCacheAdapterContext = {
redisClient, redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(..._parts: string[]): string { makeKeyFn(..._parts: string[]): string {
throw new Error('should not be used by this test'); throw new Error('should not be used by this test');
}, },
@@ -69,10 +68,10 @@ describe(RedisSecondaryEntityCache, () => {
}); });
beforeEach(async () => { beforeEach(async () => {
await redisClient.flushdb(); await redisCacheAdapterContext.redisClient.flushdb();
}); });
afterAll(async () => { afterAll(async () => {
redisClient.disconnect(); redisCacheAdapterContext.redisClient.disconnect();
}); });
it('Loads through secondary loader, caches, and invalidates', async () => { it('Loads through secondary loader, caches, and invalidates', async () => {
-108
View File
@@ -3,114 +3,6 @@
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.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
**Note:** Version bump only for package @expo/entity
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
**Note:** Version bump only for package @expo/entity
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
**Note:** Version bump only for package @expo/entity
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
### Features
* add BigIntField ([#193](https://github.com/expo/entity/issues/193)) ([acbad82](https://github.com/expo/entity/commit/acbad826a37bb5a054b4dcf9be91d11aa5f7f29a))
* nested transactions ([#194](https://github.com/expo/entity/issues/194)) ([a77b914](https://github.com/expo/entity/commit/a77b914ad6dc018d1e309c9caf4971088a553ecf))
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
### Features
* add orderByRaw to loadManyByRawWhereClauseAsync ([#185](https://github.com/expo/entity/issues/185)) ([2817d78](https://github.com/expo/entity/commit/2817d78392dfecd0093111c24d581bdf01dba06d))
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
### Features
* recache to higher cache levels when loading from a composed cache ([#182](https://github.com/expo/entity/pull/182))
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
### Features
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
**Note:** Version bump only for package @expo/entity
## [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.31.1", "version": "0.24.0",
"description": "A privacy-first data model", "description": "A privacy-first data model",
"files": [ "files": [
"build", "build",
@@ -1,127 +0,0 @@
import nullthrows from 'nullthrows';
import EntityCacheAdapter from './EntityCacheAdapter';
import EntityConfiguration from './EntityConfiguration';
import { CacheStatus, CacheLoadResult } from './internal/ReadThroughEntityCache';
/**
* A EntityCacheAdapter that composes other EntityCacheAdapter instances.
*/
export default class ComposedEntityCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
/**
* @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.
* A lower layer cache is closer to the database, while a higher layer cache is closer to the application.
*/
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>>();
const fulfilledFieldValuesByCacheIndex: NonNullable<TFields[N]>[][] = Array.from(
{ length: this.cacheAdapters.length },
() => []
);
let unfulfilledFieldValues = fieldValues;
for (let i = 0; i < this.cacheAdapters.length; i++) {
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
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);
nullthrows(fulfilledFieldValuesByCacheIndex[i]).push(fieldValue);
}
}
unfulfilledFieldValues = newUnfulfilledFieldValues;
if (unfulfilledFieldValues.length === 0) {
break;
}
}
// Recache values from lower layers that were not found in higher layers
// Write to lower layers first
for (let i = this.cacheAdapters.length - 1; i >= 0; i--) {
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
const hitsToCache = new Map<NonNullable<TFields[N]>, Readonly<TFields>>();
const negativesToCache: NonNullable<TFields[N]>[] = [];
// Loop over all lower layer caches to collect hits and misses
for (let j = i + 1; j < this.cacheAdapters.length; j++) {
const fulfilledFieldValues = nullthrows(fulfilledFieldValuesByCacheIndex[j]);
fulfilledFieldValues.forEach((fieldValue) => {
const cacheResult = nullthrows(retMap.get(fieldValue));
if (cacheResult.status === CacheStatus.HIT) {
hitsToCache.set(fieldValue, cacheResult.item);
} else if (cacheResult.status === CacheStatus.NEGATIVE) {
negativesToCache.push(fieldValue);
}
});
}
const promises = [];
if (hitsToCache.size > 0) {
promises.push(cacheAdapter.cacheManyAsync(fieldName, hitsToCache));
}
if (negativesToCache.length > 0) {
promises.push(cacheAdapter.cacheDBMissesAsync(fieldName, negativesToCache));
}
await Promise.all(promises);
}
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);
}
}
}
@@ -1,64 +0,0 @@
import nullthrows from 'nullthrows';
import { ISecondaryEntityCache } from './EntitySecondaryCacheLoader';
/**
* A ISecondaryEntityCache that composes other ISecondaryEntityCache instances.
*/
export default class ComposedSecondaryEntityCache<TLoadParams, TFields>
implements ISecondaryEntityCache<TFields, TLoadParams>
{
/**
* @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);
}
}
}
+10 -30
View File
@@ -1,8 +1,4 @@
import { import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
FieldEqualityCondition,
QuerySelectionModifiers,
QuerySelectionModifiersWithOrderByRaw,
} from './EntityDatabaseAdapter';
import EntityLoader from './EntityLoader'; import EntityLoader from './EntityLoader';
import EntityPrivacyPolicy from './EntityPrivacyPolicy'; import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import ReadonlyEntity from './ReadonlyEntity'; import ReadonlyEntity from './ReadonlyEntity';
@@ -40,7 +36,7 @@ export default class EnforcingEntityLoader<
/** /**
* Enforcing version of entity loader method by the same name. * Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities * @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>>( async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N, fieldName: N,
@@ -57,7 +53,7 @@ export default class EnforcingEntityLoader<
/** /**
* Enforcing version of entity loader method by the same name. * Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities * @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>>( async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldName: N, fieldName: N,
@@ -72,7 +68,7 @@ export default class EnforcingEntityLoader<
/** /**
* Enforcing version of entity loader method by the same name. * Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view the returned entity * @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
* @throws when multiple entities are found matching the condition * @throws when multiple entities are found matching the condition
*/ */
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>( async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
@@ -88,7 +84,7 @@ export default class EnforcingEntityLoader<
/** /**
* Enforcing version of entity loader method by the same name. * Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view the returned entity * @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
*/ */
async loadByIDAsync(id: TID): Promise<TEntity> { async loadByIDAsync(id: TID): Promise<TEntity> {
const entityResult = await this.entityLoader.loadByIDAsync(id); const entityResult = await this.entityLoader.loadByIDAsync(id);
@@ -97,7 +93,7 @@ export default class EnforcingEntityLoader<
/** /**
* Enforcing version of entity loader method by the same name. * Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view the returned entity * @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
* @throws when multiple entities are found matching the condition * @throws when multiple entities are found matching the condition
*/ */
async loadByIDNullableAsync(id: TID): Promise<TEntity | null> { async loadByIDNullableAsync(id: TID): Promise<TEntity | null> {
@@ -107,7 +103,7 @@ export default class EnforcingEntityLoader<
/** /**
* Enforcing version of entity loader method by the same name. * Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities * @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>> { async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, TEntity>> {
const entityResults = await this.entityLoader.loadManyByIDsAsync(ids); const entityResults = await this.entityLoader.loadManyByIDsAsync(ids);
@@ -116,23 +112,7 @@ export default class EnforcingEntityLoader<
/** /**
* Enforcing version of entity loader method by the same name. * Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities * @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
*/
async loadFirstByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
querySelectionModifiers: Omit<QuerySelectionModifiers<TFields>, 'limit'> &
Required<Pick<QuerySelectionModifiers<TFields>, 'orderBy'>>
): Promise<TEntity | null> {
const entityResult = await this.entityLoader.loadFirstByFieldEqualityConjunctionAsync(
fieldEqualityOperands,
querySelectionModifiers
);
return entityResult ? entityResult.enforceValue() : null;
}
/**
* Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
*/ */
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>( async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[], fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
@@ -147,12 +127,12 @@ export default class EnforcingEntityLoader<
/** /**
* Enforcing version of entity loader method by the same name. * Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities * @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
*/ */
async loadManyByRawWhereClauseAsync( async loadManyByRawWhereClauseAsync(
rawWhereClause: string, rawWhereClause: string,
bindings: any[] | object, bindings: any[] | object,
querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields> = {} querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly TEntity[]> { ): Promise<readonly TEntity[]> {
const entityResults = await this.entityLoader.loadManyByRawWhereClauseAsync( const entityResults = await this.entityLoader.loadManyByRawWhereClauseAsync(
rawWhereClause, rawWhereClause,
+5 -7
View File
@@ -11,19 +11,19 @@ import ViewerContext from './ViewerContext';
* Entity is a privacy-first data model. * Entity is a privacy-first data model.
* *
* A instance of an entity represents a single "row" of persisted data in a database that a * A instance of an entity represents a single "row" of persisted data in a database that a
* viewer, represented by the corresponding ViewerContext, has permission to read. * viewer, represented by the corresponding {@link ViewerContext}, has permission to read.
* *
* Create, read, update, and delete permissions for an entity are declaratively defined using an * Create, read, update, and delete permissions for an entity are declaratively defined using an
* EntityPrivacyPolicy. * {@link EntityPrivacyPolicy}.
* *
* Entites are loaded through an EntityLoader, which is responsible for * Entites are loaded through an {@link EntityLoader}, which is responsible for
* orchestrating fetching, caching, and authorization of reading "rows". * orchestrating fetching, caching, and authorization of reading "rows".
* *
* Entities are mutated and deleted through an EntityMutator, which is responsible for * Entities are mutated and deleted through an {@link EntityMutator}, which is responsible for
* orchestrating database writes, cache invalidation, and authorization of writing "rows". * orchestrating database writes, cache invalidation, and authorization of writing "rows".
* *
* All concrete entity implementations should extend this class and provide their * All concrete entity implementations should extend this class and provide their
* own EntityCompanionDefinition. * own {@link EntityCompanionDefinition}.
*/ */
export default abstract class Entity< export default abstract class Entity<
TFields, TFields,
@@ -251,7 +251,6 @@ export default abstract class Entity<
privacyPolicy.authorizeUpdateAsync( privacyPolicy.authorizeUpdateAsync(
existingEntity.getViewerContext(), existingEntity.getViewerContext(),
queryContext, queryContext,
{ cascadingDeleteCause: null },
existingEntity, existingEntity,
companion.getMetricsAdapter() companion.getMetricsAdapter()
) )
@@ -305,7 +304,6 @@ export default abstract class Entity<
privacyPolicy.authorizeDeleteAsync( privacyPolicy.authorizeDeleteAsync(
existingEntity.getViewerContext(), existingEntity.getViewerContext(),
queryContext, queryContext,
{ cascadingDeleteCause: null },
existingEntity, existingEntity,
companion.getMetricsAdapter() companion.getMetricsAdapter()
) )
+8 -13
View File
@@ -6,11 +6,6 @@ import { EntityQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity'; import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
/**
* An association loader is a set of convenience methods for loading entities
* associated with an entity. In relational databases, these entities are often referenced
* by foreign keys.
*/
export default class EntityAssociationLoader< export default class EntityAssociationLoader<
TFields, TFields,
TID extends NonNullable<TFields[TSelectedFields]>, TID extends NonNullable<TFields[TSelectedFields]>,
@@ -74,7 +69,7 @@ export default class EntityAssociationLoader<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass) .getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext, { cascadingDeleteCause: null }); .forLoad(queryContext);
return (await loader.loadByIDAsync(associatedEntityID as unknown as TAssociatedID)) as Result< return (await loader.loadByIDAsync(associatedEntityID as unknown as TAssociatedID)) as Result<
null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity
@@ -128,7 +123,7 @@ export default class EntityAssociationLoader<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass) .getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext, { cascadingDeleteCause: null }); .forLoad(queryContext);
return await loader.loadManyByFieldEqualingAsync( return await loader.loadManyByFieldEqualingAsync(
associatedEntityFieldContainingThisID, associatedEntityFieldContainingThisID,
thisID as any thisID as any
@@ -185,7 +180,7 @@ export default class EntityAssociationLoader<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass) .getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext, { cascadingDeleteCause: null }); .forLoad(queryContext);
return await loader.loadByFieldEqualingAsync( return await loader.loadByFieldEqualingAsync(
associatedEntityLookupByField, associatedEntityLookupByField,
associatedFieldValue as any associatedFieldValue as any
@@ -243,7 +238,7 @@ export default class EntityAssociationLoader<
.getViewerContext() .getViewerContext()
.getViewerScopedEntityCompanionForClass(associatedEntityClass) .getViewerScopedEntityCompanionForClass(associatedEntityClass)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext, { cascadingDeleteCause: null }); .forLoad(queryContext);
return await loader.loadManyByFieldEqualingAsync( return await loader.loadManyByFieldEqualingAsync(
associatedEntityLookupByField, associatedEntityLookupByField,
associatedFieldValue as any associatedFieldValue as any
@@ -251,7 +246,7 @@ export default class EntityAssociationLoader<
} }
/** /**
* Load an associated entity by folding a sequence of EntityLoadThroughDirective. At each * Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
* fold step, load an associated entity identified by a field value of the current fold value. * fold step, load an associated entity identified by a field value of the current fold value.
* @param loadDirectives - associated entity load directives instructing each step of the fold * @param loadDirectives - associated entity load directives instructing each step of the fold
* @param queryContext - query context in which to perform the loads * @param queryContext - query context in which to perform the loads
@@ -285,7 +280,7 @@ export default class EntityAssociationLoader<
): Promise<Result<TEntity2> | null>; ): Promise<Result<TEntity2> | null>;
/** /**
* Load an associated entity by folding a sequence of EntityLoadThroughDirective. At each * Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
* fold step, load an associated entity identified by a field value of the current fold value. * fold step, load an associated entity identified by a field value of the current fold value.
* @param loadDirectives - associated entity load directives instructing each step of the fold * @param loadDirectives - associated entity load directives instructing each step of the fold
* @param queryContext - query context in which to perform the loads * @param queryContext - query context in which to perform the loads
@@ -340,7 +335,7 @@ export default class EntityAssociationLoader<
): Promise<Result<TEntity3> | null>; ): Promise<Result<TEntity3> | null>;
/** /**
* Load an associated entity by folding a sequence of EntityLoadThroughDirective. At each * Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
* fold step, load an associated entity identified by a field value of the current fold value. * fold step, load an associated entity identified by a field value of the current fold value.
* @param loadDirectives - associated entity load directives instructing each step of the fold * @param loadDirectives - associated entity load directives instructing each step of the fold
* @param queryContext - query context in which to perform the loads * @param queryContext - query context in which to perform the loads
@@ -416,7 +411,7 @@ export default class EntityAssociationLoader<
): Promise<Result<TEntity4> | null>; ): Promise<Result<TEntity4> | null>;
/** /**
* Load an associated entity by folding a sequence of EntityLoadThroughDirective. At each * Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
* fold step, load an associated entity identified by a field value of the current fold value. * fold step, load an associated entity identified by a field value of the current fold value.
* @param loadDirectives - associated entity load directives instructing each step of the fold * @param loadDirectives - associated entity load directives instructing each step of the fold
* @param queryContext - query context in which to perform the loads * @param queryContext - query context in which to perform the loads
+1 -1
View File
@@ -32,7 +32,7 @@ export default abstract class EntityCacheAdapter<TFields> {
/** /**
* Negatively cache objects that could not be found in the cache or DB. * Negatively cache objects that could not be found in the cache or DB.
* @param fieldName - object field being queried * @param fieldName - object field being queried
* @param fieldValues - fieldValues for objects reported as CacheStatus.NEGATIVE * @param fieldValues - fieldValues for objects reported as {@link CacheStatus.NEGATIVE}
* in the cache and not found in the DB. * in the cache and not found in the DB.
*/ */
public abstract cacheDBMissesAsync<N extends keyof TFields>( public abstract cacheDBMissesAsync<N extends keyof TFields>(
+1 -1
View File
@@ -132,7 +132,7 @@ export default class EntityCompanion<
} }
/** /**
* Get the IEntityMetricsAdapter for this companion. * Get the {@link IEntityMetricsAdapter} for this companion.
*/ */
getMetricsAdapter(): IEntityMetricsAdapter { getMetricsAdapter(): IEntityMetricsAdapter {
return this.metricsAdapter; return this.metricsAdapter;
@@ -109,15 +109,15 @@ export class EntityCompanionDefinition<
TSelectedFields TSelectedFields
>; >;
/** /**
* The EntityConfiguration for this entity. * The {@link EntityConfiguration} for this entity.
*/ */
entityConfiguration: EntityConfiguration<TFields>; entityConfiguration: EntityConfiguration<TFields>;
/** /**
* The EntityPrivacyPolicy class for this entity. * The {@link EntityPrivacyPolicy} class for this entity.
*/ */
privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>; privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
/** /**
* An optional list of EntityMutationValidator for this entity. * An optional list of {@link EntityMutationValidator} for this entity.
*/ */
mutationValidators?: () => EntityMutationValidator< mutationValidators?: () => EntityMutationValidator<
TFields, TFields,
@@ -127,7 +127,7 @@ export class EntityCompanionDefinition<
TSelectedFields TSelectedFields
>[]; >[];
/** /**
* An optional list of EntityMutationTrigger for this entity. * An optional list of {@link EntityMutationTrigger} for this entity.
*/ */
mutationTriggers?: () => EntityMutationTriggerConfiguration< mutationTriggers?: () => EntityMutationTriggerConfiguration<
TFields, TFields,
@@ -137,8 +137,8 @@ export class EntityCompanionDefinition<
TSelectedFields TSelectedFields
>; >;
/** /**
* An optional subset of fields defined in the EntityConfiguration which belong to this entity. * An optional subset of fields defined in the {@link EntityConfiguration} which belong to this entity.
* For use when multiple types of entities are backed by a single table (EntityConfiguration) yet * For use when multiple types of entities are backed by a single table ({@link EntityConfiguration}) yet
* only expose a subset of the fields. * only expose a subset of the fields.
*/ */
entitySelectedFields?: TSelectedFields[]; entitySelectedFields?: TSelectedFields[];
@@ -155,11 +155,11 @@ export class EntityCompanionDefinition<
/** /**
* An instance of the Entity framework. * An instance of the Entity framework.
* *
* Required to create a ViewerContext, which is the application entry point * Required to create a {@link ViewerContext}, which is the application entry point
* into the framework. * into the framework.
* *
* Internally, this is a lazy entity companion factory that instantiates and caches one * Internally, this is a lazy entity companion factory that instantiates and caches one
* EntityCompanion for each type of Entity. * {@link EntityCompanion} for each type of {@link Entity}.
*/ */
export default class EntityCompanionProvider { export default class EntityCompanionProvider {
private readonly companionMap: Map<string, EntityCompanion<any, any, any, any, any, any>> = private readonly companionMap: Map<string, EntityCompanion<any, any, any, any, any, any>> =
@@ -169,7 +169,7 @@ export default class EntityCompanionProvider {
/** /**
* Instantiate an Entity framework. * Instantiate an Entity framework.
* @param metricsAdapter - An IEntityMetricsAdapter for collecting metrics on this instance * @param metricsAdapter - An {@link IEntityMetricsAdapter} for collecting metrics on this instance
* @param databaseAdapterFlavors - Database adapter configurations for this instance * @param databaseAdapterFlavors - Database adapter configurations for this instance
* @param cacheAdapterFlavors - Cache adapter configurations for this instance * @param cacheAdapterFlavors - Cache adapter configurations for this instance
*/ */
+2 -2
View File
@@ -41,12 +41,12 @@ export default class EntityConfiguration<TFields> {
tableName: string; tableName: string;
/** /**
* Map from each entity field to an EntityFieldDefinition specifying information about the field. * Map from each entity field to an {@link EntityFieldDefinition} specifying information about the field.
*/ */
schema: Record<keyof TFields, EntityFieldDefinition<any>>; schema: Record<keyof TFields, EntityFieldDefinition<any>>;
/** /**
* List of other entity types that reference this type in EntityFieldDefinition associations. * List of other entity types that reference this type in {@link EntityFieldDefinition} associations.
*/ */
getInboundEdges?: () => IEntityClass<any, any, any, any, any, any>[]; getInboundEdges?: () => IEntityClass<any, any, any, any, any, any>[];
+6 -43
View File
@@ -7,32 +7,16 @@ import {
FieldTransformerMap, FieldTransformerMap,
} from './internal/EntityFieldTransformationUtils'; } from './internal/EntityFieldTransformationUtils';
/** interface SingleValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
* Equality operand that is used for selecting entities with a field with a single value.
*/
export interface SingleValueFieldEqualityCondition<
TFields,
N extends keyof TFields = keyof TFields
> {
fieldName: N; fieldName: N;
fieldValue: TFields[N]; fieldValue: TFields[N];
} }
/** interface MultiValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
* Equality operand that is used for selecting entities with a field matching one of multiple values.
*/
export interface MultiValueFieldEqualityCondition<
TFields,
N extends keyof TFields = keyof TFields
> {
fieldName: N; fieldName: N;
fieldValues: readonly TFields[N][]; fieldValues: readonly TFields[N][];
} }
/**
* A single equality operand for use in a selection clause.
* See EntityLoader.loadManyByFieldEqualityConjunctionAsync documentation for examples.
*/
export type FieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> = export type FieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> =
| SingleValueFieldEqualityCondition<TFields, N> | SingleValueFieldEqualityCondition<TFields, N>
| MultiValueFieldEqualityCondition<TFields, N>; | MultiValueFieldEqualityCondition<TFields, N>;
@@ -84,14 +68,6 @@ export interface QuerySelectionModifiers<TFields> {
limit?: number; limit?: number;
} }
export interface QuerySelectionModifiersWithOrderByRaw<TFields>
extends QuerySelectionModifiers<TFields> {
/**
* Order the entities by a raw SQL `ORDER BY` clause.
*/
orderByRaw?: string;
}
export interface TableQuerySelectionModifiers { export interface TableQuerySelectionModifiers {
orderBy: orderBy:
| { | {
@@ -103,10 +79,6 @@ export interface TableQuerySelectionModifiers {
limit: number | undefined; limit: number | undefined;
} }
export interface TableQuerySelectionModifiersWithOrderByRaw extends TableQuerySelectionModifiers {
orderByRaw: string | undefined;
}
/** /**
* A database adapter is an interface by which entity objects can be * A database adapter is an interface by which entity objects can be
* fetched, inserted, updated, and deleted from a database. This base class * fetched, inserted, updated, and deleted from a database. This base class
@@ -177,7 +149,7 @@ export default abstract class EntityDatabaseAdapter<TFields> {
* *
* @param queryContext - query context with which to perform the fetch * @param queryContext - query context with which to perform the fetch
* @param fieldEqualityOperands - list of field equality where clause operand specifications * @param fieldEqualityOperands - list of field equality where clause operand specifications
* @param querySelectionModifiers - limit, offset, orderBy, and orderByRaw for the query * @param querySelectionModifiers - limit, offset, and orderBy for the query
* @returns array of objects matching the query * @returns array of objects matching the query
*/ */
async fetchManyByFieldEqualityConjunctionAsync<N extends keyof TFields>( async fetchManyByFieldEqualityConjunctionAsync<N extends keyof TFields>(
@@ -235,14 +207,14 @@ export default abstract class EntityDatabaseAdapter<TFields> {
queryContext: EntityQueryContext, queryContext: EntityQueryContext,
rawWhereClause: string, rawWhereClause: string,
bindings: any[] | object, bindings: any[] | object,
querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields> querySelectionModifiers: QuerySelectionModifiers<TFields>
): Promise<readonly Readonly<TFields>[]> { ): Promise<readonly Readonly<TFields>[]> {
const results = await this.fetchManyByRawWhereClauseInternalAsync( const results = await this.fetchManyByRawWhereClauseInternalAsync(
queryContext.getQueryInterface(), queryContext.getQueryInterface(),
this.entityConfiguration.tableName, this.entityConfiguration.tableName,
rawWhereClause, rawWhereClause,
bindings, bindings,
this.convertToTableQueryModifiersWithOrderByRaw(querySelectionModifiers) this.convertToTableQueryModifiers(querySelectionModifiers)
); );
return results.map((result) => return results.map((result) =>
@@ -255,7 +227,7 @@ export default abstract class EntityDatabaseAdapter<TFields> {
tableName: string, tableName: string,
rawWhereClause: string, rawWhereClause: string,
bindings: any[] | object, bindings: any[] | object,
querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw querySelectionModifiers: TableQuerySelectionModifiers
): Promise<object[]>; ): Promise<object[]>;
/** /**
@@ -391,15 +363,6 @@ export default abstract class EntityDatabaseAdapter<TFields> {
id: any id: any
): Promise<number>; ): Promise<number>;
private convertToTableQueryModifiersWithOrderByRaw(
querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields>
): TableQuerySelectionModifiersWithOrderByRaw {
return {
...this.convertToTableQueryModifiers(querySelectionModifiers),
orderByRaw: querySelectionModifiers.orderByRaw,
};
}
private convertToTableQueryModifiers( private convertToTableQueryModifiers(
querySelectionModifiers: QuerySelectionModifiers<TFields> querySelectionModifiers: QuerySelectionModifiers<TFields>
): TableQuerySelectionModifiers { ): TableQuerySelectionModifiers {
+6 -15
View File
@@ -5,21 +5,13 @@ import ViewerContext from './ViewerContext';
export enum EntityEdgeDeletionBehavior { export enum EntityEdgeDeletionBehavior {
/** /**
* Invalidate the cache for all entities that reference the entity * Default. Invalidate the cache for all entities that reference the entity
* being deleted through this field, and transitively run deletions on those entities. * being deleted through this field, and transitively run deletions on those entities.
* This is most useful when the database itself expresses foreign * This is most useful when the database itself expresses foreign
* keys and cascading deletes and the entity framework just needs to * keys and cascading deletes or set nulls and the entity framework just needs to
* be kept consistent with the state of the database. * be kept consistent with the state of the database.
*/ */
CASCADE_DELETE_INVALIDATE_CACHE_ONLY, CASCADE_DELETE_INVALIDATE_CACHE,
/**
* Invalidate the cache for all entities that reference the entity
* being deleted through this field. This is most useful when the database itself expresses
* foreign keys and cascading "SET NULL"s and the entity framework just needs to be
* kept consistent with the state of the database.
*/
SET_NULL_INVALIDATE_CACHE_ONLY,
/** /**
* Delete all entities that reference the entity being deleted through this field. This is very similar * Delete all entities that reference the entity being deleted through this field. This is very similar
@@ -82,17 +74,16 @@ export interface EntityAssociationDefinition<
* *
* @remarks * @remarks
* The entity framework doesn't prescribe a one-size-fits-all solution for referential * The entity framework doesn't prescribe a one-size-fits-all solution for referential
* integrity; instead it exposes mechanisms that support both database foreign key constraints * integrity; instead it exposes mechanisms that supports both database foreign key constraints
* and implicit entity-specified foreign keys. Choosing which approach to use often depends on * and implicit entity-specified foreign keys. Choosing which approach to use often depends on
* application requirements, and sometimes even a mix-and-match is the right choice. * application requirements, and sometimes even a mix-and-match is the right choice.
* *
* - If referential integrity is critical to your application, database foreign key constraints * - If referential integrity is critical to your application, database foreign key constraints
* combined with EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY or * combined with {@link EntityEdgeDeletionBehavior.CASACDE_DELETE_INVALIDATE_CACHE} are recommended.
* EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY are recommended.
* - If the database being used doesn't support foreign keys, then using the entity framework for referential * - If the database being used doesn't support foreign keys, then using the entity framework for referential
* integrity is recommended. * integrity is recommended.
*/ */
edgeDeletionBehavior: EntityEdgeDeletionBehavior; edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
} }
/** /**
+28 -9
View File
@@ -3,7 +3,7 @@ import { validate as validateUUID } from 'uuid';
import { EntityFieldDefinition } from './EntityFieldDefinition'; import { EntityFieldDefinition } from './EntityFieldDefinition';
/** /**
* EntityFieldDefinition for a column with a JS string type. * {@link EntityFieldDefinition} for a column with a JS string type.
*/ */
export class StringField extends EntityFieldDefinition<string> { export class StringField extends EntityFieldDefinition<string> {
protected validateInputValueInternal(value: string): boolean { protected validateInputValueInternal(value: string): boolean {
@@ -12,7 +12,7 @@ export class StringField extends EntityFieldDefinition<string> {
} }
/** /**
* EntityFieldDefinition for a column with a JS string type. * {@link EntityFieldDefinition} for a column with a JS string type.
* Enforces that the string is a valid UUID. * Enforces that the string is a valid UUID.
*/ */
export class UUIDField extends StringField { export class UUIDField extends StringField {
@@ -22,7 +22,7 @@ export class UUIDField extends StringField {
} }
/** /**
* EntityFieldDefinition for a column with a JS Date type. * {@link EntityFieldDefinition} for a column with a JS Date type.
*/ */
export class DateField extends EntityFieldDefinition<Date> { export class DateField extends EntityFieldDefinition<Date> {
protected validateInputValueInternal(value: Date): boolean { protected validateInputValueInternal(value: Date): boolean {
@@ -31,7 +31,7 @@ export class DateField extends EntityFieldDefinition<Date> {
} }
/** /**
* EntityFieldDefinition for a column with a JS boolean type. * {@link EntityFieldDefinition} for a column with a JS boolean type.
*/ */
export class BooleanField extends EntityFieldDefinition<boolean> { export class BooleanField extends EntityFieldDefinition<boolean> {
protected validateInputValueInternal(value: boolean): boolean { protected validateInputValueInternal(value: boolean): boolean {
@@ -40,7 +40,7 @@ export class BooleanField extends EntityFieldDefinition<boolean> {
} }
/** /**
* EntityFieldDefinition for a column with a JS number type. * {@link EntityFieldDefinition} for a column with a JS number type.
* Enforces that the number is an integer. * Enforces that the number is an integer.
*/ */
export class IntField extends EntityFieldDefinition<number> { export class IntField extends EntityFieldDefinition<number> {
@@ -50,7 +50,7 @@ export class IntField extends EntityFieldDefinition<number> {
} }
/** /**
* EntityFieldDefinition for a column with a JS number type. * {@link EntityFieldDefinition} for a column with a JS number type.
* Enforces that the number is a float (which includes integers in JS). * Enforces that the number is a float (which includes integers in JS).
*/ */
export class FloatField extends EntityFieldDefinition<number> { export class FloatField extends EntityFieldDefinition<number> {
@@ -60,7 +60,7 @@ export class FloatField extends EntityFieldDefinition<number> {
} }
/** /**
* EntityFieldDefinition for a column with a JS string array type. * {@link EntityFieldDefinition} for a column with a JS string array type.
* Enforces that every member of the string array is a string. * Enforces that every member of the string array is a string.
*/ */
export class StringArrayField extends EntityFieldDefinition<string[]> { export class StringArrayField extends EntityFieldDefinition<string[]> {
@@ -70,7 +70,7 @@ export class StringArrayField extends EntityFieldDefinition<string[]> {
} }
/** /**
* EntityFieldDefinition for a column with a JS JSON object type. * {@link EntityFieldDefinition} for a column with a JS JSON object type.
*/ */
export class JSONObjectField extends EntityFieldDefinition<object> { export class JSONObjectField extends EntityFieldDefinition<object> {
protected validateInputValueInternal(value: object): boolean { protected validateInputValueInternal(value: object): boolean {
@@ -79,10 +79,29 @@ export class JSONObjectField extends EntityFieldDefinition<object> {
} }
/** /**
* EntityFieldDefinition for a enum column with a JS string or number type. * {@link EntityFieldDefinition} for a enum column with a JS string or number type.
*/ */
export class EnumField extends EntityFieldDefinition<string | number> { export class EnumField extends EntityFieldDefinition<string | number> {
protected validateInputValueInternal(value: string | number): boolean { protected validateInputValueInternal(value: string | number): boolean {
return typeof value === 'number' || typeof value === 'string'; return typeof value === 'number' || typeof value === 'string';
} }
} }
/**
* {@link EntityFieldDefinition} for a column with a JS JSON array type.
*/
export class JSONArrayField extends EntityFieldDefinition<any[]> {
protected validateInputValueInternal(value: any[]): boolean {
return Array.isArray(value);
}
}
/**
* {@link EntityFieldDefinition} for a column that may be a JS JSON array type.
* Does not do any validation.
*/
export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
protected validateInputValueInternal(_value: any): boolean {
return true;
}
}
+12 -45
View File
@@ -8,9 +8,8 @@ import {
FieldEqualityCondition, FieldEqualityCondition,
QuerySelectionModifiers, QuerySelectionModifiers,
isSingleValueFieldEqualityCondition, isSingleValueFieldEqualityCondition,
QuerySelectionModifiersWithOrderByRaw,
} from './EntityDatabaseAdapter'; } from './EntityDatabaseAdapter';
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy'; import EntityPrivacyPolicy 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';
@@ -22,7 +21,7 @@ import { mapMap, mapMapAsync } 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,
* cached, and authorized against the entity's EntityPrivacyPolicy. * cached, and authorized against the entity's {@link EntityPrivacyPolicy}.
*/ */
export default class EntityLoader< export default class EntityLoader<
TFields, TFields,
@@ -41,7 +40,6 @@ export default class EntityLoader<
constructor( constructor(
private readonly viewerContext: TViewerContext, private readonly viewerContext: TViewerContext,
private readonly queryContext: EntityQueryContext, private readonly queryContext: EntityQueryContext,
private readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
private readonly entityConfiguration: EntityConfiguration<TFields>, private readonly entityConfiguration: EntityConfiguration<TFields>,
private readonly entityClass: IEntityClass< private readonly entityClass: IEntityClass<
TFields, TFields,
@@ -127,9 +125,7 @@ export default class EntityLoader<
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue); const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue);
invariant( invariant(
entityResults.length <= 1, entityResults.length <= 1,
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${String( `loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${uniqueFieldName}=${fieldValue}`
uniqueFieldName
)}=${fieldValue}`
); );
return entityResults[0] ?? null; return entityResults[0] ?? null;
} }
@@ -183,42 +179,16 @@ export default class EntityLoader<
} }
/** /**
* Loads the first entity matching the selection constructed from the conjunction of specified * Loads many entities matching the conjunction of WHERE clauses constructed from specified operands.
* operands, or null if no matching entity exists. Entities loaded using this method are not
* batched or cached.
*
* This is a convenience method for {@link loadManyByFieldEqualityConjunctionAsync}. However, the
* `orderBy` option must be specified to define what "first" means. If ordering doesn't matter,
* explicitly pass in an empty array.
*
* @param fieldEqualityOperands - list of field equality selection operand specifications
* @param querySelectionModifiers - orderBy and optional offset for the query
* @returns the first entity results that matches the query, where result error can be
* UnauthorizedError
*/
async loadFirstByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
querySelectionModifiers: Omit<QuerySelectionModifiers<TFields>, 'limit'> &
Required<Pick<QuerySelectionModifiers<TFields>, 'orderBy'>>
): Promise<Result<TEntity> | null> {
const results = await this.loadManyByFieldEqualityConjunctionAsync(fieldEqualityOperands, {
...querySelectionModifiers,
limit: 1,
});
return results[0] ?? null;
}
/**
* Loads many entities matching the selection constructed from the conjunction of specified operands.
* Entities loaded using this method are not batched or cached. * Entities loaded using this method are not batched or cached.
* *
* @example * @example
* fieldEqualityOperands: * fieldEqualityOperands:
* `[{fieldName: 'hello', fieldValue: 1}, {fieldName: 'world', fieldValues: [2, 3]}]` * `[{fieldName: 'hello', fieldValue: 1}, {fieldName: 'world', fieldValues: [2, 3]}]`
* Entities returned with a SQL EntityDatabaseAdapter: * Entities returned:
* `WHERE hello = 1 AND world = ANY({2, 3})` * `WHERE hello = 1 AND world = ANY({2, 3})`
* *
* @param fieldEqualityOperands - list of field equality selection 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 entity results that match the query, where result error can be UnauthorizedError
*/ */
@@ -248,7 +218,6 @@ export default class EntityLoader<
this.privacyPolicy.authorizeReadAsync( this.privacyPolicy.authorizeReadAsync(
this.viewerContext, this.viewerContext,
this.queryContext, this.queryContext,
this.privacyPolicyEvaluationContext,
uncheckedEntityResult.value, uncheckedEntityResult.value,
this.metricsAdapter this.metricsAdapter
) )
@@ -271,12 +240,12 @@ export default class EntityLoader<
* bindings: `[1]` * bindings: `[1]`
* Entites returned `WHERE id = 1` * Entites returned `WHERE id = 1`
* *
* http://knexjs.org/#Builder-whereRaw * {@link http://knexjs.org/#Builder-whereRaw}
* http://knexjs.org/#Raw-Bindings * {@link http://knexjs.org/#Raw-Bindings}
* *
* @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, orderBy, and orderByRaw 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 entity results that match the query, where result error can be UnauthorizedError
* @throws Error when rawWhereClause or bindings are invalid * @throws Error when rawWhereClause or bindings are invalid
* *
@@ -285,7 +254,7 @@ export default class EntityLoader<
async loadManyByRawWhereClauseAsync( async loadManyByRawWhereClauseAsync(
rawWhereClause: string, rawWhereClause: string,
bindings: any[] | object, bindings: any[] | object,
querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields> = {} querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
): Promise<readonly Result<TEntity>[]> { ): Promise<readonly Result<TEntity>[]> {
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync( const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync(
this.queryContext, this.queryContext,
@@ -303,7 +272,6 @@ export default class EntityLoader<
this.privacyPolicy.authorizeReadAsync( this.privacyPolicy.authorizeReadAsync(
this.viewerContext, this.viewerContext,
this.queryContext, this.queryContext,
this.privacyPolicyEvaluationContext,
uncheckedEntityResult.value, uncheckedEntityResult.value,
this.metricsAdapter this.metricsAdapter
) )
@@ -313,7 +281,7 @@ export default class EntityLoader<
} }
/** /**
* Invalidate all caches for an entity's fields. Exposed primarily for internal use by EntityMutator. * Invalidate all caches for an entity's fields. Exposed primarily for internal use by {@link EntityMutator}.
* @param objectFields - entity data object to be invalidated * @param objectFields - entity data object to be invalidated
*/ */
async invalidateFieldsAsync(objectFields: Readonly<TFields>): Promise<void> { async invalidateFieldsAsync(objectFields: Readonly<TFields>): Promise<void> {
@@ -364,7 +332,6 @@ export default class EntityLoader<
this.privacyPolicy.authorizeReadAsync( this.privacyPolicy.authorizeReadAsync(
this.viewerContext, this.viewerContext,
this.queryContext, this.queryContext,
this.privacyPolicyEvaluationContext,
uncheckedEntityResult.value, uncheckedEntityResult.value,
this.metricsAdapter this.metricsAdapter
) )
@@ -379,7 +346,7 @@ export default class EntityLoader<
fieldValues: readonly TFields[N][] fieldValues: readonly TFields[N][]
): void { ): void {
const fieldDefinition = this.entityConfiguration.schema.get(fieldName); const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
invariant(fieldDefinition, `must have field definition for field = ${String(fieldName)}`); invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
for (const fieldValue of fieldValues) { for (const fieldValue of fieldValues) {
const isInputValid = fieldDefinition.validateInputValue(fieldValue); const isInputValid = fieldDefinition.validateInputValue(fieldValue);
if (!isInputValid) { if (!isInputValid) {
+2 -4
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, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy'; import EntityPrivacyPolicy 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,13 +47,11 @@ 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,
+3 -15
View File
@@ -20,22 +20,11 @@ export type EntityValidatorMutationInfo<
| { | {
type: EntityMutationType.UPDATE; type: EntityMutationType.UPDATE;
previousValue: TEntity; previousValue: TEntity;
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
}; };
/** 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<
@@ -51,9 +40,8 @@ export type EntityTriggerMutationInfo<
| { | {
type: EntityMutationType.UPDATE; type: EntityMutationType.UPDATE;
previousValue: TEntity; previousValue: TEntity;
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
} }
| { | {
type: EntityMutationType.DELETE; type: EntityMutationType.DELETE;
cascadingDeleteCause: EntityCascadingDeletionInfo | null; cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null;
}; };
@@ -45,7 +45,7 @@ export default interface EntityMutationTriggerConfiguration<
*/ */
beforeAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]; beforeAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/** /**
* Trigger set that runs within the transaction but after the entity is created in, updated in, or deleted from * Trigger set that runs within the transaction but before the entity is created in, updated in, or deleted from
* the database and the cache is invalidated. * the database and the cache is invalidated.
*/ */
afterAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]; afterAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
@@ -85,7 +85,7 @@ export abstract class EntityMutationTrigger<
} }
/** /**
* A non-transactional trigger is like a EntityMutationTrigger but used for afterCommit triggers * A non-transactional trigger is like a {@link EntityMutationTrigger} but used for afterCommit triggers
* since they explicitly occur outside of the transaction. * since they explicitly occur outside of the transaction.
*/ */
export abstract class EntityNonTransactionalMutationTrigger< export abstract class EntityNonTransactionalMutationTrigger<
+59 -113
View File
@@ -11,7 +11,7 @@ import {
EntityValidatorMutationInfo, EntityValidatorMutationInfo,
EntityMutationType, EntityMutationType,
EntityTriggerMutationInfo, EntityTriggerMutationInfo,
EntityCascadingDeletionInfo, EntityMutationTriggerDeleteCascadeInfo,
} from './EntityMutationInfo'; } from './EntityMutationInfo';
import EntityMutationTriggerConfiguration, { import EntityMutationTriggerConfiguration, {
EntityMutationTrigger, EntityMutationTrigger,
@@ -182,7 +182,7 @@ export class CreateMutator<
/** /**
* Commit the new entity after authorizing against creation privacy rules. Invalidates all caches for * Commit the new entity after authorizing against creation privacy rules. Invalidates all caches for
* queries that would return new entity. * queries that would return new entity and caches the new entity if not in a transactional query context.
* @returns authorized, cached, newly-created entity result, where result error can be UnauthorizedError * @returns authorized, cached, newly-created entity result, where result error can be UnauthorizedError
*/ */
async createAsync(): Promise<Result<TEntity>> { async createAsync(): Promise<Result<TEntity>> {
@@ -220,7 +220,6 @@ export class CreateMutator<
this.privacyPolicy.authorizeCreateAsync( this.privacyPolicy.authorizeCreateAsync(
this.viewerContext, this.viewerContext,
queryContext, queryContext,
{ cascadingDeleteCause: null },
temporaryEntityForPrivacyCheck, temporaryEntityForPrivacyCheck,
this.metricsAdapter this.metricsAdapter
) )
@@ -250,9 +249,7 @@ 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);
cascadingDeleteCause: null,
});
queryContext.appendPostCommitInvalidationCallback( queryContext.appendPostCommitInvalidationCallback(
entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult) entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult)
); );
@@ -377,7 +374,8 @@ export class UpdateMutator<
/** /**
* Commit the changes to the entity after authorizing against update privacy rules. * Commit the changes to the entity after authorizing against update privacy rules.
* Invalidates all caches for pre-update entity. * Invalidates all caches for pre-update entity and caches the updated entity if not in a
* transactional query context.
* @returns authorized updated entity result, where result error can be UnauthorizedError * @returns authorized updated entity result, where result error can be UnauthorizedError
*/ */
async updateAsync(): Promise<Result<TEntity>> { async updateAsync(): Promise<Result<TEntity>> {
@@ -385,7 +383,7 @@ export class UpdateMutator<
this.metricsAdapter, this.metricsAdapter,
EntityMetricsMutationType.UPDATE, EntityMetricsMutationType.UPDATE,
this.entityClass.name this.entityClass.name
)(this.updateInTransactionAsync(false, null)); )(this.updateInTransactionAsync());
} }
/** /**
@@ -395,27 +393,14 @@ export class UpdateMutator<
return await enforceAsyncResult(this.updateAsync()); return await enforceAsyncResult(this.updateAsync());
} }
private async updateInTransactionAsync( private async updateInTransactionAsync(): Promise<Result<TEntity>> {
skipDatabaseUpdate: true,
cascadingDeleteCause: EntityCascadingDeletionInfo
): Promise<Result<TEntity>>;
private async updateInTransactionAsync(
skipDatabaseUpdate: false,
cascadingDeleteCause: EntityCascadingDeletionInfo | null
): Promise<Result<TEntity>>;
private async updateInTransactionAsync(
skipDatabaseUpdate: boolean,
cascadingDeleteCause: EntityCascadingDeletionInfo | null
): Promise<Result<TEntity>> {
return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) => return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
this.updateInternalAsync(innerQueryContext, skipDatabaseUpdate, cascadingDeleteCause) this.updateInternalAsync(innerQueryContext)
); );
} }
private async updateInternalAsync( private async updateInternalAsync(
queryContext: EntityTransactionalQueryContext, queryContext: EntityTransactionalQueryContext
skipDatabaseUpdate: boolean,
cascadingDeleteCause: EntityCascadingDeletionInfo | null
): Promise<Result<TEntity>> { ): Promise<Result<TEntity>> {
this.validateFields(this.updatedFields); this.validateFields(this.updatedFields);
@@ -424,7 +409,6 @@ export class UpdateMutator<
this.privacyPolicy.authorizeUpdateAsync( this.privacyPolicy.authorizeUpdateAsync(
this.viewerContext, this.viewerContext,
queryContext, queryContext,
{ cascadingDeleteCause },
entityAboutToBeUpdated, entityAboutToBeUpdated,
this.metricsAdapter this.metricsAdapter
) )
@@ -437,34 +421,29 @@ export class UpdateMutator<
this.mutationValidators, this.mutationValidators,
queryContext, queryContext,
entityAboutToBeUpdated, entityAboutToBeUpdated,
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause } { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
); );
await this.executeMutationTriggersAsync( await this.executeMutationTriggersAsync(
this.mutationTriggers.beforeAll, this.mutationTriggers.beforeAll,
queryContext, queryContext,
entityAboutToBeUpdated, entityAboutToBeUpdated,
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause } { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
); );
await this.executeMutationTriggersAsync( await this.executeMutationTriggersAsync(
this.mutationTriggers.beforeUpdate, this.mutationTriggers.beforeUpdate,
queryContext, queryContext,
entityAboutToBeUpdated, entityAboutToBeUpdated,
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause } { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
); );
// skip the database update when specified const updateResult = await this.databaseAdapter.updateAsync(
const updateResult = skipDatabaseUpdate queryContext,
? null this.entityConfiguration.idField,
: await this.databaseAdapter.updateAsync( entityAboutToBeUpdated.getID(),
queryContext, this.updatedFields
this.entityConfiguration.idField, );
entityAboutToBeUpdated.getID(),
this.updatedFields
);
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.invalidateFieldsAsync.bind(
@@ -476,25 +455,22 @@ export class UpdateMutator<
entityLoader.invalidateFieldsAsync.bind(entityLoader, this.fieldsForEntity) entityLoader.invalidateFieldsAsync.bind(entityLoader, this.fieldsForEntity)
); );
// when the database update was skipped, assume it succeeded and use the optimistic const unauthorizedEntityAfterUpdate = new this.entityClass(this.viewerContext, updateResult);
// entity to execute triggers const updatedEntity = await entityLoader
const updatedEntity = updateResult .enforcing()
? await entityLoader .loadByIDAsync(unauthorizedEntityAfterUpdate.getID());
.enforcing()
.loadByIDAsync(new this.entityClass(this.viewerContext, updateResult).getID())
: entityAboutToBeUpdated;
await this.executeMutationTriggersAsync( await this.executeMutationTriggersAsync(
this.mutationTriggers.afterUpdate, this.mutationTriggers.afterUpdate,
queryContext, queryContext,
updatedEntity, updatedEntity,
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause } { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
); );
await this.executeMutationTriggersAsync( await this.executeMutationTriggersAsync(
this.mutationTriggers.afterAll, this.mutationTriggers.afterAll,
queryContext, queryContext,
updatedEntity, updatedEntity,
{ type: EntityMutationType.UPDATE, previousValue: this.originalEntity, cascadingDeleteCause } { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
); );
queryContext.appendPostCommitCallback( queryContext.appendPostCommitCallback(
@@ -502,11 +478,7 @@ export class UpdateMutator<
this, this,
this.mutationTriggers.afterCommit, this.mutationTriggers.afterCommit,
updatedEntity, updatedEntity,
{ { type: EntityMutationType.UPDATE, previousValue: this.originalEntity }
type: EntityMutationType.UPDATE,
previousValue: this.originalEntity,
cascadingDeleteCause,
}
) )
); );
@@ -606,7 +578,7 @@ export class DeleteMutator<
private async deleteInTransactionAsync( private async deleteInTransactionAsync(
processedEntityIdentifiersFromTransitiveDeletions: Set<string>, processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
skipDatabaseDeletion: boolean, skipDatabaseDeletion: boolean,
cascadingDeleteCause: EntityCascadingDeletionInfo | null cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null
): Promise<Result<void>> { ): Promise<Result<void>> {
return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) => return await this.queryContext.runInTransactionIfNotInTransactionAsync((innerQueryContext) =>
this.deleteInternalAsync( this.deleteInternalAsync(
@@ -622,13 +594,12 @@ export class DeleteMutator<
queryContext: EntityTransactionalQueryContext, queryContext: EntityTransactionalQueryContext,
processedEntityIdentifiersFromTransitiveDeletions: Set<string>, processedEntityIdentifiersFromTransitiveDeletions: Set<string>,
skipDatabaseDeletion: boolean, skipDatabaseDeletion: boolean,
cascadingDeleteCause: EntityCascadingDeletionInfo | null cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | 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
) )
@@ -665,9 +636,7 @@ 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())
); );
@@ -700,7 +669,7 @@ export class DeleteMutator<
/** /**
* Finds all entities referencing the specified entity and either deletes them, nullifies * Finds all entities referencing the specified entity and either deletes them, nullifies
* their references to the specified entity, or invalidates the cache depending on the * their references to the specified entity, or invalidates the cache depending on the
* OnDeleteBehavior of the field referencing the specified entity. * {@link OnDeleteBehavior} of the field referencing the specified entity.
* *
* @remarks * @remarks
* This works by doing reverse fan-out queries: * This works by doing reverse fan-out queries:
@@ -715,7 +684,7 @@ export class DeleteMutator<
entity: TEntity, entity: TEntity,
queryContext: EntityTransactionalQueryContext, queryContext: EntityTransactionalQueryContext,
processedEntityIdentifiers: Set<string>, processedEntityIdentifiers: Set<string>,
cascadingDeleteCause: EntityCascadingDeletionInfo | null cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | 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())) {
@@ -763,15 +732,10 @@ 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, { cascadingDeleteCause: newCascadingDeleteCause }) .forLoad(queryContext)
.enforcing() .enforcing()
.loadManyByFieldEqualingAsync( .loadManyByFieldEqualingAsync(
fieldName, fieldName,
@@ -779,40 +743,26 @@ export class DeleteMutator<
); );
} else { } else {
inboundReferenceEntities = await loaderFactory inboundReferenceEntities = await loaderFactory
.forLoad(queryContext, { cascadingDeleteCause: newCascadingDeleteCause }) .forLoad(queryContext)
.enforcing() .enforcing()
.loadManyByFieldEqualingAsync(fieldName, entity.getID()); .loadManyByFieldEqualingAsync(fieldName, entity.getID());
} }
switch (association.edgeDeletionBehavior) { switch (association.edgeDeletionBehavior) {
case EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY: { case undefined:
case EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE: {
await Promise.all( await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) => inboundReferenceEntities.map((inboundReferenceEntity) =>
enforceAsyncResult( mutatorFactory
mutatorFactory .forDelete(inboundReferenceEntity, queryContext)
.forDelete(inboundReferenceEntity, queryContext) .deleteInTransactionAsync(
.deleteInTransactionAsync( processedEntityIdentifiers,
processedEntityIdentifiers, /* skipDatabaseDeletion */ true, // deletion is handled by DB
/* skipDatabaseDeletion */ true, // deletion is handled by DB {
newCascadingDeleteCause entity,
) cascadingDeleteCause,
) }
) )
);
break;
}
case EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY: {
await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) =>
enforceAsyncResult(
mutatorFactory
.forUpdate(inboundReferenceEntity, queryContext)
.setField(fieldName, null)
['updateInTransactionAsync'](
/* skipDatabaseUpdate */ true,
newCascadingDeleteCause
)
)
) )
); );
break; break;
@@ -820,15 +770,10 @@ export class DeleteMutator<
case EntityEdgeDeletionBehavior.SET_NULL: { case EntityEdgeDeletionBehavior.SET_NULL: {
await Promise.all( await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) => inboundReferenceEntities.map((inboundReferenceEntity) =>
enforceAsyncResult( mutatorFactory
mutatorFactory .forUpdate(inboundReferenceEntity, queryContext)
.forUpdate(inboundReferenceEntity, queryContext) .setField(fieldName, null)
.setField(fieldName, null) .enforceUpdateAsync()
['updateInTransactionAsync'](
/* skipDatabaseUpdate */ false,
newCascadingDeleteCause
)
)
) )
); );
break; break;
@@ -836,15 +781,16 @@ export class DeleteMutator<
case EntityEdgeDeletionBehavior.CASCADE_DELETE: { case EntityEdgeDeletionBehavior.CASCADE_DELETE: {
await Promise.all( await Promise.all(
inboundReferenceEntities.map((inboundReferenceEntity) => inboundReferenceEntities.map((inboundReferenceEntity) =>
enforceAsyncResult( mutatorFactory
mutatorFactory .forDelete(inboundReferenceEntity, queryContext)
.forDelete(inboundReferenceEntity, queryContext) .deleteInTransactionAsync(
.deleteInTransactionAsync( processedEntityIdentifiers,
processedEntityIdentifiers, /* skipDatabaseDeletion */ false,
/* skipDatabaseDeletion */ false, {
newCascadingDeleteCause entity,
) cascadingDeleteCause,
) }
)
) )
); );
} }
+6 -51
View File
@@ -1,4 +1,3 @@
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';
@@ -8,35 +7,9 @@ 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;
};
/**
* Evaluation mode for a EntityPrivacyPolicy. Useful when transitioning to
* using Entity for privacy.
*/
export enum EntityPrivacyPolicyEvaluationMode { export enum EntityPrivacyPolicyEvaluationMode {
/**
* Enforce this privacy policy. Throw upon denial.
*/
ENFORCE, ENFORCE,
/**
* Do not enforce this privacy policy. Always allow but log when it would have denied.
*/
DRY_RUN, DRY_RUN,
/**
* Enforce this privacy policy. Throw and log upon denial.
*/
ENFORCE_AND_LOG, ENFORCE_AND_LOG,
} }
@@ -75,7 +48,7 @@ export enum EntityAuthorizationAction {
* *
* @remarks * @remarks
* *
* A privacy policy declares lists of PrivacyPolicyRule for create, read, update, and delete actions * A privacy policy declares lists of {@link PrivacyPolicyRule} for create, read, update, and delete actions
* for an entity and provides logic for authorizing an entity against rules. * for an entity and provides logic for authorizing an entity against rules.
* *
* Evaluation of a list of rules is performed according the following example. This allows constructing of * Evaluation of a list of rules is performed according the following example. This allows constructing of
@@ -149,12 +122,11 @@ export default abstract class EntityPrivacyPolicy<
* @param queryContext - query context in which to perform the create authorization * @param queryContext - query context in which to perform the create authorization
* @param entity - entity to authorize * @param entity - entity to authorize
* @returns entity if authorized * @returns entity if authorized
* @throws EntityNotAuthorizedError when not authorized * @throws {@link EntityNotAuthorizedError} when not authorized
*/ */
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> {
@@ -162,7 +134,6 @@ export default abstract class EntityPrivacyPolicy<
this.createRules, this.createRules,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
EntityAuthorizationAction.CREATE, EntityAuthorizationAction.CREATE,
metricsAdapter metricsAdapter
@@ -175,12 +146,11 @@ export default abstract class EntityPrivacyPolicy<
* @param queryContext - query context in which to perform the read authorization * @param queryContext - query context in which to perform the read authorization
* @param entity - entity to authorize * @param entity - entity to authorize
* @returns entity if authorized * @returns entity if authorized
* @throws EntityNotAuthorizedError when not authorized * @throws {@link EntityNotAuthorizedError} when not authorized
*/ */
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> {
@@ -188,7 +158,6 @@ export default abstract class EntityPrivacyPolicy<
this.readRules, this.readRules,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
EntityAuthorizationAction.READ, EntityAuthorizationAction.READ,
metricsAdapter metricsAdapter
@@ -201,12 +170,11 @@ export default abstract class EntityPrivacyPolicy<
* @param queryContext - query context in which to perform the update authorization * @param queryContext - query context in which to perform the update authorization
* @param entity - entity to authorize * @param entity - entity to authorize
* @returns entity if authorized * @returns entity if authorized
* @throws EntityNotAuthorizedError when not authorized * @throws {@link EntityNotAuthorizedError} when not authorized
*/ */
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> {
@@ -214,7 +182,6 @@ export default abstract class EntityPrivacyPolicy<
this.updateRules, this.updateRules,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
EntityAuthorizationAction.UPDATE, EntityAuthorizationAction.UPDATE,
metricsAdapter metricsAdapter
@@ -227,12 +194,11 @@ export default abstract class EntityPrivacyPolicy<
* @param queryContext - query context in which to perform the delete authorization * @param queryContext - query context in which to perform the delete authorization
* @param entity - entity to authorize * @param entity - entity to authorize
* @returns entity if authorized * @returns entity if authorized
* @throws EntityNotAuthorizedError when not authorized * @throws {@link EntityNotAuthorizedError} when not authorized
*/ */
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> {
@@ -240,7 +206,6 @@ export default abstract class EntityPrivacyPolicy<
this.deleteRules, this.deleteRules,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
EntityAuthorizationAction.DELETE, EntityAuthorizationAction.DELETE,
metricsAdapter metricsAdapter
@@ -251,7 +216,6 @@ 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
@@ -264,7 +228,6 @@ export default abstract class EntityPrivacyPolicy<
ruleset, ruleset,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
action action
); );
@@ -293,7 +256,6 @@ export default abstract class EntityPrivacyPolicy<
ruleset, ruleset,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
action action
); );
@@ -323,7 +285,6 @@ export default abstract class EntityPrivacyPolicy<
ruleset, ruleset,
viewerContext, viewerContext,
queryContext, queryContext,
evaluationContext,
entity, entity,
action action
); );
@@ -354,18 +315,12 @@ 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( const ruleEvaluationResult = await rule.evaluateAsync(viewerContext, queryContext, entity);
viewerContext,
queryContext,
evaluationContext,
entity
);
switch (ruleEvaluationResult) { switch (ruleEvaluationResult) {
case RuleEvaluationResult.DENY: case RuleEvaluationResult.DENY:
throw new EntityNotAuthorizedError< throw new EntityNotAuthorizedError<
+1 -72
View File
@@ -12,7 +12,7 @@ export type PreCommitCallback = (
* Entity framework representation of transactional and non-transactional database * Entity framework representation of transactional and non-transactional database
* query execution units. * query execution units.
* *
* The behavior of EntityMutator and EntityLoader * The behavior of {@link EntityMutator} and {@link EntityLoader}
* differs when in a transactional context. * differs when in a transactional context.
*/ */
export abstract class EntityQueryContext { export abstract class EntityQueryContext {
@@ -29,12 +29,6 @@ export abstract class EntityQueryContext {
): Promise<T>; ): Promise<T>;
} }
/**
* Entity framework representation of a non-transactional query execution unit.
* When supplied to EntityMutator and EntityLoader methods, they will be
* run independently of any running transaction (though mutations start their own
* independent transactions internally when not being run in a transaction).
*/
export class EntityNonTransactionalQueryContext extends EntityQueryContext { export class EntityNonTransactionalQueryContext extends EntityQueryContext {
constructor( constructor(
queryInterface: any, queryInterface: any,
@@ -54,24 +48,12 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
} }
} }
/**
* Entity framework representation of a transactional query execution unit. When supplied
* to EntityMutator and EntityLoader methods, those methods and their
* dependent triggers and validators will run within the transaction.
*/
export class EntityTransactionalQueryContext extends EntityQueryContext { export class EntityTransactionalQueryContext extends EntityQueryContext {
private readonly postCommitInvalidationCallbacks: PostCommitCallback[] = []; private readonly postCommitInvalidationCallbacks: PostCommitCallback[] = [];
private readonly postCommitCallbacks: PostCommitCallback[] = []; private readonly postCommitCallbacks: PostCommitCallback[] = [];
private readonly preCommitCallbacks: { callback: PreCommitCallback; order: number }[] = []; private readonly preCommitCallbacks: { callback: PreCommitCallback; order: number }[] = [];
constructor(
queryInterface: any,
private readonly entityQueryContextProvider: EntityQueryContextProvider
) {
super(queryInterface);
}
/** /**
* Schedule a pre-commit callback. These will be run within the transaction right before it is * Schedule a pre-commit callback. These will be run within the transaction right before it is
* committed, and will be run in the order specified. Ordering of callbacks scheduled with the * committed, and will be run in the order specified. Ordering of callbacks scheduled with the
@@ -136,57 +118,4 @@ export class EntityTransactionalQueryContext extends EntityQueryContext {
): Promise<T> { ): Promise<T> {
return await transactionScope(this); return await transactionScope(this);
} }
async runInNestedTransactionAsync<T>(
transactionScope: (innerQueryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T> {
return await this.entityQueryContextProvider.runInNestedTransactionAsync(
this,
transactionScope
);
}
}
/**
* Entity framework representation of a nested transactional query execution unit. When supplied
* to EntityMutator and EntityLoader methods, those methods and their
* dependent triggers and validators will run within the nested transaction.
*
* This exists to forward post-commit callbacks to the parent query context.
*/
export class EntityNestedTransactionalQueryContext extends EntityTransactionalQueryContext {
private readonly postCommitInvalidationCallbacksToTransfer: PostCommitCallback[] = [];
private readonly postCommitCallbacksToTransfer: PostCommitCallback[] = [];
constructor(
queryInterface: any,
private readonly parentQueryContext: EntityTransactionalQueryContext,
entityQueryContextProvider: EntityQueryContextProvider
) {
super(queryInterface, entityQueryContextProvider);
}
public override appendPostCommitCallback(callback: PostCommitCallback): void {
this.postCommitInvalidationCallbacksToTransfer.push(callback);
}
public override appendPostCommitInvalidationCallback(callback: PostCommitCallback): void {
this.postCommitCallbacksToTransfer.push(callback);
}
public override runPostCommitCallbacksAsync(): Promise<void> {
throw new Error(
'Must not call runPostCommitCallbacksAsync on EntityNestedTransactionalQueryContext'
);
}
public transferPostCommitCallbacksToParent(): void {
for (const callback of this.postCommitInvalidationCallbacksToTransfer) {
this.parentQueryContext.appendPostCommitInvalidationCallback(callback);
}
for (const callback of this.postCommitCallbacksToTransfer) {
this.parentQueryContext.appendPostCommitCallback(callback);
}
}
} }
@@ -1,7 +1,6 @@
import { import {
EntityTransactionalQueryContext, EntityTransactionalQueryContext,
EntityNonTransactionalQueryContext, EntityNonTransactionalQueryContext,
EntityNestedTransactionalQueryContext,
} from './EntityQueryContext'; } from './EntityQueryContext';
/** /**
@@ -21,16 +20,12 @@ export default abstract class EntityQueryContextProvider {
protected abstract getQueryInterface(): any; protected abstract getQueryInterface(): any;
/** /**
* Vend a transaction runner for use in runInTransactionAsync. * Vend a transaction runner for use in {@link runInTransactionAsync}.
*/ */
protected abstract createTransactionRunner<T>(): ( protected abstract createTransactionRunner<T>(): (
transactionScope: (queryInterface: any) => Promise<T> transactionScope: (queryInterface: any) => Promise<T>
) => Promise<T>; ) => Promise<T>;
protected abstract createNestedTransactionRunner<T>(
outerQueryInterface: any
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T>;
/** /**
* Start a transaction and execute the provided transaction-scoped closure within the transaction. * Start a transaction and execute the provided transaction-scoped closure within the transaction.
* @param transactionScope - async callback to execute within the transaction * @param transactionScope - async callback to execute within the transaction
@@ -41,7 +36,7 @@ export default abstract class EntityQueryContextProvider {
const [returnedValue, queryContext] = await this.createTransactionRunner< const [returnedValue, queryContext] = await this.createTransactionRunner<
[T, EntityTransactionalQueryContext] [T, EntityTransactionalQueryContext]
>()(async (queryInterface) => { >()(async (queryInterface) => {
const queryContext = new EntityTransactionalQueryContext(queryInterface, this); const queryContext = new EntityTransactionalQueryContext(queryInterface);
const result = await transactionScope(queryContext); const result = await transactionScope(queryContext);
await queryContext.runPreCommitCallbacksAsync(); await queryContext.runPreCommitCallbacksAsync();
return [result, queryContext]; return [result, queryContext];
@@ -49,31 +44,4 @@ export default abstract class EntityQueryContextProvider {
await queryContext.runPostCommitCallbacksAsync(); await queryContext.runPostCommitCallbacksAsync();
return returnedValue; return returnedValue;
} }
/**
* Start a nested transaction from the specified parent transaction and execure the
* provided nested-transaction-scoped closure within the nested transaction.
* @param outerQueryContext - the query context of the parent transaction
* @param transactionScope - async callback to execute within the nested transaction
*/
async runInNestedTransactionAsync<T>(
outerQueryContext: EntityTransactionalQueryContext,
transactionScope: (innerQueryContext: EntityNestedTransactionalQueryContext) => Promise<T>
): Promise<T> {
const [returnedValue, innerQueryContext] = await this.createNestedTransactionRunner<
[T, EntityNestedTransactionalQueryContext]
>(outerQueryContext.getQueryInterface())(async (innerQueryInterface) => {
const innerQueryContext = new EntityNestedTransactionalQueryContext(
innerQueryInterface,
outerQueryContext,
this
);
const result = await transactionScope(innerQueryContext);
await innerQueryContext.runPreCommitCallbacksAsync();
return [result, innerQueryContext];
});
// post-commit callbacks are appended to parent transaction instead of run, but only after the transaction has succeeded
innerQueryContext.transferPostCommitCallbacksToParent();
return returnedValue;
}
} }
@@ -40,7 +40,7 @@ export interface ISecondaryEntityCache<TFields, TLoadParams> {
* when the underlying data of a cache key could be stale. * when the underlying data of a cache key could be stale.
* *
* This is most commonly used to further optimize hot paths that cannot make use of normal entity cache loading * This is most commonly used to further optimize hot paths that cannot make use of normal entity cache loading
* due to use of a non-unique-field-based EntityLoader method like `loadManyByFieldEqualityConjunctionAsync` or * due to use of a non-unique-field-based {@link EntityLoader} method like `loadManyByFieldEqualityConjunctionAsync` or
* `loadManyByRawWhereClauseAsync`. * `loadManyByRawWhereClauseAsync`.
*/ */
export default abstract class EntitySecondaryCacheLoader< export default abstract class EntitySecondaryCacheLoader<
@@ -8,7 +8,7 @@ import { filterMap, zipToMap } from './utils/collections/maps';
/** /**
* A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular * A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
* single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes * 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 EntityLoader.loadManyByFieldEqualityConjunctionAsync is guaranteed to return at most one entity. * a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
*/ */
export default abstract class GenericSecondaryEntityCache<TFields, TLoadParams> export default abstract class GenericSecondaryEntityCache<TFields, TLoadParams>
implements ISecondaryEntityCache<TFields, TLoadParams> implements ISecondaryEntityCache<TFields, TLoadParams>
+2 -2
View File
@@ -82,7 +82,7 @@ export default abstract class ReadonlyEntity<
} }
/** /**
* @returns EntityAssociationLoader for this entity * @returns {@link EntityAssociationLoader} for this entity
*/ */
associationLoader(): EntityAssociationLoader< associationLoader(): EntityAssociationLoader<
TFields, TFields,
@@ -156,6 +156,6 @@ export default abstract class ReadonlyEntity<
return viewerContext return viewerContext
.getViewerScopedEntityCompanionForClass(this) .getViewerScopedEntityCompanionForClass(this)
.getLoaderFactory() .getLoaderFactory()
.forLoad(queryContext, { cascadingDeleteCause: null }); .forLoad(queryContext);
} }
} }
+2 -2
View File
@@ -7,9 +7,9 @@ import ViewerScopedEntityCompanion from './ViewerScopedEntityCompanion';
import ViewerScopedEntityCompanionProvider from './ViewerScopedEntityCompanionProvider'; import ViewerScopedEntityCompanionProvider from './ViewerScopedEntityCompanionProvider';
/** /**
* A viewer context encapsulates all information necessary to evaluate an EntityPrivacyPolicy. * A viewer context encapsulates all information necessary to evaluate an {@link EntityPrivacyPolicy}.
* *
* In combination with an EntityCompanionProvider, a viewer context is the * In combination with an {@link EntityCompanionProvider}, a viewer context is the
* entry point into the Entity framework. * entry point into the Entity framework.
*/ */
export default class ViewerContext { export default class ViewerContext {
@@ -8,7 +8,7 @@ import ViewerScopedEntityMutatorFactory from './ViewerScopedEntityMutatorFactory
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter'; import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
/** /**
* Provides a simpler API for loading and mutating entities by injecting the ViewerContext * Provides a simpler API for loading and mutating entities by injecting the {@link ViewerContext}
* from the viewer-scoped entity companion provider. * from the viewer-scoped entity companion provider.
*/ */
export default class ViewerScopedEntityCompanion< export default class ViewerScopedEntityCompanion<
@@ -79,7 +79,7 @@ export default class ViewerScopedEntityCompanion<
} }
/** /**
* Get the IEntityMetricsAdapter for this companion. * Get the {@link IEntityMetricsAdapter} for this companion.
*/ */
getMetricsAdapter(): IEntityMetricsAdapter { getMetricsAdapter(): IEntityMetricsAdapter {
return this.entityCompanion.getMetricsAdapter(); return this.entityCompanion.getMetricsAdapter();
@@ -1,12 +1,12 @@
import EntityLoader from './EntityLoader'; import EntityLoader from './EntityLoader';
import EntityLoaderFactory from './EntityLoaderFactory'; import EntityLoaderFactory from './EntityLoaderFactory';
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy'; import EntityPrivacyPolicy 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';
/** /**
* Provides a cleaner API for loading entities by passing through the ViewerContext. * Provides a cleaner API for loading entities by passing through the {@link ViewerContext}.
*/ */
export default class ViewerScopedEntityLoaderFactory< export default class ViewerScopedEntityLoaderFactory<
TFields, TFields,
@@ -35,13 +35,8 @@ 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( return this.entityLoaderFactory.forLoad(this.viewerContext, queryContext);
this.viewerContext,
queryContext,
privacyPolicyEvaluationContext
);
} }
} }
@@ -6,7 +6,7 @@ import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext'; import ViewerContext from './ViewerContext';
/** /**
* Provides a cleaner API for mutating entities by passing through the ViewerContext. * Provides a cleaner API for mutating entities by passing through the {@link ViewerContext}.
*/ */
export default class ViewerScopedEntityMutatorFactory< export default class ViewerScopedEntityMutatorFactory<
TFields, TFields,
@@ -1,319 +0,0 @@
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 ${String(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 { fallbackCacheAdapter, cacheAdapter } = makeTestCacheAdapters();
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
await fallbackCacheAdapter.cacheManyAsync('id', cacheHits);
await fallbackCacheAdapter.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('populates primary adapter with fallback adapter results', async () => {
const { primaryCacheAdapter, fallbackCacheAdapter, cacheAdapter } = makeTestCacheAdapters();
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
await fallbackCacheAdapter.cacheManyAsync('id', cacheHits);
await fallbackCacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
// should populate primary cache with fallback cache results
await cacheAdapter.loadManyAsync('id', ['test-id-1', 'test-id-2', 'test-id-3']);
const primaryResults = await primaryCacheAdapter.loadManyAsync('id', [
'test-id-1',
'test-id-2',
'test-id-3',
]);
expect(primaryResults.get('test-id-1')).toMatchObject({
status: CacheStatus.HIT,
item: { id: 'test-id-1' },
});
expect(primaryResults.get('test-id-2')).toMatchObject({ status: CacheStatus.NEGATIVE });
expect(primaryResults.get('test-id-3')).toMatchObject({ status: CacheStatus.MISS });
expect(primaryResults.size).toBe(3);
// ensure that populating the primary cache doesn't change the output
const composedResults = await cacheAdapter.loadManyAsync('id', [
'test-id-1',
'test-id-2',
'test-id-3',
]);
expect(composedResults.get('test-id-1')).toMatchObject({
status: CacheStatus.HIT,
item: { id: 'test-id-1' },
});
expect(composedResults.get('test-id-2')).toMatchObject({ status: CacheStatus.NEGATIVE });
expect(composedResults.get('test-id-3')).toMatchObject({ status: CacheStatus.MISS });
expect(composedResults.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', []);
});
});
});
@@ -1,101 +0,0 @@
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' });
});
});
@@ -222,46 +222,6 @@ describe(EnforcingEntityLoader, () => {
}); });
}); });
describe('loadFirstByFieldEqualityConjunction', () => {
it('throws when result is unsuccessful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const rejection = new Error();
when(
entityLoaderMock.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
).thenResolve(result(rejection));
const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect(
enforcingEntityLoader.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
).rejects.toThrow(rejection);
});
it('returns value when result is successful', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
const resolved = {};
when(
entityLoaderMock.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
).thenResolve(result(resolved));
const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect(
enforcingEntityLoader.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
).resolves.toEqual(resolved);
});
it('returns null when the query is successful but no rows match', async () => {
const entityLoaderMock = mock<EntityLoader<any, any, any, any, any, any>>(EntityLoader);
when(
entityLoaderMock.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
).thenResolve(null);
const entityLoader = instance(entityLoaderMock);
const enforcingEntityLoader = new EnforcingEntityLoader(entityLoader);
await expect(
enforcingEntityLoader.loadFirstByFieldEqualityConjunctionAsync(anything(), anything())
).resolves.toBeNull();
});
});
describe('loadManyByFieldEqualityConjunction', () => { describe('loadManyByFieldEqualityConjunction', () => {
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);
@@ -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, { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy'; import EntityPrivacyPolicy 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,7 +51,6 @@ 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')) {
+67 -563
View File
@@ -1,5 +1,3 @@
import invariant from 'invariant';
import Entity from '../Entity'; import Entity from '../Entity';
import { EntityCompanionDefinition } from '../EntityCompanionProvider'; import { EntityCompanionDefinition } from '../EntityCompanionProvider';
import EntityConfiguration from '../EntityConfiguration'; import EntityConfiguration from '../EntityConfiguration';
@@ -7,13 +5,10 @@ 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, { import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
EntityPrivacyPolicyEvaluationContext, import { EntityTransactionalQueryContext } from '../EntityQueryContext';
EntityAuthorizationAction,
} from '../EntityPrivacyPolicy';
import { EntityTransactionalQueryContext, EntityQueryContext } from '../EntityQueryContext';
import { CacheStatus } from '../internal/ReadThroughEntityCache'; import { CacheStatus } from '../internal/ReadThroughEntityCache';
import PrivacyPolicyRule, { RuleEvaluationResult } from '../rules/PrivacyPolicyRule'; import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
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';
@@ -32,88 +27,36 @@ interface GrandChildFields {
parent_id: string; parent_id: string;
} }
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
any,
string,
TestViewerContext,
any,
any
> {
protected override readonly readRules = [
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
];
protected override readonly createRules = [
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
];
protected override readonly updateRules = [
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
];
protected override readonly deleteRules = [
new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
];
}
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => { const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
const triggerExecutionCounts = { const triggerExecutionCounts = {
ParentEntityDeletion: 0, parent: 0,
ChildEntityDeletion: 0, child: 0,
GrandChildEntityDeletion: 0, grandchild: 0,
ParentEntityUpdate: 0,
ChildEntityUpdate: 0,
GrandChildEntityUpdate: 0,
}; };
const privacyPolicyEvaluationRecords = { class ParentCheckInfoTrigger extends EntityMutationTrigger<
shouldRecord: false,
ParentEntity: {
[EntityAuthorizationAction.CREATE]: [],
[EntityAuthorizationAction.READ]: [],
[EntityAuthorizationAction.UPDATE]: [],
[EntityAuthorizationAction.DELETE]: [],
},
ChildEntity: {
[EntityAuthorizationAction.CREATE]: [],
[EntityAuthorizationAction.READ]: [],
[EntityAuthorizationAction.UPDATE]: [],
[EntityAuthorizationAction.DELETE]: [],
},
GrandChildEntity: {
[EntityAuthorizationAction.CREATE]: [],
[EntityAuthorizationAction.READ]: [],
[EntityAuthorizationAction.UPDATE]: [],
[EntityAuthorizationAction.DELETE]: [],
},
};
class AlwaysAllowPrivacyPolicyRuleThatRecords extends PrivacyPolicyRule<
any,
string,
TestViewerContext,
any,
any
> {
constructor(private readonly action: EntityAuthorizationAction) {
super();
}
async evaluateAsync(
_viewerContext: TestViewerContext,
_queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: any
): Promise<RuleEvaluationResult> {
if (privacyPolicyEvaluationRecords.shouldRecord) {
(privacyPolicyEvaluationRecords as any)[entity.constructor.name][this.action].push(
evaluationContext
);
}
return RuleEvaluationResult.ALLOW;
}
}
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
any,
string,
TestViewerContext,
any,
any
> {
protected override readonly readRules = [
new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.READ),
];
protected override readonly createRules = [
new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.CREATE),
];
protected override readonly updateRules = [
new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.UPDATE),
];
protected override readonly deleteRules = [
new AlwaysAllowPrivacyPolicyRuleThatRecords(EntityAuthorizationAction.DELETE),
];
}
class ParentCheckInfoDeletionTrigger extends EntityMutationTrigger<
ParentFields, ParentFields,
string, string,
TestViewerContext, TestViewerContext,
@@ -125,37 +68,19 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
_entity: ParentEntity, _entity: ParentEntity,
mutationInfo: EntityTriggerMutationInfo<ParentFields, string, TestViewerContext, ParentEntity> mutationInfo: EntityTriggerMutationInfo<ParentFields, string, TestViewerContext, ParentEntity>
): Promise<void> { ): Promise<void> {
invariant(mutationInfo.type === EntityMutationType.DELETE, 'invalid EntityMutationType'); if (mutationInfo.type !== EntityMutationType.DELETE) {
return;
}
if (mutationInfo.cascadingDeleteCause !== null) { if (mutationInfo.cascadingDeleteCause !== null) {
throw new Error('Parent entity should not have casade delete cause'); throw new Error('Parent entity should not have casade delete cause');
} }
triggerExecutionCounts.ParentEntityDeletion++; triggerExecutionCounts.parent++;
} }
} }
class ParentCheckInfoUpdateTrigger extends EntityMutationTrigger< class ChildCheckInfoTrigger extends EntityMutationTrigger<
ParentFields,
string,
TestViewerContext,
ParentEntity
> {
async executeAsync(
_viewerContext: TestViewerContext,
_queryContext: EntityTransactionalQueryContext,
_entity: ParentEntity,
mutationInfo: EntityTriggerMutationInfo<ParentFields, string, TestViewerContext, ParentEntity>
): Promise<void> {
invariant(mutationInfo.type === EntityMutationType.UPDATE, 'invalid EntityMutationType');
if (mutationInfo.cascadingDeleteCause !== null) {
throw new Error('Parent entity should not have casade delete cause');
}
triggerExecutionCounts.ParentEntityUpdate++;
}
}
class ChildCheckInfoDeletionTrigger extends EntityMutationTrigger<
ChildFields, ChildFields,
string, string,
TestViewerContext, TestViewerContext,
@@ -167,7 +92,10 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
_entity: ChildEntity, _entity: ChildEntity,
mutationInfo: EntityTriggerMutationInfo<ChildFields, string, TestViewerContext, ChildEntity> mutationInfo: EntityTriggerMutationInfo<ChildFields, string, TestViewerContext, ChildEntity>
): Promise<void> { ): Promise<void> {
invariant(mutationInfo.type === EntityMutationType.DELETE, 'invalid EntityMutationType'); if (mutationInfo.type !== EntityMutationType.DELETE) {
return;
}
if (mutationInfo.cascadingDeleteCause === null) { if (mutationInfo.cascadingDeleteCause === null) {
throw new Error('Child entity should have casade delete cause'); throw new Error('Child entity should have casade delete cause');
} }
@@ -183,43 +111,11 @@ 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.ChildEntityDeletion++; triggerExecutionCounts.child++;
} }
} }
class ChildCheckInfoUpdateTrigger extends EntityMutationTrigger< class GrandChildCheckInfoTrigger extends EntityMutationTrigger<
ChildFields,
string,
TestViewerContext,
ChildEntity
> {
async executeAsync(
_viewerContext: TestViewerContext,
_queryContext: EntityTransactionalQueryContext,
_entity: ChildEntity,
mutationInfo: EntityTriggerMutationInfo<ChildFields, string, TestViewerContext, ChildEntity>
): Promise<void> {
invariant(mutationInfo.type === EntityMutationType.UPDATE, 'invalid EntityMutationType');
if (mutationInfo.cascadingDeleteCause === null) {
throw new Error('Child entity should have casade delete cause');
}
const cascadingDeleteCauseEntity = mutationInfo.cascadingDeleteCause.entity;
if (!(cascadingDeleteCauseEntity instanceof ParentEntity)) {
throw new Error('Child entity should have casade delete cause entity of type ParentEntity');
}
const secondLevelCascadingDeleteCause =
mutationInfo.cascadingDeleteCause.cascadingDeleteCause;
if (secondLevelCascadingDeleteCause) {
throw new Error('Child entity should not have two-level casade delete cause');
}
triggerExecutionCounts.ChildEntityUpdate++;
}
}
class GrandChildCheckInfoDeletionTrigger extends EntityMutationTrigger<
GrandChildFields, GrandChildFields,
string, string,
TestViewerContext, TestViewerContext,
@@ -236,7 +132,10 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
GrandChildEntity GrandChildEntity
> >
): Promise<void> { ): Promise<void> {
invariant(mutationInfo.type === EntityMutationType.DELETE, 'invalid EntityMutationType'); if (mutationInfo.type !== EntityMutationType.DELETE) {
return;
}
if (mutationInfo.cascadingDeleteCause === null) { if (mutationInfo.cascadingDeleteCause === null) {
throw new Error('GrandChild entity should have cascade delete cause'); throw new Error('GrandChild entity should have cascade delete cause');
} }
@@ -266,58 +165,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.GrandChildEntityDeletion++; triggerExecutionCounts.grandchild++;
}
}
class GrandChildCheckInfoUpdateTrigger extends EntityMutationTrigger<
GrandChildFields,
string,
TestViewerContext,
GrandChildEntity
> {
async executeAsync(
_viewerContext: TestViewerContext,
_queryContext: EntityTransactionalQueryContext,
_entity: GrandChildEntity,
mutationInfo: EntityTriggerMutationInfo<
GrandChildFields,
string,
TestViewerContext,
GrandChildEntity
>
): Promise<void> {
invariant(mutationInfo.type === EntityMutationType.UPDATE, 'invalid EntityMutationType');
if (mutationInfo.cascadingDeleteCause === null) {
throw new Error('GrandChild entity should have cascade delete cause');
}
const cascadingDeleteCauseEntity = mutationInfo.cascadingDeleteCause.entity;
if (!(cascadingDeleteCauseEntity instanceof ChildEntity)) {
throw new Error(
'GrandChild entity should have cascade delete cause entity of type ChildEntity'
);
}
const secondLevelCascadingDeleteCause =
mutationInfo.cascadingDeleteCause.cascadingDeleteCause;
if (!secondLevelCascadingDeleteCause) {
throw new Error('GrandChild entity should have two-level casade delete cause');
}
const secondLevelCascadingDeleteCauseEntity = secondLevelCascadingDeleteCause.entity;
if (!(secondLevelCascadingDeleteCauseEntity instanceof ParentEntity)) {
throw new Error(
'GrandChild entity should have second level casade delete cause entity of type ParentEntity'
);
}
const thirdLevelCascadingDeleteCause = secondLevelCascadingDeleteCause.cascadingDeleteCause;
if (thirdLevelCascadingDeleteCause) {
throw new Error('GrandChild entity should not have three-level casade delete cause');
}
triggerExecutionCounts.GrandChildEntityUpdate++;
} }
} }
@@ -419,11 +267,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
entityConfiguration: parentEntityConfiguration, entityConfiguration: parentEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy, privacyPolicyClass: TestEntityPrivacyPolicy,
mutationTriggers: () => ({ mutationTriggers: () => ({
beforeDelete: [new ParentCheckInfoDeletionTrigger()], beforeDelete: [new ParentCheckInfoTrigger()],
afterDelete: [new ParentCheckInfoDeletionTrigger()], afterDelete: [new ParentCheckInfoTrigger()],
beforeUpdate: [new ParentCheckInfoUpdateTrigger()],
afterUpdate: [new ParentCheckInfoUpdateTrigger()],
}), }),
}); });
@@ -432,11 +277,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
entityConfiguration: childEntityConfiguration, entityConfiguration: childEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy, privacyPolicyClass: TestEntityPrivacyPolicy,
mutationTriggers: () => ({ mutationTriggers: () => ({
beforeDelete: [new ChildCheckInfoDeletionTrigger()], beforeDelete: [new ChildCheckInfoTrigger()],
afterDelete: [new ChildCheckInfoDeletionTrigger()], afterDelete: [new ChildCheckInfoTrigger()],
beforeUpdate: [new ChildCheckInfoUpdateTrigger()],
afterUpdate: [new ChildCheckInfoUpdateTrigger()],
}), }),
}); });
@@ -445,11 +287,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
entityConfiguration: grandChildEntityConfiguration, entityConfiguration: grandChildEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy, privacyPolicyClass: TestEntityPrivacyPolicy,
mutationTriggers: () => ({ mutationTriggers: () => ({
beforeDelete: [new GrandChildCheckInfoDeletionTrigger()], beforeDelete: [new GrandChildCheckInfoTrigger()],
afterDelete: [new GrandChildCheckInfoDeletionTrigger()], afterDelete: [new GrandChildCheckInfoTrigger()],
beforeUpdate: [new GrandChildCheckInfoUpdateTrigger()],
afterUpdate: [new GrandChildCheckInfoUpdateTrigger()],
}), }),
}); });
@@ -458,20 +297,14 @@ 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 { const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } =
ParentEntity, makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE);
ChildEntity,
GrandChildEntity,
triggerExecutionCounts,
privacyPolicyEvaluationRecords,
} = makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE);
const companionProvider = createUnitTestEntityCompanionProvider(); const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider); const viewerContext = new TestViewerContext(companionProvider);
@@ -493,9 +326,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID()) GrandChildEntity.loader(viewerContext).enforcing().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).enforcing().loadByIDNullableAsync(parent.getID())
@@ -509,86 +340,17 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
// two calls for each trigger, one beforeDelete, one afterDelete // two calls for each trigger, one beforeDelete, one afterDelete
expect(triggerExecutionCounts).toMatchObject({ expect(triggerExecutionCounts).toMatchObject({
ParentEntityDeletion: 2, parent: 2,
ChildEntityDeletion: 2, child: 2,
GrandChildEntityDeletion: 2, grandchild: 2,
ParentEntityUpdate: 0,
ChildEntityUpdate: 0,
GrandChildEntityUpdate: 0,
});
expect(privacyPolicyEvaluationRecords).toMatchObject({
ParentEntity: {
[EntityAuthorizationAction.CREATE]: [],
[EntityAuthorizationAction.READ]: [],
[EntityAuthorizationAction.UPDATE]: [],
// one DELETE auth action for parent (since it's being deleted)
[EntityAuthorizationAction.DELETE]: [{ cascadingDeleteCause: null }],
},
ChildEntity: {
[EntityAuthorizationAction.CREATE]: [],
// one READ auth action for child in order to 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 { const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } =
ParentEntity, makeEntityClasses(EntityEdgeDeletionBehavior.SET_NULL);
ChildEntity,
GrandChildEntity,
triggerExecutionCounts,
privacyPolicyEvaluationRecords,
} = makeEntityClasses(EntityEdgeDeletionBehavior.SET_NULL);
const companionProvider = createUnitTestEntityCompanionProvider(); const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider); const viewerContext = new TestViewerContext(companionProvider);
@@ -611,9 +373,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID()) GrandChildEntity.loader(viewerContext).enforcing().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).enforcing().loadByIDNullableAsync(parent.getID())
@@ -632,74 +392,17 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
// 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({
ParentEntityDeletion: 2, parent: 2,
ChildEntityDeletion: 0, child: 0,
GrandChildEntityDeletion: 0, grandchild: 0,
ParentEntityUpdate: 0,
ChildEntityUpdate: 2,
GrandChildEntityUpdate: 0,
});
expect(privacyPolicyEvaluationRecords).toMatchObject({
ParentEntity: {
[EntityAuthorizationAction.CREATE]: [],
[EntityAuthorizationAction.READ]: [],
[EntityAuthorizationAction.UPDATE]: [],
// one DELETE auth action for parent (since it's being deleted)
[EntityAuthorizationAction.DELETE]: [{ cascadingDeleteCause: null }],
},
ChildEntity: {
[EntityAuthorizationAction.CREATE]: [],
// 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.SET_NULL_INVALIDATE_CACHE_ONLY', () => { describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
it('invalidates the cache', async () => { it('invalidates the cache', async () => {
const { const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } =
ParentEntity, makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE);
ChildEntity,
GrandChildEntity,
triggerExecutionCounts,
privacyPolicyEvaluationRecords,
} = makeEntityClasses(EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY);
const companionProvider = createUnitTestEntityCompanionProvider(); const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider); const viewerContext = new TestViewerContext(companionProvider);
@@ -744,142 +447,7 @@ 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()]);
expect(childCachedAfter.get(parent.getID())?.status).toEqual(CacheStatus.MISS);
const grandChildCachedAfter = await grandChildCacheAdapter.loadManyAsync('parent_id', [
child.getID(),
]);
expect(grandChildCachedAfter.get(child.getID())?.status).toEqual(CacheStatus.HIT);
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.toBeNull();
const loadedChild = await ChildEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(child.getID());
expect(loadedChild).not.toBeNull();
const loadedGrandchild = await GrandChildEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(grandchild.getID());
expect(loadedGrandchild.getField('parent_id')).toEqual(loadedChild.getID());
// two calls for only parent trigger, one beforeDelete, one afterDelete
// when using set null the descendants aren't deleted
expect(triggerExecutionCounts).toMatchObject({
ParentEntityDeletion: 2,
ChildEntityDeletion: 0,
GrandChildEntityDeletion: 0,
ParentEntityUpdate: 0,
ChildEntityUpdate: 2,
GrandChildEntityUpdate: 0,
});
expect(privacyPolicyEvaluationRecords).toMatchObject({
ParentEntity: {
[EntityAuthorizationAction.CREATE]: [],
[EntityAuthorizationAction.READ]: [],
[EntityAuthorizationAction.UPDATE]: [],
// one DELETE auth action for parent (since it's being deleted)
[EntityAuthorizationAction.DELETE]: [{ cascadingDeleteCause: null }],
},
ChildEntity: {
[EntityAuthorizationAction.CREATE]: [],
// one READ auth action for child in order to update via cascade
// no other entities are read since it is not cascaded past first entity
[EntityAuthorizationAction.READ]: [
{
cascadingDeleteCause: {
entity: expect.any(ParentEntity),
cascadingDeleteCause: null,
},
},
],
// one UPDATE to set null
[EntityAuthorizationAction.UPDATE]: [
{
cascadingDeleteCause: {
entity: expect.any(ParentEntity),
cascadingDeleteCause: null,
},
},
],
[EntityAuthorizationAction.DELETE]: [],
},
GrandChildEntity: {
[EntityAuthorizationAction.CREATE]: [],
[EntityAuthorizationAction.READ]: [],
[EntityAuthorizationAction.UPDATE]: [],
[EntityAuthorizationAction.DELETE]: [],
},
});
});
});
describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY', () => {
it('invalidates the cache', async () => {
const {
ParentEntity,
ChildEntity,
GrandChildEntity,
triggerExecutionCounts,
privacyPolicyEvaluationRecords,
} = makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY);
const companionProvider = createUnitTestEntityCompanionProvider();
const viewerContext = new TestViewerContext(companionProvider);
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
const child = await ChildEntity.creator(viewerContext)
.setField('parent_id', parent.getID())
.enforceCreateAsync();
const grandchild = await GrandChildEntity.creator(viewerContext)
.setField('parent_id', child.getID())
.enforceCreateAsync();
await expect(
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
).resolves.not.toBeNull();
await expect(
ChildEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_id', parent.getID())
).resolves.not.toBeNull();
await expect(
GrandChildEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('parent_id', child.getID())
).resolves.not.toBeNull();
const childCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(ChildEntity)[
'entityCompanion'
]['tableDataCoordinator']['cacheAdapter'] as InMemoryFullCacheStubCacheAdapter<ChildFields>;
const childCachedBefore = await childCacheAdapter.loadManyAsync('parent_id', [
parent.getID(),
]);
expect(childCachedBefore.get(parent.getID())?.status).toEqual(CacheStatus.HIT);
const grandChildCacheAdapter = viewerContext.getViewerScopedEntityCompanionForClass(
GrandChildEntity
)['entityCompanion']['tableDataCoordinator'][
'cacheAdapter'
] as InMemoryFullCacheStubCacheAdapter<ChildFields>;
const grandChildCachedBefore = await grandChildCacheAdapter.loadManyAsync('parent_id', [
child.getID(),
]);
expect(grandChildCachedBefore.get(child.getID())?.status).toEqual(CacheStatus.HIT);
privacyPolicyEvaluationRecords.shouldRecord = true;
await ParentEntity.enforceDeleteAsync(parent);
privacyPolicyEvaluationRecords.shouldRecord = false;
const childCachedAfter = await childCacheAdapter.loadManyAsync('parent_id', [parent.getID()]); 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);
@@ -901,73 +469,9 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
// two calls for each trigger, one beforeDelete, one afterDelete // two calls for each trigger, one beforeDelete, one afterDelete
expect(triggerExecutionCounts).toMatchObject({ expect(triggerExecutionCounts).toMatchObject({
ParentEntityDeletion: 2, parent: 2,
ChildEntityDeletion: 2, child: 2,
GrandChildEntityDeletion: 2, grandchild: 2,
ParentEntityUpdate: 0,
ChildEntityUpdate: 0,
GrandChildEntityUpdate: 0,
});
expect(privacyPolicyEvaluationRecords).toMatchObject({
ParentEntity: {
[EntityAuthorizationAction.CREATE]: [],
[EntityAuthorizationAction.READ]: [],
[EntityAuthorizationAction.UPDATE]: [],
// one DELETE auth action for parent (since it's being deleted)
[EntityAuthorizationAction.DELETE]: [{ cascadingDeleteCause: null }],
},
ChildEntity: {
[EntityAuthorizationAction.CREATE]: [],
// one READ auth action for child in order to 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,
},
},
},
],
},
}); });
}); });
}); });
@@ -11,6 +11,8 @@ import {
StringArrayField, StringArrayField,
JSONObjectField, JSONObjectField,
EnumField, EnumField,
JSONArrayField,
MaybeJSONArrayField,
} from '../EntityFields'; } from '../EntityFields';
import describeFieldTestCase from '../utils/testing/describeFieldTestCase'; import describeFieldTestCase from '../utils/testing/describeFieldTestCase';
@@ -69,3 +71,13 @@ describeFieldTestCase(
); );
describeFieldTestCase(new JSONObjectField({ columnName: 'wat' }), [{}], [true, 'hello']); describeFieldTestCase(new JSONObjectField({ columnName: 'wat' }), [{}], [true, 'hello']);
describeFieldTestCase(new EnumField({ columnName: 'wat' }), ['hello', 1], [true]); describeFieldTestCase(new EnumField({ columnName: 'wat' }), ['hello', 1], [true]);
describeFieldTestCase(
new JSONArrayField({ columnName: 'wat' }),
[[[1, 2]] as any, [['hello']] as any], // jest test cases need extra wrapping array
[1, 'hello']
);
describeFieldTestCase(
new MaybeJSONArrayField({ columnName: 'wat' }),
[1, 'hello', [['hello']]], // jest test cases need extra wrapping array
[]
);
@@ -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, { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy'; import EntityPrivacyPolicy 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,7 +118,6 @@ 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();
@@ -155,7 +154,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -2,9 +2,7 @@ import { enforceAsyncResult } from '@expo/results';
import { mock, instance, verify, spy, deepEqual, anyOfClass, anything, when } from 'ts-mockito'; import { mock, instance, verify, spy, deepEqual, anyOfClass, anything, when } from 'ts-mockito';
import { v4 as uuidv4 } from 'uuid'; import { v4 as uuidv4 } from 'uuid';
import { OrderByOrdering } from '../EntityDatabaseAdapter';
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';
@@ -23,7 +21,6 @@ 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();
@@ -72,7 +69,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -117,7 +113,6 @@ 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();
@@ -174,7 +169,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -198,7 +192,6 @@ describe(EntityLoader, () => {
spiedPrivacyPolicy.authorizeReadAsync( spiedPrivacyPolicy.authorizeReadAsync(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -211,107 +204,11 @@ describe(EntityLoader, () => {
).rejects.toThrowError('Entity field not valid: TestEntity (customIdField = not-a-uuid)'); ).rejects.toThrowError('Entity field not valid: TestEntity (customIdField = not-a-uuid)');
}); });
it('loads entities with loadFirstByFieldEqualityConjunction', async () => {
const privacyPolicy = new TestEntityPrivacyPolicy();
const spiedPrivacyPolicy = spy(privacyPolicy);
const viewerContext = instance(mock(ViewerContext));
const privacyPolicyEvaluationContext = instance(mock<EntityPrivacyPolicyEvaluationContext>());
const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
const queryContext = StubQueryContextProvider.getQueryContext();
const id1 = uuidv4();
const id2 = uuidv4();
const id3 = uuidv4();
const databaseAdapter = new StubDatabaseAdapter<TestFields>(
testEntityConfiguration,
StubDatabaseAdapter.convertFieldObjectsToDataStore(
testEntityConfiguration,
new Map([
[
testEntityConfiguration.tableName,
[
{
customIdField: id1,
stringField: 'huh',
intField: 4,
testIndexedField: '4',
dateField: new Date(),
nullableField: null,
},
{
customIdField: id2,
stringField: 'huh',
intField: 4,
testIndexedField: '5',
dateField: new Date(),
nullableField: null,
},
{
customIdField: id3,
stringField: 'huh2',
intField: 4,
testIndexedField: '6',
dateField: new Date(),
nullableField: null,
},
],
],
])
)
);
const cacheAdapterProvider = new NoCacheStubCacheAdapterProvider();
const cacheAdapter = cacheAdapterProvider.getCacheAdapter(testEntityConfiguration);
const entityCache = new ReadThroughEntityCache(testEntityConfiguration, cacheAdapter);
const dataManager = new EntityDataManager(
databaseAdapter,
entityCache,
StubQueryContextProvider,
instance(mock<IEntityMetricsAdapter>()),
TestEntity.name
);
const entityLoader = new EntityLoader(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration,
TestEntity,
privacyPolicy,
dataManager,
metricsAdapter
);
const result = await entityLoader.loadFirstByFieldEqualityConjunctionAsync(
[
{
fieldName: 'stringField',
fieldValue: 'huh',
},
{
fieldName: 'intField',
fieldValue: 4,
},
],
{ orderBy: [{ fieldName: 'testIndexedField', order: OrderByOrdering.DESCENDING }] }
);
expect(result).not.toBeNull();
expect(result!.ok).toBe(true);
expect(result!.enforceValue().getField('testIndexedField')).toEqual('5');
verify(
spiedPrivacyPolicy.authorizeReadAsync(
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
anyOfClass(TestEntity),
anything()
)
).once();
});
it('authorizes loaded entities', async () => { it('authorizes loaded entities', async () => {
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();
@@ -350,7 +247,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -359,19 +255,12 @@ describe(EntityLoader, () => {
); );
const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1)); const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
verify( verify(
spiedPrivacyPolicy.authorizeReadAsync( spiedPrivacyPolicy.authorizeReadAsync(viewerContext, queryContext, entity, anything())
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));
@@ -382,7 +271,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -398,7 +286,6 @@ 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));
@@ -409,7 +296,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -424,7 +310,6 @@ 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));
@@ -439,7 +324,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -454,7 +338,6 @@ 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);
@@ -471,7 +354,6 @@ describe(EntityLoader, () => {
privacyPolicyMock.authorizeReadAsync( privacyPolicyMock.authorizeReadAsync(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -483,7 +365,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -499,7 +380,6 @@ 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));
@@ -516,7 +396,6 @@ describe(EntityLoader, () => {
const entityLoader = new EntityLoader( const entityLoader = new EntityLoader(
viewerContext, viewerContext,
queryContext, queryContext,
privacyPolicyEvaluationContext,
testEntityConfiguration, testEntityConfiguration,
TestEntity, TestEntity,
privacyPolicy, privacyPolicy,
@@ -25,7 +25,6 @@ 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';
@@ -406,7 +405,6 @@ describe(EntityMutatorFactory, () => {
spiedPrivacyPolicy.authorizeCreateAsync( spiedPrivacyPolicy.authorizeCreateAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
deepEqual({ cascadingDeleteCause: null }),
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -499,7 +497,6 @@ 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();
@@ -524,9 +521,7 @@ describe(EntityMutatorFactory, () => {
]); ]);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadByIDAsync(id2)
); );
const updatedEntity = await entityMutatorFactory const updatedEntity = await entityMutatorFactory
@@ -539,16 +534,13 @@ describe(EntityMutatorFactory, () => {
expect(updatedEntity.getField('stringField')).toEqual('huh2'); expect(updatedEntity.getField('stringField')).toEqual('huh2');
const reloadedEntity = await enforceAsyncResult( const reloadedEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.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();
@@ -576,9 +568,7 @@ describe(EntityMutatorFactory, () => {
const spiedPrivacyPolicy = spy(privacyPolicy); const spiedPrivacyPolicy = spy(privacyPolicy);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadByIDAsync(id2)
); );
await entityMutatorFactory await entityMutatorFactory
@@ -590,7 +580,6 @@ describe(EntityMutatorFactory, () => {
spiedPrivacyPolicy.authorizeUpdateAsync( spiedPrivacyPolicy.authorizeUpdateAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
deepEqual({ cascadingDeleteCause: null }),
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -599,7 +588,6 @@ 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();
@@ -627,9 +615,7 @@ describe(EntityMutatorFactory, () => {
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers); const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadByIDAsync(id2)
); );
await entityMutatorFactory await entityMutatorFactory
@@ -648,16 +634,11 @@ describe(EntityMutatorFactory, () => {
beforeDelete: false, beforeDelete: false,
afterDelete: false, afterDelete: false,
}, },
{ { type: EntityMutationType.UPDATE, previousValue: existingEntity }
type: EntityMutationType.UPDATE,
previousValue: existingEntity,
cascadingDeleteCause: null,
}
); );
}); });
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();
@@ -685,9 +666,7 @@ describe(EntityMutatorFactory, () => {
const validatorSpies = setUpMutationValidatorSpies(mutationValidators); const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadByIDAsync(id2)
); );
await entityMutatorFactory await entityMutatorFactory
@@ -698,7 +677,6 @@ describe(EntityMutatorFactory, () => {
verifyValidatorCounts(viewerContext, validatorSpies, 1, { verifyValidatorCounts(viewerContext, validatorSpies, 1, {
type: EntityMutationType.UPDATE, type: EntityMutationType.UPDATE,
previousValue: existingEntity, previousValue: existingEntity,
cascadingDeleteCause: null,
}); });
}); });
}); });
@@ -706,7 +684,6 @@ 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();
@@ -722,9 +699,7 @@ describe(EntityMutatorFactory, () => {
]); ]);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadByIDAsync(id1)
); );
expect(existingEntity).toBeTruthy(); expect(existingEntity).toBeTruthy();
@@ -732,16 +707,13 @@ describe(EntityMutatorFactory, () => {
await expect( await expect(
enforceAsyncResult( enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.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();
@@ -760,9 +732,7 @@ describe(EntityMutatorFactory, () => {
const spiedPrivacyPolicy = spy(privacyPolicy); const spiedPrivacyPolicy = spy(privacyPolicy);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadByIDAsync(id1)
); );
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync(); await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
@@ -771,7 +741,6 @@ describe(EntityMutatorFactory, () => {
spiedPrivacyPolicy.authorizeDeleteAsync( spiedPrivacyPolicy.authorizeDeleteAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
anything(),
anyOfClass(TestEntity), anyOfClass(TestEntity),
anything() anything()
) )
@@ -780,7 +749,6 @@ 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();
@@ -799,9 +767,7 @@ describe(EntityMutatorFactory, () => {
const triggerSpies = setUpMutationTriggerSpies(mutationTriggers); const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadByIDAsync(id1)
); );
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync(); await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
@@ -823,7 +789,6 @@ 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();
@@ -842,9 +807,7 @@ describe(EntityMutatorFactory, () => {
const validatorSpies = setUpMutationValidatorSpies(mutationValidators); const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
const existingEntity = await enforceAsyncResult( const existingEntity = await enforceAsyncResult(
entityLoaderFactory entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext)
.loadByIDAsync(id1)
); );
await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync(); await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
@@ -857,7 +820,6 @@ 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();
@@ -874,7 +836,7 @@ describe(EntityMutatorFactory, () => {
const entites1 = await enforceResultsAsync( const entites1 = await enforceResultsAsync(
entityLoaderFactory entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext) .forLoad(viewerContext, queryContext)
.loadManyByFieldEqualingAsync('stringField', 'huh') .loadManyByFieldEqualingAsync('stringField', 'huh')
); );
expect(entites1).toHaveLength(1); expect(entites1).toHaveLength(1);
@@ -888,7 +850,7 @@ describe(EntityMutatorFactory, () => {
const entities2 = await enforceResultsAsync( const entities2 = await enforceResultsAsync(
entityLoaderFactory entityLoaderFactory
.forLoad(viewerContext, queryContext, privacyPolicyEvaluationContext) .forLoad(viewerContext, queryContext)
.loadManyByFieldEqualingAsync('stringField', 'huh') .loadManyByFieldEqualingAsync('stringField', 'huh')
); );
expect(entities2).toHaveLength(2); expect(entities2).toHaveLength(2);
@@ -954,7 +916,6 @@ describe(EntityMutatorFactory, () => {
privacyPolicyMock.authorizeCreateAsync( privacyPolicyMock.authorizeCreateAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
anything(),
anyOfClass(SimpleTestEntity), anyOfClass(SimpleTestEntity),
anything() anything()
) )
@@ -963,7 +924,6 @@ describe(EntityMutatorFactory, () => {
privacyPolicyMock.authorizeUpdateAsync( privacyPolicyMock.authorizeUpdateAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
anything(),
anyOfClass(SimpleTestEntity), anyOfClass(SimpleTestEntity),
anything() anything()
) )
@@ -972,7 +932,6 @@ describe(EntityMutatorFactory, () => {
privacyPolicyMock.authorizeDeleteAsync( privacyPolicyMock.authorizeDeleteAsync(
viewerContext, viewerContext,
anyOfClass(EntityTransactionalQueryContext), anyOfClass(EntityTransactionalQueryContext),
anything(),
anyOfClass(SimpleTestEntity), anyOfClass(SimpleTestEntity),
anything() anything()
) )
Loaded 100 of 127 files, more files were not shown because too many files have changed in this diff. Show more