mirror of
https://github.com/expo/entity.git
synced 2026-11-13 20:28:06 -10:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 William Schurman
|
fa4e2484c9 |
No files matched your search
@@ -10,8 +10,7 @@
|
||||
"rules": {
|
||||
"no-restricted-imports": ["error",{ "paths": [".", "..", "../.."] }],
|
||||
"tsdoc/syntax": "warn",
|
||||
"no-console": "warn",
|
||||
"handle-callback-err": "off"
|
||||
"no-console": "warn"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
|
||||
-218
@@ -3,224 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add local memory cache package ([#158](https://github.com/expo/entity/issues/158)) ([85d3575](https://github.com/expo/entity/commit/85d35752fa0919a62efb776a762a6829e83ca7af))
|
||||
|
||||
### Chores
|
||||
|
||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
### Breaking changes
|
||||
|
||||
* Move data transforming responsibilities to the CacheAdapter instead of the ReadThroughEntityCache. Affects any classes extending the EntityCacheAdapter and relying on the transformation behavior of the ReadThroughEntityCache. ([#153](https://github.com/expo/entity/pull/153))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Upgrade knex to 1.x in `@expo/entity-database-adapter-knex` ([#150](https://github.com/expo/entity/issues/150)) ([e1b0ee5](https://github.com/expo/entity/commit/e1b0ee528175646239d88aa71ffce73983eeb52f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* separate post-commit invalidation callbacks from trigger and user callbacks ([#144](https://github.com/expo/entity/issues/144)) ([efa131e](https://github.com/expo/entity/commit/efa131ef29532accf0e51b6d867ffe15a27b4c90))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add authorization metrics ([#142](https://github.com/expo/entity/issues/142)) ([7cf54d8](https://github.com/expo/entity/commit/7cf54d83c52e104159a3e2e675cdda2d29afe204))
|
||||
* add IP support ([#138](https://github.com/expo/entity/issues/138)) ([1405a91](https://github.com/expo/entity/commit/1405a9126ee3a56c3e2a38bf3b697283744f5b5d))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* expose describeFieldTestCase for use in other packages ([#139](https://github.com/expo/entity/issues/139)) ([1220477](https://github.com/expo/entity/commit/1220477aa331349b482ad015b44f76fa2bda7b90))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
* use better QueryContext types for transactional triggers and validators ([#136](https://github.com/expo/entity/issues/136)) ([5c7efe1](https://github.com/expo/entity/commit/5c7efe1678424ff907687e9327175bdc2538c3e0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add IntField and FloatField, deprecate NumberField ([#131](https://github.com/expo/entity/issues/131)) ([2f2d963](https://github.com/expo/entity/commit/2f2d963cf92c6575d78f8eeca344a4aadcc9b8d9))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
|
||||
* upgrade some other packages to fix dependabot alerts ([#126](https://github.com/expo/entity/issues/126)) ([226bffe](https://github.com/expo/entity/commit/226bffe0a95d7b8a3e9e9d46aebdb0edf1eeec1a))
|
||||
* use column name instead of field name for redis cache key ([#124](https://github.com/expo/entity/issues/124)) ([d78f452](https://github.com/expo/entity/commit/d78f452bb3ac5527069813a03f5b2264375bd8ab))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add mutation type to validator and trigger execute functions ([#119](https://github.com/expo/entity/issues/119)) ([ef40fa5](https://github.com/expo/entity/commit/ef40fa5e9cdf53e25e78a9423c698e6d1c9737af))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* allow undefined value for all fields ([#114](https://github.com/expo/entity/issues/114)) ([022e0e9](https://github.com/expo/entity/commit/022e0e9b88a5e84e0c1bc6c8810c850beb05f0cf))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better typing on filterMap for use with predicates ([#106](https://github.com/expo/entity/issues/106)) ([01b3bfe](https://github.com/expo/entity/commit/01b3bfef7c6da55e7d89d8cccb52a0050187aee8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add type generic default in test utils ([#104](https://github.com/expo/entity/issues/104)) ([fe2917e](https://github.com/expo/entity/commit/fe2917e6b5af808f166aa354d476e168c41e6d21))
|
||||
* maps utils invariants for collections containing undefined values ([#103](https://github.com/expo/entity/issues/103)) ([29c1a43](https://github.com/expo/entity/commit/29c1a434ab6cd8d30e9f0e7c742065c8d46d8d8a))
|
||||
* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
|
||||
* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* fix null handling in load paths (try 2) ([#96](https://github.com/expo/entity/issues/96)) ([d960329](https://github.com/expo/entity/commit/d9603298e0cc5c3c2b0cca959876e9195555fb57))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.9.1](https://github.com/expo/entity/compare/v0.9.0...v0.9.1) (2020-11-06)
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -4,5 +4,5 @@
|
||||
],
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true,
|
||||
"version": "0.24.0"
|
||||
"version": "0.9.1"
|
||||
}
|
||||
+15
-23
@@ -1,14 +1,11 @@
|
||||
{
|
||||
"name": "root",
|
||||
"private": true,
|
||||
"workspaces": [
|
||||
"packages/*"
|
||||
],
|
||||
"workspaces": ["packages/*"],
|
||||
"scripts": {
|
||||
"tsc": "lerna run tsc",
|
||||
"clean": "lerna run clean",
|
||||
"lint": "lerna run lint",
|
||||
"lint-fix": "lerna run lint-fix",
|
||||
"test": "lerna run test",
|
||||
"integration": "./resources/run-with-docker lerna run integration-no-setup",
|
||||
"prepublish": "lerna link && lerna run clean",
|
||||
@@ -18,36 +15,31 @@
|
||||
"devDependencies": {
|
||||
"@expo/entity": "file:packages/entity",
|
||||
"@expo/results": "^1.0.0",
|
||||
"@types/lru-cache": "^5.1.1",
|
||||
"@types/invariant": "^2.2.33",
|
||||
"@types/ioredis": "^4.26.4",
|
||||
"@types/ioredis": "^4.17.3",
|
||||
"@types/jest": "^26.0.10",
|
||||
"@types/jsbn": "^1.2.29",
|
||||
"@types/node": "^14.6.0",
|
||||
"@types/uuid": "^8.3.0",
|
||||
"@typescript-eslint/eslint-plugin": "^4.14.0",
|
||||
"@typescript-eslint/parser": "^4.14.0",
|
||||
"@typescript-eslint/eslint-plugin": "^3.10.1",
|
||||
"@typescript-eslint/parser": "^3.10.1",
|
||||
"barrelsby": "^2.2.0",
|
||||
"eslint": "^7.7.0",
|
||||
"eslint-config-universe": "^7.0.0",
|
||||
"eslint-plugin-tsdoc": "^0.2.11",
|
||||
"jest": "^26.6.3",
|
||||
"lerna": "^4.0.0",
|
||||
"nullthrows": "^1.1.1",
|
||||
"pg": "^8.6.0",
|
||||
"prettier": "^2.3.2",
|
||||
"ts-jest": "~26.4.4",
|
||||
"eslint-config-universe": "^4.0.0",
|
||||
"eslint-plugin-tsdoc": "^0.2.6",
|
||||
"jest": "^26.4.2",
|
||||
"lerna": "^3.22.1",
|
||||
"pg": "^8.3.2",
|
||||
"prettier": "^2.1.0",
|
||||
"ts-jest": "~26.2.0",
|
||||
"ts-mockito": "^2.6.1",
|
||||
"typedoc": "^0.21.9",
|
||||
"typescript": "^4.4.2",
|
||||
"typedoc": "^0.17.6",
|
||||
"typedoc-plugin-lerna-packages": "^0.3.0",
|
||||
"typescript": "^4.0.2",
|
||||
"uuid": "^8.3.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@expo/entity": "file:packages/entity",
|
||||
"@expo/entity-cache-adapter-local-memory": "file:packages/entity-cache-adapter-local-memory",
|
||||
"@expo/entity-cache-adapter-redis": "file:packages/entity-cache-adapter-redis",
|
||||
"@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex",
|
||||
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis",
|
||||
"@expo/entity-ip-address-field": "file:packages/entity-ip-address-field"
|
||||
"@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex"
|
||||
}
|
||||
}
|
||||
@@ -1,11 +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.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add local memory cache package ([#158](https://github.com/expo/entity/issues/158)) ([85d3575](https://github.com/expo/entity/commit/85d35752fa0919a62efb776a762a6829e83ca7af))
|
||||
@@ -1,44 +0,0 @@
|
||||
# `@expo/entity-cache-adapter-local-memory`
|
||||
|
||||
Cross-request [LRU](https://github.com/isaacs/node-lru-cache) cache adapter for `@expo/entity`. Use
|
||||
this cache with caution - it is nonstandard. The cache is shared between requests in the node process.
|
||||
|
||||
## Why 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:
|
||||
|
||||
- The objects stored have high mutability
|
||||
- Reading a stale object from the cache is not acceptable in your application
|
||||
- Cross-box invalidation is not possible
|
||||
|
||||
## Typical use cases
|
||||
|
||||
If your application sees many requests fetching the same objects, you can save a trip to your cache
|
||||
cluster and backing datastore by using this in-memory cache. Here are some good use cases:
|
||||
|
||||
- The objects stored are mostly immutable
|
||||
- You have a low TTL setting in your cache
|
||||
|
||||
## Usage
|
||||
|
||||
During `EntityCompanionProvider` instantiation:
|
||||
|
||||
```typescript
|
||||
export const createDefaultEntityCompanionProvider = (
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
{
|
||||
...
|
||||
},
|
||||
{
|
||||
['local-memory']: {
|
||||
cacheAdapterProvider: new LocalMemoryCacheAdapterProvider.getProvider(),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
```
|
||||
@@ -1,38 +0,0 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-local-memory",
|
||||
"version": "0.24.0",
|
||||
"description": "Cross-request local memory cache adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
"src"
|
||||
],
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
],
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"lru-cache": "^7.3.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.24.0"
|
||||
}
|
||||
}
|
||||
@@ -1,146 +0,0 @@
|
||||
import { CacheLoadResult, CacheStatus, IEntityGenericCacher } from '@expo/entity';
|
||||
import LRUCache from 'lru-cache';
|
||||
|
||||
// Sentinel value we store in local memory to negatively cache a database miss.
|
||||
// The sentinel value is distinct from any (positively) cached value.
|
||||
export const DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = Symbol('doesNotExist');
|
||||
type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
|
||||
export type LocalMemoryCache<TFields> = LRUCache<string, LocalMemoryCacheValue<TFields>>;
|
||||
|
||||
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> {
|
||||
constructor(private readonly localMemoryCache: LocalMemoryCache<TFields>) {}
|
||||
|
||||
static createLRUCache<TFields>(
|
||||
options: { maxSize?: number; ttlSeconds?: number } = {}
|
||||
): LocalMemoryCache<TFields> {
|
||||
const DEFAULT_LRU_CACHE_MAX_AGE_SECONDS = 10;
|
||||
const DEFAULT_LRU_CACHE_SIZE = 10000;
|
||||
const maxAgeSeconds = options.ttlSeconds ?? DEFAULT_LRU_CACHE_MAX_AGE_SECONDS;
|
||||
const lruCacheOptions: LRUCacheOptionsV7<string, TFields> = {
|
||||
max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE,
|
||||
sizeCalculation: (value: LocalMemoryCacheValue<TFields>) =>
|
||||
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> {
|
||||
return new LRUCache<string, LocalMemoryCacheValue<TFields>>({
|
||||
max: 0,
|
||||
maxAge: -1,
|
||||
});
|
||||
}
|
||||
|
||||
public async loadManyAsync(
|
||||
keys: readonly string[]
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
||||
const cacheResults = new Map<string, CacheLoadResult<TFields>>();
|
||||
for (const key of keys) {
|
||||
const cacheResult = this.localMemoryCache.get(key);
|
||||
if (cacheResult === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE) {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
} else if (cacheResult) {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.HIT,
|
||||
item: cacheResult as unknown as TFields,
|
||||
});
|
||||
} else {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
}
|
||||
return cacheResults;
|
||||
}
|
||||
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void> {
|
||||
for (const [key, item] of objectMap) {
|
||||
this.localMemoryCache.set(key, item);
|
||||
}
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync(keys: readonly string[]): Promise<void> {
|
||||
for (const key of keys) {
|
||||
this.localMemoryCache.set(key, DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||
}
|
||||
}
|
||||
|
||||
public async invalidateManyAsync(keys: readonly string[]): Promise<void> {
|
||||
for (const key of keys) {
|
||||
this.localMemoryCache.del(key);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,28 +0,0 @@
|
||||
import { EntityConfiguration, PartsCacheAdapter, Parts } from '@expo/entity';
|
||||
import SimplePartsCacher from '@expo/entity/build/SimplePartsCacher';
|
||||
import invariant from 'invariant';
|
||||
|
||||
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
|
||||
|
||||
export default class LocalMemoryCacheAdapter<TFields> extends PartsCacheAdapter<TFields> {
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
localMemoryCache: LocalMemoryCache<TFields>
|
||||
) {
|
||||
super(
|
||||
entityConfiguration,
|
||||
new SimplePartsCacher(new GenericLocalMemoryCacher(localMemoryCache))
|
||||
);
|
||||
}
|
||||
|
||||
getParts<N extends keyof TFields>(fieldName: N, fieldValue: NonNullable<TFields[N]>): Parts {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${fieldName}`);
|
||||
return [
|
||||
this.entityConfiguration.tableName,
|
||||
`${this.entityConfiguration.cacheKeyVersion}`,
|
||||
columnName,
|
||||
String(fieldValue),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -1,45 +0,0 @@
|
||||
import {
|
||||
computeIfAbsent,
|
||||
EntityCacheAdapter,
|
||||
EntityConfiguration,
|
||||
IEntityCacheAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
|
||||
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
|
||||
import LocalMemoryCacheAdapter from './LocalMemoryCacheAdapter';
|
||||
|
||||
export class LocalMemoryCacheAdapterProvider implements IEntityCacheAdapterProvider {
|
||||
// local memory cache adapters should be shared/reused across requests
|
||||
static localMemoryCacheAdapterMap = new Map<string, LocalMemoryCacheAdapter<any>>();
|
||||
|
||||
static getNoOpProvider(): IEntityCacheAdapterProvider {
|
||||
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
|
||||
GenericLocalMemoryCacher.createNoOpCache<TFields>()
|
||||
);
|
||||
}
|
||||
|
||||
static getProvider(
|
||||
options: { maxSize?: number; ttlSeconds?: number } = {}
|
||||
): IEntityCacheAdapterProvider {
|
||||
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
|
||||
GenericLocalMemoryCacher.createLRUCache<TFields>(options)
|
||||
);
|
||||
}
|
||||
|
||||
private constructor(
|
||||
private readonly localMemoryCacheCreator: <TFields>() => LocalMemoryCache<TFields>
|
||||
) {}
|
||||
|
||||
public getCacheAdapter<TFields>(
|
||||
entityConfiguration: EntityConfiguration<TFields>
|
||||
): EntityCacheAdapter<TFields> {
|
||||
return computeIfAbsent(
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap,
|
||||
entityConfiguration.tableName,
|
||||
() => {
|
||||
const localMemoryCache = this.localMemoryCacheCreator<TFields>();
|
||||
return new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
-180
@@ -1,180 +0,0 @@
|
||||
import { CacheStatus, ViewerContext } from '@expo/entity';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import GenericLocalMemoryCacher from '../GenericLocalMemoryCacher';
|
||||
import LocalMemoryCacheAdapter from '../LocalMemoryCacheAdapter';
|
||||
import { LocalMemoryCacheAdapterProvider } from '../LocalMemoryCacheAdapterProvider';
|
||||
import LocalMemoryTestEntity from '../testfixtures/LocalMemoryTestEntity';
|
||||
import {
|
||||
createLocalMemoryIntegrationTestEntityCompanionProvider,
|
||||
createNoopLocalMemoryIntegrationTestEntityCompanionProvider,
|
||||
} from '../testfixtures/createLocalMemoryIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(LocalMemoryCacheAdapter, () => {
|
||||
beforeEach(async () => {
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.clear();
|
||||
});
|
||||
|
||||
it('has correct caching behavior', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||
);
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
|
||||
const date = new Date();
|
||||
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
const entity1 = await LocalMemoryTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
const entitySpecificGenericCacher =
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
|
||||
LocalMemoryTestEntity.getCompanionDefinition().entityConfiguration.tableName
|
||||
)!['partsCacher']['cacher'];
|
||||
const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', entity1.getID()),
|
||||
]);
|
||||
const cachedValue = cachedResult.get(cacheKeyMaker('id', entity1.getID()))!;
|
||||
expect(cachedValue).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: {
|
||||
id: entity1.getID(),
|
||||
name: 'blah',
|
||||
dateField: date,
|
||||
},
|
||||
});
|
||||
|
||||
// simulate non existent db fetch, should write negative result ('') to cache
|
||||
const nonExistentId = uuidv4();
|
||||
|
||||
const entityNonExistentResult = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
expect(entityNonExistentResult.ok).toBe(false);
|
||||
|
||||
const nonExistentCachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', nonExistentId),
|
||||
]);
|
||||
expect(nonExistentCachedResult.get(cacheKeyMaker('id', nonExistentId))).toMatchObject({
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
|
||||
// load again through entities framework to ensure it reads negative result
|
||||
const entityNonExistentResult2 = await LocalMemoryTestEntity.loader(
|
||||
viewerContext
|
||||
).loadByIDAsync(nonExistentId);
|
||||
expect(entityNonExistentResult2.ok).toBe(false);
|
||||
|
||||
// invalidate from cache to ensure it invalidates correctly
|
||||
await LocalMemoryTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
|
||||
const cachedResultMiss = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', entity1.getID()),
|
||||
]);
|
||||
const cachedValueMiss = cachedResultMiss.get(cacheKeyMaker('id', entity1.getID()));
|
||||
expect(cachedValueMiss).toMatchObject({ status: CacheStatus.MISS });
|
||||
});
|
||||
|
||||
it('shares the cache between different requests', async () => {
|
||||
const genericLocalMemoryCacherLoadManySpy = jest.spyOn(
|
||||
GenericLocalMemoryCacher.prototype as unknown as any,
|
||||
'loadManyAsync'
|
||||
);
|
||||
const viewerContext = new TestViewerContext(
|
||||
createLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||
);
|
||||
|
||||
const date = new Date();
|
||||
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
await LocalMemoryTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
// load entity with a different request
|
||||
const viewerContext2 = new TestViewerContext(
|
||||
createLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||
);
|
||||
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
expect(entity1WithVc2.getAllFields()).toMatchObject({
|
||||
id: entity1WithVc2.getID(),
|
||||
name: 'blah',
|
||||
dateField: date,
|
||||
});
|
||||
expect(genericLocalMemoryCacherLoadManySpy).toBeCalledWith([
|
||||
cacheKeyMaker('id', entity1WithVc2.getID()),
|
||||
]);
|
||||
expect(genericLocalMemoryCacherLoadManySpy).toBeCalledTimes(2);
|
||||
});
|
||||
|
||||
it('respects the parameters of a noop cache', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createNoopLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||
);
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
|
||||
const date = new Date();
|
||||
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity will try to put it in cache but it's a noop cache, so it should be a miss
|
||||
const entity1 = await LocalMemoryTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
const entitySpecificGenericCacher =
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
|
||||
LocalMemoryTestEntity.getCompanionDefinition().entityConfiguration.tableName
|
||||
)!['partsCacher']['cacher'];
|
||||
const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', entity1.getID()),
|
||||
]);
|
||||
const cachedValue = cachedResult.get(cacheKeyMaker('id', entity1.getID()))!;
|
||||
expect(cachedValue).toMatchObject({
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
|
||||
// a non existent db fetch should try to write negative result ('') but it's a noop cache, so it should be a miss
|
||||
const nonExistentId = uuidv4();
|
||||
|
||||
const entityNonExistentResult = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
expect(entityNonExistentResult.ok).toBe(false);
|
||||
|
||||
const nonExistentCachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||
cacheKeyMaker('id', nonExistentId),
|
||||
]);
|
||||
expect(nonExistentCachedResult.get(cacheKeyMaker('id', nonExistentId))).toMatchObject({
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
});
|
||||
});
|
||||
-125
@@ -1,125 +0,0 @@
|
||||
import { CacheStatus, UUIDField, EntityConfiguration } from '@expo/entity';
|
||||
|
||||
import GenericLocalMemoryCacher, {
|
||||
DOES_NOT_EXIST_LOCAL_MEMORY_CACHE,
|
||||
} from '../GenericLocalMemoryCacher';
|
||||
import LocalMemoryCacheAdapter from '../LocalMemoryCacheAdapter';
|
||||
|
||||
type BlahFields = {
|
||||
id: string;
|
||||
};
|
||||
|
||||
const entityConfiguration = new EntityConfiguration<BlahFields>({
|
||||
idField: 'id',
|
||||
tableName: 'blah',
|
||||
schema: {
|
||||
id: new UUIDField({ columnName: 'id', cache: true }),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'local-memory',
|
||||
});
|
||||
|
||||
describe(LocalMemoryCacheAdapter, () => {
|
||||
describe('loadManyAsync', () => {
|
||||
it('returns appropriate cache results', async () => {
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||
entityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache({
|
||||
maxSize: Number.MAX_SAFE_INTEGER,
|
||||
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||
})
|
||||
);
|
||||
|
||||
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
|
||||
await cacheAdapter.cacheManyAsync('id', cacheHits);
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', [
|
||||
'test-id-1',
|
||||
'test-id-2',
|
||||
'test-id-3',
|
||||
]);
|
||||
|
||||
expect(results.get('test-id-1')).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: { id: 'test-id-1' },
|
||||
});
|
||||
expect(results.get('test-id-2')).toMatchObject({ status: CacheStatus.NEGATIVE });
|
||||
expect(results.get('test-id-3')).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.size).toBe(3);
|
||||
});
|
||||
|
||||
it('returns empty map when passed empty array of fieldValues', async () => {
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||
entityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache({
|
||||
maxSize: Number.MAX_SAFE_INTEGER,
|
||||
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||
})
|
||||
);
|
||||
const results = await cacheAdapter.loadManyAsync('id', []);
|
||||
expect(results).toEqual(new Map());
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheManyAsync', () => {
|
||||
it('correctly caches all objects', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({
|
||||
maxSize: Number.MAX_SAFE_INTEGER,
|
||||
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||
});
|
||||
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
||||
|
||||
const cacheKey = cacheAdapter['partsCacher']['makeCacheKey']('id', 'test-id-1');
|
||||
expect(localMemoryCache.get(cacheKey)).toMatchObject({
|
||||
id: 'test-id-1',
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheDBMissesAsync', () => {
|
||||
it('correctly caches misses', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({
|
||||
maxSize: Number.MAX_SAFE_INTEGER,
|
||||
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||
});
|
||||
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']);
|
||||
|
||||
const cacheKey = cacheAdapter['partsCacher']['makeCacheKey']('id', 'test-id-1');
|
||||
expect(localMemoryCache.get(cacheKey)).toEqual(DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||
});
|
||||
});
|
||||
|
||||
describe('invalidateManyAsync', () => {
|
||||
it('invalidates correctly', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({
|
||||
maxSize: Number.MAX_SAFE_INTEGER,
|
||||
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||
});
|
||||
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
await cacheAdapter.invalidateManyAsync('id', ['test-id-1', 'test-id-2']);
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', ['test-id-1', 'test-id-2']);
|
||||
expect(results.get('test-id-1')).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.get('test-id-2')).toMatchObject({ status: CacheStatus.MISS });
|
||||
});
|
||||
|
||||
it('returns when passed empty array of fieldValues', async () => {
|
||||
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||
entityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache<BlahFields>({
|
||||
maxSize: Number.MAX_SAFE_INTEGER,
|
||||
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||
})
|
||||
);
|
||||
await cacheAdapter.invalidateManyAsync('id', []);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,100 +0,0 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
ViewerContext,
|
||||
UUIDField,
|
||||
DateField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
|
||||
export type LocalMemoryTestEntityFields = {
|
||||
id: string;
|
||||
name: string;
|
||||
dateField: Date | null;
|
||||
};
|
||||
|
||||
export default class LocalMemoryTestEntity extends Entity<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext
|
||||
> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntityPrivacyPolicy
|
||||
> {
|
||||
return localMemoryTestEntityCompanionDefinition;
|
||||
}
|
||||
}
|
||||
|
||||
export class LocalMemoryTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const localMemoryTestEntityConfiguration =
|
||||
new EntityConfiguration<LocalMemoryTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'local_memory_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
cache: true,
|
||||
}),
|
||||
dateField: new DateField({
|
||||
columnName: 'date_field',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'local-memory',
|
||||
});
|
||||
|
||||
const localMemoryTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: LocalMemoryTestEntity,
|
||||
entityConfiguration: localMemoryTestEntityConfiguration,
|
||||
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
|
||||
});
|
||||
-48
@@ -1,48 +0,0 @@
|
||||
import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
|
||||
import { LocalMemoryCacheAdapterProvider } from '../LocalMemoryCacheAdapterProvider';
|
||||
|
||||
export const createLocalMemoryIntegrationTestEntityCompanionProvider = (
|
||||
localMemoryOptions: { maxSize?: number; ttlSeconds?: number } = {},
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
const localMemoryCacheAdapterProvider =
|
||||
localMemoryOptions.maxSize === 0 && localMemoryOptions.ttlSeconds === 0
|
||||
? LocalMemoryCacheAdapterProvider.getNoOpProvider()
|
||||
: LocalMemoryCacheAdapterProvider.getProvider(localMemoryOptions);
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'local-memory',
|
||||
{
|
||||
cacheAdapterProvider: localMemoryCacheAdapterProvider,
|
||||
},
|
||||
],
|
||||
])
|
||||
);
|
||||
};
|
||||
|
||||
export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = (
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return createLocalMemoryIntegrationTestEntityCompanionProvider(
|
||||
{ maxSize: 0, ttlSeconds: 0 },
|
||||
metricsAdapter
|
||||
);
|
||||
};
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -3,156 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
### Chores
|
||||
|
||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
### Chores
|
||||
|
||||
* Move data transforming responsibilities to the CacheAdapter instead of the ReadThroughEntityCache. ([#153](https://github.com/expo/entity/pull/153))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
|
||||
* use column name instead of field name for redis cache key ([#124](https://github.com/expo/entity/issues/124)) ([d78f452](https://github.com/expo/entity/commit/d78f452bb3ac5527069813a03f5b2264375bd8ab))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.9.1](https://github.com/expo/entity/compare/v0.9.0...v0.9.1) (2020-11-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
@@ -12,7 +12,7 @@ During `EntityCompanionProvider` instantiation:
|
||||
import Redis from 'ioredis';
|
||||
|
||||
const redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
@@ -35,7 +35,7 @@ export const createDefaultEntityCompanionProvider = (
|
||||
...
|
||||
},
|
||||
{
|
||||
['redis']: {
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-redis",
|
||||
"version": "0.24.0",
|
||||
"version": "0.9.1",
|
||||
"description": "Redis cache adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -11,8 +11,7 @@
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
@@ -30,9 +29,9 @@
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"ioredis": "^4.27.3"
|
||||
"ioredis": "^4.17.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.24.0"
|
||||
"@expo/entity": "^0.9.1"
|
||||
}
|
||||
}
|
||||
@@ -1,124 +0,0 @@
|
||||
import {
|
||||
CacheLoadResult,
|
||||
CacheStatus,
|
||||
EntityConfiguration,
|
||||
transformCacheObjectToFields,
|
||||
transformFieldsToCacheObject,
|
||||
IEntityGenericCacher,
|
||||
} from '@expo/entity';
|
||||
import { Redis } from 'ioredis';
|
||||
|
||||
import { redisTransformerMap } from './RedisCommon';
|
||||
import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
|
||||
|
||||
// Sentinel value we store in Redis to negatively cache a database miss.
|
||||
// The sentinel value is distinct from any (positively) cached value.
|
||||
const DOES_NOT_EXIST_REDIS = '';
|
||||
|
||||
export interface GenericRedisCacheContext {
|
||||
/**
|
||||
* Instance of ioredis.Redis
|
||||
*/
|
||||
redisClient: Redis;
|
||||
|
||||
/**
|
||||
* TTL for caching database hits. Successive entity loads within this TTL
|
||||
* will be read from cache (unless invalidated).
|
||||
*/
|
||||
ttlSecondsPositive: number;
|
||||
|
||||
/**
|
||||
* TTL for negatively caching database misses. Successive entity loads within
|
||||
* this TTL will be assumed not present in the database (unless invalidated).
|
||||
*/
|
||||
ttlSecondsNegative: number;
|
||||
}
|
||||
|
||||
export default class GenericRedisCacher<TFields> implements IEntityGenericCacher<TFields> {
|
||||
constructor(
|
||||
private readonly context: GenericRedisCacheContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>
|
||||
) {}
|
||||
|
||||
public async loadManyAsync(
|
||||
keys: readonly string[]
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
||||
if (keys.length === 0) {
|
||||
return new Map();
|
||||
}
|
||||
|
||||
const redisResults = await wrapNativeRedisCallAsync(() =>
|
||||
this.context.redisClient.mget(...keys)
|
||||
);
|
||||
|
||||
const results = new Map<string, CacheLoadResult<TFields>>();
|
||||
for (let i = 0; i < keys.length; i++) {
|
||||
const key = keys[i]!;
|
||||
const redisResult = redisResults[i];
|
||||
|
||||
if (redisResult === DOES_NOT_EXIST_REDIS) {
|
||||
results.set(key, {
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
} else if (redisResult) {
|
||||
results.set(key, {
|
||||
status: CacheStatus.HIT,
|
||||
item: transformCacheObjectToFields(
|
||||
this.entityConfiguration,
|
||||
redisTransformerMap,
|
||||
JSON.parse(redisResult)
|
||||
),
|
||||
});
|
||||
} else {
|
||||
results.set(key, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void> {
|
||||
if (objectMap.size === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
let redisTransaction = this.context.redisClient.multi();
|
||||
objectMap.forEach((object, key) => {
|
||||
redisTransaction = redisTransaction.set(
|
||||
key,
|
||||
JSON.stringify(
|
||||
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
|
||||
),
|
||||
'EX',
|
||||
this.context.ttlSecondsPositive
|
||||
);
|
||||
});
|
||||
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync(keys: readonly string[]): Promise<void> {
|
||||
if (keys.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
let redisTransaction = this.context.redisClient.multi();
|
||||
keys.forEach((key) => {
|
||||
redisTransaction = redisTransaction.set(
|
||||
key,
|
||||
DOES_NOT_EXIST_REDIS,
|
||||
'EX',
|
||||
this.context.ttlSecondsNegative
|
||||
);
|
||||
});
|
||||
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
||||
}
|
||||
|
||||
public async invalidateManyAsync(keys: readonly string[]): Promise<void> {
|
||||
if (keys.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
await wrapNativeRedisCallAsync(() => this.context.redisClient.del(...keys));
|
||||
}
|
||||
}
|
||||
@@ -1,9 +1,17 @@
|
||||
import { EntityConfiguration, PartsCacheAdapter, Parts } from '@expo/entity';
|
||||
import SimplePartsCacher from '@expo/entity/build/SimplePartsCacher';
|
||||
import invariant from 'invariant';
|
||||
import {
|
||||
EntityCacheAdapter,
|
||||
EntityConfiguration,
|
||||
FieldTransformerMap,
|
||||
CacheLoadResult,
|
||||
CacheStatus,
|
||||
} from '@expo/entity';
|
||||
import { Redis } from 'ioredis';
|
||||
|
||||
import GenericRedisCacher from './GenericRedisCacher';
|
||||
import { redisTransformerMap } from './RedisCommon';
|
||||
|
||||
// Sentinel value we store in Redis to negatively cache a database miss.
|
||||
// The sentinel value is distinct from any (positively) cached value.
|
||||
const DOES_NOT_EXIST_REDIS = '';
|
||||
|
||||
export interface RedisCacheAdapterContext {
|
||||
/**
|
||||
@@ -42,36 +50,116 @@ export interface RedisCacheAdapterContext {
|
||||
ttlSecondsNegative: number;
|
||||
}
|
||||
|
||||
export default class RedisCacheAdapter<TFields> extends PartsCacheAdapter<TFields> {
|
||||
export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly context: RedisCacheAdapterContext
|
||||
) {
|
||||
super(
|
||||
entityConfiguration,
|
||||
new SimplePartsCacher(
|
||||
new GenericRedisCacher(
|
||||
{
|
||||
redisClient: context.redisClient,
|
||||
ttlSecondsNegative: context.ttlSecondsNegative,
|
||||
ttlSecondsPositive: context.ttlSecondsPositive,
|
||||
},
|
||||
entityConfiguration
|
||||
),
|
||||
context.makeKeyFn
|
||||
)
|
||||
);
|
||||
super(entityConfiguration);
|
||||
}
|
||||
|
||||
getParts<N extends keyof TFields>(fieldName: N, fieldValue: NonNullable<TFields[N]>): Parts {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${fieldName}`);
|
||||
return [
|
||||
public getFieldTransformerMap(): FieldTransformerMap {
|
||||
return redisTransformerMap;
|
||||
}
|
||||
|
||||
public async loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult>> {
|
||||
if (fieldValues.length === 0) {
|
||||
return new Map();
|
||||
}
|
||||
|
||||
const redisKeys = fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue));
|
||||
const redisResults = await this.context.redisClient.mget(...redisKeys);
|
||||
|
||||
const results = new Map<NonNullable<TFields[N]>, CacheLoadResult>();
|
||||
for (let i = 0; i < fieldValues.length; i++) {
|
||||
const fieldValue = fieldValues[i];
|
||||
const redisResult = redisResults[i];
|
||||
|
||||
if (redisResult === DOES_NOT_EXIST_REDIS) {
|
||||
results.set(fieldValue, {
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
} else if (redisResult) {
|
||||
results.set(fieldValue, {
|
||||
status: CacheStatus.HIT,
|
||||
item: JSON.parse(redisResult),
|
||||
});
|
||||
} else {
|
||||
results.set(fieldValue, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
public async cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, object>
|
||||
): Promise<void> {
|
||||
if (objectMap.size === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
let redisTransaction = this.context.redisClient.multi();
|
||||
objectMap.forEach((object, fieldValue) => {
|
||||
const redisKey = this.makeCacheKey(fieldName, fieldValue);
|
||||
redisTransaction = redisTransaction.set(
|
||||
redisKey,
|
||||
JSON.stringify(object),
|
||||
'EX',
|
||||
this.context.ttlSecondsPositive
|
||||
);
|
||||
});
|
||||
await redisTransaction.exec();
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
if (fieldValues.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
let redisTransaction = this.context.redisClient.multi();
|
||||
fieldValues.forEach((fieldValue) => {
|
||||
const redisKey = this.makeCacheKey(fieldName, fieldValue);
|
||||
redisTransaction = redisTransaction.set(
|
||||
redisKey,
|
||||
DOES_NOT_EXIST_REDIS,
|
||||
'EX',
|
||||
this.context.ttlSecondsNegative
|
||||
);
|
||||
});
|
||||
await redisTransaction.exec();
|
||||
}
|
||||
|
||||
public async invalidateManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
if (fieldValues.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
const redisKeys = fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue));
|
||||
await this.context.redisClient.del(...redisKeys);
|
||||
}
|
||||
|
||||
private makeCacheKey<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): string {
|
||||
return this.context.makeKeyFn(
|
||||
this.context.cacheKeyPrefix,
|
||||
this.entityConfiguration.tableName,
|
||||
`v2.${this.entityConfiguration.cacheKeyVersion}`,
|
||||
columnName,
|
||||
String(fieldValue),
|
||||
];
|
||||
`v${this.entityConfiguration.cacheKeyVersion}`,
|
||||
fieldName as string,
|
||||
String(fieldValue)
|
||||
);
|
||||
}
|
||||
}
|
||||
-125
@@ -1,125 +0,0 @@
|
||||
import { CacheStatus, ViewerContext } from '@expo/entity';
|
||||
import Redis from 'ioredis';
|
||||
import { URL } from 'url';
|
||||
|
||||
import GenericRedisCacher from '../GenericRedisCacher';
|
||||
import { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||
import RedisTestEntity, {
|
||||
redisTestEntityConfiguration,
|
||||
RedisTestEntityFields,
|
||||
} from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(GenericRedisCacher, () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||
);
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
afterAll(async () => {
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
it('has correct caching and loading behavior', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const genericRedisCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: redisCacheAdapterContext.redisClient,
|
||||
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||
},
|
||||
redisTestEntityConfiguration
|
||||
);
|
||||
const date = new Date();
|
||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
const testKey = `test-id-key-${entity1Created.getID()}`;
|
||||
const objectMap = new Map<string, Readonly<RedisTestEntityFields>>([
|
||||
[testKey, entity1Created.getAllFields()],
|
||||
]);
|
||||
await genericRedisCacher.cacheManyAsync(objectMap);
|
||||
|
||||
const cachedJSON = await redisCacheAdapterContext.redisClient.get(testKey);
|
||||
const cachedValue = JSON.parse(cachedJSON!);
|
||||
expect(cachedValue).toMatchObject({
|
||||
id: entity1Created.getID(),
|
||||
dateField: date.toISOString(),
|
||||
});
|
||||
|
||||
const loadedObjectMap = await genericRedisCacher.loadManyAsync([testKey]);
|
||||
const cacheLoadResult = loadedObjectMap.get(testKey)!;
|
||||
expect(cacheLoadResult).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: entity1Created.getAllFields(),
|
||||
});
|
||||
expect(loadedObjectMap.size).toBe(1);
|
||||
});
|
||||
it('has correct negative caching behaviour', async () => {
|
||||
const genericRedisCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: redisCacheAdapterContext.redisClient,
|
||||
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||
},
|
||||
redisTestEntityConfiguration
|
||||
);
|
||||
|
||||
const testKey = `test-id-key-non-existent-id`;
|
||||
await genericRedisCacher.cacheDBMissesAsync([testKey]);
|
||||
const loadedObjectMap = await genericRedisCacher.loadManyAsync([testKey]);
|
||||
const cacheLoadResult = loadedObjectMap.get(testKey)!;
|
||||
expect(cacheLoadResult.status).toBe(CacheStatus.NEGATIVE);
|
||||
});
|
||||
it('has correct invalidation behaviour', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const genericRedisCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: redisCacheAdapterContext.redisClient,
|
||||
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||
},
|
||||
redisTestEntityConfiguration
|
||||
);
|
||||
const date = new Date();
|
||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
const testKey = `test-id-key-${entity1Created.getID()}`;
|
||||
const objectMap = new Map<string, Readonly<RedisTestEntityFields>>([
|
||||
[testKey, entity1Created.getAllFields()],
|
||||
]);
|
||||
await genericRedisCacher.cacheManyAsync(objectMap);
|
||||
|
||||
await genericRedisCacher.invalidateManyAsync([testKey]);
|
||||
|
||||
const loadedObjectMap = await genericRedisCacher.loadManyAsync([testKey]);
|
||||
const cacheLoadResult = loadedObjectMap.get(testKey)!;
|
||||
expect(cacheLoadResult.status).toBe(CacheStatus.MISS);
|
||||
});
|
||||
});
|
||||
+11
-39
@@ -15,7 +15,7 @@ describe(RedisCacheAdapter, () => {
|
||||
|
||||
beforeAll(() => {
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
@@ -38,21 +38,21 @@ describe(RedisCacheAdapter, () => {
|
||||
});
|
||||
|
||||
it('has correct caching behavior', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
const vc1 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
const cacheAdapter = vc1.entityCompanionProvider.getCompanionForEntity(
|
||||
RedisTestEntity,
|
||||
RedisTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
|
||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||
const entity1Created = await RedisTestEntity.creator(vc1)
|
||||
.setField('name', 'blah')
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
const entity1 = await RedisTestEntity.loader(viewerContext)
|
||||
const entity1 = await RedisTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
@@ -68,9 +68,7 @@ describe(RedisCacheAdapter, () => {
|
||||
// simulate non existent db fetch, should write negative result ('') to cache
|
||||
const nonExistentId = uuidv4();
|
||||
|
||||
const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
const entityNonExistentResult = await RedisTestEntity.loader(vc1).loadByIDAsync(nonExistentId);
|
||||
expect(entityNonExistentResult.ok).toBe(false);
|
||||
|
||||
const nonExistentCachedValue = await redisCacheAdapterContext.redisClient.get(
|
||||
@@ -79,13 +77,11 @@ describe(RedisCacheAdapter, () => {
|
||||
expect(nonExistentCachedValue).toEqual('');
|
||||
|
||||
// load again through entities framework to ensure it reads negative result
|
||||
const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
const entityNonExistentResult2 = await RedisTestEntity.loader(vc1).loadByIDAsync(nonExistentId);
|
||||
expect(entityNonExistentResult2.ok).toBe(false);
|
||||
|
||||
// invalidate from cache to ensure it invalidates correctly
|
||||
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
|
||||
await RedisTestEntity.loader(vc1).invalidateFieldsAsync(entity1.getAllFields());
|
||||
const cachedValueNull = await redisCacheAdapterContext.redisClient.get(
|
||||
cacheKeyMaker('id', entity1.getID())
|
||||
);
|
||||
@@ -93,18 +89,16 @@ describe(RedisCacheAdapter, () => {
|
||||
});
|
||||
|
||||
it('caches and restores date fields', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
const vc1 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const date = new Date();
|
||||
const entity1 = await enforceAsyncResult(
|
||||
RedisTestEntity.creator(viewerContext).setField('dateField', date).createAsync()
|
||||
RedisTestEntity.creator(vc1).setField('dateField', date).createAsync()
|
||||
);
|
||||
expect(entity1.getField('dateField')).toEqual(date);
|
||||
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1.getID());
|
||||
const entity2 = await RedisTestEntity.loader(vc1).enforcing().loadByIDAsync(entity1.getID());
|
||||
expect(entity2.getField('dateField')).toEqual(date);
|
||||
|
||||
// simulate new request
|
||||
@@ -114,26 +108,4 @@ describe(RedisCacheAdapter, () => {
|
||||
const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
|
||||
expect(entity3.getField('dateField')).toEqual(date);
|
||||
});
|
||||
|
||||
it('caches and restores empty string field keys', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity1 = await enforceAsyncResult(
|
||||
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
|
||||
);
|
||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', '');
|
||||
expect(entity2?.getID()).toEqual(entity1.getID());
|
||||
|
||||
// simulate new request
|
||||
const vc2 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity3 = await RedisTestEntity.loader(vc2)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', '');
|
||||
expect(entity3?.getID()).toEqual(entity1.getID());
|
||||
});
|
||||
});
|
||||
@@ -1,46 +0,0 @@
|
||||
import { EntityCacheAdapterTransientError, ViewerContext } from '@expo/entity';
|
||||
import Redis from 'ioredis';
|
||||
import { URL } from 'url';
|
||||
|
||||
import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(RedisCacheAdapter, () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||
);
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
|
||||
it('throws when redis is disconnected', async () => {
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
|
||||
const vc1 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
await expect(
|
||||
RedisTestEntity.creator(vc1).setField('name', 'blah').enforceCreateAsync()
|
||||
).rejects.toThrow(EntityCacheAdapterTransientError);
|
||||
});
|
||||
});
|
||||
@@ -1,4 +1,10 @@
|
||||
import { CacheStatus, UUIDField, EntityConfiguration } from '@expo/entity';
|
||||
import {
|
||||
CacheStatus,
|
||||
UUIDField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
} from '@expo/entity';
|
||||
import { Redis, Pipeline } from 'ioredis';
|
||||
import { mock, when, instance, anything, verify } from 'ts-mockito';
|
||||
|
||||
@@ -14,8 +20,8 @@ const entityConfiguration = new EntityConfiguration<BlahFields>({
|
||||
schema: {
|
||||
id: new UUIDField({ columnName: 'id', cache: true }),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
describe(RedisCacheAdapter, () => {
|
||||
@@ -39,11 +45,8 @@ describe(RedisCacheAdapter, () => {
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
|
||||
redisResults.set(
|
||||
cacheAdapter['partsCacher']['makeCacheKey']('id', 'wat'),
|
||||
JSON.stringify({ id: 'wat' })
|
||||
);
|
||||
redisResults.set(cacheAdapter['partsCacher']['makeCacheKey']('id', 'who'), '');
|
||||
redisResults.set(cacheAdapter['makeCacheKey']('id', 'wat'), JSON.stringify({ id: 'wat' }));
|
||||
redisResults.set(cacheAdapter['makeCacheKey']('id', 'who'), '');
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', ['wat', 'who', 'why']);
|
||||
|
||||
@@ -94,7 +97,7 @@ describe(RedisCacheAdapter, () => {
|
||||
});
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['wat', { id: 'wat' }]]));
|
||||
|
||||
const cacheKey = cacheAdapter['partsCacher']['makeCacheKey']('id', 'wat');
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'wat');
|
||||
expect(redisResults.get(cacheKey)).toMatchObject({
|
||||
value: JSON.stringify({ id: 'wat' }),
|
||||
code: 'EX',
|
||||
@@ -129,7 +132,7 @@ describe(RedisCacheAdapter, () => {
|
||||
});
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['wat']);
|
||||
|
||||
const cacheKey = cacheAdapter['partsCacher']['makeCacheKey']('id', 'wat');
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'wat');
|
||||
expect(redisResults.get(cacheKey)).toMatchObject({
|
||||
value: '',
|
||||
code: 'EX',
|
||||
@@ -153,7 +156,7 @@ describe(RedisCacheAdapter, () => {
|
||||
});
|
||||
await cacheAdapter.invalidateManyAsync('id', ['wat']);
|
||||
|
||||
const cacheKey = cacheAdapter['partsCacher']['makeCacheKey']('id', 'wat');
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'wat');
|
||||
verify(mockRedisClient.del(cacheKey)).once();
|
||||
});
|
||||
|
||||
|
||||
-39
@@ -1,39 +0,0 @@
|
||||
import { EntityCacheAdapterTransientError } from '@expo/entity';
|
||||
|
||||
import wrapNativeRedisCallAsync from '../wrapNativeRedisCallAsync';
|
||||
|
||||
describe(wrapNativeRedisCallAsync, () => {
|
||||
it('rethrows literals', async () => {
|
||||
const throwingFn = async (): Promise<void> => {
|
||||
// eslint-disable-next-line no-throw-literal,@typescript-eslint/no-throw-literal
|
||||
throw 'hello';
|
||||
};
|
||||
|
||||
let capturedThrownThing: any;
|
||||
try {
|
||||
await wrapNativeRedisCallAsync(throwingFn);
|
||||
} catch (e) {
|
||||
capturedThrownThing = e;
|
||||
}
|
||||
expect(capturedThrownThing).not.toBeInstanceOf(Error);
|
||||
expect(capturedThrownThing).toEqual('hello');
|
||||
});
|
||||
|
||||
it('wraps errors with stacks', async () => {
|
||||
const throwingFn = async (): Promise<void> => {
|
||||
const e = new Error('hello');
|
||||
e.stack = 'world';
|
||||
throw e;
|
||||
};
|
||||
|
||||
let capturedThrownThing: any;
|
||||
try {
|
||||
await wrapNativeRedisCallAsync(throwingFn);
|
||||
} catch (e) {
|
||||
capturedThrownThing = e;
|
||||
}
|
||||
expect(capturedThrownThing).toBeInstanceOf(EntityCacheAdapterTransientError);
|
||||
expect(capturedThrownThing.message).toEqual('hello');
|
||||
expect(capturedThrownThing.stack).toEqual('world');
|
||||
});
|
||||
});
|
||||
@@ -1,17 +0,0 @@
|
||||
import { EntityCacheAdapterTransientError } from '@expo/entity';
|
||||
|
||||
export default async function wrapNativeRedisCallAsync<T>(fn: () => Promise<T>): Promise<T> {
|
||||
try {
|
||||
return await fn();
|
||||
} catch (e) {
|
||||
if (!(e instanceof Error)) {
|
||||
throw e;
|
||||
}
|
||||
|
||||
const error = new EntityCacheAdapterTransientError(e.message, e);
|
||||
if (e.stack) {
|
||||
error.stack = e.stack;
|
||||
}
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
@@ -1,12 +1,8 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-cache-adapter-redis
|
||||
* Automatically generated by barrelsby.
|
||||
*/
|
||||
|
||||
export { default as RedisCacheAdapter } from './RedisCacheAdapter';
|
||||
export * from './RedisCacheAdapter';
|
||||
export { default as RedisCacheAdapterProvider } from './RedisCacheAdapterProvider';
|
||||
export * from './RedisCommon';
|
||||
export { default as GenericRedisCacher } from './GenericRedisCacher';
|
||||
export * from './GenericRedisCacher';
|
||||
@@ -6,6 +6,8 @@ import {
|
||||
DateField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
@@ -28,13 +30,13 @@ export default class RedisTestEntity extends Entity<RedisTestEntityFields, strin
|
||||
}
|
||||
}
|
||||
|
||||
export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
@@ -42,7 +44,7 @@ export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
@@ -50,7 +52,7 @@ export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
@@ -58,7 +60,7 @@ export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
@@ -78,14 +80,13 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
cache: true,
|
||||
}),
|
||||
dateField: new DateField({
|
||||
columnName: 'date_field',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
|
||||
+13
-17
@@ -2,6 +2,8 @@ import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
@@ -15,22 +17,16 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
{
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
},
|
||||
{
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -3,178 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Upgrade knex to 1.x in `@expo/entity-database-adapter-knex` ([#150](https://github.com/expo/entity/issues/150)) ([e1b0ee5](https://github.com/expo/entity/commit/e1b0ee528175646239d88aa71ffce73983eeb52f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add IntField and FloatField, deprecate NumberField ([#131](https://github.com/expo/entity/issues/131)) ([2f2d963](https://github.com/expo/entity/commit/2f2d963cf92c6575d78f8eeca344a4aadcc9b8d9))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
|
||||
* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.9.1](https://github.com/expo/entity/compare/v0.9.0...v0.9.1) (2020-11-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
@@ -9,16 +9,16 @@
|
||||
During `EntityCompanionProvider` instantiation:
|
||||
|
||||
```typescript
|
||||
import { knex, Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
const knexInstance = knex({
|
||||
const knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: process.env['PGUSER'],
|
||||
password: process.env['PGPASSWORD'],
|
||||
host: process.env['PGHOST'],
|
||||
port: parseInt(nullthrows(process.env['PGPORT']), 10),
|
||||
database: process.env['PGDATABASE'],
|
||||
user: process.env.PGUSER,
|
||||
password: process.env.PGPASSWORD,
|
||||
host: process.env.PGHOST,
|
||||
port: parseInt(process.env.PGPORT!, 10),
|
||||
database: process.env.PGDATABASE,
|
||||
},
|
||||
});
|
||||
|
||||
@@ -29,7 +29,7 @@ export const createDefaultEntityCompanionProvider = (
|
||||
metricsAdapter,
|
||||
{
|
||||
// add the knex database adapter flavor
|
||||
['postgres']: {
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapter: PostgresEntityDatabaseAdapter,
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knexInstance),
|
||||
},
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-database-adapter-knex",
|
||||
"version": "0.24.0",
|
||||
"version": "0.9.1",
|
||||
"description": "Knex database adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -11,8 +11,7 @@
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
@@ -30,10 +29,9 @@
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"knex": "^1.0.2"
|
||||
"knex": "^0.21.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.24.0",
|
||||
"pg": "^8.7.1"
|
||||
"@expo/entity": "^0.9.1"
|
||||
}
|
||||
}
|
||||
@@ -8,9 +8,7 @@ import {
|
||||
TableFieldSingleValueEqualityCondition,
|
||||
TableFieldMultiValueEqualityCondition,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
import wrapNativePostgresCallAsync from './errors/wrapNativePostgresCallAsync';
|
||||
import Knex from 'knex';
|
||||
|
||||
export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDatabaseAdapter<TFields> {
|
||||
protected getFieldTransformerMap(): FieldTransformerMap {
|
||||
@@ -45,12 +43,10 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
tableField: string,
|
||||
tableValues: readonly any[]
|
||||
): Promise<object[]> {
|
||||
return await wrapNativePostgresCallAsync(() =>
|
||||
queryInterface
|
||||
.select()
|
||||
.from(tableName)
|
||||
.whereRaw('?? = ANY(?)', [tableField, tableValues as any[]])
|
||||
);
|
||||
return await queryInterface
|
||||
.select()
|
||||
.from(tableName)
|
||||
.whereRaw('?? = ANY(?)', [tableField, tableValues as any[]]);
|
||||
}
|
||||
|
||||
private applyQueryModifiersToQuery(
|
||||
@@ -89,39 +85,20 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
|
||||
if (tableFieldSingleValueEqualityOperands.length > 0) {
|
||||
const whereObject: { [key: string]: any } = {};
|
||||
const nonNullTableFieldSingleValueEqualityOperands =
|
||||
tableFieldSingleValueEqualityOperands.filter(({ tableValue }) => tableValue !== null);
|
||||
const nullTableFieldSingleValueEqualityOperands =
|
||||
tableFieldSingleValueEqualityOperands.filter(({ tableValue }) => tableValue === null);
|
||||
|
||||
if (nonNullTableFieldSingleValueEqualityOperands.length > 0) {
|
||||
for (const { tableField, tableValue } of nonNullTableFieldSingleValueEqualityOperands) {
|
||||
whereObject[tableField] = tableValue;
|
||||
}
|
||||
query = query.where(whereObject);
|
||||
}
|
||||
if (nullTableFieldSingleValueEqualityOperands.length > 0) {
|
||||
for (const { tableField } of nullTableFieldSingleValueEqualityOperands) {
|
||||
query = query.whereNull(tableField);
|
||||
}
|
||||
for (const { tableField, tableValue } of tableFieldSingleValueEqualityOperands) {
|
||||
whereObject[tableField] = tableValue;
|
||||
}
|
||||
query = query.where(whereObject);
|
||||
}
|
||||
|
||||
if (tableFieldMultiValueEqualityOperands.length > 0) {
|
||||
for (const { tableField, tableValues } of tableFieldMultiValueEqualityOperands) {
|
||||
const nonNullTableValues = tableValues.filter((tableValue) => tableValue !== null);
|
||||
query = query.where((builder) => {
|
||||
builder.whereRaw('?? = ANY(?)', [tableField, [...nonNullTableValues]]);
|
||||
// there was at least one null, allow null in this equality clause
|
||||
if (nonNullTableValues.length !== tableValues.length) {
|
||||
builder.orWhereNull(tableField);
|
||||
}
|
||||
});
|
||||
query = query.whereRaw('?? = ANY(?)', [tableField, tableValues]);
|
||||
}
|
||||
}
|
||||
|
||||
query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
|
||||
return await wrapNativePostgresCallAsync(() => query);
|
||||
return await query;
|
||||
}
|
||||
|
||||
protected async fetchManyByRawWhereClauseInternalAsync(
|
||||
@@ -136,7 +113,7 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
.from(tableName)
|
||||
.whereRaw(rawWhereClause, bindings as any);
|
||||
query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
|
||||
return await wrapNativePostgresCallAsync(() => query);
|
||||
return await query;
|
||||
}
|
||||
|
||||
protected async insertInternalAsync(
|
||||
@@ -144,9 +121,7 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
tableName: string,
|
||||
object: object
|
||||
): Promise<object[]> {
|
||||
return await wrapNativePostgresCallAsync(() =>
|
||||
queryInterface.insert(object).into(tableName).returning('*')
|
||||
);
|
||||
return await queryInterface.insert(object).into(tableName).returning('*');
|
||||
}
|
||||
|
||||
protected async updateInternalAsync(
|
||||
@@ -156,9 +131,11 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
id: any,
|
||||
object: object
|
||||
): Promise<object[]> {
|
||||
return await wrapNativePostgresCallAsync(() =>
|
||||
queryInterface.update(object).into(tableName).where(tableIdField, id).returning('*')
|
||||
);
|
||||
return await queryInterface
|
||||
.update(object)
|
||||
.into(tableName)
|
||||
.where(tableIdField, id)
|
||||
.returning('*');
|
||||
}
|
||||
|
||||
protected async deleteInternalAsync(
|
||||
@@ -167,8 +144,6 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
tableIdField: string,
|
||||
id: any
|
||||
): Promise<number> {
|
||||
return await wrapNativePostgresCallAsync(() =>
|
||||
queryInterface.into(tableName).where(tableIdField, id).del()
|
||||
);
|
||||
return await queryInterface.into(tableName).where(tableIdField, id).del();
|
||||
}
|
||||
}
|
||||
@@ -7,8 +7,7 @@ import {
|
||||
import PostgresEntityDatabaseAdapter from './PostgresEntityDatabaseAdapter';
|
||||
|
||||
export default class PostgresEntityDatabaseAdapterProvider
|
||||
implements IEntityDatabaseAdapterProvider
|
||||
{
|
||||
implements IEntityDatabaseAdapterProvider {
|
||||
getDatabaseAdapter<TFields>(
|
||||
entityConfiguration: EntityConfiguration<TFields>
|
||||
): EntityDatabaseAdapter<TFields> {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { EntityQueryContextProvider } from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
/**
|
||||
* Query context provider for knex (postgres).
|
||||
|
||||
+7
-94
@@ -5,8 +5,7 @@ import {
|
||||
ViewerContext,
|
||||
} from '@expo/entity';
|
||||
import { enforceAsyncResult } from '@expo/results';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
import Knex from 'knex';
|
||||
|
||||
import PostgresTestEntity from '../testfixtures/PostgresTestEntity';
|
||||
import PostgresTriggerTestEntity from '../testfixtures/PostgresTriggerTestEntity';
|
||||
@@ -17,14 +16,14 @@ describe('postgres entity integration', () => {
|
||||
let knexInstance: Knex;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: nullthrows(process.env['PGUSER']),
|
||||
password: nullthrows(process.env['PGPASSWORD']),
|
||||
user: process.env.PGUSER,
|
||||
password: process.env.PGPASSWORD,
|
||||
host: 'localhost',
|
||||
port: parseInt(nullthrows(process.env['PGPORT']), 10),
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
port: parseInt(process.env.PGPORT!, 10),
|
||||
database: process.env.PGDATABASE,
|
||||
},
|
||||
});
|
||||
});
|
||||
@@ -95,7 +94,7 @@ describe('postgres entity integration', () => {
|
||||
const errorToThrow = new Error('Intentional error');
|
||||
|
||||
await expect(
|
||||
vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
PostgresTestEntity.runInTransactionAsync(vc1, async (queryContext) => {
|
||||
// put another in the DB that will be rolled back due to error thrown
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1, queryContext).setField('name', 'hello').createAsync()
|
||||
@@ -232,59 +231,6 @@ describe('postgres entity integration', () => {
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results.map((e) => e.getField('name'))).toEqual(['b', 'a']);
|
||||
});
|
||||
|
||||
it('supports null field values', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1)
|
||||
.setField('name', 'a')
|
||||
.setField('hasADog', true)
|
||||
.createAsync()
|
||||
);
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1)
|
||||
.setField('name', 'b')
|
||||
.setField('hasADog', true)
|
||||
.createAsync()
|
||||
);
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1)
|
||||
.setField('name', null)
|
||||
.setField('hasADog', true)
|
||||
.createAsync()
|
||||
);
|
||||
await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1)
|
||||
.setField('name', null)
|
||||
.setField('hasADog', false)
|
||||
.createAsync()
|
||||
);
|
||||
|
||||
const results = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([{ fieldName: 'name', fieldValue: null }]);
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results[0]!.getField('name')).toBeNull();
|
||||
|
||||
const results2 = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync(
|
||||
[
|
||||
{ fieldName: 'name', fieldValues: ['a', null] },
|
||||
{ fieldName: 'hasADog', fieldValue: true },
|
||||
],
|
||||
{
|
||||
orderBy: [
|
||||
{
|
||||
fieldName: 'name',
|
||||
order: OrderByOrdering.DESCENDING,
|
||||
},
|
||||
],
|
||||
}
|
||||
);
|
||||
expect(results2).toHaveLength(2);
|
||||
expect(results2.map((e) => e.getField('name'))).toEqual([null, 'a']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('raw where clause loading', () => {
|
||||
@@ -600,37 +546,4 @@ describe('postgres entity integration', () => {
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('queryContext callback behavior', () => {
|
||||
it('calls callbacks correctly', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
let preCommitCallCount = 0;
|
||||
let postCommitCallCount = 0;
|
||||
|
||||
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
queryContext.appendPostCommitCallback(async () => {
|
||||
postCommitCallCount++;
|
||||
});
|
||||
queryContext.appendPreCommitCallback(async () => {
|
||||
preCommitCallCount++;
|
||||
}, 0);
|
||||
});
|
||||
|
||||
await expect(
|
||||
vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
queryContext.appendPostCommitCallback(async () => {
|
||||
postCommitCallCount++;
|
||||
});
|
||||
queryContext.appendPreCommitCallback(async () => {
|
||||
preCommitCallCount++;
|
||||
throw Error('wat');
|
||||
}, 0);
|
||||
})
|
||||
).rejects.toThrowError('wat');
|
||||
|
||||
expect(preCommitCallCount).toBe(2);
|
||||
expect(postCommitCallCount).toBe(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
+6
-7
@@ -1,7 +1,6 @@
|
||||
import { ViewerContext } from '@expo/entity';
|
||||
import { enforceAsyncResult } from '@expo/results';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
import Knex from 'knex';
|
||||
|
||||
import InvalidTestEntity from '../testfixtures/InvalidTestEntity';
|
||||
import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
|
||||
@@ -10,14 +9,14 @@ describe('postgres entity integration', () => {
|
||||
let knexInstance: Knex;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: nullthrows(process.env['PGUSER']),
|
||||
password: nullthrows(process.env['PGPASSWORD']),
|
||||
user: process.env.PGUSER,
|
||||
password: process.env.PGPASSWORD,
|
||||
host: 'localhost',
|
||||
port: parseInt(nullthrows(process.env['PGPORT']), 10),
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
port: parseInt(process.env.PGPORT!, 10),
|
||||
database: process.env.PGDATABASE,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,171 +0,0 @@
|
||||
import {
|
||||
ViewerContext,
|
||||
EntityDatabaseAdapterCheckConstraintError,
|
||||
EntityDatabaseAdapterExclusionConstraintError,
|
||||
EntityDatabaseAdapterForeignKeyConstraintError,
|
||||
EntityDatabaseAdapterNotNullConstraintError,
|
||||
EntityDatabaseAdapterTransientError,
|
||||
EntityDatabaseAdapterUniqueConstraintError,
|
||||
EntityDatabaseAdapterUnknownError,
|
||||
} from '@expo/entity';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import ErrorsTestEntity from '../testfixtures/ErrorsTestEntity';
|
||||
import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
|
||||
|
||||
describe('postgres errors', () => {
|
||||
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 ErrorsTestEntity.createOrTruncatePostgresTable(knexInstance);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await ErrorsTestEntity.dropPostgresTable(knexInstance);
|
||||
await knexInstance.destroy();
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterTransientError on Knex timeout', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
const shortTimeoutKnexInstance = knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: nullthrows(process.env['PGUSER']),
|
||||
password: nullthrows(process.env['PGPASSWORD']),
|
||||
host: 'localhost',
|
||||
port: parseInt(nullthrows(process.env['PGPORT']), 10),
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
},
|
||||
acquireConnectionTimeout: 1,
|
||||
});
|
||||
const vc2 = new ViewerContext(
|
||||
createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance)
|
||||
);
|
||||
await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow(
|
||||
EntityDatabaseAdapterTransientError
|
||||
);
|
||||
await shortTimeoutKnexInstance.destroy();
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterNotNullConstraintError when not null is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', null as any)
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterNotNullConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterForeignKeyConstraintError when foreign key is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldForeignKey', 2)
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterForeignKeyConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterUniqueConstraintError when primary key unique constraint is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
await ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterUniqueConstraintError when unique constraint is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 2)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldUnique', 'hello')
|
||||
.enforceCreateAsync();
|
||||
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldUnique', 'hello')
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterCheckConstraintError when check constraint is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('checkLessThan5', 2)
|
||||
.enforceCreateAsync()
|
||||
).resolves.toBeTruthy();
|
||||
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 2)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('checkLessThan5', 10)
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterCheckConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterExclusionConstraintError when exclusion constraint is violated', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldExclusion', 'what')
|
||||
.enforceCreateAsync()
|
||||
).resolves.toBeTruthy();
|
||||
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 2)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('fieldExclusion', 'what')
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterExclusionConstraintError);
|
||||
});
|
||||
|
||||
it('throws EntityDatabaseAdapterUnknownError otherwise', async () => {
|
||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
await expect(
|
||||
ErrorsTestEntity.creator(vc)
|
||||
.setField('id', 1)
|
||||
.setField('fieldNonNull', 'hello')
|
||||
.setField('nonExistentColumn', 'what')
|
||||
.enforceCreateAsync()
|
||||
).rejects.toThrow(EntityDatabaseAdapterUnknownError);
|
||||
});
|
||||
});
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
import wrapNativePostgresCallAsync from '../wrapNativePostgresCallAsync';
|
||||
|
||||
describe(wrapNativePostgresCallAsync, () => {
|
||||
it('rethrows literals', async () => {
|
||||
const throwingFn = async (): Promise<void> => {
|
||||
// eslint-disable-next-line no-throw-literal,@typescript-eslint/no-throw-literal
|
||||
throw 'hello';
|
||||
};
|
||||
|
||||
let capturedThrownThing: any;
|
||||
try {
|
||||
await wrapNativePostgresCallAsync(throwingFn);
|
||||
} catch (e) {
|
||||
capturedThrownThing = e;
|
||||
}
|
||||
expect(capturedThrownThing).not.toBeInstanceOf(Error);
|
||||
expect(capturedThrownThing).toEqual('hello');
|
||||
});
|
||||
});
|
||||
@@ -1,55 +0,0 @@
|
||||
import {
|
||||
EntityDatabaseAdapterError,
|
||||
EntityDatabaseAdapterCheckConstraintError,
|
||||
EntityDatabaseAdapterExclusionConstraintError,
|
||||
EntityDatabaseAdapterForeignKeyConstraintError,
|
||||
EntityDatabaseAdapterNotNullConstraintError,
|
||||
EntityDatabaseAdapterTransientError,
|
||||
EntityDatabaseAdapterUniqueConstraintError,
|
||||
EntityDatabaseAdapterUnknownError,
|
||||
} from '@expo/entity';
|
||||
import { knex } from 'knex';
|
||||
|
||||
function wrapNativePostgresError(
|
||||
error: Error & { code?: string }
|
||||
): EntityDatabaseAdapterError & Error {
|
||||
const ret = translatePostgresError(error);
|
||||
if (error.stack) {
|
||||
ret.stack = error.stack;
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
function translatePostgresError(
|
||||
error: Error & { code?: string }
|
||||
): EntityDatabaseAdapterError & Error {
|
||||
if (error instanceof knex.KnexTimeoutError) {
|
||||
return new EntityDatabaseAdapterTransientError(error.message, error);
|
||||
}
|
||||
|
||||
switch (error.code) {
|
||||
case '23502':
|
||||
return new EntityDatabaseAdapterNotNullConstraintError(error.message, error);
|
||||
case '23503':
|
||||
return new EntityDatabaseAdapterForeignKeyConstraintError(error.message, error);
|
||||
case '23505':
|
||||
return new EntityDatabaseAdapterUniqueConstraintError(error.message, error);
|
||||
case '23514':
|
||||
return new EntityDatabaseAdapterCheckConstraintError(error.message, error);
|
||||
case '23P01':
|
||||
return new EntityDatabaseAdapterExclusionConstraintError(error.message, error);
|
||||
default:
|
||||
return new EntityDatabaseAdapterUnknownError(error.message, error);
|
||||
}
|
||||
}
|
||||
|
||||
export default async function wrapNativePostgresCallAsync<T>(fn: () => Promise<T>): Promise<T> {
|
||||
try {
|
||||
return await fn();
|
||||
} catch (e) {
|
||||
if (!(e instanceof Error)) {
|
||||
throw e;
|
||||
}
|
||||
throw wrapNativePostgresError(e);
|
||||
}
|
||||
}
|
||||
@@ -1,9 +1,3 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-database-adapter-knex
|
||||
*/
|
||||
|
||||
export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter';
|
||||
export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider';
|
||||
export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider';
|
||||
@@ -1,177 +0,0 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
ViewerContext,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
IntField,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
type ErrorsTestEntityFields = {
|
||||
id: number;
|
||||
fieldNonNull: string;
|
||||
fieldForeignKey: number | null;
|
||||
fieldUnique: string | null;
|
||||
checkLessThan5: number | null;
|
||||
fieldExclusion: string | null;
|
||||
nonExistentColumn: string | null;
|
||||
};
|
||||
|
||||
const foreignTableName = 'foreign_table';
|
||||
|
||||
export default class ErrorsTestEntity extends Entity<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext
|
||||
> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity,
|
||||
ErrorsTestEntityPrivacyPolicy
|
||||
> {
|
||||
return errorsTestEntityCompanionDefinition;
|
||||
}
|
||||
|
||||
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
|
||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "btree_gist"'); // for gist exclusion on varchar
|
||||
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
|
||||
const hasForeignTable = await knex.schema.hasTable(foreignTableName);
|
||||
if (!hasForeignTable) {
|
||||
await knex.schema.createTable(foreignTableName, (table) => {
|
||||
table.integer('id').primary();
|
||||
});
|
||||
}
|
||||
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (!hasTable) {
|
||||
await knex.schema.createTable(tableName, (table) => {
|
||||
table.integer('id').primary();
|
||||
table.string('field_non_null').notNullable();
|
||||
table.integer('field_foreign_key').references(`${foreignTableName}.id`);
|
||||
table.string('field_unique').unique();
|
||||
table.integer('check_less_than_5');
|
||||
table.string('field_exclusion');
|
||||
});
|
||||
|
||||
await knex.raw(
|
||||
`
|
||||
ALTER TABLE :tableName:
|
||||
ADD CONSTRAINT check_less_than_5_check_constraint
|
||||
CHECK (check_less_than_5 IS NULL OR check_less_than_5 < 5);`,
|
||||
{
|
||||
tableName,
|
||||
}
|
||||
);
|
||||
|
||||
await knex.raw(
|
||||
`
|
||||
ALTER TABLE :tableName:
|
||||
ADD CONSTRAINT field_exclusion_exclusion_constraint
|
||||
EXCLUDE USING gist (field_exclusion WITH =);
|
||||
`,
|
||||
{
|
||||
tableName,
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
await knex(tableName).delete();
|
||||
await knex(foreignTableName).delete();
|
||||
}
|
||||
|
||||
public static async dropPostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (hasTable) {
|
||||
await knex.schema.dropTable(tableName);
|
||||
}
|
||||
|
||||
const hasForeignTable = await knex.schema.hasTable(foreignTableName);
|
||||
if (hasForeignTable) {
|
||||
await knex.schema.dropTable(foreignTableName);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class ErrorsTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const ErrorsTestEntityConfiguration = new EntityConfiguration<ErrorsTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'postgres_test_entities',
|
||||
schema: {
|
||||
id: new IntField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
fieldNonNull: new StringField({
|
||||
columnName: 'field_non_null',
|
||||
}),
|
||||
fieldForeignKey: new IntField({
|
||||
columnName: 'field_foreign_key',
|
||||
}),
|
||||
fieldUnique: new StringField({
|
||||
columnName: 'field_unique',
|
||||
}),
|
||||
checkLessThan5: new IntField({
|
||||
columnName: 'check_less_than_5',
|
||||
}),
|
||||
fieldExclusion: new StringField({
|
||||
columnName: 'field_exclusion',
|
||||
}),
|
||||
nonExistentColumn: new StringField({
|
||||
columnName: 'non_existent_column',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const errorsTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: ErrorsTestEntity,
|
||||
entityConfiguration: ErrorsTestEntityConfiguration,
|
||||
privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
|
||||
});
|
||||
@@ -4,11 +4,13 @@ import {
|
||||
ViewerContext,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
IntField,
|
||||
NumberField,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
type InvalidTestEntityFields = {
|
||||
id: number;
|
||||
@@ -57,7 +59,7 @@ class InvalidTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ViewerContext,
|
||||
InvalidTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
InvalidTestEntityFields,
|
||||
number,
|
||||
@@ -65,7 +67,7 @@ class InvalidTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
InvalidTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
InvalidTestEntityFields,
|
||||
number,
|
||||
@@ -73,7 +75,7 @@ class InvalidTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
InvalidTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
InvalidTestEntityFields,
|
||||
number,
|
||||
@@ -81,7 +83,7 @@ class InvalidTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
InvalidTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
InvalidTestEntityFields,
|
||||
number,
|
||||
@@ -95,15 +97,15 @@ export const invalidTestEntityConfiguration = new EntityConfiguration<InvalidTes
|
||||
idField: 'id',
|
||||
tableName: 'postgres_test_entities',
|
||||
schema: {
|
||||
id: new IntField({
|
||||
id: new NumberField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const invalidTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
|
||||
@@ -11,10 +11,12 @@ import {
|
||||
DateField,
|
||||
MaybeJSONArrayField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
type PostgresTestEntityFields = {
|
||||
id: string;
|
||||
@@ -81,7 +83,7 @@ class PostgresTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ViewerContext,
|
||||
PostgresTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresTestEntityFields,
|
||||
string,
|
||||
@@ -89,7 +91,7 @@ class PostgresTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresTestEntityFields,
|
||||
string,
|
||||
@@ -97,7 +99,7 @@ class PostgresTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresTestEntityFields,
|
||||
string,
|
||||
@@ -105,7 +107,7 @@ class PostgresTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresTestEntityFields,
|
||||
string,
|
||||
@@ -148,8 +150,8 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
|
||||
columnName: 'maybe_json_array_field',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
|
||||
+27
-31
@@ -5,14 +5,15 @@ import {
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
EntityMutationTrigger,
|
||||
EntityQueryContext,
|
||||
EntityNonTransactionalMutationTrigger,
|
||||
EntityTriggerMutationInfo,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
type PostgresTriggerTestEntityFields = {
|
||||
id: string;
|
||||
@@ -63,7 +64,7 @@ class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ViewerContext,
|
||||
PostgresTriggerTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresTriggerTestEntityFields,
|
||||
string,
|
||||
@@ -71,7 +72,7 @@ class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresTriggerTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresTriggerTestEntityFields,
|
||||
string,
|
||||
@@ -79,7 +80,7 @@ class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresTriggerTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresTriggerTestEntityFields,
|
||||
string,
|
||||
@@ -87,7 +88,7 @@ class PostgresTriggerTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresTriggerTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresTriggerTestEntityFields,
|
||||
string,
|
||||
@@ -110,13 +111,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
||||
async executeAsync(
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
entity: PostgresTriggerTestEntity,
|
||||
_mutationInfo: EntityTriggerMutationInfo<
|
||||
PostgresTriggerTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresTriggerTestEntity
|
||||
>
|
||||
entity: PostgresTriggerTestEntity
|
||||
): Promise<void> {
|
||||
if (entity.getField(this.fieldName) === this.badValue) {
|
||||
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
||||
@@ -144,28 +139,29 @@ class ThrowConditionallyNonTransactionalTrigger extends EntityNonTransactionalMu
|
||||
}
|
||||
}
|
||||
|
||||
export const postgresTestEntityConfiguration =
|
||||
new EntityConfiguration<PostgresTriggerTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'postgres_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
export const postgresTestEntityConfiguration = new EntityConfiguration<
|
||||
PostgresTriggerTestEntityFields
|
||||
>({
|
||||
idField: 'id',
|
||||
tableName: 'postgres_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: PostgresTriggerTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresTriggerTestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
mutationTriggers: {
|
||||
beforeCreate: [new ThrowConditionallyTrigger('name', 'beforeCreate')],
|
||||
afterCreate: [new ThrowConditionallyTrigger('name', 'afterCreate')],
|
||||
beforeUpdate: [new ThrowConditionallyTrigger('name', 'beforeUpdate')],
|
||||
@@ -175,5 +171,5 @@ const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
beforeAll: [new ThrowConditionallyTrigger('name', 'beforeAll')],
|
||||
afterAll: [new ThrowConditionallyTrigger('name', 'afterAll')],
|
||||
afterCommit: [new ThrowConditionallyNonTransactionalTrigger('name', 'afterCommit')],
|
||||
}),
|
||||
},
|
||||
});
|
||||
+26
-30
@@ -5,13 +5,14 @@ import {
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
EntityMutationTrigger,
|
||||
EntityQueryContext,
|
||||
EntityValidatorMutationInfo,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
type PostgresValidatorTestEntityFields = {
|
||||
id: string;
|
||||
@@ -62,7 +63,7 @@ class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ViewerContext,
|
||||
PostgresValidatorTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
protected readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresValidatorTestEntityFields,
|
||||
string,
|
||||
@@ -70,7 +71,7 @@ class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresValidatorTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresValidatorTestEntityFields,
|
||||
string,
|
||||
@@ -78,7 +79,7 @@ class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresValidatorTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
protected readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresValidatorTestEntityFields,
|
||||
string,
|
||||
@@ -86,7 +87,7 @@ class PostgresValidatorTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresValidatorTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
protected readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresValidatorTestEntityFields,
|
||||
string,
|
||||
@@ -112,13 +113,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
||||
async executeAsync(
|
||||
_viewerContext: ViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
entity: PostgresValidatorTestEntity,
|
||||
_mutationInfo: EntityValidatorMutationInfo<
|
||||
PostgresValidatorTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresValidatorTestEntity
|
||||
>
|
||||
entity: PostgresValidatorTestEntity
|
||||
): Promise<void> {
|
||||
if (entity.getField(this.fieldName) === this.badValue) {
|
||||
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
||||
@@ -126,26 +121,27 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
||||
}
|
||||
}
|
||||
|
||||
export const postgresTestEntityConfiguration =
|
||||
new EntityConfiguration<PostgresValidatorTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'postgres_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
export const postgresTestEntityConfiguration = new EntityConfiguration<
|
||||
PostgresValidatorTestEntityFields
|
||||
>({
|
||||
idField: 'id',
|
||||
tableName: 'postgres_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: PostgresValidatorTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
|
||||
mutationValidators: () => [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
|
||||
mutationValidators: [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
|
||||
});
|
||||
+14
-18
@@ -2,9 +2,11 @@ import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
InMemoryFullCacheStubCacheAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
import PostgresEntityDatabaseAdapterProvider from '../PostgresEntityDatabaseAdapterProvider';
|
||||
import PostgresEntityQueryContextProvider from '../PostgresEntityQueryContextProvider';
|
||||
@@ -15,22 +17,16 @@ export const createKnexIntegrationTestEntityCompanionProvider = (
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||
},
|
||||
],
|
||||
])
|
||||
{
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
|
||||
},
|
||||
},
|
||||
{
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -3,150 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.9.1](https://github.com/expo/entity/compare/v0.9.0...v0.9.1) (2020-11-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
@@ -1,13 +1,12 @@
|
||||
{
|
||||
"name": "@expo/entity-example",
|
||||
"private": true,
|
||||
"version": "0.24.0",
|
||||
"version": "0.9.1",
|
||||
"description": "An example integration of the @expo/entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
@@ -23,7 +22,7 @@
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@expo/entity": "^0.24.0",
|
||||
"@expo/entity": "^0.9.1",
|
||||
"apollo-server-koa": "^2.16.1",
|
||||
"graphql": "^15.3.0",
|
||||
"koa": "^2.13.0",
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { createUnitTestEntityCompanionProvider } from '@expo/entity';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import NoteEntity from '../entities/NoteEntity';
|
||||
import { UserViewerContext } from '../viewerContexts';
|
||||
@@ -7,18 +6,17 @@ import { UserViewerContext } from '../viewerContexts';
|
||||
describe(NoteEntity, () => {
|
||||
test('demonstrate usage of business logic test utilities', async () => {
|
||||
const companionProvider = createUnitTestEntityCompanionProvider();
|
||||
const userId = uuidv4();
|
||||
const viewerContext = new UserViewerContext(companionProvider, userId);
|
||||
const viewerContext = new UserViewerContext(companionProvider, '4');
|
||||
|
||||
const createdEntityResult = await NoteEntity.creator(viewerContext)
|
||||
.setField('userID', userId)
|
||||
.setField('userID', '4')
|
||||
.setField('body', 'image')
|
||||
.setField('title', 'page')
|
||||
.createAsync();
|
||||
expect(createdEntityResult.ok).toBe(true);
|
||||
|
||||
const createdEntityResultImpersonate = await NoteEntity.creator(viewerContext)
|
||||
.setField('userID', uuidv4()) // a different user
|
||||
.setField('userID', '5')
|
||||
.setField('body', 'image')
|
||||
.setField('title', 'page')
|
||||
.createAsync();
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import http from 'http';
|
||||
import request from 'supertest';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import app from '../app';
|
||||
|
||||
@@ -8,15 +7,14 @@ describe('graphql', () => {
|
||||
it('allows CRUD of user notes', async () => {
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
const responseEmpty = await server.post('/graphql').set('totally-secure-user-id', userId).send({
|
||||
const responseEmpty = await server.post('/graphql').set('totally-secure-user-id', '4').send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
expect(responseEmpty.body.data.me.notes).toEqual([]);
|
||||
|
||||
const createResponse1 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -33,7 +31,7 @@ describe('graphql', () => {
|
||||
|
||||
const createResponse2 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -44,17 +42,14 @@ describe('graphql', () => {
|
||||
},
|
||||
});
|
||||
|
||||
const responseLength2 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
const responseLength2 = await server.post('/graphql').set('totally-secure-user-id', '4').send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
expect(responseLength2.body.data.me.notes).toHaveLength(2);
|
||||
|
||||
const responseGetSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `query($id: ID!) { noteByID(id: $id) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -69,7 +64,7 @@ describe('graphql', () => {
|
||||
|
||||
const responseUpdateSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($id: ID!, $note: NoteInput!) { updateNote(id: $id, note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -89,7 +84,7 @@ describe('graphql', () => {
|
||||
|
||||
const responseDeleteSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($id: ID!) { deleteNote(id: $id) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -107,12 +102,9 @@ describe('graphql', () => {
|
||||
body: 'boarding',
|
||||
});
|
||||
|
||||
const responseLength1 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
const responseLength1 = await server.post('/graphql').set('totally-secure-user-id', '4').send({
|
||||
query: `query { me { notes { id } } }`,
|
||||
});
|
||||
expect(responseLength1.body.data.me.notes).toHaveLength(1);
|
||||
});
|
||||
|
||||
@@ -135,11 +127,9 @@ describe('graphql', () => {
|
||||
it('disallows cross-user note impersonation', async () => {
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
const userId2 = uuidv4();
|
||||
const createResponse1 = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -153,7 +143,7 @@ describe('graphql', () => {
|
||||
// notes are public
|
||||
const responseGetSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId2)
|
||||
.set('totally-secure-user-id', '5')
|
||||
.send({
|
||||
query: `query($id: ID!) { noteByID(id: $id) { id, title, body } }`,
|
||||
variables: {
|
||||
@@ -169,7 +159,7 @@ describe('graphql', () => {
|
||||
// but can only be updated by the owner
|
||||
const responseUpdateSingle = await server
|
||||
.post('/graphql')
|
||||
.set('totally-secure-user-id', userId2)
|
||||
.set('totally-secure-user-id', '5')
|
||||
.send({
|
||||
query: `mutation($id: ID!, $note: NoteInput!) { updateNote(id: $id, note: $note) { id, title, body } }`,
|
||||
variables: {
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import http from 'http';
|
||||
import request from 'supertest';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import app from '../app';
|
||||
|
||||
@@ -12,74 +11,59 @@ describe('notesRouter', () => {
|
||||
|
||||
it('allows CRUD of user notes', async () => {
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
|
||||
const responseEmpty = await server.get('/notes/').set('totally-secure-user-id', userId).send();
|
||||
const responseEmpty = await server.get('/notes/').set('totally-secure-user-id', '4').send();
|
||||
expect(responseEmpty.body.notes).toEqual([]);
|
||||
|
||||
const createResponse1 = await server
|
||||
.post('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
const createResponse1 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
expect(createResponse1.body.note).toMatchObject({
|
||||
userID: userId,
|
||||
userID: '4',
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
|
||||
const createResponse2 = await server
|
||||
.post('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
title: 'nine',
|
||||
body: 'lotion',
|
||||
});
|
||||
const createResponse2 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
|
||||
title: 'nine',
|
||||
body: 'lotion',
|
||||
});
|
||||
|
||||
const responseLength2 = await server
|
||||
.get('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send();
|
||||
const responseLength2 = await server.get('/notes/').set('totally-secure-user-id', '4').send();
|
||||
expect(responseLength2.body.notes).toHaveLength(2);
|
||||
|
||||
const responseGetSingle = await server
|
||||
.get(`/notes/${createResponse2.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send();
|
||||
expect(responseGetSingle.body.note).toMatchObject({
|
||||
id: createResponse2.body.note.id,
|
||||
userID: userId,
|
||||
userID: '4',
|
||||
title: 'nine',
|
||||
body: 'lotion',
|
||||
});
|
||||
|
||||
const responseUpdateSingle = await server
|
||||
.put(`/notes/${createResponse2.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send({
|
||||
title: 'wave',
|
||||
body: 'boarding',
|
||||
});
|
||||
expect(responseUpdateSingle.body.note).toMatchObject({
|
||||
id: responseGetSingle.body.note.id,
|
||||
userID: userId,
|
||||
userID: '4',
|
||||
title: 'wave',
|
||||
body: 'boarding',
|
||||
});
|
||||
|
||||
const responseDeleteSingle = await server
|
||||
.delete(`/notes/${createResponse2.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId)
|
||||
.set('totally-secure-user-id', '4')
|
||||
.send();
|
||||
expect(responseDeleteSingle.body.status).toEqual('ok');
|
||||
|
||||
const responseLength1 = await server
|
||||
.get('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send();
|
||||
const responseLength1 = await server.get('/notes/').set('totally-secure-user-id', '4').send();
|
||||
expect(responseLength1.body.notes).toHaveLength(1);
|
||||
});
|
||||
|
||||
@@ -95,28 +79,23 @@ describe('notesRouter', () => {
|
||||
|
||||
it('disallows cross-user note impersonation', async () => {
|
||||
const server = request(http.createServer(app.callback()));
|
||||
const userId = uuidv4();
|
||||
const userId2 = uuidv4();
|
||||
const createResponse1 = await server
|
||||
.post('/notes/')
|
||||
.set('totally-secure-user-id', userId)
|
||||
.send({
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
const createResponse1 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
|
||||
title: 'track',
|
||||
body: 'language',
|
||||
});
|
||||
expect(createResponse1.ok).toBe(true);
|
||||
|
||||
// notes are public
|
||||
const responseGetSingleOtherUser = await server
|
||||
.get(`/notes/${createResponse1.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId2)
|
||||
.set('totally-secure-user-id', '5')
|
||||
.send();
|
||||
expect(responseGetSingleOtherUser.ok).toBe(true);
|
||||
|
||||
// but can only be updated by the owner
|
||||
const responseUpdateSingle = await server
|
||||
.put(`/notes/${createResponse1.body.note.id}`)
|
||||
.set('totally-secure-user-id', userId2)
|
||||
.set('totally-secure-user-id', '5')
|
||||
.send({
|
||||
title: 'wave',
|
||||
body: 'boarding',
|
||||
|
||||
@@ -58,7 +58,7 @@ class InMemoryDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
|
||||
return 0;
|
||||
}
|
||||
|
||||
const currentOrderBy = orderBys[0]!;
|
||||
const currentOrderBy = orderBys[0];
|
||||
const aField = objectA[currentOrderBy.columnName];
|
||||
const bField = objectB[currentOrderBy.columnName];
|
||||
switch (currentOrderBy.order) {
|
||||
@@ -161,7 +161,7 @@ class InMemoryDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
|
||||
...dbObjects[objectIndex],
|
||||
...object,
|
||||
};
|
||||
return [dbObjects[objectIndex]!];
|
||||
return [dbObjects[objectIndex]];
|
||||
}
|
||||
|
||||
protected async deleteInternalAsync(
|
||||
|
||||
@@ -3,6 +3,8 @@ import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
InMemoryFullCacheStubCacheAdapterProvider,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
} from '@expo/entity';
|
||||
|
||||
import { InMemoryDatabaseAdapterProvider } from './adapters/InMemoryDatabaseAdapter';
|
||||
@@ -19,26 +21,20 @@ export const createEntityCompanionProvider = (
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
// An in-memory DB is used for demonstration purposes, but generally this would be
|
||||
// instantiated with PostgresEntityDatabaseAdapter and PostgresEntityQueryContextProvider
|
||||
{
|
||||
adapterProvider: new InMemoryDatabaseAdapterProvider(),
|
||||
queryContextProvider: new InMemoryQueryContextProvider(),
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
// An in-memory cache is used for demonstration purposes, but generally this would be
|
||||
// instantiated with a RedisCacheAdapterProvider
|
||||
{
|
||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||
},
|
||||
],
|
||||
])
|
||||
{
|
||||
// An in-memory DB is used for demonstration purposes, but generally this would be
|
||||
// instantiated with PostgresEntityDatabaseAdapter and PostgresEntityQueryContextProvider
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapterProvider: new InMemoryDatabaseAdapterProvider(),
|
||||
queryContextProvider: new InMemoryQueryContextProvider(),
|
||||
},
|
||||
},
|
||||
{
|
||||
// An in-memory cache is used for demonstration purposes, but generally this would be
|
||||
// instantiated with a RedisCacheAdapterProvider
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -23,9 +23,8 @@ import { ExampleViewerContext } from '../viewerContexts';
|
||||
*/
|
||||
export default class AllowIfUserOwnerPrivacyRule<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
TID,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>
|
||||
> extends PrivacyPolicyRule<TFields, TID, ExampleViewerContext, TEntity> {
|
||||
constructor(private readonly entityOwnerField: keyof TFields) {
|
||||
super();
|
||||
|
||||
@@ -3,6 +3,8 @@ import {
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
UUIDField,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
StringField,
|
||||
} from '@expo/entity';
|
||||
|
||||
@@ -55,8 +57,8 @@ export const noteEntityCompanion = new EntityCompanionDefinition({
|
||||
columnName: 'body',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
}),
|
||||
privacyPolicyClass: NotePrivacyPolicy,
|
||||
});
|
||||
@@ -13,16 +13,16 @@ export default class NotePrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ExampleViewerContext,
|
||||
NoteEntity
|
||||
> {
|
||||
protected override readonly readRules = [
|
||||
protected readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<NoteFields, string, ExampleViewerContext, NoteEntity>(),
|
||||
];
|
||||
protected override readonly createRules = [
|
||||
protected readonly createRules = [
|
||||
new AllowIfUserOwnerPrivacyRule<NoteFields, string, NoteEntity>('userID'),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
protected readonly updateRules = [
|
||||
new AllowIfUserOwnerPrivacyRule<NoteFields, string, NoteEntity>('userID'),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
protected readonly deleteRules = [
|
||||
new AllowIfUserOwnerPrivacyRule<NoteFields, string, NoteEntity>('userID'),
|
||||
];
|
||||
}
|
||||
@@ -3,156 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* upgrade ioredis, knex, and pg ([#125](https://github.com/expo/entity/issues/125)) ([7c43edf](https://github.com/expo/entity/commit/7c43edf3de37e8af13e2a99bd44f03f54803d9b9))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.9.1](https://github.com/expo/entity/compare/v0.9.0...v0.9.1) (2020-11-06)
|
||||
|
||||
|
||||
|
||||
@@ -1,13 +1,12 @@
|
||||
{
|
||||
"name": "@expo/entity-full-integration-tests",
|
||||
"private": true,
|
||||
"version": "0.24.0",
|
||||
"version": "0.9.1",
|
||||
"description": "Full redis and knex integration tests for the entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
@@ -27,8 +26,8 @@
|
||||
"@expo/entity-database-adapter-knex": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.24.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.24.0",
|
||||
"@expo/entity-database-adapter-knex": "^0.24.0"
|
||||
"@expo/entity": "^0.9.1",
|
||||
"@expo/entity-cache-adapter-redis": "^0.9.1",
|
||||
"@expo/entity-database-adapter-knex": "^0.9.1"
|
||||
}
|
||||
}
|
||||
+27
-38
@@ -5,13 +5,13 @@ import {
|
||||
Entity,
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
UUIDField,
|
||||
StringField,
|
||||
} from '@expo/entity';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
import Knex from 'knex';
|
||||
import { URL } from 'url';
|
||||
|
||||
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
||||
@@ -28,18 +28,10 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
ViewerContext,
|
||||
TestEntity
|
||||
> {
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
||||
];
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
class TestEntity extends Entity<TestFields, string, ViewerContext> {
|
||||
@@ -62,16 +54,16 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
other_string: new StringField({
|
||||
other_string: new UUIDField({
|
||||
columnName: 'other_string',
|
||||
cache: true,
|
||||
}),
|
||||
third_string: new StringField({
|
||||
third_string: new UUIDField({
|
||||
columnName: 'third_string',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const testEntityCompanion = new EntityCompanionDefinition({
|
||||
@@ -105,18 +97,18 @@ describe('Entity cache inconsistency', () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: nullthrows(process.env['PGUSER']),
|
||||
password: nullthrows(process.env['PGPASSWORD']),
|
||||
user: process.env.PGUSER,
|
||||
password: process.env.PGPASSWORD,
|
||||
host: 'localhost',
|
||||
port: parseInt(nullthrows(process.env['PGPORT']), 10),
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
port: parseInt(process.env.PGPORT!, 10),
|
||||
database: process.env.PGDATABASE,
|
||||
},
|
||||
});
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
@@ -159,12 +151,12 @@ describe('Entity cache inconsistency', () => {
|
||||
.loadByFieldEqualingAsync('other_string', 'hello');
|
||||
|
||||
let openBarrier1: () => void;
|
||||
const barrier1 = new Promise<void>((resolve) => {
|
||||
const barrier1 = new Promise((resolve) => {
|
||||
openBarrier1 = resolve;
|
||||
});
|
||||
|
||||
let openBarrier2: () => void;
|
||||
const barrier2 = new Promise<void>((resolve) => {
|
||||
const barrier2 = new Promise((resolve) => {
|
||||
openBarrier2 = resolve;
|
||||
});
|
||||
|
||||
@@ -183,19 +175,16 @@ describe('Entity cache inconsistency', () => {
|
||||
|
||||
openBarrier2!();
|
||||
})(),
|
||||
viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
|
||||
'postgres',
|
||||
async (queryContext) => {
|
||||
await TestEntity.updater(entity1, queryContext)
|
||||
.setField('third_string', 'updated')
|
||||
.enforceUpdateAsync();
|
||||
TestEntity.runInTransactionAsync(viewerContext, async (queryContext) => {
|
||||
await TestEntity.updater(entity1, queryContext)
|
||||
.setField('third_string', 'updated')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
openBarrier1();
|
||||
openBarrier1();
|
||||
|
||||
// wait for to ensure the transaction isn't committed until after load above occurs
|
||||
await barrier2;
|
||||
}
|
||||
),
|
||||
// wait for to ensure the transaction isn't committed until after load above occurs
|
||||
await barrier2;
|
||||
}),
|
||||
]);
|
||||
|
||||
// ensure cache consistency
|
||||
|
||||
+7
-8
@@ -1,8 +1,7 @@
|
||||
import { ViewerContext } from '@expo/entity';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
import Knex from 'knex';
|
||||
import { URL } from 'url';
|
||||
|
||||
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
||||
@@ -38,18 +37,18 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: nullthrows(process.env['PGUSER']),
|
||||
password: nullthrows(process.env['PGPASSWORD']),
|
||||
user: process.env.PGUSER,
|
||||
password: process.env.PGPASSWORD,
|
||||
host: 'localhost',
|
||||
port: parseInt(nullthrows(process.env['PGPORT']), 10),
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
port: parseInt(process.env.PGPORT!, 10),
|
||||
database: process.env.PGDATABASE,
|
||||
},
|
||||
});
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
|
||||
+17
-24
@@ -5,13 +5,14 @@ import {
|
||||
Entity,
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
DatabaseAdapterFlavor,
|
||||
CacheAdapterFlavor,
|
||||
UUIDField,
|
||||
EntityEdgeDeletionBehavior,
|
||||
} from '@expo/entity';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
import Knex from 'knex';
|
||||
import { URL } from 'url';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
@@ -28,18 +29,10 @@ interface OtherFields {
|
||||
}
|
||||
|
||||
class PrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any> {
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
|
||||
];
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
||||
@@ -89,8 +82,8 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const categoryEntityCompanion = new EntityCompanionDefinition({
|
||||
@@ -117,8 +110,8 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const otherEntityCompanion = new EntityCompanionDefinition({
|
||||
@@ -167,18 +160,18 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
knexInstance = Knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: nullthrows(process.env['PGUSER']),
|
||||
password: nullthrows(process.env['PGPASSWORD']),
|
||||
user: process.env.PGUSER,
|
||||
password: process.env.PGPASSWORD,
|
||||
host: 'localhost',
|
||||
port: parseInt(nullthrows(process.env['PGPORT']), 10),
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
port: parseInt(process.env.PGPORT!, 10),
|
||||
database: process.env.PGDATABASE,
|
||||
},
|
||||
});
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
|
||||
+8
-14
@@ -1,5 +1,7 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
Entity,
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
@@ -17,18 +19,10 @@ interface ChildFields {
|
||||
}
|
||||
|
||||
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
export default class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
|
||||
@@ -60,8 +54,8 @@ const childEntityConfiguration = new EntityConfiguration<ChildFields>({
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const childEntityCompanion = new EntityCompanionDefinition({
|
||||
|
||||
+8
-14
@@ -1,5 +1,7 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
Entity,
|
||||
EntityCompanionDefinition,
|
||||
EntityConfiguration,
|
||||
@@ -15,18 +17,10 @@ interface ParentFields {
|
||||
}
|
||||
|
||||
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
|
||||
];
|
||||
protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
|
||||
}
|
||||
|
||||
export default class ParentEntity extends Entity<ParentFields, string, ViewerContext> {
|
||||
@@ -51,8 +45,8 @@ const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
|
||||
cache: true,
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
|
||||
cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
|
||||
});
|
||||
|
||||
const parentEntityCompanion = new EntityCompanionDefinition({
|
||||
|
||||
+14
-18
@@ -2,6 +2,8 @@ import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
CacheAdapterFlavor,
|
||||
DatabaseAdapterFlavor,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
RedisCacheAdapterContext,
|
||||
@@ -11,7 +13,7 @@ import {
|
||||
PostgresEntityDatabaseAdapterProvider,
|
||||
PostgresEntityQueryContextProvider,
|
||||
} from '@expo/entity-database-adapter-knex';
|
||||
import { Knex } from 'knex';
|
||||
import Knex from 'knex';
|
||||
|
||||
export const createFullIntegrationTestEntityCompanionProvider = (
|
||||
knex: Knex,
|
||||
@@ -20,22 +22,16 @@ export const createFullIntegrationTestEntityCompanionProvider = (
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
{
|
||||
[DatabaseAdapterFlavor.POSTGRES]: {
|
||||
adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
|
||||
queryContextProvider: new PostgresEntityQueryContextProvider(knex),
|
||||
},
|
||||
},
|
||||
{
|
||||
[CacheAdapterFlavor.REDIS]: {
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -1,66 +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.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add IP support ([#138](https://github.com/expo/entity/issues/138)) ([1405a91](https://github.com/expo/entity/commit/1405a9126ee3a56c3e2a38bf3b697283744f5b5d))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* lands @expo/entity-ip-address-field ([#138](https://github.com/expo/entity/pull/138))
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* expose describeFieldTestCase for use in other packages ([#139](https://github.com/expo/entity/issues/139)) ([1220477](https://github.com/expo/entity/commit/1220477aa331349b482ad015b44f76fa2bda7b90))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
* use better QueryContext types for transactional triggers and validators ([#136](https://github.com/expo/entity/issues/136)) ([5c7efe1](https://github.com/expo/entity/commit/5c7efe1678424ff907687e9327175bdc2538c3e0))
|
||||
@@ -1,3 +0,0 @@
|
||||
# @expo/entity-ip-address-field
|
||||
|
||||
A package containing the IP address EntityField definitions for @expo/entity. Supports addresses with either IPv4 or IPv6 syntax.
|
||||
@@ -1,37 +0,0 @@
|
||||
{
|
||||
"name": "@expo/entity-ip-address-field",
|
||||
"version": "0.24.0",
|
||||
"description": "IP address EntityField definitions for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
"src"
|
||||
],
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
],
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"ip-address": "^8.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.24.0",
|
||||
"@types/jsbn": "^1.2.29"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*"
|
||||
}
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
import { EntityFieldDefinition } from '@expo/entity';
|
||||
import { Address4, Address6 } from 'ip-address';
|
||||
|
||||
export class IPAddressField extends EntityFieldDefinition<string> {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return Address4.isValid(value) || Address6.isValid(value);
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
import { describeFieldTestCase } from '@expo/entity';
|
||||
|
||||
import { IPAddressField } from '../EntityFields';
|
||||
|
||||
describeFieldTestCase(
|
||||
new IPAddressField({ columnName: 'wat' }),
|
||||
[
|
||||
'192.168.1.1',
|
||||
'198.24.10.0/24',
|
||||
'10.0.0.0',
|
||||
'0:1:2:3:4:5:6:7',
|
||||
'1:2:3:4:5:6:7:8/64',
|
||||
'fedc:ba98:7654:3210:fedc:ba98:7654:3210',
|
||||
],
|
||||
['', 'abs', '0.0.0.x/0', '123.21.23', '1:2:3:4:5:6', '198.10/8']
|
||||
);
|
||||
@@ -1,7 +0,0 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-ip-address-field
|
||||
*/
|
||||
|
||||
export * from './EntityFields';
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -1,89 +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.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
### Chores
|
||||
|
||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
### Chores
|
||||
|
||||
* Move data transforming responsibilities to the CacheAdapter instead of the RedisSecondaryEntityCache. ([#153](https://github.com/expo/entity/pull/153))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
@@ -1,25 +0,0 @@
|
||||
# `@expo/entity-secondary-cache-redis`
|
||||
|
||||
[ioredis](https://github.com/luin/ioredis) secondary cache for `@expo/entity`.
|
||||
|
||||
[Documentation](https://expo.github.io/entity/modules/_expo_secondary_cache_redis.html)
|
||||
|
||||
## Usage
|
||||
|
||||
1. Create a concrete implementation of abstract class `EntitySecondaryCacheLoader`, in this example `TestEntitySecondaryCacheLoader`. The underlying data can come from anywhere, but an entity is constructed from the data and then authorized for the viewer.
|
||||
2. Create an instance of your `EntitySecondaryCacheLoader`, passing in a `RedisSecondaryEntityCache`.
|
||||
```typescript
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
redisCacheAdapterContext,
|
||||
(loadParams) => `${loadParams.id}`
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
);
|
||||
```
|
||||
3. Load entities through it:
|
||||
```typescript
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
```
|
||||
@@ -1,41 +0,0 @@
|
||||
{
|
||||
"name": "@expo/entity-secondary-cache-redis",
|
||||
"version": "0.24.0",
|
||||
"description": "Redis secondary cache for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
"src"
|
||||
],
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"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-redis": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"ioredis": "^4.17.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.24.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.24.0",
|
||||
"nullthrows": "^1.1.1"
|
||||
}
|
||||
}
|
||||
@@ -1,32 +0,0 @@
|
||||
import {
|
||||
EntityConfiguration,
|
||||
GenericSecondaryEntityCache,
|
||||
Parts,
|
||||
SimplePartsCacher,
|
||||
} from '@expo/entity';
|
||||
import { GenericRedisCacheContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
|
||||
|
||||
/**
|
||||
* A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
|
||||
* single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
|
||||
* a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
|
||||
*/
|
||||
export default class RedisSecondaryEntityCache<
|
||||
TFields,
|
||||
TLoadParams
|
||||
> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
genericRedisCacheContext: GenericRedisCacheContext,
|
||||
makeRedisSpecificKey: (...parts: Parts) => string,
|
||||
getParts: (params: Readonly<TLoadParams>) => Parts
|
||||
) {
|
||||
super(
|
||||
new SimplePartsCacher(
|
||||
new GenericRedisCacher(genericRedisCacheContext, entityConfiguration),
|
||||
makeRedisSpecificKey
|
||||
),
|
||||
getParts
|
||||
);
|
||||
}
|
||||
}
|
||||
-141
@@ -1,141 +0,0 @@
|
||||
import { EntitySecondaryCacheLoader, mapMapAsync, ViewerContext } from '@expo/entity';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import nullthrows from 'nullthrows';
|
||||
import { URL } from 'url';
|
||||
|
||||
import RedisSecondaryEntityCache from '../RedisSecondaryEntityCache';
|
||||
import RedisTestEntity, {
|
||||
redisTestEntityConfiguration,
|
||||
RedisTestEntityFields,
|
||||
RedisTestEntityPrivacyPolicy,
|
||||
} from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
type TestLoadParams = { id: string };
|
||||
|
||||
const FAKE_ID = 'fake';
|
||||
|
||||
class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
|
||||
TestLoadParams,
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
RedisTestEntity,
|
||||
RedisTestEntityPrivacyPolicy
|
||||
> {
|
||||
public databaseLoadCount = 0;
|
||||
|
||||
protected async fetchObjectsFromDatabaseAsync(
|
||||
loadParamsArray: readonly Readonly<TestLoadParams>[]
|
||||
): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<RedisTestEntityFields> | null>> {
|
||||
this.databaseLoadCount += loadParamsArray.length;
|
||||
|
||||
const emptyMap = new Map(loadParamsArray.map((p) => [p, null]));
|
||||
return await mapMapAsync(emptyMap, async (_value, loadParams) => {
|
||||
if (loadParams.id === FAKE_ID) {
|
||||
return null;
|
||||
}
|
||||
return nullthrows(
|
||||
(
|
||||
await this.entityLoader
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
)[0]
|
||||
).getAllFields();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
describe(RedisSecondaryEntityCache, () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(..._parts: string[]): string {
|
||||
throw new Error('should not be used by this test');
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
afterAll(async () => {
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
it('Loads through secondary loader, caches, and invalidates', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const createdEntity = await RedisTestEntity.creator(viewerContext)
|
||||
.setField('name', 'wat')
|
||||
.enforceCreateAsync();
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
redisCacheAdapterContext,
|
||||
(...parts) => parts.join(':redis-specific-delimiter:'),
|
||||
(loadParams) => [`test-key-${loadParams.id}`]
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
);
|
||||
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
||||
|
||||
const results2 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results2.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
||||
|
||||
await secondaryCacheLoader.invalidateManyAsync([loadParams]);
|
||||
|
||||
const results3 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results3.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(2);
|
||||
});
|
||||
|
||||
it('correctly handles uncached and unfetchable load params', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
redisCacheAdapterContext,
|
||||
(...parts) => parts.join(':redis-specific-delimiter:'),
|
||||
(loadParams) => [`test-key-${loadParams.id}`]
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
);
|
||||
|
||||
const loadParams = { id: FAKE_ID };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(results.size).toBe(1);
|
||||
expect(results.get(loadParams)).toBe(null);
|
||||
});
|
||||
});
|
||||
@@ -1,7 +0,0 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-secondary-cache-redis
|
||||
*/
|
||||
|
||||
export { default as RedisSecondaryEntityCache } from './RedisSecondaryEntityCache';
|
||||
@@ -1,88 +0,0 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
ViewerContext,
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
|
||||
export type RedisTestEntityFields = {
|
||||
id: string;
|
||||
name: string;
|
||||
};
|
||||
|
||||
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity,
|
||||
RedisTestEntityPrivacyPolicy
|
||||
> {
|
||||
return redisTestEntityCompanionDefinition;
|
||||
}
|
||||
}
|
||||
|
||||
export class RedisTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'redis_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: RedisTestEntity,
|
||||
entityConfiguration: redisTestEntityConfiguration,
|
||||
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
||||
});
|
||||
-37
@@ -1,37 +0,0 @@
|
||||
import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
RedisCacheAdapterContext,
|
||||
RedisCacheAdapterProvider,
|
||||
} from '@expo/entity-cache-adapter-redis';
|
||||
|
||||
export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
redisCacheAdapterContext: RedisCacheAdapterContext,
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
);
|
||||
};
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -3,210 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Chores
|
||||
|
||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||
|
||||
# [0.23.0](https://github.com/expo/entity/compare/v0.22.0...v0.23.0) (2022-02-09)
|
||||
|
||||
### Breaking changes
|
||||
|
||||
* Move data transforming responsibilities to the CacheAdapter instead of the ReadThroughEntityCache. Affects any classes extending the EntityCacheAdapter and relying on the transformation behavior of the ReadThroughEntityCache. ([#153](https://github.com/expo/entity/pull/153))
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.22.0](https://github.com/expo/entity/compare/v0.21.0...v0.22.0) (2022-02-04)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.21.0](https://github.com/expo/entity/compare/v0.20.0...v0.21.0) (2022-01-03)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add pre-commit callbacks on EntityQueryContext ([#147](https://github.com/expo/entity/issues/147)) ([f1d9847](https://github.com/expo/entity/commit/f1d9847210f5775de964509e44ce493e44482b21))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.20.0](https://github.com/expo/entity/compare/v0.19.0...v0.20.0) (2021-12-29)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* separate post-commit invalidation callbacks from trigger and user callbacks ([#144](https://github.com/expo/entity/issues/144)) ([efa131e](https://github.com/expo/entity/commit/efa131ef29532accf0e51b6d867ffe15a27b4c90))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add cascading deletion info ([#145](https://github.com/expo/entity/issues/145)) ([3727191](https://github.com/expo/entity/commit/372719176742d3ead6b7cbca29cb66b09b3fe09c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.19.0](https://github.com/expo/entity/compare/v0.18.0...v0.19.0) (2021-10-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add authorization metrics ([#142](https://github.com/expo/entity/issues/142)) ([7cf54d8](https://github.com/expo/entity/commit/7cf54d83c52e104159a3e2e675cdda2d29afe204))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.18.0](https://github.com/expo/entity/compare/v0.17.0...v0.18.0) (2021-10-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enable noImplicitOverride tsc setting ([#135](https://github.com/expo/entity/issues/135)) ([4263cb9](https://github.com/expo/entity/commit/4263cb9b8b69fe4fb68c74ec1c7aba04508a1555))
|
||||
* expose describeFieldTestCase for use in other packages ([#139](https://github.com/expo/entity/issues/139)) ([1220477](https://github.com/expo/entity/commit/1220477aa331349b482ad015b44f76fa2bda7b90))
|
||||
* upgrade TypeScript to 4.4 ([#134](https://github.com/expo/entity/issues/134)) ([7612392](https://github.com/expo/entity/commit/7612392dbfd9778d25c465c1626c372d75a6d05a))
|
||||
* use better QueryContext types for transactional triggers and validators ([#136](https://github.com/expo/entity/issues/136)) ([5c7efe1](https://github.com/expo/entity/commit/5c7efe1678424ff907687e9327175bdc2538c3e0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.17.0](https://github.com/expo/entity/compare/v0.16.0...v0.17.0) (2021-08-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add IntField and FloatField, deprecate NumberField ([#131](https://github.com/expo/entity/issues/131)) ([2f2d963](https://github.com/expo/entity/commit/2f2d963cf92c6575d78f8eeca344a4aadcc9b8d9))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.16.0](https://github.com/expo/entity/compare/v0.15.0...v0.16.0) (2021-07-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* allow null field values in loadManyByFieldEqualityConjunctionAsync ([#130](https://github.com/expo/entity/issues/130)) ([2f37dc6](https://github.com/expo/entity/commit/2f37dc6a37d368b12b3c8375e04f0777fd448797))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.15.0](https://github.com/expo/entity/compare/v0.14.1...v0.15.0) (2021-05-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* secondary cache loader ([#123](https://github.com/expo/entity/issues/123)) ([4cba01e](https://github.com/expo/entity/commit/4cba01eb259c87d60b3026ce776e46f781363690))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.14.1](https://github.com/expo/entity/compare/v0.14.0...v0.14.1) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* typescript typedef of EntityMutationInfo ([#121](https://github.com/expo/entity/issues/121)) ([8e8f0dc](https://github.com/expo/entity/commit/8e8f0dc8636e343e29a6012d155e4111477a8989))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.14.0](https://github.com/expo/entity/compare/v0.13.0...v0.14.0) (2021-03-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* mutation validator and trigger cyclic import structure ([#118](https://github.com/expo/entity/issues/118)) ([b11dbc0](https://github.com/expo/entity/commit/b11dbc087ba5ad13c748032698dd73279b7960b0))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add mutation type to validator and trigger execute functions ([#119](https://github.com/expo/entity/issues/119)) ([ef40fa5](https://github.com/expo/entity/commit/ef40fa5e9cdf53e25e78a9423c698e6d1c9737af))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* allow undefined value for all fields ([#114](https://github.com/expo/entity/issues/114)) ([022e0e9](https://github.com/expo/entity/commit/022e0e9b88a5e84e0c1bc6c8810c850beb05f0cf))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
|
||||
* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better typing on filterMap for use with predicates ([#106](https://github.com/expo/entity/issues/106)) ([01b3bfe](https://github.com/expo/entity/commit/01b3bfef7c6da55e7d89d8cccb52a0050187aee8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add type generic default in test utils ([#104](https://github.com/expo/entity/issues/104)) ([fe2917e](https://github.com/expo/entity/commit/fe2917e6b5af808f166aa354d476e168c41e6d21))
|
||||
* maps utils invariants for collections containing undefined values ([#103](https://github.com/expo/entity/issues/103)) ([29c1a43](https://github.com/expo/entity/commit/29c1a434ab6cd8d30e9f0e7c742065c8d46d8d8a))
|
||||
* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
|
||||
* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* fix null handling in load paths (try 2) ([#96](https://github.com/expo/entity/issues/96)) ([d960329](https://github.com/expo/entity/commit/d9603298e0cc5c3c2b0cca959876e9195555fb57))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.9.1](https://github.com/expo/entity/compare/v0.9.0...v0.9.1) (2020-11-06)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity",
|
||||
"version": "0.24.0",
|
||||
"version": "0.9.1",
|
||||
"description": "A privacy-first data model",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -11,8 +11,7 @@
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"lint": "eslint src --ext '.ts'",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
|
||||
@@ -1,82 +0,0 @@
|
||||
import { CacheLoadResult } from '@expo/entity/src/internal/ReadThroughEntityCache';
|
||||
import invariant from 'invariant';
|
||||
|
||||
import PartsCacher, { Parts, PartsKey } from './PartsCacher';
|
||||
import { CacheStatus } from './internal/ReadThroughEntityCache';
|
||||
|
||||
/**
|
||||
* A composed cacher by which objects are stored, fetched and removed in a series of caches
|
||||
* */
|
||||
export default class ComposedPartsCacher<TFields> extends PartsCacher<TFields> {
|
||||
constructor(
|
||||
/**
|
||||
* The series of cachers to use, in order of evaluation
|
||||
* For example, [cacheAdapterEvaluatedFirst, cacheAdapterEvaluatedSecond, cacheAdapterEvaluatedThird]
|
||||
*/
|
||||
private readonly partsCachers: PartsCacher<TFields>[]
|
||||
) {
|
||||
super();
|
||||
}
|
||||
|
||||
public async loadManyAsync(
|
||||
partsList: readonly Parts[]
|
||||
): Promise<ReadonlyMap<PartsKey, CacheLoadResult<TFields>>> {
|
||||
const resultsFromAllCachers = new Map<PartsKey, CacheLoadResult<TFields>>();
|
||||
const partsKeysToParts = new Map(
|
||||
partsList.map((parts) => [PartsCacher.getPartsKey(...parts), parts])
|
||||
);
|
||||
let partsKeysToLookup: PartsKey[] = partsList.map((parts) => PartsCacher.getPartsKey(...parts));
|
||||
for (const partsCacher of this.partsCachers) {
|
||||
const partsListToLookup = partsKeysToLookup.map((partsKey) => {
|
||||
const parts = partsKeysToParts.get(partsKey);
|
||||
invariant(parts, 'parts cannot be undefined');
|
||||
return parts;
|
||||
});
|
||||
const cacheResults = await partsCacher.loadManyAsync(partsListToLookup);
|
||||
const cacheMisses = [];
|
||||
for (const [partsKey, cacheResult] of cacheResults) {
|
||||
if (cacheResult.status === CacheStatus.MISS) {
|
||||
cacheMisses.push(partsKey);
|
||||
} else {
|
||||
resultsFromAllCachers.set(partsKey, cacheResult);
|
||||
}
|
||||
}
|
||||
partsKeysToLookup = cacheMisses;
|
||||
}
|
||||
|
||||
// None of the cachers have these values, so they are misses
|
||||
for (const partsKey of partsKeysToLookup) {
|
||||
resultsFromAllCachers.set(partsKey, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
return resultsFromAllCachers;
|
||||
}
|
||||
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<PartsKey, Readonly<TFields>>): Promise<void> {
|
||||
// perform action on lower layers first
|
||||
for (let i = this.partsCachers.length - 1; i >= 0; i--) {
|
||||
const partsCacher = this.partsCachers[i];
|
||||
invariant(partsCacher, 'parts cacher cannot be undefined');
|
||||
await partsCacher.cacheManyAsync(objectMap);
|
||||
}
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync(partsList: readonly Parts[]): Promise<void> {
|
||||
// perform action on lower layers first
|
||||
for (let i = this.partsCachers.length - 1; i >= 0; i--) {
|
||||
const partsCacher = this.partsCachers[i];
|
||||
invariant(partsCacher, 'parts cacher cannot be undefined');
|
||||
await partsCacher.cacheDBMissesAsync(partsList);
|
||||
}
|
||||
}
|
||||
|
||||
public async invalidateManyAsync(partsList: readonly Parts[]): Promise<void> {
|
||||
// perform action on lower layers first
|
||||
for (let i = this.partsCachers.length - 1; i >= 0; i--) {
|
||||
const cacheAdapter = this.partsCachers[i];
|
||||
invariant(cacheAdapter, 'parts cacher cannot be undefined');
|
||||
await cacheAdapter.invalidateManyAsync(partsList);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -11,7 +11,7 @@ import { mapMap } from './utils/collections/maps';
|
||||
*/
|
||||
export default class EnforcingEntityLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -79,7 +79,7 @@ export default class EnforcingEntityLoader<
|
||||
uniqueFieldName,
|
||||
fieldValue
|
||||
);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
return entityResult.enforceValue();
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -98,7 +98,7 @@ export default class EnforcingEntityLoader<
|
||||
*/
|
||||
async loadByIDNullableAsync(id: TID): Promise<TEntity | null> {
|
||||
const entityResult = await this.entityLoader.loadByIDNullableAsync(id);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
return entityResult.enforceValue();
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -27,7 +27,7 @@ import ViewerContext from './ViewerContext';
|
||||
*/
|
||||
export default abstract class Entity<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields> {
|
||||
@@ -39,7 +39,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static creator<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMViewerContext2 extends TMViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
@@ -80,7 +80,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static updater<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -121,7 +121,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static deleteAsync<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -163,7 +163,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static enforceDeleteAsync<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -216,7 +216,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static async canViewerUpdateAsync<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -243,16 +243,12 @@ export default abstract class Entity<
|
||||
.getQueryContextProvider()
|
||||
.getQueryContext()
|
||||
): Promise<boolean> {
|
||||
const companion = existingEntity
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this);
|
||||
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
|
||||
const evaluationResult = await asyncResult(
|
||||
privacyPolicy.authorizeUpdateAsync(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
existingEntity,
|
||||
companion.getMetricsAdapter()
|
||||
existingEntity
|
||||
)
|
||||
);
|
||||
return evaluationResult.ok;
|
||||
@@ -269,7 +265,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
static async canViewerDeleteAsync<
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMID,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
TMPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -296,16 +292,12 @@ export default abstract class Entity<
|
||||
.getQueryContextProvider()
|
||||
.getQueryContext()
|
||||
): Promise<boolean> {
|
||||
const companion = existingEntity
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this);
|
||||
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
|
||||
const evaluationResult = await asyncResult(
|
||||
privacyPolicy.authorizeDeleteAsync(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
existingEntity,
|
||||
companion.getMetricsAdapter()
|
||||
existingEntity
|
||||
)
|
||||
);
|
||||
return evaluationResult.ok;
|
||||
@@ -317,7 +309,7 @@ export default abstract class Entity<
|
||||
*/
|
||||
export interface IEntityClass<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
|
||||
@@ -8,7 +8,7 @@ import ViewerContext from './ViewerContext';
|
||||
|
||||
export default class EntityAssociationLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields
|
||||
@@ -25,7 +25,7 @@ export default class EntityAssociationLoader<
|
||||
async loadAssociatedEntityAsync<
|
||||
TIdentifyingField extends keyof Pick<TFields, TSelectedFields>,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -60,9 +60,7 @@ export default class EntityAssociationLoader<
|
||||
> {
|
||||
const associatedEntityID = this.entity.getField(fieldIdentifyingAssociatedEntity);
|
||||
if (!associatedEntityID) {
|
||||
return result(null) as Result<
|
||||
null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity
|
||||
>;
|
||||
return result(null) as any;
|
||||
}
|
||||
|
||||
const loader = this.entity
|
||||
@@ -70,10 +68,7 @@ export default class EntityAssociationLoader<
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext);
|
||||
|
||||
return (await loader.loadByIDAsync(associatedEntityID as unknown as TAssociatedID)) as Result<
|
||||
null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity
|
||||
>;
|
||||
return (await loader.loadByIDAsync((associatedEntityID as unknown) as TAssociatedID)) as any;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -87,7 +82,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadManyAssociatedEntitiesAsync<
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -139,8 +134,9 @@ export default class EntityAssociationLoader<
|
||||
* @param queryContext - query context in which to perform the load
|
||||
*/
|
||||
async loadAssociatedEntityByFieldEqualingAsync<
|
||||
TIdentifyingField extends keyof Pick<TFields, TSelectedFields>,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -156,7 +152,7 @@ export default class EntityAssociationLoader<
|
||||
>,
|
||||
TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
|
||||
>(
|
||||
fieldIdentifyingAssociatedEntity: keyof Pick<TFields, TSelectedFields>,
|
||||
fieldIdentifyingAssociatedEntity: TIdentifyingField,
|
||||
associatedEntityClass: IEntityClass<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -171,11 +167,12 @@ export default class EntityAssociationLoader<
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getQueryContextProvider()
|
||||
.getQueryContext()
|
||||
): Promise<Result<TAssociatedEntity> | null> {
|
||||
): Promise<Result<TAssociatedEntity | null>> {
|
||||
const associatedFieldValue = this.entity.getField(fieldIdentifyingAssociatedEntity);
|
||||
if (!associatedFieldValue) {
|
||||
return null;
|
||||
return result(null);
|
||||
}
|
||||
|
||||
const loader = this.entity
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
@@ -197,7 +194,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadManyAssociatedEntitiesByFieldEqualingAsync<
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
@@ -253,7 +250,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TID2,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
TFields2,
|
||||
@@ -277,7 +274,7 @@ export default class EntityAssociationLoader<
|
||||
>
|
||||
],
|
||||
queryContext?: EntityQueryContext
|
||||
): Promise<Result<TEntity2> | null>;
|
||||
): Promise<Result<TEntity2 | null>>;
|
||||
|
||||
/**
|
||||
* Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
|
||||
@@ -287,7 +284,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TID2,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
TFields2,
|
||||
@@ -297,7 +294,7 @@ export default class EntityAssociationLoader<
|
||||
TSelectedFields2
|
||||
>,
|
||||
TFields3,
|
||||
TID3 extends NonNullable<TFields3[TSelectedFields3]>,
|
||||
TID3,
|
||||
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
|
||||
TPrivacyPolicy3 extends EntityPrivacyPolicy<
|
||||
TFields3,
|
||||
@@ -332,7 +329,7 @@ export default class EntityAssociationLoader<
|
||||
>
|
||||
],
|
||||
queryContext?: EntityQueryContext
|
||||
): Promise<Result<TEntity3> | null>;
|
||||
): Promise<Result<TEntity3 | null>>;
|
||||
|
||||
/**
|
||||
* Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
|
||||
@@ -342,7 +339,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TID2,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
TFields2,
|
||||
@@ -352,7 +349,7 @@ export default class EntityAssociationLoader<
|
||||
TSelectedFields2
|
||||
>,
|
||||
TFields3,
|
||||
TID3 extends NonNullable<TFields3[TSelectedFields3]>,
|
||||
TID3,
|
||||
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
|
||||
TPrivacyPolicy3 extends EntityPrivacyPolicy<
|
||||
TFields3,
|
||||
@@ -362,7 +359,7 @@ export default class EntityAssociationLoader<
|
||||
TSelectedFields3
|
||||
>,
|
||||
TFields4,
|
||||
TID4 extends NonNullable<TFields4[TSelectedFields4]>,
|
||||
TID4,
|
||||
TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext, TSelectedFields4>,
|
||||
TPrivacyPolicy4 extends EntityPrivacyPolicy<
|
||||
TFields4,
|
||||
@@ -408,7 +405,7 @@ export default class EntityAssociationLoader<
|
||||
>
|
||||
],
|
||||
queryContext?: EntityQueryContext
|
||||
): Promise<Result<TEntity4> | null>;
|
||||
): Promise<Result<TEntity4 | null>>;
|
||||
|
||||
/**
|
||||
* Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
|
||||
@@ -419,12 +416,12 @@ export default class EntityAssociationLoader<
|
||||
async loadAssociatedEntityThroughAsync(
|
||||
loadDirectives: EntityLoadThroughDirective<TViewerContext, any, any, any, any, any, any, any>[],
|
||||
queryContext?: EntityQueryContext
|
||||
): Promise<Result<ReadonlyEntity<any, any, any, any>> | null>;
|
||||
): Promise<Result<ReadonlyEntity<any, any, any, any> | null>>;
|
||||
|
||||
async loadAssociatedEntityThroughAsync(
|
||||
loadDirectives: EntityLoadThroughDirective<TViewerContext, any, any, any, any, any, any, any>[],
|
||||
queryContext?: EntityQueryContext
|
||||
): Promise<Result<ReadonlyEntity<any, any, any, any>> | null> {
|
||||
): Promise<Result<ReadonlyEntity<any, any, any, any> | null>> {
|
||||
let currentEntity: ReadonlyEntity<any, any, any, any> = this.entity;
|
||||
for (const loadDirective of loadDirectives) {
|
||||
const {
|
||||
@@ -432,7 +429,7 @@ export default class EntityAssociationLoader<
|
||||
fieldIdentifyingAssociatedEntity,
|
||||
associatedEntityLookupByField,
|
||||
} = loadDirective;
|
||||
let associatedEntityResult: Result<ReadonlyEntity<any, any, any, any>> | null;
|
||||
let associatedEntityResult: Result<ReadonlyEntity<any, any, any, any> | null>;
|
||||
if (associatedEntityLookupByField) {
|
||||
associatedEntityResult = await currentEntity
|
||||
.associationLoader()
|
||||
@@ -443,28 +440,23 @@ export default class EntityAssociationLoader<
|
||||
queryContext
|
||||
);
|
||||
} else {
|
||||
const associatedEntityResultLocal = await currentEntity
|
||||
associatedEntityResult = await currentEntity
|
||||
.associationLoader()
|
||||
.loadAssociatedEntityAsync(
|
||||
fieldIdentifyingAssociatedEntity,
|
||||
associatedEntityClass,
|
||||
queryContext
|
||||
);
|
||||
|
||||
if (associatedEntityResultLocal.ok && associatedEntityResultLocal.value === null) {
|
||||
associatedEntityResult = null;
|
||||
} else {
|
||||
associatedEntityResult = associatedEntityResultLocal;
|
||||
}
|
||||
}
|
||||
|
||||
if (!associatedEntityResult) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!associatedEntityResult.ok) {
|
||||
return result(associatedEntityResult.reason);
|
||||
}
|
||||
|
||||
if (!associatedEntityResult.value) {
|
||||
return result(null);
|
||||
}
|
||||
|
||||
currentEntity = associatedEntityResult.value;
|
||||
}
|
||||
return result(currentEntity);
|
||||
@@ -478,7 +470,7 @@ export interface EntityLoadThroughDirective<
|
||||
TViewerContext extends ViewerContext,
|
||||
TFields,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import { FieldTransformerMap } from './internal/EntityFieldTransformationUtils';
|
||||
import { CacheLoadResult } from './internal/ReadThroughEntityCache';
|
||||
|
||||
/**
|
||||
@@ -8,6 +9,13 @@ import { CacheLoadResult } from './internal/ReadThroughEntityCache';
|
||||
export default abstract class EntityCacheAdapter<TFields> {
|
||||
constructor(protected readonly entityConfiguration: EntityConfiguration<TFields>) {}
|
||||
|
||||
/**
|
||||
* Transformer definitions for field types. Used to modify values as they are read from or written to
|
||||
* the cache. Override in concrete subclasses to change transformation behavior.
|
||||
* If a field type is not present in the map, then fields of that type will not be transformed.
|
||||
*/
|
||||
public abstract getFieldTransformerMap(): FieldTransformerMap;
|
||||
|
||||
/**
|
||||
* Load many objects from cache.
|
||||
* @param fieldName - object field being queried
|
||||
@@ -17,7 +25,7 @@ export default abstract class EntityCacheAdapter<TFields> {
|
||||
public abstract loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>>;
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult>>;
|
||||
|
||||
/**
|
||||
* Cache many objects fetched from the DB.
|
||||
@@ -26,7 +34,7 @@ export default abstract class EntityCacheAdapter<TFields> {
|
||||
*/
|
||||
public abstract cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, object>
|
||||
): Promise<void>;
|
||||
|
||||
/**
|
||||
|
||||
@@ -19,7 +19,7 @@ export interface IPrivacyPolicyClass<TPrivacyPolicy> {
|
||||
*/
|
||||
export default class EntityCompanion<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -73,7 +73,7 @@ export default class EntityCompanion<
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly metricsAdapter: IEntityMetricsAdapter
|
||||
metricsAdapter: IEntityMetricsAdapter
|
||||
) {
|
||||
const privacyPolicy = new PrivacyPolicyClass();
|
||||
this.entityLoaderFactory = new EntityLoaderFactory<
|
||||
@@ -84,11 +84,10 @@ export default class EntityCompanion<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>(
|
||||
tableDataCoordinator.entityConfiguration,
|
||||
tableDataCoordinator.entityConfiguration.idField as keyof Pick<TFields, TSelectedFields>,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
tableDataCoordinator.dataManager,
|
||||
metricsAdapter
|
||||
tableDataCoordinator.dataManager
|
||||
);
|
||||
this.entityMutatorFactory = new EntityMutatorFactory(
|
||||
tableDataCoordinator.entityConfiguration,
|
||||
@@ -130,11 +129,4 @@ export default class EntityCompanion<
|
||||
getQueryContextProvider(): EntityQueryContextProvider {
|
||||
return this.tableDataCoordinator.getQueryContextProvider();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the {@link IEntityMetricsAdapter} for this companion.
|
||||
*/
|
||||
getMetricsAdapter(): IEntityMetricsAdapter {
|
||||
return this.metricsAdapter;
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,3 @@
|
||||
import invariant from 'invariant';
|
||||
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityCompanion, { IPrivacyPolicyClass } from './EntityCompanion';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
@@ -18,14 +16,25 @@ import { computeIfAbsent } from './utils/collections/maps';
|
||||
/**
|
||||
* Backing database and transaction type for an entity. The definitions and implementations
|
||||
* are provided by injection in the root EntityCompanionProvider to allow for mocking and sharing.
|
||||
*
|
||||
* Note: this enum will likely be modified soon to be more flexible.
|
||||
*/
|
||||
export type DatabaseAdapterFlavor = string;
|
||||
export enum DatabaseAdapterFlavor {
|
||||
/**
|
||||
* Knex postgres adapter, using postgres table and postgres transactions.
|
||||
*/
|
||||
POSTGRES = 'postgres',
|
||||
}
|
||||
|
||||
/**
|
||||
* Cache system for an entity. The definitions and implementations are provided by injection
|
||||
* in the root EntityCompanionProvider to allow for mocking and sharing.
|
||||
*
|
||||
* Note: this enum will likely be modified soon to be more flexible.
|
||||
*/
|
||||
export type CacheAdapterFlavor = string;
|
||||
export enum CacheAdapterFlavor {
|
||||
REDIS = 'redis',
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines a set interfaces for a entity database adapter flavor. An entity that uses a flavor
|
||||
@@ -51,7 +60,7 @@ export interface CacheAdapterFlavorDefinition {
|
||||
*/
|
||||
export class EntityCompanionDefinition<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -73,14 +82,14 @@ export class EntityCompanionDefinition<
|
||||
>;
|
||||
readonly entityConfiguration: EntityConfiguration<TFields>;
|
||||
readonly privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
|
||||
readonly mutationValidators: () => EntityMutationValidator<
|
||||
readonly mutationValidators: EntityMutationValidator<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>[];
|
||||
readonly mutationTriggers: () => EntityMutationTriggerConfiguration<
|
||||
readonly mutationTriggers: EntityMutationTriggerConfiguration<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
@@ -93,13 +102,10 @@ export class EntityCompanionDefinition<
|
||||
entityClass,
|
||||
entityConfiguration,
|
||||
privacyPolicyClass,
|
||||
mutationValidators = () => [],
|
||||
mutationTriggers = () => ({}),
|
||||
mutationValidators = [],
|
||||
mutationTriggers = {},
|
||||
entitySelectedFields = Array.from(entityConfiguration.schema.keys()) as TSelectedFields[],
|
||||
}: {
|
||||
/**
|
||||
* The concrete Entity class for which this is the definition.
|
||||
*/
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -108,39 +114,22 @@ export class EntityCompanionDefinition<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>;
|
||||
/**
|
||||
* The {@link EntityConfiguration} for this entity.
|
||||
*/
|
||||
entityConfiguration: EntityConfiguration<TFields>;
|
||||
/**
|
||||
* The {@link EntityPrivacyPolicy} class for this entity.
|
||||
*/
|
||||
privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
|
||||
/**
|
||||
* An optional list of {@link EntityMutationValidator} for this entity.
|
||||
*/
|
||||
mutationValidators?: () => EntityMutationValidator<
|
||||
mutationValidators?: EntityMutationValidator<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>[];
|
||||
/**
|
||||
* An optional list of {@link EntityMutationTrigger} for this entity.
|
||||
*/
|
||||
mutationTriggers?: () => EntityMutationTriggerConfiguration<
|
||||
mutationTriggers?: EntityMutationTriggerConfiguration<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>;
|
||||
/**
|
||||
* An optional subset of fields defined in the {@link EntityConfiguration} which belong to this entity.
|
||||
* For use when multiple types of entities are backed by a single table ({@link EntityConfiguration}) yet
|
||||
* only expose a subset of the fields.
|
||||
*/
|
||||
entitySelectedFields?: TSelectedFields[];
|
||||
}) {
|
||||
this.entityClass = entityClass;
|
||||
@@ -162,10 +151,14 @@ export class EntityCompanionDefinition<
|
||||
* {@link EntityCompanion} for each type of {@link Entity}.
|
||||
*/
|
||||
export default class EntityCompanionProvider {
|
||||
private readonly companionMap: Map<string, EntityCompanion<any, any, any, any, any, any>> =
|
||||
new Map();
|
||||
private readonly tableDataCoordinatorMap: Map<string, EntityTableDataCoordinator<any>> =
|
||||
new Map();
|
||||
private readonly companionMap: Map<
|
||||
string,
|
||||
EntityCompanion<any, any, any, any, any, any>
|
||||
> = new Map();
|
||||
private readonly tableDataCoordinatorMap: Map<
|
||||
string,
|
||||
EntityTableDataCoordinator<any>
|
||||
> = new Map();
|
||||
|
||||
/**
|
||||
* Instantiate an Entity framework.
|
||||
@@ -174,12 +167,9 @@ export default class EntityCompanionProvider {
|
||||
* @param cacheAdapterFlavors - Cache adapter configurations for this instance
|
||||
*/
|
||||
constructor(
|
||||
public readonly metricsAdapter: IEntityMetricsAdapter,
|
||||
private databaseAdapterFlavors: ReadonlyMap<
|
||||
DatabaseAdapterFlavor,
|
||||
DatabaseAdapterFlavorDefinition
|
||||
>,
|
||||
private cacheAdapterFlavors: ReadonlyMap<CacheAdapterFlavor, CacheAdapterFlavorDefinition>
|
||||
private metricsAdapter: IEntityMetricsAdapter,
|
||||
private databaseAdapterFlavors: Record<DatabaseAdapterFlavor, DatabaseAdapterFlavorDefinition>,
|
||||
private cacheAdapterFlavors: Record<CacheAdapterFlavor, CacheAdapterFlavorDefinition>
|
||||
) {}
|
||||
|
||||
/**
|
||||
@@ -191,7 +181,7 @@ export default class EntityCompanionProvider {
|
||||
*/
|
||||
getCompanionForEntity<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -229,46 +219,24 @@ export default class EntityCompanionProvider {
|
||||
entityCompanionDefinition.entityClass,
|
||||
tableDataCoordinator,
|
||||
entityCompanionDefinition.privacyPolicyClass,
|
||||
entityCompanionDefinition.mutationValidators(),
|
||||
entityCompanionDefinition.mutationTriggers(),
|
||||
entityCompanionDefinition.mutationValidators,
|
||||
entityCompanionDefinition.mutationTriggers,
|
||||
this.metricsAdapter
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
getQueryContextProviderForDatabaseAdaptorFlavor(
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor
|
||||
): EntityQueryContextProvider {
|
||||
const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors.get(databaseAdapterFlavor);
|
||||
invariant(
|
||||
entityDatabaseAdapterFlavor,
|
||||
`No database adaptor configuration found for flavor: ${databaseAdapterFlavor}`
|
||||
);
|
||||
|
||||
return entityDatabaseAdapterFlavor.queryContextProvider;
|
||||
}
|
||||
|
||||
private getTableDataCoordinatorForEntity<TFields>(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
entityClassName: string
|
||||
): EntityTableDataCoordinator<TFields> {
|
||||
return computeIfAbsent(this.tableDataCoordinatorMap, entityConfiguration.tableName, () => {
|
||||
const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors.get(
|
||||
const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors[
|
||||
entityConfiguration.databaseAdapterFlavor
|
||||
);
|
||||
invariant(
|
||||
entityDatabaseAdapterFlavor,
|
||||
`No database adaptor configuration found for flavor: ${entityConfiguration.databaseAdapterFlavor}`
|
||||
);
|
||||
|
||||
const entityCacheAdapterFlavor = this.cacheAdapterFlavors.get(
|
||||
];
|
||||
const entityCacheAdapterFlavor = this.cacheAdapterFlavors[
|
||||
entityConfiguration.cacheAdapterFlavor
|
||||
);
|
||||
invariant(
|
||||
entityCacheAdapterFlavor,
|
||||
`No cache adaptor configuration found for flavor: ${entityConfiguration.cacheAdapterFlavor}`
|
||||
);
|
||||
|
||||
];
|
||||
return new EntityTableDataCoordinator(
|
||||
entityConfiguration,
|
||||
entityDatabaseAdapterFlavor.adapterProvider,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { IEntityClass } from './Entity';
|
||||
import { DatabaseAdapterFlavor, CacheAdapterFlavor } from './EntityCompanionProvider';
|
||||
import { EntityFieldDefinition } from './EntityFieldDefinition';
|
||||
import { EntityFieldDefinition } from './EntityFields';
|
||||
import { mapMap, invertMap, reduceMap } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
@@ -14,7 +14,7 @@ export default class EntityConfiguration<TFields> {
|
||||
readonly cacheKeyVersion: number;
|
||||
|
||||
readonly getInboundEdges: () => IEntityClass<any, any, any, any, any, any>[];
|
||||
readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>;
|
||||
readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>;
|
||||
readonly entityToDBFieldsKeyMapping: ReadonlyMap<keyof TFields, string>;
|
||||
readonly dbToEntityFieldsKeyMapping: ReadonlyMap<string, keyof TFields>;
|
||||
|
||||
@@ -30,40 +30,12 @@ export default class EntityConfiguration<TFields> {
|
||||
databaseAdapterFlavor,
|
||||
cacheAdapterFlavor,
|
||||
}: {
|
||||
/**
|
||||
* The field used to identify this entity. Must be a unique field in the table.
|
||||
*/
|
||||
idField: keyof TFields;
|
||||
|
||||
/**
|
||||
* The name of the table where entities of this type are stored.
|
||||
*/
|
||||
tableName: string;
|
||||
|
||||
/**
|
||||
* Map from each entity field to an {@link EntityFieldDefinition} specifying information about the field.
|
||||
*/
|
||||
schema: Record<keyof TFields, EntityFieldDefinition<any>>;
|
||||
|
||||
/**
|
||||
* List of other entity types that reference this type in {@link EntityFieldDefinition} associations.
|
||||
*/
|
||||
schema: Record<keyof TFields, EntityFieldDefinition>;
|
||||
getInboundEdges?: () => IEntityClass<any, any, any, any, any, any>[];
|
||||
|
||||
/**
|
||||
* Cache key version for this entity type. Should be bumped when a field is added to, removed from, or changed
|
||||
* in this entity and the underlying database table.
|
||||
*/
|
||||
cacheKeyVersion?: number;
|
||||
|
||||
/**
|
||||
* Backing database and transaction type for this entity.
|
||||
*/
|
||||
databaseAdapterFlavor: DatabaseAdapterFlavor;
|
||||
|
||||
/**
|
||||
* Cache system for this entity.
|
||||
*/
|
||||
cacheAdapterFlavor: CacheAdapterFlavor;
|
||||
}) {
|
||||
this.idField = idField;
|
||||
@@ -87,7 +59,7 @@ export default class EntityConfiguration<TFields> {
|
||||
}
|
||||
|
||||
private static computeCacheableKeys<TFields>(
|
||||
schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>
|
||||
schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>
|
||||
): ReadonlySet<keyof TFields> {
|
||||
return reduceMap(
|
||||
schema,
|
||||
@@ -102,7 +74,7 @@ export default class EntityConfiguration<TFields> {
|
||||
}
|
||||
|
||||
private static computeEntityToDBFieldsKeyMapping<TFields>(
|
||||
schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>
|
||||
schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>
|
||||
): ReadonlyMap<keyof TFields, string> {
|
||||
return mapMap(schema, (v) => v.columnName);
|
||||
}
|
||||
|
||||
@@ -14,17 +14,14 @@ interface SingleValueFieldEqualityCondition<TFields, N extends keyof TFields = k
|
||||
|
||||
interface MultiValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
|
||||
fieldName: N;
|
||||
fieldValues: readonly TFields[N][];
|
||||
fieldValues: TFields[N][];
|
||||
}
|
||||
|
||||
export type FieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> =
|
||||
| SingleValueFieldEqualityCondition<TFields, N>
|
||||
| MultiValueFieldEqualityCondition<TFields, N>;
|
||||
|
||||
export function isSingleValueFieldEqualityCondition<
|
||||
TFields,
|
||||
N extends keyof TFields = keyof TFields
|
||||
>(
|
||||
function isSingleValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields>(
|
||||
condition: FieldEqualityCondition<TFields, N>
|
||||
): condition is SingleValueFieldEqualityCondition<TFields, N> {
|
||||
return (condition as SingleValueFieldEqualityCondition<TFields, N>).fieldValue !== undefined;
|
||||
@@ -37,7 +34,7 @@ export interface TableFieldSingleValueEqualityCondition {
|
||||
|
||||
export interface TableFieldMultiValueEqualityCondition {
|
||||
tableField: string;
|
||||
tableValues: readonly any[];
|
||||
tableValues: any[];
|
||||
}
|
||||
|
||||
export enum OrderByOrdering {
|
||||
@@ -69,14 +66,12 @@ export interface QuerySelectionModifiers<TFields> {
|
||||
}
|
||||
|
||||
export interface TableQuerySelectionModifiers {
|
||||
orderBy:
|
||||
| {
|
||||
columnName: string;
|
||||
order: OrderByOrdering;
|
||||
}[]
|
||||
| undefined;
|
||||
offset: number | undefined;
|
||||
limit: number | undefined;
|
||||
orderBy?: {
|
||||
columnName: string;
|
||||
order: OrderByOrdering;
|
||||
}[];
|
||||
offset?: number;
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -265,7 +260,7 @@ export default abstract class EntityDatabaseAdapter<TFields> {
|
||||
return transformDatabaseObjectToFields(
|
||||
this.entityConfiguration,
|
||||
this.fieldTransformerMap,
|
||||
results[0]!
|
||||
results[0]
|
||||
);
|
||||
}
|
||||
|
||||
@@ -317,7 +312,7 @@ export default abstract class EntityDatabaseAdapter<TFields> {
|
||||
return transformDatabaseObjectToFields(
|
||||
this.entityConfiguration,
|
||||
this.fieldTransformerMap,
|
||||
results[0]!
|
||||
results[0]
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
import ES6Error from 'es6-error';
|
||||
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityPrivacyPolicy, { EntityAuthorizationAction } from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
export abstract class EntityError extends ES6Error {}
|
||||
|
||||
export class EntityNotFoundError<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
N extends keyof TFields,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> extends EntityError {
|
||||
constructor(
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
fieldName: N,
|
||||
fieldValue: TFields[N]
|
||||
) {
|
||||
super(`Entity not found: ${entityClass.name} (${fieldName} = ${fieldValue})`);
|
||||
}
|
||||
}
|
||||
|
||||
export class EntityNotAuthorizedError<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> extends EntityError {
|
||||
public readonly entityClassName: string;
|
||||
|
||||
constructor(
|
||||
entity: TEntity,
|
||||
viewerContext: TViewerContext,
|
||||
action: EntityAuthorizationAction,
|
||||
ruleIndex: number
|
||||
) {
|
||||
super(
|
||||
`Entity not authorized: ${entity} (viewer = ${viewerContext}, action = ${EntityAuthorizationAction[action]}, ruleIndex = ${ruleIndex})`
|
||||
);
|
||||
this.entityClassName = entity.constructor.name;
|
||||
}
|
||||
}
|
||||
@@ -1,132 +0,0 @@
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
export enum EntityEdgeDeletionBehavior {
|
||||
/**
|
||||
* Default. Invalidate the cache for all entities that reference the entity
|
||||
* being deleted through this field, and transitively run deletions on those entities.
|
||||
* This is most useful when the database itself expresses foreign
|
||||
* keys and cascading deletes or set nulls and the entity framework just needs to
|
||||
* be kept consistent with the state of the database.
|
||||
*/
|
||||
CASCADE_DELETE_INVALIDATE_CACHE,
|
||||
|
||||
/**
|
||||
* Delete all entities that reference the entity being deleted through this field. This is very similar
|
||||
* to SQL `ON DELETE CASCADE` but is done in the Entity framework instead of at the underlying level.
|
||||
* This will also invalidate the cached referencing entities.
|
||||
*/
|
||||
CASCADE_DELETE,
|
||||
|
||||
/**
|
||||
* Set this field to null when the referenced entity is deleted. This is very similar
|
||||
* to SQL `ON DELETE SET NULL` but is done in the Entity framework instead of at the underlying level.
|
||||
* This will also invalidate the cached referencing entities.
|
||||
*/
|
||||
SET_NULL,
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines an association between entities. An association is primarily used to define cascading deletion behavior.
|
||||
*/
|
||||
export interface EntityAssociationDefinition<
|
||||
TViewerContext extends ViewerContext,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
TViewerContext,
|
||||
TAssociatedSelectedFields
|
||||
>,
|
||||
TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
TViewerContext,
|
||||
TAssociatedEntity,
|
||||
TAssociatedSelectedFields
|
||||
>,
|
||||
TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
|
||||
> {
|
||||
/**
|
||||
* Class of entity on the other end of this edge.
|
||||
*/
|
||||
getAssociatedEntityClass: () => IEntityClass<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
TViewerContext,
|
||||
TAssociatedEntity,
|
||||
TAssociatedPrivacyPolicy,
|
||||
TAssociatedSelectedFields
|
||||
>;
|
||||
|
||||
/**
|
||||
* Field by which to load the instance of associatedEntityClass. If not provided, the
|
||||
* associatedEntityClass instance is fetched by its ID.
|
||||
*/
|
||||
associatedEntityLookupByField?: keyof TAssociatedFields;
|
||||
|
||||
/**
|
||||
* What action to perform on the current entity when the entity on the referencing end of
|
||||
* this edge is deleted.
|
||||
*
|
||||
* @remarks
|
||||
* The entity framework doesn't prescribe a one-size-fits-all solution for referential
|
||||
* integrity; instead it exposes mechanisms that supports both database foreign key constraints
|
||||
* and implicit entity-specified foreign keys. Choosing which approach to use often depends on
|
||||
* application requirements, and sometimes even a mix-and-match is the right choice.
|
||||
*
|
||||
* - If referential integrity is critical to your application, database foreign key constraints
|
||||
* combined with {@link EntityEdgeDeletionBehavior.CASACDE_DELETE_INVALIDATE_CACHE} are recommended.
|
||||
* - If the database being used doesn't support foreign keys, then using the entity framework for referential
|
||||
* integrity is recommended.
|
||||
*/
|
||||
edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
|
||||
}
|
||||
|
||||
/**
|
||||
* Definition for a field referencing a column in the underlying database. Specifies things like
|
||||
* cache behavior and associations, and handles input validation.
|
||||
*/
|
||||
export abstract class EntityFieldDefinition<T> {
|
||||
readonly columnName: string;
|
||||
readonly cache: boolean;
|
||||
readonly association: EntityAssociationDefinition<any, any, any, any, any, any> | undefined;
|
||||
/**
|
||||
*
|
||||
* @param columnName - Column name in the database.
|
||||
* @param cache - Whether or not to cache loaded instances of the entity by this field. The column name is
|
||||
* used to derive a cache key for the cache entry. If true, this column must be able uniquely
|
||||
* identify the entity.
|
||||
* @param association - Defines the association behavior for an entity that this column references.
|
||||
*/
|
||||
constructor({
|
||||
columnName,
|
||||
cache = false,
|
||||
association,
|
||||
}: {
|
||||
columnName: string;
|
||||
cache?: boolean;
|
||||
association?: EntityAssociationDefinition<any, any, any, any, any, any>;
|
||||
}) {
|
||||
this.columnName = columnName;
|
||||
this.cache = cache;
|
||||
this.association = association;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates input value for a field of this type. Null and undefined are considered valid by default. This is used for things like:
|
||||
* - EntityLoader.loadByFieldValue - to ensure the value being loaded by is a valid value
|
||||
* - EntityMutator.setField - to ensure the value being set is a valid value
|
||||
*/
|
||||
public validateInputValue(value: T | null | undefined): boolean {
|
||||
if (value === null || value === undefined) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return this.validateInputValueInternal(value);
|
||||
}
|
||||
protected abstract validateInputValueInternal(value: T): boolean;
|
||||
}
|
||||
+116
-102
@@ -1,107 +1,121 @@
|
||||
import { validate as validateUUID } from 'uuid';
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
import { EntityFieldDefinition } from './EntityFieldDefinition';
|
||||
export enum EntityEdgeDeletionBehavior {
|
||||
/**
|
||||
* Default. Invalidate the cache for all entities that reference the entity
|
||||
* being deleted through this field, and transitively run deletions on those entities.
|
||||
* This is most useful when the database itself expresses foreign
|
||||
* keys and cascading deletes or set nulls and the entity framework just needs to
|
||||
* be kept consistent with the state of the database.
|
||||
*/
|
||||
CASCADE_DELETE_INVALIDATE_CACHE,
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS string type.
|
||||
*/
|
||||
export class StringField extends EntityFieldDefinition<string> {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return typeof value === 'string';
|
||||
/**
|
||||
* Delete all entities that reference the entity being deleted through this field. This is very similar
|
||||
* to SQL `ON DELETE CASCADE` but is done in the Entity framework instead of at the underlying level.
|
||||
* This will also invalidate the cached referencing entities.
|
||||
*/
|
||||
CASCADE_DELETE,
|
||||
|
||||
/**
|
||||
* Set this field to null when the referenced entity is deleted. This is very similar
|
||||
* to SQL `ON DELETE SET NULL` but is done in the Entity framework instead of at the underlying level.
|
||||
* This will also invalidate the cached referencing entities.
|
||||
*/
|
||||
SET_NULL,
|
||||
}
|
||||
|
||||
export interface EntityAssociationDefinition<
|
||||
TViewerContext extends ViewerContext,
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
TViewerContext,
|
||||
TAssociatedSelectedFields
|
||||
>,
|
||||
TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
TViewerContext,
|
||||
TAssociatedEntity,
|
||||
TAssociatedSelectedFields
|
||||
>,
|
||||
TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields
|
||||
> {
|
||||
/**
|
||||
* Class of entity on the other end of this edge.
|
||||
*/
|
||||
getAssociatedEntityClass: () => IEntityClass<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
TViewerContext,
|
||||
TAssociatedEntity,
|
||||
TAssociatedPrivacyPolicy,
|
||||
TAssociatedSelectedFields
|
||||
>;
|
||||
|
||||
/**
|
||||
* Field by which to load the instance of associatedEntityClass. If not provided, the
|
||||
* associatedEntityClass instance is fetched by its ID.
|
||||
*/
|
||||
associatedEntityLookupByField?: keyof TAssociatedFields;
|
||||
|
||||
/**
|
||||
* What action to perform on the current entity when the entity on the referencing end of
|
||||
* this edge is deleted.
|
||||
*
|
||||
* @remarks
|
||||
* The entity framework doesn't prescribe a one-size-fits-all solution for referential
|
||||
* integrity; instead it exposes mechanisms that supports both database foreign key constraints
|
||||
* and implicit entity-specified foreign keys. Choosing which approach to use often depends on
|
||||
* application requirements, and sometimes even a mix-and-match is the right choice.
|
||||
*
|
||||
* - If referential integrity is critical to your application, database foreign key constraints
|
||||
* combined with {@link EntityEdgeDeletionBehavior.CASACDE_DELETE_INVALIDATE_CACHE} are recommended.
|
||||
* - If the database being used doesn't support foreign keys, then using the entity framework for referential
|
||||
* integrity is recommended.
|
||||
*/
|
||||
edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
|
||||
}
|
||||
|
||||
export abstract class EntityFieldDefinition {
|
||||
readonly columnName: string;
|
||||
readonly cache: boolean;
|
||||
readonly association?: EntityAssociationDefinition<any, any, any, any, any, any>;
|
||||
/**
|
||||
*
|
||||
* @param columnName - Column name in the database.
|
||||
* @param cache - Whether or not to cache loaded instances of the entity by this field. The column name is
|
||||
* used to derive a cache key for the cache entry. If true, this column must be able uniquely
|
||||
* identify the entity.
|
||||
*/
|
||||
constructor({
|
||||
columnName,
|
||||
cache = false,
|
||||
association,
|
||||
}: {
|
||||
columnName: string;
|
||||
cache?: boolean;
|
||||
association?: EntityAssociationDefinition<any, any, any, any, any, any>;
|
||||
}) {
|
||||
this.columnName = columnName;
|
||||
this.cache = cache;
|
||||
this.association = association;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS string type.
|
||||
* Enforces that the string is a valid UUID.
|
||||
*/
|
||||
export class UUIDField extends StringField {
|
||||
protected override validateInputValueInternal(value: string): boolean {
|
||||
return validateUUID(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS Date type.
|
||||
*/
|
||||
export class DateField extends EntityFieldDefinition<Date> {
|
||||
protected validateInputValueInternal(value: Date): boolean {
|
||||
return value instanceof Date;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS boolean type.
|
||||
*/
|
||||
export class BooleanField extends EntityFieldDefinition<boolean> {
|
||||
protected validateInputValueInternal(value: boolean): boolean {
|
||||
return typeof value === 'boolean';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS number type.
|
||||
* Enforces that the number is an integer.
|
||||
*/
|
||||
export class IntField extends EntityFieldDefinition<number> {
|
||||
protected validateInputValueInternal(value: number): boolean {
|
||||
return typeof value === 'number' && Number.isInteger(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS number type.
|
||||
* Enforces that the number is a float (which includes integers in JS).
|
||||
*/
|
||||
export class FloatField extends EntityFieldDefinition<number> {
|
||||
protected validateInputValueInternal(value: number): boolean {
|
||||
return typeof value === 'number';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS string array type.
|
||||
* Enforces that every member of the string array is a string.
|
||||
*/
|
||||
export class StringArrayField extends EntityFieldDefinition<string[]> {
|
||||
protected validateInputValueInternal(value: string[]): boolean {
|
||||
return Array.isArray(value) && value.every((subValue) => typeof subValue === 'string');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS JSON object type.
|
||||
*/
|
||||
export class JSONObjectField extends EntityFieldDefinition<object> {
|
||||
protected validateInputValueInternal(value: object): boolean {
|
||||
return typeof value === 'object' && !Array.isArray(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a enum column with a JS string or number type.
|
||||
*/
|
||||
export class EnumField extends EntityFieldDefinition<string | number> {
|
||||
protected validateInputValueInternal(value: string | number): boolean {
|
||||
return typeof value === 'number' || typeof value === 'string';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column with a JS JSON array type.
|
||||
*/
|
||||
export class JSONArrayField extends EntityFieldDefinition<any[]> {
|
||||
protected validateInputValueInternal(value: any[]): boolean {
|
||||
return Array.isArray(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link EntityFieldDefinition} for a column that may be a JS JSON array type.
|
||||
* Does not do any validation.
|
||||
*/
|
||||
export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
|
||||
protected validateInputValueInternal(_value: any): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
export class StringField extends EntityFieldDefinition {}
|
||||
export class UUIDField extends StringField {}
|
||||
export class DateField extends EntityFieldDefinition {}
|
||||
export class BooleanField extends EntityFieldDefinition {}
|
||||
export class NumberField extends EntityFieldDefinition {}
|
||||
export class StringArrayField extends EntityFieldDefinition {}
|
||||
export class JSONObjectField extends EntityFieldDefinition {}
|
||||
export class EnumField extends EntityFieldDefinition {}
|
||||
export class JSONArrayField extends EntityFieldDefinition {}
|
||||
export class MaybeJSONArrayField extends EntityFieldDefinition {}
|
||||
@@ -3,20 +3,13 @@ import invariant from 'invariant';
|
||||
|
||||
import EnforcingEntityLoader from './EnforcingEntityLoader';
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import {
|
||||
FieldEqualityCondition,
|
||||
QuerySelectionModifiers,
|
||||
isSingleValueFieldEqualityCondition,
|
||||
} from './EntityDatabaseAdapter';
|
||||
import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
|
||||
import { EntityNotFoundError } from './EntityErrors';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
|
||||
import EntityNotFoundError from './errors/EntityNotFoundError';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
@@ -25,7 +18,7 @@ import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
*/
|
||||
export default class EntityLoader<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -40,7 +33,7 @@ export default class EntityLoader<
|
||||
constructor(
|
||||
private readonly viewerContext: TViewerContext,
|
||||
private readonly queryContext: EntityQueryContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly idField: keyof Pick<TFields, TSelectedFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -50,8 +43,7 @@ export default class EntityLoader<
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly privacyPolicy: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
private readonly dataManager: EntityDataManager<TFields>
|
||||
) {}
|
||||
|
||||
/**
|
||||
@@ -81,15 +73,34 @@ export default class EntityLoader<
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
|
||||
this.validateFieldValues(fieldName, fieldValues);
|
||||
|
||||
const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
|
||||
this.queryContext,
|
||||
fieldName,
|
||||
fieldValues
|
||||
);
|
||||
const fieldValuesToUncheckedEntityResults = mapMap(fieldValuesToFieldObjects, (fieldObjects) =>
|
||||
this.tryConstructEntities(fieldObjects)
|
||||
);
|
||||
|
||||
return await this.constructAndAuthorizeEntitiesAsync(fieldValuesToFieldObjects);
|
||||
return await mapMapAsync(
|
||||
fieldValuesToUncheckedEntityResults,
|
||||
async (uncheckedEntityResults) => {
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
uncheckedEntityResult.value
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -121,13 +132,13 @@ export default class EntityLoader<
|
||||
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
uniqueFieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): Promise<Result<TEntity> | null> {
|
||||
): Promise<Result<TEntity | null>> {
|
||||
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue);
|
||||
invariant(
|
||||
entityResults.length <= 1,
|
||||
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${uniqueFieldName}=${fieldValue}`
|
||||
);
|
||||
return entityResults[0] ?? null;
|
||||
return entityResults[0] ?? result(null);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -139,9 +150,7 @@ export default class EntityLoader<
|
||||
const entityResults = await this.loadManyByIDsAsync([id]);
|
||||
const entityResult = entityResults.get(id);
|
||||
if (entityResult === undefined) {
|
||||
return result(
|
||||
new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
|
||||
);
|
||||
return result(new EntityNotFoundError(this.entityClass, this.idField, id as any));
|
||||
}
|
||||
return entityResult;
|
||||
}
|
||||
@@ -151,11 +160,8 @@ export default class EntityLoader<
|
||||
* @param id - ID of the entity
|
||||
* @returns entity result for matching ID, or null if no entity exists for ID.
|
||||
*/
|
||||
async loadByIDNullableAsync(id: TID): Promise<Result<TEntity> | null> {
|
||||
return await this.loadByFieldEqualingAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
id
|
||||
);
|
||||
async loadByIDNullableAsync(id: TID): Promise<Result<TEntity | null>> {
|
||||
return await this.loadByFieldEqualingAsync(this.idField, id as any);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -165,15 +171,14 @@ export default class EntityLoader<
|
||||
* @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
|
||||
*/
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
|
||||
const entityResults = (await this.loadManyByFieldEqualingManyAsync(
|
||||
this.entityConfiguration.idField as TSelectedFields,
|
||||
ids
|
||||
)) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
|
||||
const entityResults = ((await this.loadManyByFieldEqualingManyAsync(
|
||||
this.idField,
|
||||
ids as any
|
||||
)) as any) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
|
||||
return mapMap(entityResults, (entityResultsForId, id) => {
|
||||
const entityResult = entityResultsForId[0];
|
||||
return (
|
||||
entityResult ??
|
||||
result(new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id))
|
||||
entityResult ?? result(new EntityNotFoundError(this.entityClass, this.idField, id as any))
|
||||
);
|
||||
});
|
||||
}
|
||||
@@ -196,13 +201,6 @@ export default class EntityLoader<
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
for (const fieldEqualityOperand of fieldEqualityOperands) {
|
||||
const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
|
||||
? [fieldEqualityOperand.fieldValue]
|
||||
: fieldEqualityOperand.fieldValues;
|
||||
this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
|
||||
}
|
||||
|
||||
const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
|
||||
this.queryContext,
|
||||
fieldEqualityOperands,
|
||||
@@ -218,8 +216,7 @@ export default class EntityLoader<
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
uncheckedEntityResult.value
|
||||
)
|
||||
);
|
||||
})
|
||||
@@ -272,8 +269,7 @@ export default class EntityLoader<
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
uncheckedEntityResult.value
|
||||
)
|
||||
);
|
||||
})
|
||||
@@ -297,61 +293,18 @@ export default class EntityLoader<
|
||||
await this.invalidateFieldsAsync(entity.getAllDatabaseFields());
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrap entity construction in try/catch and return Results. Used to prevent constructor errors
|
||||
* thrown for one entity instantiation from interfering with other entity instantiatons of the same query.
|
||||
* @param fieldsObjects - array of entity data objects to construct entities
|
||||
*/
|
||||
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
|
||||
return fieldsObjects.map((fieldsObject) => {
|
||||
try {
|
||||
return result(new this.entityClass(this.viewerContext, fieldsObject));
|
||||
} catch (e) {
|
||||
if (!(e instanceof Error)) {
|
||||
throw e;
|
||||
}
|
||||
return result(e);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct and authorize entities from fields map, returning error results for entities that fail
|
||||
* to construct or fail to authorize.
|
||||
*
|
||||
* @param map - map from an arbitrary key type to an array of entity field objects
|
||||
*/
|
||||
public async constructAndAuthorizeEntitiesAsync<K>(
|
||||
map: ReadonlyMap<K, readonly Readonly<TFields>[]>
|
||||
): Promise<ReadonlyMap<K, readonly Result<TEntity>[]>> {
|
||||
const uncheckedEntityResultsMap = mapMap(map, (fieldObjects) =>
|
||||
this.tryConstructEntities(fieldObjects)
|
||||
);
|
||||
return await mapMapAsync(uncheckedEntityResultsMap, async (uncheckedEntityResults) => {
|
||||
return await Promise.all(
|
||||
uncheckedEntityResults.map(async (uncheckedEntityResult) => {
|
||||
if (!uncheckedEntityResult.ok) {
|
||||
return uncheckedEntityResult;
|
||||
}
|
||||
return await asyncResult(
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
);
|
||||
})
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
private validateFieldValues<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly TFields[N][]
|
||||
): void {
|
||||
const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
|
||||
invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
|
||||
for (const fieldValue of fieldValues) {
|
||||
const isInputValid = fieldDefinition.validateInputValue(fieldValue);
|
||||
if (!isInputValid) {
|
||||
throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,19 +1,17 @@
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
|
||||
/**
|
||||
* The primary entry point for loading entities.
|
||||
*/
|
||||
export default class EntityLoaderFactory<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
@@ -26,7 +24,7 @@ export default class EntityLoaderFactory<
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
constructor(
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly idField: keyof Pick<TFields, TSelectedFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -36,8 +34,7 @@ export default class EntityLoaderFactory<
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly privacyPolicyClass: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
private readonly dataManager: EntityDataManager<TFields>
|
||||
) {}
|
||||
|
||||
/**
|
||||
@@ -52,11 +49,10 @@ export default class EntityLoaderFactory<
|
||||
return new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
this.entityConfiguration,
|
||||
this.idField,
|
||||
this.entityClass,
|
||||
this.privacyPolicyClass,
|
||||
this.dataManager,
|
||||
this.metricsAdapter
|
||||
this.dataManager
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
import Entity from './Entity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
export enum EntityMutationType {
|
||||
CREATE,
|
||||
UPDATE,
|
||||
DELETE,
|
||||
}
|
||||
|
||||
export type EntityValidatorMutationInfo<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> =
|
||||
| {
|
||||
type: EntityMutationType.CREATE;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
};
|
||||
|
||||
export type EntityMutationTriggerDeleteCascadeInfo<> = {
|
||||
entity: Entity<any, any, any, any>;
|
||||
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null;
|
||||
};
|
||||
|
||||
export type EntityTriggerMutationInfo<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> =
|
||||
| {
|
||||
type: EntityMutationType.CREATE;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.DELETE;
|
||||
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null;
|
||||
};
|
||||
@@ -1,5 +1,4 @@
|
||||
import { EntityTriggerMutationInfo } from './EntityMutationInfo';
|
||||
import { EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
@@ -8,7 +7,7 @@ import ViewerContext from './ViewerContext';
|
||||
*/
|
||||
export default interface EntityMutationTriggerConfiguration<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
@@ -71,16 +70,15 @@ export default interface EntityMutationTriggerConfiguration<
|
||||
*/
|
||||
export abstract class EntityMutationTrigger<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
abstract executeAsync(
|
||||
abstract async executeAsync(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity
|
||||
): Promise<void>;
|
||||
}
|
||||
|
||||
@@ -90,14 +88,10 @@ export abstract class EntityMutationTrigger<
|
||||
*/
|
||||
export abstract class EntityNonTransactionalMutationTrigger<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
abstract executeAsync(
|
||||
viewerContext: TViewerContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
|
||||
): Promise<void>;
|
||||
abstract async executeAsync(viewerContext: TViewerContext, entity: TEntity): Promise<void>;
|
||||
}
|
||||
@@ -1,29 +1,21 @@
|
||||
import { EntityValidatorMutationInfo } from './EntityMutationInfo';
|
||||
import { EntityTransactionalQueryContext } from './EntityQueryContext';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
/**
|
||||
/*
|
||||
* A validator is a way to specify entity mutation validation that runs within the
|
||||
* same transaction as the mutation itself before creating or updating an entity.
|
||||
*/
|
||||
export default abstract class EntityMutationValidator<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TID,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
abstract executeAsync(
|
||||
abstract async executeAsync(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityTransactionalQueryContext,
|
||||
entity: TEntity,
|
||||
mutationInfo: EntityValidatorMutationInfo<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>
|
||||
queryContext: EntityQueryContext,
|
||||
entity: TEntity
|
||||
): Promise<void>;
|
||||
}
|
||||
Loaded 100 of 177 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user