mirror of
https://github.com/expo/entity.git
synced 2026-11-15 03:48:08 -10:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b61341057b |
No files matched your search
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"directory": "./src",
|
|
||||||
"location": "top",
|
|
||||||
"exclude": ["tests__", "testfixtures"],
|
|
||||||
"singleQuotes": true,
|
|
||||||
"exportDefault": true,
|
|
||||||
"delete": true
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
{
|
||||||
|
"root": true,
|
||||||
|
"extends": [
|
||||||
|
"universe/node",
|
||||||
|
"universe/shared/typescript-analysis"
|
||||||
|
],
|
||||||
|
"plugins": [
|
||||||
|
"eslint-plugin-tsdoc"
|
||||||
|
],
|
||||||
|
"rules": {
|
||||||
|
"no-restricted-imports": ["error",{ "paths": [".", "..", "../.."] }],
|
||||||
|
"tsdoc/syntax": "warn",
|
||||||
|
"no-console": "warn",
|
||||||
|
"handle-callback-err": "off"
|
||||||
|
},
|
||||||
|
"overrides": [
|
||||||
|
{
|
||||||
|
"files": [
|
||||||
|
"*.ts",
|
||||||
|
"*.tsx",
|
||||||
|
"*.d.ts"
|
||||||
|
],
|
||||||
|
"parserOptions": {
|
||||||
|
"project": "./tsconfig.json"
|
||||||
|
},
|
||||||
|
"rules": {
|
||||||
|
"@typescript-eslint/explicit-function-return-type": [
|
||||||
|
"warn",
|
||||||
|
{
|
||||||
|
"allowExpressions": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"@typescript-eslint/naming-convention": [
|
||||||
|
"warn",
|
||||||
|
{
|
||||||
|
"selector": "typeLike",
|
||||||
|
"format": [
|
||||||
|
"PascalCase"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"selector": "enumMember",
|
||||||
|
"format": [
|
||||||
|
"UPPER_CASE"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"no-dupe-class-members": "off",
|
||||||
|
"@typescript-eslint/no-dupe-class-members": [
|
||||||
|
"error"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
root: true,
|
|
||||||
extends: ['universe/node', 'universe/shared/typescript-analysis'],
|
|
||||||
plugins: ['eslint-plugin-tsdoc'],
|
|
||||||
rules: {
|
|
||||||
'no-restricted-imports': ['error', { paths: ['.', '..', '../..'] }],
|
|
||||||
'tsdoc/syntax': 'warn',
|
|
||||||
'no-console': 'warn',
|
|
||||||
'handle-callback-err': 'off',
|
|
||||||
},
|
|
||||||
overrides: [
|
|
||||||
{
|
|
||||||
files: ['*.ts', '*.tsx', '*.d.ts'],
|
|
||||||
parserOptions: {
|
|
||||||
project: './tsconfig.json',
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
'@typescript-eslint/explicit-function-return-type': [
|
|
||||||
'warn',
|
|
||||||
{
|
|
||||||
allowExpressions: true,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
'@typescript-eslint/naming-convention': [
|
|
||||||
'warn',
|
|
||||||
{
|
|
||||||
selector: 'typeLike',
|
|
||||||
format: ['PascalCase'],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
selector: 'enumMember',
|
|
||||||
format: ['UPPER_CASE'],
|
|
||||||
},
|
|
||||||
// async functions must have names ending with 'Async'
|
|
||||||
{
|
|
||||||
selector: ['function', 'classMethod', 'typeMethod'],
|
|
||||||
format: ['camelCase'],
|
|
||||||
modifiers: ['async'],
|
|
||||||
suffix: ['Async'],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
'no-dupe-class-members': 'off',
|
|
||||||
'@typescript-eslint/no-dupe-class-members': ['error'],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
|
||||||
@@ -3,17 +3,21 @@ name: docs
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- master
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
deploy:
|
deploy:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-18.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v1
|
||||||
with:
|
with:
|
||||||
cache: yarn
|
node-version: 12.x
|
||||||
node-version-file: package.json
|
- name: Cache Node.js modules
|
||||||
|
uses: actions/cache@v1
|
||||||
|
with:
|
||||||
|
path: ${{ github.workspace }}/node_modules
|
||||||
|
key: ${{ runner.OS }}-node_modules-${{ hashFiles('yarn.lock') }}
|
||||||
- run: yarn --frozen-lockfile
|
- run: yarn --frozen-lockfile
|
||||||
- run: yarn typedoc
|
- run: yarn typedoc
|
||||||
- name: Deploy
|
- name: Deploy
|
||||||
|
|||||||
@@ -2,20 +2,24 @@ name: tests
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [ main ]
|
branches: [ master ]
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v1
|
||||||
with:
|
with:
|
||||||
cache: yarn
|
node-version: 12.x
|
||||||
node-version-file: package.json
|
- name: Cache Node.js modules
|
||||||
|
uses: actions/cache@v1
|
||||||
|
with:
|
||||||
|
path: ${{ github.workspace }}/node_modules
|
||||||
|
key: ${{ runner.OS }}-node_modules-${{ hashFiles('yarn.lock') }}
|
||||||
- run: yarn --frozen-lockfile
|
- run: yarn --frozen-lockfile
|
||||||
- run: yarn lint -- -- --max-warnings=0
|
- run: yarn lint -- -- --max-warnings=0
|
||||||
- run: yarn test -- -- --coverage
|
- run: yarn test -- -- --coverage
|
||||||
|
|||||||
+1
-8
@@ -23,19 +23,12 @@ node_modules/
|
|||||||
.yarn-integrity
|
.yarn-integrity
|
||||||
|
|
||||||
# yarn v2
|
# yarn v2
|
||||||
|
|
||||||
.yarn/cache
|
.yarn/cache
|
||||||
.yarn/unplugged
|
.yarn/unplugged
|
||||||
.yarn/build-state.yml
|
.yarn/build-state.yml
|
||||||
.pnp.*
|
.pnp.*
|
||||||
|
|
||||||
# [yarn](https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored)
|
|
||||||
**/.yarn/*
|
|
||||||
!**/.yarn/plugins
|
|
||||||
!**/.yarn/releases
|
|
||||||
!**/.yarn/sdks
|
|
||||||
!**/.yarn/versions
|
|
||||||
**/.pnp.*
|
|
||||||
|
|
||||||
# Entity-specific ignores
|
# Entity-specific ignores
|
||||||
|
|
||||||
build/
|
build/
|
||||||
|
|||||||
+1
-218
@@ -3,223 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
### Breaking Changes
|
|
||||||
|
|
||||||
* make using non-enforcing entity loader explicit ([#238](https://github.com/expo/entity/issues/238)) ([2edc7af](https://github.com/expo/entity/commit/2edc7af7e20c362688ff2ee674fa2245205d6de4))
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* always reload entity after update since cascading changes may have changed it since commit ([#233](https://github.com/expo/entity/issues/233)) ([7c3c985](https://github.com/expo/entity/commit/7c3c9854a4dd91d4b73ebdb18bdeadea8b63f4c7))
|
|
||||||
* constrain entity fields type to string-keyed object ([#235](https://github.com/expo/entity/issues/235)) ([7e2cea1](https://github.com/expo/entity/commit/7e2cea16973a0ae1917f867cd25d6ef7c8eaecef))
|
|
||||||
* disallow keys of JS Object prototype for safety ([#236](https://github.com/expo/entity/issues/236)) ([05726d4](https://github.com/expo/entity/commit/05726d45fa9b91a6b25ddbc9c7e3e097b02097ca))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* Add global mutation trigger field to EntityCompanionProvider ([#215](https://github.com/expo/entity/issues/215)) ([6569486](https://github.com/expo/entity/commit/6569486ecddf2fd33c626f634c761e06636b1730))
|
|
||||||
* add previousValue to privacy policy context for updates ([#232](https://github.com/expo/entity/issues/232)) ([af495a9](https://github.com/expo/entity/commit/af495a9a856a5042f00cfd150348e415139cb85e))
|
|
||||||
* Add StrictEnumField with better validation ([#222](https://github.com/expo/entity/issues/222)) ([8753252](https://github.com/expo/entity/commit/87532525d090b3a67f1cedd95ac990f7dcb3ab5d))
|
|
||||||
* make canViewerDeleteAsync recursive ([#224](https://github.com/expo/entity/issues/224)) ([60fc9a4](https://github.com/expo/entity/commit/60fc9a4c4b587b866f2f5a1b3bd22145bc77e6e9))
|
|
||||||
* Use uuid v7 in stub database adapter ([#234](https://github.com/expo/entity/issues/234)) ([1e8ea64](https://github.com/expo/entity/commit/1e8ea64017430a2ce5ea197678bd78713ad77ecd))
|
|
||||||
* move entity loader utils into their own object ([#239](https://github.com/expo/entity/issues/239))([93905be](https://github.com/expo/entity/commit/93905be81cf74c5626ca19358794261c17223f95))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* Allow UUIDv6/7/8 in UUIDField validation ([#221](https://github.com/expo/entity/issues/221)) ([cc6f3dc](https://github.com/expo/entity/commit/cc6f3dc1e677382eec220723c37b5b883d980372))
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* add loadManyByIDsNullableAsync loader method ([#214](https://github.com/expo/entity/issues/214)) ([aad94ac](https://github.com/expo/entity/commit/aad94aca479ac07cc7f76b5e1a122ff85a2d1542))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
|
|
||||||
@@ -229,7 +12,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|||||||
|
|
||||||
### Chores
|
### Chores
|
||||||
|
|
||||||
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
* Refactor cachers to use an abstract class and interface ([#157](https://github.com/expo/entity/pull/157))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -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://github.com/expo/entity/actions?query=workflow%3Atests)
|
||||||
[](https://expo.github.io/entity/)
|
[](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)
|
||||||
[](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
|
## Releasing
|
||||||
|
|
||||||
To release a new version:
|
To release a new version, let's say `v1.0.0` for example:
|
||||||
1. `git checkout main`
|
1. `git checkout -b bump-v1.0.0`
|
||||||
1. `yarn lerna publish [patch|minor|major] -- --conventional-commits`
|
1. `yarn lerna version minor -- --no-push --conventional-commits`
|
||||||
|
1. `git push -u origin bump-v1.0.0`
|
||||||
|
1. Create a PR from the `bump-v1.0.0` branch, wait for tests, and commit the PR using GitHub interface.
|
||||||
|
1. `git checkout master && git pull`
|
||||||
|
1. `git tag -d v1.0.0`
|
||||||
|
1. `git tag v1.0.0`
|
||||||
|
1. `git push origin v1.0.0`
|
||||||
1. In GitHub release interface, create a new release from the tag, copy changelog changes to release description.
|
1. In GitHub release interface, create a new release from the tag, copy changelog changes to release description.
|
||||||
|
1. `yarn clean && yarn tsc`
|
||||||
|
1. In each public subpackage, run `npm publish` and enter 2FA token.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
codecov:
|
|
||||||
branch: main
|
|
||||||
ignore:
|
|
||||||
- "packages/entity-example"
|
|
||||||
+1
-1
@@ -4,5 +4,5 @@
|
|||||||
],
|
],
|
||||||
"npmClient": "yarn",
|
"npmClient": "yarn",
|
||||||
"useWorkspaces": true,
|
"useWorkspaces": true,
|
||||||
"version": "0.37.0"
|
"version": "0.24.0"
|
||||||
}
|
}
|
||||||
+20
-24
@@ -16,30 +16,30 @@
|
|||||||
"barrelsby": "lerna run barrelsby"
|
"barrelsby": "lerna run barrelsby"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@expo/batcher": "^1.0.0",
|
|
||||||
"@expo/entity": "file:packages/entity",
|
"@expo/entity": "file:packages/entity",
|
||||||
"@expo/results": "^1.0.0",
|
"@expo/results": "^1.0.0",
|
||||||
"@types/invariant": "^2.2.37",
|
|
||||||
"@types/jest": "^29.5.12",
|
|
||||||
"@types/jsbn": "^1.2.29",
|
|
||||||
"@types/lru-cache": "^5.1.1",
|
"@types/lru-cache": "^5.1.1",
|
||||||
"@types/node": "^20.14.1",
|
"@types/invariant": "^2.2.33",
|
||||||
|
"@types/ioredis": "^4.26.4",
|
||||||
|
"@types/jest": "^26.0.10",
|
||||||
|
"@types/jsbn": "^1.2.29",
|
||||||
|
"@types/node": "^14.6.0",
|
||||||
"@types/uuid": "^8.3.0",
|
"@types/uuid": "^8.3.0",
|
||||||
"barrelsby": "^2.8.1",
|
"@typescript-eslint/eslint-plugin": "^4.14.0",
|
||||||
"eslint": "^8.56.0",
|
"@typescript-eslint/parser": "^4.14.0",
|
||||||
"eslint-config-universe": "^13.0.0",
|
"barrelsby": "^2.2.0",
|
||||||
"eslint-plugin-tsdoc": "^0.3.0",
|
"eslint": "^7.7.0",
|
||||||
"ioredis": "^5.4.1",
|
"eslint-config-universe": "^7.0.0",
|
||||||
"jest": "^29.7.0",
|
"eslint-plugin-tsdoc": "^0.2.11",
|
||||||
"lerna": "^5.4.0",
|
"jest": "^26.6.3",
|
||||||
"lru-cache": "^6.0.0",
|
"lerna": "^4.0.0",
|
||||||
"nullthrows": "^1.1.1",
|
"nullthrows": "^1.1.1",
|
||||||
"pg": "8.12.0",
|
"pg": "^8.6.0",
|
||||||
"prettier": "^3.3.0",
|
"prettier": "^2.3.2",
|
||||||
"ts-jest": "^29.1.4",
|
"ts-jest": "~26.4.4",
|
||||||
"ts-mockito": "^2.6.1",
|
"ts-mockito": "^2.6.1",
|
||||||
"typedoc": "^0.25.13",
|
"typedoc": "^0.21.9",
|
||||||
"typescript": "^5.4.5",
|
"typescript": "^4.4.2",
|
||||||
"uuid": "^8.3.0"
|
"uuid": "^8.3.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
@@ -47,11 +47,7 @@
|
|||||||
"@expo/entity-cache-adapter-local-memory": "file:packages/entity-cache-adapter-local-memory",
|
"@expo/entity-cache-adapter-local-memory": "file:packages/entity-cache-adapter-local-memory",
|
||||||
"@expo/entity-cache-adapter-redis": "file:packages/entity-cache-adapter-redis",
|
"@expo/entity-cache-adapter-redis": "file:packages/entity-cache-adapter-redis",
|
||||||
"@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex",
|
"@expo/entity-database-adapter-knex": "file:packages/entity-database-adapter-knex",
|
||||||
"@expo/entity-ip-address-field": "file:packages/entity-ip-address-field",
|
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis",
|
||||||
"@expo/entity-secondary-cache-local-memory": "file:packages/entity-secondary-cache-local-memory",
|
"@expo/entity-ip-address-field": "file:packages/entity-ip-address-field"
|
||||||
"@expo/entity-secondary-cache-redis": "file:packages/entity-secondary-cache-redis"
|
|
||||||
},
|
|
||||||
"volta": {
|
|
||||||
"node": "20.14.0"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -3,166 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* constrain entity fields type to string-keyed object ([#235](https://github.com/expo/entity/issues/235)) ([7e2cea1](https://github.com/expo/entity/commit/7e2cea16973a0ae1917f867cd25d6ef7c8eaecef))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-cache-adapter-local-memory
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -3,26 +3,21 @@
|
|||||||
Cross-request [LRU](https://github.com/isaacs/node-lru-cache) cache adapter for `@expo/entity`. Use
|
Cross-request [LRU](https://github.com/isaacs/node-lru-cache) cache adapter for `@expo/entity`. Use
|
||||||
this cache with caution - it is nonstandard. The cache is shared between requests in the node process.
|
this cache with caution - it is nonstandard. The cache is shared between requests in the node process.
|
||||||
|
|
||||||
Note: This uses version 6.0.0 of `node-lru-cache` since it the most tuned version for our use case (low TTL + LRU). Upgrading
|
|
||||||
to 7.x will cause high memory usage for the entity cache adapter use case since it allocates fixed-size data structures up front to tune for the non-TTL use case: https://github.com/isaacs/node-lru-cache/issues/208.
|
|
||||||
|
|
||||||
[Documentation](https://expo.github.io/entity/modules/_expo_cache_adapter_local_memory.html)
|
|
||||||
|
|
||||||
## Why NOT use this cache
|
## Why NOT use this cache
|
||||||
|
|
||||||
Because this is an in-memory cache, cross-machine invalidation is not possible. Do not use this cache
|
Because this is an in-memory cache, cross-box invalidation is not possible. Do not use this cache
|
||||||
if you have the following use cases:
|
if you have the following use cases:
|
||||||
|
|
||||||
- The objects stored are mutable
|
- The objects stored have high mutability
|
||||||
- Reading a stale object from the cache is not acceptable in your application
|
- Reading a stale object from the cache is not acceptable in your application
|
||||||
- Cross-machine invalidation is not possible
|
- Cross-box invalidation is not possible
|
||||||
|
|
||||||
## Typical use cases
|
## Typical use cases
|
||||||
|
|
||||||
If your application sees many requests fetching the same objects, you can save a trip to your cache
|
If your application sees many requests fetching the same objects, you can save a trip to your cache
|
||||||
cluster and backing datastore by using this in-memory cache. Here are some good use cases:
|
cluster and backing datastore by using this in-memory cache. Here are some good use cases:
|
||||||
|
|
||||||
- The objects stored are mostly immutable, and reading a stale object for a short TTL is acceptable
|
- The objects stored are mostly immutable
|
||||||
- You have a low TTL setting in your cache
|
- You have a low TTL setting in your cache
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@expo/entity-cache-adapter-local-memory",
|
"name": "@expo/entity-cache-adapter-local-memory",
|
||||||
"version": "0.37.0",
|
"version": "0.24.0",
|
||||||
"description": "Cross-request local memory cache adapter for @expo/entity",
|
"description": "Cross-request local memory cache adapter for @expo/entity",
|
||||||
"files": [
|
"files": [
|
||||||
"build",
|
"build",
|
||||||
@@ -16,10 +16,10 @@
|
|||||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||||
"barrelsby": "barrelsby --config ../../.barrelsby.json"
|
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16"
|
"node": ">=12"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"entity"
|
"entity"
|
||||||
@@ -30,9 +30,9 @@
|
|||||||
"@expo/entity": "*"
|
"@expo/entity": "*"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"lru-cache": "^6.0.0"
|
"lru-cache": "^7.3.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@expo/entity": "^0.37.0"
|
"@expo/entity": "^0.24.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,10 +1,4 @@
|
|||||||
import {
|
import { CacheLoadResult, CacheStatus, IEntityGenericCacher } from '@expo/entity';
|
||||||
CacheLoadResult,
|
|
||||||
CacheStatus,
|
|
||||||
EntityConfiguration,
|
|
||||||
IEntityGenericCacher,
|
|
||||||
} from '@expo/entity';
|
|
||||||
import invariant from 'invariant';
|
|
||||||
import LRUCache from 'lru-cache';
|
import LRUCache from 'lru-cache';
|
||||||
|
|
||||||
// Sentinel value we store in local memory to negatively cache a database miss.
|
// Sentinel value we store in local memory to negatively cache a database miss.
|
||||||
@@ -13,25 +7,92 @@ export const DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = Symbol('doesNotExist');
|
|||||||
type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
|
type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
|
||||||
export type LocalMemoryCache<TFields> = LRUCache<string, LocalMemoryCacheValue<TFields>>;
|
export type LocalMemoryCache<TFields> = LRUCache<string, LocalMemoryCacheValue<TFields>>;
|
||||||
|
|
||||||
export default class GenericLocalMemoryCacher<TFields extends Record<string, any>>
|
type LRUCacheOptionsV7<K, V> = {
|
||||||
implements IEntityGenericCacher<TFields>
|
/**
|
||||||
{
|
* the number of most recently used items to keep.
|
||||||
constructor(
|
* note that we may store fewer items than this if maxSize is hit.
|
||||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
*/
|
||||||
private readonly localMemoryCache: LocalMemoryCache<TFields>,
|
max: number;
|
||||||
) {}
|
|
||||||
|
/**
|
||||||
|
* if you wish to track item size, you must provide a maxSize
|
||||||
|
* note that we still will only keep up to max *actual items*,
|
||||||
|
* so size tracking may cause fewer than max items to be stored.
|
||||||
|
* At the extreme, a single item of maxSize size will cause everything
|
||||||
|
* else in the cache to be dropped when it is added. Use with caution!
|
||||||
|
* Note also that size tracking can negatively impact performance,
|
||||||
|
* though for most cases, only minimally.
|
||||||
|
*/
|
||||||
|
|
||||||
|
maxSize?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* function to calculate size of items. useful if storing strings or
|
||||||
|
* buffers or other items where memory size depends on the object itself.
|
||||||
|
* also note that oversized items do NOT immediately get dropped from
|
||||||
|
* the cache, though they will cause faster turnover in the storage.
|
||||||
|
*/
|
||||||
|
sizeCalculation?: (value: V, key: K) => number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* function to call when the item is removed from the cache
|
||||||
|
* Note that using this can negatively impact performance.
|
||||||
|
*/
|
||||||
|
dispose?: (value: V, key: K) => void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* max time to live for items before they are considered stale
|
||||||
|
* note that stale items are NOT preemptively removed by default,
|
||||||
|
* and MAY live in the cache, contributing to its LRU max, long after
|
||||||
|
* they have expired.
|
||||||
|
* Also, as this cache is optimized for LRU/MRU operations, some of
|
||||||
|
* the staleness/TTL checks will reduce performance, as they will incur
|
||||||
|
* overhead by deleting items.
|
||||||
|
* Must be a positive integer in ms, defaults to 0, which means "no TTL"
|
||||||
|
*/
|
||||||
|
ttl?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* return stale items from cache.get() before disposing of them
|
||||||
|
* boolean, default false
|
||||||
|
*/
|
||||||
|
allowStale?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* update the age of items on cache.get(), renewing their TTL
|
||||||
|
* boolean, default false
|
||||||
|
*/
|
||||||
|
updateAgeOnGet?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* update the age of items on cache.has(), renewing their TTL
|
||||||
|
* boolean, default false
|
||||||
|
*/
|
||||||
|
updateAgeOnHas?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* update the "recently-used"-ness of items on cache.has()
|
||||||
|
* boolean, default false
|
||||||
|
*/
|
||||||
|
updateRecencyOnHas?: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default class GenericLocalMemoryCacher<TFields> implements IEntityGenericCacher<TFields> {
|
||||||
|
constructor(private readonly localMemoryCache: LocalMemoryCache<TFields>) {}
|
||||||
|
|
||||||
static createLRUCache<TFields>(
|
static createLRUCache<TFields>(
|
||||||
options: { maxSize?: number; ttlSeconds?: number } = {},
|
options: { maxSize?: number; ttlSeconds?: number } = {}
|
||||||
): LocalMemoryCache<TFields> {
|
): LocalMemoryCache<TFields> {
|
||||||
const DEFAULT_LRU_CACHE_MAX_AGE_SECONDS = 10;
|
const DEFAULT_LRU_CACHE_MAX_AGE_SECONDS = 10;
|
||||||
const DEFAULT_LRU_CACHE_SIZE = 10000;
|
const DEFAULT_LRU_CACHE_SIZE = 10000;
|
||||||
const maxAgeSeconds = options.ttlSeconds ?? DEFAULT_LRU_CACHE_MAX_AGE_SECONDS;
|
const maxAgeSeconds = options.ttlSeconds ?? DEFAULT_LRU_CACHE_MAX_AGE_SECONDS;
|
||||||
return new LRUCache<string, LocalMemoryCacheValue<TFields>>({
|
const lruCacheOptions: LRUCacheOptionsV7<string, TFields> = {
|
||||||
max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE,
|
max: options.maxSize ?? DEFAULT_LRU_CACHE_SIZE,
|
||||||
length: (value) => (value === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1),
|
sizeCalculation: (value: LocalMemoryCacheValue<TFields>) =>
|
||||||
maxAge: maxAgeSeconds * 1000, // convert to ms
|
value === DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1,
|
||||||
});
|
ttl: maxAgeSeconds * 1000, // convert to ms
|
||||||
|
};
|
||||||
|
return new LRUCache<string, LocalMemoryCacheValue<TFields>>(lruCacheOptions as any);
|
||||||
}
|
}
|
||||||
|
|
||||||
static createNoOpCache<TFields>(): LocalMemoryCache<TFields> {
|
static createNoOpCache<TFields>(): LocalMemoryCache<TFields> {
|
||||||
@@ -42,7 +103,7 @@ export default class GenericLocalMemoryCacher<TFields extends Record<string, any
|
|||||||
}
|
}
|
||||||
|
|
||||||
public async loadManyAsync(
|
public async loadManyAsync(
|
||||||
keys: readonly string[],
|
keys: readonly string[]
|
||||||
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
||||||
const cacheResults = new Map<string, CacheLoadResult<TFields>>();
|
const cacheResults = new Map<string, CacheLoadResult<TFields>>();
|
||||||
for (const key of keys) {
|
for (const key of keys) {
|
||||||
@@ -83,22 +144,10 @@ export default class GenericLocalMemoryCacher<TFields extends Record<string, any
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public makeCacheKey<N extends keyof TFields>(
|
public makeCacheKey(parts: string[]): string {
|
||||||
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 delimiter = ':';
|
||||||
const escapedParts = parts.map((part) =>
|
const escapedParts = parts.map((part) =>
|
||||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`),
|
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||||
);
|
);
|
||||||
return escapedParts.join(delimiter);
|
return escapedParts.join(delimiter);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,80 @@
|
|||||||
|
import { EntityCacheAdapter, CacheLoadResult, EntityConfiguration, mapKeys } from '@expo/entity';
|
||||||
|
import invariant from 'invariant';
|
||||||
|
|
||||||
|
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
|
||||||
|
|
||||||
|
export default class LocalMemoryCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
|
||||||
|
private readonly genericLocalMemoryCacher: GenericLocalMemoryCacher<TFields>;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
entityConfiguration: EntityConfiguration<TFields>,
|
||||||
|
localMemoryCache: LocalMemoryCache<TFields>
|
||||||
|
) {
|
||||||
|
super(entityConfiguration);
|
||||||
|
this.genericLocalMemoryCacher = new GenericLocalMemoryCacher(localMemoryCache);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async loadManyAsync<N extends keyof TFields>(
|
||||||
|
fieldName: N,
|
||||||
|
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||||
|
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>> {
|
||||||
|
const localMemoryCacheKeyToFieldValueMapping = new Map(
|
||||||
|
fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue])
|
||||||
|
);
|
||||||
|
const cacheResults = await this.genericLocalMemoryCacher.loadManyAsync(
|
||||||
|
Array.from(localMemoryCacheKeyToFieldValueMapping.keys())
|
||||||
|
);
|
||||||
|
|
||||||
|
return mapKeys(cacheResults, (cacheKey) => {
|
||||||
|
const fieldValue = localMemoryCacheKeyToFieldValueMapping.get(cacheKey);
|
||||||
|
invariant(
|
||||||
|
fieldValue !== undefined,
|
||||||
|
'Unspecified cache key %s returned from generic local memory cacher',
|
||||||
|
cacheKey
|
||||||
|
);
|
||||||
|
return fieldValue;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public async cacheManyAsync<N extends keyof TFields>(
|
||||||
|
fieldName: N,
|
||||||
|
objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>
|
||||||
|
): Promise<void> {
|
||||||
|
await this.genericLocalMemoryCacher.cacheManyAsync(
|
||||||
|
mapKeys(objectMap, (fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||||
|
fieldName: N,
|
||||||
|
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||||
|
): Promise<void> {
|
||||||
|
await this.genericLocalMemoryCacher.cacheDBMissesAsync(
|
||||||
|
fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async invalidateManyAsync<N extends keyof TFields>(
|
||||||
|
fieldName: N,
|
||||||
|
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||||
|
): Promise<void> {
|
||||||
|
await this.genericLocalMemoryCacher.invalidateManyAsync(
|
||||||
|
fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private makeCacheKey<N extends keyof TFields>(
|
||||||
|
fieldName: N,
|
||||||
|
fieldValue: NonNullable<TFields[N]>
|
||||||
|
): string {
|
||||||
|
const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
|
||||||
|
invariant(columnName, `database field mapping missing for ${fieldName}`);
|
||||||
|
const parts = [
|
||||||
|
this.entityConfiguration.tableName,
|
||||||
|
`${this.entityConfiguration.cacheKeyVersion}`,
|
||||||
|
columnName,
|
||||||
|
String(fieldValue),
|
||||||
|
];
|
||||||
|
return this.genericLocalMemoryCacher.makeCacheKey(parts);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,52 +1,45 @@
|
|||||||
import {
|
import {
|
||||||
computeIfAbsent,
|
computeIfAbsent,
|
||||||
IEntityCacheAdapter,
|
EntityCacheAdapter,
|
||||||
EntityConfiguration,
|
EntityConfiguration,
|
||||||
GenericEntityCacheAdapter,
|
|
||||||
IEntityCacheAdapterProvider,
|
IEntityCacheAdapterProvider,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
|
|
||||||
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
|
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
|
||||||
|
import LocalMemoryCacheAdapter from './LocalMemoryCacheAdapter';
|
||||||
|
|
||||||
/**
|
|
||||||
* Vends local memory cache adapters. An instance of this class may be shared across requests to
|
|
||||||
* share the local memory cache.
|
|
||||||
*/
|
|
||||||
export default class LocalMemoryCacheAdapterProvider implements IEntityCacheAdapterProvider {
|
export default class LocalMemoryCacheAdapterProvider implements IEntityCacheAdapterProvider {
|
||||||
/**
|
// local memory cache adapters should be shared/reused across requests
|
||||||
* @returns a no-op local memory cache adapter provider, or one that doesn't cache locally.
|
static localMemoryCacheAdapterMap = new Map<string, LocalMemoryCacheAdapter<any>>();
|
||||||
*/
|
|
||||||
static createNoOpProvider(): IEntityCacheAdapterProvider {
|
static getNoOpProvider(): IEntityCacheAdapterProvider {
|
||||||
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
|
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
|
||||||
GenericLocalMemoryCacher.createNoOpCache<TFields>(),
|
GenericLocalMemoryCacher.createNoOpCache<TFields>()
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
static getProvider(
|
||||||
* @returns a local memory cache adapter provider configured with the supplied options.
|
options: { maxSize?: number; ttlSeconds?: number } = {}
|
||||||
*/
|
|
||||||
static createProviderWithOptions(
|
|
||||||
options: { maxSize?: number; ttlSeconds?: number } = {},
|
|
||||||
): IEntityCacheAdapterProvider {
|
): IEntityCacheAdapterProvider {
|
||||||
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
|
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
|
||||||
GenericLocalMemoryCacher.createLRUCache<TFields>(options),
|
GenericLocalMemoryCacher.createLRUCache<TFields>(options)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
private localMemoryCacheAdapterMap = new Map<string, GenericEntityCacheAdapter<any>>();
|
|
||||||
|
|
||||||
private constructor(
|
private constructor(
|
||||||
private readonly localMemoryCacheCreator: <TFields>() => LocalMemoryCache<TFields>,
|
private readonly localMemoryCacheCreator: <TFields>() => LocalMemoryCache<TFields>
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public getCacheAdapter<TFields extends Record<string, any>>(
|
public getCacheAdapter<TFields>(
|
||||||
entityConfiguration: EntityConfiguration<TFields>,
|
entityConfiguration: EntityConfiguration<TFields>
|
||||||
): IEntityCacheAdapter<TFields> {
|
): EntityCacheAdapter<TFields> {
|
||||||
return computeIfAbsent(this.localMemoryCacheAdapterMap, entityConfiguration.tableName, () => {
|
return computeIfAbsent(
|
||||||
const localMemoryCache = this.localMemoryCacheCreator<TFields>();
|
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap,
|
||||||
return new GenericEntityCacheAdapter(
|
entityConfiguration.tableName,
|
||||||
new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache),
|
() => {
|
||||||
);
|
const localMemoryCache = this.localMemoryCacheCreator<TFields>();
|
||||||
});
|
return new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||||
|
}
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+180
@@ -0,0 +1,180 @@
|
|||||||
|
import { CacheStatus, ViewerContext } from '@expo/entity';
|
||||||
|
import { v4 as uuidv4 } from 'uuid';
|
||||||
|
|
||||||
|
import GenericLocalMemoryCacher from '../GenericLocalMemoryCacher';
|
||||||
|
import LocalMemoryCacheAdapter from '../LocalMemoryCacheAdapter';
|
||||||
|
import { LocalMemoryCacheAdapterProvider } from '../LocalMemoryCacheAdapterProvider';
|
||||||
|
import LocalMemoryTestEntity from '../testfixtures/LocalMemoryTestEntity';
|
||||||
|
import {
|
||||||
|
createLocalMemoryIntegrationTestEntityCompanionProvider,
|
||||||
|
createNoopLocalMemoryIntegrationTestEntityCompanionProvider,
|
||||||
|
} from '../testfixtures/createLocalMemoryIntegrationTestEntityCompanionProvider';
|
||||||
|
|
||||||
|
class TestViewerContext extends ViewerContext {}
|
||||||
|
|
||||||
|
describe(LocalMemoryCacheAdapter, () => {
|
||||||
|
beforeEach(async () => {
|
||||||
|
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.clear();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('has correct caching behavior', async () => {
|
||||||
|
const viewerContext = new TestViewerContext(
|
||||||
|
createLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||||
|
);
|
||||||
|
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||||
|
LocalMemoryTestEntity,
|
||||||
|
LocalMemoryTestEntity.getCompanionDefinition()
|
||||||
|
)['tableDataCoordinator']['cacheAdapter'];
|
||||||
|
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||||
|
|
||||||
|
const date = new Date();
|
||||||
|
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||||
|
.setField('name', 'blah')
|
||||||
|
.setField('dateField', date)
|
||||||
|
.enforceCreateAsync();
|
||||||
|
|
||||||
|
// loading an entity should put it in cache
|
||||||
|
const entity1 = await LocalMemoryTestEntity.loader(viewerContext)
|
||||||
|
.enforcing()
|
||||||
|
.loadByIDAsync(entity1Created.getID());
|
||||||
|
|
||||||
|
const entitySpecificGenericCacher =
|
||||||
|
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
|
||||||
|
LocalMemoryTestEntity.getCompanionDefinition().entityConfiguration.tableName
|
||||||
|
)!['genericLocalMemoryCacher'];
|
||||||
|
const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||||
|
cacheKeyMaker('id', entity1.getID()),
|
||||||
|
]);
|
||||||
|
const cachedValue = cachedResult.get(cacheKeyMaker('id', entity1.getID()))!;
|
||||||
|
expect(cachedValue).toMatchObject({
|
||||||
|
status: CacheStatus.HIT,
|
||||||
|
item: {
|
||||||
|
id: entity1.getID(),
|
||||||
|
name: 'blah',
|
||||||
|
dateField: date,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// simulate non existent db fetch, should write negative result ('') to cache
|
||||||
|
const nonExistentId = uuidv4();
|
||||||
|
|
||||||
|
const entityNonExistentResult = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||||
|
nonExistentId
|
||||||
|
);
|
||||||
|
expect(entityNonExistentResult.ok).toBe(false);
|
||||||
|
|
||||||
|
const nonExistentCachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||||
|
cacheKeyMaker('id', nonExistentId),
|
||||||
|
]);
|
||||||
|
expect(nonExistentCachedResult.get(cacheKeyMaker('id', nonExistentId))).toMatchObject({
|
||||||
|
status: CacheStatus.NEGATIVE,
|
||||||
|
});
|
||||||
|
|
||||||
|
// load again through entities framework to ensure it reads negative result
|
||||||
|
const entityNonExistentResult2 = await LocalMemoryTestEntity.loader(
|
||||||
|
viewerContext
|
||||||
|
).loadByIDAsync(nonExistentId);
|
||||||
|
expect(entityNonExistentResult2.ok).toBe(false);
|
||||||
|
|
||||||
|
// invalidate from cache to ensure it invalidates correctly
|
||||||
|
await LocalMemoryTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
|
||||||
|
const cachedResultMiss = await entitySpecificGenericCacher.loadManyAsync([
|
||||||
|
cacheKeyMaker('id', entity1.getID()),
|
||||||
|
]);
|
||||||
|
const cachedValueMiss = cachedResultMiss.get(cacheKeyMaker('id', entity1.getID()));
|
||||||
|
expect(cachedValueMiss).toMatchObject({ status: CacheStatus.MISS });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('shares the cache between different requests', async () => {
|
||||||
|
const genericLocalMemoryCacherLoadManySpy = jest.spyOn(
|
||||||
|
GenericLocalMemoryCacher.prototype as unknown as any,
|
||||||
|
'loadManyAsync'
|
||||||
|
);
|
||||||
|
const viewerContext = new TestViewerContext(
|
||||||
|
createLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||||
|
);
|
||||||
|
|
||||||
|
const date = new Date();
|
||||||
|
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||||
|
.setField('name', 'blah')
|
||||||
|
.setField('dateField', date)
|
||||||
|
.enforceCreateAsync();
|
||||||
|
|
||||||
|
// loading an entity should put it in cache
|
||||||
|
await LocalMemoryTestEntity.loader(viewerContext)
|
||||||
|
.enforcing()
|
||||||
|
.loadByIDAsync(entity1Created.getID());
|
||||||
|
|
||||||
|
// load entity with a different request
|
||||||
|
const viewerContext2 = new TestViewerContext(
|
||||||
|
createLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||||
|
);
|
||||||
|
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2)
|
||||||
|
.enforcing()
|
||||||
|
.loadByIDAsync(entity1Created.getID());
|
||||||
|
|
||||||
|
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||||
|
LocalMemoryTestEntity,
|
||||||
|
LocalMemoryTestEntity.getCompanionDefinition()
|
||||||
|
)['tableDataCoordinator']['cacheAdapter'];
|
||||||
|
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||||
|
expect(entity1WithVc2.getAllFields()).toMatchObject({
|
||||||
|
id: entity1WithVc2.getID(),
|
||||||
|
name: 'blah',
|
||||||
|
dateField: date,
|
||||||
|
});
|
||||||
|
expect(genericLocalMemoryCacherLoadManySpy).toBeCalledWith([
|
||||||
|
cacheKeyMaker('id', entity1WithVc2.getID()),
|
||||||
|
]);
|
||||||
|
expect(genericLocalMemoryCacherLoadManySpy).toBeCalledTimes(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('respects the parameters of a noop cache', async () => {
|
||||||
|
const viewerContext = new TestViewerContext(
|
||||||
|
createNoopLocalMemoryIntegrationTestEntityCompanionProvider()
|
||||||
|
);
|
||||||
|
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||||
|
LocalMemoryTestEntity,
|
||||||
|
LocalMemoryTestEntity.getCompanionDefinition()
|
||||||
|
)['tableDataCoordinator']['cacheAdapter'];
|
||||||
|
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||||
|
|
||||||
|
const date = new Date();
|
||||||
|
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
|
||||||
|
.setField('name', 'blah')
|
||||||
|
.setField('dateField', date)
|
||||||
|
.enforceCreateAsync();
|
||||||
|
|
||||||
|
// loading an entity will try to put it in cache but it's a noop cache, so it should be a miss
|
||||||
|
const entity1 = await LocalMemoryTestEntity.loader(viewerContext)
|
||||||
|
.enforcing()
|
||||||
|
.loadByIDAsync(entity1Created.getID());
|
||||||
|
|
||||||
|
const entitySpecificGenericCacher =
|
||||||
|
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(
|
||||||
|
LocalMemoryTestEntity.getCompanionDefinition().entityConfiguration.tableName
|
||||||
|
)!['genericLocalMemoryCacher'];
|
||||||
|
const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||||
|
cacheKeyMaker('id', entity1.getID()),
|
||||||
|
]);
|
||||||
|
const cachedValue = cachedResult.get(cacheKeyMaker('id', entity1.getID()))!;
|
||||||
|
expect(cachedValue).toMatchObject({
|
||||||
|
status: CacheStatus.MISS,
|
||||||
|
});
|
||||||
|
|
||||||
|
// a non existent db fetch should try to write negative result ('') but it's a noop cache, so it should be a miss
|
||||||
|
const nonExistentId = uuidv4();
|
||||||
|
|
||||||
|
const entityNonExistentResult = await LocalMemoryTestEntity.loader(viewerContext).loadByIDAsync(
|
||||||
|
nonExistentId
|
||||||
|
);
|
||||||
|
expect(entityNonExistentResult.ok).toBe(false);
|
||||||
|
|
||||||
|
const nonExistentCachedResult = await entitySpecificGenericCacher.loadManyAsync([
|
||||||
|
cacheKeyMaker('id', nonExistentId),
|
||||||
|
]);
|
||||||
|
expect(nonExistentCachedResult.get(cacheKeyMaker('id', nonExistentId))).toMatchObject({
|
||||||
|
status: CacheStatus.MISS,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
-150
@@ -1,150 +0,0 @@
|
|||||||
import {
|
|
||||||
CacheAdapterFlavor,
|
|
||||||
CacheAdapterFlavorDefinition,
|
|
||||||
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, () => {
|
|
||||||
it('has correct caching behavior', async () => {
|
|
||||||
const entityCompanionProvider = createLocalMemoryTestEntityCompanionProvider();
|
|
||||||
const viewerContext = new ViewerContext(entityCompanionProvider);
|
|
||||||
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 localMemoryCacheAdapterProvider = (
|
|
||||||
entityCompanionProvider['cacheAdapterFlavors'] as ReadonlyMap<
|
|
||||||
CacheAdapterFlavor,
|
|
||||||
CacheAdapterFlavorDefinition
|
|
||||||
>
|
|
||||||
).get('local-memory')!.cacheAdapterProvider as LocalMemoryCacheAdapterProvider;
|
|
||||||
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)
|
|
||||||
.withAuthorizationResults()
|
|
||||||
.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)
|
|
||||||
.withAuthorizationResults()
|
|
||||||
.loadByIDAsync(nonExistentId);
|
|
||||||
expect(entityNonExistentResult2.ok).toBe(false);
|
|
||||||
|
|
||||||
// invalidate from cache to ensure it invalidates correctly
|
|
||||||
await LocalMemoryTestEntity.loader(viewerContext)
|
|
||||||
.utils()
|
|
||||||
.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('respects the parameters of a noop cache', async () => {
|
|
||||||
const entityCompanionProvider = createNoOpLocalMemoryIntegrationTestEntityCompanionProvider();
|
|
||||||
const viewerContext = new ViewerContext(entityCompanionProvider);
|
|
||||||
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 localMemoryCacheAdapterProvider = (
|
|
||||||
entityCompanionProvider['cacheAdapterFlavors'] as ReadonlyMap<
|
|
||||||
CacheAdapterFlavor,
|
|
||||||
CacheAdapterFlavorDefinition
|
|
||||||
>
|
|
||||||
).get('local-memory')!.cacheAdapterProvider as LocalMemoryCacheAdapterProvider;
|
|
||||||
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)
|
|
||||||
.withAuthorizationResults()
|
|
||||||
.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,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
+38
-61
@@ -1,13 +1,9 @@
|
|||||||
import {
|
import { CacheStatus, UUIDField, EntityConfiguration } from '@expo/entity';
|
||||||
CacheStatus,
|
|
||||||
UUIDField,
|
|
||||||
EntityConfiguration,
|
|
||||||
GenericEntityCacheAdapter,
|
|
||||||
} from '@expo/entity';
|
|
||||||
|
|
||||||
import GenericLocalMemoryCacher, {
|
import GenericLocalMemoryCacher, {
|
||||||
DOES_NOT_EXIST_LOCAL_MEMORY_CACHE,
|
DOES_NOT_EXIST_LOCAL_MEMORY_CACHE,
|
||||||
} from '../GenericLocalMemoryCacher';
|
} from '../GenericLocalMemoryCacher';
|
||||||
|
import LocalMemoryCacheAdapter from '../LocalMemoryCacheAdapter';
|
||||||
|
|
||||||
type BlahFields = {
|
type BlahFields = {
|
||||||
id: string;
|
id: string;
|
||||||
@@ -23,41 +19,15 @@ const entityConfiguration = new EntityConfiguration<BlahFields>({
|
|||||||
cacheAdapterFlavor: 'local-memory',
|
cacheAdapterFlavor: 'local-memory',
|
||||||
});
|
});
|
||||||
|
|
||||||
describe(GenericLocalMemoryCacher, () => {
|
describe(LocalMemoryCacheAdapter, () => {
|
||||||
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', () => {
|
describe('loadManyAsync', () => {
|
||||||
it('returns appropriate cache results', async () => {
|
it('returns appropriate cache results', async () => {
|
||||||
const cacheAdapter = new GenericEntityCacheAdapter(
|
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||||
new GenericLocalMemoryCacher(
|
entityConfiguration,
|
||||||
entityConfiguration,
|
GenericLocalMemoryCacher.createLRUCache({
|
||||||
GenericLocalMemoryCacher.createLRUCache(),
|
maxSize: Number.MAX_SAFE_INTEGER,
|
||||||
),
|
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
|
const cacheHits = new Map<string, Readonly<BlahFields>>([['test-id-1', { id: 'test-id-1' }]]);
|
||||||
@@ -80,11 +50,12 @@ describe('Use within GenericEntityCacheAdapter', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('returns empty map when passed empty array of fieldValues', async () => {
|
it('returns empty map when passed empty array of fieldValues', async () => {
|
||||||
const cacheAdapter = new GenericEntityCacheAdapter(
|
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||||
new GenericLocalMemoryCacher(
|
entityConfiguration,
|
||||||
entityConfiguration,
|
GenericLocalMemoryCacher.createLRUCache({
|
||||||
GenericLocalMemoryCacher.createLRUCache(),
|
maxSize: Number.MAX_SAFE_INTEGER,
|
||||||
),
|
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
const results = await cacheAdapter.loadManyAsync('id', []);
|
const results = await cacheAdapter.loadManyAsync('id', []);
|
||||||
expect(results).toEqual(new Map());
|
expect(results).toEqual(new Map());
|
||||||
@@ -93,13 +64,15 @@ describe('Use within GenericEntityCacheAdapter', () => {
|
|||||||
|
|
||||||
describe('cacheManyAsync', () => {
|
describe('cacheManyAsync', () => {
|
||||||
it('correctly caches all objects', async () => {
|
it('correctly caches all objects', async () => {
|
||||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({
|
||||||
|
maxSize: Number.MAX_SAFE_INTEGER,
|
||||||
|
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||||
|
});
|
||||||
|
|
||||||
const localMemoryCacher = new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache);
|
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||||
const cacheAdapter = new GenericEntityCacheAdapter(localMemoryCacher);
|
|
||||||
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
||||||
|
|
||||||
const cacheKey = localMemoryCacher['makeCacheKey']('id', 'test-id-1');
|
const cacheKey = cacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||||
expect(localMemoryCache.get(cacheKey)).toMatchObject({
|
expect(localMemoryCache.get(cacheKey)).toMatchObject({
|
||||||
id: 'test-id-1',
|
id: 'test-id-1',
|
||||||
});
|
});
|
||||||
@@ -108,24 +81,27 @@ describe('Use within GenericEntityCacheAdapter', () => {
|
|||||||
|
|
||||||
describe('cacheDBMissesAsync', () => {
|
describe('cacheDBMissesAsync', () => {
|
||||||
it('correctly caches misses', async () => {
|
it('correctly caches misses', async () => {
|
||||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({
|
||||||
|
maxSize: Number.MAX_SAFE_INTEGER,
|
||||||
|
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||||
|
});
|
||||||
|
|
||||||
const localMemoryCacher = new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache);
|
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||||
const cacheAdapter = new GenericEntityCacheAdapter(localMemoryCacher);
|
|
||||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']);
|
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']);
|
||||||
|
|
||||||
const cacheKey = localMemoryCacher['makeCacheKey']('id', 'test-id-1');
|
const cacheKey = cacheAdapter['makeCacheKey']('id', 'test-id-1');
|
||||||
expect(localMemoryCache.get(cacheKey)).toEqual(DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
expect(localMemoryCache.get(cacheKey)).toEqual(DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('invalidateManyAsync', () => {
|
describe('invalidateManyAsync', () => {
|
||||||
it('invalidates correctly', async () => {
|
it('invalidates correctly', async () => {
|
||||||
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({});
|
const localMemoryCache = GenericLocalMemoryCacher.createLRUCache<BlahFields>({
|
||||||
|
maxSize: Number.MAX_SAFE_INTEGER,
|
||||||
|
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||||
|
});
|
||||||
|
|
||||||
const cacheAdapter = new GenericEntityCacheAdapter(
|
const cacheAdapter = new LocalMemoryCacheAdapter(entityConfiguration, localMemoryCache);
|
||||||
new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache),
|
|
||||||
);
|
|
||||||
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
|
||||||
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
|
||||||
await cacheAdapter.invalidateManyAsync('id', ['test-id-1', 'test-id-2']);
|
await cacheAdapter.invalidateManyAsync('id', ['test-id-1', 'test-id-2']);
|
||||||
@@ -136,11 +112,12 @@ describe('Use within GenericEntityCacheAdapter', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('returns when passed empty array of fieldValues', async () => {
|
it('returns when passed empty array of fieldValues', async () => {
|
||||||
const cacheAdapter = new GenericEntityCacheAdapter(
|
const cacheAdapter = new LocalMemoryCacheAdapter(
|
||||||
new GenericLocalMemoryCacher(
|
entityConfiguration,
|
||||||
entityConfiguration,
|
GenericLocalMemoryCacher.createLRUCache<BlahFields>({
|
||||||
GenericLocalMemoryCacher.createLRUCache<BlahFields>({}),
|
maxSize: Number.MAX_SAFE_INTEGER,
|
||||||
),
|
ttlSeconds: Number.MAX_SAFE_INTEGER,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
await cacheAdapter.invalidateManyAsync('id', []);
|
await cacheAdapter.invalidateManyAsync('id', []);
|
||||||
});
|
});
|
||||||
@@ -4,6 +4,7 @@
|
|||||||
* @module @expo/entity-cache-adapter-local-memory
|
* @module @expo/entity-cache-adapter-local-memory
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
export { default as LocalMemoryCacheAdapter } from './LocalMemoryCacheAdapter';
|
||||||
|
export { default as LocalMemoryCacheAdapterProvider } from './LocalMemoryCacheAdapterProvider';
|
||||||
export { default as GenericLocalMemoryCacher } from './GenericLocalMemoryCacher';
|
export { default as GenericLocalMemoryCacher } from './GenericLocalMemoryCacher';
|
||||||
export * from './GenericLocalMemoryCacher';
|
export * from './GenericLocalMemoryCacher';
|
||||||
export { default as LocalMemoryCacheAdapterProvider } from './LocalMemoryCacheAdapterProvider';
|
|
||||||
+8
-6
@@ -21,18 +21,14 @@ export default class LocalMemoryTestEntity extends Entity<
|
|||||||
string,
|
string,
|
||||||
ViewerContext
|
ViewerContext
|
||||||
> {
|
> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
LocalMemoryTestEntityFields,
|
LocalMemoryTestEntityFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
LocalMemoryTestEntity,
|
LocalMemoryTestEntity,
|
||||||
LocalMemoryTestEntityPrivacyPolicy
|
LocalMemoryTestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return localMemoryTestEntityCompanionDefinition;
|
||||||
entityClass: LocalMemoryTestEntity,
|
|
||||||
entityConfiguration: localMemoryTestEntityConfiguration,
|
|
||||||
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -96,3 +92,9 @@ export const localMemoryTestEntityConfiguration =
|
|||||||
databaseAdapterFlavor: 'postgres',
|
databaseAdapterFlavor: 'postgres',
|
||||||
cacheAdapterFlavor: 'local-memory',
|
cacheAdapterFlavor: 'local-memory',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const localMemoryTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||||
|
entityClass: LocalMemoryTestEntity,
|
||||||
|
entityConfiguration: localMemoryTestEntityConfiguration,
|
||||||
|
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
|
||||||
|
});
|
||||||
+10
-10
@@ -6,16 +6,16 @@ import {
|
|||||||
StubDatabaseAdapterProvider,
|
StubDatabaseAdapterProvider,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
|
|
||||||
import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider';
|
import { LocalMemoryCacheAdapterProvider } from '../LocalMemoryCacheAdapterProvider';
|
||||||
|
|
||||||
export const createLocalMemoryTestEntityCompanionProvider = (
|
export const createLocalMemoryIntegrationTestEntityCompanionProvider = (
|
||||||
localMemoryOptions: { maxSize?: number; ttlSeconds?: number } = {},
|
localMemoryOptions: { maxSize?: number; ttlSeconds?: number } = {},
|
||||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
|
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||||
): EntityCompanionProvider => {
|
): EntityCompanionProvider => {
|
||||||
const localMemoryCacheAdapterProvider =
|
const localMemoryCacheAdapterProvider =
|
||||||
localMemoryOptions.maxSize === 0 && localMemoryOptions.ttlSeconds === 0
|
localMemoryOptions.maxSize === 0 && localMemoryOptions.ttlSeconds === 0
|
||||||
? LocalMemoryCacheAdapterProvider.createNoOpProvider()
|
? LocalMemoryCacheAdapterProvider.getNoOpProvider()
|
||||||
: LocalMemoryCacheAdapterProvider.createProviderWithOptions(localMemoryOptions);
|
: LocalMemoryCacheAdapterProvider.getProvider(localMemoryOptions);
|
||||||
return new EntityCompanionProvider(
|
return new EntityCompanionProvider(
|
||||||
metricsAdapter,
|
metricsAdapter,
|
||||||
new Map([
|
new Map([
|
||||||
@@ -34,15 +34,15 @@ export const createLocalMemoryTestEntityCompanionProvider = (
|
|||||||
cacheAdapterProvider: localMemoryCacheAdapterProvider,
|
cacheAdapterProvider: localMemoryCacheAdapterProvider,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
]),
|
])
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const createNoOpLocalMemoryIntegrationTestEntityCompanionProvider = (
|
export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = (
|
||||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
|
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||||
): EntityCompanionProvider => {
|
): EntityCompanionProvider => {
|
||||||
return createLocalMemoryTestEntityCompanionProvider(
|
return createLocalMemoryIntegrationTestEntityCompanionProvider(
|
||||||
{ maxSize: 0, ttlSeconds: 0 },
|
{ maxSize: 0, ttlSeconds: 0 },
|
||||||
metricsAdapter,
|
metricsAdapter
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -3,169 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* constrain entity fields type to string-keyed object ([#235](https://github.com/expo/entity/issues/235)) ([7e2cea1](https://github.com/expo/entity/commit/7e2cea16973a0ae1917f867cd25d6ef7c8eaecef))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-cache-adapter-redis
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
### Chores
|
### Chores
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ During `EntityCompanionProvider` instantiation:
|
|||||||
```typescript
|
```typescript
|
||||||
import Redis from 'ioredis';
|
import Redis from 'ioredis';
|
||||||
|
|
||||||
const genericRedisCacherContext = {
|
const redisCacheAdapterContext = {
|
||||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||||
makeKeyFn(...parts: string[]): string {
|
makeKeyFn(...parts: string[]): string {
|
||||||
const delimiter = ':';
|
const delimiter = ':';
|
||||||
@@ -21,6 +21,7 @@ const genericRedisCacherContext = {
|
|||||||
return escapedParts.join(delimiter);
|
return escapedParts.join(delimiter);
|
||||||
},
|
},
|
||||||
cacheKeyPrefix: 'ent-',
|
cacheKeyPrefix: 'ent-',
|
||||||
|
cacheKeyVersion: 1,
|
||||||
ttlSecondsPositive: 86400, // 1 day
|
ttlSecondsPositive: 86400, // 1 day
|
||||||
ttlSecondsNegative: 600, // 10 minutes
|
ttlSecondsNegative: 600, // 10 minutes
|
||||||
};
|
};
|
||||||
@@ -35,7 +36,7 @@ export const createDefaultEntityCompanionProvider = (
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
['redis']: {
|
['redis']: {
|
||||||
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
|
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@expo/entity-cache-adapter-redis",
|
"name": "@expo/entity-cache-adapter-redis",
|
||||||
"version": "0.37.0",
|
"version": "0.24.0",
|
||||||
"description": "Redis cache adapter for @expo/entity",
|
"description": "Redis cache adapter for @expo/entity",
|
||||||
"files": [
|
"files": [
|
||||||
"build",
|
"build",
|
||||||
@@ -16,10 +16,10 @@
|
|||||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||||
"barrelsby": "barrelsby --config ../../.barrelsby.json"
|
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16"
|
"node": ">=12"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"entity"
|
"entity"
|
||||||
@@ -27,11 +27,12 @@
|
|||||||
"author": "Expo",
|
"author": "Expo",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@expo/entity": "*",
|
"@expo/entity": "*"
|
||||||
"ioredis": ">=5"
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"ioredis": "^4.27.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@expo/entity": "^0.37.0",
|
"@expo/entity": "^0.24.0"
|
||||||
"ioredis": "^5.2.5"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -6,7 +6,7 @@ import {
|
|||||||
transformFieldsToCacheObject,
|
transformFieldsToCacheObject,
|
||||||
IEntityGenericCacher,
|
IEntityGenericCacher,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
import invariant from 'invariant';
|
import { Redis } from 'ioredis';
|
||||||
|
|
||||||
import { redisTransformerMap } from './RedisCommon';
|
import { redisTransformerMap } from './RedisCommon';
|
||||||
import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
|
import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
|
||||||
@@ -15,34 +15,11 @@ import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
|
|||||||
// The sentinel value is distinct from any (positively) cached value.
|
// The sentinel value is distinct from any (positively) cached value.
|
||||||
const DOES_NOT_EXIST_REDIS = '';
|
const DOES_NOT_EXIST_REDIS = '';
|
||||||
|
|
||||||
export interface IRedisTransaction {
|
|
||||||
set(key: string, value: string, secondsToken: 'EX', seconds: number): this;
|
|
||||||
exec(): Promise<any>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface IRedis {
|
|
||||||
mget(...args: [...keys: string[]]): Promise<(string | null)[]>;
|
|
||||||
multi(): IRedisTransaction;
|
|
||||||
del(...args: [...keys: string[]]): Promise<any>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface GenericRedisCacheContext {
|
export interface GenericRedisCacheContext {
|
||||||
/**
|
/**
|
||||||
* Instance of ioredis.Redis
|
* Instance of ioredis.Redis
|
||||||
*/
|
*/
|
||||||
redisClient: IRedis;
|
redisClient: Redis;
|
||||||
|
|
||||||
/**
|
|
||||||
* 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;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* TTL for caching database hits. Successive entity loads within this TTL
|
* TTL for caching database hits. Successive entity loads within this TTL
|
||||||
@@ -57,23 +34,21 @@ export interface GenericRedisCacheContext {
|
|||||||
ttlSecondsNegative: number;
|
ttlSecondsNegative: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default class GenericRedisCacher<TFields extends Record<string, any>>
|
export default class GenericRedisCacher<TFields> implements IEntityGenericCacher<TFields> {
|
||||||
implements IEntityGenericCacher<TFields>
|
|
||||||
{
|
|
||||||
constructor(
|
constructor(
|
||||||
private readonly context: GenericRedisCacheContext,
|
private readonly context: GenericRedisCacheContext,
|
||||||
private readonly entityConfiguration: EntityConfiguration<TFields>,
|
private readonly entityConfiguration: EntityConfiguration<TFields>
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public async loadManyAsync(
|
public async loadManyAsync(
|
||||||
keys: readonly string[],
|
keys: readonly string[]
|
||||||
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
|
||||||
if (keys.length === 0) {
|
if (keys.length === 0) {
|
||||||
return new Map();
|
return new Map();
|
||||||
}
|
}
|
||||||
|
|
||||||
const redisResults = await wrapNativeRedisCallAsync(() =>
|
const redisResults = await wrapNativeRedisCallAsync(() =>
|
||||||
this.context.redisClient.mget(...keys),
|
this.context.redisClient.mget(...keys)
|
||||||
);
|
);
|
||||||
|
|
||||||
const results = new Map<string, CacheLoadResult<TFields>>();
|
const results = new Map<string, CacheLoadResult<TFields>>();
|
||||||
@@ -91,7 +66,7 @@ export default class GenericRedisCacher<TFields extends Record<string, any>>
|
|||||||
item: transformCacheObjectToFields(
|
item: transformCacheObjectToFields(
|
||||||
this.entityConfiguration,
|
this.entityConfiguration,
|
||||||
redisTransformerMap,
|
redisTransformerMap,
|
||||||
JSON.parse(redisResult),
|
JSON.parse(redisResult)
|
||||||
),
|
),
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
@@ -113,10 +88,10 @@ export default class GenericRedisCacher<TFields extends Record<string, any>>
|
|||||||
redisTransaction = redisTransaction.set(
|
redisTransaction = redisTransaction.set(
|
||||||
key,
|
key,
|
||||||
JSON.stringify(
|
JSON.stringify(
|
||||||
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object),
|
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
|
||||||
),
|
),
|
||||||
'EX',
|
'EX',
|
||||||
this.context.ttlSecondsPositive,
|
this.context.ttlSecondsPositive
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
||||||
@@ -133,7 +108,7 @@ export default class GenericRedisCacher<TFields extends Record<string, any>>
|
|||||||
key,
|
key,
|
||||||
DOES_NOT_EXIST_REDIS,
|
DOES_NOT_EXIST_REDIS,
|
||||||
'EX',
|
'EX',
|
||||||
this.context.ttlSecondsNegative,
|
this.context.ttlSecondsNegative
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
|
||||||
@@ -146,19 +121,4 @@ export default class GenericRedisCacher<TFields extends Record<string, any>>
|
|||||||
|
|
||||||
await wrapNativeRedisCallAsync(() => this.context.redisClient.del(...keys));
|
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,125 @@
|
|||||||
|
import { EntityCacheAdapter, EntityConfiguration, CacheLoadResult, mapKeys } from '@expo/entity';
|
||||||
|
import invariant from 'invariant';
|
||||||
|
import { Redis } from 'ioredis';
|
||||||
|
|
||||||
|
import GenericRedisCacher from './GenericRedisCacher';
|
||||||
|
|
||||||
|
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> {
|
||||||
|
private readonly genericRedisCacher: GenericRedisCacher<TFields>;
|
||||||
|
constructor(
|
||||||
|
entityConfiguration: EntityConfiguration<TFields>,
|
||||||
|
private readonly context: RedisCacheAdapterContext
|
||||||
|
) {
|
||||||
|
super(entityConfiguration);
|
||||||
|
|
||||||
|
this.genericRedisCacher = new GenericRedisCacher(
|
||||||
|
{
|
||||||
|
redisClient: context.redisClient,
|
||||||
|
ttlSecondsNegative: context.ttlSecondsNegative,
|
||||||
|
ttlSecondsPositive: context.ttlSecondsPositive,
|
||||||
|
},
|
||||||
|
entityConfiguration
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async loadManyAsync<N extends keyof TFields>(
|
||||||
|
fieldName: N,
|
||||||
|
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||||
|
): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>> {
|
||||||
|
const redisCacheKeyToFieldValueMapping = new Map(
|
||||||
|
fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue])
|
||||||
|
);
|
||||||
|
const cacheResults = await this.genericRedisCacher.loadManyAsync(
|
||||||
|
Array.from(redisCacheKeyToFieldValueMapping.keys())
|
||||||
|
);
|
||||||
|
|
||||||
|
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]>, Readonly<TFields>>
|
||||||
|
): Promise<void> {
|
||||||
|
await this.genericRedisCacher.cacheManyAsync(
|
||||||
|
mapKeys(objectMap, (fieldValue) => this.makeCacheKey(fieldName, fieldValue))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async cacheDBMissesAsync<N extends keyof TFields>(
|
||||||
|
fieldName: N,
|
||||||
|
fieldValues: readonly NonNullable<TFields[N]>[]
|
||||||
|
): Promise<void> {
|
||||||
|
await this.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 {
|
import { IEntityCacheAdapterProvider, EntityConfiguration, EntityCacheAdapter } from '@expo/entity';
|
||||||
IEntityCacheAdapterProvider,
|
|
||||||
EntityConfiguration,
|
|
||||||
IEntityCacheAdapter,
|
|
||||||
GenericEntityCacheAdapter,
|
|
||||||
} from '@expo/entity';
|
|
||||||
|
|
||||||
import GenericRedisCacher, { GenericRedisCacheContext } from './GenericRedisCacher';
|
import RedisCacheAdapter, { RedisCacheAdapterContext } from './RedisCacheAdapter';
|
||||||
|
|
||||||
export default class RedisCacheAdapterProvider implements IEntityCacheAdapterProvider {
|
export default class RedisCacheAdapterProvider implements IEntityCacheAdapterProvider {
|
||||||
constructor(private readonly context: GenericRedisCacheContext) {}
|
constructor(private readonly context: RedisCacheAdapterContext) {}
|
||||||
|
|
||||||
getCacheAdapter<TFields extends Record<string, any>>(
|
getCacheAdapter<TFields>(
|
||||||
entityConfiguration: EntityConfiguration<TFields>,
|
entityConfiguration: EntityConfiguration<TFields>
|
||||||
): IEntityCacheAdapter<TFields> {
|
): EntityCacheAdapter<TFields> {
|
||||||
return new GenericEntityCacheAdapter(new GenericRedisCacher(this.context, entityConfiguration));
|
return new RedisCacheAdapter(entityConfiguration, this.context);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
-170
@@ -1,170 +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;
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
||||||
async mget(...args: string[]): Promise<(string | null)[]> {
|
|
||||||
return await this.mgetBatcher.batchAsync(args);
|
|
||||||
}
|
|
||||||
|
|
||||||
multi(): IRedisTransaction {
|
|
||||||
return this.redis.multi();
|
|
||||||
}
|
|
||||||
|
|
||||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
||||||
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)
|
|
||||||
.withAuthorizationResults()
|
|
||||||
.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)
|
|
||||||
.withAuthorizationResults()
|
|
||||||
.loadByIDAsync(nonExistentId);
|
|
||||||
expect(entityNonExistentResult2.ok).toBe(false);
|
|
||||||
|
|
||||||
// invalidate from cache to ensure it invalidates correctly in both caches
|
|
||||||
await RedisTestEntity.loader(viewerContext)
|
|
||||||
.utils()
|
|
||||||
.invalidateFieldsAsync(entity1.getAllFields());
|
|
||||||
await expect(redis.get(cacheKeyEntity1)).resolves.toBeNull();
|
|
||||||
await expect(redis.get(cacheKeyEntity1NameField)).resolves.toBeNull();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
+29
-15
@@ -2,7 +2,8 @@ import { CacheStatus, ViewerContext } from '@expo/entity';
|
|||||||
import Redis from 'ioredis';
|
import Redis from 'ioredis';
|
||||||
import { URL } from 'url';
|
import { URL } from 'url';
|
||||||
|
|
||||||
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
|
import GenericRedisCacher from '../GenericRedisCacher';
|
||||||
|
import { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||||
import RedisTestEntity, {
|
import RedisTestEntity, {
|
||||||
redisTestEntityConfiguration,
|
redisTestEntityConfiguration,
|
||||||
RedisTestEntityFields,
|
RedisTestEntityFields,
|
||||||
@@ -12,38 +13,43 @@ import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtur
|
|||||||
class TestViewerContext extends ViewerContext {}
|
class TestViewerContext extends ViewerContext {}
|
||||||
|
|
||||||
describe(GenericRedisCacher, () => {
|
describe(GenericRedisCacher, () => {
|
||||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||||
|
|
||||||
beforeAll(() => {
|
beforeAll(() => {
|
||||||
genericRedisCacheContext = {
|
redisCacheAdapterContext = {
|
||||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||||
makeKeyFn(...parts: string[]): string {
|
makeKeyFn(...parts: string[]): string {
|
||||||
const delimiter = ':';
|
const delimiter = ':';
|
||||||
const escapedParts = parts.map((part) =>
|
const escapedParts = parts.map((part) =>
|
||||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`),
|
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||||
);
|
);
|
||||||
return escapedParts.join(delimiter);
|
return escapedParts.join(delimiter);
|
||||||
},
|
},
|
||||||
cacheKeyPrefix: 'test-',
|
cacheKeyPrefix: 'test-',
|
||||||
|
cacheKeyVersion: 1,
|
||||||
ttlSecondsPositive: 86400, // 1 day
|
ttlSecondsPositive: 86400, // 1 day
|
||||||
ttlSecondsNegative: 600, // 10 minutes
|
ttlSecondsNegative: 600, // 10 minutes
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await (genericRedisCacheContext.redisClient as Redis).flushdb();
|
await redisCacheAdapterContext.redisClient.flushdb();
|
||||||
});
|
});
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
(genericRedisCacheContext.redisClient as Redis).disconnect();
|
redisCacheAdapterContext.redisClient.disconnect();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('has correct caching and loading behavior', async () => {
|
it('has correct caching and loading behavior', async () => {
|
||||||
const viewerContext = new TestViewerContext(
|
const viewerContext = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
const genericRedisCacher = new GenericRedisCacher(
|
const genericRedisCacher = new GenericRedisCacher(
|
||||||
genericRedisCacheContext,
|
{
|
||||||
redisTestEntityConfiguration,
|
redisClient: redisCacheAdapterContext.redisClient,
|
||||||
|
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||||
|
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||||
|
},
|
||||||
|
redisTestEntityConfiguration
|
||||||
);
|
);
|
||||||
const date = new Date();
|
const date = new Date();
|
||||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||||
@@ -56,7 +62,7 @@ describe(GenericRedisCacher, () => {
|
|||||||
]);
|
]);
|
||||||
await genericRedisCacher.cacheManyAsync(objectMap);
|
await genericRedisCacher.cacheManyAsync(objectMap);
|
||||||
|
|
||||||
const cachedJSON = await (genericRedisCacheContext.redisClient as Redis).get(testKey);
|
const cachedJSON = await redisCacheAdapterContext.redisClient.get(testKey);
|
||||||
const cachedValue = JSON.parse(cachedJSON!);
|
const cachedValue = JSON.parse(cachedJSON!);
|
||||||
expect(cachedValue).toMatchObject({
|
expect(cachedValue).toMatchObject({
|
||||||
id: entity1Created.getID(),
|
id: entity1Created.getID(),
|
||||||
@@ -73,8 +79,12 @@ describe(GenericRedisCacher, () => {
|
|||||||
});
|
});
|
||||||
it('has correct negative caching behaviour', async () => {
|
it('has correct negative caching behaviour', async () => {
|
||||||
const genericRedisCacher = new GenericRedisCacher(
|
const genericRedisCacher = new GenericRedisCacher(
|
||||||
genericRedisCacheContext,
|
{
|
||||||
redisTestEntityConfiguration,
|
redisClient: redisCacheAdapterContext.redisClient,
|
||||||
|
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||||
|
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||||
|
},
|
||||||
|
redisTestEntityConfiguration
|
||||||
);
|
);
|
||||||
|
|
||||||
const testKey = `test-id-key-non-existent-id`;
|
const testKey = `test-id-key-non-existent-id`;
|
||||||
@@ -85,11 +95,15 @@ describe(GenericRedisCacher, () => {
|
|||||||
});
|
});
|
||||||
it('has correct invalidation behaviour', async () => {
|
it('has correct invalidation behaviour', async () => {
|
||||||
const viewerContext = new TestViewerContext(
|
const viewerContext = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
const genericRedisCacher = new GenericRedisCacher(
|
const genericRedisCacher = new GenericRedisCacher(
|
||||||
genericRedisCacheContext,
|
{
|
||||||
redisTestEntityConfiguration,
|
redisClient: redisCacheAdapterContext.redisClient,
|
||||||
|
ttlSecondsNegative: redisCacheAdapterContext.ttlSecondsNegative,
|
||||||
|
ttlSecondsPositive: redisCacheAdapterContext.ttlSecondsPositive,
|
||||||
|
},
|
||||||
|
redisTestEntityConfiguration
|
||||||
);
|
);
|
||||||
const date = new Date();
|
const date = new Date();
|
||||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||||
|
|||||||
+33
-34
@@ -4,47 +4,48 @@ import Redis from 'ioredis';
|
|||||||
import { URL } from 'url';
|
import { URL } from 'url';
|
||||||
import { v4 as uuidv4 } from 'uuid';
|
import { v4 as uuidv4 } from 'uuid';
|
||||||
|
|
||||||
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
|
import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||||
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
||||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||||
|
|
||||||
class TestViewerContext extends ViewerContext {}
|
class TestViewerContext extends ViewerContext {}
|
||||||
|
|
||||||
describe(GenericRedisCacher, () => {
|
describe(RedisCacheAdapter, () => {
|
||||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||||
|
|
||||||
beforeAll(() => {
|
beforeAll(() => {
|
||||||
genericRedisCacheContext = {
|
redisCacheAdapterContext = {
|
||||||
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||||
makeKeyFn(...parts: string[]): string {
|
makeKeyFn(...parts: string[]): string {
|
||||||
const delimiter = ':';
|
const delimiter = ':';
|
||||||
const escapedParts = parts.map((part) =>
|
const escapedParts = parts.map((part) =>
|
||||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`),
|
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||||
);
|
);
|
||||||
return escapedParts.join(delimiter);
|
return escapedParts.join(delimiter);
|
||||||
},
|
},
|
||||||
cacheKeyPrefix: 'test-',
|
cacheKeyPrefix: 'test-',
|
||||||
|
cacheKeyVersion: 1,
|
||||||
ttlSecondsPositive: 86400, // 1 day
|
ttlSecondsPositive: 86400, // 1 day
|
||||||
ttlSecondsNegative: 600, // 10 minutes
|
ttlSecondsNegative: 600, // 10 minutes
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await (genericRedisCacheContext.redisClient as Redis).flushdb();
|
await redisCacheAdapterContext.redisClient.flushdb();
|
||||||
});
|
});
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
(genericRedisCacheContext.redisClient as Redis).disconnect();
|
redisCacheAdapterContext.redisClient.disconnect();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('has correct caching behavior', async () => {
|
it('has correct caching behavior', async () => {
|
||||||
const viewerContext = new TestViewerContext(
|
const viewerContext = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
const genericCacher =
|
const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(
|
||||||
viewerContext.entityCompanionProvider.getCompanionForEntity(RedisTestEntity)[
|
RedisTestEntity,
|
||||||
'tableDataCoordinator'
|
RedisTestEntity.getCompanionDefinition()
|
||||||
]['cacheAdapter']['genericCacher'];
|
)['tableDataCoordinator']['cacheAdapter'];
|
||||||
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
|
const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
|
||||||
|
|
||||||
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
const entity1Created = await RedisTestEntity.creator(viewerContext)
|
||||||
.setField('name', 'blah')
|
.setField('name', 'blah')
|
||||||
@@ -55,8 +56,8 @@ describe(GenericRedisCacher, () => {
|
|||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByIDAsync(entity1Created.getID());
|
.loadByIDAsync(entity1Created.getID());
|
||||||
|
|
||||||
const cachedJSON = await (genericRedisCacheContext.redisClient as Redis).get(
|
const cachedJSON = await redisCacheAdapterContext.redisClient.get(
|
||||||
cacheKeyMaker('id', entity1.getID()),
|
cacheKeyMaker('id', entity1.getID())
|
||||||
);
|
);
|
||||||
const cachedValue = JSON.parse(cachedJSON!);
|
const cachedValue = JSON.parse(cachedJSON!);
|
||||||
expect(cachedValue).toMatchObject({
|
expect(cachedValue).toMatchObject({
|
||||||
@@ -67,39 +68,37 @@ describe(GenericRedisCacher, () => {
|
|||||||
// simulate non existent db fetch, should write negative result ('') to cache
|
// simulate non existent db fetch, should write negative result ('') to cache
|
||||||
const nonExistentId = uuidv4();
|
const nonExistentId = uuidv4();
|
||||||
|
|
||||||
const entityNonExistentResult = await RedisTestEntity.loader(viewerContext)
|
const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||||
.withAuthorizationResults()
|
nonExistentId
|
||||||
.loadByIDAsync(nonExistentId);
|
);
|
||||||
expect(entityNonExistentResult.ok).toBe(false);
|
expect(entityNonExistentResult.ok).toBe(false);
|
||||||
|
|
||||||
const nonExistentCachedValue = await (genericRedisCacheContext.redisClient as Redis).get(
|
const nonExistentCachedValue = await redisCacheAdapterContext.redisClient.get(
|
||||||
cacheKeyMaker('id', nonExistentId),
|
cacheKeyMaker('id', nonExistentId)
|
||||||
);
|
);
|
||||||
expect(nonExistentCachedValue).toEqual('');
|
expect(nonExistentCachedValue).toEqual('');
|
||||||
|
|
||||||
// load again through entities framework to ensure it reads negative result
|
// load again through entities framework to ensure it reads negative result
|
||||||
const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext)
|
const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
|
||||||
.withAuthorizationResults()
|
nonExistentId
|
||||||
.loadByIDAsync(nonExistentId);
|
);
|
||||||
expect(entityNonExistentResult2.ok).toBe(false);
|
expect(entityNonExistentResult2.ok).toBe(false);
|
||||||
|
|
||||||
// invalidate from cache to ensure it invalidates correctly
|
// invalidate from cache to ensure it invalidates correctly
|
||||||
await RedisTestEntity.loader(viewerContext)
|
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
|
||||||
.utils()
|
const cachedValueNull = await redisCacheAdapterContext.redisClient.get(
|
||||||
.invalidateFieldsAsync(entity1.getAllFields());
|
cacheKeyMaker('id', entity1.getID())
|
||||||
const cachedValueNull = await (genericRedisCacheContext.redisClient as Redis).get(
|
|
||||||
cacheKeyMaker('id', entity1.getID()),
|
|
||||||
);
|
);
|
||||||
expect(cachedValueNull).toBe(null);
|
expect(cachedValueNull).toBe(null);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('caches and restores date fields', async () => {
|
it('caches and restores date fields', async () => {
|
||||||
const viewerContext = new TestViewerContext(
|
const viewerContext = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
const date = new Date();
|
const date = new Date();
|
||||||
const entity1 = await enforceAsyncResult(
|
const entity1 = await enforceAsyncResult(
|
||||||
RedisTestEntity.creator(viewerContext).setField('dateField', date).createAsync(),
|
RedisTestEntity.creator(viewerContext).setField('dateField', date).createAsync()
|
||||||
);
|
);
|
||||||
expect(entity1.getField('dateField')).toEqual(date);
|
expect(entity1.getField('dateField')).toEqual(date);
|
||||||
|
|
||||||
@@ -110,7 +109,7 @@ describe(GenericRedisCacher, () => {
|
|||||||
|
|
||||||
// simulate new request
|
// simulate new request
|
||||||
const vc2 = new TestViewerContext(
|
const vc2 = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
|
const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
|
||||||
expect(entity3.getField('dateField')).toEqual(date);
|
expect(entity3.getField('dateField')).toEqual(date);
|
||||||
@@ -118,10 +117,10 @@ describe(GenericRedisCacher, () => {
|
|||||||
|
|
||||||
it('caches and restores empty string field keys', async () => {
|
it('caches and restores empty string field keys', async () => {
|
||||||
const viewerContext = new TestViewerContext(
|
const viewerContext = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
const entity1 = await enforceAsyncResult(
|
const entity1 = await enforceAsyncResult(
|
||||||
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync(),
|
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
|
||||||
);
|
);
|
||||||
const entity2 = await RedisTestEntity.loader(viewerContext)
|
const entity2 = await RedisTestEntity.loader(viewerContext)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
@@ -130,7 +129,7 @@ describe(GenericRedisCacher, () => {
|
|||||||
|
|
||||||
// simulate new request
|
// simulate new request
|
||||||
const vc2 = new TestViewerContext(
|
const vc2 = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
const entity3 = await RedisTestEntity.loader(vc2)
|
const entity3 = await RedisTestEntity.loader(vc2)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
@@ -2,45 +2,45 @@ import { EntityCacheAdapterTransientError, ViewerContext } from '@expo/entity';
|
|||||||
import Redis from 'ioredis';
|
import Redis from 'ioredis';
|
||||||
import { URL } from 'url';
|
import { URL } from 'url';
|
||||||
|
|
||||||
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
|
import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||||
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
import RedisTestEntity from '../testfixtures/RedisTestEntity';
|
||||||
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
|
||||||
|
|
||||||
class TestViewerContext extends ViewerContext {}
|
class TestViewerContext extends ViewerContext {}
|
||||||
|
|
||||||
describe(GenericRedisCacher, () => {
|
describe(RedisCacheAdapter, () => {
|
||||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
|
||||||
|
|
||||||
beforeAll(() => {
|
beforeAll(() => {
|
||||||
genericRedisCacheContext = {
|
redisCacheAdapterContext = {
|
||||||
redisClient,
|
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||||
makeKeyFn(...parts: string[]): string {
|
makeKeyFn(...parts: string[]): string {
|
||||||
const delimiter = ':';
|
const delimiter = ':';
|
||||||
const escapedParts = parts.map((part) =>
|
const escapedParts = parts.map((part) =>
|
||||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`),
|
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||||
);
|
);
|
||||||
return escapedParts.join(delimiter);
|
return escapedParts.join(delimiter);
|
||||||
},
|
},
|
||||||
cacheKeyPrefix: 'test-',
|
cacheKeyPrefix: 'test-',
|
||||||
|
cacheKeyVersion: 1,
|
||||||
ttlSecondsPositive: 86400, // 1 day
|
ttlSecondsPositive: 86400, // 1 day
|
||||||
ttlSecondsNegative: 600, // 10 minutes
|
ttlSecondsNegative: 600, // 10 minutes
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await redisClient.flushdb();
|
await redisCacheAdapterContext.redisClient.flushdb();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('throws when redis is disconnected', async () => {
|
it('throws when redis is disconnected', async () => {
|
||||||
redisClient.disconnect();
|
redisCacheAdapterContext.redisClient.disconnect();
|
||||||
|
|
||||||
const vc1 = new TestViewerContext(
|
const vc1 = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
RedisTestEntity.creator(vc1).setField('name', 'blah').enforceCreateAsync(),
|
RedisTestEntity.creator(vc1).setField('name', 'blah').enforceCreateAsync()
|
||||||
).rejects.toThrow(EntityCacheAdapterTransientError);
|
).rejects.toThrow(EntityCacheAdapterTransientError);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -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,169 @@
|
|||||||
|
import { CacheStatus, UUIDField, EntityConfiguration } 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;
|
||||||
|
};
|
||||||
|
|
||||||
|
const entityConfiguration = new EntityConfiguration<BlahFields>({
|
||||||
|
idField: 'id',
|
||||||
|
tableName: 'blah',
|
||||||
|
schema: {
|
||||||
|
id: new UUIDField({ columnName: 'id', cache: true }),
|
||||||
|
},
|
||||||
|
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());
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
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,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
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,8 +4,9 @@
|
|||||||
* @module @expo/entity-cache-adapter-redis
|
* @module @expo/entity-cache-adapter-redis
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export { default as GenericRedisCacher } from './GenericRedisCacher';
|
export { default as RedisCacheAdapter } from './RedisCacheAdapter';
|
||||||
export * from './GenericRedisCacher';
|
export * from './RedisCacheAdapter';
|
||||||
export { default as RedisCacheAdapterProvider } from './RedisCacheAdapterProvider';
|
export { default as RedisCacheAdapterProvider } from './RedisCacheAdapterProvider';
|
||||||
export * from './RedisCommon';
|
export * from './RedisCommon';
|
||||||
export { default as wrapNativeRedisCallAsync } from './errors/wrapNativeRedisCallAsync';
|
export { default as GenericRedisCacher } from './GenericRedisCacher';
|
||||||
|
export * from './GenericRedisCacher';
|
||||||
@@ -17,18 +17,14 @@ export type RedisTestEntityFields = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
|
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
RedisTestEntityFields,
|
RedisTestEntityFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
RedisTestEntity,
|
RedisTestEntity,
|
||||||
RedisTestEntityPrivacyPolicy
|
RedisTestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return redisTestEntityCompanionDefinition;
|
||||||
entityClass: RedisTestEntity,
|
|
||||||
entityConfiguration: redisTestEntityConfiguration,
|
|
||||||
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -91,3 +87,9 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
|
|||||||
databaseAdapterFlavor: 'postgres',
|
databaseAdapterFlavor: 'postgres',
|
||||||
cacheAdapterFlavor: 'redis',
|
cacheAdapterFlavor: 'redis',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||||
|
entityClass: RedisTestEntity,
|
||||||
|
entityConfiguration: redisTestEntityConfiguration,
|
||||||
|
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
||||||
|
});
|
||||||
+6
-9
@@ -6,15 +6,12 @@ import {
|
|||||||
StubDatabaseAdapterProvider,
|
StubDatabaseAdapterProvider,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
|
|
||||||
import { GenericRedisCacheContext } from '../GenericRedisCacher';
|
import { RedisCacheAdapterContext } from '../RedisCacheAdapter';
|
||||||
import RedisCacheAdapterProvider from '../RedisCacheAdapterProvider';
|
import RedisCacheAdapterProvider from '../RedisCacheAdapterProvider';
|
||||||
|
|
||||||
// share across all in calls in test to simulate postgres
|
|
||||||
const adapterProvider = new StubDatabaseAdapterProvider();
|
|
||||||
|
|
||||||
export const createRedisIntegrationTestEntityCompanionProvider = (
|
export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||||
genericRedisCacheContext: GenericRedisCacheContext,
|
redisCacheAdapterContext: RedisCacheAdapterContext,
|
||||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
|
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||||
): EntityCompanionProvider => {
|
): EntityCompanionProvider => {
|
||||||
return new EntityCompanionProvider(
|
return new EntityCompanionProvider(
|
||||||
metricsAdapter,
|
metricsAdapter,
|
||||||
@@ -22,7 +19,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
|
|||||||
[
|
[
|
||||||
'postgres',
|
'postgres',
|
||||||
{
|
{
|
||||||
adapterProvider,
|
adapterProvider: new StubDatabaseAdapterProvider(),
|
||||||
queryContextProvider: StubQueryContextProvider,
|
queryContextProvider: StubQueryContextProvider,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
@@ -31,9 +28,9 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
|
|||||||
[
|
[
|
||||||
'redis',
|
'redis',
|
||||||
{
|
{
|
||||||
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
|
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
]),
|
])
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -3,165 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* constrain entity fields type to string-keyed object ([#235](https://github.com/expo/entity/issues/235)) ([7e2cea1](https://github.com/expo/entity/commit/7e2cea16973a0ae1917f867cd25d6ef7c8eaecef))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
**Note:** Version bump only for package @expo/entity-database-adapter-knex
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@expo/entity-database-adapter-knex",
|
"name": "@expo/entity-database-adapter-knex",
|
||||||
"version": "0.37.0",
|
"version": "0.24.0",
|
||||||
"description": "Knex database adapter for @expo/entity",
|
"description": "Knex database adapter for @expo/entity",
|
||||||
"files": [
|
"files": [
|
||||||
"build",
|
"build",
|
||||||
@@ -16,10 +16,10 @@
|
|||||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||||
"barrelsby": "barrelsby --config ../../.barrelsby.json"
|
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16"
|
"node": ">=12"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"entity"
|
"entity"
|
||||||
@@ -30,10 +30,10 @@
|
|||||||
"@expo/entity": "*"
|
"@expo/entity": "*"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"knex": "^3.1.0"
|
"knex": "^1.0.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@expo/entity": "^0.37.0",
|
"@expo/entity": "^0.24.0",
|
||||||
"pg": "8.12.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,19 +2,17 @@ import {
|
|||||||
EntityDatabaseAdapter,
|
EntityDatabaseAdapter,
|
||||||
FieldTransformerMap,
|
FieldTransformerMap,
|
||||||
FieldTransformer,
|
FieldTransformer,
|
||||||
|
JSONArrayField,
|
||||||
|
MaybeJSONArrayField,
|
||||||
TableQuerySelectionModifiers,
|
TableQuerySelectionModifiers,
|
||||||
TableFieldSingleValueEqualityCondition,
|
TableFieldSingleValueEqualityCondition,
|
||||||
TableFieldMultiValueEqualityCondition,
|
TableFieldMultiValueEqualityCondition,
|
||||||
TableQuerySelectionModifiersWithOrderByRaw,
|
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
import { Knex } from 'knex';
|
import { Knex } from 'knex';
|
||||||
|
|
||||||
import { JSONArrayField, MaybeJSONArrayField } from './EntityFields';
|
|
||||||
import wrapNativePostgresCallAsync from './errors/wrapNativePostgresCallAsync';
|
import wrapNativePostgresCallAsync from './errors/wrapNativePostgresCallAsync';
|
||||||
|
|
||||||
export default class PostgresEntityDatabaseAdapter<
|
export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDatabaseAdapter<TFields> {
|
||||||
TFields extends Record<string, any>,
|
|
||||||
> extends EntityDatabaseAdapter<TFields> {
|
|
||||||
protected getFieldTransformerMap(): FieldTransformerMap {
|
protected getFieldTransformerMap(): FieldTransformerMap {
|
||||||
return new Map<string, FieldTransformer<any>>([
|
return new Map<string, FieldTransformer<any>>([
|
||||||
[
|
[
|
||||||
@@ -45,33 +43,19 @@ export default class PostgresEntityDatabaseAdapter<
|
|||||||
queryInterface: Knex,
|
queryInterface: Knex,
|
||||||
tableName: string,
|
tableName: string,
|
||||||
tableField: string,
|
tableField: string,
|
||||||
tableValues: readonly any[],
|
tableValues: readonly any[]
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
return await wrapNativePostgresCallAsync(() =>
|
return await wrapNativePostgresCallAsync(() =>
|
||||||
queryInterface
|
queryInterface
|
||||||
.select()
|
.select()
|
||||||
.from(tableName)
|
.from(tableName)
|
||||||
.whereRaw('?? = ANY(?)', [tableField, tableValues as any[]]),
|
.whereRaw('?? = ANY(?)', [tableField, tableValues as any[]])
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
private applyQueryModifiersToQueryOrderByRaw(
|
|
||||||
query: Knex.QueryBuilder,
|
|
||||||
querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw,
|
|
||||||
): Knex.QueryBuilder {
|
|
||||||
let ret = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
|
|
||||||
|
|
||||||
const { orderByRaw } = querySelectionModifiers;
|
|
||||||
if (orderByRaw !== undefined) {
|
|
||||||
ret = ret.orderByRaw(orderByRaw);
|
|
||||||
}
|
|
||||||
|
|
||||||
return ret;
|
|
||||||
}
|
|
||||||
|
|
||||||
private applyQueryModifiersToQuery(
|
private applyQueryModifiersToQuery(
|
||||||
query: Knex.QueryBuilder,
|
query: Knex.QueryBuilder,
|
||||||
querySelectionModifiers: TableQuerySelectionModifiers,
|
querySelectionModifiers: TableQuerySelectionModifiers
|
||||||
): Knex.QueryBuilder {
|
): Knex.QueryBuilder {
|
||||||
const { orderBy, offset, limit } = querySelectionModifiers;
|
const { orderBy, offset, limit } = querySelectionModifiers;
|
||||||
|
|
||||||
@@ -99,7 +83,7 @@ export default class PostgresEntityDatabaseAdapter<
|
|||||||
tableName: string,
|
tableName: string,
|
||||||
tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[],
|
tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[],
|
||||||
tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[],
|
tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[],
|
||||||
querySelectionModifiers: TableQuerySelectionModifiers,
|
querySelectionModifiers: TableQuerySelectionModifiers
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
let query = queryInterface.select().from(tableName);
|
let query = queryInterface.select().from(tableName);
|
||||||
|
|
||||||
@@ -145,23 +129,23 @@ export default class PostgresEntityDatabaseAdapter<
|
|||||||
tableName: string,
|
tableName: string,
|
||||||
rawWhereClause: string,
|
rawWhereClause: string,
|
||||||
bindings: object | any[],
|
bindings: object | any[],
|
||||||
querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw,
|
querySelectionModifiers: TableQuerySelectionModifiers
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
let query = queryInterface
|
let query = queryInterface
|
||||||
.select()
|
.select()
|
||||||
.from(tableName)
|
.from(tableName)
|
||||||
.whereRaw(rawWhereClause, bindings as any);
|
.whereRaw(rawWhereClause, bindings as any);
|
||||||
query = this.applyQueryModifiersToQueryOrderByRaw(query, querySelectionModifiers);
|
query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
|
||||||
return await wrapNativePostgresCallAsync(() => query);
|
return await wrapNativePostgresCallAsync(() => query);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected async insertInternalAsync(
|
protected async insertInternalAsync(
|
||||||
queryInterface: Knex,
|
queryInterface: Knex,
|
||||||
tableName: string,
|
tableName: string,
|
||||||
object: object,
|
object: object
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
return await wrapNativePostgresCallAsync(() =>
|
return await wrapNativePostgresCallAsync(() =>
|
||||||
queryInterface.insert(object).into(tableName).returning('*'),
|
queryInterface.insert(object).into(tableName).returning('*')
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -170,10 +154,10 @@ export default class PostgresEntityDatabaseAdapter<
|
|||||||
tableName: string,
|
tableName: string,
|
||||||
tableIdField: string,
|
tableIdField: string,
|
||||||
id: any,
|
id: any,
|
||||||
object: object,
|
object: object
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
return await wrapNativePostgresCallAsync(() =>
|
return await wrapNativePostgresCallAsync(() =>
|
||||||
queryInterface.update(object).into(tableName).where(tableIdField, id).returning('*'),
|
queryInterface.update(object).into(tableName).where(tableIdField, id).returning('*')
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -181,10 +165,10 @@ export default class PostgresEntityDatabaseAdapter<
|
|||||||
queryInterface: Knex,
|
queryInterface: Knex,
|
||||||
tableName: string,
|
tableName: string,
|
||||||
tableIdField: string,
|
tableIdField: string,
|
||||||
id: any,
|
id: any
|
||||||
): Promise<number> {
|
): Promise<number> {
|
||||||
return await wrapNativePostgresCallAsync(() =>
|
return await wrapNativePostgresCallAsync(() =>
|
||||||
queryInterface.into(tableName).where(tableIdField, id).del(),
|
queryInterface.into(tableName).where(tableIdField, id).del()
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -9,8 +9,8 @@ import PostgresEntityDatabaseAdapter from './PostgresEntityDatabaseAdapter';
|
|||||||
export default class PostgresEntityDatabaseAdapterProvider
|
export default class PostgresEntityDatabaseAdapterProvider
|
||||||
implements IEntityDatabaseAdapterProvider
|
implements IEntityDatabaseAdapterProvider
|
||||||
{
|
{
|
||||||
getDatabaseAdapter<TFields extends Record<string, any>>(
|
getDatabaseAdapter<TFields>(
|
||||||
entityConfiguration: EntityConfiguration<TFields>,
|
entityConfiguration: EntityConfiguration<TFields>
|
||||||
): EntityDatabaseAdapter<TFields> {
|
): EntityDatabaseAdapter<TFields> {
|
||||||
return new PostgresEntityDatabaseAdapter(entityConfiguration);
|
return new PostgresEntityDatabaseAdapter(entityConfiguration);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,8 +1,4 @@
|
|||||||
import {
|
import { EntityQueryContextProvider } from '@expo/entity';
|
||||||
EntityQueryContextProvider,
|
|
||||||
TransactionConfig,
|
|
||||||
TransactionIsolationLevel,
|
|
||||||
} from '@expo/entity';
|
|
||||||
import { Knex } from 'knex';
|
import { Knex } from 'knex';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -17,44 +13,9 @@ export default class PostgresEntityQueryContextProvider extends EntityQueryConte
|
|||||||
return this.knexInstance;
|
return this.knexInstance;
|
||||||
}
|
}
|
||||||
|
|
||||||
protected createTransactionRunner<T>(
|
protected createTransactionRunner<T>(): (
|
||||||
transactionConfig?: TransactionConfig,
|
transactionScope: (trx: any) => Promise<T>
|
||||||
): (transactionScope: (trx: any) => Promise<T>) => Promise<T> {
|
) => Promise<T> {
|
||||||
return (transactionScope) =>
|
return (transactionScope) => this.knexInstance.transaction(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) }
|
|
||||||
: {}),
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+73
-189
@@ -1,13 +1,12 @@
|
|||||||
import {
|
import {
|
||||||
OrderByOrdering,
|
OrderByOrdering,
|
||||||
createUnitTestEntityCompanionProvider,
|
createUnitTestEntityCompanionProvider,
|
||||||
|
enforceResultsAsync,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
TransactionIsolationLevel,
|
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
import { enforceAsyncResult } from '@expo/results';
|
import { enforceAsyncResult } from '@expo/results';
|
||||||
import { knex, Knex } from 'knex';
|
import { knex, Knex } from 'knex';
|
||||||
import nullthrows from 'nullthrows';
|
import nullthrows from 'nullthrows';
|
||||||
import { setTimeout } from 'timers/promises';
|
|
||||||
|
|
||||||
import PostgresTestEntity from '../testfixtures/PostgresTestEntity';
|
import PostgresTestEntity from '../testfixtures/PostgresTestEntity';
|
||||||
import PostgresTriggerTestEntity from '../testfixtures/PostgresTriggerTestEntity';
|
import PostgresTriggerTestEntity from '../testfixtures/PostgresTriggerTestEntity';
|
||||||
@@ -31,18 +30,18 @@ describe('postgres entity integration', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await PostgresTestEntity.createOrTruncatePostgresTableAsync(knexInstance);
|
await PostgresTestEntity.createOrTruncatePostgresTable(knexInstance);
|
||||||
});
|
});
|
||||||
|
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
await PostgresTestEntity.dropPostgresTableAsync(knexInstance);
|
await PostgresTestEntity.dropPostgresTable(knexInstance);
|
||||||
await knexInstance.destroy();
|
await knexInstance.destroy();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('supports parallel partial updates', async () => {
|
it('supports parallel partial updates', async () => {
|
||||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||||
const entity = await enforceAsyncResult(
|
const entity = await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc).setField('name', 'hello').createAsync(),
|
PostgresTestEntity.creator(vc).setField('name', 'hello').createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
// update two different fields at the same time (from the same entity)
|
// update two different fields at the same time (from the same entity)
|
||||||
@@ -69,7 +68,7 @@ describe('postgres entity integration', () => {
|
|||||||
it('throws knex error upon empty update', async () => {
|
it('throws knex error upon empty update', async () => {
|
||||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||||
const entity = await enforceAsyncResult(
|
const entity = await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc).setField('name', 'hello').createAsync(),
|
PostgresTestEntity.creator(vc).setField('name', 'hello').createAsync()
|
||||||
);
|
);
|
||||||
await expect(PostgresTestEntity.updater(entity).updateAsync()).rejects.toThrow();
|
await expect(PostgresTestEntity.updater(entity).updateAsync()).rejects.toThrow();
|
||||||
});
|
});
|
||||||
@@ -77,7 +76,7 @@ describe('postgres entity integration', () => {
|
|||||||
it('throws error upon empty update for stub database adapter to match behavior', async () => {
|
it('throws error upon empty update for stub database adapter to match behavior', async () => {
|
||||||
const vc = new ViewerContext(createUnitTestEntityCompanionProvider());
|
const vc = new ViewerContext(createUnitTestEntityCompanionProvider());
|
||||||
const entity = await enforceAsyncResult(
|
const entity = await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc).setField('name', 'hello').createAsync(),
|
PostgresTestEntity.creator(vc).setField('name', 'hello').createAsync()
|
||||||
);
|
);
|
||||||
await expect(PostgresTestEntity.updater(entity).updateAsync()).rejects.toThrow();
|
await expect(PostgresTestEntity.updater(entity).updateAsync()).rejects.toThrow();
|
||||||
});
|
});
|
||||||
@@ -88,89 +87,28 @@ describe('postgres entity integration', () => {
|
|||||||
|
|
||||||
// put one in the DB
|
// put one in the DB
|
||||||
const firstEntity = await enforceAsyncResult(
|
const firstEntity = await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1).setField('name', 'hello').createAsync(),
|
PostgresTestEntity.creator(vc1).setField('name', 'hello').createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
await PostgresTestEntity.loader(vc1).enforcing().loadByIDAsync(firstEntity.getID());
|
await enforceAsyncResult(PostgresTestEntity.loader(vc1).loadByIDAsync(firstEntity.getID()));
|
||||||
|
|
||||||
const errorToThrow = new Error('Intentional error');
|
const errorToThrow = new Error('Intentional error');
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
vc1.runInTransactionForDatabaseAdaptorFlavorAsync(
|
vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||||
'postgres',
|
// put another in the DB that will be rolled back due to error thrown
|
||||||
async (queryContext) => {
|
await enforceAsyncResult(
|
||||||
// put another in the DB that will be rolled back due to error thrown
|
PostgresTestEntity.creator(vc1, queryContext).setField('name', 'hello').createAsync()
|
||||||
await enforceAsyncResult(
|
);
|
||||||
PostgresTestEntity.creator(vc1, queryContext).setField('name', 'hello').createAsync(),
|
|
||||||
);
|
|
||||||
|
|
||||||
throw errorToThrow;
|
throw errorToThrow;
|
||||||
},
|
})
|
||||||
{}, // test empty transaction config
|
|
||||||
),
|
|
||||||
).rejects.toEqual(errorToThrow);
|
).rejects.toEqual(errorToThrow);
|
||||||
|
|
||||||
const entities = await PostgresTestEntity.loader(vc1)
|
const entities = await enforceResultsAsync(
|
||||||
.enforcing()
|
PostgresTestEntity.loader(vc1).loadManyByFieldEqualingAsync('name', 'hello')
|
||||||
.loadManyByFieldEqualingAsync('name', 'hello');
|
|
||||||
expect(entities).toHaveLength(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('isolation levels', () => {
|
|
||||||
test.each(Object.values(TransactionIsolationLevel))(
|
|
||||||
'isolation level: %p',
|
|
||||||
async (isolationLevel: TransactionIsolationLevel) => {
|
|
||||||
const vc1 = new ViewerContext(
|
|
||||||
createKnexIntegrationTestEntityCompanionProvider(knexInstance),
|
|
||||||
);
|
|
||||||
|
|
||||||
const firstEntity = await enforceAsyncResult(
|
|
||||||
PostgresTestEntity.creator(vc1).setField('name', 'hello').createAsync(),
|
|
||||||
);
|
|
||||||
|
|
||||||
const loadAndUpdateAsync = async (
|
|
||||||
newName: string,
|
|
||||||
delay: number,
|
|
||||||
): Promise<{ error?: Error }> => {
|
|
||||||
try {
|
|
||||||
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync(
|
|
||||||
'postgres',
|
|
||||||
async (queryContext) => {
|
|
||||||
const entity = await PostgresTestEntity.loader(vc1, queryContext)
|
|
||||||
.enforcing()
|
|
||||||
.loadByIDAsync(firstEntity.getID());
|
|
||||||
await setTimeout(delay);
|
|
||||||
await PostgresTestEntity.updater(entity, queryContext)
|
|
||||||
.setField('name', entity.getField('name') + ',' + newName)
|
|
||||||
.enforceUpdateAsync();
|
|
||||||
},
|
|
||||||
{ isolationLevel },
|
|
||||||
);
|
|
||||||
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', 0),
|
|
||||||
loadAndUpdateAsync('hello3', 100),
|
|
||||||
loadAndUpdateAsync('hello4', 200),
|
|
||||||
loadAndUpdateAsync('hello5', 300),
|
|
||||||
]);
|
|
||||||
|
|
||||||
if (isolationLevel === TransactionIsolationLevel.READ_COMMITTED) {
|
|
||||||
// read committed seems executes the transactions and doesn't produce a consistent result, but doesn't throw
|
|
||||||
expect(results.filter((r) => !!r.error).length > 0).toBe(false);
|
|
||||||
} else {
|
|
||||||
// all other isolation levels throw since they're doing nonrepeatable reads
|
|
||||||
expect(results.filter((r) => (r.error as any)?.cause?.code === '40001').length > 0).toBe(
|
|
||||||
true,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
);
|
);
|
||||||
|
expect(entities).toHaveLength(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('JSON fields', () => {
|
describe('JSON fields', () => {
|
||||||
@@ -181,7 +119,7 @@ describe('postgres entity integration', () => {
|
|||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('stringArray', ['hello', 'world'])
|
.setField('stringArray', ['hello', 'world'])
|
||||||
.setField('jsonArrayField', ['hello', 'world'])
|
.setField('jsonArrayField', ['hello', 'world'])
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
expect(entity.getField('stringArray')).toEqual(['hello', 'world']);
|
expect(entity.getField('stringArray')).toEqual(['hello', 'world']);
|
||||||
@@ -194,7 +132,7 @@ describe('postgres entity integration', () => {
|
|||||||
const entity = await enforceAsyncResult(
|
const entity = await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('jsonObjectField', { hello: 'world' })
|
.setField('jsonObjectField', { hello: 'world' })
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
expect(entity.getField('jsonObjectField')).toEqual({ hello: 'world' });
|
expect(entity.getField('jsonObjectField')).toEqual({ hello: 'world' });
|
||||||
@@ -206,12 +144,12 @@ describe('postgres entity integration', () => {
|
|||||||
const entity1 = await enforceAsyncResult(
|
const entity1 = await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('maybeJsonArrayField', ['hello', 'world'])
|
.setField('maybeJsonArrayField', ['hello', 'world'])
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
const entity2 = await enforceAsyncResult(
|
const entity2 = await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('maybeJsonArrayField', { hello: 'world' })
|
.setField('maybeJsonArrayField', { hello: 'world' })
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
expect(entity1.getField('maybeJsonArrayField')).toEqual(['hello', 'world']);
|
expect(entity1.getField('maybeJsonArrayField')).toEqual(['hello', 'world']);
|
||||||
@@ -219,27 +157,6 @@ describe('postgres entity integration', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('BIGINT fields', () => {
|
|
||||||
it('supports BIGINT fields', async () => {
|
|
||||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
|
||||||
|
|
||||||
let entity = await enforceAsyncResult(
|
|
||||||
PostgresTestEntity.creator(vc1).setField('bigintField', '72057594037928038').createAsync(),
|
|
||||||
);
|
|
||||||
expect(entity.getField('bigintField')).toEqual('72057594037928038');
|
|
||||||
|
|
||||||
entity = await enforceAsyncResult(
|
|
||||||
PostgresTestEntity.updater(entity).setField('bigintField', '10').updateAsync(),
|
|
||||||
);
|
|
||||||
expect(entity.getField('bigintField')).toEqual('10');
|
|
||||||
|
|
||||||
entity = await enforceAsyncResult(
|
|
||||||
PostgresTestEntity.updater(entity).setField('bigintField', '-10').updateAsync(),
|
|
||||||
);
|
|
||||||
expect(entity.getField('bigintField')).toEqual('-10');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('conjunction field equality loading', () => {
|
describe('conjunction field equality loading', () => {
|
||||||
it('supports single fieldValue and multiple fieldValues', async () => {
|
it('supports single fieldValue and multiple fieldValues', async () => {
|
||||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||||
@@ -249,7 +166,7 @@ describe('postgres entity integration', () => {
|
|||||||
.setField('name', 'hello')
|
.setField('name', 'hello')
|
||||||
.setField('hasACat', false)
|
.setField('hasACat', false)
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
@@ -257,7 +174,7 @@ describe('postgres entity integration', () => {
|
|||||||
.setField('name', 'world')
|
.setField('name', 'world')
|
||||||
.setField('hasACat', false)
|
.setField('hasACat', false)
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
@@ -265,7 +182,7 @@ describe('postgres entity integration', () => {
|
|||||||
.setField('name', 'wat')
|
.setField('name', 'wat')
|
||||||
.setField('hasACat', false)
|
.setField('hasACat', false)
|
||||||
.setField('hasADog', false)
|
.setField('hasADog', false)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
const results = await PostgresTestEntity.loader(vc1)
|
const results = await PostgresTestEntity.loader(vc1)
|
||||||
@@ -322,25 +239,25 @@ describe('postgres entity integration', () => {
|
|||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('name', 'a')
|
.setField('name', 'a')
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('name', 'b')
|
.setField('name', 'b')
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('name', null)
|
.setField('name', null)
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('name', null)
|
.setField('name', null)
|
||||||
.setField('hasADog', false)
|
.setField('hasADog', false)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
const results = await PostgresTestEntity.loader(vc1)
|
const results = await PostgresTestEntity.loader(vc1)
|
||||||
@@ -363,7 +280,7 @@ describe('postgres entity integration', () => {
|
|||||||
order: OrderByOrdering.DESCENDING,
|
order: OrderByOrdering.DESCENDING,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
}
|
||||||
);
|
);
|
||||||
expect(results2).toHaveLength(2);
|
expect(results2).toHaveLength(2);
|
||||||
expect(results2.map((e) => e.getField('name'))).toEqual([null, 'a']);
|
expect(results2.map((e) => e.getField('name'))).toEqual([null, 'a']);
|
||||||
@@ -378,7 +295,7 @@ describe('postgres entity integration', () => {
|
|||||||
.setField('name', 'hello')
|
.setField('name', 'hello')
|
||||||
.setField('hasACat', false)
|
.setField('hasACat', false)
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
const results = await PostgresTestEntity.loader(vc1)
|
const results = await PostgresTestEntity.loader(vc1)
|
||||||
@@ -395,13 +312,13 @@ describe('postgres entity integration', () => {
|
|||||||
.setField('name', 'hello')
|
.setField('name', 'hello')
|
||||||
.setField('hasACat', false)
|
.setField('hasACat', false)
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTestEntity.loader(vc1)
|
PostgresTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadManyByRawWhereClauseAsync('invalid_column = ?', ['hello']),
|
.loadManyByRawWhereClauseAsync('invalid_column = ?', ['hello'])
|
||||||
).rejects.toThrow();
|
).rejects.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -412,21 +329,21 @@ describe('postgres entity integration', () => {
|
|||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('name', 'a')
|
.setField('name', 'a')
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('name', 'b')
|
.setField('name', 'b')
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
PostgresTestEntity.creator(vc1)
|
PostgresTestEntity.creator(vc1)
|
||||||
.setField('name', 'c')
|
.setField('name', 'c')
|
||||||
.setField('hasADog', true)
|
.setField('hasADog', true)
|
||||||
.createAsync(),
|
.createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
const results = await PostgresTestEntity.loader(vc1)
|
const results = await PostgresTestEntity.loader(vc1)
|
||||||
@@ -462,15 +379,6 @@ describe('postgres entity integration', () => {
|
|||||||
|
|
||||||
expect(resultsMultipleOrderBy).toHaveLength(3);
|
expect(resultsMultipleOrderBy).toHaveLength(3);
|
||||||
expect(resultsMultipleOrderBy.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
|
expect(resultsMultipleOrderBy.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
|
||||||
|
|
||||||
const resultsOrderByRaw = await PostgresTestEntity.loader(vc1)
|
|
||||||
.enforcing()
|
|
||||||
.loadManyByRawWhereClauseAsync('has_a_dog = ?', [true], {
|
|
||||||
orderByRaw: 'has_a_dog ASC, name DESC',
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(resultsOrderByRaw).toHaveLength(3);
|
|
||||||
expect(resultsOrderByRaw.map((e) => e.getField('name'))).toEqual(['c', 'b', 'a']);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -478,58 +386,58 @@ describe('postgres entity integration', () => {
|
|||||||
describe('create', () => {
|
describe('create', () => {
|
||||||
it('rolls back transaction when trigger throws except afterCommit', async () => {
|
it('rolls back transaction when trigger throws except afterCommit', async () => {
|
||||||
const vc1 = new ViewerContext(
|
const vc1 = new ViewerContext(
|
||||||
createKnexIntegrationTestEntityCompanionProvider(knexInstance),
|
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
|
||||||
);
|
);
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.creator(vc1)
|
PostgresTriggerTestEntity.creator(vc1)
|
||||||
.setField('name', 'beforeCreate')
|
.setField('name', 'beforeCreate')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrowError('name cannot have value beforeCreate');
|
).rejects.toThrowError('name cannot have value beforeCreate');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'beforeCreate'),
|
.loadByFieldEqualingAsync('name', 'beforeCreate')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.creator(vc1)
|
PostgresTriggerTestEntity.creator(vc1)
|
||||||
.setField('name', 'afterCreate')
|
.setField('name', 'afterCreate')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrowError('name cannot have value afterCreate');
|
).rejects.toThrowError('name cannot have value afterCreate');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'afterCreate'),
|
.loadByFieldEqualingAsync('name', 'afterCreate')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.creator(vc1).setField('name', 'beforeAll').enforceCreateAsync(),
|
PostgresTriggerTestEntity.creator(vc1).setField('name', 'beforeAll').enforceCreateAsync()
|
||||||
).rejects.toThrowError('name cannot have value beforeAll');
|
).rejects.toThrowError('name cannot have value beforeAll');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'beforeAll'),
|
.loadByFieldEqualingAsync('name', 'beforeAll')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.creator(vc1).setField('name', 'afterAll').enforceCreateAsync(),
|
PostgresTriggerTestEntity.creator(vc1).setField('name', 'afterAll').enforceCreateAsync()
|
||||||
).rejects.toThrowError('name cannot have value afterAll');
|
).rejects.toThrowError('name cannot have value afterAll');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'afterAll'),
|
.loadByFieldEqualingAsync('name', 'afterAll')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.creator(vc1)
|
PostgresTriggerTestEntity.creator(vc1)
|
||||||
.setField('name', 'afterCommit')
|
.setField('name', 'afterCommit')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrowError('name cannot have value afterCommit');
|
).rejects.toThrowError('name cannot have value afterCommit');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'afterCommit'),
|
.loadByFieldEqualingAsync('name', 'afterCommit')
|
||||||
).resolves.not.toBeNull();
|
).resolves.not.toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -537,7 +445,7 @@ describe('postgres entity integration', () => {
|
|||||||
describe('update', () => {
|
describe('update', () => {
|
||||||
it('rolls back transaction when trigger throws except afterCommit', async () => {
|
it('rolls back transaction when trigger throws except afterCommit', async () => {
|
||||||
const vc1 = new ViewerContext(
|
const vc1 = new ViewerContext(
|
||||||
createKnexIntegrationTestEntityCompanionProvider(knexInstance),
|
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
|
||||||
);
|
);
|
||||||
|
|
||||||
const entity = await PostgresTriggerTestEntity.creator(vc1)
|
const entity = await PostgresTriggerTestEntity.creator(vc1)
|
||||||
@@ -547,56 +455,56 @@ describe('postgres entity integration', () => {
|
|||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.updater(entity)
|
PostgresTriggerTestEntity.updater(entity)
|
||||||
.setField('name', 'beforeUpdate')
|
.setField('name', 'beforeUpdate')
|
||||||
.enforceUpdateAsync(),
|
.enforceUpdateAsync()
|
||||||
).rejects.toThrowError('name cannot have value beforeUpdate');
|
).rejects.toThrowError('name cannot have value beforeUpdate');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'beforeUpdate'),
|
.loadByFieldEqualingAsync('name', 'beforeUpdate')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.updater(entity)
|
PostgresTriggerTestEntity.updater(entity)
|
||||||
.setField('name', 'afterUpdate')
|
.setField('name', 'afterUpdate')
|
||||||
.enforceUpdateAsync(),
|
.enforceUpdateAsync()
|
||||||
).rejects.toThrowError('name cannot have value afterUpdate');
|
).rejects.toThrowError('name cannot have value afterUpdate');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'afterUpdate'),
|
.loadByFieldEqualingAsync('name', 'afterUpdate')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.updater(entity)
|
PostgresTriggerTestEntity.updater(entity)
|
||||||
.setField('name', 'beforeAll')
|
.setField('name', 'beforeAll')
|
||||||
.enforceUpdateAsync(),
|
.enforceUpdateAsync()
|
||||||
).rejects.toThrowError('name cannot have value beforeAll');
|
).rejects.toThrowError('name cannot have value beforeAll');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'beforeAll'),
|
.loadByFieldEqualingAsync('name', 'beforeAll')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.updater(entity)
|
PostgresTriggerTestEntity.updater(entity)
|
||||||
.setField('name', 'afterAll')
|
.setField('name', 'afterAll')
|
||||||
.enforceUpdateAsync(),
|
.enforceUpdateAsync()
|
||||||
).rejects.toThrowError('name cannot have value afterAll');
|
).rejects.toThrowError('name cannot have value afterAll');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'afterAll'),
|
.loadByFieldEqualingAsync('name', 'afterAll')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.updater(entity)
|
PostgresTriggerTestEntity.updater(entity)
|
||||||
.setField('name', 'afterCommit')
|
.setField('name', 'afterCommit')
|
||||||
.enforceUpdateAsync(),
|
.enforceUpdateAsync()
|
||||||
).rejects.toThrowError('name cannot have value afterCommit');
|
).rejects.toThrowError('name cannot have value afterCommit');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'afterCommit'),
|
.loadByFieldEqualingAsync('name', 'afterCommit')
|
||||||
).resolves.not.toBeNull();
|
).resolves.not.toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -604,31 +512,31 @@ describe('postgres entity integration', () => {
|
|||||||
describe('delete', () => {
|
describe('delete', () => {
|
||||||
it('rolls back transaction when trigger throws except afterCommit', async () => {
|
it('rolls back transaction when trigger throws except afterCommit', async () => {
|
||||||
const vc1 = new ViewerContext(
|
const vc1 = new ViewerContext(
|
||||||
createKnexIntegrationTestEntityCompanionProvider(knexInstance),
|
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
|
||||||
);
|
);
|
||||||
|
|
||||||
const entityBeforeDelete = await PostgresTriggerTestEntity.creator(vc1)
|
const entityBeforeDelete = await PostgresTriggerTestEntity.creator(vc1)
|
||||||
.setField('name', 'beforeDelete')
|
.setField('name', 'beforeDelete')
|
||||||
.enforceCreateAsync();
|
.enforceCreateAsync();
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.enforceDeleteAsync(entityBeforeDelete),
|
PostgresTriggerTestEntity.enforceDeleteAsync(entityBeforeDelete)
|
||||||
).rejects.toThrowError('name cannot have value beforeDelete');
|
).rejects.toThrowError('name cannot have value beforeDelete');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'beforeDelete'),
|
.loadByFieldEqualingAsync('name', 'beforeDelete')
|
||||||
).resolves.not.toBeNull();
|
).resolves.not.toBeNull();
|
||||||
|
|
||||||
const entityAfterDelete = await PostgresTriggerTestEntity.creator(vc1)
|
const entityAfterDelete = await PostgresTriggerTestEntity.creator(vc1)
|
||||||
.setField('name', 'afterDelete')
|
.setField('name', 'afterDelete')
|
||||||
.enforceCreateAsync();
|
.enforceCreateAsync();
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.enforceDeleteAsync(entityAfterDelete),
|
PostgresTriggerTestEntity.enforceDeleteAsync(entityAfterDelete)
|
||||||
).rejects.toThrowError('name cannot have value afterDelete');
|
).rejects.toThrowError('name cannot have value afterDelete');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresTriggerTestEntity.loader(vc1)
|
PostgresTriggerTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'afterDelete'),
|
.loadByFieldEqualingAsync('name', 'afterDelete')
|
||||||
).resolves.not.toBeNull();
|
).resolves.not.toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -636,25 +544,25 @@ describe('postgres entity integration', () => {
|
|||||||
describe('create', () => {
|
describe('create', () => {
|
||||||
it('rolls back transaction when trigger throws ', async () => {
|
it('rolls back transaction when trigger throws ', async () => {
|
||||||
const vc1 = new ViewerContext(
|
const vc1 = new ViewerContext(
|
||||||
createKnexIntegrationTestEntityCompanionProvider(knexInstance),
|
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
|
||||||
);
|
);
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
PostgresValidatorTestEntity.creator(vc1)
|
PostgresValidatorTestEntity.creator(vc1)
|
||||||
.setField('name', 'beforeCreateAndBeforeUpdate')
|
.setField('name', 'beforeCreateAndBeforeUpdate')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
|
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresValidatorTestEntity.loader(vc1)
|
PostgresValidatorTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate'),
|
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('update', () => {
|
describe('update', () => {
|
||||||
it('rolls back transaction when trigger throws ', async () => {
|
it('rolls back transaction when trigger throws ', async () => {
|
||||||
const vc1 = new ViewerContext(
|
const vc1 = new ViewerContext(
|
||||||
createKnexIntegrationTestEntityCompanionProvider(knexInstance),
|
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
|
||||||
);
|
);
|
||||||
|
|
||||||
const entity = await PostgresValidatorTestEntity.creator(vc1)
|
const entity = await PostgresValidatorTestEntity.creator(vc1)
|
||||||
@@ -664,19 +572,19 @@ describe('postgres entity integration', () => {
|
|||||||
await expect(
|
await expect(
|
||||||
PostgresValidatorTestEntity.updater(entity)
|
PostgresValidatorTestEntity.updater(entity)
|
||||||
.setField('name', 'beforeCreateAndBeforeUpdate')
|
.setField('name', 'beforeCreateAndBeforeUpdate')
|
||||||
.enforceUpdateAsync(),
|
.enforceUpdateAsync()
|
||||||
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
|
).rejects.toThrowError('name cannot have value beforeCreateAndBeforeUpdate');
|
||||||
await expect(
|
await expect(
|
||||||
PostgresValidatorTestEntity.loader(vc1)
|
PostgresValidatorTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate'),
|
.loadByFieldEqualingAsync('name', 'beforeCreateAndBeforeUpdate')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('delete', () => {
|
describe('delete', () => {
|
||||||
it('validation should not run on a delete mutation', async () => {
|
it('validation should not run on a delete mutation', async () => {
|
||||||
const vc1 = new ViewerContext(
|
const vc1 = new ViewerContext(
|
||||||
createKnexIntegrationTestEntityCompanionProvider(knexInstance),
|
createKnexIntegrationTestEntityCompanionProvider(knexInstance)
|
||||||
);
|
);
|
||||||
|
|
||||||
const entityToDelete = await PostgresValidatorTestEntity.creator(vc1)
|
const entityToDelete = await PostgresValidatorTestEntity.creator(vc1)
|
||||||
@@ -686,7 +594,7 @@ describe('postgres entity integration', () => {
|
|||||||
await expect(
|
await expect(
|
||||||
PostgresValidatorTestEntity.loader(vc1)
|
PostgresValidatorTestEntity.loader(vc1)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('name', 'shouldBeDeleted'),
|
.loadByFieldEqualingAsync('name', 'shouldBeDeleted')
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -698,7 +606,6 @@ describe('postgres entity integration', () => {
|
|||||||
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||||
|
|
||||||
let preCommitCallCount = 0;
|
let preCommitCallCount = 0;
|
||||||
let preCommitInnerCallCount = 0;
|
|
||||||
let postCommitCallCount = 0;
|
let postCommitCallCount = 0;
|
||||||
|
|
||||||
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
|
||||||
@@ -708,28 +615,6 @@ describe('postgres entity integration', () => {
|
|||||||
queryContext.appendPreCommitCallback(async () => {
|
queryContext.appendPreCommitCallback(async () => {
|
||||||
preCommitCallCount++;
|
preCommitCallCount++;
|
||||||
}, 0);
|
}, 0);
|
||||||
|
|
||||||
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
|
|
||||||
innerQueryContext.appendPostCommitCallback(async () => {
|
|
||||||
postCommitCallCount++;
|
|
||||||
});
|
|
||||||
innerQueryContext.appendPreCommitCallback(async () => {
|
|
||||||
preCommitInnerCallCount++;
|
|
||||||
}, 0);
|
|
||||||
});
|
|
||||||
|
|
||||||
// this one throws so its post commit shouldn't execute
|
|
||||||
try {
|
|
||||||
await queryContext.runInNestedTransactionAsync(async (innerQueryContext) => {
|
|
||||||
innerQueryContext.appendPostCommitCallback(async () => {
|
|
||||||
postCommitCallCount++;
|
|
||||||
});
|
|
||||||
innerQueryContext.appendPreCommitCallback(async () => {
|
|
||||||
preCommitInnerCallCount++;
|
|
||||||
throw Error('wat');
|
|
||||||
}, 0);
|
|
||||||
});
|
|
||||||
} catch {}
|
|
||||||
});
|
});
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
@@ -741,12 +626,11 @@ describe('postgres entity integration', () => {
|
|||||||
preCommitCallCount++;
|
preCommitCallCount++;
|
||||||
throw Error('wat');
|
throw Error('wat');
|
||||||
}, 0);
|
}, 0);
|
||||||
}),
|
})
|
||||||
).rejects.toThrowError('wat');
|
).rejects.toThrowError('wat');
|
||||||
|
|
||||||
expect(preCommitCallCount).toBe(2);
|
expect(preCommitCallCount).toBe(2);
|
||||||
expect(preCommitInnerCallCount).toBe(2);
|
expect(postCommitCallCount).toBe(1);
|
||||||
expect(postCommitCallCount).toBe(2);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
-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.createOrTruncatePostgresTableAsync(knexInstance);
|
|
||||||
});
|
|
||||||
|
|
||||||
afterAll(async () => {
|
|
||||||
await PostgresUniqueTestEntity.dropPostgresTableAsync(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');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
+10
-10
@@ -23,11 +23,11 @@ describe('postgres entity integration', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await InvalidTestEntity.createOrTruncatePostgresTableAsync(knexInstance);
|
await InvalidTestEntity.createOrTruncatePostgresTable(knexInstance);
|
||||||
});
|
});
|
||||||
|
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
await InvalidTestEntity.dropPostgresTableAsync(knexInstance);
|
await InvalidTestEntity.dropPostgresTable(knexInstance);
|
||||||
await knexInstance.destroy();
|
await knexInstance.destroy();
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -35,40 +35,40 @@ describe('postgres entity integration', () => {
|
|||||||
it('throws after deletion of multiple rows or no rows', async () => {
|
it('throws after deletion of multiple rows or no rows', async () => {
|
||||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||||
const entity1 = await enforceAsyncResult(
|
const entity1 = await enforceAsyncResult(
|
||||||
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'hello').createAsync(),
|
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'hello').createAsync()
|
||||||
);
|
);
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'world').createAsync(),
|
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'world').createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
await expect(InvalidTestEntity.deleteAsync(entity1)).rejects.toThrowError(
|
await expect(InvalidTestEntity.deleteAsync(entity1)).rejects.toThrowError(
|
||||||
'Excessive deletions from database adapter delete',
|
'Excessive deletions from database adapter delete'
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('throws after update of multiple rows', async () => {
|
it('throws after update of multiple rows', async () => {
|
||||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||||
const entity1 = await enforceAsyncResult(
|
const entity1 = await enforceAsyncResult(
|
||||||
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'hello').createAsync(),
|
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'hello').createAsync()
|
||||||
);
|
);
|
||||||
await enforceAsyncResult(
|
await enforceAsyncResult(
|
||||||
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'world').createAsync(),
|
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'world').createAsync()
|
||||||
);
|
);
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
InvalidTestEntity.updater(entity1).setField('name', 'blah').enforceUpdateAsync(),
|
InvalidTestEntity.updater(entity1).setField('name', 'blah').enforceUpdateAsync()
|
||||||
).rejects.toThrowError('Excessive results from database adapter update');
|
).rejects.toThrowError('Excessive results from database adapter update');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('throws after update of no rows', async () => {
|
it('throws after update of no rows', async () => {
|
||||||
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
|
||||||
const entity1 = await enforceAsyncResult(
|
const entity1 = await enforceAsyncResult(
|
||||||
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'hello').createAsync(),
|
InvalidTestEntity.creator(vc).setField('id', 1).setField('name', 'hello').createAsync()
|
||||||
);
|
);
|
||||||
await InvalidTestEntity.deleteAsync(entity1);
|
await InvalidTestEntity.deleteAsync(entity1);
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
InvalidTestEntity.updater(entity1).setField('name', 'blah').enforceUpdateAsync(),
|
InvalidTestEntity.updater(entity1).setField('name', 'blah').enforceUpdateAsync()
|
||||||
).rejects.toThrowError('Empty results from database adapter update');
|
).rejects.toThrowError('Empty results from database adapter update');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -31,11 +31,11 @@ describe('postgres errors', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await ErrorsTestEntity.createOrTruncatePostgresTableAsync(knexInstance);
|
await ErrorsTestEntity.createOrTruncatePostgresTable(knexInstance);
|
||||||
});
|
});
|
||||||
|
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
await ErrorsTestEntity.dropPostgresTableAsync(knexInstance);
|
await ErrorsTestEntity.dropPostgresTable(knexInstance);
|
||||||
await knexInstance.destroy();
|
await knexInstance.destroy();
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -58,10 +58,10 @@ describe('postgres errors', () => {
|
|||||||
acquireConnectionTimeout: 1,
|
acquireConnectionTimeout: 1,
|
||||||
});
|
});
|
||||||
const vc2 = new ViewerContext(
|
const vc2 = new ViewerContext(
|
||||||
createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance),
|
createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance)
|
||||||
);
|
);
|
||||||
await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow(
|
await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow(
|
||||||
EntityDatabaseAdapterTransientError,
|
EntityDatabaseAdapterTransientError
|
||||||
);
|
);
|
||||||
await shortTimeoutKnexInstance.destroy();
|
await shortTimeoutKnexInstance.destroy();
|
||||||
});
|
});
|
||||||
@@ -72,7 +72,7 @@ describe('postgres errors', () => {
|
|||||||
ErrorsTestEntity.creator(vc)
|
ErrorsTestEntity.creator(vc)
|
||||||
.setField('id', 1)
|
.setField('id', 1)
|
||||||
.setField('fieldNonNull', null as any)
|
.setField('fieldNonNull', null as any)
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrow(EntityDatabaseAdapterNotNullConstraintError);
|
).rejects.toThrow(EntityDatabaseAdapterNotNullConstraintError);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -83,7 +83,7 @@ describe('postgres errors', () => {
|
|||||||
.setField('id', 1)
|
.setField('id', 1)
|
||||||
.setField('fieldNonNull', 'hello')
|
.setField('fieldNonNull', 'hello')
|
||||||
.setField('fieldForeignKey', 2)
|
.setField('fieldForeignKey', 2)
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrow(EntityDatabaseAdapterForeignKeyConstraintError);
|
).rejects.toThrow(EntityDatabaseAdapterForeignKeyConstraintError);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -99,7 +99,7 @@ describe('postgres errors', () => {
|
|||||||
ErrorsTestEntity.creator(vc)
|
ErrorsTestEntity.creator(vc)
|
||||||
.setField('id', 1)
|
.setField('id', 1)
|
||||||
.setField('fieldNonNull', 'hello')
|
.setField('fieldNonNull', 'hello')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
|
).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ describe('postgres errors', () => {
|
|||||||
.setField('id', 1)
|
.setField('id', 1)
|
||||||
.setField('fieldNonNull', 'hello')
|
.setField('fieldNonNull', 'hello')
|
||||||
.setField('fieldUnique', 'hello')
|
.setField('fieldUnique', 'hello')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
|
).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -127,7 +127,7 @@ describe('postgres errors', () => {
|
|||||||
.setField('id', 1)
|
.setField('id', 1)
|
||||||
.setField('fieldNonNull', 'hello')
|
.setField('fieldNonNull', 'hello')
|
||||||
.setField('checkLessThan5', 2)
|
.setField('checkLessThan5', 2)
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).resolves.toBeTruthy();
|
).resolves.toBeTruthy();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
@@ -135,7 +135,7 @@ describe('postgres errors', () => {
|
|||||||
.setField('id', 2)
|
.setField('id', 2)
|
||||||
.setField('fieldNonNull', 'hello')
|
.setField('fieldNonNull', 'hello')
|
||||||
.setField('checkLessThan5', 10)
|
.setField('checkLessThan5', 10)
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrow(EntityDatabaseAdapterCheckConstraintError);
|
).rejects.toThrow(EntityDatabaseAdapterCheckConstraintError);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -146,7 +146,7 @@ describe('postgres errors', () => {
|
|||||||
.setField('id', 1)
|
.setField('id', 1)
|
||||||
.setField('fieldNonNull', 'hello')
|
.setField('fieldNonNull', 'hello')
|
||||||
.setField('fieldExclusion', 'what')
|
.setField('fieldExclusion', 'what')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).resolves.toBeTruthy();
|
).resolves.toBeTruthy();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
@@ -154,7 +154,7 @@ describe('postgres errors', () => {
|
|||||||
.setField('id', 2)
|
.setField('id', 2)
|
||||||
.setField('fieldNonNull', 'hello')
|
.setField('fieldNonNull', 'hello')
|
||||||
.setField('fieldExclusion', 'what')
|
.setField('fieldExclusion', 'what')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrow(EntityDatabaseAdapterExclusionConstraintError);
|
).rejects.toThrow(EntityDatabaseAdapterExclusionConstraintError);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -165,7 +165,7 @@ describe('postgres errors', () => {
|
|||||||
.setField('id', 1)
|
.setField('id', 1)
|
||||||
.setField('fieldNonNull', 'hello')
|
.setField('fieldNonNull', 'hello')
|
||||||
.setField('nonExistentColumn', 'what')
|
.setField('nonExistentColumn', 'what')
|
||||||
.enforceCreateAsync(),
|
.enforceCreateAsync()
|
||||||
).rejects.toThrow(EntityDatabaseAdapterUnknownError);
|
).rejects.toThrow(EntityDatabaseAdapterUnknownError);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -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, {}],
|
|
||||||
);
|
|
||||||
@@ -11,7 +11,7 @@ import {
|
|||||||
import { knex } from 'knex';
|
import { knex } from 'knex';
|
||||||
|
|
||||||
function wrapNativePostgresError(
|
function wrapNativePostgresError(
|
||||||
error: Error & { code?: string },
|
error: Error & { code?: string }
|
||||||
): EntityDatabaseAdapterError & Error {
|
): EntityDatabaseAdapterError & Error {
|
||||||
const ret = translatePostgresError(error);
|
const ret = translatePostgresError(error);
|
||||||
if (error.stack) {
|
if (error.stack) {
|
||||||
@@ -21,7 +21,7 @@ function wrapNativePostgresError(
|
|||||||
}
|
}
|
||||||
|
|
||||||
function translatePostgresError(
|
function translatePostgresError(
|
||||||
error: Error & { code?: string },
|
error: Error & { code?: string }
|
||||||
): EntityDatabaseAdapterError & Error {
|
): EntityDatabaseAdapterError & Error {
|
||||||
if (error instanceof knex.KnexTimeoutError) {
|
if (error instanceof knex.KnexTimeoutError) {
|
||||||
return new EntityDatabaseAdapterTransientError(error.message, error);
|
return new EntityDatabaseAdapterTransientError(error.message, error);
|
||||||
|
|||||||
@@ -4,8 +4,6 @@
|
|||||||
* @module @expo/entity-database-adapter-knex
|
* @module @expo/entity-database-adapter-knex
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export * from './EntityFields';
|
|
||||||
export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter';
|
export { default as PostgresEntityDatabaseAdapter } from './PostgresEntityDatabaseAdapter';
|
||||||
export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider';
|
export { default as PostgresEntityDatabaseAdapterProvider } from './PostgresEntityDatabaseAdapterProvider';
|
||||||
export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider';
|
export { default as PostgresEntityQueryContextProvider } from './PostgresEntityQueryContextProvider';
|
||||||
export { default as wrapNativePostgresCallAsync } from './errors/wrapNativePostgresCallAsync';
|
|
||||||
@@ -27,24 +27,21 @@ export default class ErrorsTestEntity extends Entity<
|
|||||||
number,
|
number,
|
||||||
ViewerContext
|
ViewerContext
|
||||||
> {
|
> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
ErrorsTestEntityFields,
|
ErrorsTestEntityFields,
|
||||||
number,
|
number,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
ErrorsTestEntity,
|
ErrorsTestEntity,
|
||||||
ErrorsTestEntityPrivacyPolicy
|
ErrorsTestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return errorsTestEntityCompanionDefinition;
|
||||||
entityClass: ErrorsTestEntity,
|
|
||||||
entityConfiguration: ErrorsTestEntityConfiguration,
|
|
||||||
privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async createOrTruncatePostgresTableAsync(knex: Knex): Promise<void> {
|
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
|
||||||
await knex.raw('CREATE EXTENSION IF NOT EXISTS "btree_gist"'); // for gist exclusion on varchar
|
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);
|
const hasForeignTable = await knex.schema.hasTable(foreignTableName);
|
||||||
if (!hasForeignTable) {
|
if (!hasForeignTable) {
|
||||||
await knex.schema.createTable(foreignTableName, (table) => {
|
await knex.schema.createTable(foreignTableName, (table) => {
|
||||||
@@ -70,7 +67,7 @@ export default class ErrorsTestEntity extends Entity<
|
|||||||
CHECK (check_less_than_5 IS NULL OR check_less_than_5 < 5);`,
|
CHECK (check_less_than_5 IS NULL OR check_less_than_5 < 5);`,
|
||||||
{
|
{
|
||||||
tableName,
|
tableName,
|
||||||
},
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
await knex.raw(
|
await knex.raw(
|
||||||
@@ -81,7 +78,7 @@ export default class ErrorsTestEntity extends Entity<
|
|||||||
`,
|
`,
|
||||||
{
|
{
|
||||||
tableName,
|
tableName,
|
||||||
},
|
}
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -89,8 +86,8 @@ export default class ErrorsTestEntity extends Entity<
|
|||||||
await knex(foreignTableName).delete();
|
await knex(foreignTableName).delete();
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async dropPostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (hasTable) {
|
if (hasTable) {
|
||||||
await knex.schema.dropTable(tableName);
|
await knex.schema.dropTable(tableName);
|
||||||
@@ -172,3 +169,9 @@ export const ErrorsTestEntityConfiguration = new EntityConfiguration<ErrorsTestE
|
|||||||
databaseAdapterFlavor: 'postgres',
|
databaseAdapterFlavor: 'postgres',
|
||||||
cacheAdapterFlavor: 'redis',
|
cacheAdapterFlavor: 'redis',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const errorsTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||||
|
entityClass: ErrorsTestEntity,
|
||||||
|
entityConfiguration: ErrorsTestEntityConfiguration,
|
||||||
|
privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
|
||||||
|
});
|
||||||
@@ -20,22 +20,18 @@ export default class InvalidTestEntity extends Entity<
|
|||||||
number,
|
number,
|
||||||
ViewerContext
|
ViewerContext
|
||||||
> {
|
> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
InvalidTestEntityFields,
|
InvalidTestEntityFields,
|
||||||
number,
|
number,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
InvalidTestEntity,
|
InvalidTestEntity,
|
||||||
InvalidTestEntityPrivacyPolicy
|
InvalidTestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return invalidTestEntityCompanionDefinition;
|
||||||
entityClass: InvalidTestEntity,
|
|
||||||
entityConfiguration: invalidTestEntityConfiguration,
|
|
||||||
privacyPolicyClass: InvalidTestEntityPrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async createOrTruncatePostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (!hasTable) {
|
if (!hasTable) {
|
||||||
await knex.schema.createTable(tableName, (table) => {
|
await knex.schema.createTable(tableName, (table) => {
|
||||||
@@ -46,8 +42,8 @@ export default class InvalidTestEntity extends Entity<
|
|||||||
await knex.into(tableName).truncate();
|
await knex.into(tableName).truncate();
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async dropPostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (hasTable) {
|
if (hasTable) {
|
||||||
await knex.schema.dropTable(tableName);
|
await knex.schema.dropTable(tableName);
|
||||||
@@ -109,3 +105,9 @@ export const invalidTestEntityConfiguration = new EntityConfiguration<InvalidTes
|
|||||||
databaseAdapterFlavor: 'postgres',
|
databaseAdapterFlavor: 'postgres',
|
||||||
cacheAdapterFlavor: 'redis',
|
cacheAdapterFlavor: 'redis',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const invalidTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||||
|
entityClass: InvalidTestEntity,
|
||||||
|
entityConfiguration: invalidTestEntityConfiguration,
|
||||||
|
privacyPolicyClass: InvalidTestEntityPrivacyPolicy,
|
||||||
|
});
|
||||||
@@ -6,16 +6,16 @@ import {
|
|||||||
StringField,
|
StringField,
|
||||||
BooleanField,
|
BooleanField,
|
||||||
StringArrayField,
|
StringArrayField,
|
||||||
|
JSONArrayField,
|
||||||
JSONObjectField,
|
JSONObjectField,
|
||||||
DateField,
|
DateField,
|
||||||
|
MaybeJSONArrayField,
|
||||||
EntityConfiguration,
|
EntityConfiguration,
|
||||||
EntityCompanionDefinition,
|
EntityCompanionDefinition,
|
||||||
Entity,
|
Entity,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
import { Knex } from 'knex';
|
import { Knex } from 'knex';
|
||||||
|
|
||||||
import { BigIntField, JSONArrayField, MaybeJSONArrayField } from '../EntityFields';
|
|
||||||
|
|
||||||
type PostgresTestEntityFields = {
|
type PostgresTestEntityFields = {
|
||||||
id: string;
|
id: string;
|
||||||
name: string | null;
|
name: string | null;
|
||||||
@@ -28,7 +28,6 @@ type PostgresTestEntityFields = {
|
|||||||
} | null;
|
} | null;
|
||||||
dateField: Date | null;
|
dateField: Date | null;
|
||||||
maybeJsonArrayField: string[] | { hello: string } | null;
|
maybeJsonArrayField: string[] | { hello: string } | null;
|
||||||
bigintField: string | null;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export default class PostgresTestEntity extends Entity<
|
export default class PostgresTestEntity extends Entity<
|
||||||
@@ -36,26 +35,24 @@ export default class PostgresTestEntity extends Entity<
|
|||||||
string,
|
string,
|
||||||
ViewerContext
|
ViewerContext
|
||||||
> {
|
> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
PostgresTestEntityFields,
|
PostgresTestEntityFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
PostgresTestEntity,
|
PostgresTestEntity,
|
||||||
PostgresTestEntityPrivacyPolicy
|
PostgresTestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return postgresTestEntityCompanionDefinition;
|
||||||
entityClass: PostgresTestEntity,
|
|
||||||
entityConfiguration: postgresTestEntityConfiguration,
|
|
||||||
privacyPolicyClass: PostgresTestEntityPrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async createOrTruncatePostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (!hasTable) {
|
if (!hasTable) {
|
||||||
await knex.schema.createTable(tableName, (table) => {
|
await knex.schema.createTable(tableName, (table) => {
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||||
table.string('name');
|
table.string('name');
|
||||||
table.boolean('has_a_dog');
|
table.boolean('has_a_dog');
|
||||||
table.boolean('has_a_cat');
|
table.boolean('has_a_cat');
|
||||||
@@ -64,14 +61,13 @@ export default class PostgresTestEntity extends Entity<
|
|||||||
table.jsonb('json_object_field');
|
table.jsonb('json_object_field');
|
||||||
table.dateTime('date_field', { useTz: true });
|
table.dateTime('date_field', { useTz: true });
|
||||||
table.jsonb('maybe_json_array_field');
|
table.jsonb('maybe_json_array_field');
|
||||||
table.bigint('bigint_field');
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
await knex.into(tableName).truncate();
|
await knex.into(tableName).truncate();
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async dropPostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (hasTable) {
|
if (hasTable) {
|
||||||
await knex.schema.dropTable(tableName);
|
await knex.schema.dropTable(tableName);
|
||||||
@@ -151,10 +147,13 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
|
|||||||
maybeJsonArrayField: new MaybeJSONArrayField({
|
maybeJsonArrayField: new MaybeJSONArrayField({
|
||||||
columnName: 'maybe_json_array_field',
|
columnName: 'maybe_json_array_field',
|
||||||
}),
|
}),
|
||||||
bigintField: new BigIntField({
|
|
||||||
columnName: 'bigint_field',
|
|
||||||
}),
|
|
||||||
},
|
},
|
||||||
databaseAdapterFlavor: 'postgres',
|
databaseAdapterFlavor: 'postgres',
|
||||||
cacheAdapterFlavor: 'redis',
|
cacheAdapterFlavor: 'redis',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||||
|
entityClass: PostgresTestEntity,
|
||||||
|
entityConfiguration: postgresTestEntityConfiguration,
|
||||||
|
privacyPolicyClass: PostgresTestEntityPrivacyPolicy,
|
||||||
|
});
|
||||||
+30
-32
@@ -24,45 +24,32 @@ export default class PostgresTriggerTestEntity extends Entity<
|
|||||||
string,
|
string,
|
||||||
ViewerContext
|
ViewerContext
|
||||||
> {
|
> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
PostgresTriggerTestEntityFields,
|
PostgresTriggerTestEntityFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
PostgresTriggerTestEntity,
|
PostgresTriggerTestEntity,
|
||||||
PostgresTriggerTestEntityPrivacyPolicy
|
PostgresTriggerTestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return postgresTestEntityCompanionDefinition;
|
||||||
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')],
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async createOrTruncatePostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (!hasTable) {
|
if (!hasTable) {
|
||||||
await knex.schema.createTable(tableName, (table) => {
|
await knex.schema.createTable(tableName, (table) => {
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||||
table.string('name');
|
table.string('name');
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
await knex.into(tableName).truncate();
|
await knex.into(tableName).truncate();
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async dropPostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (hasTable) {
|
if (hasTable) {
|
||||||
await knex.schema.dropTable(tableName);
|
await knex.schema.dropTable(tableName);
|
||||||
@@ -116,10 +103,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
|||||||
ViewerContext,
|
ViewerContext,
|
||||||
PostgresTriggerTestEntity
|
PostgresTriggerTestEntity
|
||||||
> {
|
> {
|
||||||
constructor(
|
constructor(private fieldName: keyof PostgresTriggerTestEntityFields, private badValue: string) {
|
||||||
private fieldName: keyof PostgresTriggerTestEntityFields,
|
|
||||||
private badValue: string,
|
|
||||||
) {
|
|
||||||
super();
|
super();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -132,7 +116,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
|||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
PostgresTriggerTestEntity
|
PostgresTriggerTestEntity
|
||||||
>,
|
>
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
if (entity.getField(this.fieldName) === this.badValue) {
|
if (entity.getField(this.fieldName) === this.badValue) {
|
||||||
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
||||||
@@ -146,16 +130,13 @@ class ThrowConditionallyNonTransactionalTrigger extends EntityNonTransactionalMu
|
|||||||
ViewerContext,
|
ViewerContext,
|
||||||
PostgresTriggerTestEntity
|
PostgresTriggerTestEntity
|
||||||
> {
|
> {
|
||||||
constructor(
|
constructor(private fieldName: keyof PostgresTriggerTestEntityFields, private badValue: string) {
|
||||||
private fieldName: keyof PostgresTriggerTestEntityFields,
|
|
||||||
private badValue: string,
|
|
||||||
) {
|
|
||||||
super();
|
super();
|
||||||
}
|
}
|
||||||
|
|
||||||
async executeAsync(
|
async executeAsync(
|
||||||
_viewerContext: ViewerContext,
|
_viewerContext: ViewerContext,
|
||||||
entity: PostgresTriggerTestEntity,
|
entity: PostgresTriggerTestEntity
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
if (entity.getField(this.fieldName) === this.badValue) {
|
if (entity.getField(this.fieldName) === this.badValue) {
|
||||||
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
||||||
@@ -179,3 +160,20 @@ export const postgresTestEntityConfiguration =
|
|||||||
databaseAdapterFlavor: 'postgres',
|
databaseAdapterFlavor: 'postgres',
|
||||||
cacheAdapterFlavor: 'redis',
|
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 createOrTruncatePostgresTableAsync(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 dropPostgresTableAsync(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',
|
|
||||||
});
|
|
||||||
+18
-14
@@ -23,35 +23,32 @@ export default class PostgresValidatorTestEntity extends Entity<
|
|||||||
string,
|
string,
|
||||||
ViewerContext
|
ViewerContext
|
||||||
> {
|
> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
PostgresValidatorTestEntityFields,
|
PostgresValidatorTestEntityFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
PostgresValidatorTestEntity,
|
PostgresValidatorTestEntity,
|
||||||
PostgresValidatorTestEntityPrivacyPolicy
|
PostgresValidatorTestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return postgresTestEntityCompanionDefinition;
|
||||||
entityClass: PostgresValidatorTestEntity,
|
|
||||||
entityConfiguration: postgresTestEntityConfiguration,
|
|
||||||
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
|
|
||||||
mutationValidators: [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async createOrTruncatePostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (!hasTable) {
|
if (!hasTable) {
|
||||||
await knex.schema.createTable(tableName, (table) => {
|
await knex.schema.createTable(tableName, (table) => {
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||||
table.string('name');
|
table.string('name');
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
await knex.into(tableName).truncate();
|
await knex.into(tableName).truncate();
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async dropPostgresTableAsync(knex: Knex): Promise<void> {
|
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);
|
const hasTable = await knex.schema.hasTable(tableName);
|
||||||
if (hasTable) {
|
if (hasTable) {
|
||||||
await knex.schema.dropTable(tableName);
|
await knex.schema.dropTable(tableName);
|
||||||
@@ -107,7 +104,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
|||||||
> {
|
> {
|
||||||
constructor(
|
constructor(
|
||||||
private fieldName: keyof PostgresValidatorTestEntityFields,
|
private fieldName: keyof PostgresValidatorTestEntityFields,
|
||||||
private badValue: string,
|
private badValue: string
|
||||||
) {
|
) {
|
||||||
super();
|
super();
|
||||||
}
|
}
|
||||||
@@ -121,7 +118,7 @@ class ThrowConditionallyTrigger extends EntityMutationTrigger<
|
|||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
PostgresValidatorTestEntity
|
PostgresValidatorTestEntity
|
||||||
>,
|
>
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
if (entity.getField(this.fieldName) === this.badValue) {
|
if (entity.getField(this.fieldName) === this.badValue) {
|
||||||
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
throw new Error(`${this.fieldName} cannot have value ${this.badValue}`);
|
||||||
@@ -145,3 +142,10 @@ export const postgresTestEntityConfiguration =
|
|||||||
databaseAdapterFlavor: 'postgres',
|
databaseAdapterFlavor: 'postgres',
|
||||||
cacheAdapterFlavor: 'redis',
|
cacheAdapterFlavor: 'redis',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||||
|
entityClass: PostgresValidatorTestEntity,
|
||||||
|
entityConfiguration: postgresTestEntityConfiguration,
|
||||||
|
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
|
||||||
|
mutationValidators: () => [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
|
||||||
|
});
|
||||||
+2
-2
@@ -11,7 +11,7 @@ import PostgresEntityQueryContextProvider from '../PostgresEntityQueryContextPro
|
|||||||
|
|
||||||
export const createKnexIntegrationTestEntityCompanionProvider = (
|
export const createKnexIntegrationTestEntityCompanionProvider = (
|
||||||
knex: Knex,
|
knex: Knex,
|
||||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
|
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||||
): EntityCompanionProvider => {
|
): EntityCompanionProvider => {
|
||||||
return new EntityCompanionProvider(
|
return new EntityCompanionProvider(
|
||||||
metricsAdapter,
|
metricsAdapter,
|
||||||
@@ -31,6 +31,6 @@ export const createKnexIntegrationTestEntityCompanionProvider = (
|
|||||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
]),
|
])
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -3,169 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* constrain entity fields type to string-keyed object ([#235](https://github.com/expo/entity/issues/235)) ([7e2cea1](https://github.com/expo/entity/commit/7e2cea16973a0ae1917f867cd25d6ef7c8eaecef))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* add previousValue to privacy policy context for updates ([#232](https://github.com/expo/entity/issues/232)) ([af495a9](https://github.com/expo/entity/commit/af495a9a856a5042f00cfd150348e415139cb85e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-example
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-example
|
**Note:** Version bump only for package @expo/entity-example
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@expo/entity-example",
|
"name": "@expo/entity-example",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "0.37.0",
|
"version": "0.24.0",
|
||||||
"description": "An example integration of the @expo/entity framework",
|
"description": "An example integration of the @expo/entity framework",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"tsc": "tsc",
|
"tsc": "tsc",
|
||||||
@@ -11,11 +11,11 @@
|
|||||||
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
"test": "jest --rootDir . --config ../../resources/jest.config.js",
|
||||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||||
"barrelsby": "",
|
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete",
|
||||||
"start": "tsnd --transpile-only --inspect --respawn --no-notify --async-stack-traces --throw-deprecation -- src/index.ts"
|
"start": "tsnd --transpile-only --inspect --respawn --no-notify --async-stack-traces --throw-deprecation -- src/index.ts"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16"
|
"node": ">=12"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"entity"
|
"entity"
|
||||||
@@ -23,20 +23,16 @@
|
|||||||
"author": "Expo",
|
"author": "Expo",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@apollo/server": "^4.7.3",
|
"@expo/entity": "^0.24.0",
|
||||||
"@as-integrations/koa": "^1.1.1",
|
"apollo-server-koa": "^2.16.1",
|
||||||
"@expo/entity": "^0.37.0",
|
"graphql": "^15.3.0",
|
||||||
"@koa/cors": "^4.0.0",
|
"koa": "^2.13.0",
|
||||||
"@koa/router": "^12.0.0",
|
"koa-body": "^4.2.0",
|
||||||
"graphql": "^16.6.0",
|
"koa-router": "^9.4.0"
|
||||||
"koa": "^2.14.2",
|
|
||||||
"koa-bodyparser": "^4.4.0"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/koa": "^2.13.6",
|
"@types/koa": "^2.11.4",
|
||||||
"@types/koa-bodyparser": "^4.3.10",
|
"@types/koa-router": "^7.4.1",
|
||||||
"@types/koa__cors": "^4.0.0",
|
|
||||||
"@types/koa__router": "^12.0.0",
|
|
||||||
"@types/supertest": "^2.0.10",
|
"@types/supertest": "^2.0.10",
|
||||||
"supertest": "^4.0.2",
|
"supertest": "^4.0.2",
|
||||||
"ts-node-dev": "^1.0.0-pre.60"
|
"ts-node-dev": "^1.0.0-pre.60"
|
||||||
|
|||||||
@@ -2,11 +2,10 @@ import http from 'http';
|
|||||||
import request from 'supertest';
|
import request from 'supertest';
|
||||||
import { v4 as uuidv4 } from 'uuid';
|
import { v4 as uuidv4 } from 'uuid';
|
||||||
|
|
||||||
import createAppAsync from '../app';
|
import app from '../app';
|
||||||
|
|
||||||
describe('graphql', () => {
|
describe('graphql', () => {
|
||||||
it('allows CRUD of user notes', async () => {
|
it('allows CRUD of user notes', async () => {
|
||||||
const app = await createAppAsync();
|
|
||||||
const server = request(http.createServer(app.callback()));
|
const server = request(http.createServer(app.callback()));
|
||||||
|
|
||||||
const userId = uuidv4();
|
const userId = uuidv4();
|
||||||
@@ -118,7 +117,6 @@ describe('graphql', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('disallows anonymous note creation', async () => {
|
it('disallows anonymous note creation', async () => {
|
||||||
const app = await createAppAsync();
|
|
||||||
const server = request(http.createServer(app.callback()));
|
const server = request(http.createServer(app.callback()));
|
||||||
const createResponse1 = await server.post('/graphql').send({
|
const createResponse1 = await server.post('/graphql').send({
|
||||||
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
|
||||||
@@ -135,7 +133,6 @@ describe('graphql', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('disallows cross-user note impersonation', async () => {
|
it('disallows cross-user note impersonation', async () => {
|
||||||
const app = await createAppAsync();
|
|
||||||
const server = request(http.createServer(app.callback()));
|
const server = request(http.createServer(app.callback()));
|
||||||
|
|
||||||
const userId = uuidv4();
|
const userId = uuidv4();
|
||||||
|
|||||||
@@ -2,17 +2,15 @@ import http from 'http';
|
|||||||
import request from 'supertest';
|
import request from 'supertest';
|
||||||
import { v4 as uuidv4 } from 'uuid';
|
import { v4 as uuidv4 } from 'uuid';
|
||||||
|
|
||||||
import createAppAsync from '../app';
|
import app from '../app';
|
||||||
|
|
||||||
describe('notesRouter', () => {
|
describe('notesRouter', () => {
|
||||||
it('returns empty array for logged-out', async () => {
|
it('returns empty array for logged-out', async () => {
|
||||||
const app = await createAppAsync();
|
|
||||||
const response = await request(http.createServer(app.callback())).get('/notes/').send();
|
const response = await request(http.createServer(app.callback())).get('/notes/').send();
|
||||||
expect(response.body.notes).toEqual([]);
|
expect(response.body.notes).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('allows CRUD of user notes', async () => {
|
it('allows CRUD of user notes', async () => {
|
||||||
const app = await createAppAsync();
|
|
||||||
const server = request(http.createServer(app.callback()));
|
const server = request(http.createServer(app.callback()));
|
||||||
|
|
||||||
const userId = uuidv4();
|
const userId = uuidv4();
|
||||||
@@ -86,7 +84,6 @@ describe('notesRouter', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('disallows anonymous note creation', async () => {
|
it('disallows anonymous note creation', async () => {
|
||||||
const app = await createAppAsync();
|
|
||||||
const server = request(http.createServer(app.callback()));
|
const server = request(http.createServer(app.callback()));
|
||||||
const createResponse1 = await server.post('/notes/').send({
|
const createResponse1 = await server.post('/notes/').send({
|
||||||
title: 'track',
|
title: 'track',
|
||||||
@@ -97,7 +94,6 @@ describe('notesRouter', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('disallows cross-user note impersonation', async () => {
|
it('disallows cross-user note impersonation', async () => {
|
||||||
const app = await createAppAsync();
|
|
||||||
const server = request(http.createServer(app.callback()));
|
const server = request(http.createServer(app.callback()));
|
||||||
const userId = uuidv4();
|
const userId = uuidv4();
|
||||||
const userId2 = uuidv4();
|
const userId2 = uuidv4();
|
||||||
|
|||||||
@@ -15,8 +15,8 @@ import { v4 as uuidv4 } from 'uuid';
|
|||||||
const dbObjects: Readonly<{ [key: string]: any }>[] = [];
|
const dbObjects: Readonly<{ [key: string]: any }>[] = [];
|
||||||
|
|
||||||
export class InMemoryDatabaseAdapterProvider implements IEntityDatabaseAdapterProvider {
|
export class InMemoryDatabaseAdapterProvider implements IEntityDatabaseAdapterProvider {
|
||||||
getDatabaseAdapter<TFields extends Record<string, any>>(
|
getDatabaseAdapter<TFields>(
|
||||||
entityConfiguration: EntityConfiguration<TFields>,
|
entityConfiguration: EntityConfiguration<TFields>
|
||||||
): EntityDatabaseAdapter<TFields> {
|
): EntityDatabaseAdapter<TFields> {
|
||||||
return new InMemoryDatabaseAdapter(entityConfiguration);
|
return new InMemoryDatabaseAdapter(entityConfiguration);
|
||||||
}
|
}
|
||||||
@@ -26,7 +26,7 @@ export class InMemoryDatabaseAdapterProvider implements IEntityDatabaseAdapterPr
|
|||||||
* In-memory database adapter for entity for the purposes of this example. Normally `@expo/entity-database-adapter-knex`
|
* In-memory database adapter for entity for the purposes of this example. Normally `@expo/entity-database-adapter-knex`
|
||||||
* or another production adapter would be used. Very similar to StubDatabaseAdapter but shared in a way more akin to a normal database.
|
* or another production adapter would be used. Very similar to StubDatabaseAdapter but shared in a way more akin to a normal database.
|
||||||
*/
|
*/
|
||||||
class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatabaseAdapter<T> {
|
class InMemoryDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
|
||||||
protected getFieldTransformerMap(): FieldTransformerMap {
|
protected getFieldTransformerMap(): FieldTransformerMap {
|
||||||
return new Map();
|
return new Map();
|
||||||
}
|
}
|
||||||
@@ -35,13 +35,13 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
_queryInterface: any,
|
_queryInterface: any,
|
||||||
_tableName: string,
|
_tableName: string,
|
||||||
tableField: string,
|
tableField: string,
|
||||||
tableValues: readonly any[],
|
tableValues: readonly any[]
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
return tableValues.reduce((acc, fieldValue) => {
|
return tableValues.reduce((acc, fieldValue) => {
|
||||||
return acc.concat(
|
return acc.concat(
|
||||||
dbObjects.filter((obj) => {
|
dbObjects.filter((obj) => {
|
||||||
return obj[tableField] === fieldValue;
|
return obj[tableField] === fieldValue;
|
||||||
}),
|
})
|
||||||
);
|
);
|
||||||
}, []);
|
}, []);
|
||||||
}
|
}
|
||||||
@@ -52,7 +52,7 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
order: OrderByOrdering;
|
order: OrderByOrdering;
|
||||||
}[],
|
}[],
|
||||||
objectA: { [key: string]: any },
|
objectA: { [key: string]: any },
|
||||||
objectB: { [key: string]: any },
|
objectB: { [key: string]: any }
|
||||||
): 0 | 1 | -1 {
|
): 0 | 1 | -1 {
|
||||||
if (orderBys.length === 0) {
|
if (orderBys.length === 0) {
|
||||||
return 0;
|
return 0;
|
||||||
@@ -66,14 +66,14 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
return aField > bField
|
return aField > bField
|
||||||
? -1
|
? -1
|
||||||
: aField < bField
|
: aField < bField
|
||||||
? 1
|
? 1
|
||||||
: this.compareByOrderBys(orderBys.slice(1), objectA, objectB);
|
: this.compareByOrderBys(orderBys.slice(1), objectA, objectB);
|
||||||
case OrderByOrdering.ASCENDING:
|
case OrderByOrdering.ASCENDING:
|
||||||
return bField > aField
|
return bField > aField
|
||||||
? -1
|
? -1
|
||||||
: bField < aField
|
: bField < aField
|
||||||
? 1
|
? 1
|
||||||
: this.compareByOrderBys(orderBys.slice(1), objectA, objectB);
|
: this.compareByOrderBys(orderBys.slice(1), objectA, objectB);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
_tableName: string,
|
_tableName: string,
|
||||||
tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[],
|
tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[],
|
||||||
tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[],
|
tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[],
|
||||||
querySelectionModifiers: TableQuerySelectionModifiers,
|
querySelectionModifiers: TableQuerySelectionModifiers
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
let filteredObjects = dbObjects;
|
let filteredObjects = dbObjects;
|
||||||
for (const { tableField, tableValue } of tableFieldSingleValueEqualityOperands) {
|
for (const { tableField, tableValue } of tableFieldSingleValueEqualityOperands) {
|
||||||
@@ -96,7 +96,7 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
const orderBy = querySelectionModifiers.orderBy;
|
const orderBy = querySelectionModifiers.orderBy;
|
||||||
if (orderBy !== undefined) {
|
if (orderBy !== undefined) {
|
||||||
filteredObjects = filteredObjects.sort((a, b) =>
|
filteredObjects = filteredObjects.sort((a, b) =>
|
||||||
InMemoryDatabaseAdapter.compareByOrderBys(orderBy, a, b),
|
InMemoryDatabaseAdapter.compareByOrderBys(orderBy, a, b)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
_tableName: string,
|
_tableName: string,
|
||||||
_rawWhereClause: string,
|
_rawWhereClause: string,
|
||||||
_bindings: object | any[],
|
_bindings: object | any[],
|
||||||
_querySelectionModifiers: TableQuerySelectionModifiers,
|
_querySelectionModifiers: TableQuerySelectionModifiers
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
throw new Error('Raw WHERE clauses not supported for InMemoryDatabaseAdapter');
|
throw new Error('Raw WHERE clauses not supported for InMemoryDatabaseAdapter');
|
||||||
}
|
}
|
||||||
@@ -126,12 +126,12 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
protected async insertInternalAsync(
|
protected async insertInternalAsync(
|
||||||
_queryInterface: any,
|
_queryInterface: any,
|
||||||
_tableName: string,
|
_tableName: string,
|
||||||
object: object,
|
object: object
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
const configurationPrivate = this['entityConfiguration'] as EntityConfiguration<T>;
|
const configurationPrivate = this['entityConfiguration'] as EntityConfiguration<T>;
|
||||||
const idField = getDatabaseFieldForEntityField(
|
const idField = getDatabaseFieldForEntityField(
|
||||||
configurationPrivate,
|
configurationPrivate,
|
||||||
configurationPrivate.idField,
|
configurationPrivate.idField
|
||||||
);
|
);
|
||||||
const objectToInsert = {
|
const objectToInsert = {
|
||||||
[idField]: uuidv4(),
|
[idField]: uuidv4(),
|
||||||
@@ -146,7 +146,7 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
_tableName: string,
|
_tableName: string,
|
||||||
tableIdField: string,
|
tableIdField: string,
|
||||||
id: any,
|
id: any,
|
||||||
object: object,
|
object: object
|
||||||
): Promise<object[]> {
|
): Promise<object[]> {
|
||||||
// SQL does not support empty updates, mirror behavior here for better test simulation
|
// SQL does not support empty updates, mirror behavior here for better test simulation
|
||||||
if (Object.keys(object).length === 0) {
|
if (Object.keys(object).length === 0) {
|
||||||
@@ -168,7 +168,7 @@ class InMemoryDatabaseAdapter<T extends Record<string, any>> extends EntityDatab
|
|||||||
_queryInterface: any,
|
_queryInterface: any,
|
||||||
_tableName: string,
|
_tableName: string,
|
||||||
tableIdField: string,
|
tableIdField: string,
|
||||||
id: any,
|
id: any
|
||||||
): Promise<number> {
|
): Promise<number> {
|
||||||
const objectIndex = dbObjects.findIndex((obj) => {
|
const objectIndex = dbObjects.findIndex((obj) => {
|
||||||
return obj[tableIdField] === id;
|
return obj[tableIdField] === id;
|
||||||
|
|||||||
@@ -1,19 +1,13 @@
|
|||||||
import { EntityQueryContextProvider, TransactionConfig } from '@expo/entity';
|
import { EntityQueryContextProvider } from '@expo/entity';
|
||||||
|
|
||||||
export default class InMemoryQueryContextProvider extends EntityQueryContextProvider {
|
export default class InMemoryQueryContextProvider extends EntityQueryContextProvider {
|
||||||
protected getQueryInterface(): any {
|
protected getQueryInterface(): any {
|
||||||
return {};
|
return {};
|
||||||
}
|
}
|
||||||
|
|
||||||
protected createTransactionRunner<T>(
|
protected createTransactionRunner<T>(): (
|
||||||
_transactionConfig?: TransactionConfig,
|
transactionScope: (queryInterface: any) => Promise<T>
|
||||||
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
|
) => Promise<T> {
|
||||||
return (transactionScope) => Promise.resolve(transactionScope({}));
|
|
||||||
}
|
|
||||||
|
|
||||||
protected createNestedTransactionRunner<T>(
|
|
||||||
_outerQueryInterface: any,
|
|
||||||
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
|
|
||||||
return (transactionScope) => Promise.resolve(transactionScope({}));
|
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 { EntityCompanionProvider } from '@expo/entity';
|
||||||
import cors from '@koa/cors';
|
import { ApolloServer } from 'apollo-server-koa';
|
||||||
import Router from '@koa/router';
|
|
||||||
import Koa from '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 { entityCompanionMiddleware, viewerContextMiddleware } from './middleware';
|
||||||
import notesRouter from './routers/notesRouter';
|
import notesRouter from './routers/notesRouter';
|
||||||
import { typeDefs, resolvers } from './schema';
|
import { typeDefs, resolvers } from './schema';
|
||||||
import { ExampleViewerContext } from './viewerContexts';
|
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.
|
* Koa provides a per-request state container to place custom properties.
|
||||||
@@ -23,40 +21,31 @@ export type ExampleState = {
|
|||||||
entityCompanionProvider: EntityCompanionProvider; // entityCompanionMiddleware
|
entityCompanionProvider: EntityCompanionProvider; // entityCompanionMiddleware
|
||||||
};
|
};
|
||||||
|
|
||||||
export default async function createAppAsync(): Promise<Koa<ExampleState, ExampleContext>> {
|
const app = new Koa();
|
||||||
const app = new Koa<ExampleState, ExampleContext>();
|
|
||||||
|
|
||||||
// initialze the entity framework for each request
|
// body parsing for POST/PUT requests
|
||||||
app.use(entityCompanionMiddleware);
|
app.use(koaBody());
|
||||||
|
|
||||||
// generate a viewer context for each request
|
// initialze the entity framework for each request
|
||||||
app.use(viewerContextMiddleware);
|
app.use(entityCompanionMiddleware);
|
||||||
|
|
||||||
app.use(cors());
|
// generate a viewer context for each request
|
||||||
|
app.use(viewerContextMiddleware);
|
||||||
|
|
||||||
// body parsing for POST/PUT requests
|
// serve routes that make use of the viewer context
|
||||||
app.use(bodyParser());
|
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 server = new ApolloServer({
|
||||||
const router = new Router<ExampleState, ExampleContext>();
|
typeDefs,
|
||||||
|
resolvers,
|
||||||
|
context: ({ ctx }) => {
|
||||||
|
return {
|
||||||
|
viewerContext: ctx.state.viewerContext,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
});
|
||||||
|
app.use(server.getMiddleware({ cors: false, disableHealthCheck: true, bodyParserConfig: false }));
|
||||||
|
|
||||||
// normal API routes
|
export default app;
|
||||||
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;
|
|
||||||
}
|
|
||||||
@@ -15,7 +15,7 @@ import InMemoryQueryContextProvider from './adapters/InMemoryQueryContextProvide
|
|||||||
* One EntityCompanionProvider should be created per-request.
|
* One EntityCompanionProvider should be created per-request.
|
||||||
*/
|
*/
|
||||||
export const createEntityCompanionProvider = (
|
export const createEntityCompanionProvider = (
|
||||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
|
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||||
): EntityCompanionProvider => {
|
): EntityCompanionProvider => {
|
||||||
return new EntityCompanionProvider(
|
return new EntityCompanionProvider(
|
||||||
metricsAdapter,
|
metricsAdapter,
|
||||||
@@ -39,6 +39,6 @@ export const createEntityCompanionProvider = (
|
|||||||
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
]),
|
])
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -3,7 +3,6 @@ import {
|
|||||||
ReadonlyEntity,
|
ReadonlyEntity,
|
||||||
EntityQueryContext,
|
EntityQueryContext,
|
||||||
RuleEvaluationResult,
|
RuleEvaluationResult,
|
||||||
EntityPrivacyPolicyEvaluationContext,
|
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
|
|
||||||
import { ExampleViewerContext } from '../viewerContexts';
|
import { ExampleViewerContext } from '../viewerContexts';
|
||||||
@@ -23,10 +22,10 @@ import { ExampleViewerContext } from '../viewerContexts';
|
|||||||
* Otherwise, it defers to the next rule in the policy.
|
* Otherwise, it defers to the next rule in the policy.
|
||||||
*/
|
*/
|
||||||
export default class AllowIfUserOwnerPrivacyRule<
|
export default class AllowIfUserOwnerPrivacyRule<
|
||||||
TFields extends object,
|
TFields,
|
||||||
TID extends NonNullable<TFields[TSelectedFields]>,
|
TID extends NonNullable<TFields[TSelectedFields]>,
|
||||||
TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>,
|
TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>,
|
||||||
TSelectedFields extends keyof TFields = keyof TFields,
|
TSelectedFields extends keyof TFields = keyof TFields
|
||||||
> extends PrivacyPolicyRule<TFields, TID, ExampleViewerContext, TEntity> {
|
> extends PrivacyPolicyRule<TFields, TID, ExampleViewerContext, TEntity> {
|
||||||
constructor(private readonly entityOwnerField: keyof TFields) {
|
constructor(private readonly entityOwnerField: keyof TFields) {
|
||||||
super();
|
super();
|
||||||
@@ -35,14 +34,7 @@ export default class AllowIfUserOwnerPrivacyRule<
|
|||||||
async evaluateAsync(
|
async evaluateAsync(
|
||||||
viewerContext: ExampleViewerContext,
|
viewerContext: ExampleViewerContext,
|
||||||
_queryContext: EntityQueryContext,
|
_queryContext: EntityQueryContext,
|
||||||
_evaluationContext: EntityPrivacyPolicyEvaluationContext<
|
entity: TEntity
|
||||||
TFields,
|
|
||||||
TID,
|
|
||||||
ExampleViewerContext,
|
|
||||||
TEntity,
|
|
||||||
TSelectedFields
|
|
||||||
>,
|
|
||||||
entity: TEntity,
|
|
||||||
): Promise<RuleEvaluationResult> {
|
): Promise<RuleEvaluationResult> {
|
||||||
if (viewerContext.isUserViewerContext()) {
|
if (viewerContext.isUserViewerContext()) {
|
||||||
if (String(entity.getField(this.entityOwnerField)) === viewerContext.userID) {
|
if (String(entity.getField(this.entityOwnerField)) === viewerContext.userID) {
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ import {
|
|||||||
StringField,
|
StringField,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
|
|
||||||
import NotePrivacyPolicy from './NotePrivacyPolicy';
|
|
||||||
import { ExampleViewerContext } from '../viewerContexts';
|
import { ExampleViewerContext } from '../viewerContexts';
|
||||||
|
import NotePrivacyPolicy from './NotePrivacyPolicy';
|
||||||
|
|
||||||
export interface NoteFields {
|
export interface NoteFields {
|
||||||
id: string;
|
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.
|
* 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> {
|
export default class NoteEntity extends Entity<NoteFields, string, ExampleViewerContext> {
|
||||||
/**
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
* 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<
|
|
||||||
NoteFields,
|
NoteFields,
|
||||||
string,
|
string,
|
||||||
ExampleViewerContext,
|
ExampleViewerContext,
|
||||||
NoteEntity,
|
NoteEntity,
|
||||||
NotePrivacyPolicy
|
NotePrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return noteEntityCompanion;
|
||||||
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,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 { EntityPrivacyPolicy, AlwaysAllowPrivacyPolicyRule } from '@expo/entity';
|
||||||
|
|
||||||
|
import { ExampleViewerContext } from '../viewerContexts';
|
||||||
import AllowIfUserOwnerPrivacyRule from './AllowIfUserOwnerPrivacyRule';
|
import AllowIfUserOwnerPrivacyRule from './AllowIfUserOwnerPrivacyRule';
|
||||||
import NoteEntity, { NoteFields } from './NoteEntity';
|
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.
|
* 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 mainAsync(): Promise<void> {
|
app.listen(3000);
|
||||||
const app = await createAppAsync();
|
|
||||||
app.listen(3000);
|
|
||||||
}
|
|
||||||
|
|
||||||
mainAsync();
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import Router from '@koa/router';
|
import KoaRouter from 'koa-router';
|
||||||
|
|
||||||
import { ExampleState, ExampleContext } from '../app';
|
import { ExampleState, ExampleContext } from '../app';
|
||||||
import NoteEntity from '../entities/NoteEntity';
|
import NoteEntity from '../entities/NoteEntity';
|
||||||
@@ -11,11 +11,11 @@ import NoteEntity from '../entities/NoteEntity';
|
|||||||
* PUT /notes/:id - update a note
|
* PUT /notes/:id - update a note
|
||||||
* DELETE /notes/:id - delete a note
|
* DELETE /notes/:id - delete a note
|
||||||
*/
|
*/
|
||||||
const router = new Router<ExampleState, ExampleContext>({
|
const router = new KoaRouter<ExampleState>({
|
||||||
prefix: '/notes',
|
prefix: '/notes',
|
||||||
});
|
});
|
||||||
|
|
||||||
router.get('/', async (ctx) => {
|
router.get('/', async (ctx: ExampleContext) => {
|
||||||
const viewerContext = ctx.state.viewerContext;
|
const viewerContext = ctx.state.viewerContext;
|
||||||
let notes: readonly NoteEntity[] = [];
|
let notes: readonly NoteEntity[] = [];
|
||||||
if (viewerContext.isUserViewerContext()) {
|
if (viewerContext.isUserViewerContext()) {
|
||||||
@@ -28,14 +28,11 @@ router.get('/', async (ctx) => {
|
|||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
router.get('/:id', async (ctx) => {
|
router.get('/:id', async (ctx: ExampleContext) => {
|
||||||
const viewerContext = ctx.state.viewerContext;
|
const viewerContext = ctx.state.viewerContext;
|
||||||
const noteResult = await NoteEntity.loader(viewerContext)
|
const noteResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||||
.withAuthorizationResults()
|
|
||||||
.loadByIDAsync(ctx.params['id']!);
|
|
||||||
if (!noteResult.ok) {
|
if (!noteResult.ok) {
|
||||||
ctx.throw(403, noteResult.reason);
|
ctx.throw(403, noteResult.reason);
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx.body = {
|
ctx.body = {
|
||||||
@@ -43,17 +40,16 @@ router.get('/:id', async (ctx) => {
|
|||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
router.post('/', async (ctx) => {
|
router.post('/', async (ctx: ExampleContext) => {
|
||||||
const viewerContext = ctx.state.viewerContext;
|
const viewerContext = ctx.state.viewerContext;
|
||||||
if (!viewerContext.isUserViewerContext()) {
|
if (!viewerContext.isUserViewerContext()) {
|
||||||
// Only logged-in users can create notes. Technically this
|
// Only logged-in users can create notes. Technically this
|
||||||
// would be handled by the privacy policy (it would fail)
|
// would be handled by the privacy policy (it would fail)
|
||||||
// but we throw here for better type safety.
|
// but we throw here for better type safety.
|
||||||
ctx.throw(403);
|
ctx.throw(403);
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const { title, body } = ctx.request.body as any;
|
const { title, body } = ctx.request.body;
|
||||||
|
|
||||||
const createResult = await NoteEntity.creator(viewerContext)
|
const createResult = await NoteEntity.creator(viewerContext)
|
||||||
.setField('userID', viewerContext.userID)
|
.setField('userID', viewerContext.userID)
|
||||||
@@ -62,7 +58,6 @@ router.post('/', async (ctx) => {
|
|||||||
.createAsync();
|
.createAsync();
|
||||||
if (!createResult.ok) {
|
if (!createResult.ok) {
|
||||||
ctx.throw(403, createResult.reason);
|
ctx.throw(403, createResult.reason);
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx.body = {
|
ctx.body = {
|
||||||
@@ -70,16 +65,13 @@ router.post('/', async (ctx) => {
|
|||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
router.put('/:id', async (ctx) => {
|
router.put('/:id', async (ctx: ExampleContext) => {
|
||||||
const viewerContext = ctx.state.viewerContext;
|
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)
|
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||||
.withAuthorizationResults()
|
|
||||||
.loadByIDAsync(ctx.params['id']!);
|
|
||||||
if (!noteLoadResult.ok) {
|
if (!noteLoadResult.ok) {
|
||||||
ctx.throw(403, noteLoadResult.reason);
|
ctx.throw(403, noteLoadResult.reason);
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const noteUpdateResult = await NoteEntity.updater(noteLoadResult.value)
|
const noteUpdateResult = await NoteEntity.updater(noteLoadResult.value)
|
||||||
@@ -88,7 +80,6 @@ router.put('/:id', async (ctx) => {
|
|||||||
.updateAsync();
|
.updateAsync();
|
||||||
if (!noteUpdateResult.ok) {
|
if (!noteUpdateResult.ok) {
|
||||||
ctx.throw(403, noteUpdateResult.reason);
|
ctx.throw(403, noteUpdateResult.reason);
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx.body = {
|
ctx.body = {
|
||||||
@@ -96,21 +87,17 @@ router.put('/:id', async (ctx) => {
|
|||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
router.delete('/:id', async (ctx) => {
|
router.delete('/:id', async (ctx: ExampleContext) => {
|
||||||
const viewerContext = ctx.state.viewerContext;
|
const viewerContext = ctx.state.viewerContext;
|
||||||
|
|
||||||
const noteLoadResult = await NoteEntity.loader(viewerContext)
|
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params.id);
|
||||||
.withAuthorizationResults()
|
|
||||||
.loadByIDAsync(ctx.params['id']!);
|
|
||||||
if (!noteLoadResult.ok) {
|
if (!noteLoadResult.ok) {
|
||||||
ctx.throw(403, noteLoadResult.reason);
|
ctx.throw(403, noteLoadResult.reason);
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const noteDeleteResult = await NoteEntity.deleteAsync(noteLoadResult.value);
|
const noteDeleteResult = await NoteEntity.deleteAsync(noteLoadResult.value);
|
||||||
if (!noteDeleteResult.ok) {
|
if (!noteDeleteResult.ok) {
|
||||||
ctx.throw(403, noteDeleteResult.reason);
|
ctx.throw(403, noteDeleteResult.reason);
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx.body = {
|
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 NoteEntity from './entities/NoteEntity';
|
||||||
import { ExampleViewerContext } from './viewerContexts';
|
import { ExampleViewerContext } from './viewerContexts';
|
||||||
@@ -7,7 +7,7 @@ type GraphqlContext = {
|
|||||||
viewerContext: ExampleViewerContext;
|
viewerContext: ExampleViewerContext;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const typeDefs = `#graphql
|
export const typeDefs = gql`
|
||||||
type User {
|
type User {
|
||||||
id: ID!
|
id: ID!
|
||||||
notes: [Note]!
|
notes: [Note]!
|
||||||
@@ -48,7 +48,7 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
|||||||
async noteByID(_root, args, { viewerContext }) {
|
async noteByID(_root, args, { viewerContext }) {
|
||||||
return await NoteEntity.loader(viewerContext).enforcing().loadByIDAsync(args.id);
|
return await NoteEntity.loader(viewerContext).enforcing().loadByIDAsync(args.id);
|
||||||
},
|
},
|
||||||
} as IObjectTypeResolver<any, GraphqlContext>,
|
} as IResolverObject<any, GraphqlContext>,
|
||||||
|
|
||||||
User: {
|
User: {
|
||||||
id: (root) => root,
|
id: (root) => root,
|
||||||
@@ -57,14 +57,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
|||||||
.enforcing()
|
.enforcing()
|
||||||
.loadManyByFieldEqualingAsync('userID', root);
|
.loadManyByFieldEqualingAsync('userID', root);
|
||||||
},
|
},
|
||||||
} as IObjectTypeResolver<string, GraphqlContext>,
|
} as IResolverObject<string, GraphqlContext>,
|
||||||
|
|
||||||
Note: {
|
Note: {
|
||||||
id: (root) => root.getID(),
|
id: (root) => root.getID(),
|
||||||
title: (root) => root.getField('title'),
|
title: (root) => root.getField('title'),
|
||||||
body: (root) => root.getField('body'),
|
body: (root) => root.getField('body'),
|
||||||
user: (root) => root.getField('userID'),
|
user: (root) => root.getField('userID'),
|
||||||
} as IObjectTypeResolver<NoteEntity, GraphqlContext>,
|
} as IResolverObject<NoteEntity, GraphqlContext>,
|
||||||
|
|
||||||
Mutation: {
|
Mutation: {
|
||||||
async addNote(_root, args, { viewerContext }) {
|
async addNote(_root, args, { viewerContext }) {
|
||||||
@@ -94,5 +94,5 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
|
|||||||
await NoteEntity.enforceDeleteAsync(existingNote);
|
await NoteEntity.enforceDeleteAsync(existingNote);
|
||||||
return existingNote;
|
return existingNote;
|
||||||
},
|
},
|
||||||
} as IObjectTypeResolver<any, GraphqlContext>,
|
} as IResolverObject<any, GraphqlContext>,
|
||||||
};
|
};
|
||||||
@@ -17,10 +17,7 @@ export abstract class ExampleViewerContext extends ViewerContext {
|
|||||||
* Represents a logged-in user.
|
* Represents a logged-in user.
|
||||||
*/
|
*/
|
||||||
export class UserViewerContext extends ExampleViewerContext {
|
export class UserViewerContext extends ExampleViewerContext {
|
||||||
constructor(
|
constructor(entityCompanionProvider: EntityCompanionProvider, public userID: string) {
|
||||||
entityCompanionProvider: EntityCompanionProvider,
|
|
||||||
public userID: string,
|
|
||||||
) {
|
|
||||||
super(entityCompanionProvider);
|
super(entityCompanionProvider);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,168 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* always reload entity after update since cascading changes may have changed it since commit ([#233](https://github.com/expo/entity/issues/233)) ([7c3c985](https://github.com/expo/entity/commit/7c3c9854a4dd91d4b73ebdb18bdeadea8b63f4c7))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
**Note:** Version bump only for package @expo/entity-full-integration-tests
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@expo/entity-full-integration-tests",
|
"name": "@expo/entity-full-integration-tests",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "0.37.0",
|
"version": "0.24.0",
|
||||||
"description": "Full redis and knex integration tests for the entity framework",
|
"description": "Full redis and knex integration tests for the entity framework",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"tsc": "tsc",
|
"tsc": "tsc",
|
||||||
@@ -11,10 +11,10 @@
|
|||||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||||
"barrelsby": "barrelsby --config ../../.barrelsby.json"
|
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16"
|
"node": ">=12"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"entity"
|
"entity"
|
||||||
@@ -27,8 +27,8 @@
|
|||||||
"@expo/entity-database-adapter-knex": "*"
|
"@expo/entity-database-adapter-knex": "*"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@expo/entity": "^0.37.0",
|
"@expo/entity": "^0.24.0",
|
||||||
"@expo/entity-cache-adapter-redis": "^0.37.0",
|
"@expo/entity-cache-adapter-redis": "^0.24.0",
|
||||||
"@expo/entity-database-adapter-knex": "^0.37.0"
|
"@expo/entity-database-adapter-knex": "^0.24.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+32
-25
@@ -8,7 +8,7 @@ import {
|
|||||||
UUIDField,
|
UUIDField,
|
||||||
StringField,
|
StringField,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
|
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||||
import Redis from 'ioredis';
|
import Redis from 'ioredis';
|
||||||
import { knex, Knex } from 'knex';
|
import { knex, Knex } from 'knex';
|
||||||
import nullthrows from 'nullthrows';
|
import nullthrows from 'nullthrows';
|
||||||
@@ -43,18 +43,14 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
|||||||
}
|
}
|
||||||
|
|
||||||
class TestEntity extends Entity<TestFields, string, ViewerContext> {
|
class TestEntity extends Entity<TestFields, string, ViewerContext> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
TestFields,
|
TestFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
TestEntity,
|
TestEntity,
|
||||||
TestEntityPrivacyPolicy
|
TestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return testEntityCompanion;
|
||||||
entityClass: TestEntity,
|
|
||||||
entityConfiguration: testEntityConfiguration,
|
|
||||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -78,25 +74,35 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
|
|||||||
cacheAdapterFlavor: 'redis',
|
cacheAdapterFlavor: 'redis',
|
||||||
});
|
});
|
||||||
|
|
||||||
async function createOrTruncatePostgresTablesAsync(knex: Knex): Promise<void> {
|
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) => {
|
await knex.schema.createTable('testentities', (table) => {
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||||
table.string('other_string').notNullable();
|
table.string('other_string').notNullable();
|
||||||
table.string('third_string').notNullable();
|
table.string('third_string').notNullable();
|
||||||
});
|
});
|
||||||
await knex.into('testentities').truncate();
|
await knex.into('testentities').truncate();
|
||||||
}
|
}
|
||||||
|
|
||||||
async function dropPostgresTableAsync(knex: Knex): Promise<void> {
|
async function dropPostgresTable(knex: Knex): Promise<void> {
|
||||||
if (await knex.schema.hasTable('testentities')) {
|
if (await knex.schema.hasTable('children')) {
|
||||||
await knex.schema.dropTable('testentities');
|
await knex.schema.dropTable('children');
|
||||||
|
}
|
||||||
|
if (await knex.schema.hasTable('parents')) {
|
||||||
|
await knex.schema.dropTable('parents');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
describe('Entity cache inconsistency', () => {
|
describe('Entity cache inconsistency', () => {
|
||||||
let knexInstance: Knex;
|
let knexInstance: Knex;
|
||||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
|
||||||
|
|
||||||
beforeAll(() => {
|
beforeAll(() => {
|
||||||
knexInstance = knex({
|
knexInstance = knex({
|
||||||
@@ -109,35 +115,36 @@ describe('Entity cache inconsistency', () => {
|
|||||||
database: nullthrows(process.env['PGDATABASE']),
|
database: nullthrows(process.env['PGDATABASE']),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
genericRedisCacheContext = {
|
redisCacheAdapterContext = {
|
||||||
redisClient,
|
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||||
makeKeyFn(...parts: string[]): string {
|
makeKeyFn(...parts: string[]): string {
|
||||||
const delimiter = ':';
|
const delimiter = ':';
|
||||||
const escapedParts = parts.map((part) =>
|
const escapedParts = parts.map((part) =>
|
||||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`),
|
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||||
);
|
);
|
||||||
return escapedParts.join(delimiter);
|
return escapedParts.join(delimiter);
|
||||||
},
|
},
|
||||||
cacheKeyPrefix: 'test-',
|
cacheKeyPrefix: 'test-',
|
||||||
|
cacheKeyVersion: 1,
|
||||||
ttlSecondsPositive: 86400, // 1 day
|
ttlSecondsPositive: 86400, // 1 day
|
||||||
ttlSecondsNegative: 600, // 10 minutes
|
ttlSecondsNegative: 600, // 10 minutes
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await createOrTruncatePostgresTablesAsync(knexInstance);
|
await createOrTruncatePostgresTables(knexInstance);
|
||||||
await redisClient.flushdb();
|
await redisCacheAdapterContext.redisClient.flushdb();
|
||||||
});
|
});
|
||||||
|
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
await dropPostgresTableAsync(knexInstance);
|
await dropPostgresTable(knexInstance);
|
||||||
await knexInstance.destroy();
|
await knexInstance.destroy();
|
||||||
redisClient.disconnect();
|
redisCacheAdapterContext.redisClient.disconnect();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('lots of updates in long-ish running transactions', async () => {
|
test('lots of updates in long-ish running transactions', async () => {
|
||||||
const viewerContext = new ViewerContext(
|
const viewerContext = new ViewerContext(
|
||||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext),
|
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
const entity1 = await TestEntity.creator(viewerContext)
|
const entity1 = await TestEntity.creator(viewerContext)
|
||||||
@@ -170,7 +177,7 @@ describe('Entity cache inconsistency', () => {
|
|||||||
await barrier1;
|
await barrier1;
|
||||||
|
|
||||||
const viewerContextInternal = new ViewerContext(
|
const viewerContextInternal = new ViewerContext(
|
||||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext),
|
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
await TestEntity.loader(viewerContextInternal).enforcing().loadByIDAsync(entity1.getID());
|
await TestEntity.loader(viewerContextInternal).enforcing().loadByIDAsync(entity1.getID());
|
||||||
|
|
||||||
@@ -187,13 +194,13 @@ describe('Entity cache inconsistency', () => {
|
|||||||
|
|
||||||
// wait for to ensure the transaction isn't committed until after load above occurs
|
// wait for to ensure the transaction isn't committed until after load above occurs
|
||||||
await barrier2;
|
await barrier2;
|
||||||
},
|
}
|
||||||
),
|
),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// ensure cache consistency
|
// ensure cache consistency
|
||||||
const viewerContextLast = new ViewerContext(
|
const viewerContextLast = new ViewerContext(
|
||||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext),
|
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
const loadedById = await TestEntity.loader(viewerContextLast)
|
const loadedById = await TestEntity.loader(viewerContextLast)
|
||||||
|
|||||||
+22
-20
@@ -1,28 +1,30 @@
|
|||||||
import { ViewerContext } from '@expo/entity';
|
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 Redis from 'ioredis';
|
||||||
import { knex, Knex } from 'knex';
|
import { knex, Knex } from 'knex';
|
||||||
import nullthrows from 'nullthrows';
|
import nullthrows from 'nullthrows';
|
||||||
import { URL } from 'url';
|
import { URL } from 'url';
|
||||||
|
|
||||||
|
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
||||||
import ChildEntity from './entities/ChildEntity';
|
import ChildEntity from './entities/ChildEntity';
|
||||||
import ParentEntity from './entities/ParentEntity';
|
import ParentEntity from './entities/ParentEntity';
|
||||||
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
|
||||||
|
|
||||||
async function createOrTruncatePostgresTablesAsync(knex: Knex): Promise<void> {
|
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
|
||||||
|
await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'); // for uuid_generate_v4()
|
||||||
|
|
||||||
await knex.schema.createTable('parents', (table) => {
|
await knex.schema.createTable('parents', (table) => {
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||||
});
|
});
|
||||||
await knex.into('parents').truncate();
|
await knex.into('parents').truncate();
|
||||||
|
|
||||||
await knex.schema.createTable('children', (table) => {
|
await knex.schema.createTable('children', (table) => {
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||||
table.uuid('parent_id').references('id').inTable('parents').onDelete('cascade').unique();
|
table.uuid('parent_id').references('id').inTable('parents').onDelete('cascade').unique();
|
||||||
});
|
});
|
||||||
await knex.into('children').truncate();
|
await knex.into('children').truncate();
|
||||||
}
|
}
|
||||||
|
|
||||||
async function dropPostgresTableAsync(knex: Knex): Promise<void> {
|
async function dropPostgresTable(knex: Knex): Promise<void> {
|
||||||
if (await knex.schema.hasTable('children')) {
|
if (await knex.schema.hasTable('children')) {
|
||||||
await knex.schema.dropTable('children');
|
await knex.schema.dropTable('children');
|
||||||
}
|
}
|
||||||
@@ -33,8 +35,7 @@ async function dropPostgresTableAsync(knex: Knex): Promise<void> {
|
|||||||
|
|
||||||
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||||
let knexInstance: Knex;
|
let knexInstance: Knex;
|
||||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
|
||||||
|
|
||||||
beforeAll(() => {
|
beforeAll(() => {
|
||||||
knexInstance = knex({
|
knexInstance = knex({
|
||||||
@@ -47,36 +48,37 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
|||||||
database: nullthrows(process.env['PGDATABASE']),
|
database: nullthrows(process.env['PGDATABASE']),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
genericRedisCacheContext = {
|
redisCacheAdapterContext = {
|
||||||
redisClient,
|
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||||
makeKeyFn(...parts: string[]): string {
|
makeKeyFn(...parts: string[]): string {
|
||||||
const delimiter = ':';
|
const delimiter = ':';
|
||||||
const escapedParts = parts.map((part) =>
|
const escapedParts = parts.map((part) =>
|
||||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`),
|
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||||
);
|
);
|
||||||
return escapedParts.join(delimiter);
|
return escapedParts.join(delimiter);
|
||||||
},
|
},
|
||||||
cacheKeyPrefix: 'test-',
|
cacheKeyPrefix: 'test-',
|
||||||
|
cacheKeyVersion: 1,
|
||||||
ttlSecondsPositive: 86400, // 1 day
|
ttlSecondsPositive: 86400, // 1 day
|
||||||
ttlSecondsNegative: 600, // 10 minutes
|
ttlSecondsNegative: 600, // 10 minutes
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await createOrTruncatePostgresTablesAsync(knexInstance);
|
await createOrTruncatePostgresTables(knexInstance);
|
||||||
await redisClient.flushdb();
|
await redisCacheAdapterContext.redisClient.flushdb();
|
||||||
});
|
});
|
||||||
|
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
await dropPostgresTableAsync(knexInstance);
|
await dropPostgresTable(knexInstance);
|
||||||
await knexInstance.destroy();
|
await knexInstance.destroy();
|
||||||
redisClient.disconnect();
|
redisCacheAdapterContext.redisClient.disconnect();
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('EntityEdgeDeletionBehavior.INVALIDATE_CACHE', () => {
|
describe('EntityEdgeDeletionBehavior.INVALIDATE_CACHE', () => {
|
||||||
it('invalidates the cache', async () => {
|
it('invalidates the cache', async () => {
|
||||||
const viewerContext = new ViewerContext(
|
const viewerContext = new ViewerContext(
|
||||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext),
|
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
|
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
|
||||||
@@ -85,22 +87,22 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
|||||||
.enforceCreateAsync();
|
.enforceCreateAsync();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()),
|
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||||
).resolves.not.toBeNull();
|
).resolves.not.toBeNull();
|
||||||
await expect(
|
await expect(
|
||||||
ChildEntity.loader(viewerContext)
|
ChildEntity.loader(viewerContext)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
.loadByFieldEqualingAsync('parent_id', parent.getID()),
|
.loadByFieldEqualingAsync('parent_id', parent.getID())
|
||||||
).resolves.not.toBeNull();
|
).resolves.not.toBeNull();
|
||||||
|
|
||||||
await ParentEntity.enforceDeleteAsync(parent);
|
await ParentEntity.enforceDeleteAsync(parent);
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID()),
|
ParentEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(parent.getID())
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
|
|
||||||
await expect(
|
await expect(
|
||||||
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID()),
|
ChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(child.getID())
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
-149
@@ -1,149 +0,0 @@
|
|||||||
import {
|
|
||||||
EntityPrivacyPolicy,
|
|
||||||
ViewerContext,
|
|
||||||
AlwaysAllowPrivacyPolicyRule,
|
|
||||||
Entity,
|
|
||||||
EntityCompanionDefinition,
|
|
||||||
EntityConfiguration,
|
|
||||||
UUIDField,
|
|
||||||
} from '@expo/entity';
|
|
||||||
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
|
|
||||||
import Redis from 'ioredis';
|
|
||||||
import { knex, Knex } from 'knex';
|
|
||||||
import nullthrows from 'nullthrows';
|
|
||||||
import { URL } from 'url';
|
|
||||||
import { v4 as uuidv4 } from 'uuid';
|
|
||||||
|
|
||||||
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
|
|
||||||
|
|
||||||
interface TestFields {
|
|
||||||
id: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
|
|
||||||
TestFields,
|
|
||||||
string,
|
|
||||||
ViewerContext,
|
|
||||||
TestEntity
|
|
||||||
> {
|
|
||||||
protected override readonly readRules = [
|
|
||||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
|
||||||
];
|
|
||||||
protected override readonly createRules = [
|
|
||||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
|
||||||
];
|
|
||||||
protected override readonly updateRules = [
|
|
||||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
|
||||||
];
|
|
||||||
protected override readonly deleteRules = [
|
|
||||||
new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
class TestEntity extends Entity<TestFields, string, ViewerContext> {
|
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
|
||||||
TestFields,
|
|
||||||
string,
|
|
||||||
ViewerContext,
|
|
||||||
TestEntity,
|
|
||||||
TestEntityPrivacyPolicy
|
|
||||||
> {
|
|
||||||
return {
|
|
||||||
entityClass: TestEntity,
|
|
||||||
entityConfiguration: testEntityConfiguration,
|
|
||||||
privacyPolicyClass: TestEntityPrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const testEntityConfiguration = new EntityConfiguration<TestFields>({
|
|
||||||
idField: 'id',
|
|
||||||
tableName: 'testentities',
|
|
||||||
schema: {
|
|
||||||
id: new UUIDField({
|
|
||||||
columnName: 'id',
|
|
||||||
cache: true,
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
databaseAdapterFlavor: 'postgres',
|
|
||||||
cacheAdapterFlavor: 'redis',
|
|
||||||
});
|
|
||||||
|
|
||||||
async function createOrTruncatePostgresTablesAsync(knex: Knex): Promise<void> {
|
|
||||||
await knex.schema.createTable('testentities', (table) => {
|
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
|
||||||
});
|
|
||||||
await knex.into('testentities').truncate();
|
|
||||||
}
|
|
||||||
|
|
||||||
async function dropPostgresTableAsync(knex: Knex): Promise<void> {
|
|
||||||
if (await knex.schema.hasTable('testentities')) {
|
|
||||||
await knex.schema.dropTable('testentities');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('Entity integrity', () => {
|
|
||||||
let knexInstance: Knex;
|
|
||||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
|
||||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
|
||||||
|
|
||||||
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']),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
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 createOrTruncatePostgresTablesAsync(knexInstance);
|
|
||||||
await redisClient.flushdb();
|
|
||||||
});
|
|
||||||
|
|
||||||
afterAll(async () => {
|
|
||||||
await dropPostgresTableAsync(knexInstance);
|
|
||||||
await knexInstance.destroy();
|
|
||||||
redisClient.disconnect();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('cannot update ID', async () => {
|
|
||||||
const viewerContext = new ViewerContext(
|
|
||||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext),
|
|
||||||
);
|
|
||||||
|
|
||||||
const entity1 = await TestEntity.creator(viewerContext).enforceCreateAsync();
|
|
||||||
|
|
||||||
await expect(
|
|
||||||
TestEntity.updater(entity1).setField('id', uuidv4()).enforceUpdateAsync(),
|
|
||||||
).rejects.toThrow('id field updates not supported: (entityClass = TestEntity)');
|
|
||||||
|
|
||||||
// ensure cache consistency
|
|
||||||
const viewerContextLast = new ViewerContext(
|
|
||||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext),
|
|
||||||
);
|
|
||||||
|
|
||||||
const loadedById = await TestEntity.loader(viewerContextLast)
|
|
||||||
.enforcing()
|
|
||||||
.loadByIDAsync(entity1.getID());
|
|
||||||
|
|
||||||
expect(loadedById.getID()).toEqual(entity1.getID());
|
|
||||||
});
|
|
||||||
});
|
|
||||||
+39
-56
@@ -8,7 +8,7 @@ import {
|
|||||||
UUIDField,
|
UUIDField,
|
||||||
EntityEdgeDeletionBehavior,
|
EntityEdgeDeletionBehavior,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
|
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
|
||||||
import Redis from 'ioredis';
|
import Redis from 'ioredis';
|
||||||
import { knex, Knex } from 'knex';
|
import { knex, Knex } from 'knex';
|
||||||
import nullthrows from 'nullthrows';
|
import nullthrows from 'nullthrows';
|
||||||
@@ -48,41 +48,33 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
|||||||
const othersTableName = uuidv4();
|
const othersTableName = uuidv4();
|
||||||
|
|
||||||
class CategoryEntity extends Entity<CategoryFields, string, ViewerContext> {
|
class CategoryEntity extends Entity<CategoryFields, string, ViewerContext> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
CategoryFields,
|
CategoryFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
CategoryEntity,
|
CategoryEntity,
|
||||||
PrivacyPolicy
|
PrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return categoryEntityCompanion;
|
||||||
entityClass: CategoryEntity,
|
|
||||||
entityConfiguration: categoryEntityConfiguration,
|
|
||||||
privacyPolicyClass: PrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class OtherEntity extends Entity<OtherFields, string, ViewerContext> {
|
class OtherEntity extends Entity<OtherFields, string, ViewerContext> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
OtherFields,
|
OtherFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
OtherEntity,
|
OtherEntity,
|
||||||
PrivacyPolicy
|
PrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return otherEntityCompanion;
|
||||||
entityClass: OtherEntity,
|
|
||||||
entityConfiguration: otherEntityConfiguration,
|
|
||||||
privacyPolicyClass: PrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const categoryEntityConfiguration = new EntityConfiguration<CategoryFields>({
|
const categoryEntityConfiguration = new EntityConfiguration<CategoryFields>({
|
||||||
idField: 'id',
|
idField: 'id',
|
||||||
tableName: categoriesTableName,
|
tableName: categoriesTableName,
|
||||||
inboundEdges: [OtherEntity],
|
getInboundEdges: () => [OtherEntity],
|
||||||
schema: {
|
schema: {
|
||||||
id: new UUIDField({
|
id: new UUIDField({
|
||||||
columnName: 'id',
|
columnName: 'id',
|
||||||
@@ -92,7 +84,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
|||||||
columnName: 'parent_other_id',
|
columnName: 'parent_other_id',
|
||||||
cache: true,
|
cache: true,
|
||||||
association: {
|
association: {
|
||||||
associatedEntityClass: OtherEntity,
|
getAssociatedEntityClass: () => OtherEntity,
|
||||||
edgeDeletionBehavior,
|
edgeDeletionBehavior,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
@@ -101,10 +93,16 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
|||||||
cacheAdapterFlavor: 'redis',
|
cacheAdapterFlavor: 'redis',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const categoryEntityCompanion = new EntityCompanionDefinition({
|
||||||
|
entityClass: CategoryEntity,
|
||||||
|
entityConfiguration: categoryEntityConfiguration,
|
||||||
|
privacyPolicyClass: PrivacyPolicy,
|
||||||
|
});
|
||||||
|
|
||||||
const otherEntityConfiguration = new EntityConfiguration<OtherFields>({
|
const otherEntityConfiguration = new EntityConfiguration<OtherFields>({
|
||||||
idField: 'id',
|
idField: 'id',
|
||||||
tableName: othersTableName,
|
tableName: othersTableName,
|
||||||
inboundEdges: [CategoryEntity],
|
getInboundEdges: () => [CategoryEntity],
|
||||||
schema: {
|
schema: {
|
||||||
id: new UUIDField({
|
id: new UUIDField({
|
||||||
columnName: 'id',
|
columnName: 'id',
|
||||||
@@ -114,7 +112,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
|||||||
columnName: 'parent_category_id',
|
columnName: 'parent_category_id',
|
||||||
cache: true,
|
cache: true,
|
||||||
association: {
|
association: {
|
||||||
associatedEntityClass: CategoryEntity,
|
getAssociatedEntityClass: () => CategoryEntity,
|
||||||
edgeDeletionBehavior,
|
edgeDeletionBehavior,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
@@ -123,46 +121,40 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
|||||||
cacheAdapterFlavor: 'redis',
|
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) => {
|
await knex.schema.createTable(categoriesTableName, (table) => {
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||||
});
|
});
|
||||||
|
|
||||||
await knex.schema.createTable(othersTableName, (table) => {
|
await knex.schema.createTable(othersTableName, (table) => {
|
||||||
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
|
table.uuid('id').defaultTo(knex.raw('uuid_generate_v4()')).primary();
|
||||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY) {
|
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
|
||||||
table
|
table
|
||||||
.uuid('parent_category_id')
|
.uuid('parent_category_id')
|
||||||
.references('id')
|
.references('id')
|
||||||
.inTable(categoriesTableName)
|
.inTable(categoriesTableName)
|
||||||
.unique()
|
.unique()
|
||||||
.onDelete('cascade');
|
.onDelete('cascade');
|
||||||
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
|
|
||||||
table
|
|
||||||
.uuid('parent_category_id')
|
|
||||||
.references('id')
|
|
||||||
.inTable(categoriesTableName)
|
|
||||||
.unique()
|
|
||||||
.onDelete('set null');
|
|
||||||
} else {
|
} else {
|
||||||
table.uuid('parent_category_id').unique();
|
table.uuid('parent_category_id').unique();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
await knex.schema.alterTable(categoriesTableName, (table) => {
|
await knex.schema.alterTable(categoriesTableName, (table) => {
|
||||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY) {
|
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE) {
|
||||||
table
|
table
|
||||||
.uuid('parent_other_id')
|
.uuid('parent_other_id')
|
||||||
.references('id')
|
.references('id')
|
||||||
.inTable(othersTableName)
|
.inTable(othersTableName)
|
||||||
.unique()
|
.unique()
|
||||||
.onDelete('cascade');
|
.onDelete('cascade');
|
||||||
} else if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY) {
|
|
||||||
table
|
|
||||||
.uuid('parent_other_id')
|
|
||||||
.references('id')
|
|
||||||
.inTable(othersTableName)
|
|
||||||
.unique()
|
|
||||||
.onDelete('set null');
|
|
||||||
} else {
|
} else {
|
||||||
table.uuid('parent_other_id').unique();
|
table.uuid('parent_other_id').unique();
|
||||||
}
|
}
|
||||||
@@ -172,8 +164,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
|
|||||||
};
|
};
|
||||||
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
||||||
let knexInstance: Knex;
|
let knexInstance: Knex;
|
||||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
|
||||||
|
|
||||||
beforeAll(() => {
|
beforeAll(() => {
|
||||||
knexInstance = knex({
|
knexInstance = knex({
|
||||||
@@ -186,16 +177,17 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
|||||||
database: nullthrows(process.env['PGDATABASE']),
|
database: nullthrows(process.env['PGDATABASE']),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
genericRedisCacheContext = {
|
redisCacheAdapterContext = {
|
||||||
redisClient,
|
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||||
makeKeyFn(...parts: string[]): string {
|
makeKeyFn(...parts: string[]): string {
|
||||||
const delimiter = ':';
|
const delimiter = ':';
|
||||||
const escapedParts = parts.map((part) =>
|
const escapedParts = parts.map((part) =>
|
||||||
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`),
|
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
|
||||||
);
|
);
|
||||||
return escapedParts.join(delimiter);
|
return escapedParts.join(delimiter);
|
||||||
},
|
},
|
||||||
cacheKeyPrefix: 'test-',
|
cacheKeyPrefix: 'test-',
|
||||||
|
cacheKeyVersion: 1,
|
||||||
ttlSecondsPositive: 86400, // 1 day
|
ttlSecondsPositive: 86400, // 1 day
|
||||||
ttlSecondsNegative: 600, // 10 minutes
|
ttlSecondsNegative: 600, // 10 minutes
|
||||||
};
|
};
|
||||||
@@ -203,22 +195,21 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
|||||||
|
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
await knexInstance.destroy();
|
await knexInstance.destroy();
|
||||||
redisClient.disconnect();
|
redisCacheAdapterContext.redisClient.disconnect();
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it.each([
|
||||||
EntityEdgeDeletionBehavior.CASCADE_DELETE,
|
EntityEdgeDeletionBehavior.CASCADE_DELETE,
|
||||||
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
|
EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE,
|
||||||
EntityEdgeDeletionBehavior.SET_NULL,
|
EntityEdgeDeletionBehavior.SET_NULL,
|
||||||
EntityEdgeDeletionBehavior.SET_NULL_INVALIDATE_CACHE_ONLY,
|
|
||||||
])('behavior: %p', async (edgeDeletionBehavior) => {
|
])('behavior: %p', async (edgeDeletionBehavior) => {
|
||||||
const { CategoryEntity, OtherEntity } = await makeEntityClasses(
|
const { CategoryEntity, OtherEntity } = await makeEntityClasses(
|
||||||
knexInstance,
|
knexInstance,
|
||||||
edgeDeletionBehavior,
|
edgeDeletionBehavior
|
||||||
);
|
);
|
||||||
|
|
||||||
const viewerContext = new ViewerContext(
|
const viewerContext = new ViewerContext(
|
||||||
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext),
|
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
const category1 = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
|
const category1 = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
|
||||||
@@ -233,15 +224,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
|||||||
|
|
||||||
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL) {
|
if (edgeDeletionBehavior === EntityEdgeDeletionBehavior.SET_NULL) {
|
||||||
await expect(
|
await expect(
|
||||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID()),
|
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||||
).resolves.toBeNull();
|
|
||||||
const otherLoaded = await OtherEntity.loader(viewerContext)
|
|
||||||
.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();
|
).resolves.toBeNull();
|
||||||
const otherLoaded = await OtherEntity.loader(viewerContext)
|
const otherLoaded = await OtherEntity.loader(viewerContext)
|
||||||
.enforcing()
|
.enforcing()
|
||||||
@@ -249,10 +232,10 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
|
|||||||
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
|
expect(otherLoaded?.getField('parent_category_id')).toBeNull();
|
||||||
} else {
|
} else {
|
||||||
await expect(
|
await expect(
|
||||||
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID()),
|
CategoryEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(category1.getID())
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
await expect(
|
await expect(
|
||||||
OtherEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(other1.getID()),
|
OtherEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(other1.getID())
|
||||||
).resolves.toBeNull();
|
).resolves.toBeNull();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
+29
-25
@@ -32,36 +32,40 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerCon
|
|||||||
}
|
}
|
||||||
|
|
||||||
export default class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
|
export default class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
ChildFields,
|
ChildFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
ChildEntity,
|
ChildEntity,
|
||||||
TestEntityPrivacyPolicy
|
TestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return childEntityCompanion;
|
||||||
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,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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> {
|
export default class ParentEntity extends Entity<ParentFields, string, ViewerContext> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
ParentFields,
|
ParentFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
ParentEntity,
|
ParentEntity,
|
||||||
TestEntityPrivacyPolicy
|
TestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return parentEntityCompanion;
|
||||||
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,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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,
|
||||||
|
});
|
||||||
+5
-5
@@ -4,7 +4,7 @@ import {
|
|||||||
EntityCompanionProvider,
|
EntityCompanionProvider,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
import {
|
import {
|
||||||
GenericRedisCacheContext,
|
RedisCacheAdapterContext,
|
||||||
RedisCacheAdapterProvider,
|
RedisCacheAdapterProvider,
|
||||||
} from '@expo/entity-cache-adapter-redis';
|
} from '@expo/entity-cache-adapter-redis';
|
||||||
import {
|
import {
|
||||||
@@ -15,8 +15,8 @@ import { Knex } from 'knex';
|
|||||||
|
|
||||||
export const createFullIntegrationTestEntityCompanionProvider = (
|
export const createFullIntegrationTestEntityCompanionProvider = (
|
||||||
knex: Knex,
|
knex: Knex,
|
||||||
genericRedisCacheContext: GenericRedisCacheContext,
|
redisCacheAdapterContext: RedisCacheAdapterContext,
|
||||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
|
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||||
): EntityCompanionProvider => {
|
): EntityCompanionProvider => {
|
||||||
return new EntityCompanionProvider(
|
return new EntityCompanionProvider(
|
||||||
metricsAdapter,
|
metricsAdapter,
|
||||||
@@ -33,9 +33,9 @@ export const createFullIntegrationTestEntityCompanionProvider = (
|
|||||||
[
|
[
|
||||||
'redis',
|
'redis',
|
||||||
{
|
{
|
||||||
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
|
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
]),
|
])
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -3,142 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-ip-address-field
|
**Note:** Version bump only for package @expo/entity-ip-address-field
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@expo/entity-ip-address-field",
|
"name": "@expo/entity-ip-address-field",
|
||||||
"version": "0.37.0",
|
"version": "0.24.0",
|
||||||
"description": "IP address EntityField definitions for @expo/entity",
|
"description": "IP address EntityField definitions for @expo/entity",
|
||||||
"files": [
|
"files": [
|
||||||
"build",
|
"build",
|
||||||
@@ -17,7 +17,7 @@
|
|||||||
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --delete"
|
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --delete"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16"
|
"node": ">=12"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"entity"
|
"entity"
|
||||||
@@ -28,7 +28,7 @@
|
|||||||
"ip-address": "^8.1.0"
|
"ip-address": "^8.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@expo/entity": "^0.37.0",
|
"@expo/entity": "^0.24.0",
|
||||||
"@types/jsbn": "^1.2.29"
|
"@types/jsbn": "^1.2.29"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
|
|||||||
@@ -12,5 +12,5 @@ describeFieldTestCase(
|
|||||||
'1:2:3:4:5:6:7:8/64',
|
'1:2:3:4:5:6:7:8/64',
|
||||||
'fedc:ba98:7654:3210:fedc:ba98:7654:3210',
|
'fedc:ba98:7654:3210:fedc:ba98:7654:3210',
|
||||||
],
|
],
|
||||||
['', 'abs', '0.0.0.x/0', '123.21.23', '1:2:3:4:5:6', '198.10/8'],
|
['', 'abs', '0.0.0.x/0', '123.21.23', '1:2:3:4:5:6', '198.10/8']
|
||||||
);
|
);
|
||||||
@@ -1,154 +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.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* constrain entity fields type to string-keyed object ([#235](https://github.com/expo/entity/issues/235)) ([7e2cea1](https://github.com/expo/entity/commit/7e2cea16973a0ae1917f867cd25d6ef7c8eaecef))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-secondary-cache-local-memory
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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.37.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 --config ../../.barrelsby.json"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=16"
|
|
||||||
},
|
|
||||||
"keywords": [
|
|
||||||
"entity"
|
|
||||||
],
|
|
||||||
"author": "Expo",
|
|
||||||
"license": "MIT",
|
|
||||||
"peerDependencies": {
|
|
||||||
"@expo/entity": "*",
|
|
||||||
"@expo/entity-cache-adapter-local-memory": "*"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@expo/entity": "^0.37.0",
|
|
||||||
"@expo/entity-cache-adapter-local-memory": "^0.37.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 extends Record<string, any>,
|
|
||||||
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.createProviderWithOptions(),
|
|
||||||
},
|
|
||||||
],
|
|
||||||
]),
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
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,171 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* constrain entity fields type to string-keyed object ([#235](https://github.com/expo/entity/issues/235)) ([7e2cea1](https://github.com/expo/entity/commit/7e2cea16973a0ae1917f867cd25d6ef7c8eaecef))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity-secondary-cache-redis
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
### Chores
|
### Chores
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||||
new RedisSecondaryEntityCache(
|
new RedisSecondaryEntityCache(
|
||||||
redisTestEntityConfiguration,
|
redisTestEntityConfiguration,
|
||||||
genericRedisCacheContext,
|
redisCacheAdapterContext,
|
||||||
(loadParams) => `${loadParams.id}`
|
(loadParams) => `${loadParams.id}`
|
||||||
),
|
),
|
||||||
RedisTestEntity.loader(viewerContext)
|
RedisTestEntity.loader(viewerContext)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@expo/entity-secondary-cache-redis",
|
"name": "@expo/entity-secondary-cache-redis",
|
||||||
"version": "0.37.0",
|
"version": "0.24.0",
|
||||||
"description": "Redis secondary cache for @expo/entity",
|
"description": "Redis secondary cache for @expo/entity",
|
||||||
"files": [
|
"files": [
|
||||||
"build",
|
"build",
|
||||||
@@ -16,10 +16,10 @@
|
|||||||
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
"test": "jest --rootDir . --config ../../resources/jest.config.js --passWithNoTests",
|
||||||
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
"integration": "../../resources/run-with-docker yarn integration-no-setup",
|
||||||
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
"integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir . --runInBand --passWithNoTests",
|
||||||
"barrelsby": "barrelsby --config ../../.barrelsby.json"
|
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16"
|
"node": ">=12"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"entity"
|
"entity"
|
||||||
@@ -30,10 +30,12 @@
|
|||||||
"@expo/entity": "*",
|
"@expo/entity": "*",
|
||||||
"@expo/entity-cache-adapter-redis": "*"
|
"@expo/entity-cache-adapter-redis": "*"
|
||||||
},
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"ioredis": "^4.17.3"
|
||||||
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@expo/entity": "^0.37.0",
|
"@expo/entity": "^0.24.0",
|
||||||
"@expo/entity-cache-adapter-redis": "^0.37.0",
|
"@expo/entity-cache-adapter-redis": "^0.24.0",
|
||||||
"ioredis": "^5.2.5",
|
|
||||||
"nullthrows": "^1.1.1"
|
"nullthrows": "^1.1.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,16 +2,18 @@ import { EntityConfiguration, GenericSecondaryEntityCache } from '@expo/entity';
|
|||||||
import { GenericRedisCacheContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
|
import { GenericRedisCacheContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A redis GenericSecondaryEntityCache.
|
* A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
|
||||||
|
* single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
|
||||||
|
* a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
|
||||||
*/
|
*/
|
||||||
export default class RedisSecondaryEntityCache<
|
export default class RedisSecondaryEntityCache<
|
||||||
TFields extends Record<string, any>,
|
TFields,
|
||||||
TLoadParams,
|
TLoadParams
|
||||||
> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
|
> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
|
||||||
constructor(
|
constructor(
|
||||||
entityConfiguration: EntityConfiguration<TFields>,
|
entityConfiguration: EntityConfiguration<TFields>,
|
||||||
genericRedisCacheContext: GenericRedisCacheContext,
|
genericRedisCacheContext: GenericRedisCacheContext,
|
||||||
constructRedisKey: (params: Readonly<TLoadParams>) => string,
|
constructRedisKey: (params: Readonly<TLoadParams>) => string
|
||||||
) {
|
) {
|
||||||
super(new GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
|
super(new GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
|
||||||
}
|
}
|
||||||
|
|||||||
+20
-20
@@ -1,5 +1,5 @@
|
|||||||
import { EntitySecondaryCacheLoader, mapMapAsync, ViewerContext } from '@expo/entity';
|
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 Redis from 'ioredis';
|
||||||
import nullthrows from 'nullthrows';
|
import nullthrows from 'nullthrows';
|
||||||
import { URL } from 'url';
|
import { URL } from 'url';
|
||||||
@@ -29,7 +29,7 @@ class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
|
|||||||
public databaseLoadCount = 0;
|
public databaseLoadCount = 0;
|
||||||
|
|
||||||
protected async fetchObjectsFromDatabaseAsync(
|
protected async fetchObjectsFromDatabaseAsync(
|
||||||
loadParamsArray: readonly Readonly<TestLoadParams>[],
|
loadParamsArray: readonly Readonly<TestLoadParams>[]
|
||||||
): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<RedisTestEntityFields> | null>> {
|
): Promise<ReadonlyMap<Readonly<TestLoadParams>, Readonly<RedisTestEntityFields> | null>> {
|
||||||
this.databaseLoadCount += loadParamsArray.length;
|
this.databaseLoadCount += loadParamsArray.length;
|
||||||
|
|
||||||
@@ -45,38 +45,38 @@ class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
|
|||||||
.loadManyByFieldEqualityConjunctionAsync([
|
.loadManyByFieldEqualityConjunctionAsync([
|
||||||
{ fieldName: 'id', fieldValue: loadParams.id },
|
{ fieldName: 'id', fieldValue: loadParams.id },
|
||||||
])
|
])
|
||||||
)[0],
|
)[0]
|
||||||
).getAllFields();
|
).getAllFields();
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
describe(RedisSecondaryEntityCache, () => {
|
describe(RedisSecondaryEntityCache, () => {
|
||||||
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
|
let redisCacheAdapterContext: RedisCacheAdapterContext;
|
||||||
let genericRedisCacheContext: GenericRedisCacheContext;
|
|
||||||
|
|
||||||
beforeAll(() => {
|
beforeAll(() => {
|
||||||
genericRedisCacheContext = {
|
redisCacheAdapterContext = {
|
||||||
redisClient,
|
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
|
||||||
makeKeyFn(..._parts: string[]): string {
|
makeKeyFn(..._parts: string[]): string {
|
||||||
throw new Error('should not be used by this test');
|
throw new Error('should not be used by this test');
|
||||||
},
|
},
|
||||||
cacheKeyPrefix: 'test-',
|
cacheKeyPrefix: 'test-',
|
||||||
|
cacheKeyVersion: 1,
|
||||||
ttlSecondsPositive: 86400, // 1 day
|
ttlSecondsPositive: 86400, // 1 day
|
||||||
ttlSecondsNegative: 600, // 10 minutes
|
ttlSecondsNegative: 600, // 10 minutes
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await redisClient.flushdb();
|
await redisCacheAdapterContext.redisClient.flushdb();
|
||||||
});
|
});
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
redisClient.disconnect();
|
redisCacheAdapterContext.redisClient.disconnect();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('Loads through secondary loader, caches, and invalidates', async () => {
|
it('Loads through secondary loader, caches, and invalidates', async () => {
|
||||||
const viewerContext = new TestViewerContext(
|
const viewerContext = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
const createdEntity = await RedisTestEntity.creator(viewerContext)
|
const createdEntity = await RedisTestEntity.creator(viewerContext)
|
||||||
@@ -86,23 +86,23 @@ describe(RedisSecondaryEntityCache, () => {
|
|||||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||||
new RedisSecondaryEntityCache(
|
new RedisSecondaryEntityCache(
|
||||||
redisTestEntityConfiguration,
|
redisTestEntityConfiguration,
|
||||||
genericRedisCacheContext,
|
redisCacheAdapterContext,
|
||||||
(loadParams) => `test-key-${loadParams.id}`,
|
(loadParams) => `test-key-${loadParams.id}`
|
||||||
),
|
),
|
||||||
RedisTestEntity.loader(viewerContext),
|
RedisTestEntity.loader(viewerContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
const loadParams = { id: createdEntity.getID() };
|
const loadParams = { id: createdEntity.getID() };
|
||||||
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
const results = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||||
expect(nullthrows(results.get(loadParams)).enforceValue().getID()).toEqual(
|
expect(nullthrows(results.get(loadParams)).enforceValue().getID()).toEqual(
|
||||||
createdEntity.getID(),
|
createdEntity.getID()
|
||||||
);
|
);
|
||||||
|
|
||||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
||||||
|
|
||||||
const results2 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
const results2 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||||
expect(nullthrows(results2.get(loadParams)).enforceValue().getID()).toEqual(
|
expect(nullthrows(results2.get(loadParams)).enforceValue().getID()).toEqual(
|
||||||
createdEntity.getID(),
|
createdEntity.getID()
|
||||||
);
|
);
|
||||||
|
|
||||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
expect(secondaryCacheLoader.databaseLoadCount).toEqual(1);
|
||||||
@@ -111,7 +111,7 @@ describe(RedisSecondaryEntityCache, () => {
|
|||||||
|
|
||||||
const results3 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
const results3 = await secondaryCacheLoader.loadManyAsync([loadParams]);
|
||||||
expect(nullthrows(results3.get(loadParams)).enforceValue().getID()).toEqual(
|
expect(nullthrows(results3.get(loadParams)).enforceValue().getID()).toEqual(
|
||||||
createdEntity.getID(),
|
createdEntity.getID()
|
||||||
);
|
);
|
||||||
|
|
||||||
expect(secondaryCacheLoader.databaseLoadCount).toEqual(2);
|
expect(secondaryCacheLoader.databaseLoadCount).toEqual(2);
|
||||||
@@ -119,16 +119,16 @@ describe(RedisSecondaryEntityCache, () => {
|
|||||||
|
|
||||||
it('correctly handles uncached and unfetchable load params', async () => {
|
it('correctly handles uncached and unfetchable load params', async () => {
|
||||||
const viewerContext = new TestViewerContext(
|
const viewerContext = new TestViewerContext(
|
||||||
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext),
|
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
|
||||||
new RedisSecondaryEntityCache(
|
new RedisSecondaryEntityCache(
|
||||||
redisTestEntityConfiguration,
|
redisTestEntityConfiguration,
|
||||||
genericRedisCacheContext,
|
redisCacheAdapterContext,
|
||||||
(loadParams) => `test-key-${loadParams.id}`,
|
(loadParams) => `test-key-${loadParams.id}`
|
||||||
),
|
),
|
||||||
RedisTestEntity.loader(viewerContext),
|
RedisTestEntity.loader(viewerContext)
|
||||||
);
|
);
|
||||||
|
|
||||||
const loadParams = { id: FAKE_ID };
|
const loadParams = { id: FAKE_ID };
|
||||||
|
|||||||
@@ -15,18 +15,14 @@ export type RedisTestEntityFields = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
|
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
|
||||||
static defineCompanionDefinition(): EntityCompanionDefinition<
|
static getCompanionDefinition(): EntityCompanionDefinition<
|
||||||
RedisTestEntityFields,
|
RedisTestEntityFields,
|
||||||
string,
|
string,
|
||||||
ViewerContext,
|
ViewerContext,
|
||||||
RedisTestEntity,
|
RedisTestEntity,
|
||||||
RedisTestEntityPrivacyPolicy
|
RedisTestEntityPrivacyPolicy
|
||||||
> {
|
> {
|
||||||
return {
|
return redisTestEntityCompanionDefinition;
|
||||||
entityClass: RedisTestEntity,
|
|
||||||
entityConfiguration: redisTestEntityConfiguration,
|
|
||||||
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -84,3 +80,9 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
|
|||||||
databaseAdapterFlavor: 'postgres',
|
databaseAdapterFlavor: 'postgres',
|
||||||
cacheAdapterFlavor: 'redis',
|
cacheAdapterFlavor: 'redis',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
|
||||||
|
entityClass: RedisTestEntity,
|
||||||
|
entityConfiguration: redisTestEntityConfiguration,
|
||||||
|
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
|
||||||
|
});
|
||||||
+5
-5
@@ -6,13 +6,13 @@ import {
|
|||||||
StubDatabaseAdapterProvider,
|
StubDatabaseAdapterProvider,
|
||||||
} from '@expo/entity';
|
} from '@expo/entity';
|
||||||
import {
|
import {
|
||||||
GenericRedisCacheContext,
|
RedisCacheAdapterContext,
|
||||||
RedisCacheAdapterProvider,
|
RedisCacheAdapterProvider,
|
||||||
} from '@expo/entity-cache-adapter-redis';
|
} from '@expo/entity-cache-adapter-redis';
|
||||||
|
|
||||||
export const createRedisIntegrationTestEntityCompanionProvider = (
|
export const createRedisIntegrationTestEntityCompanionProvider = (
|
||||||
genericRedisCacheContext: GenericRedisCacheContext,
|
redisCacheAdapterContext: RedisCacheAdapterContext,
|
||||||
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
|
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
|
||||||
): EntityCompanionProvider => {
|
): EntityCompanionProvider => {
|
||||||
return new EntityCompanionProvider(
|
return new EntityCompanionProvider(
|
||||||
metricsAdapter,
|
metricsAdapter,
|
||||||
@@ -29,9 +29,9 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
|
|||||||
[
|
[
|
||||||
'redis',
|
'redis',
|
||||||
{
|
{
|
||||||
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
|
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
]),
|
])
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -3,193 +3,6 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
# [0.37.0](https://github.com/expo/entity/compare/v0.36.0...v0.37.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update barrels ([#241](https://github.com/expo/entity/issues/241)) ([8c5f81b](https://github.com/expo/entity/commit/8c5f81bcca107e9b7bbea5f0ab41b0105057806e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.36.0](https://github.com/expo/entity/compare/v0.35.0...v0.36.0) (2024-06-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* always reload entity after update since cascading changes may have changed it since commit ([#233](https://github.com/expo/entity/issues/233)) ([7c3c985](https://github.com/expo/entity/commit/7c3c9854a4dd91d4b73ebdb18bdeadea8b63f4c7))
|
|
||||||
* constrain entity fields type to string-keyed object ([#235](https://github.com/expo/entity/issues/235)) ([7e2cea1](https://github.com/expo/entity/commit/7e2cea16973a0ae1917f867cd25d6ef7c8eaecef))
|
|
||||||
* disallow keys of JS Object prototype for safety ([#236](https://github.com/expo/entity/issues/236)) ([05726d4](https://github.com/expo/entity/commit/05726d45fa9b91a6b25ddbc9c7e3e097b02097ca))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* Add global mutation trigger field to EntityCompanionProvider ([#215](https://github.com/expo/entity/issues/215)) ([6569486](https://github.com/expo/entity/commit/6569486ecddf2fd33c626f634c761e06636b1730))
|
|
||||||
* add previousValue to privacy policy context for updates ([#232](https://github.com/expo/entity/issues/232)) ([af495a9](https://github.com/expo/entity/commit/af495a9a856a5042f00cfd150348e415139cb85e))
|
|
||||||
* Add StrictEnumField with better validation ([#222](https://github.com/expo/entity/issues/222)) ([8753252](https://github.com/expo/entity/commit/87532525d090b3a67f1cedd95ac990f7dcb3ab5d))
|
|
||||||
* make canViewerDeleteAsync recursive ([#224](https://github.com/expo/entity/issues/224)) ([60fc9a4](https://github.com/expo/entity/commit/60fc9a4c4b587b866f2f5a1b3bd22145bc77e6e9))
|
|
||||||
* Use uuid v7 in stub database adapter ([#234](https://github.com/expo/entity/issues/234)) ([1e8ea64](https://github.com/expo/entity/commit/1e8ea64017430a2ce5ea197678bd78713ad77ecd))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/expo/entity/compare/v0.34.0...v0.35.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Revert: require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([1bdfbd6](https://github.com/expo/entity/commit/1bdfbd6b562d1200e4029df0533b5adb2d917831))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/expo/entity/compare/v0.33.0...v0.34.0) (2024-04-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* Allow UUIDv6/7/8 in UUIDField validation ([#221](https://github.com/expo/entity/issues/221)) ([cc6f3dc](https://github.com/expo/entity/commit/cc6f3dc1e677382eec220723c37b5b883d980372))
|
|
||||||
* require explicit query context specification ([#219](https://github.com/expo/entity/issues/219)) ([8b0b31f](https://github.com/expo/entity/commit/8b0b31fdde5bd565aa527719003ef283a45f55cc))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/expo/entity/compare/v0.32.0...v0.33.0) (2023-10-06)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* add loadManyByIDsNullableAsync loader method ([#214](https://github.com/expo/entity/issues/214)) ([aad94ac](https://github.com/expo/entity/commit/aad94aca479ac07cc7f76b5e1a122ff85a2d1542))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [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)
|
# [0.24.0](https://github.com/expo/entity/compare/v0.23.0...v0.24.0) (2022-02-16)
|
||||||
|
|
||||||
**Note:** Version bump only for package @expo/entity
|
**Note:** Version bump only for package @expo/entity
|
||||||
|
|||||||
Loaded 100 of 214 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user