mirror of
https://github.com/expo/entity.git
synced 2026-11-13 20:28:06 -10:00
Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a38e77e9af | ||
|
|
9ba1d430e0 |
No files matched your search
@@ -3,16 +3,16 @@ name: docs
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- master
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-18.04
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 18.x
|
||||
node-version: 12.x
|
||||
- name: Cache Node.js modules
|
||||
uses: actions/cache@v1
|
||||
with:
|
||||
|
||||
@@ -2,7 +2,7 @@ name: tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
branches: [ master ]
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
@@ -14,7 +14,7 @@ jobs:
|
||||
ref: ${{ github.event.pull_request.head.sha }}
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 18.x
|
||||
node-version: 12.x
|
||||
- name: Cache Node.js modules
|
||||
uses: actions/cache@v1
|
||||
with:
|
||||
|
||||
-171
@@ -3,177 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove unused field from redis configuration ([#213](https://github.com/expo/entity/issues/213)) ([503a2fb](https://github.com/expo/entity/commit/503a2fb6a8d57f6a09f6da99daf5ab92fc3e7945))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add ability to specify knex transaction config ([#207](https://github.com/expo/entity/issues/207)) ([2069a0d](https://github.com/expo/entity/commit/2069a0d9fd1d8f7d090a71a90a758b2429ea5dd3))
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.1](https://github.com/expo/entity/compare/v0.31.0...v0.31.1) (2023-03-06)
|
||||
|
||||
### Features
|
||||
* add loadFirstByFieldEqualityConjunction, a convenience method ([#206](https://github.com/expo/entity/pull/206)) ([1934216](https://github.com/expo/entity/commit/1934216b70572cf2b9693e0f14939f49b90427dd))
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package root
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package root
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add example of redis mget batching using @expo/batcher ([#199](https://github.com/expo/entity/issues/199)) ([684f91b](https://github.com/expo/entity/commit/684f91b1f270851dbe331df2e2620664eea17266))
|
||||
* change redis cache adapter to use redis-like interface ([#200](https://github.com/expo/entity/issues/200)) ([e381f5b](https://github.com/expo/entity/commit/e381f5b2acfc17dcade2cf6e8506fa1c1c255e73))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add BigIntField ([#193](https://github.com/expo/entity/issues/193)) ([acbad82](https://github.com/expo/entity/commit/acbad826a37bb5a054b4dcf9be91d11aa5f7f29a))
|
||||
* nested transactions ([#194](https://github.com/expo/entity/issues/194)) ([a77b914](https://github.com/expo/entity/commit/a77b914ad6dc018d1e309c9caf4971088a553ecf))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add orderByRaw to loadManyByRawWhereClauseAsync ([#185](https://github.com/expo/entity/issues/185)) ([2817d78](https://github.com/expo/entity/commit/2817d78392dfecd0093111c24d581bdf01dba06d))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* recache to higher cache levels when loading from a composed cache ([#182](https://github.com/expo/entity/pull/182))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* fix workflow branch specification ([#179](https://github.com/expo/entity/issues/179)) ([25d14bf](https://github.com/expo/entity/commit/25d14bf8c1688524ad488aa2b63221393a4f0b05))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
|
||||
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* lock lru-cache to v6.0.0 ([#170](https://github.com/expo/entity/issues/170)) ([293868b](https://github.com/expo/entity/commit/293868b1a73df9f749216af68b1ae94ac22ac2b9))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* lru-cache yarn workspace version resolution ([#168](https://github.com/expo/entity/issues/168)) ([e76ca8c](https://github.com/expo/entity/commit/e76ca8c2f72da84aa372a64ef1898ade220ed0a8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add composed cache to index ([#166](https://github.com/expo/entity/issues/166)) ([5c82edc](https://github.com/expo/entity/commit/5c82edcd9f26854878d29950a05852e117bbd723))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
* privacy policy evaluation context ([#162](https://github.com/expo/entity/issues/162)) ([3a81a4c](https://github.com/expo/entity/commit/3a81a4c059e2e995eb800e35e76b3d432c22b23f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ Entity is a privacy-aware data layer for defining, caching, and authorizing acce
|
||||
|
||||
[](https://github.com/expo/entity/actions?query=workflow%3Atests)
|
||||
[](https://expo.github.io/entity/)
|
||||
[](https://codecov.io/gh/expo/entity)
|
||||
[](https://codecov.io/gh/expo/entity)
|
||||
[](https://www.npmjs.com/package/@expo/entity)
|
||||
[](https://www.npmjs.com/package/@expo/entity)
|
||||
|
||||
@@ -80,10 +80,18 @@ Note: The entity framework instance should not be shared across multiple request
|
||||
|
||||
## Releasing
|
||||
|
||||
To release a new version:
|
||||
1. `git checkout main`
|
||||
1. `yarn lerna publish [patch|minor|major] -- --conventional-commits`
|
||||
To release a new version, let's say `v1.0.0` for example:
|
||||
1. `git checkout -b bump-v1.0.0`
|
||||
1. `yarn lerna version minor -- --no-push --conventional-commits`
|
||||
1. `git push -u origin bump-v1.0.0`
|
||||
1. Create a PR from the `bump-v1.0.0` branch, wait for tests, and commit the PR using GitHub interface.
|
||||
1. `git checkout master && git pull`
|
||||
1. `git tag -d v1.0.0`
|
||||
1. `git tag v1.0.0`
|
||||
1. `git push origin v1.0.0`
|
||||
1. In GitHub release interface, create a new release from the tag, copy changelog changes to release description.
|
||||
1. `yarn clean && yarn tsc`
|
||||
1. In each public subpackage, run `npm publish` and enter 2FA token.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
+1
-1
@@ -4,5 +4,5 @@
|
||||
],
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true,
|
||||
"version": "0.32.0"
|
||||
"version": "0.22.0"
|
||||
}
|
||||
+17
-20
@@ -16,39 +16,36 @@
|
||||
"barrelsby": "lerna run barrelsby"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/batcher": "^1.0.0",
|
||||
"@expo/entity": "file:packages/entity",
|
||||
"@expo/results": "^1.0.0",
|
||||
"@types/invariant": "^2.2.33",
|
||||
"@types/jest": "^29.5.2",
|
||||
"@types/ioredis": "^4.26.4",
|
||||
"@types/jest": "^26.0.10",
|
||||
"@types/jsbn": "^1.2.29",
|
||||
"@types/lru-cache": "^5.1.1",
|
||||
"@types/node": "^16.18.34",
|
||||
"@types/node": "^14.6.0",
|
||||
"@types/uuid": "^8.3.0",
|
||||
"@typescript-eslint/eslint-plugin": "^4.14.0",
|
||||
"@typescript-eslint/parser": "^4.14.0",
|
||||
"barrelsby": "^2.2.0",
|
||||
"eslint": "^8.14.0",
|
||||
"eslint-config-universe": "^11.2.0",
|
||||
"eslint-plugin-tsdoc": "^0.2.17",
|
||||
"ioredis": "^5.2.5",
|
||||
"jest": "^29.1.2",
|
||||
"lerna": "^5.4.0",
|
||||
"lru-cache": "^6.0.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.10.0",
|
||||
"prettier": "^2.8.8",
|
||||
"ts-jest": "^29.1.0",
|
||||
"pg": "^8.6.0",
|
||||
"prettier": "^2.3.2",
|
||||
"ts-jest": "~26.4.4",
|
||||
"ts-mockito": "^2.6.1",
|
||||
"typedoc": "^0.24.8",
|
||||
"typescript": "^5.1.3",
|
||||
"typedoc": "^0.21.9",
|
||||
"typescript": "^4.4.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-ip-address-field": "file:packages/entity-ip-address-field",
|
||||
"@expo/entity-secondary-cache-local-memory": "file:packages/entity-secondary-cache-local-memory",
|
||||
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis"
|
||||
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis",
|
||||
"@expo/entity-ip-address-field": "file:packages/entity-ip-address-field"
|
||||
}
|
||||
}
|
||||
@@ -1,119 +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.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* lock lru-cache to v6.0.0 ([#170](https://github.com/expo/entity/issues/170)) ([293868b](https://github.com/expo/entity/commit/293868b1a73df9f749216af68b1ae94ac22ac2b9))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* lru-cache yarn workspace version resolution ([#168](https://github.com/expo/entity/issues/168)) ([e76ca8c](https://github.com/expo/entity/commit/e76ca8c2f72da84aa372a64ef1898ade220ed0a8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add local memory cache package ([#158](https://github.com/expo/entity/issues/158)) ([85d3575](https://github.com/expo/entity/commit/85d35752fa0919a62efb776a762a6829e83ca7af))
|
||||
@@ -1,49 +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.
|
||||
|
||||
Note: This uses version 6.0.0 of `node-lru-cache` since it the most tuned version for our use case (low TTL + LRU). Upgrading
|
||||
to 7.x will cause high memory usage for the entity cache adapter use case since it allocates fixed-size data structures up front to tune for the non-TTL use case: https://github.com/isaacs/node-lru-cache/issues/208.
|
||||
|
||||
[Documentation](https://expo.github.io/entity/modules/_expo_cache_adapter_local_memory.html)
|
||||
|
||||
## Why NOT use this cache
|
||||
|
||||
Because this is an in-memory cache, cross-machine invalidation is not possible. Do not use this cache
|
||||
if you have the following use cases:
|
||||
|
||||
- The objects stored are mutable
|
||||
- Reading a stale object from the cache is not acceptable in your application
|
||||
- Cross-machine invalidation is not possible
|
||||
|
||||
## Typical use cases
|
||||
|
||||
If your application sees many requests fetching the same objects, you can save a trip to your cache
|
||||
cluster and backing datastore by using this in-memory cache. Here are some good use cases:
|
||||
|
||||
- The objects stored are mostly immutable, and reading a stale object for a short TTL is acceptable
|
||||
- You have a low TTL setting in your cache
|
||||
|
||||
## Usage
|
||||
|
||||
During `EntityCompanionProvider` instantiation:
|
||||
|
||||
```typescript
|
||||
export const createDefaultEntityCompanionProvider = (
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
{
|
||||
...
|
||||
},
|
||||
{
|
||||
['local-memory']: {
|
||||
cacheAdapterProvider: new LocalMemoryCacheAdapterProvider.getProvider(),
|
||||
},
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
```
|
||||
@@ -1,38 +0,0 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-local-memory",
|
||||
"version": "0.32.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": ">=16"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
],
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"lru-cache": "^6.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.32.0"
|
||||
}
|
||||
}
|
||||
@@ -1,103 +0,0 @@
|
||||
import {
|
||||
CacheLoadResult,
|
||||
CacheStatus,
|
||||
EntityConfiguration,
|
||||
IEntityGenericCacher,
|
||||
} from '@expo/entity';
|
||||
import invariant from 'invariant';
|
||||
import LRUCache from 'lru-cache';
|
||||
|
||||
// Sentinel value we store in local memory to negatively cache a database miss.
|
||||
// The sentinel value is distinct from any (positively) cached value.
|
||||
export const DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = Symbol('doesNotExist');
|
||||
type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
|
||||
export type LocalMemoryCache<TFields> = LRUCache<string, LocalMemoryCacheValue<TFields>>;
|
||||
|
||||
export default class GenericLocalMemoryCacher<TFields> implements IEntityGenericCacher<TFields> {
|
||||
constructor(
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly localMemoryCache: LocalMemoryCache<TFields>
|
||||
) {}
|
||||
|
||||
static createLRUCache<TFields>(
|
||||
options: { maxSize?: number; ttlSeconds?: number } = {}
|
||||
): LocalMemoryCache<TFields> {
|
||||
const DEFAULT_LRU_CACHE_MAX_AGE_SECONDS = 10;
|
||||
const DEFAULT_LRU_CACHE_SIZE = 10000;
|
||||
const maxAgeSeconds = options.ttlSeconds ?? DEFAULT_LRU_CACHE_MAX_AGE_SECONDS;
|
||||
return new LRUCache<string, LocalMemoryCacheValue<TFields>>({
|
||||
max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE,
|
||||
length: (value) => (value === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1),
|
||||
maxAge: maxAgeSeconds * 1000, // convert to ms
|
||||
});
|
||||
}
|
||||
|
||||
static createNoOpCache<TFields>(): LocalMemoryCache<TFields> {
|
||||
return new LRUCache<string, LocalMemoryCacheValue<TFields>>({
|
||||
max: 0,
|
||||
maxAge: -1,
|
||||
});
|
||||
}
|
||||
|
||||
public async loadManyAsync(
|
||||
keys: readonly string[]
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
||||
const cacheResults = new Map<string, CacheLoadResult<TFields>>();
|
||||
for (const key of keys) {
|
||||
const cacheResult = this.localMemoryCache.get(key);
|
||||
if (cacheResult === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE) {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.NEGATIVE,
|
||||
});
|
||||
} else if (cacheResult) {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.HIT,
|
||||
item: cacheResult as unknown as TFields,
|
||||
});
|
||||
} else {
|
||||
cacheResults.set(key, {
|
||||
status: CacheStatus.MISS,
|
||||
});
|
||||
}
|
||||
}
|
||||
return cacheResults;
|
||||
}
|
||||
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void> {
|
||||
for (const [key, item] of objectMap) {
|
||||
this.localMemoryCache.set(key, item);
|
||||
}
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync(keys: readonly string[]): Promise<void> {
|
||||
for (const key of keys) {
|
||||
this.localMemoryCache.set(key, DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||
}
|
||||
}
|
||||
|
||||
public async invalidateManyAsync(keys: readonly string[]): Promise<void> {
|
||||
for (const key of keys) {
|
||||
this.localMemoryCache.del(key);
|
||||
}
|
||||
}
|
||||
|
||||
public makeCacheKey<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): string {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${String(fieldName)}`);
|
||||
const parts = [
|
||||
this.entityConfiguration.tableName,
|
||||
`${this.entityConfiguration.cacheKeyVersion}`,
|
||||
columnName,
|
||||
String(fieldValue),
|
||||
];
|
||||
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||
);
|
||||
return escapedParts.join(delimiter);
|
||||
}
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
import {
|
||||
computeIfAbsent,
|
||||
IEntityCacheAdapter,
|
||||
EntityConfiguration,
|
||||
GenericEntityCacheAdapter,
|
||||
IEntityCacheAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
|
||||
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
|
||||
|
||||
export default class LocalMemoryCacheAdapterProvider implements IEntityCacheAdapterProvider {
|
||||
// local memory cache adapters should be shared/reused across requests
|
||||
private static localMemoryCacheAdapterMap = new Map<string, GenericEntityCacheAdapter<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>
|
||||
): IEntityCacheAdapter<TFields> {
|
||||
return computeIfAbsent(
|
||||
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap,
|
||||
entityConfiguration.tableName,
|
||||
() => {
|
||||
const localMemoryCache = this.localMemoryCacheCreator<TFields>();
|
||||
return new GenericEntityCacheAdapter(
|
||||
new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache)
|
||||
);
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
-175
@@ -1,175 +0,0 @@
|
||||
import { CacheStatus, ViewerContext } from '@expo/entity';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import GenericLocalMemoryCacher from '../GenericLocalMemoryCacher';
|
||||
import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider';
|
||||
import LocalMemoryTestEntity from '../testfixtures/LocalMemoryTestEntity';
|
||||
import {
|
||||
createLocalMemoryTestEntityCompanionProvider,
|
||||
createNoopLocalMemoryIntegrationTestEntityCompanionProvider,
|
||||
} from '../testfixtures/createLocalMemoryTestEntityCompanionProvider';
|
||||
|
||||
describe(GenericLocalMemoryCacher, () => {
|
||||
beforeEach(async () => {
|
||||
LocalMemoryCacheAdapterProvider['localMemoryCacheAdapterMap'].clear();
|
||||
});
|
||||
|
||||
it('has correct caching behavior', async () => {
|
||||
const viewerContext = new ViewerContext(createLocalMemoryTestEntityCompanionProvider());
|
||||
const genericCacher =
|
||||
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)[
|
||||
'tableDataCoordinator'
|
||||
]['cacheAdapter']['genericCacher'];
|
||||
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
|
||||
|
||||
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(
|
||||
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)
|
||||
.entityCompanionDefinition.entityConfiguration.tableName
|
||||
)!['genericCacher'];
|
||||
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 ViewerContext(createLocalMemoryTestEntityCompanionProvider());
|
||||
|
||||
const date = new Date();
|
||||
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.setField('dateField', date)
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache
|
||||
await LocalMemoryTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
// load entity with a different request
|
||||
const viewerContext2 = new ViewerContext(createLocalMemoryTestEntityCompanionProvider());
|
||||
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2)
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
const genericCacher =
|
||||
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)[
|
||||
'tableDataCoordinator'
|
||||
]['cacheAdapter']['genericCacher'];
|
||||
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
|
||||
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 ViewerContext(
|
||||
createNoopLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||
);
|
||||
const genericCacher =
|
||||
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)[
|
||||
'tableDataCoordinator'
|
||||
]['cacheAdapter']['genericCacher'];
|
||||
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
|
||||
|
||||
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(
|
||||
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)
|
||||
.entityCompanionDefinition.entityConfiguration.tableName
|
||||
)!['genericCacher'];
|
||||
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,
|
||||
});
|
||||
});
|
||||
});
|
||||
-142
@@ -1,142 +0,0 @@
|
||||
import {
|
||||
CacheStatus,
|
||||
UUIDField,
|
||||
EntityConfiguration,
|
||||
GenericEntityCacheAdapter,
|
||||
} from '@expo/entity';
|
||||
|
||||
import GenericLocalMemoryCacher, {
|
||||
DOES_NOT_EXIST_LOCAL_MEMORY_CACHE,
|
||||
} from '../GenericLocalMemoryCacher';
|
||||
|
||||
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(GenericLocalMemoryCacher, () => {
|
||||
describe(GenericLocalMemoryCacher.createLRUCache, () => {
|
||||
it('creates a cache with default options', () => {
|
||||
const cache = GenericLocalMemoryCacher.createLRUCache();
|
||||
expect(cache.max).toBe(10000);
|
||||
expect(cache.maxAge).toBe(10000);
|
||||
});
|
||||
|
||||
it('respects specified options', () => {
|
||||
const cache = GenericLocalMemoryCacher.createLRUCache({
|
||||
ttlSeconds: 3,
|
||||
maxSize: 10,
|
||||
});
|
||||
expect(cache.max).toBe(10);
|
||||
expect(cache.maxAge).toBe(3000);
|
||||
});
|
||||
});
|
||||
|
||||
describe(GenericLocalMemoryCacher.createNoOpCache, () => {
|
||||
it('creates a no-op cache', () => {
|
||||
const cache = GenericLocalMemoryCacher.createNoOpCache<{ hello: 'world' }>();
|
||||
cache.set('a', { hello: 'world' });
|
||||
expect(cache.get('a')).toBeUndefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('Use within GenericEntityCacheAdapter', () => {
|
||||
describe('loadManyAsync', () => {
|
||||
it('returns appropriate cache results', async () => {
|
||||
const cacheAdapter = new GenericEntityCacheAdapter(
|
||||
new GenericLocalMemoryCacher(entityConfiguration, GenericLocalMemoryCacher.createLRUCache())
|
||||
);
|
||||
|
||||
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
|
||||
await cacheAdapter.cacheManyAsync('id', cacheHits);
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', [
|
||||
'test-id-1',
|
||||
'test-id-2',
|
||||
'test-id-3',
|
||||
]);
|
||||
|
||||
expect(results.get('test-id-1')).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: { id: 'test-id-1' },
|
||||
});
|
||||
expect(results.get('test-id-2')).toMatchObject({ status: CacheStatus.NEGATIVE });
|
||||
expect(results.get('test-id-3')).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.size).toBe(3);
|
||||
});
|
||||
|
||||
it('returns empty map when passed empty array of fieldValues', async () => {
|
||||
const cacheAdapter = new GenericEntityCacheAdapter(
|
||||
new GenericLocalMemoryCacher(entityConfiguration, GenericLocalMemoryCacher.createLRUCache())
|
||||
);
|
||||
const results = await cacheAdapter.loadManyAsync('id', []);
|
||||
expect(results).toEqual(new Map());
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheManyAsync', () => {
|
||||
it('correctly caches all objects', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
||||
|
||||
const localMemoryCacher = new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache);
|
||||
const cacheAdapter = new GenericEntityCacheAdapter(localMemoryCacher);
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
||||
|
||||
const cacheKey = localMemoryCacher['makeCacheKey']('id', 'test-id-1');
|
||||
expect(localMemoryCache.get(cacheKey)).toMatchObject({
|
||||
id: 'test-id-1',
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheDBMissesAsync', () => {
|
||||
it('correctly caches misses', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
||||
|
||||
const localMemoryCacher = new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache);
|
||||
const cacheAdapter = new GenericEntityCacheAdapter(localMemoryCacher);
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']);
|
||||
|
||||
const cacheKey = localMemoryCacher['makeCacheKey']('id', 'test-id-1');
|
||||
expect(localMemoryCache.get(cacheKey)).toEqual(DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||
});
|
||||
});
|
||||
|
||||
describe('invalidateManyAsync', () => {
|
||||
it('invalidates correctly', async () => {
|
||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
||||
|
||||
const cacheAdapter = new GenericEntityCacheAdapter(
|
||||
new GenericLocalMemoryCacher(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 GenericEntityCacheAdapter(
|
||||
new GenericLocalMemoryCacher(
|
||||
entityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache<BlahFields>({})
|
||||
)
|
||||
);
|
||||
await cacheAdapter.invalidateManyAsync('id', []);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,9 +0,0 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-cache-adapter-local-memory
|
||||
*/
|
||||
|
||||
export { default as GenericLocalMemoryCacher } from './GenericLocalMemoryCacher';
|
||||
export * from './GenericLocalMemoryCacher';
|
||||
export { default as LocalMemoryCacheAdapterProvider } from './LocalMemoryCacheAdapterProvider';
|
||||
@@ -1,98 +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 defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: LocalMemoryTestEntity,
|
||||
entityConfiguration: localMemoryTestEntityConfiguration,
|
||||
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
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',
|
||||
});
|
||||
-48
@@ -1,48 +0,0 @@
|
||||
import {
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
|
||||
import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider';
|
||||
|
||||
export const createLocalMemoryTestEntityCompanionProvider = (
|
||||
localMemoryOptions: { maxSize?: number; ttlSeconds?: number } = {},
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
const localMemoryCacheAdapterProvider =
|
||||
localMemoryOptions.maxSize === 0 && localMemoryOptions.ttlSeconds === 0
|
||||
? LocalMemoryCacheAdapterProvider.getNoOpProvider()
|
||||
: LocalMemoryCacheAdapterProvider.getProvider(localMemoryOptions);
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'local-memory',
|
||||
{
|
||||
cacheAdapterProvider: localMemoryCacheAdapterProvider,
|
||||
},
|
||||
],
|
||||
])
|
||||
);
|
||||
};
|
||||
|
||||
export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = (
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return createLocalMemoryTestEntityCompanionProvider(
|
||||
{ maxSize: 0, ttlSeconds: 0 },
|
||||
metricsAdapter
|
||||
);
|
||||
};
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -3,136 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove unused field from redis configuration ([#213](https://github.com/expo/entity/issues/213)) ([503a2fb](https://github.com/expo/entity/commit/503a2fb6a8d57f6a09f6da99daf5ab92fc3e7945))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add example of redis mget batching using @expo/batcher ([#199](https://github.com/expo/entity/issues/199)) ([684f91b](https://github.com/expo/entity/commit/684f91b1f270851dbe331df2e2620664eea17266))
|
||||
* change redis cache adapter to use redis-like interface ([#200](https://github.com/expo/entity/issues/200)) ([e381f5b](https://github.com/expo/entity/commit/e381f5b2acfc17dcade2cf6e8506fa1c1c255e73))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
### 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
|
||||
|
||||
@@ -11,7 +11,7 @@ During `EntityCompanionProvider` instantiation:
|
||||
```typescript
|
||||
import Redis from 'ioredis';
|
||||
|
||||
const genericRedisCacherContext = {
|
||||
const redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
@@ -21,6 +21,7 @@ const genericRedisCacherContext = {
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'ent-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
@@ -35,7 +36,7 @@ export const createDefaultEntityCompanionProvider = (
|
||||
},
|
||||
{
|
||||
['redis']: {
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
}
|
||||
);
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-cache-adapter-redis",
|
||||
"version": "0.32.0",
|
||||
"version": "0.22.0",
|
||||
"description": "Redis cache adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -19,7 +19,7 @@
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
@@ -27,11 +27,12 @@
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*",
|
||||
"ioredis": ">=5"
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"ioredis": "^4.27.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.32.0",
|
||||
"ioredis": "^5.2.5"
|
||||
"@expo/entity": "^0.22.0"
|
||||
}
|
||||
}
|
||||
@@ -1,48 +1,17 @@
|
||||
import {
|
||||
CacheLoadResult,
|
||||
CacheStatus,
|
||||
EntityConfiguration,
|
||||
transformCacheObjectToFields,
|
||||
transformFieldsToCacheObject,
|
||||
IEntityGenericCacher,
|
||||
} from '@expo/entity';
|
||||
import invariant from 'invariant';
|
||||
import { CacheLoadResult, CacheStatus } 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 IRedisTransaction {
|
||||
set(key: string, value: string, secondsToken: 'EX', seconds: number): this;
|
||||
exec(): Promise<any>;
|
||||
}
|
||||
|
||||
export interface IRedis {
|
||||
mget(...args: [...keys: string[]]): Promise<(string | null)[]>;
|
||||
multi(): IRedisTransaction;
|
||||
del(...args: [...keys: string[]]): Promise<any>;
|
||||
}
|
||||
|
||||
export interface GenericRedisCacheContext {
|
||||
/**
|
||||
* Instance of ioredis.Redis
|
||||
*/
|
||||
redisClient: IRedis;
|
||||
|
||||
/**
|
||||
* Create a key string for key parts (cache key prefix, versions, entity name, etc).
|
||||
* Most commonly a simple `parts.join(':')`. See integration test for example.
|
||||
*/
|
||||
makeKeyFn: (...parts: string[]) => string;
|
||||
|
||||
/**
|
||||
* Prefix prepended to all entity cache keys. Useful for adding a short, human-readable
|
||||
* distintion for entity keys, e.g. `ent-`
|
||||
*/
|
||||
cacheKeyPrefix: string;
|
||||
redisClient: Redis;
|
||||
|
||||
/**
|
||||
* TTL for caching database hits. Successive entity loads within this TTL
|
||||
@@ -57,15 +26,12 @@ export interface GenericRedisCacheContext {
|
||||
ttlSecondsNegative: number;
|
||||
}
|
||||
|
||||
export default class GenericRedisCacher<TFields> implements IEntityGenericCacher<TFields> {
|
||||
constructor(
|
||||
private readonly context: GenericRedisCacheContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>
|
||||
) {}
|
||||
export default class GenericRedisCacher {
|
||||
constructor(private readonly context: GenericRedisCacheContext) {}
|
||||
|
||||
public async loadManyAsync(
|
||||
keys: readonly string[]
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
||||
): Promise<ReadonlyMap<string, CacheLoadResult>> {
|
||||
if (keys.length === 0) {
|
||||
return new Map();
|
||||
}
|
||||
@@ -74,7 +40,7 @@ export default class GenericRedisCacher<TFields> implements IEntityGenericCacher
|
||||
this.context.redisClient.mget(...keys)
|
||||
);
|
||||
|
||||
const results = new Map<string, CacheLoadResult<TFields>>();
|
||||
const results = new Map<string, CacheLoadResult>();
|
||||
for (let i = 0; i < keys.length; i++) {
|
||||
const key = keys[i]!;
|
||||
const redisResult = redisResults[i];
|
||||
@@ -86,11 +52,7 @@ export default class GenericRedisCacher<TFields> implements IEntityGenericCacher
|
||||
} else if (redisResult) {
|
||||
results.set(key, {
|
||||
status: CacheStatus.HIT,
|
||||
item: transformCacheObjectToFields(
|
||||
this.entityConfiguration,
|
||||
redisTransformerMap,
|
||||
JSON.parse(redisResult)
|
||||
),
|
||||
item: JSON.parse(redisResult),
|
||||
});
|
||||
} else {
|
||||
results.set(key, {
|
||||
@@ -101,7 +63,7 @@ export default class GenericRedisCacher<TFields> implements IEntityGenericCacher
|
||||
return results;
|
||||
}
|
||||
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void> {
|
||||
public async cacheManyAsync(objectMap: ReadonlyMap<string, object>): Promise<void> {
|
||||
if (objectMap.size === 0) {
|
||||
return;
|
||||
}
|
||||
@@ -110,9 +72,7 @@ export default class GenericRedisCacher<TFields> implements IEntityGenericCacher
|
||||
objectMap.forEach((object, key) => {
|
||||
redisTransaction = redisTransaction.set(
|
||||
key,
|
||||
JSON.stringify(
|
||||
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
|
||||
),
|
||||
JSON.stringify(object),
|
||||
'EX',
|
||||
this.context.ttlSecondsPositive
|
||||
);
|
||||
@@ -120,7 +80,7 @@ export default class GenericRedisCacher<TFields> implements IEntityGenericCacher
|
||||
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync(keys: readonly string[]): Promise<void> {
|
||||
public async cacheDBMissesAsync(keys: string[]): Promise<void> {
|
||||
if (keys.length === 0) {
|
||||
return;
|
||||
}
|
||||
@@ -137,26 +97,11 @@ export default class GenericRedisCacher<TFields> implements IEntityGenericCacher
|
||||
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
||||
}
|
||||
|
||||
public async invalidateManyAsync(keys: readonly string[]): Promise<void> {
|
||||
public async invalidateManyAsync(keys: string[]): Promise<void> {
|
||||
if (keys.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
await wrapNativeRedisCallAsync(() => this.context.redisClient.del(...keys));
|
||||
}
|
||||
|
||||
public makeCacheKey<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): string {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${String(fieldName)}`);
|
||||
return this.context.makeKeyFn(
|
||||
this.context.cacheKeyPrefix,
|
||||
this.entityConfiguration.tableName,
|
||||
`v2.${this.entityConfiguration.cacheKeyVersion}`,
|
||||
columnName,
|
||||
String(fieldValue)
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,164 @@
|
||||
import {
|
||||
EntityCacheAdapter,
|
||||
EntityConfiguration,
|
||||
CacheLoadResult,
|
||||
FieldTransformerMap,
|
||||
mapKeys,
|
||||
transformCacheObjectToFields,
|
||||
CacheStatus,
|
||||
transformFieldsToCacheObject,
|
||||
} from '@expo/entity';
|
||||
import invariant from 'invariant';
|
||||
import { Redis } from 'ioredis';
|
||||
|
||||
import GenericRedisCacher from './GenericRedisCacher';
|
||||
import { redisTransformerMap } from './RedisCommon';
|
||||
|
||||
export interface RedisCacheAdapterContext {
|
||||
/**
|
||||
* Instance of ioredis.Redis
|
||||
*/
|
||||
redisClient: Redis;
|
||||
|
||||
/**
|
||||
* Create a key string for key parts (cache key prefix, versions, entity name, etc).
|
||||
* Most commonly a simple `parts.join(':')`. See integration test for example.
|
||||
*/
|
||||
makeKeyFn: (...parts: string[]) => string;
|
||||
|
||||
/**
|
||||
* Global cache version for the entity framework. Bumping this version will
|
||||
* invalidate the cache for all entities at once.
|
||||
*/
|
||||
cacheKeyVersion: number;
|
||||
|
||||
/**
|
||||
* Prefix prepended to all entity cache keys. Useful for adding a short, human-readable
|
||||
* distintion for entity keys, e.g. `ent-`
|
||||
*/
|
||||
cacheKeyPrefix: string;
|
||||
|
||||
/**
|
||||
* 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 RedisCacheAdapter<TFields> extends EntityCacheAdapter<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.
|
||||
*/
|
||||
private readonly redisFieldTransformer: FieldTransformerMap = redisTransformerMap;
|
||||
private readonly genericRedisCacher: GenericRedisCacher;
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly context: RedisCacheAdapterContext
|
||||
) {
|
||||
super(entityConfiguration);
|
||||
|
||||
this.genericRedisCacher = new GenericRedisCacher({
|
||||
redisClient: context.redisClient,
|
||||
ttlSecondsNegative: context.ttlSecondsNegative,
|
||||
ttlSecondsPositive: context.ttlSecondsPositive,
|
||||
});
|
||||
}
|
||||
|
||||
public async loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult>> {
|
||||
const redisCacheKeyToFieldValueMapping = new Map(
|
||||
fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue])
|
||||
);
|
||||
const rawCacheResults = await this.genericRedisCacher.loadManyAsync(
|
||||
Array.from(redisCacheKeyToFieldValueMapping.keys())
|
||||
);
|
||||
const cacheResults = new Map<string, CacheLoadResult>();
|
||||
for (const [redisCacheKey, rawCacheResult] of rawCacheResults) {
|
||||
if (rawCacheResult.status === CacheStatus.HIT) {
|
||||
cacheResults.set(redisCacheKey, {
|
||||
status: CacheStatus.HIT,
|
||||
item: transformCacheObjectToFields(
|
||||
this.entityConfiguration,
|
||||
this.redisFieldTransformer,
|
||||
rawCacheResult.item
|
||||
),
|
||||
});
|
||||
} else {
|
||||
cacheResults.set(redisCacheKey, rawCacheResult);
|
||||
}
|
||||
}
|
||||
|
||||
return mapKeys(cacheResults, (redisCacheKey) => {
|
||||
const fieldValue = redisCacheKeyToFieldValueMapping.get(redisCacheKey);
|
||||
invariant(
|
||||
fieldValue !== undefined,
|
||||
'Unspecified cache key %s returned from generic Redis cacher',
|
||||
redisCacheKey
|
||||
);
|
||||
return fieldValue;
|
||||
});
|
||||
}
|
||||
|
||||
public async cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, object>
|
||||
): Promise<void> {
|
||||
const cacheObjectMap = new Map<NonNullable<TFields[N]>, object>();
|
||||
for (const [fieldValue, object] of objectMap) {
|
||||
cacheObjectMap.set(
|
||||
fieldValue,
|
||||
transformFieldsToCacheObject(
|
||||
this.entityConfiguration,
|
||||
this.redisFieldTransformer,
|
||||
object as Readonly<TFields>
|
||||
)
|
||||
);
|
||||
}
|
||||
await this.genericRedisCacher.cacheManyAsync(
|
||||
mapKeys(cacheObjectMap, (fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
await this.genericRedisCacher.cacheDBMissesAsync(
|
||||
fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
}
|
||||
|
||||
public async invalidateManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
await this.genericRedisCacher.invalidateManyAsync(
|
||||
fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||
);
|
||||
}
|
||||
|
||||
private makeCacheKey<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValue: NonNullable<TFields[N]>
|
||||
): string {
|
||||
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||
invariant(columnName, `database field mapping missing for ${fieldName}`);
|
||||
return this.context.makeKeyFn(
|
||||
this.context.cacheKeyPrefix,
|
||||
this.entityConfiguration.tableName,
|
||||
`v2.${this.entityConfiguration.cacheKeyVersion}`,
|
||||
columnName,
|
||||
String(fieldValue)
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,18 +1,13 @@
|
||||
import {
|
||||
IEntityCacheAdapterProvider,
|
||||
EntityConfiguration,
|
||||
IEntityCacheAdapter,
|
||||
GenericEntityCacheAdapter,
|
||||
} from '@expo/entity';
|
||||
import { IEntityCacheAdapterProvider, EntityConfiguration, EntityCacheAdapter } from '@expo/entity';
|
||||
|
||||
import GenericRedisCacher, { GenericRedisCacheContext } from './GenericRedisCacher';
|
||||
import RedisCacheAdapter, { RedisCacheAdapterContext } from './RedisCacheAdapter';
|
||||
|
||||
export default class RedisCacheAdapterProvider implements IEntityCacheAdapterProvider {
|
||||
constructor(private readonly context: GenericRedisCacheContext) {}
|
||||
constructor(private readonly context: RedisCacheAdapterContext) {}
|
||||
|
||||
getCacheAdapter<TFields>(
|
||||
entityConfiguration: EntityConfiguration<TFields>
|
||||
): IEntityCacheAdapter<TFields> {
|
||||
return new GenericEntityCacheAdapter(new GenericRedisCacher(this.context, entityConfiguration));
|
||||
): EntityCacheAdapter<TFields> {
|
||||
return new RedisCacheAdapter(entityConfiguration, this.context);
|
||||
}
|
||||
}
|
||||
-166
@@ -1,166 +0,0 @@
|
||||
import { Batcher } from '@expo/batcher';
|
||||
import { ViewerContext, zipToMap } from '@expo/entity';
|
||||
import invariant from 'invariant';
|
||||
import Redis from 'ioredis';
|
||||
import nullthrows from 'nullthrows';
|
||||
import { URL } from 'url';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import GenericRedisCacher, {
|
||||
IRedis,
|
||||
IRedisTransaction,
|
||||
GenericRedisCacheContext,
|
||||
} from '../GenericRedisCacher';
|
||||
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class BatchedRedis implements IRedis {
|
||||
private readonly mgetBatcher = new Batcher<string[], (string | null)[]>(
|
||||
this.batchMgetAsync.bind(this),
|
||||
{
|
||||
maxBatchInterval: 0,
|
||||
}
|
||||
);
|
||||
|
||||
constructor(private readonly redis: Redis) {}
|
||||
|
||||
private async batchMgetAsync(keySets: string[][]): Promise<(string | null)[][]> {
|
||||
// ordered distinct keys to fetch
|
||||
const allKeysToFetch = [...new Set(keySets.flat())];
|
||||
|
||||
// fetch the distinct keys
|
||||
const allResults = await this.redis.mget(...allKeysToFetch);
|
||||
|
||||
// put them into a map for fast lookup
|
||||
const keysToResults = zipToMap(allKeysToFetch, allResults);
|
||||
|
||||
// re-associate them with original key sets
|
||||
return keySets.map((keySet) =>
|
||||
keySet.map((key) => {
|
||||
const result = keysToResults.get(key);
|
||||
invariant(result !== undefined, 'result should not be undefined');
|
||||
return result;
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
async mget(...args: string[]): Promise<(string | null)[]> {
|
||||
return await this.mgetBatcher.batchAsync(args);
|
||||
}
|
||||
|
||||
multi(): IRedisTransaction {
|
||||
return this.redis.multi();
|
||||
}
|
||||
|
||||
async del(...args: string[]): Promise<void> {
|
||||
await this.redis.del(...args);
|
||||
}
|
||||
}
|
||||
|
||||
describe(GenericRedisCacher, () => {
|
||||
const redis = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
||||
const redisClient = new BatchedRedis(redis);
|
||||
|
||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
||||
|
||||
beforeAll(() => {
|
||||
genericRedisCacheContext = {
|
||||
redisClient,
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||
);
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await redis.flushdb();
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
redis.disconnect();
|
||||
});
|
||||
|
||||
it('has correct caching behavior', async () => {
|
||||
// simulate two requests
|
||||
const viewerContext = new ViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
);
|
||||
|
||||
const mgetSpy = jest.spyOn(redis, 'mget');
|
||||
|
||||
const genericCacher =
|
||||
viewerContext.entityCompanionProvider.getCompanionForEntity(RedisTestEntity)[
|
||||
'tableDataCoordinator'
|
||||
]['cacheAdapter']['genericCacher'];
|
||||
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
|
||||
|
||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
.enforceCreateAsync();
|
||||
|
||||
// loading an entity should put it in cache. load by multiple requests and multiple fields in same tick to ensure batch works
|
||||
mgetSpy.mockClear();
|
||||
const viewerContext1 = new ViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
);
|
||||
const viewerContext2 = new ViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
);
|
||||
const viewerContext3 = new ViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
);
|
||||
const [entity1, entity2, entity3] = await Promise.all([
|
||||
RedisTestEntity.loader(viewerContext1).enforcing().loadByIDAsync(entity1Created.getID()),
|
||||
RedisTestEntity.loader(viewerContext2).enforcing().loadByIDAsync(entity1Created.getID()),
|
||||
RedisTestEntity.loader(viewerContext3)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', entity1Created.getField('name')),
|
||||
]);
|
||||
|
||||
expect(mgetSpy).toHaveBeenCalledTimes(1);
|
||||
expect(mgetSpy.mock.calls[0]).toHaveLength(2); // should dedupe the first two loads
|
||||
expect(entity1.getID()).toEqual(entity2.getID());
|
||||
expect(entity2.getID()).toEqual(nullthrows(entity3).getID());
|
||||
|
||||
const cacheKeyEntity1 = cacheKeyMaker('id', entity1Created.getID());
|
||||
const cachedJSON = await redis.get(cacheKeyEntity1);
|
||||
const cachedValue = JSON.parse(cachedJSON!);
|
||||
expect(cachedValue).toMatchObject({
|
||||
id: entity1.getID(),
|
||||
name: 'blah',
|
||||
});
|
||||
|
||||
const cacheKeyEntity1NameField = cacheKeyMaker('name', entity1Created.getField('name'));
|
||||
await RedisTestEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByFieldEqualingAsync('name', entity1Created.getField('name'));
|
||||
await expect(redis.get(cacheKeyEntity1NameField)).resolves.toEqual(cachedJSON);
|
||||
|
||||
// simulate non existent db fetch, should write negative result ('') to cache
|
||||
const nonExistentId = uuidv4();
|
||||
const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
expect(entityNonExistentResult.ok).toBe(false);
|
||||
const cacheKeyNonExistent = cacheKeyMaker('id', nonExistentId);
|
||||
const nonExistentCachedValue = await redis.get(cacheKeyNonExistent);
|
||||
expect(nonExistentCachedValue).toEqual('');
|
||||
// load again through entities framework to ensure it reads negative result
|
||||
const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||
nonExistentId
|
||||
);
|
||||
expect(entityNonExistentResult2.ok).toBe(false);
|
||||
|
||||
// invalidate from cache to ensure it invalidates correctly in both caches
|
||||
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
|
||||
await expect(redis.get(cacheKeyEntity1)).resolves.toBeNull();
|
||||
await expect(redis.get(cacheKeyEntity1NameField)).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
-111
@@ -1,111 +0,0 @@
|
||||
import { CacheStatus, ViewerContext } from '@expo/entity';
|
||||
import Redis from 'ioredis';
|
||||
import { URL } from 'url';
|
||||
|
||||
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
|
||||
import RedisTestEntity, {
|
||||
redisTestEntityConfiguration,
|
||||
RedisTestEntityFields,
|
||||
} from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(GenericRedisCacher, () => {
|
||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
||||
|
||||
beforeAll(() => {
|
||||
genericRedisCacheContext = {
|
||||
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-',
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await (genericRedisCacheContext.redisClient as Redis).flushdb();
|
||||
});
|
||||
afterAll(async () => {
|
||||
(genericRedisCacheContext.redisClient as Redis).disconnect();
|
||||
});
|
||||
|
||||
it('has correct caching and loading behavior', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
);
|
||||
const genericRedisCacher = new GenericRedisCacher(
|
||||
genericRedisCacheContext,
|
||||
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 (genericRedisCacheContext.redisClient as Redis).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(
|
||||
genericRedisCacheContext,
|
||||
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(genericRedisCacheContext)
|
||||
);
|
||||
const genericRedisCacher = new GenericRedisCacher(
|
||||
genericRedisCacheContext,
|
||||
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);
|
||||
});
|
||||
});
|
||||
+20
-19
@@ -4,17 +4,17 @@ import Redis from 'ioredis';
|
||||
import { URL } from 'url';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
|
||||
import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(GenericRedisCacher, () => {
|
||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
||||
describe(RedisCacheAdapter, () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
genericRedisCacheContext = {
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
@@ -24,27 +24,28 @@ describe(GenericRedisCacher, () => {
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await (genericRedisCacheContext.redisClient as Redis).flushdb();
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
afterAll(async () => {
|
||||
(genericRedisCacheContext.redisClient as Redis).disconnect();
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
it('has correct caching behavior', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const genericCacher =
|
||||
viewerContext.entityCompanionProvider.getCompanionForEntity(RedisTestEntity)[
|
||||
'tableDataCoordinator'
|
||||
]['cacheAdapter']['genericCacher'];
|
||||
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
|
||||
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||
RedisTestEntity,
|
||||
RedisTestEntity.getCompanionDefinition()
|
||||
)['tableDataCoordinator']['cacheAdapter'];
|
||||
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||
|
||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||
.setField('name', 'blah')
|
||||
@@ -55,7 +56,7 @@ describe(GenericRedisCacher, () => {
|
||||
.enforcing()
|
||||
.loadByIDAsync(entity1Created.getID());
|
||||
|
||||
const cachedJSON = await (genericRedisCacheContext.redisClient as Redis).get(
|
||||
const cachedJSON = await redisCacheAdapterContext.redisClient.get(
|
||||
cacheKeyMaker('id', entity1.getID())
|
||||
);
|
||||
const cachedValue = JSON.parse(cachedJSON!);
|
||||
@@ -72,7 +73,7 @@ describe(GenericRedisCacher, () => {
|
||||
);
|
||||
expect(entityNonExistentResult.ok).toBe(false);
|
||||
|
||||
const nonExistentCachedValue = await (genericRedisCacheContext.redisClient as Redis).get(
|
||||
const nonExistentCachedValue = await redisCacheAdapterContext.redisClient.get(
|
||||
cacheKeyMaker('id', nonExistentId)
|
||||
);
|
||||
expect(nonExistentCachedValue).toEqual('');
|
||||
@@ -85,7 +86,7 @@ describe(GenericRedisCacher, () => {
|
||||
|
||||
// invalidate from cache to ensure it invalidates correctly
|
||||
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
|
||||
const cachedValueNull = await (genericRedisCacheContext.redisClient as Redis).get(
|
||||
const cachedValueNull = await redisCacheAdapterContext.redisClient.get(
|
||||
cacheKeyMaker('id', entity1.getID())
|
||||
);
|
||||
expect(cachedValueNull).toBe(null);
|
||||
@@ -93,7 +94,7 @@ describe(GenericRedisCacher, () => {
|
||||
|
||||
it('caches and restores date fields', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const date = new Date();
|
||||
const entity1 = await enforceAsyncResult(
|
||||
@@ -108,7 +109,7 @@ describe(GenericRedisCacher, () => {
|
||||
|
||||
// simulate new request
|
||||
const vc2 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
|
||||
expect(entity3.getField('dateField')).toEqual(date);
|
||||
@@ -116,7 +117,7 @@ describe(GenericRedisCacher, () => {
|
||||
|
||||
it('caches and restores empty string field keys', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity1 = await enforceAsyncResult(
|
||||
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
|
||||
@@ -128,7 +129,7 @@ describe(GenericRedisCacher, () => {
|
||||
|
||||
// simulate new request
|
||||
const vc2 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
const entity3 = await RedisTestEntity.loader(vc2)
|
||||
.enforcing()
|
||||
@@ -2,19 +2,18 @@ import { EntityCacheAdapterTransientError, ViewerContext } from '@expo/entity';
|
||||
import Redis from 'ioredis';
|
||||
import { URL } from 'url';
|
||||
|
||||
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
|
||||
import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
describe(GenericRedisCacher, () => {
|
||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
||||
describe(RedisCacheAdapter, () => {
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
genericRedisCacheContext = {
|
||||
redisClient,
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
@@ -23,20 +22,21 @@ describe(GenericRedisCacher, () => {
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await redisClient.flushdb();
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
|
||||
it('throws when redis is disconnected', async () => {
|
||||
redisClient.disconnect();
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
|
||||
const vc1 = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
await expect(
|
||||
|
||||
@@ -1,193 +0,0 @@
|
||||
import { CacheStatus, UUIDField, EntityConfiguration } from '@expo/entity';
|
||||
import { Redis, Pipeline } from 'ioredis';
|
||||
import { mock, when, instance, anything, verify } from 'ts-mockito';
|
||||
|
||||
import GenericRedisCacher from '../GenericRedisCacher';
|
||||
|
||||
type BlahFields = {
|
||||
id: string;
|
||||
};
|
||||
|
||||
const entityConfiguration = new EntityConfiguration<BlahFields>({
|
||||
idField: 'id',
|
||||
tableName: 'blah',
|
||||
schema: {
|
||||
id: new UUIDField({ columnName: 'id', cache: true }),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
describe(GenericRedisCacher, () => {
|
||||
describe('loadManyAsync', () => {
|
||||
it('returns appropriate cache results', async () => {
|
||||
const redisResults = new Map();
|
||||
|
||||
const mockRedisClient = mock<Redis>();
|
||||
|
||||
// need to have one anything() for each element of spread, in this case 3
|
||||
when(mockRedisClient.mget(anything(), anything(), anything())).thenCall(async (...keys) =>
|
||||
keys.map((k) => redisResults.get(k) ?? null)
|
||||
);
|
||||
|
||||
const genericCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
},
|
||||
entityConfiguration
|
||||
);
|
||||
|
||||
const cacheKeyWat = genericCacher['makeCacheKey']('id', 'wat');
|
||||
const cacheKeyWho = genericCacher['makeCacheKey']('id', 'who');
|
||||
const cacheKeyWhy = genericCacher['makeCacheKey']('id', 'why');
|
||||
|
||||
redisResults.set(cacheKeyWat, JSON.stringify({ id: 'wat' }));
|
||||
redisResults.set(cacheKeyWho, '');
|
||||
|
||||
const results = await genericCacher.loadManyAsync([cacheKeyWat, cacheKeyWho, cacheKeyWhy]);
|
||||
|
||||
expect(results.get(cacheKeyWat)).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: { id: 'wat' },
|
||||
});
|
||||
expect(results.get(cacheKeyWho)).toMatchObject({ status: CacheStatus.NEGATIVE });
|
||||
expect(results.get(cacheKeyWhy)).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.size).toBe(3);
|
||||
});
|
||||
|
||||
it('returns empty map when passed empty array of fieldValues', async () => {
|
||||
const genericCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: instance(mock<Redis>()),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
},
|
||||
entityConfiguration
|
||||
);
|
||||
const results = await genericCacher.loadManyAsync([]);
|
||||
expect(results).toEqual(new Map());
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheManyAsync', () => {
|
||||
it('correctly caches all objects', async () => {
|
||||
const redisResults = new Map();
|
||||
|
||||
const mockPipeline = mock<Pipeline>();
|
||||
when(mockPipeline.set(anything(), anything(), anything(), anything())).thenCall(
|
||||
(key, value, code, ttl) => {
|
||||
redisResults.set(key, { value, code, ttl });
|
||||
return pipeline;
|
||||
}
|
||||
);
|
||||
when(mockPipeline.exec()).thenResolve({} as any);
|
||||
const pipeline = instance(mockPipeline);
|
||||
|
||||
const mockRedisClient = mock<Redis>();
|
||||
when(mockRedisClient.multi()).thenReturn(pipeline);
|
||||
|
||||
const genericCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
},
|
||||
entityConfiguration
|
||||
);
|
||||
|
||||
const cacheKey = genericCacher['makeCacheKey']('id', 'wat');
|
||||
|
||||
await genericCacher.cacheManyAsync(new Map([[cacheKey, { id: 'wat' }]]));
|
||||
|
||||
expect(redisResults.get(cacheKey)).toMatchObject({
|
||||
value: JSON.stringify({ id: 'wat' }),
|
||||
code: 'EX',
|
||||
ttl: 1,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheDBMissesAsync', () => {
|
||||
it('correctly caches misses', async () => {
|
||||
const redisResults = new Map();
|
||||
const mockPipeline = mock<Pipeline>();
|
||||
when(mockPipeline.set(anything(), anything(), anything(), anything())).thenCall(
|
||||
(key, value, code, ttl) => {
|
||||
redisResults.set(key, { value, code, ttl });
|
||||
return pipeline;
|
||||
}
|
||||
);
|
||||
when(mockPipeline.exec()).thenResolve({} as any);
|
||||
const pipeline = instance(mockPipeline);
|
||||
|
||||
const mockRedisClient = mock<Redis>();
|
||||
when(mockRedisClient.multi()).thenReturn(pipeline);
|
||||
|
||||
const genericCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
},
|
||||
entityConfiguration
|
||||
);
|
||||
|
||||
const cacheKey = genericCacher['makeCacheKey']('id', 'wat');
|
||||
|
||||
await genericCacher.cacheDBMissesAsync([cacheKey]);
|
||||
|
||||
expect(redisResults.get(cacheKey)).toMatchObject({
|
||||
value: '',
|
||||
code: 'EX',
|
||||
ttl: 2,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('invalidateManyAsync', () => {
|
||||
it('invalidates correctly', async () => {
|
||||
const mockRedisClient = mock<Redis>();
|
||||
when(mockRedisClient.del()).thenResolve(1);
|
||||
|
||||
const genericCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
},
|
||||
entityConfiguration
|
||||
);
|
||||
const cacheKey = genericCacher['makeCacheKey']('id', 'wat');
|
||||
|
||||
await genericCacher.invalidateManyAsync([cacheKey]);
|
||||
|
||||
verify(mockRedisClient.del(cacheKey)).once();
|
||||
});
|
||||
|
||||
it('returns when passed empty array of fieldValues', async () => {
|
||||
const genericCacher = new GenericRedisCacher(
|
||||
{
|
||||
redisClient: instance(mock<Redis>()),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
},
|
||||
entityConfiguration
|
||||
);
|
||||
await genericCacher.invalidateManyAsync([]);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,240 @@
|
||||
import { CacheStatus, UUIDField, EntityConfiguration, DateField } from '@expo/entity';
|
||||
import { Redis, Pipeline } from 'ioredis';
|
||||
import { mock, when, instance, anything, verify } from 'ts-mockito';
|
||||
|
||||
import RedisCacheAdapter from '../RedisCacheAdapter';
|
||||
|
||||
type BlahFields = {
|
||||
id: string;
|
||||
date: Date | null;
|
||||
};
|
||||
|
||||
const entityConfiguration = new EntityConfiguration<BlahFields>({
|
||||
idField: 'id',
|
||||
tableName: 'blah',
|
||||
schema: {
|
||||
id: new UUIDField({ columnName: 'id', cache: true }),
|
||||
date: new DateField({ columnName: 'date' }),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
describe(RedisCacheAdapter, () => {
|
||||
describe('loadManyAsync', () => {
|
||||
it('returns appropriate cache results', async () => {
|
||||
const redisResults = new Map();
|
||||
|
||||
const mockRedisClient = mock<Redis>();
|
||||
|
||||
// need to have one anything() for each element of spread, in this case 3
|
||||
when(mockRedisClient.mget(anything(), anything(), anything())).thenCall(async (...keys) =>
|
||||
keys.map((k) => redisResults.get(k) ?? null)
|
||||
);
|
||||
|
||||
const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyVersion: 1,
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
|
||||
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']);
|
||||
|
||||
expect(results.get('wat')).toMatchObject({ status: CacheStatus.HIT, item: { id: 'wat' } });
|
||||
expect(results.get('who')).toMatchObject({ status: CacheStatus.NEGATIVE });
|
||||
expect(results.get('why')).toMatchObject({ status: CacheStatus.MISS });
|
||||
expect(results.size).toBe(3);
|
||||
});
|
||||
|
||||
it('returns empty map when passed empty array of fieldValues', async () => {
|
||||
const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
|
||||
redisClient: instance(mock<Redis>()),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyVersion: 1,
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
const results = await cacheAdapter.loadManyAsync('id', []);
|
||||
expect(results).toEqual(new Map());
|
||||
});
|
||||
|
||||
it('transforms a cache object to an Entity object', async () => {
|
||||
const redisResults = new Map();
|
||||
|
||||
const mockRedisClient = mock<Redis>();
|
||||
|
||||
// need to have one anything() for each element of spread, in this case 1
|
||||
when(mockRedisClient.mget(anything())).thenCall(async (...keys) =>
|
||||
keys.map((k) => redisResults.get(k) ?? null)
|
||||
);
|
||||
|
||||
const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyVersion: 1,
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
|
||||
const date = new Date();
|
||||
redisResults.set(
|
||||
cacheAdapter['makeCacheKey']('id', 'wat'),
|
||||
JSON.stringify({ id: 'wat', date: date.toISOString() })
|
||||
);
|
||||
|
||||
const results = await cacheAdapter.loadManyAsync('id', ['wat']);
|
||||
|
||||
expect(results.get('wat')).toMatchObject({
|
||||
status: CacheStatus.HIT,
|
||||
item: { id: 'wat', date },
|
||||
});
|
||||
expect(results.size).toBe(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheManyAsync', () => {
|
||||
it('correctly caches all objects', async () => {
|
||||
const redisResults = new Map();
|
||||
|
||||
const mockPipeline = mock<Pipeline>();
|
||||
when(mockPipeline.set(anything(), anything(), anything(), anything())).thenCall(
|
||||
(key, value, code, ttl) => {
|
||||
redisResults.set(key, { value, code, ttl });
|
||||
return pipeline;
|
||||
}
|
||||
);
|
||||
when(mockPipeline.exec()).thenResolve({} as any);
|
||||
const pipeline = instance(mockPipeline);
|
||||
|
||||
const mockRedisClient = mock<Redis>();
|
||||
when(mockRedisClient.multi()).thenReturn(pipeline);
|
||||
|
||||
const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyVersion: 1,
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['wat', { id: 'wat' }]]));
|
||||
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'wat');
|
||||
expect(redisResults.get(cacheKey)).toMatchObject({
|
||||
value: JSON.stringify({ id: 'wat' }),
|
||||
code: 'EX',
|
||||
ttl: 1,
|
||||
});
|
||||
});
|
||||
|
||||
it('transforms an Entity object to a cache object', async () => {
|
||||
const redisResults = new Map();
|
||||
|
||||
const mockPipeline = mock<Pipeline>();
|
||||
when(mockPipeline.set(anything(), anything(), anything(), anything())).thenCall(
|
||||
(key, value, code, ttl) => {
|
||||
redisResults.set(key, { value, code, ttl });
|
||||
return pipeline;
|
||||
}
|
||||
);
|
||||
when(mockPipeline.exec()).thenResolve({} as any);
|
||||
const pipeline = instance(mockPipeline);
|
||||
|
||||
const mockRedisClient = mock<Redis>();
|
||||
when(mockRedisClient.multi()).thenReturn(pipeline);
|
||||
|
||||
const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyVersion: 1,
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
const date = new Date();
|
||||
await cacheAdapter.cacheManyAsync('id', new Map([['wat', { id: 'wat', date }]]));
|
||||
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'wat');
|
||||
expect(redisResults.get(cacheKey)).toMatchObject({
|
||||
value: JSON.stringify({ id: 'wat', date: date.toISOString() }),
|
||||
code: 'EX',
|
||||
ttl: 1,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('cacheDBMissesAsync', () => {
|
||||
it('correctly caches misses', async () => {
|
||||
const redisResults = new Map();
|
||||
const mockPipeline = mock<Pipeline>();
|
||||
when(mockPipeline.set(anything(), anything(), anything(), anything())).thenCall(
|
||||
(key, value, code, ttl) => {
|
||||
redisResults.set(key, { value, code, ttl });
|
||||
return pipeline;
|
||||
}
|
||||
);
|
||||
when(mockPipeline.exec()).thenResolve({} as any);
|
||||
const pipeline = instance(mockPipeline);
|
||||
|
||||
const mockRedisClient = mock<Redis>();
|
||||
when(mockRedisClient.multi()).thenReturn(pipeline);
|
||||
|
||||
const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyVersion: 1,
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
await cacheAdapter.cacheDBMissesAsync('id', ['wat']);
|
||||
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'wat');
|
||||
expect(redisResults.get(cacheKey)).toMatchObject({
|
||||
value: '',
|
||||
code: 'EX',
|
||||
ttl: 2,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('invalidateManyAsync', () => {
|
||||
it('invalidates correctly', async () => {
|
||||
const mockRedisClient = mock<Redis>();
|
||||
when(mockRedisClient.del()).thenResolve(1);
|
||||
|
||||
const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
|
||||
redisClient: instance(mockRedisClient),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyVersion: 1,
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
await cacheAdapter.invalidateManyAsync('id', ['wat']);
|
||||
|
||||
const cacheKey = cacheAdapter['makeCacheKey']('id', 'wat');
|
||||
verify(mockRedisClient.del(cacheKey)).once();
|
||||
});
|
||||
|
||||
it('returns when passed empty array of fieldValues', async () => {
|
||||
const cacheAdapter = new RedisCacheAdapter(entityConfiguration, {
|
||||
redisClient: instance(mock<Redis>()),
|
||||
makeKeyFn: (...parts) => parts.join(':'),
|
||||
cacheKeyVersion: 1,
|
||||
cacheKeyPrefix: 'hello-',
|
||||
ttlSecondsPositive: 1,
|
||||
ttlSecondsNegative: 2,
|
||||
});
|
||||
await cacheAdapter.invalidateManyAsync('id', []);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -4,6 +4,8 @@
|
||||
* @module @expo/entity-cache-adapter-redis
|
||||
*/
|
||||
|
||||
export { default as RedisCacheAdapter } from './RedisCacheAdapter';
|
||||
export * from './RedisCacheAdapter';
|
||||
export { default as RedisCacheAdapterProvider } from './RedisCacheAdapterProvider';
|
||||
export * from './RedisCommon';
|
||||
export { default as GenericRedisCacher } from './GenericRedisCacher';
|
||||
|
||||
@@ -17,18 +17,14 @@ export type RedisTestEntityFields = {
|
||||
};
|
||||
|
||||
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity,
|
||||
RedisTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: RedisTestEntity,
|
||||
entityConfiguration: redisTestEntityConfiguration,
|
||||
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
||||
};
|
||||
return redisTestEntityCompanionDefinition;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -91,3 +87,9 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: RedisTestEntity,
|
||||
entityConfiguration: redisTestEntityConfiguration,
|
||||
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
||||
});
|
||||
+4
-7
@@ -6,14 +6,11 @@ import {
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
|
||||
import { GenericRedisCacheContext } from '../GenericRedisCacher';
|
||||
import { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||
import RedisCacheAdapterProvider from '../RedisCacheAdapterProvider';
|
||||
|
||||
// share across all in calls in test to simulate postgres
|
||||
const adapterProvider = new StubDatabaseAdapterProvider();
|
||||
|
||||
export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
genericRedisCacheContext: GenericRedisCacheContext,
|
||||
redisCacheAdapterContext: RedisCacheAdapterContext,
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
@@ -22,7 +19,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider,
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
@@ -31,7 +28,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
|
||||
@@ -3,129 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add ability to specify knex transaction config ([#207](https://github.com/expo/entity/issues/207)) ([2069a0d](https://github.com/expo/entity/commit/2069a0d9fd1d8f7d090a71a90a758b2429ea5dd3))
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add BigIntField ([#193](https://github.com/expo/entity/issues/193)) ([acbad82](https://github.com/expo/entity/commit/acbad826a37bb5a054b4dcf9be91d11aa5f7f29a))
|
||||
* nested transactions ([#194](https://github.com/expo/entity/issues/194)) ([a77b914](https://github.com/expo/entity/commit/a77b914ad6dc018d1e309c9caf4971088a553ecf))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add orderByRaw to loadManyByRawWhereClauseAsync ([#185](https://github.com/expo/entity/issues/185)) ([2817d78](https://github.com/expo/entity/commit/2817d78392dfecd0093111c24d581bdf01dba06d))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**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)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-database-adapter-knex",
|
||||
"version": "0.32.0",
|
||||
"version": "0.22.0",
|
||||
"description": "Knex database adapter for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -19,7 +19,7 @@
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
@@ -30,10 +30,10 @@
|
||||
"@expo/entity": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"knex": "^2.4.2"
|
||||
"knex": "^1.0.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.32.0",
|
||||
"pg": "8.10.0"
|
||||
"@expo/entity": "^0.22.0",
|
||||
"pg": "^8.7.1"
|
||||
}
|
||||
}
|
||||
@@ -1,29 +0,0 @@
|
||||
import { EntityFieldDefinition } from '@expo/entity';
|
||||
|
||||
/**
|
||||
* EntityFieldDefinition for a Postres column with a JS JSON array type.
|
||||
*/
|
||||
export class JSONArrayField extends EntityFieldDefinition<any[]> {
|
||||
protected validateInputValueInternal(value: any[]): boolean {
|
||||
return Array.isArray(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* EntityFieldDefinition for a Postgres column that may be a JS JSON array type.
|
||||
* Does not do any validation.
|
||||
*/
|
||||
export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
|
||||
protected validateInputValueInternal(_value: any): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* EntityFieldDefinition for a Postgres BIGINT column.
|
||||
*/
|
||||
export class BigIntField extends EntityFieldDefinition<string> {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return typeof value === 'string';
|
||||
}
|
||||
}
|
||||
@@ -2,14 +2,14 @@ import {
|
||||
EntityDatabaseAdapter,
|
||||
FieldTransformerMap,
|
||||
FieldTransformer,
|
||||
JSONArrayField,
|
||||
MaybeJSONArrayField,
|
||||
TableQuerySelectionModifiers,
|
||||
TableFieldSingleValueEqualityCondition,
|
||||
TableFieldMultiValueEqualityCondition,
|
||||
TableQuerySelectionModifiersWithOrderByRaw,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
import { JSONArrayField, MaybeJSONArrayField } from './EntityFields';
|
||||
import wrapNativePostgresCallAsync from './errors/wrapNativePostgresCallAsync';
|
||||
|
||||
export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDatabaseAdapter<TFields> {
|
||||
@@ -53,20 +53,6 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
);
|
||||
}
|
||||
|
||||
private applyQueryModifiersToQueryOrderByRaw(
|
||||
query: Knex.QueryBuilder,
|
||||
querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw
|
||||
): Knex.QueryBuilder {
|
||||
let ret = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
|
||||
|
||||
const { orderByRaw } = querySelectionModifiers;
|
||||
if (orderByRaw !== undefined) {
|
||||
ret = ret.orderByRaw(orderByRaw);
|
||||
}
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
private applyQueryModifiersToQuery(
|
||||
query: Knex.QueryBuilder,
|
||||
querySelectionModifiers: TableQuerySelectionModifiers
|
||||
@@ -143,13 +129,13 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
|
||||
tableName: string,
|
||||
rawWhereClause: string,
|
||||
bindings: object | any[],
|
||||
querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw
|
||||
querySelectionModifiers: TableQuerySelectionModifiers
|
||||
): Promise<object[]> {
|
||||
let query = queryInterface
|
||||
.select()
|
||||
.from(tableName)
|
||||
.whereRaw(rawWhereClause, bindings as any);
|
||||
query = this.applyQueryModifiersToQueryOrderByRaw(query, querySelectionModifiers);
|
||||
query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
|
||||
return await wrapNativePostgresCallAsync(() => query);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,8 +1,4 @@
|
||||
import {
|
||||
EntityQueryContextProvider,
|
||||
TransactionConfig,
|
||||
TransactionIsolationLevel,
|
||||
} from '@expo/entity';
|
||||
import { EntityQueryContextProvider } from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
/**
|
||||
@@ -17,44 +13,9 @@ export default class PostgresEntityQueryContextProvider extends EntityQueryConte
|
||||
return this.knexInstance;
|
||||
}
|
||||
|
||||
protected createTransactionRunner<T>(
|
||||
transactionConfig?: TransactionConfig
|
||||
): (transactionScope: (trx: any) => Promise<T>) => Promise<T> {
|
||||
return (transactionScope) =>
|
||||
this.knexInstance.transaction(
|
||||
transactionScope,
|
||||
transactionConfig
|
||||
? PostgresEntityQueryContextProvider.convertTransactionConfig(transactionConfig)
|
||||
: undefined
|
||||
);
|
||||
}
|
||||
|
||||
protected createNestedTransactionRunner<T>(
|
||||
outerQueryInterface: any
|
||||
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
|
||||
return (transactionScope) => (outerQueryInterface as Knex).transaction(transactionScope);
|
||||
}
|
||||
|
||||
private static convertTransactionConfig(
|
||||
transactionConfig: TransactionConfig
|
||||
): Knex.TransactionConfig {
|
||||
const convertIsolationLevel = (
|
||||
isolationLevel: TransactionIsolationLevel
|
||||
): Knex.IsolationLevels => {
|
||||
switch (isolationLevel) {
|
||||
case TransactionIsolationLevel.READ_COMMITTED:
|
||||
return 'read committed';
|
||||
case TransactionIsolationLevel.REPEATABLE_READ:
|
||||
return 'repeatable read';
|
||||
case TransactionIsolationLevel.SERIALIZABLE:
|
||||
return 'serializable';
|
||||
}
|
||||
};
|
||||
|
||||
return {
|
||||
...(transactionConfig.isolationLevel
|
||||
? { isolationLevel: convertIsolationLevel(transactionConfig.isolationLevel) }
|
||||
: {}),
|
||||
};
|
||||
protected createTransactionRunner<T>(): (
|
||||
transactionScope: (trx: any) => Promise<T>
|
||||
) => Promise<T> {
|
||||
return (transactionScope) => this.knexInstance.transaction(transactionScope);
|
||||
}
|
||||
}
|
||||
+1
-94
@@ -3,7 +3,6 @@ import {
|
||||
createUnitTestEntityCompanionProvider,
|
||||
enforceResultsAsync,
|
||||
ViewerContext,
|
||||
TransactionIsolationLevel,
|
||||
} from '@expo/entity';
|
||||
import { enforceAsyncResult } from '@expo/results';
|
||||
import { knex, Knex } from 'knex';
|
||||
@@ -112,44 +111,6 @@ describe('postgres entity integration', () => {
|
||||
expect(entities).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('passes transaction config into transactions', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
const firstEntity = await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1).setField('name', 'hello').createAsync()
|
||||
);
|
||||
|
||||
const loadAndUpdateAsync = async (newName: string): Promise<{ error?: Error }> => {
|
||||
try {
|
||||
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync(
|
||||
'postgres',
|
||||
async (queryContext) => {
|
||||
const entity = await PostgresTestEntity.loader(vc1, queryContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(firstEntity.getID());
|
||||
await PostgresTestEntity.updater(entity, queryContext)
|
||||
.setField('name', newName)
|
||||
.enforceUpdateAsync();
|
||||
},
|
||||
{ isolationLevel: TransactionIsolationLevel.SERIALIZABLE }
|
||||
);
|
||||
return {};
|
||||
} catch (e) {
|
||||
return { error: e as Error };
|
||||
}
|
||||
};
|
||||
|
||||
// do some parallel updates to trigger serializable error in at least some of them
|
||||
const results = await Promise.all([
|
||||
loadAndUpdateAsync('hello2'),
|
||||
loadAndUpdateAsync('hello3'),
|
||||
loadAndUpdateAsync('hello4'),
|
||||
loadAndUpdateAsync('hello5'),
|
||||
]);
|
||||
|
||||
expect(results.filter((r) => (r.error as any)?.cause?.code === '40001').length > 0).toBe(true);
|
||||
});
|
||||
|
||||
describe('JSON fields', () => {
|
||||
it('supports both types of array fields', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
@@ -196,27 +157,6 @@ describe('postgres entity integration', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('BIGINT fields', () => {
|
||||
it('supports BIGINT fields', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
let entity = await enforceAsyncResult(
|
||||
PostgresTestEntity.creator(vc1).setField('bigintField', '72057594037928038').createAsync()
|
||||
);
|
||||
expect(entity.getField('bigintField')).toEqual('72057594037928038');
|
||||
|
||||
entity = await enforceAsyncResult(
|
||||
PostgresTestEntity.updater(entity).setField('bigintField', '10').updateAsync()
|
||||
);
|
||||
expect(entity.getField('bigintField')).toEqual('10');
|
||||
|
||||
entity = await enforceAsyncResult(
|
||||
PostgresTestEntity.updater(entity).setField('bigintField', '-10').updateAsync()
|
||||
);
|
||||
expect(entity.getField('bigintField')).toEqual('-10');
|
||||
});
|
||||
});
|
||||
|
||||
describe('conjunction field equality loading', () => {
|
||||
it('supports single fieldValue and multiple fieldValues', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
@@ -439,15 +379,6 @@ describe('postgres entity integration', () => {
|
||||
|
||||
expect(resultsMultipleOrderBy).toHaveLength(3);
|
||||
expect(resultsMultipleOrderBy.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
|
||||
|
||||
const resultsOrderByRaw = await PostgresTestEntity.loader(vc1)
|
||||
.enforcing()
|
||||
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
|
||||
orderByRaw: 'has_a_dog ASC, name DESC',
|
||||
});
|
||||
|
||||
expect(resultsOrderByRaw).toHaveLength(3);
|
||||
expect(resultsOrderByRaw.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -675,7 +606,6 @@ describe('postgres entity integration', () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
let preCommitCallCount = 0;
|
||||
let preCommitInnerCallCount = 0;
|
||||
let postCommitCallCount = 0;
|
||||
|
||||
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
@@ -685,28 +615,6 @@ describe('postgres entity integration', () => {
|
||||
queryContext.appendPreCommitCallback(async () => {
|
||||
preCommitCallCount++;
|
||||
}, 0);
|
||||
|
||||
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
|
||||
innerQueryContext.appendPostCommitCallback(async () => {
|
||||
postCommitCallCount++;
|
||||
});
|
||||
innerQueryContext.appendPreCommitCallback(async () => {
|
||||
preCommitInnerCallCount++;
|
||||
}, 0);
|
||||
});
|
||||
|
||||
// this one throws so its post commit shouldn't execute
|
||||
try {
|
||||
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
|
||||
innerQueryContext.appendPostCommitCallback(async () => {
|
||||
postCommitCallCount++;
|
||||
});
|
||||
innerQueryContext.appendPreCommitCallback(async () => {
|
||||
preCommitInnerCallCount++;
|
||||
throw Error('wat');
|
||||
}, 0);
|
||||
});
|
||||
} catch {}
|
||||
});
|
||||
|
||||
await expect(
|
||||
@@ -722,8 +630,7 @@ describe('postgres entity integration', () => {
|
||||
).rejects.toThrowError('wat');
|
||||
|
||||
expect(preCommitCallCount).toBe(2);
|
||||
expect(preCommitInnerCallCount).toBe(2);
|
||||
expect(postCommitCallCount).toBe(2);
|
||||
expect(postCommitCallCount).toBe(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
-101
@@ -1,101 +0,0 @@
|
||||
import { ViewerContext } from '@expo/entity';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import PostgresEntityQueryContextProvider from '../PostgresEntityQueryContextProvider';
|
||||
import PostgresUniqueTestEntity from '../testfixtures/PostgresUniqueTestEntity';
|
||||
import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
|
||||
|
||||
describe(PostgresEntityQueryContextProvider, () => {
|
||||
let knexInstance: Knex;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
client: 'pg',
|
||||
connection: {
|
||||
user: nullthrows(process.env['PGUSER']),
|
||||
password: nullthrows(process.env['PGPASSWORD']),
|
||||
host: 'localhost',
|
||||
port: parseInt(nullthrows(process.env['PGPORT']), 10),
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
await PostgresUniqueTestEntity.createOrTruncatePostgresTable(knexInstance);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await PostgresUniqueTestEntity.dropPostgresTable(knexInstance);
|
||||
await knexInstance.destroy();
|
||||
});
|
||||
|
||||
it('supports nested transactions', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
await PostgresUniqueTestEntity.creator(vc1).setField('name', 'unique').enforceCreateAsync();
|
||||
|
||||
const id = (
|
||||
await PostgresUniqueTestEntity.creator(vc1).setField('name', 'wat').enforceCreateAsync()
|
||||
).getID();
|
||||
|
||||
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
const entity = await PostgresUniqueTestEntity.loader(vc1, queryContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(id);
|
||||
await PostgresUniqueTestEntity.updater(entity, queryContext)
|
||||
.setField('name', 'wat2')
|
||||
.enforceUpdateAsync();
|
||||
|
||||
// ensure the outer transaction is not aborted due to postgres error in inner transaction,
|
||||
// in this case the error triggered is a unique constraint violation
|
||||
try {
|
||||
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
|
||||
const entity = await PostgresUniqueTestEntity.loader(vc1, innerQueryContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(id);
|
||||
await PostgresUniqueTestEntity.updater(entity, innerQueryContext)
|
||||
.setField('name', 'unique')
|
||||
.enforceUpdateAsync();
|
||||
});
|
||||
} catch {}
|
||||
|
||||
const entity2 = await PostgresUniqueTestEntity.loader(vc1, queryContext)
|
||||
.enforcing()
|
||||
.loadByIDAsync(id);
|
||||
await PostgresUniqueTestEntity.updater(entity2, queryContext)
|
||||
.setField('name', 'wat3')
|
||||
.enforceUpdateAsync();
|
||||
});
|
||||
|
||||
const entityLoaded = await PostgresUniqueTestEntity.loader(vc1).enforcing().loadByIDAsync(id);
|
||||
expect(entityLoaded.getField('name')).toEqual('wat3');
|
||||
});
|
||||
|
||||
it('supports multi-nested transactions', async () => {
|
||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||
|
||||
const id = (
|
||||
await PostgresUniqueTestEntity.creator(vc1).setField('name', 'wat').enforceCreateAsync()
|
||||
).getID();
|
||||
|
||||
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
|
||||
await innerQueryContext.runInNestedTransactionAsync(async (innerQueryContex2) => {
|
||||
await innerQueryContex2.runInNestedTransactionAsync(async (innerQueryContex3) => {
|
||||
const entity = await PostgresUniqueTestEntity.loader(vc1, innerQueryContex3)
|
||||
.enforcing()
|
||||
.loadByIDAsync(id);
|
||||
await PostgresUniqueTestEntity.updater(entity, innerQueryContex3)
|
||||
.setField('name', 'wat3')
|
||||
.enforceUpdateAsync();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
const entityLoaded = await PostgresUniqueTestEntity.loader(vc1).enforcing().loadByIDAsync(id);
|
||||
expect(entityLoaded.getField('name')).toEqual('wat3');
|
||||
});
|
||||
});
|
||||
@@ -1,19 +0,0 @@
|
||||
import { describeFieldTestCase } from '@expo/entity';
|
||||
|
||||
import { BigIntField, JSONArrayField, MaybeJSONArrayField } from '../EntityFields';
|
||||
|
||||
describeFieldTestCase(
|
||||
new JSONArrayField({ columnName: 'wat' }),
|
||||
[[[1, 2]] as any, [['hello']] as any],
|
||||
[1, 'hello']
|
||||
);
|
||||
describeFieldTestCase(
|
||||
new MaybeJSONArrayField({ columnName: 'wat' }),
|
||||
[1, 'hello', [['hello']]],
|
||||
[]
|
||||
);
|
||||
describeFieldTestCase(
|
||||
new BigIntField({ columnName: 'wat' }),
|
||||
['123457682149816498126412896', '123', '-1', '-124147812641876482716841'],
|
||||
[1, false, -1, 1e6, {}]
|
||||
);
|
||||
@@ -7,4 +7,3 @@
|
||||
export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter';
|
||||
export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider';
|
||||
export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider';
|
||||
export * from './EntityFields';
|
||||
@@ -27,24 +27,21 @@ export default class ErrorsTestEntity extends Entity<
|
||||
number,
|
||||
ViewerContext
|
||||
> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
ErrorsTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
ErrorsTestEntity,
|
||||
ErrorsTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: ErrorsTestEntity,
|
||||
entityConfiguration: ErrorsTestEntityConfiguration,
|
||||
privacyPolicyClass: 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 = 'postgres_test_entities';
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
|
||||
const hasForeignTable = await knex.schema.hasTable(foreignTableName);
|
||||
if (!hasForeignTable) {
|
||||
await knex.schema.createTable(foreignTableName, (table) => {
|
||||
@@ -90,7 +87,7 @@ export default class ErrorsTestEntity extends Entity<
|
||||
}
|
||||
|
||||
public static async dropPostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (hasTable) {
|
||||
await knex.schema.dropTable(tableName);
|
||||
@@ -172,3 +169,9 @@ export const ErrorsTestEntityConfiguration = new EntityConfiguration<ErrorsTestE
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const errorsTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: ErrorsTestEntity,
|
||||
entityConfiguration: ErrorsTestEntityConfiguration,
|
||||
privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
|
||||
});
|
||||
@@ -20,22 +20,18 @@ export default class InvalidTestEntity extends Entity<
|
||||
number,
|
||||
ViewerContext
|
||||
> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
InvalidTestEntityFields,
|
||||
number,
|
||||
ViewerContext,
|
||||
InvalidTestEntity,
|
||||
InvalidTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: InvalidTestEntity,
|
||||
entityConfiguration: invalidTestEntityConfiguration,
|
||||
privacyPolicyClass: InvalidTestEntityPrivacyPolicy,
|
||||
};
|
||||
return invalidTestEntityCompanionDefinition;
|
||||
}
|
||||
|
||||
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (!hasTable) {
|
||||
await knex.schema.createTable(tableName, (table) => {
|
||||
@@ -47,7 +43,7 @@ export default class InvalidTestEntity extends Entity<
|
||||
}
|
||||
|
||||
public static async dropPostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (hasTable) {
|
||||
await knex.schema.dropTable(tableName);
|
||||
@@ -109,3 +105,9 @@ export const invalidTestEntityConfiguration = new EntityConfiguration<InvalidTes
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const invalidTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: InvalidTestEntity,
|
||||
entityConfiguration: invalidTestEntityConfiguration,
|
||||
privacyPolicyClass: InvalidTestEntityPrivacyPolicy,
|
||||
});
|
||||
@@ -6,16 +6,16 @@ import {
|
||||
StringField,
|
||||
BooleanField,
|
||||
StringArrayField,
|
||||
JSONArrayField,
|
||||
JSONObjectField,
|
||||
DateField,
|
||||
MaybeJSONArrayField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
import { BigIntField, JSONArrayField, MaybeJSONArrayField } from '../EntityFields';
|
||||
|
||||
type PostgresTestEntityFields = {
|
||||
id: string;
|
||||
name: string | null;
|
||||
@@ -28,7 +28,6 @@ type PostgresTestEntityFields = {
|
||||
} | null;
|
||||
dateField: Date | null;
|
||||
maybeJsonArrayField: string[] | { hello: string } | null;
|
||||
bigintField: string | null;
|
||||
};
|
||||
|
||||
export default class PostgresTestEntity extends Entity<
|
||||
@@ -36,26 +35,24 @@ export default class PostgresTestEntity extends Entity<
|
||||
string,
|
||||
ViewerContext
|
||||
> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
PostgresTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresTestEntity,
|
||||
PostgresTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: PostgresTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresTestEntityPrivacyPolicy,
|
||||
};
|
||||
return postgresTestEntityCompanionDefinition;
|
||||
}
|
||||
|
||||
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
|
||||
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (!hasTable) {
|
||||
await knex.schema.createTable(tableName, (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
table.string('name');
|
||||
table.boolean('has_a_dog');
|
||||
table.boolean('has_a_cat');
|
||||
@@ -64,14 +61,13 @@ export default class PostgresTestEntity extends Entity<
|
||||
table.jsonb('json_object_field');
|
||||
table.dateTime('date_field', { useTz: true });
|
||||
table.jsonb('maybe_json_array_field');
|
||||
table.bigint('bigint_field');
|
||||
});
|
||||
}
|
||||
await knex.into(tableName).truncate();
|
||||
}
|
||||
|
||||
public static async dropPostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (hasTable) {
|
||||
await knex.schema.dropTable(tableName);
|
||||
@@ -151,10 +147,13 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
|
||||
maybeJsonArrayField: new MaybeJSONArrayField({
|
||||
columnName: 'maybe_json_array_field',
|
||||
}),
|
||||
bigintField: new BigIntField({
|
||||
columnName: 'bigint_field',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: PostgresTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresTestEntityPrivacyPolicy,
|
||||
});
|
||||
+24
-20
@@ -24,37 +24,24 @@ export default class PostgresTriggerTestEntity extends Entity<
|
||||
string,
|
||||
ViewerContext
|
||||
> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
PostgresTriggerTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresTriggerTestEntity,
|
||||
PostgresTriggerTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: PostgresTriggerTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresTriggerTestEntityPrivacyPolicy,
|
||||
mutationTriggers: {
|
||||
beforeCreate: [new ThrowConditionallyTrigger('name', 'beforeCreate')],
|
||||
afterCreate: [new ThrowConditionallyTrigger('name', 'afterCreate')],
|
||||
beforeUpdate: [new ThrowConditionallyTrigger('name', 'beforeUpdate')],
|
||||
afterUpdate: [new ThrowConditionallyTrigger('name', 'afterUpdate')],
|
||||
beforeDelete: [new ThrowConditionallyTrigger('name', 'beforeDelete')],
|
||||
afterDelete: [new ThrowConditionallyTrigger('name', 'afterDelete')],
|
||||
beforeAll: [new ThrowConditionallyTrigger('name', 'beforeAll')],
|
||||
afterAll: [new ThrowConditionallyTrigger('name', 'afterAll')],
|
||||
afterCommit: [new ThrowConditionallyNonTransactionalTrigger('name', 'afterCommit')],
|
||||
},
|
||||
};
|
||||
return postgresTestEntityCompanionDefinition;
|
||||
}
|
||||
|
||||
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
|
||||
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (!hasTable) {
|
||||
await knex.schema.createTable(tableName, (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
table.string('name');
|
||||
});
|
||||
}
|
||||
@@ -62,7 +49,7 @@ export default class PostgresTriggerTestEntity extends Entity<
|
||||
}
|
||||
|
||||
public static async dropPostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (hasTable) {
|
||||
await knex.schema.dropTable(tableName);
|
||||
@@ -173,3 +160,20 @@ export const postgresTestEntityConfiguration =
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: PostgresTriggerTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresTriggerTestEntityPrivacyPolicy,
|
||||
mutationTriggers: () => ({
|
||||
beforeCreate: [new ThrowConditionallyTrigger('name', 'beforeCreate')],
|
||||
afterCreate: [new ThrowConditionallyTrigger('name', 'afterCreate')],
|
||||
beforeUpdate: [new ThrowConditionallyTrigger('name', 'beforeUpdate')],
|
||||
afterUpdate: [new ThrowConditionallyTrigger('name', 'afterUpdate')],
|
||||
beforeDelete: [new ThrowConditionallyTrigger('name', 'beforeDelete')],
|
||||
afterDelete: [new ThrowConditionallyTrigger('name', 'afterDelete')],
|
||||
beforeAll: [new ThrowConditionallyTrigger('name', 'beforeAll')],
|
||||
afterAll: [new ThrowConditionallyTrigger('name', 'afterAll')],
|
||||
afterCommit: [new ThrowConditionallyNonTransactionalTrigger('name', 'afterCommit')],
|
||||
}),
|
||||
});
|
||||
@@ -1,113 +0,0 @@
|
||||
import {
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
ViewerContext,
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
import { Knex } from 'knex';
|
||||
|
||||
type PostgresUniqueTestEntityFields = {
|
||||
id: string;
|
||||
name: string | null;
|
||||
};
|
||||
|
||||
export default class PostgresUniqueTestEntity extends Entity<
|
||||
PostgresUniqueTestEntityFields,
|
||||
string,
|
||||
ViewerContext
|
||||
> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
PostgresUniqueTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresUniqueTestEntity,
|
||||
PostgresUniqueTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: PostgresUniqueTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresUniqueTestEntityPrivacyPolicy,
|
||||
};
|
||||
}
|
||||
|
||||
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (!hasTable) {
|
||||
await knex.schema.createTable(tableName, (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
table.string('name').unique();
|
||||
});
|
||||
}
|
||||
await knex.into(tableName).truncate();
|
||||
}
|
||||
|
||||
public static async dropPostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (hasTable) {
|
||||
await knex.schema.dropTable(tableName);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class PostgresUniqueTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
PostgresUniqueTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresUniqueTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresUniqueTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresUniqueTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresUniqueTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresUniqueTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresUniqueTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresUniqueTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
PostgresUniqueTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresUniqueTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const postgresTestEntityConfiguration =
|
||||
new EntityConfiguration<PostgresUniqueTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'postgres_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
+14
-10
@@ -23,27 +23,24 @@ export default class PostgresValidatorTestEntity extends Entity<
|
||||
string,
|
||||
ViewerContext
|
||||
> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
PostgresValidatorTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
PostgresValidatorTestEntity,
|
||||
PostgresValidatorTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: PostgresValidatorTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
|
||||
mutationValidators: [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
|
||||
};
|
||||
return postgresTestEntityCompanionDefinition;
|
||||
}
|
||||
|
||||
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
|
||||
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (!hasTable) {
|
||||
await knex.schema.createTable(tableName, (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
table.string('name');
|
||||
});
|
||||
}
|
||||
@@ -51,7 +48,7 @@ export default class PostgresValidatorTestEntity extends Entity<
|
||||
}
|
||||
|
||||
public static async dropPostgresTable(knex: Knex): Promise<void> {
|
||||
const tableName = 'postgres_test_entities';
|
||||
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
|
||||
const hasTable = await knex.schema.hasTable(tableName);
|
||||
if (hasTable) {
|
||||
await knex.schema.dropTable(tableName);
|
||||
@@ -145,3 +142,10 @@ export const postgresTestEntityConfiguration =
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: PostgresValidatorTestEntity,
|
||||
entityConfiguration: postgresTestEntityConfiguration,
|
||||
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
|
||||
mutationValidators: () => [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
|
||||
});
|
||||
@@ -3,128 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add ability to specify knex transaction config ([#207](https://github.com/expo/entity/issues/207)) ([2069a0d](https://github.com/expo/entity/commit/2069a0d9fd1d8f7d090a71a90a758b2429ea5dd3))
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* nested transactions ([#194](https://github.com/expo/entity/issues/194)) ([a77b914](https://github.com/expo/entity/commit/a77b914ad6dc018d1e309c9caf4971088a553ecf))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* privacy policy evaluation context ([#162](https://github.com/expo/entity/issues/162)) ([3a81a4c](https://github.com/expo/entity/commit/3a81a4c059e2e995eb800e35e76b3d432c22b23f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**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
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@expo/entity-example",
|
||||
"private": true,
|
||||
"version": "0.32.0",
|
||||
"version": "0.22.0",
|
||||
"description": "An example integration of the @expo/entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
@@ -15,7 +15,7 @@
|
||||
"start": "tsnd --transpile-only --inspect --respawn --no-notify --async-stack-traces --throw-deprecation -- src/index.ts"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
@@ -23,20 +23,16 @@
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@apollo/server": "^4.7.3",
|
||||
"@as-integrations/koa": "^1.1.1",
|
||||
"@expo/entity": "^0.32.0",
|
||||
"@koa/cors": "^4.0.0",
|
||||
"@koa/router": "^12.0.0",
|
||||
"graphql": "^16.6.0",
|
||||
"koa": "^2.14.2",
|
||||
"koa-bodyparser": "^4.4.0"
|
||||
"@expo/entity": "^0.22.0",
|
||||
"apollo-server-koa": "^2.16.1",
|
||||
"graphql": "^15.3.0",
|
||||
"koa": "^2.13.0",
|
||||
"koa-body": "^4.2.0",
|
||||
"koa-router": "^9.4.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/koa": "^2.13.6",
|
||||
"@types/koa-bodyparser": "^4.3.10",
|
||||
"@types/koa__cors": "^4.0.0",
|
||||
"@types/koa__router": "^12.0.0",
|
||||
"@types/koa": "^2.11.4",
|
||||
"@types/koa-router": "^7.4.1",
|
||||
"@types/supertest": "^2.0.10",
|
||||
"supertest": "^4.0.2",
|
||||
"ts-node-dev": "^1.0.0-pre.60"
|
||||
|
||||
@@ -2,11 +2,10 @@ import http from 'http';
|
||||
import request from 'supertest';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import createAppAsync from '../app';
|
||||
import app from '../app';
|
||||
|
||||
describe('graphql', () => {
|
||||
it('allows CRUD of user notes', async () => {
|
||||
const app = await createAppAsync();
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
@@ -118,7 +117,6 @@ describe('graphql', () => {
|
||||
});
|
||||
|
||||
it('disallows anonymous note creation', async () => {
|
||||
const app = await createAppAsync();
|
||||
const server = request(http.createServer(app.callback()));
|
||||
const createResponse1 = await server.post('/graphql').send({
|
||||
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
||||
@@ -135,7 +133,6 @@ describe('graphql', () => {
|
||||
});
|
||||
|
||||
it('disallows cross-user note impersonation', async () => {
|
||||
const app = await createAppAsync();
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
|
||||
@@ -2,17 +2,15 @@ import http from 'http';
|
||||
import request from 'supertest';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
|
||||
import createAppAsync from '../app';
|
||||
import app from '../app';
|
||||
|
||||
describe('notesRouter', () => {
|
||||
it('returns empty array for logged-out', async () => {
|
||||
const app = await createAppAsync();
|
||||
const response = await request(http.createServer(app.callback())).get('/notes/').send();
|
||||
expect(response.body.notes).toEqual([]);
|
||||
});
|
||||
|
||||
it('allows CRUD of user notes', async () => {
|
||||
const app = await createAppAsync();
|
||||
const server = request(http.createServer(app.callback()));
|
||||
|
||||
const userId = uuidv4();
|
||||
@@ -86,7 +84,6 @@ describe('notesRouter', () => {
|
||||
});
|
||||
|
||||
it('disallows anonymous note creation', async () => {
|
||||
const app = await createAppAsync();
|
||||
const server = request(http.createServer(app.callback()));
|
||||
const createResponse1 = await server.post('/notes/').send({
|
||||
title: 'track',
|
||||
@@ -97,7 +94,6 @@ describe('notesRouter', () => {
|
||||
});
|
||||
|
||||
it('disallows cross-user note impersonation', async () => {
|
||||
const app = await createAppAsync();
|
||||
const server = request(http.createServer(app.callback()));
|
||||
const userId = uuidv4();
|
||||
const userId2 = uuidv4();
|
||||
|
||||
@@ -1,19 +1,13 @@
|
||||
import { EntityQueryContextProvider, TransactionConfig } from '@expo/entity';
|
||||
import { EntityQueryContextProvider } from '@expo/entity';
|
||||
|
||||
export default class InMemoryQueryContextProvider extends EntityQueryContextProvider {
|
||||
protected getQueryInterface(): any {
|
||||
return {};
|
||||
}
|
||||
|
||||
protected createTransactionRunner<T>(
|
||||
_transactionConfig?: TransactionConfig
|
||||
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
|
||||
return (transactionScope) => Promise.resolve(transactionScope({}));
|
||||
}
|
||||
|
||||
protected createNestedTransactionRunner<T>(
|
||||
_outerQueryInterface: any
|
||||
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
|
||||
protected createTransactionRunner<T>(): (
|
||||
transactionScope: (queryInterface: any) => Promise<T>
|
||||
) => Promise<T> {
|
||||
return (transactionScope) => Promise.resolve(transactionScope({}));
|
||||
}
|
||||
}
|
||||
@@ -1,17 +1,15 @@
|
||||
import { ApolloServer } from '@apollo/server';
|
||||
import { koaMiddleware } from '@as-integrations/koa';
|
||||
import { EntityCompanionProvider } from '@expo/entity';
|
||||
import cors from '@koa/cors';
|
||||
import Router from '@koa/router';
|
||||
import { ApolloServer } from 'apollo-server-koa';
|
||||
import Koa from 'koa';
|
||||
import bodyParser from 'koa-bodyparser';
|
||||
import koaBody from 'koa-body';
|
||||
import KoaRouter, { RouterContext } from 'koa-router';
|
||||
|
||||
import { entityCompanionMiddleware, viewerContextMiddleware } from './middleware';
|
||||
import notesRouter from './routers/notesRouter';
|
||||
import { typeDefs, resolvers } from './schema';
|
||||
import { ExampleViewerContext } from './viewerContexts';
|
||||
|
||||
export type ExampleContext = Koa.ParameterizedContext<ExampleState>;
|
||||
export type ExampleContext = RouterContext<ExampleState>;
|
||||
|
||||
/**
|
||||
* Koa provides a per-request state container to place custom properties.
|
||||
@@ -23,40 +21,31 @@ export type ExampleState = {
|
||||
entityCompanionProvider: EntityCompanionProvider; // entityCompanionMiddleware
|
||||
};
|
||||
|
||||
export default async function createAppAsync(): Promise<Koa<ExampleState, ExampleContext>> {
|
||||
const app = new Koa<ExampleState, ExampleContext>();
|
||||
const app = new Koa();
|
||||
|
||||
// initialze the entity framework for each request
|
||||
app.use(entityCompanionMiddleware);
|
||||
// body parsing for POST/PUT requests
|
||||
app.use(koaBody());
|
||||
|
||||
// generate a viewer context for each request
|
||||
app.use(viewerContextMiddleware);
|
||||
// initialze the entity framework for each request
|
||||
app.use(entityCompanionMiddleware);
|
||||
|
||||
app.use(cors());
|
||||
// generate a viewer context for each request
|
||||
app.use(viewerContextMiddleware);
|
||||
|
||||
// body parsing for POST/PUT requests
|
||||
app.use(bodyParser());
|
||||
// serve routes that make use of the viewer context
|
||||
const router = new KoaRouter<ExampleState>();
|
||||
router.use(notesRouter.routes());
|
||||
app.use(router.routes()).use(router.allowedMethods());
|
||||
|
||||
// serve routes that make use of the viewer context
|
||||
const router = new Router<ExampleState, ExampleContext>();
|
||||
const server = new ApolloServer({
|
||||
typeDefs,
|
||||
resolvers,
|
||||
context: ({ ctx }) => {
|
||||
return {
|
||||
viewerContext: ctx.state.viewerContext,
|
||||
};
|
||||
},
|
||||
});
|
||||
app.use(server.getMiddleware({ cors: false, disableHealthCheck: true, bodyParserConfig: false }));
|
||||
|
||||
// normal API routes
|
||||
router.use(notesRouter.routes());
|
||||
|
||||
// GraphQL routes
|
||||
const server = new ApolloServer({
|
||||
typeDefs,
|
||||
resolvers,
|
||||
});
|
||||
await server.start();
|
||||
router.post(
|
||||
'/graphql',
|
||||
koaMiddleware(server, {
|
||||
context: async ({ ctx }) => ({ viewerContext: (ctx as ExampleContext).state.viewerContext }),
|
||||
})
|
||||
);
|
||||
|
||||
app.use(router.routes()).use(router.allowedMethods());
|
||||
|
||||
return app;
|
||||
}
|
||||
export default app;
|
||||
@@ -3,7 +3,6 @@ import {
|
||||
ReadonlyEntity,
|
||||
EntityQueryContext,
|
||||
RuleEvaluationResult,
|
||||
EntityPrivacyPolicyEvaluationContext,
|
||||
} from '@expo/entity';
|
||||
|
||||
import { ExampleViewerContext } from '../viewerContexts';
|
||||
@@ -23,7 +22,7 @@ import { ExampleViewerContext } from '../viewerContexts';
|
||||
* Otherwise, it defers to the next rule in the policy.
|
||||
*/
|
||||
export default class AllowIfUserOwnerPrivacyRule<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
@@ -35,7 +34,6 @@ export default class AllowIfUserOwnerPrivacyRule<
|
||||
async evaluateAsync(
|
||||
viewerContext: ExampleViewerContext,
|
||||
_queryContext: EntityQueryContext,
|
||||
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
entity: TEntity
|
||||
): Promise<RuleEvaluationResult> {
|
||||
if (viewerContext.isUserViewerContext()) {
|
||||
|
||||
@@ -6,8 +6,8 @@ import {
|
||||
StringField,
|
||||
} from '@expo/entity';
|
||||
|
||||
import NotePrivacyPolicy from './NotePrivacyPolicy';
|
||||
import { ExampleViewerContext } from '../viewerContexts';
|
||||
import NotePrivacyPolicy from './NotePrivacyPolicy';
|
||||
|
||||
export interface NoteFields {
|
||||
id: string;
|
||||
@@ -20,41 +20,43 @@ export interface NoteFields {
|
||||
* A simple entity representing a "notes" table/collection. Each note has an owner, title, and body.
|
||||
*/
|
||||
export default class NoteEntity extends Entity<NoteFields, string, ExampleViewerContext> {
|
||||
/**
|
||||
* The companion provides configuration instructions to the Entity framework for this type
|
||||
* of entity. In some languages, this would be representable as "abstract" static members
|
||||
* of the class itself, but TypeScript disallows static generic and abstract methods.
|
||||
*/
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
NoteFields,
|
||||
string,
|
||||
ExampleViewerContext,
|
||||
NoteEntity,
|
||||
NotePrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: NoteEntity,
|
||||
entityConfiguration: new EntityConfiguration<NoteFields>({
|
||||
idField: 'id',
|
||||
tableName: 'notes',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
userID: new UUIDField({
|
||||
columnName: 'user_id',
|
||||
}),
|
||||
title: new StringField({
|
||||
columnName: 'title',
|
||||
}),
|
||||
body: new StringField({
|
||||
columnName: 'body',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
}),
|
||||
privacyPolicyClass: NotePrivacyPolicy,
|
||||
};
|
||||
return noteEntityCompanion;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The companion provides configuration instructions to the Entity framework for this type
|
||||
* of entity. In some languages, this would be representable as "abstract" static members
|
||||
* of the class itself, but TypeScript disallows static generic and abstract methods.
|
||||
*/
|
||||
export const noteEntityCompanion = new EntityCompanionDefinition({
|
||||
entityClass: NoteEntity,
|
||||
entityConfiguration: new EntityConfiguration<NoteFields>({
|
||||
idField: 'id',
|
||||
tableName: 'notes',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
userID: new UUIDField({
|
||||
columnName: 'user_id',
|
||||
}),
|
||||
title: new StringField({
|
||||
columnName: 'title',
|
||||
}),
|
||||
body: new StringField({
|
||||
columnName: 'body',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
}),
|
||||
privacyPolicyClass: NotePrivacyPolicy,
|
||||
});
|
||||
@@ -1,8 +1,8 @@
|
||||
import { EntityPrivacyPolicy, AlwaysAllowPrivacyPolicyRule } from '@expo/entity';
|
||||
|
||||
import { ExampleViewerContext } from '../viewerContexts';
|
||||
import AllowIfUserOwnerPrivacyRule from './AllowIfUserOwnerPrivacyRule';
|
||||
import NoteEntity, { NoteFields } from './NoteEntity';
|
||||
import { ExampleViewerContext } from '../viewerContexts';
|
||||
|
||||
/**
|
||||
* For purposes of this demonstration, notes are considered public and can only be mutated by the owner.
|
||||
|
||||
@@ -1,8 +1,3 @@
|
||||
import createAppAsync from './app';
|
||||
import app from './app';
|
||||
|
||||
async function main(): Promise<void> {
|
||||
const app = await createAppAsync();
|
||||
app.listen(3000);
|
||||
}
|
||||
|
||||
main();
|
||||
app.listen(3000);
|
||||
@@ -1,4 +1,4 @@
|
||||
import Router from '@koa/router';
|
||||
import KoaRouter from 'koa-router';
|
||||
|
||||
import { ExampleState, ExampleContext } from '../app';
|
||||
import NoteEntity from '../entities/NoteEntity';
|
||||
@@ -11,11 +11,11 @@ import NoteEntity from '../entities/NoteEntity';
|
||||
* PUT /notes/:id - update a note
|
||||
* DELETE /notes/:id - delete a note
|
||||
*/
|
||||
const router = new Router<ExampleState, ExampleContext>({
|
||||
const router = new KoaRouter<ExampleState>({
|
||||
prefix: '/notes',
|
||||
});
|
||||
|
||||
router.get('/', async (ctx) => {
|
||||
router.get('/', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
let notes: readonly NoteEntity[] = [];
|
||||
if (viewerContext.isUserViewerContext()) {
|
||||
@@ -28,12 +28,11 @@ router.get('/', async (ctx) => {
|
||||
};
|
||||
});
|
||||
|
||||
router.get('/:id', async (ctx) => {
|
||||
router.get('/:id', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
const noteResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
|
||||
const noteResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||
if (!noteResult.ok) {
|
||||
ctx.throw(403, noteResult.reason);
|
||||
return;
|
||||
}
|
||||
|
||||
ctx.body = {
|
||||
@@ -41,17 +40,16 @@ router.get('/:id', async (ctx) => {
|
||||
};
|
||||
});
|
||||
|
||||
router.post('/', async (ctx) => {
|
||||
router.post('/', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
if (!viewerContext.isUserViewerContext()) {
|
||||
// Only logged-in users can create notes. Technically this
|
||||
// would be handled by the privacy policy (it would fail)
|
||||
// but we throw here for better type safety.
|
||||
ctx.throw(403);
|
||||
return;
|
||||
}
|
||||
|
||||
const { title, body } = ctx.request.body as any;
|
||||
const { title, body } = ctx.request.body;
|
||||
|
||||
const createResult = await NoteEntity.creator(viewerContext)
|
||||
.setField('userID', viewerContext.userID)
|
||||
@@ -60,7 +58,6 @@ router.post('/', async (ctx) => {
|
||||
.createAsync();
|
||||
if (!createResult.ok) {
|
||||
ctx.throw(403, createResult.reason);
|
||||
return;
|
||||
}
|
||||
|
||||
ctx.body = {
|
||||
@@ -68,14 +65,13 @@ router.post('/', async (ctx) => {
|
||||
};
|
||||
});
|
||||
|
||||
router.put('/:id', async (ctx) => {
|
||||
router.put('/:id', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
const { title, body } = ctx.request.body as any;
|
||||
const { title, body } = ctx.request.body;
|
||||
|
||||
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
|
||||
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||
if (!noteLoadResult.ok) {
|
||||
ctx.throw(403, noteLoadResult.reason);
|
||||
return;
|
||||
}
|
||||
|
||||
const noteUpdateResult = await NoteEntity.updater(noteLoadResult.value)
|
||||
@@ -84,7 +80,6 @@ router.put('/:id', async (ctx) => {
|
||||
.updateAsync();
|
||||
if (!noteUpdateResult.ok) {
|
||||
ctx.throw(403, noteUpdateResult.reason);
|
||||
return;
|
||||
}
|
||||
|
||||
ctx.body = {
|
||||
@@ -92,19 +87,17 @@ router.put('/:id', async (ctx) => {
|
||||
};
|
||||
});
|
||||
|
||||
router.delete('/:id', async (ctx) => {
|
||||
router.delete('/:id', async (ctx: ExampleContext) => {
|
||||
const viewerContext = ctx.state.viewerContext;
|
||||
|
||||
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
|
||||
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||
if (!noteLoadResult.ok) {
|
||||
ctx.throw(403, noteLoadResult.reason);
|
||||
return;
|
||||
}
|
||||
|
||||
const noteDeleteResult = await NoteEntity.deleteAsync(noteLoadResult.value);
|
||||
if (!noteDeleteResult.ok) {
|
||||
ctx.throw(403, noteDeleteResult.reason);
|
||||
return;
|
||||
}
|
||||
|
||||
ctx.body = {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { IResolvers, IObjectTypeResolver } from '@graphql-tools/utils';
|
||||
import { gql, IResolvers, IResolverObject } from 'apollo-server-koa';
|
||||
|
||||
import NoteEntity from './entities/NoteEntity';
|
||||
import { ExampleViewerContext } from './viewerContexts';
|
||||
@@ -7,7 +7,7 @@ type GraphqlContext = {
|
||||
viewerContext: ExampleViewerContext;
|
||||
};
|
||||
|
||||
export const typeDefs = `#graphql
|
||||
export const typeDefs = gql`
|
||||
type User {
|
||||
id: ID!
|
||||
notes: [Note]!
|
||||
@@ -48,7 +48,7 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
||||
async noteByID(_root, args, { viewerContext }) {
|
||||
return await NoteEntity.loader(viewerContext).enforcing().loadByIDAsync(args.id);
|
||||
},
|
||||
} as IObjectTypeResolver<any, GraphqlContext>,
|
||||
} as IResolverObject<any, GraphqlContext>,
|
||||
|
||||
User: {
|
||||
id: (root) => root,
|
||||
@@ -57,14 +57,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualingAsync('userID', root);
|
||||
},
|
||||
} as IObjectTypeResolver<string, GraphqlContext>,
|
||||
} as IResolverObject<string, GraphqlContext>,
|
||||
|
||||
Note: {
|
||||
id: (root) => root.getID(),
|
||||
title: (root) => root.getField('title'),
|
||||
body: (root) => root.getField('body'),
|
||||
user: (root) => root.getField('userID'),
|
||||
} as IObjectTypeResolver<NoteEntity, GraphqlContext>,
|
||||
} as IResolverObject<NoteEntity, GraphqlContext>,
|
||||
|
||||
Mutation: {
|
||||
async addNote(_root, args, { viewerContext }) {
|
||||
@@ -94,5 +94,5 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
||||
await NoteEntity.enforceDeleteAsync(existingNote);
|
||||
return existingNote;
|
||||
},
|
||||
} as IObjectTypeResolver<any, GraphqlContext>,
|
||||
} as IResolverObject<any, GraphqlContext>,
|
||||
};
|
||||
@@ -3,132 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove unused field from redis configuration ([#213](https://github.com/expo/entity/issues/213)) ([503a2fb](https://github.com/expo/entity/commit/503a2fb6a8d57f6a09f6da99daf5ab92fc3e7945))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* change redis cache adapter to use redis-like interface ([#200](https://github.com/expo/entity/issues/200)) ([e381f5b](https://github.com/expo/entity/commit/e381f5b2acfc17dcade2cf6e8506fa1c1c255e73))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**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
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@expo/entity-full-integration-tests",
|
||||
"private": true,
|
||||
"version": "0.32.0",
|
||||
"version": "0.22.0",
|
||||
"description": "Full redis and knex integration tests for the entity framework",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
@@ -14,7 +14,7 @@
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
@@ -27,8 +27,8 @@
|
||||
"@expo/entity-database-adapter-knex": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.32.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.32.0",
|
||||
"@expo/entity-database-adapter-knex": "^0.32.0"
|
||||
"@expo/entity": "^0.22.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.22.0",
|
||||
"@expo/entity-database-adapter-knex": "^0.22.0"
|
||||
}
|
||||
}
|
||||
+26
-19
@@ -8,7 +8,7 @@ import {
|
||||
UUIDField,
|
||||
StringField,
|
||||
} from '@expo/entity';
|
||||
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
@@ -43,18 +43,14 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
}
|
||||
|
||||
class TestEntity extends Entity<TestFields, string, ViewerContext> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
TestFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
TestEntity,
|
||||
TestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: TestEntity,
|
||||
entityConfiguration: testEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
};
|
||||
return testEntityCompanion;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -78,9 +74,17 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const testEntityCompanion = new EntityCompanionDefinition({
|
||||
entityClass: TestEntity,
|
||||
entityConfiguration: testEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
});
|
||||
|
||||
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
|
||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
|
||||
|
||||
await knex.schema.createTable('testentities', (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
table.string('other_string').notNullable();
|
||||
table.string('third_string').notNullable();
|
||||
});
|
||||
@@ -88,15 +92,17 @@ async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
|
||||
}
|
||||
|
||||
async function dropPostgresTable(knex: Knex): Promise<void> {
|
||||
if (await knex.schema.hasTable('testentities')) {
|
||||
await knex.schema.dropTable('testentities');
|
||||
if (await knex.schema.hasTable('children')) {
|
||||
await knex.schema.dropTable('children');
|
||||
}
|
||||
if (await knex.schema.hasTable('parents')) {
|
||||
await knex.schema.dropTable('parents');
|
||||
}
|
||||
}
|
||||
|
||||
describe('Entity cache inconsistency', () => {
|
||||
let knexInstance: Knex;
|
||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
@@ -109,8 +115,8 @@ describe('Entity cache inconsistency', () => {
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
},
|
||||
});
|
||||
genericRedisCacheContext = {
|
||||
redisClient,
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
@@ -119,6 +125,7 @@ describe('Entity cache inconsistency', () => {
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
@@ -126,18 +133,18 @@ describe('Entity cache inconsistency', () => {
|
||||
|
||||
beforeEach(async () => {
|
||||
await createOrTruncatePostgresTables(knexInstance);
|
||||
await redisClient.flushdb();
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await dropPostgresTable(knexInstance);
|
||||
await knexInstance.destroy();
|
||||
redisClient.disconnect();
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
test('lots of updates in long-ish running transactions', async () => {
|
||||
const viewerContext = new ViewerContext(
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const entity1 = await TestEntity.creator(viewerContext)
|
||||
@@ -170,7 +177,7 @@ describe('Entity cache inconsistency', () => {
|
||||
await barrier1;
|
||||
|
||||
const viewerContextInternal = new ViewerContext(
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
await TestEntity.loader(viewerContextInternal).enforcing().loadByIDAsync(entity1.getID());
|
||||
|
||||
@@ -193,7 +200,7 @@ describe('Entity cache inconsistency', () => {
|
||||
|
||||
// ensure cache consistency
|
||||
const viewerContextLast = new ViewerContext(
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const loadedById = await TestEntity.loader(viewerContextLast)
|
||||
|
||||
+13
-11
@@ -1,22 +1,24 @@
|
||||
import { ViewerContext } from '@expo/entity';
|
||||
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
import { URL } from 'url';
|
||||
|
||||
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
||||
import ChildEntity from './entities/ChildEntity';
|
||||
import ParentEntity from './entities/ParentEntity';
|
||||
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
||||
|
||||
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
|
||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
|
||||
|
||||
await knex.schema.createTable('parents', (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
});
|
||||
await knex.into('parents').truncate();
|
||||
|
||||
await knex.schema.createTable('children', (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
table.uuid('parent_id').references('id').inTable('parents').onDelete('cascade').unique();
|
||||
});
|
||||
await knex.into('children').truncate();
|
||||
@@ -33,8 +35,7 @@ async function dropPostgresTable(knex: Knex): Promise<void> {
|
||||
|
||||
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
let knexInstance: Knex;
|
||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
@@ -47,8 +48,8 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
},
|
||||
});
|
||||
genericRedisCacheContext = {
|
||||
redisClient,
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
@@ -57,6 +58,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
@@ -64,19 +66,19 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
|
||||
beforeEach(async () => {
|
||||
await createOrTruncatePostgresTables(knexInstance);
|
||||
await redisClient.flushdb();
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await dropPostgresTable(knexInstance);
|
||||
await knexInstance.destroy();
|
||||
redisClient.disconnect();
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
describe('EntityEdgeDeletionBehavior.INVALIDATE_CACHE', () => {
|
||||
it('invalidates the cache', async () => {
|
||||
const viewerContext = new ViewerContext(
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
|
||||
|
||||
+34
-51
@@ -8,7 +8,7 @@ import {
|
||||
UUIDField,
|
||||
EntityEdgeDeletionBehavior,
|
||||
} from '@expo/entity';
|
||||
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import { knex, Knex } from 'knex';
|
||||
import nullthrows from 'nullthrows';
|
||||
@@ -48,41 +48,33 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
const othersTableName = uuidv4();
|
||||
|
||||
class CategoryEntity extends Entity<CategoryFields, string, ViewerContext> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
CategoryFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
CategoryEntity,
|
||||
PrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: CategoryEntity,
|
||||
entityConfiguration: categoryEntityConfiguration,
|
||||
privacyPolicyClass: PrivacyPolicy,
|
||||
};
|
||||
return categoryEntityCompanion;
|
||||
}
|
||||
}
|
||||
|
||||
class OtherEntity extends Entity<OtherFields, string, ViewerContext> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
OtherFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
OtherEntity,
|
||||
PrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: OtherEntity,
|
||||
entityConfiguration: otherEntityConfiguration,
|
||||
privacyPolicyClass: PrivacyPolicy,
|
||||
};
|
||||
return otherEntityCompanion;
|
||||
}
|
||||
}
|
||||
|
||||
const categoryEntityConfiguration = new EntityConfiguration<CategoryFields>({
|
||||
idField: 'id',
|
||||
tableName: categoriesTableName,
|
||||
inboundEdges: [OtherEntity],
|
||||
getInboundEdges: () => [OtherEntity],
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
@@ -92,7 +84,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
columnName: 'parent_other_id',
|
||||
cache: true,
|
||||
association: {
|
||||
associatedEntityClass: OtherEntity,
|
||||
getAssociatedEntityClass: () => OtherEntity,
|
||||
edgeDeletionBehavior,
|
||||
},
|
||||
}),
|
||||
@@ -101,10 +93,16 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const categoryEntityCompanion = new EntityCompanionDefinition({
|
||||
entityClass: CategoryEntity,
|
||||
entityConfiguration: categoryEntityConfiguration,
|
||||
privacyPolicyClass: PrivacyPolicy,
|
||||
});
|
||||
|
||||
const otherEntityConfiguration = new EntityConfiguration<OtherFields>({
|
||||
idField: 'id',
|
||||
tableName: othersTableName,
|
||||
inboundEdges: [CategoryEntity],
|
||||
getInboundEdges: () => [CategoryEntity],
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
@@ -114,7 +112,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
columnName: 'parent_category_id',
|
||||
cache: true,
|
||||
association: {
|
||||
associatedEntityClass: CategoryEntity,
|
||||
getAssociatedEntityClass: () => CategoryEntity,
|
||||
edgeDeletionBehavior,
|
||||
},
|
||||
}),
|
||||
@@ -123,46 +121,40 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const otherEntityCompanion = new EntityCompanionDefinition({
|
||||
entityClass: OtherEntity,
|
||||
entityConfiguration: otherEntityConfiguration,
|
||||
privacyPolicyClass: PrivacyPolicy,
|
||||
});
|
||||
|
||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
|
||||
|
||||
await knex.schema.createTable(categoriesTableName, (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
});
|
||||
|
||||
await knex.schema.createTable(othersTableName, (table) => {
|
||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY) {
|
||||
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
|
||||
table
|
||||
.uuid('parent_category_id')
|
||||
.references('id')
|
||||
.inTable(categoriesTableName)
|
||||
.unique()
|
||||
.onDelete('cascade');
|
||||
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
|
||||
table
|
||||
.uuid('parent_category_id')
|
||||
.references('id')
|
||||
.inTable(categoriesTableName)
|
||||
.unique()
|
||||
.onDelete('set null');
|
||||
} else {
|
||||
table.uuid('parent_category_id').unique();
|
||||
}
|
||||
});
|
||||
|
||||
await knex.schema.alterTable(categoriesTableName, (table) => {
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY) {
|
||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
|
||||
table
|
||||
.uuid('parent_other_id')
|
||||
.references('id')
|
||||
.inTable(othersTableName)
|
||||
.unique()
|
||||
.onDelete('cascade');
|
||||
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
|
||||
table
|
||||
.uuid('parent_other_id')
|
||||
.references('id')
|
||||
.inTable(othersTableName)
|
||||
.unique()
|
||||
.onDelete('set null');
|
||||
} else {
|
||||
table.uuid('parent_other_id').unique();
|
||||
}
|
||||
@@ -172,8 +164,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
||||
};
|
||||
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
let knexInstance: Knex;
|
||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
knexInstance = knex({
|
||||
@@ -186,8 +177,8 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
database: nullthrows(process.env['PGDATABASE']),
|
||||
},
|
||||
});
|
||||
genericRedisCacheContext = {
|
||||
redisClient,
|
||||
redisCacheAdapterContext = {
|
||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||
makeKeyFn(...parts: string[]): string {
|
||||
const delimiter = ':';
|
||||
const escapedParts = parts.map((part) =>
|
||||
@@ -196,6 +187,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
return escapedParts.join(delimiter);
|
||||
},
|
||||
cacheKeyPrefix: 'test-',
|
||||
cacheKeyVersion: 1,
|
||||
ttlSecondsPositive: 86400, // 1 day
|
||||
ttlSecondsNegative: 600, // 10 minutes
|
||||
};
|
||||
@@ -203,14 +195,13 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
|
||||
afterAll(async () => {
|
||||
await knexInstance.destroy();
|
||||
redisClient.disconnect();
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
it.each([
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE,
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
|
||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
|
||||
EntityEdgeDeletionBehavior.SET_NULL,
|
||||
EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY,
|
||||
])('behavior: %p', async (edgeDeletionBehavior) => {
|
||||
const { CategoryEntity, OtherEntity } = await makeEntityClasses(
|
||||
knexInstance,
|
||||
@@ -218,7 +209,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
);
|
||||
|
||||
const viewerContext = new ViewerContext(
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
|
||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const category1 = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
|
||||
@@ -239,14 +230,6 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||
.enforcing()
|
||||
.loadByIDNullableAsync(other1.getID());
|
||||
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
|
||||
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||
).resolves.toBeNull();
|
||||
const otherLoaded = await OtherEntity.loader(viewerContext)
|
||||
.enforcing()
|
||||
.loadByIDNullableAsync(other1.getID());
|
||||
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
|
||||
} else {
|
||||
await expect(
|
||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||
|
||||
+29
-25
@@ -32,36 +32,40 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerCon
|
||||
}
|
||||
|
||||
export default class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
ChildFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
ChildEntity,
|
||||
TestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: ChildEntity,
|
||||
entityConfiguration: new EntityConfiguration<ChildFields>({
|
||||
idField: 'id',
|
||||
tableName: 'children',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
parent_id: new UUIDField({
|
||||
columnName: 'parent_id',
|
||||
cache: true,
|
||||
association: {
|
||||
associatedEntityClass: ParentEntity,
|
||||
edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
}),
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
};
|
||||
return childEntityCompanion;
|
||||
}
|
||||
}
|
||||
|
||||
const childEntityConfiguration = new EntityConfiguration<ChildFields>({
|
||||
idField: 'id',
|
||||
tableName: 'children',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
parent_id: new UUIDField({
|
||||
columnName: 'parent_id',
|
||||
cache: true,
|
||||
association: {
|
||||
getAssociatedEntityClass: () => ParentEntity,
|
||||
edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
|
||||
},
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const childEntityCompanion = new EntityCompanionDefinition({
|
||||
entityClass: ChildEntity,
|
||||
entityConfiguration: childEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
});
|
||||
+22
-18
@@ -30,29 +30,33 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerCon
|
||||
}
|
||||
|
||||
export default class ParentEntity extends Entity<ParentFields, string, ViewerContext> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
ParentFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
ParentEntity,
|
||||
TestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: ParentEntity,
|
||||
entityConfiguration: new EntityConfiguration<ParentFields>({
|
||||
idField: 'id',
|
||||
tableName: 'parents',
|
||||
inboundEdges: [ChildEntity],
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
}),
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
};
|
||||
return parentEntityCompanion;
|
||||
}
|
||||
}
|
||||
|
||||
const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
|
||||
idField: 'id',
|
||||
tableName: 'parents',
|
||||
getInboundEdges: () => [ChildEntity],
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
cache: true,
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const parentEntityCompanion = new EntityCompanionDefinition({
|
||||
entityClass: ParentEntity,
|
||||
entityConfiguration: parentEntityConfiguration,
|
||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
||||
});
|
||||
+3
-3
@@ -4,7 +4,7 @@ import {
|
||||
EntityCompanionProvider,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
GenericRedisCacheContext,
|
||||
RedisCacheAdapterContext,
|
||||
RedisCacheAdapterProvider,
|
||||
} from '@expo/entity-cache-adapter-redis';
|
||||
import {
|
||||
@@ -15,7 +15,7 @@ import { Knex } from 'knex';
|
||||
|
||||
export const createFullIntegrationTestEntityCompanionProvider = (
|
||||
knex: Knex,
|
||||
genericRedisCacheContext: GenericRedisCacheContext,
|
||||
redisCacheAdapterContext: RedisCacheAdapterContext,
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
@@ -33,7 +33,7 @@ export const createFullIntegrationTestEntityCompanionProvider = (
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
|
||||
@@ -3,118 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**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
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-ip-address-field",
|
||||
"version": "0.32.0",
|
||||
"version": "0.22.0",
|
||||
"description": "IP address EntityField definitions for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -17,7 +17,7 @@
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
@@ -28,7 +28,7 @@
|
||||
"ip-address": "^8.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.32.0",
|
||||
"@expo/entity": "^0.22.0",
|
||||
"@types/jsbn": "^1.2.29"
|
||||
},
|
||||
"peerDependencies": {
|
||||
|
||||
@@ -1,102 +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.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
@@ -1,24 +0,0 @@
|
||||
# `@expo/entity-secondary-cache-local-memory`
|
||||
|
||||
Cross-request [LRU](https://github.com/isaacs/node-lru-cache) secondary cache for `@expo/entity`. Use
|
||||
this cache with caution - it is nonstandard. The cache is shared between requests in the node process.
|
||||
|
||||
[Documentation](https://expo.github.io/entity/modules/_expo_secondary_cache_local_memory.html)
|
||||
|
||||
## Usage
|
||||
|
||||
1. Create a concrete implementation of abstract class `EntitySecondaryCacheLoader`, in this example `TestEntitySecondaryCacheLoader`. The underlying data can come from anywhere, but an entity is constructed from the data and then authorized for the viewer.
|
||||
2. Create an instance of your `EntitySecondaryCacheLoader`, passing in a `LocalMemorySecondaryEntityCache`.
|
||||
```typescript
|
||||
const secondaryCacheLoader = new TestSecondaryLocalMemoryCacheLoader(
|
||||
new LocalMemorySecondaryEntityCache(
|
||||
GenericLocalMemoryCacher.createLRUCache<LocalMemoryTestEntityFields>({})
|
||||
),
|
||||
LocalMemoryTestEntity.loader(viewerContext)
|
||||
);
|
||||
```
|
||||
3. Load entities through it:
|
||||
```typescript
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
```
|
||||
@@ -1,38 +0,0 @@
|
||||
{
|
||||
"name": "@expo/entity-secondary-cache-local-memory",
|
||||
"version": "0.32.0",
|
||||
"description": "Local memory secondary cache for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
"src"
|
||||
],
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"tsc": "tsc",
|
||||
"clean": "rm -rf build coverage coverage-integration",
|
||||
"lint": "eslint src",
|
||||
"lint-fix": "eslint src --fix",
|
||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
],
|
||||
"author": "Expo",
|
||||
"license": "MIT",
|
||||
"peerDependencies": {
|
||||
"@expo/entity": "*",
|
||||
"@expo/entity-cache-adapter-local-memory": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.32.0",
|
||||
"@expo/entity-cache-adapter-local-memory": "^0.32.0",
|
||||
"nullthrows": "^1.1.1"
|
||||
}
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
import { EntityConfiguration, GenericSecondaryEntityCache } from '@expo/entity';
|
||||
import {
|
||||
GenericLocalMemoryCacher,
|
||||
LocalMemoryCache,
|
||||
} from '@expo/entity-cache-adapter-local-memory';
|
||||
|
||||
/**
|
||||
* A local memory GenericSecondaryEntityCache.
|
||||
*
|
||||
* @remarks
|
||||
*
|
||||
* TLoadParams must be JSON stringifyable.
|
||||
*/
|
||||
export default class LocalMemorySecondaryEntityCache<
|
||||
TFields,
|
||||
TLoadParams
|
||||
> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
localMemoryCache: LocalMemoryCache<TFields>
|
||||
) {
|
||||
super(new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache), (params) =>
|
||||
JSON.stringify(params)
|
||||
);
|
||||
}
|
||||
}
|
||||
-228
@@ -1,228 +0,0 @@
|
||||
import {
|
||||
EntitySecondaryCacheLoader,
|
||||
mapMapAsync,
|
||||
ViewerContext,
|
||||
NoOpEntityMetricsAdapter,
|
||||
IEntityMetricsAdapter,
|
||||
EntityCompanionProvider,
|
||||
StubQueryContextProvider,
|
||||
StubDatabaseAdapterProvider,
|
||||
AlwaysAllowPrivacyPolicyRule,
|
||||
EntityPrivacyPolicy,
|
||||
UUIDField,
|
||||
StringField,
|
||||
EntityConfiguration,
|
||||
EntityCompanionDefinition,
|
||||
Entity,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
GenericLocalMemoryCacher,
|
||||
LocalMemoryCacheAdapterProvider,
|
||||
} from '@expo/entity-cache-adapter-local-memory';
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import LocalMemorySecondaryEntityCache from '../LocalMemorySecondaryEntityCache';
|
||||
|
||||
export type LocalMemoryTestEntityFields = {
|
||||
id: string;
|
||||
name: string;
|
||||
};
|
||||
|
||||
export default class LocalMemoryTestEntity extends Entity<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext
|
||||
> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: LocalMemoryTestEntity,
|
||||
entityConfiguration: localMemoryTestEntityConfiguration,
|
||||
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
export class LocalMemoryTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
> {
|
||||
protected override readonly createRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly readRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly updateRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
protected override readonly deleteRules = [
|
||||
new AlwaysAllowPrivacyPolicyRule<
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
LocalMemoryTestEntity
|
||||
>(),
|
||||
];
|
||||
}
|
||||
|
||||
export const localMemoryTestEntityConfiguration =
|
||||
new EntityConfiguration<LocalMemoryTestEntityFields>({
|
||||
idField: 'id',
|
||||
tableName: 'local_memory_test_entities',
|
||||
schema: {
|
||||
id: new UUIDField({
|
||||
columnName: 'id',
|
||||
}),
|
||||
name: new StringField({
|
||||
columnName: 'name',
|
||||
}),
|
||||
},
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'local-memory',
|
||||
});
|
||||
|
||||
export const createTestEntityCompanionProvider = (
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
metricsAdapter,
|
||||
new Map([
|
||||
[
|
||||
'postgres',
|
||||
{
|
||||
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||
queryContextProvider: StubQueryContextProvider,
|
||||
},
|
||||
],
|
||||
]),
|
||||
new Map([
|
||||
[
|
||||
'local-memory',
|
||||
{
|
||||
cacheAdapterProvider: LocalMemoryCacheAdapterProvider.getProvider(),
|
||||
},
|
||||
],
|
||||
])
|
||||
);
|
||||
};
|
||||
|
||||
class TestViewerContext extends ViewerContext {}
|
||||
|
||||
type TestLoadParams = { id: string };
|
||||
|
||||
const FAKE_ID = 'fake';
|
||||
|
||||
class TestSecondaryLocalMemoryCacheLoader extends EntitySecondaryCacheLoader<
|
||||
TestLoadParams,
|
||||
LocalMemoryTestEntityFields,
|
||||
string,
|
||||
TestViewerContext,
|
||||
LocalMemoryTestEntity,
|
||||
LocalMemoryTestEntityPrivacyPolicy
|
||||
> {
|
||||
public databaseLoadCount = 0;
|
||||
|
||||
protected async fetchObjectsFromDatabaseAsync(
|
||||
loadParamsArray: readonly Readonly<TestLoadParams>[]
|
||||
): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<LocalMemoryTestEntityFields> | null>> {
|
||||
this.databaseLoadCount += loadParamsArray.length;
|
||||
|
||||
const emptyMap = new Map(loadParamsArray.map((p) => [p, null]));
|
||||
return await mapMapAsync(emptyMap, async (_value, loadParams) => {
|
||||
if (loadParams.id === FAKE_ID) {
|
||||
return null;
|
||||
}
|
||||
return nullthrows(
|
||||
(
|
||||
await this.entityLoader
|
||||
.enforcing()
|
||||
.loadManyByFieldEqualityConjunctionAsync([
|
||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||
])
|
||||
)[0]
|
||||
).getAllFields();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
describe(LocalMemorySecondaryEntityCache, () => {
|
||||
it('Loads through secondary loader, caches, and invalidates', async () => {
|
||||
const viewerContext = new TestViewerContext(createTestEntityCompanionProvider());
|
||||
|
||||
const createdEntity = await LocalMemoryTestEntity.creator(viewerContext)
|
||||
.setField('name', 'wat')
|
||||
.enforceCreateAsync();
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryLocalMemoryCacheLoader(
|
||||
new LocalMemorySecondaryEntityCache(
|
||||
localMemoryTestEntityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache<LocalMemoryTestEntityFields>({})
|
||||
),
|
||||
LocalMemoryTestEntity.loader(viewerContext)
|
||||
);
|
||||
|
||||
const loadParams = { id: createdEntity.getID() };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
||||
|
||||
const results2 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results2.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
||||
|
||||
await secondaryCacheLoader.invalidateManyAsync([loadParams]);
|
||||
|
||||
const results3 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(nullthrows(results3.get(loadParams)).enforceValue().getID()).toEqual(
|
||||
createdEntity.getID()
|
||||
);
|
||||
|
||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(2);
|
||||
});
|
||||
|
||||
it('correctly handles uncached and unfetchable load params', async () => {
|
||||
const viewerContext = new TestViewerContext(createTestEntityCompanionProvider());
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryLocalMemoryCacheLoader(
|
||||
new LocalMemorySecondaryEntityCache(
|
||||
localMemoryTestEntityConfiguration,
|
||||
GenericLocalMemoryCacher.createLRUCache<LocalMemoryTestEntityFields>({})
|
||||
),
|
||||
LocalMemoryTestEntity.loader(viewerContext)
|
||||
);
|
||||
|
||||
const loadParams = { id: FAKE_ID };
|
||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||
expect(results.size).toBe(1);
|
||||
expect(results.get(loadParams)).toBe(null);
|
||||
});
|
||||
});
|
||||
@@ -1,7 +0,0 @@
|
||||
/* eslint-disable tsdoc/syntax */
|
||||
/**
|
||||
* @packageDocumentation
|
||||
* @module @expo/entity-secondary-cache-local-memory
|
||||
*/
|
||||
|
||||
export { default as LocalMemorySecondaryEntityCache } from './LocalMemorySecondaryEntityCache';
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "build",
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -3,137 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove unused field from redis configuration ([#213](https://github.com/expo/entity/issues/213)) ([503a2fb](https://github.com/expo/entity/commit/503a2fb6a8d57f6a09f6da99daf5ab92fc3e7945))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* change redis cache adapter to use redis-like interface ([#200](https://github.com/expo/entity/issues/200)) ([e381f5b](https://github.com/expo/entity/commit/e381f5b2acfc17dcade2cf6e8506fa1c1c255e73))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update ioredis to v5, make it a devDependency of the cache packages ([#172](https://github.com/expo/entity/issues/172)) ([9fcfbf7](https://github.com/expo/entity/commit/9fcfbf746a61554cefedf7fb0f1a3a9056b58ffe))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
### 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
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
genericRedisCacheContext,
|
||||
redisCacheAdapterContext,
|
||||
(loadParams) => `${loadParams.id}`
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity-secondary-cache-redis",
|
||||
"version": "0.32.0",
|
||||
"version": "0.22.0",
|
||||
"description": "Redis secondary cache for @expo/entity",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -19,7 +19,7 @@
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
@@ -30,10 +30,12 @@
|
||||
"@expo/entity": "*",
|
||||
"@expo/entity-cache-adapter-redis": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"ioredis": "^4.17.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@expo/entity": "^0.32.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.32.0",
|
||||
"ioredis": "^5.2.5",
|
||||
"@expo/entity": "^0.22.0",
|
||||
"@expo/entity-cache-adapter-redis": "^0.22.0",
|
||||
"nullthrows": "^1.1.1"
|
||||
}
|
||||
}
|
||||
@@ -1,18 +1,136 @@
|
||||
import { EntityConfiguration, GenericSecondaryEntityCache } from '@expo/entity';
|
||||
import { GenericRedisCacheContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
|
||||
import {
|
||||
CacheStatus,
|
||||
EntityConfiguration,
|
||||
filterMap,
|
||||
ISecondaryEntityCache,
|
||||
transformCacheObjectToFields,
|
||||
transformFieldsToCacheObject,
|
||||
zipToMap,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
GenericRedisCacheContext,
|
||||
GenericRedisCacher,
|
||||
redisTransformerMap,
|
||||
} from '@expo/entity-cache-adapter-redis';
|
||||
import invariant from 'invariant';
|
||||
|
||||
/**
|
||||
* A redis GenericSecondaryEntityCache.
|
||||
* A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
|
||||
* single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
|
||||
* a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
|
||||
*/
|
||||
export default class RedisSecondaryEntityCache<
|
||||
TFields,
|
||||
TLoadParams
|
||||
> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
|
||||
export default class RedisSecondaryEntityCache<TFields, TLoadParams>
|
||||
implements ISecondaryEntityCache<TFields, TLoadParams>
|
||||
{
|
||||
private readonly genericRedisCacher: GenericRedisCacher;
|
||||
|
||||
constructor(
|
||||
entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
genericRedisCacheContext: GenericRedisCacheContext,
|
||||
constructRedisKey: (params: Readonly<TLoadParams>) => string
|
||||
private readonly constructRedisKey: (params: Readonly<TLoadParams>) => string
|
||||
) {
|
||||
super(new GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
|
||||
this.genericRedisCacher = new GenericRedisCacher(genericRedisCacheContext);
|
||||
}
|
||||
|
||||
/**
|
||||
* Read-through cache function. Steps:
|
||||
*
|
||||
* 1. Check for cached objects
|
||||
* 2. Query the fetcher for loadParams not in the cache
|
||||
* 3. Cache the results from the fetcher
|
||||
* 4. Negatively cache anything missing from the fetcher
|
||||
* 5. Return the full set of data for the query.
|
||||
*
|
||||
* @param loadParamsArray - array of loadParams to load from the cache
|
||||
* @param fetcher - closure used to provide underlying data source objects for loadParams
|
||||
* @returns map from loadParams to the entity field object
|
||||
*/
|
||||
public async loadManyThroughAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[],
|
||||
fetcher: (
|
||||
fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
|
||||
): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>> {
|
||||
const redisKeys = loadParamsArray.map(this.constructRedisKey);
|
||||
const redisKeyToLoadParamsMap = zipToMap(redisKeys, loadParamsArray);
|
||||
|
||||
const cacheLoadResults = await this.genericRedisCacher.loadManyAsync(redisKeys);
|
||||
|
||||
invariant(
|
||||
cacheLoadResults.size === loadParamsArray.length,
|
||||
`${this.constructor.name} loadMany should return a result for each key`
|
||||
);
|
||||
|
||||
const redisKeysToFetch = Array.from(
|
||||
filterMap(
|
||||
cacheLoadResults,
|
||||
(cacheLoadResult) => cacheLoadResult.status === CacheStatus.MISS
|
||||
).keys()
|
||||
);
|
||||
|
||||
// put transformed cache hits in result map
|
||||
const results: Map<Readonly<TLoadParams>, Readonly<TFields> | null> = new Map();
|
||||
cacheLoadResults.forEach((cacheLoadResult, redisKey) => {
|
||||
if (cacheLoadResult.status === CacheStatus.HIT) {
|
||||
const loadParams = redisKeyToLoadParamsMap.get(redisKey);
|
||||
invariant(loadParams !== undefined, 'load params should be in redis key map');
|
||||
results.set(
|
||||
loadParams,
|
||||
transformCacheObjectToFields(
|
||||
this.entityConfiguration,
|
||||
redisTransformerMap,
|
||||
cacheLoadResult.item
|
||||
)
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
// fetch any misses from DB, add DB objects to results, cache DB results, inform cache of any missing DB results
|
||||
if (redisKeysToFetch.length > 0) {
|
||||
const loadParamsToFetch = redisKeysToFetch.map((redisKey) => {
|
||||
const loadParams = redisKeyToLoadParamsMap.get(redisKey);
|
||||
invariant(loadParams !== undefined, 'load params should be in redis key map');
|
||||
return loadParams;
|
||||
});
|
||||
const fetchResults = await fetcher(loadParamsToFetch);
|
||||
|
||||
const fetchMisses = loadParamsToFetch.filter((loadParams) => {
|
||||
// all values of fetchResults should be field objects or undefined
|
||||
return !fetchResults.get(loadParams);
|
||||
});
|
||||
|
||||
for (const fetchMiss of fetchMisses) {
|
||||
results.set(fetchMiss, null);
|
||||
}
|
||||
|
||||
const objectsToCache: Map<string, object> = new Map();
|
||||
for (const [loadParams, object] of fetchResults.entries()) {
|
||||
if (object) {
|
||||
objectsToCache.set(
|
||||
this.constructRedisKey(loadParams),
|
||||
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
|
||||
);
|
||||
results.set(loadParams, object);
|
||||
}
|
||||
}
|
||||
|
||||
await Promise.all([
|
||||
this.genericRedisCacher.cacheManyAsync(objectsToCache),
|
||||
this.genericRedisCacher.cacheDBMissesAsync(fetchMisses.map(this.constructRedisKey)),
|
||||
]);
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate the cache for objects cached by constructRedisKey(loadParams).
|
||||
*
|
||||
* @param loadParamsArray - load params to invalidate
|
||||
*/
|
||||
public async invalidateManyAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
): Promise<void> {
|
||||
await this.genericRedisCacher.invalidateManyAsync(loadParamsArray.map(this.constructRedisKey));
|
||||
}
|
||||
}
|
||||
+11
-11
@@ -1,5 +1,5 @@
|
||||
import { EntitySecondaryCacheLoader, mapMapAsync, ViewerContext } from '@expo/entity';
|
||||
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
|
||||
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||
import Redis from 'ioredis';
|
||||
import nullthrows from 'nullthrows';
|
||||
import { URL } from 'url';
|
||||
@@ -52,31 +52,31 @@ class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
|
||||
}
|
||||
|
||||
describe(RedisSecondaryEntityCache, () => {
|
||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
||||
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||
|
||||
beforeAll(() => {
|
||||
genericRedisCacheContext = {
|
||||
redisClient,
|
||||
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 redisClient.flushdb();
|
||||
await redisCacheAdapterContext.redisClient.flushdb();
|
||||
});
|
||||
afterAll(async () => {
|
||||
redisClient.disconnect();
|
||||
redisCacheAdapterContext.redisClient.disconnect();
|
||||
});
|
||||
|
||||
it('Loads through secondary loader, caches, and invalidates', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const createdEntity = await RedisTestEntity.creator(viewerContext)
|
||||
@@ -86,7 +86,7 @@ describe(RedisSecondaryEntityCache, () => {
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
genericRedisCacheContext,
|
||||
redisCacheAdapterContext,
|
||||
(loadParams) => `test-key-${loadParams.id}`
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
@@ -119,13 +119,13 @@ describe(RedisSecondaryEntityCache, () => {
|
||||
|
||||
it('correctly handles uncached and unfetchable load params', async () => {
|
||||
const viewerContext = new TestViewerContext(
|
||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
|
||||
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||
);
|
||||
|
||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||
new RedisSecondaryEntityCache(
|
||||
redisTestEntityConfiguration,
|
||||
genericRedisCacheContext,
|
||||
redisCacheAdapterContext,
|
||||
(loadParams) => `test-key-${loadParams.id}`
|
||||
),
|
||||
RedisTestEntity.loader(viewerContext)
|
||||
|
||||
@@ -15,18 +15,14 @@ export type RedisTestEntityFields = {
|
||||
};
|
||||
|
||||
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
|
||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||
RedisTestEntityFields,
|
||||
string,
|
||||
ViewerContext,
|
||||
RedisTestEntity,
|
||||
RedisTestEntityPrivacyPolicy
|
||||
> {
|
||||
return {
|
||||
entityClass: RedisTestEntity,
|
||||
entityConfiguration: redisTestEntityConfiguration,
|
||||
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
||||
};
|
||||
return redisTestEntityCompanionDefinition;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -84,3 +80,9 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
|
||||
databaseAdapterFlavor: 'postgres',
|
||||
cacheAdapterFlavor: 'redis',
|
||||
});
|
||||
|
||||
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||
entityClass: RedisTestEntity,
|
||||
entityConfiguration: redisTestEntityConfiguration,
|
||||
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
||||
});
|
||||
+3
-3
@@ -6,12 +6,12 @@ import {
|
||||
StubDatabaseAdapterProvider,
|
||||
} from '@expo/entity';
|
||||
import {
|
||||
GenericRedisCacheContext,
|
||||
RedisCacheAdapterContext,
|
||||
RedisCacheAdapterProvider,
|
||||
} from '@expo/entity-cache-adapter-redis';
|
||||
|
||||
export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
genericRedisCacheContext: GenericRedisCacheContext,
|
||||
redisCacheAdapterContext: RedisCacheAdapterContext,
|
||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||
): EntityCompanionProvider => {
|
||||
return new EntityCompanionProvider(
|
||||
@@ -29,7 +29,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||
[
|
||||
'redis',
|
||||
{
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
|
||||
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||
},
|
||||
],
|
||||
])
|
||||
|
||||
@@ -3,147 +3,6 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [0.32.0](https://github.com/expo/entity/compare/v0.31.1...v0.32.0) (2023-06-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add ability to specify knex transaction config ([#207](https://github.com/expo/entity/issues/207)) ([2069a0d](https://github.com/expo/entity/commit/2069a0d9fd1d8f7d090a71a90a758b2429ea5dd3))
|
||||
* entity companion definition static thunk ([#210](https://github.com/expo/entity/issues/210)) ([4b18010](https://github.com/expo/entity/commit/4b18010d42be50ef329f428b08330e21bf676586))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.31.0](https://github.com/expo/entity/compare/v0.30.0...v0.31.0) (2023-01-19)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.30.0](https://github.com/expo/entity/compare/v0.29.0...v0.30.0) (2022-12-23)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.29.0](https://github.com/expo/entity/compare/v0.28.0...v0.29.0) (2022-10-06)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.28.0](https://github.com/expo/entity/compare/v0.27.0...v0.28.0) (2022-09-13)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add BigIntField ([#193](https://github.com/expo/entity/issues/193)) ([acbad82](https://github.com/expo/entity/commit/acbad826a37bb5a054b4dcf9be91d11aa5f7f29a))
|
||||
* nested transactions ([#194](https://github.com/expo/entity/issues/194)) ([a77b914](https://github.com/expo/entity/commit/a77b914ad6dc018d1e309c9caf4971088a553ecf))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.27.0](https://github.com/expo/entity/compare/v0.26.1...v0.27.0) (2022-08-09)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add orderByRaw to loadManyByRawWhereClauseAsync ([#185](https://github.com/expo/entity/issues/185)) ([2817d78](https://github.com/expo/entity/commit/2817d78392dfecd0093111c24d581bdf01dba06d))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.26.1](https://github.com/expo/entity/compare/v0.26.0...v0.26.1) (2022-07-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* recache to higher cache levels when loading from a composed cache ([#182](https://github.com/expo/entity/pull/182))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.26.0](https://github.com/expo/entity/compare/v0.25.3...v0.26.0) (2022-07-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY ([#178](https://github.com/expo/entity/issues/178)) ([a0c35dd](https://github.com/expo/entity/commit/a0c35ddd7bca05d0c3f41dcf48e16d058918231c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.3](https://github.com/expo/entity/compare/v0.25.2...v0.25.3) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.2](https://github.com/expo/entity/compare/v0.25.1...v0.25.2) (2022-03-12)
|
||||
|
||||
**Note:** Version bump only for package @expo/entity
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [0.25.1](https://github.com/expo/entity/compare/v0.25.0...v0.25.1) (2022-03-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add composed cache to index ([#166](https://github.com/expo/entity/issues/166)) ([5c82edc](https://github.com/expo/entity/commit/5c82edcd9f26854878d29950a05852e117bbd723))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.25.0](https://github.com/expo/entity/compare/v0.24.0...v0.25.0) (2022-03-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* composed cache adapter, composed secondary cache, local memory secondary cache ([#164](https://github.com/expo/entity/issues/164)) ([6b6e70e](https://github.com/expo/entity/commit/6b6e70e75f7e42a4dce13edeb406a4d88d9264f0))
|
||||
* privacy policy evaluation context ([#162](https://github.com/expo/entity/issues/162)) ([3a81a4c](https://github.com/expo/entity/commit/3a81a4c059e2e995eb800e35e76b3d432c22b23f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||
|
||||
**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
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/entity",
|
||||
"version": "0.32.0",
|
||||
"version": "0.22.0",
|
||||
"description": "A privacy-first data model",
|
||||
"files": [
|
||||
"build",
|
||||
@@ -19,7 +19,7 @@
|
||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
"node": ">=12"
|
||||
},
|
||||
"keywords": [
|
||||
"entity"
|
||||
|
||||
@@ -1,120 +0,0 @@
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import IEntityCacheAdapter from './IEntityCacheAdapter';
|
||||
import { CacheStatus, CacheLoadResult } from './internal/ReadThroughEntityCache';
|
||||
|
||||
/**
|
||||
* A IEntityCacheAdapter that composes other IEntityCacheAdapter instances.
|
||||
*/
|
||||
export default class ComposedEntityCacheAdapter<TFields> implements IEntityCacheAdapter<TFields> {
|
||||
/**
|
||||
* @param cacheAdapters - list of cache adapters to compose in order of precedence.
|
||||
* Earlier cache adapters are read from first and written to (including invalidations) last.
|
||||
* Typically, caches closer to the application should be ordered before caches closer to the database.
|
||||
* A lower layer cache is closer to the database, while a higher layer cache is closer to the application.
|
||||
*/
|
||||
constructor(private readonly cacheAdapters: IEntityCacheAdapter<TFields>[]) {}
|
||||
|
||||
public async loadManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>> {
|
||||
const retMap = new Map<NonNullable<TFields[N]>, CacheLoadResult<TFields>>();
|
||||
const fulfilledFieldValuesByCacheIndex: NonNullable<TFields[N]>[][] = Array.from(
|
||||
{ length: this.cacheAdapters.length },
|
||||
() => []
|
||||
);
|
||||
|
||||
let unfulfilledFieldValues = fieldValues;
|
||||
for (let i = 0; i < this.cacheAdapters.length; i++) {
|
||||
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
|
||||
const cacheResultsFromAdapter = await cacheAdapter.loadManyAsync(
|
||||
fieldName,
|
||||
unfulfilledFieldValues
|
||||
);
|
||||
|
||||
const newUnfulfilledFieldValues = [];
|
||||
for (const [fieldValue, cacheResult] of cacheResultsFromAdapter) {
|
||||
if (cacheResult.status === CacheStatus.MISS) {
|
||||
newUnfulfilledFieldValues.push(fieldValue);
|
||||
} else {
|
||||
retMap.set(fieldValue, cacheResult);
|
||||
nullthrows(fulfilledFieldValuesByCacheIndex[i]).push(fieldValue);
|
||||
}
|
||||
}
|
||||
unfulfilledFieldValues = newUnfulfilledFieldValues;
|
||||
if (unfulfilledFieldValues.length === 0) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Recache values from lower layers that were not found in higher layers
|
||||
// Write to lower layers first
|
||||
for (let i = this.cacheAdapters.length - 1; i >= 0; i--) {
|
||||
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
|
||||
const hitsToCache = new Map<NonNullable<TFields[N]>, Readonly<TFields>>();
|
||||
const negativesToCache: NonNullable<TFields[N]>[] = [];
|
||||
|
||||
// Loop over all lower layer caches to collect hits and misses
|
||||
for (let j = i + 1; j < this.cacheAdapters.length; j++) {
|
||||
const fulfilledFieldValues = nullthrows(fulfilledFieldValuesByCacheIndex[j]);
|
||||
fulfilledFieldValues.forEach((fieldValue) => {
|
||||
const cacheResult = nullthrows(retMap.get(fieldValue));
|
||||
if (cacheResult.status === CacheStatus.HIT) {
|
||||
hitsToCache.set(fieldValue, cacheResult.item);
|
||||
} else if (cacheResult.status === CacheStatus.NEGATIVE) {
|
||||
negativesToCache.push(fieldValue);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
const promises = [];
|
||||
if (hitsToCache.size > 0) {
|
||||
promises.push(cacheAdapter.cacheManyAsync(fieldName, hitsToCache));
|
||||
}
|
||||
if (negativesToCache.length > 0) {
|
||||
promises.push(cacheAdapter.cacheDBMissesAsync(fieldName, negativesToCache));
|
||||
}
|
||||
await Promise.all(promises);
|
||||
}
|
||||
|
||||
for (const fieldValue of unfulfilledFieldValues) {
|
||||
retMap.set(fieldValue, { status: CacheStatus.MISS });
|
||||
}
|
||||
|
||||
return retMap;
|
||||
}
|
||||
|
||||
public async cacheManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>
|
||||
): Promise<void> {
|
||||
// write to lower layers first
|
||||
for (let i = this.cacheAdapters.length - 1; i >= 0; i--) {
|
||||
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
|
||||
await cacheAdapter.cacheManyAsync(fieldName, objectMap);
|
||||
}
|
||||
}
|
||||
|
||||
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
// write to lower layers first
|
||||
for (let i = this.cacheAdapters.length - 1; i >= 0; i--) {
|
||||
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
|
||||
await cacheAdapter.cacheDBMissesAsync(fieldName, fieldValues);
|
||||
}
|
||||
}
|
||||
|
||||
public async invalidateManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void> {
|
||||
// delete from lower layers first
|
||||
for (let i = this.cacheAdapters.length - 1; i >= 0; i--) {
|
||||
const cacheAdapter = nullthrows(this.cacheAdapters[i]);
|
||||
await cacheAdapter.invalidateManyAsync(fieldName, fieldValues);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import { ISecondaryEntityCache } from './EntitySecondaryCacheLoader';
|
||||
|
||||
/**
|
||||
* A ISecondaryEntityCache that composes other ISecondaryEntityCache instances.
|
||||
*/
|
||||
export default class ComposedSecondaryEntityCache<TLoadParams, TFields>
|
||||
implements ISecondaryEntityCache<TFields, TLoadParams>
|
||||
{
|
||||
/**
|
||||
* @param secondaryEntityCaches - list of caches to compose in order of precedence.
|
||||
* Earlier caches are read from first and written to (including invalidations) last.
|
||||
* Typically, caches closer to the application should be ordered before caches closer to the database.
|
||||
*/
|
||||
constructor(
|
||||
private readonly secondaryEntityCaches: ISecondaryEntityCache<TFields, TLoadParams>[]
|
||||
) {}
|
||||
|
||||
async loadManyThroughAsync(
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[],
|
||||
fetcher: (
|
||||
fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
|
||||
): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>> {
|
||||
return await ComposedSecondaryEntityCache.loadManyThroughRecursivelyAsync(
|
||||
this.secondaryEntityCaches,
|
||||
loadParamsArray,
|
||||
fetcher
|
||||
);
|
||||
}
|
||||
|
||||
private static async loadManyThroughRecursivelyAsync<TLoadParams, TFields>(
|
||||
secondaryEntityCaches: ISecondaryEntityCache<TFields, TLoadParams>[],
|
||||
loadParamsArray: readonly Readonly<TLoadParams>[],
|
||||
fetcher: (
|
||||
fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
|
||||
) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
|
||||
): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>> {
|
||||
if (secondaryEntityCaches.length === 0) {
|
||||
return await fetcher(loadParamsArray);
|
||||
}
|
||||
|
||||
const [firstCache, ...restCaches] = secondaryEntityCaches;
|
||||
|
||||
return await nullthrows(firstCache).loadManyThroughAsync(
|
||||
loadParamsArray,
|
||||
(fetcherLoadParamsArray) =>
|
||||
ComposedSecondaryEntityCache.loadManyThroughRecursivelyAsync(
|
||||
restCaches,
|
||||
fetcherLoadParamsArray,
|
||||
fetcher
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
async invalidateManyAsync(loadParamsArray: readonly Readonly<TLoadParams>[]): Promise<void> {
|
||||
// invalidate lower layers first
|
||||
for (let i = this.secondaryEntityCaches.length - 1; i >= 0; i--) {
|
||||
const secondaryEntityCache = nullthrows(this.secondaryEntityCaches[i]);
|
||||
await secondaryEntityCache.invalidateManyAsync(loadParamsArray);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,4 @@
|
||||
import {
|
||||
FieldEqualityCondition,
|
||||
QuerySelectionModifiers,
|
||||
QuerySelectionModifiersWithOrderByRaw,
|
||||
} from './EntityDatabaseAdapter';
|
||||
import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
@@ -14,7 +10,7 @@ import { mapMap } from './utils/collections/maps';
|
||||
* if the loads are not successful.
|
||||
*/
|
||||
export default class EnforcingEntityLoader<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -40,7 +36,7 @@ export default class EnforcingEntityLoader<
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByFieldEqualingManyAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
@@ -57,7 +53,7 @@ export default class EnforcingEntityLoader<
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldName: N,
|
||||
@@ -72,7 +68,7 @@ export default class EnforcingEntityLoader<
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view the returned entity
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
|
||||
* @throws when multiple entities are found matching the condition
|
||||
*/
|
||||
async loadByFieldEqualingAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
@@ -88,7 +84,7 @@ export default class EnforcingEntityLoader<
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view the returned entity
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
|
||||
*/
|
||||
async loadByIDAsync(id: TID): Promise<TEntity> {
|
||||
const entityResult = await this.entityLoader.loadByIDAsync(id);
|
||||
@@ -97,7 +93,7 @@ export default class EnforcingEntityLoader<
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view the returned entity
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view the returned entity
|
||||
* @throws when multiple entities are found matching the condition
|
||||
*/
|
||||
async loadByIDNullableAsync(id: TID): Promise<TEntity | null> {
|
||||
@@ -107,7 +103,7 @@ export default class EnforcingEntityLoader<
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, TEntity>> {
|
||||
const entityResults = await this.entityLoader.loadManyByIDsAsync(ids);
|
||||
@@ -116,23 +112,7 @@ export default class EnforcingEntityLoader<
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadFirstByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: Omit<QuerySelectionModifiers<TFields>, 'limit'> &
|
||||
Required<Pick<QuerySelectionModifiers<TFields>, 'orderBy'>>
|
||||
): Promise<TEntity | null> {
|
||||
const entityResult = await this.entityLoader.loadFirstByFieldEqualityConjunctionAsync(
|
||||
fieldEqualityOperands,
|
||||
querySelectionModifiers
|
||||
);
|
||||
return entityResult ? entityResult.enforceValue() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
@@ -147,12 +127,12 @@ export default class EnforcingEntityLoader<
|
||||
|
||||
/**
|
||||
* Enforcing version of entity loader method by the same name.
|
||||
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
|
||||
* @throws {@link EntityNotAuthorizedError} when viewer is not authorized to view one or more of the returned entities
|
||||
*/
|
||||
async loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields> = {}
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly TEntity[]> {
|
||||
const entityResults = await this.entityLoader.loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause,
|
||||
|
||||
@@ -11,22 +11,22 @@ import ViewerContext from './ViewerContext';
|
||||
* Entity is a privacy-first data model.
|
||||
*
|
||||
* A instance of an entity represents a single "row" of persisted data in a database that a
|
||||
* viewer, represented by the corresponding ViewerContext, has permission to read.
|
||||
* viewer, represented by the corresponding {@link ViewerContext}, has permission to read.
|
||||
*
|
||||
* Create, read, update, and delete permissions for an entity are declaratively defined using an
|
||||
* EntityPrivacyPolicy.
|
||||
* {@link EntityPrivacyPolicy}.
|
||||
*
|
||||
* Entites are loaded through an EntityLoader, which is responsible for
|
||||
* Entites are loaded through an {@link EntityLoader}, which is responsible for
|
||||
* orchestrating fetching, caching, and authorization of reading "rows".
|
||||
*
|
||||
* Entities are mutated and deleted through an EntityMutator, which is responsible for
|
||||
* Entities are mutated and deleted through an {@link EntityMutator}, which is responsible for
|
||||
* orchestrating database writes, cache invalidation, and authorization of writing "rows".
|
||||
*
|
||||
* All concrete entity implementations should extend this class and provide their
|
||||
* own EntityCompanionDefinition.
|
||||
* own {@link EntityCompanionDefinition}.
|
||||
*/
|
||||
export default abstract class Entity<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
@@ -38,7 +38,7 @@ export default abstract class Entity<
|
||||
* @returns mutator for creating an entity
|
||||
*/
|
||||
static creator<
|
||||
TMFields extends object,
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMViewerContext2 extends TMViewerContext,
|
||||
@@ -79,7 +79,7 @@ export default abstract class Entity<
|
||||
* @returns mutator for updating existingEntity
|
||||
*/
|
||||
static updater<
|
||||
TMFields extends object,
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
@@ -120,7 +120,7 @@ export default abstract class Entity<
|
||||
* @param queryContext - query context in which to perform the delete
|
||||
*/
|
||||
static deleteAsync<
|
||||
TMFields extends object,
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
@@ -162,7 +162,7 @@ export default abstract class Entity<
|
||||
* @param queryContext - query context in which to perform the delete
|
||||
*/
|
||||
static enforceDeleteAsync<
|
||||
TMFields extends object,
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
@@ -215,7 +215,7 @@ export default abstract class Entity<
|
||||
* @param queryContext - query context in which to perform the check
|
||||
*/
|
||||
static async canViewerUpdateAsync<
|
||||
TMFields extends object,
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
@@ -246,12 +246,11 @@ export default abstract class Entity<
|
||||
const companion = existingEntity
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this);
|
||||
const privacyPolicy = companion.entityCompanion.privacyPolicy;
|
||||
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
|
||||
const evaluationResult = await asyncResult(
|
||||
privacyPolicy.authorizeUpdateAsync(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
{ cascadingDeleteCause: null },
|
||||
existingEntity,
|
||||
companion.getMetricsAdapter()
|
||||
)
|
||||
@@ -269,7 +268,7 @@ export default abstract class Entity<
|
||||
* @param queryContext - query context in which to perform the check
|
||||
*/
|
||||
static async canViewerDeleteAsync<
|
||||
TMFields extends object,
|
||||
TMFields,
|
||||
TMID extends NonNullable<TMFields[TMSelectedFields]>,
|
||||
TMViewerContext extends ViewerContext,
|
||||
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
|
||||
@@ -300,12 +299,11 @@ export default abstract class Entity<
|
||||
const companion = existingEntity
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(this);
|
||||
const privacyPolicy = companion.entityCompanion.privacyPolicy;
|
||||
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
|
||||
const evaluationResult = await asyncResult(
|
||||
privacyPolicy.authorizeDeleteAsync(
|
||||
existingEntity.getViewerContext(),
|
||||
queryContext,
|
||||
{ cascadingDeleteCause: null },
|
||||
existingEntity,
|
||||
companion.getMetricsAdapter()
|
||||
)
|
||||
@@ -318,7 +316,7 @@ export default abstract class Entity<
|
||||
* An interface to pass in constructor (class) of an Entity as a function argument.
|
||||
*/
|
||||
export interface IEntityClass<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -331,19 +329,8 @@ export interface IEntityClass<
|
||||
>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
new (constructorParam: {
|
||||
viewerContext: TViewerContext;
|
||||
id: TID;
|
||||
databaseFields: Readonly<TFields>;
|
||||
selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
|
||||
}): TEntity;
|
||||
|
||||
/**
|
||||
* Returns a EntityCompanionDefinition for this entity.
|
||||
*
|
||||
* Memoized by the entity framework.
|
||||
*/
|
||||
defineCompanionDefinition(): EntityCompanionDefinition<
|
||||
new (viewerContext: TViewerContext, obj: Readonly<TFields>): TEntity;
|
||||
getCompanionDefinition(): EntityCompanionDefinition<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
|
||||
@@ -6,13 +6,8 @@ import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
|
||||
/**
|
||||
* An association loader is a set of convenience methods for loading entities
|
||||
* associated with an entity. In relational databases, these entities are often referenced
|
||||
* by foreign keys.
|
||||
*/
|
||||
export default class EntityAssociationLoader<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -29,7 +24,7 @@ export default class EntityAssociationLoader<
|
||||
*/
|
||||
async loadAssociatedEntityAsync<
|
||||
TIdentifyingField extends keyof Pick<TFields, TSelectedFields>,
|
||||
TAssociatedFields extends object,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
@@ -74,7 +69,7 @@ export default class EntityAssociationLoader<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
.forLoad(queryContext);
|
||||
|
||||
return (await loader.loadByIDAsync(associatedEntityID as unknown as TAssociatedID)) as Result<
|
||||
null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity
|
||||
@@ -91,7 +86,7 @@ export default class EntityAssociationLoader<
|
||||
* @param queryContext - query context in which to perform the load
|
||||
*/
|
||||
async loadManyAssociatedEntitiesAsync<
|
||||
TAssociatedFields extends object,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
@@ -128,7 +123,7 @@ export default class EntityAssociationLoader<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
.forLoad(queryContext);
|
||||
return await loader.loadManyByFieldEqualingAsync(
|
||||
associatedEntityFieldContainingThisID,
|
||||
thisID as any
|
||||
@@ -144,7 +139,7 @@ export default class EntityAssociationLoader<
|
||||
* @param queryContext - query context in which to perform the load
|
||||
*/
|
||||
async loadAssociatedEntityByFieldEqualingAsync<
|
||||
TAssociatedFields extends object,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
@@ -185,7 +180,7 @@ export default class EntityAssociationLoader<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
.forLoad(queryContext);
|
||||
return await loader.loadByFieldEqualingAsync(
|
||||
associatedEntityLookupByField,
|
||||
associatedFieldValue as any
|
||||
@@ -201,7 +196,7 @@ export default class EntityAssociationLoader<
|
||||
* @param queryContext - query context in which to perform the load
|
||||
*/
|
||||
async loadManyAssociatedEntitiesByFieldEqualingAsync<
|
||||
TAssociatedFields extends object,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
@@ -243,7 +238,7 @@ export default class EntityAssociationLoader<
|
||||
.getViewerContext()
|
||||
.getViewerScopedEntityCompanionForClass(associatedEntityClass)
|
||||
.getLoaderFactory()
|
||||
.forLoad(queryContext, { cascadingDeleteCause: null });
|
||||
.forLoad(queryContext);
|
||||
return await loader.loadManyByFieldEqualingAsync(
|
||||
associatedEntityLookupByField,
|
||||
associatedFieldValue as any
|
||||
@@ -251,13 +246,13 @@ export default class EntityAssociationLoader<
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an associated entity by folding a sequence of EntityLoadThroughDirective. At each
|
||||
* Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
|
||||
* fold step, load an associated entity identified by a field value of the current fold value.
|
||||
* @param loadDirectives - associated entity load directives instructing each step of the fold
|
||||
* @param queryContext - query context in which to perform the loads
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2 extends object,
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
@@ -285,13 +280,13 @@ export default class EntityAssociationLoader<
|
||||
): Promise<Result<TEntity2> | null>;
|
||||
|
||||
/**
|
||||
* Load an associated entity by folding a sequence of EntityLoadThroughDirective. At each
|
||||
* Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
|
||||
* fold step, load an associated entity identified by a field value of the current fold value.
|
||||
* @param loadDirectives - associated entity load directives instructing each step of the fold
|
||||
* @param queryContext - query context in which to perform the loads
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2 extends object,
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
@@ -301,7 +296,7 @@ export default class EntityAssociationLoader<
|
||||
TEntity2,
|
||||
TSelectedFields2
|
||||
>,
|
||||
TFields3 extends object,
|
||||
TFields3,
|
||||
TID3 extends NonNullable<TFields3[TSelectedFields3]>,
|
||||
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
|
||||
TPrivacyPolicy3 extends EntityPrivacyPolicy<
|
||||
@@ -340,13 +335,13 @@ export default class EntityAssociationLoader<
|
||||
): Promise<Result<TEntity3> | null>;
|
||||
|
||||
/**
|
||||
* Load an associated entity by folding a sequence of EntityLoadThroughDirective. At each
|
||||
* Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
|
||||
* fold step, load an associated entity identified by a field value of the current fold value.
|
||||
* @param loadDirectives - associated entity load directives instructing each step of the fold
|
||||
* @param queryContext - query context in which to perform the loads
|
||||
*/
|
||||
async loadAssociatedEntityThroughAsync<
|
||||
TFields2 extends object,
|
||||
TFields2,
|
||||
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
|
||||
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
|
||||
TPrivacyPolicy2 extends EntityPrivacyPolicy<
|
||||
@@ -356,7 +351,7 @@ export default class EntityAssociationLoader<
|
||||
TEntity2,
|
||||
TSelectedFields2
|
||||
>,
|
||||
TFields3 extends object,
|
||||
TFields3,
|
||||
TID3 extends NonNullable<TFields3[TSelectedFields3]>,
|
||||
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
|
||||
TPrivacyPolicy3 extends EntityPrivacyPolicy<
|
||||
@@ -366,7 +361,7 @@ export default class EntityAssociationLoader<
|
||||
TEntity3,
|
||||
TSelectedFields3
|
||||
>,
|
||||
TFields4 extends object,
|
||||
TFields4,
|
||||
TID4 extends NonNullable<TFields4[TSelectedFields4]>,
|
||||
TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext, TSelectedFields4>,
|
||||
TPrivacyPolicy4 extends EntityPrivacyPolicy<
|
||||
@@ -416,7 +411,7 @@ export default class EntityAssociationLoader<
|
||||
): Promise<Result<TEntity4> | null>;
|
||||
|
||||
/**
|
||||
* Load an associated entity by folding a sequence of EntityLoadThroughDirective. At each
|
||||
* Load an associated entity by folding a sequence of {@link EntityLoadThroughDirective}. At each
|
||||
* fold step, load an associated entity identified by a field value of the current fold value.
|
||||
* @param loadDirectives - associated entity load directives instructing each step of the fold
|
||||
* @param queryContext - query context in which to perform the loads
|
||||
@@ -482,7 +477,7 @@ export default class EntityAssociationLoader<
|
||||
export interface EntityLoadThroughDirective<
|
||||
TViewerContext extends ViewerContext,
|
||||
TFields,
|
||||
TAssociatedFields extends object,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
|
||||
+11
-8
@@ -1,38 +1,41 @@
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import { CacheLoadResult } from './internal/ReadThroughEntityCache';
|
||||
|
||||
/**
|
||||
* A cache adapter is an interface by which objects can be
|
||||
* cached, fetched from cache, and removed from cache (invalidated).
|
||||
*/
|
||||
export default interface IEntityCacheAdapter<TFields> {
|
||||
export default abstract class EntityCacheAdapter<TFields> {
|
||||
constructor(protected readonly entityConfiguration: EntityConfiguration<TFields>) {}
|
||||
|
||||
/**
|
||||
* Load many objects from cache.
|
||||
* @param fieldName - object field being queried
|
||||
* @param fieldValues - fieldName field values being queried
|
||||
* @returns map from all field values to a CacheLoadResult for each input value
|
||||
*/
|
||||
loadManyAsync<N extends keyof 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.
|
||||
* @param fieldName - object field being queried
|
||||
* @param objectMap - map from field value to object to cache
|
||||
*/
|
||||
cacheManyAsync<N extends keyof 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>;
|
||||
|
||||
/**
|
||||
* Negatively cache objects that could not be found in the cache or DB.
|
||||
* @param fieldName - object field being queried
|
||||
* @param fieldValues - fieldValues for objects reported as CacheStatus.NEGATIVE
|
||||
* @param fieldValues - fieldValues for objects reported as {@link CacheStatus.NEGATIVE}
|
||||
* in the cache and not found in the DB.
|
||||
*/
|
||||
cacheDBMissesAsync<N extends keyof TFields>(
|
||||
public abstract cacheDBMissesAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void>;
|
||||
@@ -42,7 +45,7 @@ export default interface IEntityCacheAdapter<TFields> {
|
||||
* @param fieldName - object field being queried
|
||||
* @param fieldValues - fieldName field values to be invalidated
|
||||
*/
|
||||
invalidateManyAsync<N extends keyof TFields>(
|
||||
public abstract invalidateManyAsync<N extends keyof TFields>(
|
||||
fieldName: N,
|
||||
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||
): Promise<void>;
|
||||
@@ -1,5 +1,7 @@
|
||||
import EntityCompanionProvider, { EntityCompanionDefinition } from './EntityCompanionProvider';
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityLoaderFactory from './EntityLoaderFactory';
|
||||
import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
|
||||
import EntityMutationValidator from './EntityMutationValidator';
|
||||
import EntityMutatorFactory from './EntityMutatorFactory';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import EntityQueryContextProvider from './EntityQueryContextProvider';
|
||||
@@ -16,7 +18,7 @@ export interface IPrivacyPolicyClass<TPrivacyPolicy> {
|
||||
* Composition root responsible for orchestrating setup of Entity mutators and loaders.
|
||||
*/
|
||||
export default class EntityCompanion<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -29,8 +31,6 @@ export default class EntityCompanion<
|
||||
>,
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
public readonly privacyPolicy: TPrivacyPolicy;
|
||||
|
||||
private readonly entityLoaderFactory: EntityLoaderFactory<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -49,8 +49,7 @@ export default class EntityCompanion<
|
||||
>;
|
||||
|
||||
constructor(
|
||||
public readonly entityCompanionProvider: EntityCompanionProvider,
|
||||
public readonly entityCompanionDefinition: EntityCompanionDefinition<
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
@@ -59,9 +58,24 @@ export default class EntityCompanion<
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly tableDataCoordinator: EntityTableDataCoordinator<TFields>,
|
||||
PrivacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>,
|
||||
mutationValidators: EntityMutationValidator<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>[],
|
||||
mutationTriggers: EntityMutationTriggerConfiguration<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {
|
||||
this.privacyPolicy = new entityCompanionDefinition.privacyPolicyClass();
|
||||
const privacyPolicy = new PrivacyPolicyClass();
|
||||
this.entityLoaderFactory = new EntityLoaderFactory<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -69,14 +83,19 @@ export default class EntityCompanion<
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>(this, tableDataCoordinator.dataManager, metricsAdapter);
|
||||
this.entityMutatorFactory = new EntityMutatorFactory(
|
||||
entityCompanionProvider,
|
||||
>(
|
||||
tableDataCoordinator.entityConfiguration,
|
||||
entityCompanionDefinition.entityClass,
|
||||
this.privacyPolicy,
|
||||
entityCompanionDefinition.mutationValidators ?? [],
|
||||
entityCompanionDefinition.mutationTriggers ?? {},
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
tableDataCoordinator.dataManager,
|
||||
metricsAdapter
|
||||
);
|
||||
this.entityMutatorFactory = new EntityMutatorFactory(
|
||||
tableDataCoordinator.entityConfiguration,
|
||||
entityClass,
|
||||
privacyPolicy,
|
||||
mutationValidators,
|
||||
mutationTriggers,
|
||||
this.entityLoaderFactory,
|
||||
tableDataCoordinator.databaseAdapter,
|
||||
metricsAdapter
|
||||
@@ -113,7 +132,7 @@ export default class EntityCompanion<
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the IEntityMetricsAdapter for this companion.
|
||||
* Get the {@link IEntityMetricsAdapter} for this companion.
|
||||
*/
|
||||
getMetricsAdapter(): IEntityMetricsAdapter {
|
||||
return this.metricsAdapter;
|
||||
|
||||
@@ -49,8 +49,8 @@ export interface CacheAdapterFlavorDefinition {
|
||||
* Definition for constructing a companion for an entity. Defines the core set of objects
|
||||
* used to power the entity framework for a particular type of entity.
|
||||
*/
|
||||
export interface EntityCompanionDefinition<
|
||||
TFields extends object,
|
||||
export class EntityCompanionDefinition<
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -63,9 +63,6 @@ export interface EntityCompanionDefinition<
|
||||
>,
|
||||
TSelectedFields extends keyof TFields = keyof TFields
|
||||
> {
|
||||
/**
|
||||
* The concrete Entity class for which this is the definition.
|
||||
*/
|
||||
readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
@@ -74,61 +71,97 @@ export interface EntityCompanionDefinition<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>;
|
||||
|
||||
/**
|
||||
* The EntityConfiguration for this entity.
|
||||
*/
|
||||
readonly entityConfiguration: EntityConfiguration<TFields>;
|
||||
|
||||
/**
|
||||
* The EntityPrivacyPolicy class for this entity.
|
||||
*/
|
||||
readonly privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
|
||||
|
||||
/**
|
||||
* An optional list of EntityMutationValidator for this entity.
|
||||
*/
|
||||
readonly mutationValidators?: EntityMutationValidator<
|
||||
readonly mutationValidators: () => EntityMutationValidator<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>[];
|
||||
|
||||
/**
|
||||
* An optional list of EntityMutationTrigger for this entity.
|
||||
*/
|
||||
readonly mutationTriggers?: EntityMutationTriggerConfiguration<
|
||||
readonly mutationTriggers: () => EntityMutationTriggerConfiguration<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>;
|
||||
readonly entitySelectedFields: TSelectedFields[];
|
||||
|
||||
/**
|
||||
* An optional subset of fields defined in the EntityConfiguration which belong to this entity.
|
||||
* For use when multiple types of entities are backed by a single table (EntityConfiguration) yet
|
||||
* only expose a subset of the fields.
|
||||
*/
|
||||
readonly entitySelectedFields?: TSelectedFields[];
|
||||
constructor({
|
||||
entityClass,
|
||||
entityConfiguration,
|
||||
privacyPolicyClass,
|
||||
mutationValidators = () => [],
|
||||
mutationTriggers = () => ({}),
|
||||
entitySelectedFields = Array.from(entityConfiguration.schema.keys()) as TSelectedFields[],
|
||||
}: {
|
||||
/**
|
||||
* The concrete Entity class for which this is the definition.
|
||||
*/
|
||||
entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
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<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TSelectedFields
|
||||
>[];
|
||||
/**
|
||||
* An optional list of {@link EntityMutationTrigger} for this entity.
|
||||
*/
|
||||
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;
|
||||
this.entityConfiguration = entityConfiguration;
|
||||
this.privacyPolicyClass = privacyPolicyClass;
|
||||
this.mutationValidators = mutationValidators;
|
||||
this.mutationTriggers = mutationTriggers;
|
||||
this.entitySelectedFields = entitySelectedFields;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* An instance of the Entity framework.
|
||||
*
|
||||
* Required to create a ViewerContext, which is the application entry point
|
||||
* Required to create a {@link ViewerContext}, which is the application entry point
|
||||
* into the framework.
|
||||
*
|
||||
* Internally, this is a lazy entity companion factory that instantiates and caches one
|
||||
* EntityCompanion for each type of Entity.
|
||||
* {@link EntityCompanion} for each type of {@link Entity}.
|
||||
*/
|
||||
export default class EntityCompanionProvider {
|
||||
private readonly companionDefinitionMap: Map<
|
||||
string,
|
||||
EntityCompanionDefinition<any, any, any, any, any, any>
|
||||
> = new Map();
|
||||
private readonly companionMap: Map<string, EntityCompanion<any, any, any, any, any, any>> =
|
||||
new Map();
|
||||
private readonly tableDataCoordinatorMap: Map<string, EntityTableDataCoordinator<any>> =
|
||||
@@ -136,7 +169,7 @@ export default class EntityCompanionProvider {
|
||||
|
||||
/**
|
||||
* Instantiate an Entity framework.
|
||||
* @param metricsAdapter - An IEntityMetricsAdapter for collecting metrics on this instance
|
||||
* @param metricsAdapter - An {@link IEntityMetricsAdapter} for collecting metrics on this instance
|
||||
* @param databaseAdapterFlavors - Database adapter configurations for this instance
|
||||
* @param cacheAdapterFlavors - Cache adapter configurations for this instance
|
||||
*/
|
||||
@@ -154,9 +187,10 @@ export default class EntityCompanionProvider {
|
||||
* companion is constructed using the configuration provided by the factory.
|
||||
*
|
||||
* @param entityClass - entity class to load
|
||||
* @param factory - entity companion factory
|
||||
*/
|
||||
getCompanionForEntity<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -176,22 +210,27 @@ export default class EntityCompanionProvider {
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
entityCompanionDefinition: EntityCompanionDefinition<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
TEntity,
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>
|
||||
): EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
const entityCompanionDefinition = computeIfAbsent(
|
||||
this.companionDefinitionMap,
|
||||
entityClass.name,
|
||||
() => entityClass.defineCompanionDefinition()
|
||||
);
|
||||
const tableDataCoordinator = this.getTableDataCoordinatorForEntity(
|
||||
entityCompanionDefinition.entityConfiguration,
|
||||
entityClass.name
|
||||
);
|
||||
return computeIfAbsent(this.companionMap, entityClass.name, () => {
|
||||
return new EntityCompanion(
|
||||
this,
|
||||
entityCompanionDefinition,
|
||||
entityCompanionDefinition.entityClass,
|
||||
tableDataCoordinator,
|
||||
entityCompanionDefinition.privacyPolicyClass,
|
||||
entityCompanionDefinition.mutationValidators(),
|
||||
entityCompanionDefinition.mutationTriggers(),
|
||||
this.metricsAdapter
|
||||
);
|
||||
});
|
||||
|
||||
@@ -13,7 +13,7 @@ export default class EntityConfiguration<TFields> {
|
||||
readonly cacheableKeys: ReadonlySet<keyof TFields>;
|
||||
readonly cacheKeyVersion: number;
|
||||
|
||||
readonly inboundEdges: IEntityClass<any, any, any, any, any, any>[];
|
||||
readonly getInboundEdges: () => IEntityClass<any, any, any, any, any, any>[];
|
||||
readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>;
|
||||
readonly entityToDBFieldsKeyMapping: ReadonlyMap<keyof TFields, string>;
|
||||
readonly dbToEntityFieldsKeyMapping: ReadonlyMap<string, keyof TFields>;
|
||||
@@ -25,7 +25,7 @@ export default class EntityConfiguration<TFields> {
|
||||
idField,
|
||||
tableName,
|
||||
schema,
|
||||
inboundEdges = [],
|
||||
getInboundEdges = () => [],
|
||||
cacheKeyVersion = 0,
|
||||
databaseAdapterFlavor,
|
||||
cacheAdapterFlavor,
|
||||
@@ -41,14 +41,14 @@ export default class EntityConfiguration<TFields> {
|
||||
tableName: string;
|
||||
|
||||
/**
|
||||
* Map from each entity field to an EntityFieldDefinition specifying information about the field.
|
||||
* Map from each entity field to an {@link EntityFieldDefinition} specifying information about the field.
|
||||
*/
|
||||
schema: Record<keyof TFields, EntityFieldDefinition<any>>;
|
||||
|
||||
/**
|
||||
* List of other entity types that reference this type in EntityFieldDefinition associations.
|
||||
* List of other entity types that reference this type in {@link EntityFieldDefinition} associations.
|
||||
*/
|
||||
inboundEdges?: IEntityClass<any, any, any, any, any, any>[];
|
||||
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
|
||||
@@ -71,7 +71,8 @@ export default class EntityConfiguration<TFields> {
|
||||
this.cacheKeyVersion = cacheKeyVersion;
|
||||
this.databaseAdapterFlavor = databaseAdapterFlavor;
|
||||
this.cacheAdapterFlavor = cacheAdapterFlavor;
|
||||
this.inboundEdges = inboundEdges;
|
||||
|
||||
this.getInboundEdges = getInboundEdges;
|
||||
|
||||
// external schema is a Record to typecheck that all fields have FieldDefinitions,
|
||||
// but internally the most useful representation is a map for lookups
|
||||
|
||||
@@ -7,32 +7,16 @@ import {
|
||||
FieldTransformerMap,
|
||||
} from './internal/EntityFieldTransformationUtils';
|
||||
|
||||
/**
|
||||
* Equality operand that is used for selecting entities with a field with a single value.
|
||||
*/
|
||||
export interface SingleValueFieldEqualityCondition<
|
||||
TFields,
|
||||
N extends keyof TFields = keyof TFields
|
||||
> {
|
||||
interface SingleValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
|
||||
fieldName: N;
|
||||
fieldValue: TFields[N];
|
||||
}
|
||||
|
||||
/**
|
||||
* Equality operand that is used for selecting entities with a field matching one of multiple values.
|
||||
*/
|
||||
export interface MultiValueFieldEqualityCondition<
|
||||
TFields,
|
||||
N extends keyof TFields = keyof TFields
|
||||
> {
|
||||
interface MultiValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
|
||||
fieldName: N;
|
||||
fieldValues: readonly TFields[N][];
|
||||
}
|
||||
|
||||
/**
|
||||
* A single equality operand for use in a selection clause.
|
||||
* See EntityLoader.loadManyByFieldEqualityConjunctionAsync documentation for examples.
|
||||
*/
|
||||
export type FieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> =
|
||||
| SingleValueFieldEqualityCondition<TFields, N>
|
||||
| MultiValueFieldEqualityCondition<TFields, N>;
|
||||
@@ -84,14 +68,6 @@ export interface QuerySelectionModifiers<TFields> {
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
export interface QuerySelectionModifiersWithOrderByRaw<TFields>
|
||||
extends QuerySelectionModifiers<TFields> {
|
||||
/**
|
||||
* Order the entities by a raw SQL `ORDER BY` clause.
|
||||
*/
|
||||
orderByRaw?: string;
|
||||
}
|
||||
|
||||
export interface TableQuerySelectionModifiers {
|
||||
orderBy:
|
||||
| {
|
||||
@@ -103,10 +79,6 @@ export interface TableQuerySelectionModifiers {
|
||||
limit: number | undefined;
|
||||
}
|
||||
|
||||
export interface TableQuerySelectionModifiersWithOrderByRaw extends TableQuerySelectionModifiers {
|
||||
orderByRaw: string | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* A database adapter is an interface by which entity objects can be
|
||||
* fetched, inserted, updated, and deleted from a database. This base class
|
||||
@@ -177,7 +149,7 @@ export default abstract class EntityDatabaseAdapter<TFields> {
|
||||
*
|
||||
* @param queryContext - query context with which to perform the fetch
|
||||
* @param fieldEqualityOperands - list of field equality where clause operand specifications
|
||||
* @param querySelectionModifiers - limit, offset, orderBy, and orderByRaw for the query
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of objects matching the query
|
||||
*/
|
||||
async fetchManyByFieldEqualityConjunctionAsync<N extends keyof TFields>(
|
||||
@@ -235,14 +207,14 @@ export default abstract class EntityDatabaseAdapter<TFields> {
|
||||
queryContext: EntityQueryContext,
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields>
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields>
|
||||
): Promise<readonly Readonly<TFields>[]> {
|
||||
const results = await this.fetchManyByRawWhereClauseInternalAsync(
|
||||
queryContext.getQueryInterface(),
|
||||
this.entityConfiguration.tableName,
|
||||
rawWhereClause,
|
||||
bindings,
|
||||
this.convertToTableQueryModifiersWithOrderByRaw(querySelectionModifiers)
|
||||
this.convertToTableQueryModifiers(querySelectionModifiers)
|
||||
);
|
||||
|
||||
return results.map((result) =>
|
||||
@@ -255,7 +227,7 @@ export default abstract class EntityDatabaseAdapter<TFields> {
|
||||
tableName: string,
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw
|
||||
querySelectionModifiers: TableQuerySelectionModifiers
|
||||
): Promise<object[]>;
|
||||
|
||||
/**
|
||||
@@ -391,15 +363,6 @@ export default abstract class EntityDatabaseAdapter<TFields> {
|
||||
id: any
|
||||
): Promise<number>;
|
||||
|
||||
private convertToTableQueryModifiersWithOrderByRaw(
|
||||
querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields>
|
||||
): TableQuerySelectionModifiersWithOrderByRaw {
|
||||
return {
|
||||
...this.convertToTableQueryModifiers(querySelectionModifiers),
|
||||
orderByRaw: querySelectionModifiers.orderByRaw,
|
||||
};
|
||||
}
|
||||
|
||||
private convertToTableQueryModifiers(
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields>
|
||||
): TableQuerySelectionModifiers {
|
||||
|
||||
@@ -5,21 +5,13 @@ import ViewerContext from './ViewerContext';
|
||||
|
||||
export enum EntityEdgeDeletionBehavior {
|
||||
/**
|
||||
* Invalidate the cache for all entities that reference the entity
|
||||
* Default. Invalidate the cache for all entities that reference the entity
|
||||
* being deleted through this field, and transitively run deletions on those entities.
|
||||
* This is most useful when the database itself expresses foreign
|
||||
* keys and cascading deletes and the entity framework just needs to
|
||||
* keys and cascading deletes or set nulls and the entity framework just needs to
|
||||
* be kept consistent with the state of the database.
|
||||
*/
|
||||
CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
|
||||
|
||||
/**
|
||||
* Invalidate the cache for all entities that reference the entity
|
||||
* being deleted through this field. This is most useful when the database itself expresses
|
||||
* foreign keys and cascading "SET NULL"s and the entity framework just needs to be
|
||||
* kept consistent with the state of the database.
|
||||
*/
|
||||
SET_NULL_INVALIDATE_CACHE_ONLY,
|
||||
CASCADE_DELETE_INVALIDATE_CACHE,
|
||||
|
||||
/**
|
||||
* Delete all entities that reference the entity being deleted through this field. This is very similar
|
||||
@@ -36,12 +28,9 @@ export enum EntityEdgeDeletionBehavior {
|
||||
SET_NULL,
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines an association between entities. An association is primarily used to define cascading deletion behavior.
|
||||
*/
|
||||
export interface EntityAssociationDefinition<
|
||||
TViewerContext extends ViewerContext,
|
||||
TAssociatedFields extends object,
|
||||
TAssociatedFields,
|
||||
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
|
||||
TAssociatedEntity extends ReadonlyEntity<
|
||||
TAssociatedFields,
|
||||
@@ -61,7 +50,7 @@ export interface EntityAssociationDefinition<
|
||||
/**
|
||||
* Class of entity on the other end of this edge.
|
||||
*/
|
||||
associatedEntityClass: IEntityClass<
|
||||
getAssociatedEntityClass: () => IEntityClass<
|
||||
TAssociatedFields,
|
||||
TAssociatedID,
|
||||
TViewerContext,
|
||||
@@ -82,23 +71,18 @@ export interface EntityAssociationDefinition<
|
||||
*
|
||||
* @remarks
|
||||
* The entity framework doesn't prescribe a one-size-fits-all solution for referential
|
||||
* integrity; instead it exposes mechanisms that support both database foreign key constraints
|
||||
* integrity; instead it exposes mechanisms that supports both database foreign key constraints
|
||||
* and implicit entity-specified foreign keys. Choosing which approach to use often depends on
|
||||
* 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 EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY or
|
||||
* EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY are recommended.
|
||||
* 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;
|
||||
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;
|
||||
@@ -109,7 +93,6 @@ export abstract class EntityFieldDefinition<T> {
|
||||
* @param cache - Whether or not to cache loaded instances of the entity by this field. The column name is
|
||||
* used to derive a cache key for the cache entry. If true, this column must be able uniquely
|
||||
* identify the entity.
|
||||
* @param association - Defines the association behavior for an entity that this column references.
|
||||
*/
|
||||
constructor({
|
||||
columnName,
|
||||
|
||||
@@ -2,87 +2,61 @@ import { validate as validateUUID } from 'uuid';
|
||||
|
||||
import { EntityFieldDefinition } from './EntityFieldDefinition';
|
||||
|
||||
/**
|
||||
* EntityFieldDefinition for a column with a JS string type.
|
||||
*/
|
||||
export class StringField extends EntityFieldDefinition<string> {
|
||||
protected validateInputValueInternal(value: string): boolean {
|
||||
return typeof value === 'string';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* EntityFieldDefinition for a column with a JS Date type.
|
||||
*/
|
||||
export class DateField extends EntityFieldDefinition<Date> {
|
||||
protected validateInputValueInternal(value: Date): boolean {
|
||||
return value instanceof Date;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* EntityFieldDefinition for a column with a JS boolean type.
|
||||
*/
|
||||
export class BooleanField extends EntityFieldDefinition<boolean> {
|
||||
protected validateInputValueInternal(value: boolean): boolean {
|
||||
return typeof value === 'boolean';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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';
|
||||
}
|
||||
}
|
||||
export class JSONArrayField extends EntityFieldDefinition<any[]> {
|
||||
protected validateInputValueInternal(value: any[]): boolean {
|
||||
return Array.isArray(value);
|
||||
}
|
||||
}
|
||||
export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
|
||||
protected validateInputValueInternal(_value: any): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,5 @@
|
||||
import { Result, asyncResult, result } from '@expo/results';
|
||||
import invariant from 'invariant';
|
||||
import nullthrows from 'nullthrows';
|
||||
|
||||
import EnforcingEntityLoader from './EnforcingEntityLoader';
|
||||
import { IEntityClass } from './Entity';
|
||||
@@ -9,13 +8,11 @@ import {
|
||||
FieldEqualityCondition,
|
||||
QuerySelectionModifiers,
|
||||
isSingleValueFieldEqualityCondition,
|
||||
QuerySelectionModifiersWithOrderByRaw,
|
||||
} from './EntityDatabaseAdapter';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
import { pick } from './entityUtils';
|
||||
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
|
||||
import EntityNotFoundError from './errors/EntityNotFoundError';
|
||||
import EntityDataManager from './internal/EntityDataManager';
|
||||
@@ -24,10 +21,10 @@ import { mapMap, mapMapAsync } from './utils/collections/maps';
|
||||
|
||||
/**
|
||||
* The primary interface for loading entities. All normal loads are batched,
|
||||
* cached, and authorized against the entity's EntityPrivacyPolicy.
|
||||
* cached, and authorized against the entity's {@link EntityPrivacyPolicy}.
|
||||
*/
|
||||
export default class EntityLoader<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -43,7 +40,6 @@ export default class EntityLoader<
|
||||
constructor(
|
||||
private readonly viewerContext: TViewerContext,
|
||||
private readonly queryContext: EntityQueryContext,
|
||||
private readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext,
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
@@ -53,7 +49,6 @@ export default class EntityLoader<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly entitySelectedFields: TSelectedFields[] | undefined,
|
||||
private readonly privacyPolicy: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
@@ -130,9 +125,7 @@ export default class EntityLoader<
|
||||
const entityResults = await this.loadManyByFieldEqualingAsync(uniqueFieldName, fieldValue);
|
||||
invariant(
|
||||
entityResults.length <= 1,
|
||||
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${String(
|
||||
uniqueFieldName
|
||||
)}=${fieldValue}`
|
||||
`loadByFieldEqualing: Multiple entities of type ${this.entityClass.name} found for ${uniqueFieldName}=${fieldValue}`
|
||||
);
|
||||
return entityResults[0] ?? null;
|
||||
}
|
||||
@@ -186,42 +179,16 @@ export default class EntityLoader<
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the first entity matching the selection constructed from the conjunction of specified
|
||||
* operands, or null if no matching entity exists. Entities loaded using this method are not
|
||||
* batched or cached.
|
||||
*
|
||||
* This is a convenience method for {@link loadManyByFieldEqualityConjunctionAsync}. However, the
|
||||
* `orderBy` option must be specified to define what "first" means. If ordering doesn't matter,
|
||||
* explicitly pass in an empty array.
|
||||
*
|
||||
* @param fieldEqualityOperands - list of field equality selection operand specifications
|
||||
* @param querySelectionModifiers - orderBy and optional offset for the query
|
||||
* @returns the first entity results that matches the query, where result error can be
|
||||
* UnauthorizedError
|
||||
*/
|
||||
async loadFirstByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
|
||||
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
|
||||
querySelectionModifiers: Omit<QuerySelectionModifiers<TFields>, 'limit'> &
|
||||
Required<Pick<QuerySelectionModifiers<TFields>, 'orderBy'>>
|
||||
): Promise<Result<TEntity> | null> {
|
||||
const results = await this.loadManyByFieldEqualityConjunctionAsync(fieldEqualityOperands, {
|
||||
...querySelectionModifiers,
|
||||
limit: 1,
|
||||
});
|
||||
return results[0] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads many entities matching the selection constructed from the conjunction of specified operands.
|
||||
* Loads many entities matching the conjunction of WHERE clauses constructed from specified operands.
|
||||
* Entities loaded using this method are not batched or cached.
|
||||
*
|
||||
* @example
|
||||
* fieldEqualityOperands:
|
||||
* `[{fieldName: 'hello', fieldValue: 1}, {fieldName: 'world', fieldValues: [2, 3]}]`
|
||||
* Entities returned with a SQL EntityDatabaseAdapter:
|
||||
* Entities returned:
|
||||
* `WHERE hello = 1 AND world = ANY({2, 3})`
|
||||
*
|
||||
* @param fieldEqualityOperands - list of field equality selection operand specifications
|
||||
* @param fieldEqualityOperands - list of field equality WHERE clause operand specifications
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
*/
|
||||
@@ -251,7 +218,6 @@ export default class EntityLoader<
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
@@ -274,12 +240,12 @@ export default class EntityLoader<
|
||||
* bindings: `[1]`
|
||||
* Entites returned `WHERE id = 1`
|
||||
*
|
||||
* http://knexjs.org/#Builder-whereRaw
|
||||
* http://knexjs.org/#Raw-Bindings
|
||||
* {@link http://knexjs.org/#Builder-whereRaw}
|
||||
* {@link http://knexjs.org/#Raw-Bindings}
|
||||
*
|
||||
* @param rawWhereClause - parameterized SQL WHERE clause with positional binding placeholders or named binding placeholders
|
||||
* @param bindings - array of positional bindings or object of named bindings
|
||||
* @param querySelectionModifiers - limit, offset, orderBy, and orderByRaw for the query
|
||||
* @param querySelectionModifiers - limit, offset, and orderBy for the query
|
||||
* @returns array of entity results that match the query, where result error can be UnauthorizedError
|
||||
* @throws Error when rawWhereClause or bindings are invalid
|
||||
*
|
||||
@@ -288,7 +254,7 @@ export default class EntityLoader<
|
||||
async loadManyByRawWhereClauseAsync(
|
||||
rawWhereClause: string,
|
||||
bindings: any[] | object,
|
||||
querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields> = {}
|
||||
querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
|
||||
): Promise<readonly Result<TEntity>[]> {
|
||||
const fieldObjects = await this.dataManager.loadManyByRawWhereClauseAsync(
|
||||
this.queryContext,
|
||||
@@ -306,7 +272,6 @@ export default class EntityLoader<
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
@@ -316,7 +281,7 @@ export default class EntityLoader<
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate all caches for an entity's fields. Exposed primarily for internal use by EntityMutator.
|
||||
* Invalidate all caches for an entity's fields. Exposed primarily for internal use by {@link EntityMutator}.
|
||||
* @param objectFields - entity data object to be invalidated
|
||||
*/
|
||||
async invalidateFieldsAsync(objectFields: Readonly<TFields>): Promise<void> {
|
||||
@@ -335,7 +300,7 @@ export default class EntityLoader<
|
||||
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
|
||||
return fieldsObjects.map((fieldsObject) => {
|
||||
try {
|
||||
return result(this.constructEntity(fieldsObject));
|
||||
return result(new this.entityClass(this.viewerContext, fieldsObject));
|
||||
} catch (e) {
|
||||
if (!(e instanceof Error)) {
|
||||
throw e;
|
||||
@@ -345,20 +310,6 @@ export default class EntityLoader<
|
||||
});
|
||||
}
|
||||
|
||||
public constructEntity(fieldsObject: TFields): TEntity {
|
||||
const idField = this.entityConfiguration.idField;
|
||||
const id = nullthrows(fieldsObject[idField], 'must provide ID to create an entity');
|
||||
const entitySelectedFields =
|
||||
this.entitySelectedFields ?? Array.from(this.entityConfiguration.schema.keys());
|
||||
const selectedFields = pick(fieldsObject, entitySelectedFields);
|
||||
return new this.entityClass({
|
||||
viewerContext: this.viewerContext,
|
||||
id: id as TID,
|
||||
databaseFields: fieldsObject,
|
||||
selectedFields,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct and authorize entities from fields map, returning error results for entities that fail
|
||||
* to construct or fail to authorize.
|
||||
@@ -381,7 +332,6 @@ export default class EntityLoader<
|
||||
this.privacyPolicy.authorizeReadAsync(
|
||||
this.viewerContext,
|
||||
this.queryContext,
|
||||
this.privacyPolicyEvaluationContext,
|
||||
uncheckedEntityResult.value,
|
||||
this.metricsAdapter
|
||||
)
|
||||
@@ -396,7 +346,7 @@ export default class EntityLoader<
|
||||
fieldValues: readonly TFields[N][]
|
||||
): void {
|
||||
const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
|
||||
invariant(fieldDefinition, `must have field definition for field = ${String(fieldName)}`);
|
||||
invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
|
||||
for (const fieldValue of fieldValues) {
|
||||
const isInputValid = fieldDefinition.validateInputValue(fieldValue);
|
||||
if (!isInputValid) {
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import EntityCompanion from './EntityCompanion';
|
||||
import { IEntityClass } from './Entity';
|
||||
import EntityConfiguration from './EntityConfiguration';
|
||||
import EntityLoader from './EntityLoader';
|
||||
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
|
||||
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
|
||||
import { EntityQueryContext } from './EntityQueryContext';
|
||||
import ReadonlyEntity from './ReadonlyEntity';
|
||||
import ViewerContext from './ViewerContext';
|
||||
@@ -11,7 +12,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
|
||||
* The primary entry point for loading entities.
|
||||
*/
|
||||
export default class EntityLoaderFactory<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -25,7 +26,8 @@ export default class EntityLoaderFactory<
|
||||
TSelectedFields extends keyof TFields
|
||||
> {
|
||||
constructor(
|
||||
private readonly entityCompanion: EntityCompanion<
|
||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
||||
private readonly entityClass: IEntityClass<
|
||||
TFields,
|
||||
TID,
|
||||
TViewerContext,
|
||||
@@ -33,6 +35,7 @@ export default class EntityLoaderFactory<
|
||||
TPrivacyPolicy,
|
||||
TSelectedFields
|
||||
>,
|
||||
private readonly privacyPolicyClass: TPrivacyPolicy,
|
||||
private readonly dataManager: EntityDataManager<TFields>,
|
||||
protected readonly metricsAdapter: IEntityMetricsAdapter
|
||||
) {}
|
||||
@@ -44,17 +47,14 @@ export default class EntityLoaderFactory<
|
||||
*/
|
||||
forLoad(
|
||||
viewerContext: TViewerContext,
|
||||
queryContext: EntityQueryContext,
|
||||
privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext
|
||||
queryContext: EntityQueryContext
|
||||
): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
|
||||
return new EntityLoader(
|
||||
viewerContext,
|
||||
queryContext,
|
||||
privacyPolicyEvaluationContext,
|
||||
this.entityCompanion.entityCompanionDefinition.entityConfiguration,
|
||||
this.entityCompanion.entityCompanionDefinition.entityClass,
|
||||
this.entityCompanion.entityCompanionDefinition.entitySelectedFields,
|
||||
this.entityCompanion.privacyPolicy,
|
||||
this.entityConfiguration,
|
||||
this.entityClass,
|
||||
this.privacyPolicyClass,
|
||||
this.dataManager,
|
||||
this.metricsAdapter
|
||||
);
|
||||
|
||||
@@ -8,7 +8,7 @@ export enum EntityMutationType {
|
||||
}
|
||||
|
||||
export type EntityValidatorMutationInfo<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -20,26 +20,15 @@ export type EntityValidatorMutationInfo<
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
};
|
||||
|
||||
/**
|
||||
* Information about a cascading deletion.
|
||||
*/
|
||||
export type EntityCascadingDeletionInfo = {
|
||||
/**
|
||||
* The entity that is being mutated at this step in the cascaded deletion.
|
||||
*/
|
||||
export type EntityMutationTriggerDeleteCascadeInfo<> = {
|
||||
entity: Entity<any, any, any, any>;
|
||||
|
||||
/**
|
||||
* The cascade deletion that caused this mutation.
|
||||
*/
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null;
|
||||
};
|
||||
|
||||
export type EntityTriggerMutationInfo<
|
||||
TFields extends object,
|
||||
TFields,
|
||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||
TViewerContext extends ViewerContext,
|
||||
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
|
||||
@@ -51,9 +40,8 @@ export type EntityTriggerMutationInfo<
|
||||
| {
|
||||
type: EntityMutationType.UPDATE;
|
||||
previousValue: TEntity;
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
}
|
||||
| {
|
||||
type: EntityMutationType.DELETE;
|
||||
cascadingDeleteCause: EntityCascadingDeletionInfo | null;
|
||||
cascadingDeleteCause: EntityMutationTriggerDeleteCascadeInfo | null;
|
||||
};
|
||||
Loaded 100 of 176 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user