Compare commits

..
148 changed files with 4649 additions and 5617 deletions

No files matched your search

+1 -86
View File
@@ -3,91 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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)
@@ -193,7 +108,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
### 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))
+1 -1
View File
@@ -4,5 +4,5 @@
],
"npmClient": "yarn",
"useWorkspaces": true,
"version": "0.35.0"
"version": "0.28.0"
}
+14 -13
View File
@@ -16,30 +16,31 @@
"barrelsby": "lerna run barrelsby"
},
"devDependencies": {
"@expo/batcher": "^1.0.0",
"@expo/entity": "file:packages/entity",
"@expo/results": "^1.0.0",
"@types/invariant": "^2.2.33",
"@types/jest": "^29.5.2",
"@types/jest": "^26.0.10",
"@types/jsbn": "^1.2.29",
"@types/lru-cache": "^5.1.1",
"@types/node": "^16.18.34",
"@types/node": "^14.6.0",
"@types/uuid": "^8.3.0",
"@typescript-eslint/eslint-plugin": "^4.14.0",
"@typescript-eslint/parser": "^4.14.0",
"barrelsby": "^2.2.0",
"eslint": "^8.14.0",
"eslint-config-universe": "^11.2.0",
"eslint-plugin-tsdoc": "^0.2.17",
"ioredis": "^5.2.5",
"jest": "^29.1.2",
"eslint": "^7.7.0",
"eslint-config-universe": "^7.0.0",
"eslint-plugin-tsdoc": "^0.2.16",
"ioredis": "^5.0.4",
"jest": "^26.6.3",
"lerna": "^5.4.0",
"lru-cache": "^6.0.0",
"nullthrows": "^1.1.1",
"pg": "8.10.0",
"prettier": "^2.8.8",
"ts-jest": "^29.1.0",
"pg": "^8.6.0",
"prettier": "^2.3.2",
"ts-jest": "~26.4.4",
"ts-mockito": "^2.6.1",
"typedoc": "^0.24.8",
"typescript": "^5.1.3",
"typedoc": "^0.23.10",
"typescript": "^4.6.3",
"uuid": "^8.3.0"
},
"dependencies": {
@@ -3,71 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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
@@ -1,6 +1,6 @@
{
"name": "@expo/entity-cache-adapter-local-memory",
"version": "0.35.0",
"version": "0.28.0",
"description": "Cross-request local memory cache adapter for @expo/entity",
"files": [
"build",
@@ -19,7 +19,7 @@
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -33,6 +33,6 @@
"lru-cache": "^6.0.0"
},
"devDependencies": {
"@expo/entity": "^0.35.0"
"@expo/entity": "^0.28.0"
}
}
@@ -93,7 +93,6 @@ export default class GenericLocalMemoryCacher<TFields> implements IEntityGeneric
columnName,
String(fieldValue),
];
const delimiter = ':';
const escapedParts = parts.map((part) =>
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
@@ -1,31 +1,24 @@
import {
computeIfAbsent,
IEntityCacheAdapter,
EntityConfiguration,
GenericEntityCacheAdapter,
EntityConfiguration,
IEntityCacheAdapterProvider,
} from '@expo/entity';
import GenericLocalMemoryCacher, { LocalMemoryCache } from './GenericLocalMemoryCacher';
/**
* 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 {
/**
* @returns a no-op local memory cache adapter provider, or one that doesn't cache locally.
*/
static createNoOpProvider(): IEntityCacheAdapterProvider {
// local memory cache adapters should be shared/reused across requests
private static localMemoryCacheAdapterMap = new Map<string, GenericEntityCacheAdapter<any>>();
static getNoOpProvider(): IEntityCacheAdapterProvider {
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
GenericLocalMemoryCacher.createNoOpCache<TFields>()
);
}
/**
* @returns a local memory cache adapter provider configured with the supplied options.
*/
static createProviderWithOptions(
static getProvider(
options: { maxSize?: number; ttlSeconds?: number } = {}
): IEntityCacheAdapterProvider {
return new LocalMemoryCacheAdapterProvider(<TFields>() =>
@@ -33,8 +26,6 @@ export default class LocalMemoryCacheAdapterProvider implements IEntityCacheAdap
);
}
private localMemoryCacheAdapterMap = new Map<string, GenericEntityCacheAdapter<any>>();
private constructor(
private readonly localMemoryCacheCreator: <TFields>() => LocalMemoryCache<TFields>
) {}
@@ -42,11 +33,15 @@ export default class LocalMemoryCacheAdapterProvider implements IEntityCacheAdap
public getCacheAdapter<TFields>(
entityConfiguration: EntityConfiguration<TFields>
): IEntityCacheAdapter<TFields> {
return computeIfAbsent(this.localMemoryCacheAdapterMap, entityConfiguration.tableName, () => {
const localMemoryCache = this.localMemoryCacheCreator<TFields>();
return new GenericEntityCacheAdapter(
new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache)
);
});
return computeIfAbsent(
LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap,
entityConfiguration.tableName,
() => {
const localMemoryCache = this.localMemoryCacheCreator<TFields>();
return new GenericEntityCacheAdapter(
new GenericLocalMemoryCacher(entityConfiguration, localMemoryCache)
);
}
);
}
}
@@ -1,9 +1,4 @@
import {
CacheAdapterFlavor,
CacheAdapterFlavorDefinition,
CacheStatus,
ViewerContext,
} from '@expo/entity';
import { CacheStatus, ViewerContext } from '@expo/entity';
import { v4 as uuidv4 } from 'uuid';
import GenericLocalMemoryCacher from '../GenericLocalMemoryCacher';
@@ -11,17 +6,20 @@ import LocalMemoryCacheAdapterProvider from '../LocalMemoryCacheAdapterProvider'
import LocalMemoryTestEntity from '../testfixtures/LocalMemoryTestEntity';
import {
createLocalMemoryTestEntityCompanionProvider,
createNoOpLocalMemoryIntegrationTestEntityCompanionProvider,
createNoopLocalMemoryIntegrationTestEntityCompanionProvider,
} from '../testfixtures/createLocalMemoryTestEntityCompanionProvider';
describe(GenericLocalMemoryCacher, () => {
beforeEach(async () => {
LocalMemoryCacheAdapterProvider['localMemoryCacheAdapterMap'].clear();
});
it('has correct caching behavior', async () => {
const entityCompanionProvider = createLocalMemoryTestEntityCompanionProvider();
const viewerContext = new ViewerContext(entityCompanionProvider);
const genericCacher =
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)[
'tableDataCoordinator'
]['cacheAdapter']['genericCacher'];
const viewerContext = new ViewerContext(createLocalMemoryTestEntityCompanionProvider());
const genericCacher = viewerContext.entityCompanionProvider.getCompanionForEntity(
LocalMemoryTestEntity,
LocalMemoryTestEntity.getCompanionDefinition()
)['tableDataCoordinator']['cacheAdapter']['genericCacher'];
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
const date = new Date();
@@ -35,18 +33,11 @@ describe(GenericLocalMemoryCacher, () => {
.enforcing()
.loadByIDAsync(entity1Created.getID());
const localMemoryCacheAdapterProvider = (
entityCompanionProvider['cacheAdapterFlavors'] as ReadonlyMap<
CacheAdapterFlavor,
CacheAdapterFlavorDefinition
>
).get('local-memory')!.cacheAdapterProvider as LocalMemoryCacheAdapterProvider;
const entitySpecificGenericCacher = localMemoryCacheAdapterProvider[
const entitySpecificGenericCacher = LocalMemoryCacheAdapterProvider[
'localMemoryCacheAdapterMap'
].get(
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)
.entityCompanionDefinition.entityConfiguration.tableName
)!['genericCacher'];
].get(LocalMemoryTestEntity.getCompanionDefinition().entityConfiguration.tableName)![
'genericCacher'
];
const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
cacheKeyMaker('id', entity1.getID()),
]);
@@ -90,13 +81,54 @@ describe(GenericLocalMemoryCacher, () => {
expect(cachedValueMiss).toMatchObject({ status: CacheStatus.MISS });
});
it('shares the cache between different requests', async () => {
const genericLocalMemoryCacherLoadManySpy = jest.spyOn(
GenericLocalMemoryCacher.prototype as unknown as any,
'loadManyAsync'
);
const viewerContext = new ViewerContext(createLocalMemoryTestEntityCompanionProvider());
const date = new Date();
const entity1Created = await LocalMemoryTestEntity.creator(viewerContext)
.setField('name', 'blah')
.setField('dateField', date)
.enforceCreateAsync();
// loading an entity should put it in cache
await LocalMemoryTestEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity1Created.getID());
// load entity with a different request
const viewerContext2 = new ViewerContext(createLocalMemoryTestEntityCompanionProvider());
const entity1WithVc2 = await LocalMemoryTestEntity.loader(viewerContext2)
.enforcing()
.loadByIDAsync(entity1Created.getID());
const genericCacher = viewerContext.entityCompanionProvider.getCompanionForEntity(
LocalMemoryTestEntity,
LocalMemoryTestEntity.getCompanionDefinition()
)['tableDataCoordinator']['cacheAdapter']['genericCacher'];
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
expect(entity1WithVc2.getAllFields()).toMatchObject({
id: entity1WithVc2.getID(),
name: 'blah',
dateField: date,
});
expect(genericLocalMemoryCacherLoadManySpy).toBeCalledWith([
cacheKeyMaker('id', entity1WithVc2.getID()),
]);
expect(genericLocalMemoryCacherLoadManySpy).toBeCalledTimes(2);
});
it('respects the parameters of a noop cache', async () => {
const entityCompanionProvider = createNoOpLocalMemoryIntegrationTestEntityCompanionProvider();
const viewerContext = new ViewerContext(entityCompanionProvider);
const genericCacher =
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)[
'tableDataCoordinator'
]['cacheAdapter']['genericCacher'];
const viewerContext = new ViewerContext(
createNoopLocalMemoryIntegrationTestEntityCompanionProvider()
);
const genericCacher = viewerContext.entityCompanionProvider.getCompanionForEntity(
LocalMemoryTestEntity,
LocalMemoryTestEntity.getCompanionDefinition()
)['tableDataCoordinator']['cacheAdapter']['genericCacher'];
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
const date = new Date();
@@ -110,18 +142,11 @@ describe(GenericLocalMemoryCacher, () => {
.enforcing()
.loadByIDAsync(entity1Created.getID());
const localMemoryCacheAdapterProvider = (
entityCompanionProvider['cacheAdapterFlavors'] as ReadonlyMap<
CacheAdapterFlavor,
CacheAdapterFlavorDefinition
>
).get('local-memory')!.cacheAdapterProvider as LocalMemoryCacheAdapterProvider;
const entitySpecificGenericCacher = localMemoryCacheAdapterProvider[
const entitySpecificGenericCacher = LocalMemoryCacheAdapterProvider[
'localMemoryCacheAdapterMap'
].get(
viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity)
.entityCompanionDefinition.entityConfiguration.tableName
)!['genericCacher'];
].get(LocalMemoryTestEntity.getCompanionDefinition().entityConfiguration.tableName)![
'genericCacher'
];
const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
cacheKeyMaker('id', entity1.getID()),
]);
@@ -21,18 +21,14 @@ export default class LocalMemoryTestEntity extends Entity<
string,
ViewerContext
> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
LocalMemoryTestEntityFields,
string,
ViewerContext,
LocalMemoryTestEntity,
LocalMemoryTestEntityPrivacyPolicy
> {
return {
entityClass: LocalMemoryTestEntity,
entityConfiguration: localMemoryTestEntityConfiguration,
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
};
return localMemoryTestEntityCompanionDefinition;
}
}
@@ -96,3 +92,9 @@ export const localMemoryTestEntityConfiguration =
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'local-memory',
});
const localMemoryTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: LocalMemoryTestEntity,
entityConfiguration: localMemoryTestEntityConfiguration,
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
});
@@ -14,8 +14,8 @@ export const createLocalMemoryTestEntityCompanionProvider = (
): EntityCompanionProvider => {
const localMemoryCacheAdapterProvider =
localMemoryOptions.maxSize === 0 && localMemoryOptions.ttlSeconds === 0
? LocalMemoryCacheAdapterProvider.createNoOpProvider()
: LocalMemoryCacheAdapterProvider.createProviderWithOptions(localMemoryOptions);
? LocalMemoryCacheAdapterProvider.getNoOpProvider()
: LocalMemoryCacheAdapterProvider.getProvider(localMemoryOptions);
return new EntityCompanionProvider(
metricsAdapter,
new Map([
@@ -38,7 +38,7 @@ export const createLocalMemoryTestEntityCompanionProvider = (
);
};
export const createNoOpLocalMemoryIntegrationTestEntityCompanionProvider = (
export const createNoopLocalMemoryIntegrationTestEntityCompanionProvider = (
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => {
return createLocalMemoryTestEntityCompanionProvider(
@@ -3,80 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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
@@ -11,7 +11,7 @@ During `EntityCompanionProvider` instantiation:
```typescript
import Redis from 'ioredis';
const genericRedisCacherContext = {
const redisCacheAdapterContext = {
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
@@ -21,6 +21,7 @@ const genericRedisCacherContext = {
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'ent-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
@@ -35,7 +36,7 @@ export const createDefaultEntityCompanionProvider = (
},
{
['redis']: {
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
},
}
);
@@ -1,6 +1,6 @@
{
"name": "@expo/entity-cache-adapter-redis",
"version": "0.35.0",
"version": "0.28.0",
"description": "Redis cache adapter for @expo/entity",
"files": [
"build",
@@ -19,7 +19,7 @@
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -31,7 +31,7 @@
"ioredis": ">=5"
},
"devDependencies": {
"@expo/entity": "^0.35.0",
"ioredis": "^5.2.5"
"@expo/entity": "^0.28.0",
"ioredis": "^5.0.4"
}
}
@@ -1,162 +1,62 @@
import {
CacheLoadResult,
CacheStatus,
EntityConfiguration,
transformCacheObjectToFields,
transformFieldsToCacheObject,
IEntityGenericCacher,
} from '@expo/entity';
import { CacheLoadResult, EntityConfiguration, IEntityGenericCacher } from '@expo/entity';
import invariant from 'invariant';
import Redis from 'ioredis';
import { redisTransformerMap } from './RedisCommon';
import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
import ShardedGenericRedisCacher, {
ShardedRedisCacheAdapterContext,
} from './ShardedGenericRedisCacher';
// Sentinel value we store in Redis to negatively cache a database miss.
// The sentinel value is distinct from any (positively) cached value.
const DOES_NOT_EXIST_REDIS = '';
export interface IRedisTransaction {
set(key: string, value: string, secondsToken: 'EX', seconds: number): this;
exec(): Promise<any>;
}
export interface IRedis {
mget(...args: [...keys: string[]]): Promise<(string | null)[]>;
multi(): IRedisTransaction;
del(...args: [...keys: string[]]): Promise<any>;
}
export interface GenericRedisCacheContext {
export type RedisCacheAdapterContext = Pick<
ShardedRedisCacheAdapterContext,
'cacheKeyPrefix' | 'cacheKeyVersion' | 'makeKeyFn' | 'ttlSecondsNegative' | 'ttlSecondsPositive'
> & {
/**
* Instance of ioredis.Redis
*/
redisClient: IRedis;
/**
* Create a key string for key parts (cache key prefix, versions, entity name, etc).
* Most commonly a simple `parts.join(':')`. See integration test for example.
*/
makeKeyFn: (...parts: string[]) => string;
/**
* Prefix prepended to all entity cache keys. Useful for adding a short, human-readable
* distintion for entity keys, e.g. `ent-`
*/
cacheKeyPrefix: string;
/**
* 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;
}
redisClient: Redis;
};
export default class GenericRedisCacher<TFields> implements IEntityGenericCacher<TFields> {
private readonly shardedGenericRedisCacher: ShardedGenericRedisCacher<TFields>;
constructor(
private readonly context: GenericRedisCacheContext,
private readonly entityConfiguration: EntityConfiguration<TFields>
) {}
context: RedisCacheAdapterContext,
entityConfiguration: EntityConfiguration<TFields>
) {
this.shardedGenericRedisCacher = new ShardedGenericRedisCacher(
{
...context,
getShardGroupForKeysFn: (keys) => new Map(keys.map((k) => [k, 1])),
getRedisInstanceForShardGroup: (shardGroup) => {
invariant(shardGroup === 1, 'invalid shard group');
return context.redisClient;
},
shardingSchemeVersion: 1,
},
entityConfiguration
);
}
public async loadManyAsync(
keys: readonly string[]
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
if (keys.length === 0) {
return new Map();
}
const redisResults = await wrapNativeRedisCallAsync(() =>
this.context.redisClient.mget(...keys)
);
const results = new Map<string, CacheLoadResult<TFields>>();
for (let i = 0; i < keys.length; i++) {
const key = keys[i]!;
const redisResult = redisResults[i];
if (redisResult === DOES_NOT_EXIST_REDIS) {
results.set(key, {
status: CacheStatus.NEGATIVE,
});
} else if (redisResult) {
results.set(key, {
status: CacheStatus.HIT,
item: transformCacheObjectToFields(
this.entityConfiguration,
redisTransformerMap,
JSON.parse(redisResult)
),
});
} else {
results.set(key, {
status: CacheStatus.MISS,
});
}
}
return results;
return this.shardedGenericRedisCacher.loadManyAsync(keys);
}
public async cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void> {
if (objectMap.size === 0) {
return;
}
let redisTransaction = this.context.redisClient.multi();
objectMap.forEach((object, key) => {
redisTransaction = redisTransaction.set(
key,
JSON.stringify(
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
),
'EX',
this.context.ttlSecondsPositive
);
});
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
return this.shardedGenericRedisCacher.cacheManyAsync(objectMap);
}
public async cacheDBMissesAsync(keys: readonly string[]): Promise<void> {
if (keys.length === 0) {
return;
}
let redisTransaction = this.context.redisClient.multi();
keys.forEach((key) => {
redisTransaction = redisTransaction.set(
key,
DOES_NOT_EXIST_REDIS,
'EX',
this.context.ttlSecondsNegative
);
});
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
return this.shardedGenericRedisCacher.cacheDBMissesAsync(keys);
}
public async invalidateManyAsync(keys: readonly string[]): Promise<void> {
if (keys.length === 0) {
return;
}
await wrapNativeRedisCallAsync(() => this.context.redisClient.del(...keys));
return this.shardedGenericRedisCacher.invalidateManyAsync(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)
);
return this.shardedGenericRedisCacher.makeCacheKey(fieldName, fieldValue);
}
}
@@ -5,14 +5,15 @@ import {
GenericEntityCacheAdapter,
} from '@expo/entity';
import GenericRedisCacher, { GenericRedisCacheContext } from './GenericRedisCacher';
import GenericRedisCacher, { RedisCacheAdapterContext } from './GenericRedisCacher';
export default class RedisCacheAdapterProvider implements IEntityCacheAdapterProvider {
constructor(private readonly context: GenericRedisCacheContext) {}
constructor(private readonly context: RedisCacheAdapterContext) {}
getCacheAdapter<TFields>(
entityConfiguration: EntityConfiguration<TFields>
): IEntityCacheAdapter<TFields> {
return new GenericEntityCacheAdapter(new GenericRedisCacher(this.context, entityConfiguration));
const genericCacher = new GenericRedisCacher(this.context, entityConfiguration);
return new GenericEntityCacheAdapter(genericCacher);
}
}
@@ -0,0 +1,222 @@
import {
CacheLoadResult,
CacheStatus,
EntityConfiguration,
transformCacheObjectToFields,
transformFieldsToCacheObject,
IEntityGenericCacher,
mapMapAsync,
filterMap,
computeIfAbsent,
} from '@expo/entity';
import invariant from 'invariant';
import { Redis } from 'ioredis';
import { redisTransformerMap } from './RedisCommon';
import wrapNativeRedisCallAsync from './errors/wrapNativeRedisCallAsync';
// Sentinel value we store in Redis to negatively cache a database miss.
// The sentinel value is distinct from any (positively) cached value.
const DOES_NOT_EXIST_REDIS = '';
export type ShardGroup = number;
export interface ShardedRedisCacheAdapterContext {
/**
* Shard computation function.
*/
getShardGroupForKeysFn: (keys: readonly string[]) => ReadonlyMap<string, ShardGroup>;
/**
* Get Redis instance for shard group.
*/
getRedisInstanceForShardGroup: (shardGroup: ShardGroup) => Redis;
/**
* Sharding scheme version. Increment when sharding scheme is updated.
*/
shardingSchemeVersion: number;
/**
* 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 ShardedGenericRedisCacher<TFields> implements IEntityGenericCacher<TFields> {
constructor(
private readonly context: ShardedRedisCacheAdapterContext,
private readonly entityConfiguration: EntityConfiguration<TFields>
) {}
private getRedisClientsForKeys(
keys: readonly string[]
): Map<ShardGroup, { keys: string[]; redisClient: Redis }> {
const shardGroupsForKeys = this.context.getShardGroupForKeysFn(keys);
const redisClientsForKeys = new Map<ShardGroup, { keys: string[]; redisClient: Redis }>();
for (const [key, shardGroup] of shardGroupsForKeys) {
const entry = computeIfAbsent(redisClientsForKeys, shardGroup, (currShardGroup) => ({
keys: [],
redisClient: this.context.getRedisInstanceForShardGroup(currShardGroup),
}));
entry.keys.push(key);
}
return redisClientsForKeys;
}
public async loadManyAsync(
keys: readonly string[]
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
if (keys.length === 0) {
return new Map();
}
const redisClientsForKeys = this.getRedisClientsForKeys(keys);
const allShardResults = (
await mapMapAsync(redisClientsForKeys, async ({ redisClient, keys }) => {
return await this.getCacheResultsForKeysAsync(redisClient, keys);
})
).values();
const results = new Map<string, CacheLoadResult<TFields>>();
for (const shardResults of allShardResults) {
for (const [shardResultKey, shardResult] of shardResults) {
results.set(shardResultKey, shardResult);
}
}
return results;
}
private async getCacheResultsForKeysAsync(
redisClient: Redis,
keys: readonly string[]
): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>> {
const redisResults = await wrapNativeRedisCallAsync(() => redisClient.mget(...keys));
const results = new Map<string, CacheLoadResult<TFields>>();
for (let i = 0; i < keys.length; i++) {
const key = keys[i]!;
const redisResult = redisResults[i];
if (redisResult === DOES_NOT_EXIST_REDIS) {
results.set(key, {
status: CacheStatus.NEGATIVE,
});
} else if (redisResult) {
results.set(key, {
status: CacheStatus.HIT,
item: transformCacheObjectToFields(
this.entityConfiguration,
redisTransformerMap,
JSON.parse(redisResult)
),
});
} else {
results.set(key, {
status: CacheStatus.MISS,
});
}
}
return results;
}
public async cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void> {
if (objectMap.size === 0) {
return;
}
const keys = [...objectMap.keys()];
const redisClientsForKeys = this.getRedisClientsForKeys(keys);
await mapMapAsync(redisClientsForKeys, async ({ redisClient, keys }) => {
const keySet = new Set(keys);
const objectMapForKeys = filterMap(objectMap, (_, k) => keySet.has(k));
let redisTransaction = redisClient.multi();
objectMapForKeys.forEach((object, key) => {
redisTransaction = redisTransaction.set(
key,
JSON.stringify(
transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
),
'EX',
this.context.ttlSecondsPositive
);
});
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
});
}
public async cacheDBMissesAsync(allKeys: readonly string[]): Promise<void> {
if (allKeys.length === 0) {
return;
}
const redisClientsForKeys = this.getRedisClientsForKeys(allKeys);
await mapMapAsync(redisClientsForKeys, async ({ redisClient, keys }) => {
let redisTransaction = redisClient.multi();
keys.forEach((key) => {
redisTransaction = redisTransaction.set(
key,
DOES_NOT_EXIST_REDIS,
'EX',
this.context.ttlSecondsNegative
);
});
await wrapNativeRedisCallAsync(() => redisTransaction.exec());
});
}
public async invalidateManyAsync(allKeys: readonly string[]): Promise<void> {
if (allKeys.length === 0) {
return;
}
const redisClientsForKeys = this.getRedisClientsForKeys(allKeys);
await mapMapAsync(redisClientsForKeys, async ({ redisClient, keys }) => {
await wrapNativeRedisCallAsync(() => 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,
`v${this.context.shardingSchemeVersion}`,
this.entityConfiguration.tableName,
`v2.${this.entityConfiguration.cacheKeyVersion}`,
columnName,
String(fieldValue)
);
}
}
@@ -0,0 +1,21 @@
import {
IEntityCacheAdapterProvider,
EntityConfiguration,
IEntityCacheAdapter,
GenericEntityCacheAdapter,
} from '@expo/entity';
import ShardedGenericRedisCacher, {
ShardedRedisCacheAdapterContext,
} from './ShardedGenericRedisCacher';
export default class ShardedRedisCacheAdapterProvider implements IEntityCacheAdapterProvider {
constructor(private readonly context: ShardedRedisCacheAdapterContext) {}
getCacheAdapter<TFields>(
entityConfiguration: EntityConfiguration<TFields>
): IEntityCacheAdapter<TFields> {
const genericCacher = new ShardedGenericRedisCacher(this.context, entityConfiguration);
return new GenericEntityCacheAdapter(genericCacher);
}
}
@@ -1,166 +0,0 @@
import { Batcher } from '@expo/batcher';
import { ViewerContext, zipToMap } from '@expo/entity';
import invariant from 'invariant';
import Redis from 'ioredis';
import nullthrows from 'nullthrows';
import { URL } from 'url';
import { v4 as uuidv4 } from 'uuid';
import GenericRedisCacher, {
IRedis,
IRedisTransaction,
GenericRedisCacheContext,
} from '../GenericRedisCacher';
import RedisTestEntity from '../testfixtures/RedisTestEntity';
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
class BatchedRedis implements IRedis {
private readonly mgetBatcher = new Batcher<string[], (string | null)[]>(
this.batchMgetAsync.bind(this),
{
maxBatchInterval: 0,
}
);
constructor(private readonly redis: Redis) {}
private async batchMgetAsync(keySets: string[][]): Promise<(string | null)[][]> {
// ordered distinct keys to fetch
const allKeysToFetch = [...new Set(keySets.flat())];
// fetch the distinct keys
const allResults = await this.redis.mget(...allKeysToFetch);
// put them into a map for fast lookup
const keysToResults = zipToMap(allKeysToFetch, allResults);
// re-associate them with original key sets
return keySets.map((keySet) =>
keySet.map((key) => {
const result = keysToResults.get(key);
invariant(result !== undefined, 'result should not be undefined');
return result;
})
);
}
async mget(...args: string[]): Promise<(string | null)[]> {
return await this.mgetBatcher.batchAsync(args);
}
multi(): IRedisTransaction {
return this.redis.multi();
}
async del(...args: string[]): Promise<void> {
await this.redis.del(...args);
}
}
describe(GenericRedisCacher, () => {
const redis = new Redis(new URL(process.env['REDIS_URL']!).toString());
const redisClient = new BatchedRedis(redis);
let genericRedisCacheContext: GenericRedisCacheContext;
beforeAll(() => {
genericRedisCacheContext = {
redisClient,
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
const escapedParts = parts.map((part) =>
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
);
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
});
beforeEach(async () => {
await redis.flushdb();
});
afterAll(async () => {
redis.disconnect();
});
it('has correct caching behavior', async () => {
// simulate two requests
const viewerContext = new ViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
);
const mgetSpy = jest.spyOn(redis, 'mget');
const genericCacher =
viewerContext.entityCompanionProvider.getCompanionForEntity(RedisTestEntity)[
'tableDataCoordinator'
]['cacheAdapter']['genericCacher'];
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
const entity1Created = await RedisTestEntity.creator(viewerContext)
.setField('name', 'blah')
.enforceCreateAsync();
// loading an entity should put it in cache. load by multiple requests and multiple fields in same tick to ensure batch works
mgetSpy.mockClear();
const viewerContext1 = new ViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
);
const viewerContext2 = new ViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
);
const viewerContext3 = new ViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
);
const [entity1, entity2, entity3] = await Promise.all([
RedisTestEntity.loader(viewerContext1).enforcing().loadByIDAsync(entity1Created.getID()),
RedisTestEntity.loader(viewerContext2).enforcing().loadByIDAsync(entity1Created.getID()),
RedisTestEntity.loader(viewerContext3)
.enforcing()
.loadByFieldEqualingAsync('name', entity1Created.getField('name')),
]);
expect(mgetSpy).toHaveBeenCalledTimes(1);
expect(mgetSpy.mock.calls[0]).toHaveLength(2); // should dedupe the first two loads
expect(entity1.getID()).toEqual(entity2.getID());
expect(entity2.getID()).toEqual(nullthrows(entity3).getID());
const cacheKeyEntity1 = cacheKeyMaker('id', entity1Created.getID());
const cachedJSON = await redis.get(cacheKeyEntity1);
const cachedValue = JSON.parse(cachedJSON!);
expect(cachedValue).toMatchObject({
id: entity1.getID(),
name: 'blah',
});
const cacheKeyEntity1NameField = cacheKeyMaker('name', entity1Created.getField('name'));
await RedisTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('name', entity1Created.getField('name'));
await expect(redis.get(cacheKeyEntity1NameField)).resolves.toEqual(cachedJSON);
// simulate non existent db fetch, should write negative result ('') to cache
const nonExistentId = uuidv4();
const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
nonExistentId
);
expect(entityNonExistentResult.ok).toBe(false);
const cacheKeyNonExistent = cacheKeyMaker('id', nonExistentId);
const nonExistentCachedValue = await redis.get(cacheKeyNonExistent);
expect(nonExistentCachedValue).toEqual('');
// load again through entities framework to ensure it reads negative result
const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
nonExistentId
);
expect(entityNonExistentResult2.ok).toBe(false);
// invalidate from cache to ensure it invalidates correctly in both caches
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
await expect(redis.get(cacheKeyEntity1)).resolves.toBeNull();
await expect(redis.get(cacheKeyEntity1NameField)).resolves.toBeNull();
});
});
@@ -4,17 +4,17 @@ import Redis from 'ioredis';
import { URL } from 'url';
import { v4 as uuidv4 } from 'uuid';
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
import GenericRedisCacher, { RedisCacheAdapterContext } from '../GenericRedisCacher';
import RedisTestEntity from '../testfixtures/RedisTestEntity';
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
class TestViewerContext extends ViewerContext {}
describe(GenericRedisCacher, () => {
let genericRedisCacheContext: GenericRedisCacheContext;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
genericRedisCacheContext = {
redisCacheAdapterContext = {
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
@@ -24,26 +24,27 @@ describe(GenericRedisCacher, () => {
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
});
beforeEach(async () => {
await (genericRedisCacheContext.redisClient as Redis).flushdb();
await redisCacheAdapterContext.redisClient.flushdb();
});
afterAll(async () => {
(genericRedisCacheContext.redisClient as Redis).disconnect();
redisCacheAdapterContext.redisClient.disconnect();
});
it('has correct caching behavior', async () => {
const viewerContext = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const genericCacher =
viewerContext.entityCompanionProvider.getCompanionForEntity(RedisTestEntity)[
'tableDataCoordinator'
]['cacheAdapter']['genericCacher'];
const genericCacher = viewerContext.entityCompanionProvider.getCompanionForEntity(
RedisTestEntity,
RedisTestEntity.getCompanionDefinition()
)['tableDataCoordinator']['cacheAdapter']['genericCacher'];
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
const entity1Created = await RedisTestEntity.creator(viewerContext)
@@ -55,7 +56,7 @@ describe(GenericRedisCacher, () => {
.enforcing()
.loadByIDAsync(entity1Created.getID());
const cachedJSON = await (genericRedisCacheContext.redisClient as Redis).get(
const cachedJSON = await redisCacheAdapterContext.redisClient.get(
cacheKeyMaker('id', entity1.getID())
);
const cachedValue = JSON.parse(cachedJSON!);
@@ -72,7 +73,7 @@ describe(GenericRedisCacher, () => {
);
expect(entityNonExistentResult.ok).toBe(false);
const nonExistentCachedValue = await (genericRedisCacheContext.redisClient as Redis).get(
const nonExistentCachedValue = await redisCacheAdapterContext.redisClient.get(
cacheKeyMaker('id', nonExistentId)
);
expect(nonExistentCachedValue).toEqual('');
@@ -85,7 +86,7 @@ describe(GenericRedisCacher, () => {
// invalidate from cache to ensure it invalidates correctly
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
const cachedValueNull = await (genericRedisCacheContext.redisClient as Redis).get(
const cachedValueNull = await redisCacheAdapterContext.redisClient.get(
cacheKeyMaker('id', entity1.getID())
);
expect(cachedValueNull).toBe(null);
@@ -93,7 +94,7 @@ describe(GenericRedisCacher, () => {
it('caches and restores date fields', async () => {
const viewerContext = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const date = new Date();
const entity1 = await enforceAsyncResult(
@@ -108,7 +109,7 @@ describe(GenericRedisCacher, () => {
// simulate new request
const vc2 = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const entity3 = await RedisTestEntity.loader(vc2).enforcing().loadByIDAsync(entity1.getID());
expect(entity3.getField('dateField')).toEqual(date);
@@ -116,7 +117,7 @@ describe(GenericRedisCacher, () => {
it('caches and restores empty string field keys', async () => {
const viewerContext = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const entity1 = await enforceAsyncResult(
RedisTestEntity.creator(viewerContext).setField('name', '').createAsync()
@@ -128,7 +129,7 @@ describe(GenericRedisCacher, () => {
// simulate new request
const vc2 = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const entity3 = await RedisTestEntity.loader(vc2)
.enforcing()
@@ -2,7 +2,7 @@ import { CacheStatus, ViewerContext } from '@expo/entity';
import Redis from 'ioredis';
import { URL } from 'url';
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
import GenericRedisCacher, { RedisCacheAdapterContext } from '../GenericRedisCacher';
import RedisTestEntity, {
redisTestEntityConfiguration,
RedisTestEntityFields,
@@ -12,10 +12,10 @@ import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtur
class TestViewerContext extends ViewerContext {}
describe(GenericRedisCacher, () => {
let genericRedisCacheContext: GenericRedisCacheContext;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
genericRedisCacheContext = {
redisCacheAdapterContext = {
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
@@ -25,24 +25,25 @@ describe(GenericRedisCacher, () => {
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
});
beforeEach(async () => {
await (genericRedisCacheContext.redisClient as Redis).flushdb();
await redisCacheAdapterContext.redisClient.flushdb();
});
afterAll(async () => {
(genericRedisCacheContext.redisClient as Redis).disconnect();
redisCacheAdapterContext.redisClient.disconnect();
});
it('has correct caching and loading behavior', async () => {
const viewerContext = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const genericRedisCacher = new GenericRedisCacher(
genericRedisCacheContext,
redisCacheAdapterContext,
redisTestEntityConfiguration
);
const date = new Date();
@@ -56,7 +57,7 @@ describe(GenericRedisCacher, () => {
]);
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!);
expect(cachedValue).toMatchObject({
id: entity1Created.getID(),
@@ -73,7 +74,7 @@ describe(GenericRedisCacher, () => {
});
it('has correct negative caching behaviour', async () => {
const genericRedisCacher = new GenericRedisCacher(
genericRedisCacheContext,
redisCacheAdapterContext,
redisTestEntityConfiguration
);
@@ -85,10 +86,10 @@ describe(GenericRedisCacher, () => {
});
it('has correct invalidation behaviour', async () => {
const viewerContext = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const genericRedisCacher = new GenericRedisCacher(
genericRedisCacheContext,
redisCacheAdapterContext,
redisTestEntityConfiguration
);
const date = new Date();
@@ -0,0 +1,147 @@
import { ViewerContext } from '@expo/entity';
import Redis from 'ioredis';
import nullthrows from 'nullthrows';
import { URL } from 'url';
import ShardedGenericRedisCacher, {
ShardedRedisCacheAdapterContext,
} from '../ShardedGenericRedisCacher';
import RedisTestEntity from '../testfixtures/RedisTestEntity';
import { createShardedRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createShardedRedisIntegrationTestEntityCompanionProvider';
const ids = {
entity1: '7345999c-b97d-47af-873c-bb1e9c1876f3', // shard 0
nonexistent: 'c207c238-70b5-41bb-8f33-130a57a6f6c5', // shard 1
};
function getShardForKey(key: string): 0 | 1 {
if (key.includes(ids.entity1)) {
return 0;
}
if (key.includes(ids.nonexistent)) {
return 1;
}
// entity1
if (key.includes('name:blah')) {
return 1; // put other field cache for entity1 on different server than the id field cached value
}
throw Error('unknown id encountered: ' + key);
}
describe(ShardedGenericRedisCacher, () => {
let redis1: Redis;
let redis2: Redis;
let redisCacheAdapterContext: ShardedRedisCacheAdapterContext;
beforeAll(() => {
redis1 = new Redis(new URL(process.env['REDIS_URL']!).toString());
redis2 = new Redis(new URL(process.env['REDIS_URL_2']!).toString());
redisCacheAdapterContext = {
getShardGroupForKeysFn: (keys) => new Map(keys.map((k) => [k, getShardForKey(k)])),
getRedisInstanceForShardGroup: (shardGroup) => (shardGroup === 0 ? redis1 : redis2),
shardingSchemeVersion: 1,
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
const escapedParts = parts.map((part) =>
part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
);
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
});
beforeEach(async () => {
await Promise.all([redis1?.flushdb(), redis2?.flushdb()]);
});
afterAll(async () => {
redis1.disconnect();
redis2.disconnect();
});
it('has correct caching behavior', async () => {
const viewerContext = new ViewerContext(
createShardedRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const genericCacher = viewerContext.entityCompanionProvider.getCompanionForEntity(
RedisTestEntity,
RedisTestEntity.getCompanionDefinition()
)['tableDataCoordinator']['cacheAdapter']['genericCacher'];
const cacheKeyMaker = genericCacher['makeCacheKey'].bind(genericCacher);
const entity1Created = await RedisTestEntity.creator(viewerContext)
.setField('id', ids.entity1)
.setField('name', 'blah')
.enforceCreateAsync();
// loading an entity should put it in cache. load by both cached fields (which are on separate redis instances).
const cacheKeyEntity1 = cacheKeyMaker('id', entity1Created.getID());
const cacheKeyEntity1ShardGroup = nullthrows(
redisCacheAdapterContext.getShardGroupForKeysFn([cacheKeyEntity1]).get(cacheKeyEntity1)
);
const cacheRedisClientForEntity =
redisCacheAdapterContext.getRedisInstanceForShardGroup(cacheKeyEntity1ShardGroup);
const entity1 = await RedisTestEntity.loader(viewerContext)
.enforcing()
.loadByIDAsync(entity1Created.getID());
const cachedJSON = await cacheRedisClientForEntity.get(cacheKeyEntity1);
const cachedValue = JSON.parse(cachedJSON!);
expect(cachedValue).toMatchObject({
id: entity1.getID(),
name: 'blah',
});
const cacheKeyEntity1NameField = cacheKeyMaker('name', entity1Created.getField('name'));
const cacheKeyEntity1NameFieldShardGroup = nullthrows(
redisCacheAdapterContext
.getShardGroupForKeysFn([cacheKeyEntity1NameField])
.get(cacheKeyEntity1NameField)
);
const cacheRedisClientForEntityNameField =
redisCacheAdapterContext.getRedisInstanceForShardGroup(cacheKeyEntity1NameFieldShardGroup);
await RedisTestEntity.loader(viewerContext)
.enforcing()
.loadByFieldEqualingAsync('name', entity1Created.getField('name'));
await expect(cacheRedisClientForEntityNameField.get(cacheKeyEntity1NameField)).resolves.toEqual(
cachedJSON
);
expect(cacheKeyEntity1ShardGroup).not.toEqual(cacheKeyEntity1NameFieldShardGroup);
// simulate non existent db fetch, should write negative result ('') to cache
const nonExistentId = ids.nonexistent;
const entityNonExistentResult = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
nonExistentId
);
expect(entityNonExistentResult.ok).toBe(false);
const cacheKeyNonExistent = cacheKeyMaker('id', nonExistentId);
const cacheRedisClientForNonExistent = redisCacheAdapterContext.getRedisInstanceForShardGroup(
nullthrows(
redisCacheAdapterContext
.getShardGroupForKeysFn([cacheKeyNonExistent])
.get(cacheKeyNonExistent)
)
);
const nonExistentCachedValue = await cacheRedisClientForNonExistent.get(cacheKeyNonExistent);
expect(nonExistentCachedValue).toEqual('');
// load again through entities framework to ensure it reads negative result
const entityNonExistentResult2 = await RedisTestEntity.loader(viewerContext).loadByIDAsync(
nonExistentId
);
expect(entityNonExistentResult2.ok).toBe(false);
// invalidate from cache to ensure it invalidates correctly in both caches
await RedisTestEntity.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
await expect(cacheRedisClientForEntity.get(cacheKeyEntity1)).resolves.toBeNull();
await expect(
cacheRedisClientForEntityNameField.get(cacheKeyEntity1NameField)
).resolves.toBeNull();
});
});
@@ -2,19 +2,18 @@ import { EntityCacheAdapterTransientError, ViewerContext } from '@expo/entity';
import Redis from 'ioredis';
import { URL } from 'url';
import GenericRedisCacher, { GenericRedisCacheContext } from '../GenericRedisCacher';
import GenericRedisCacher, { RedisCacheAdapterContext } from '../GenericRedisCacher';
import RedisTestEntity from '../testfixtures/RedisTestEntity';
import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
class TestViewerContext extends ViewerContext {}
describe(GenericRedisCacher, () => {
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let genericRedisCacheContext: GenericRedisCacheContext;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
genericRedisCacheContext = {
redisClient,
redisCacheAdapterContext = {
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
const escapedParts = parts.map((part) =>
@@ -23,20 +22,21 @@ describe(GenericRedisCacher, () => {
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
});
beforeEach(async () => {
await redisClient.flushdb();
await redisCacheAdapterContext.redisClient.flushdb();
});
it('throws when redis is disconnected', async () => {
redisClient.disconnect();
redisCacheAdapterContext.redisClient.disconnect();
const vc1 = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
await expect(
@@ -34,6 +34,7 @@ describe(GenericRedisCacher, () => {
{
redisClient: instance(mockRedisClient),
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
@@ -64,6 +65,7 @@ describe(GenericRedisCacher, () => {
{
redisClient: instance(mock<Redis>()),
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
@@ -96,6 +98,7 @@ describe(GenericRedisCacher, () => {
{
redisClient: instance(mockRedisClient),
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
@@ -135,6 +138,7 @@ describe(GenericRedisCacher, () => {
{
redisClient: instance(mockRedisClient),
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
@@ -163,6 +167,7 @@ describe(GenericRedisCacher, () => {
{
redisClient: instance(mockRedisClient),
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
@@ -181,6 +186,7 @@ describe(GenericRedisCacher, () => {
{
redisClient: instance(mock<Redis>()),
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
@@ -0,0 +1,316 @@
import { CacheStatus, UUIDField, EntityConfiguration } from '@expo/entity';
import { Redis, Pipeline } from 'ioredis';
import { mock, when, instance, anything, verify } from 'ts-mockito';
import ShardedGenericRedisCacher from '../ShardedGenericRedisCacher';
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(ShardedGenericRedisCacher, () => {
describe('loadManyAsync', () => {
it('returns appropriate cache results', async () => {
const makeMockRedis = (): { mockRedisClient: Redis; redisResults: Map<string, string> } => {
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)
);
return { mockRedisClient, redisResults };
};
const [
{ mockRedisClient: mockRedisClient1, redisResults: redisResults1 },
{ mockRedisClient: mockRedisClient2, redisResults: redisResults2 },
] = [makeMockRedis(), makeMockRedis()];
const redisClient1 = instance(mockRedisClient1);
const redisClient2 = instance(mockRedisClient2);
const genericCacher = new ShardedGenericRedisCacher(
{
getShardGroupForKeysFn: (keys) =>
new Map(keys.map((k) => [k, k.includes('ins-1') ? 1 : 2])),
getRedisInstanceForShardGroup: (shardGroup) =>
shardGroup === 1 ? redisClient1 : redisClient2,
shardingSchemeVersion: 1,
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
},
entityConfiguration
);
const cacheKeyWat1 = genericCacher['makeCacheKey']('id', 'wat-ins-1');
const cacheKeyWho1 = genericCacher['makeCacheKey']('id', 'who-ins-1');
const cacheKeyWhy1 = genericCacher['makeCacheKey']('id', 'why-ins-1');
const cacheKeyWat2 = genericCacher['makeCacheKey']('id', 'wat-ins-2');
const cacheKeyWho2 = genericCacher['makeCacheKey']('id', 'who-ins-2');
const cacheKeyWhy2 = genericCacher['makeCacheKey']('id', 'why-ins-2');
redisResults1.set(cacheKeyWat1, JSON.stringify({ id: 'wat-ins-1' }));
redisResults1.set(cacheKeyWho1, '');
redisResults2.set(cacheKeyWat2, JSON.stringify({ id: 'wat-ins-2' }));
redisResults2.set(cacheKeyWho2, '');
const results = await genericCacher.loadManyAsync([
cacheKeyWat1,
cacheKeyWho1,
cacheKeyWhy1,
cacheKeyWat2,
cacheKeyWho2,
cacheKeyWhy2,
]);
expect(results.get(cacheKeyWat1)).toMatchObject({
status: CacheStatus.HIT,
item: { id: 'wat-ins-1' },
});
expect(results.get(cacheKeyWho1)).toMatchObject({ status: CacheStatus.NEGATIVE });
expect(results.get(cacheKeyWhy1)).toMatchObject({ status: CacheStatus.MISS });
expect(results.get(cacheKeyWat2)).toMatchObject({
status: CacheStatus.HIT,
item: { id: 'wat-ins-2' },
});
expect(results.get(cacheKeyWho2)).toMatchObject({ status: CacheStatus.NEGATIVE });
expect(results.get(cacheKeyWhy2)).toMatchObject({ status: CacheStatus.MISS });
expect(results.size).toBe(6);
});
it('returns empty map when passed empty array of fieldValues', async () => {
const mockRedisClient = mock<Redis>();
const redisClient = instance(mockRedisClient);
const genericCacher = new ShardedGenericRedisCacher(
{
getShardGroupForKeysFn: (keys) => new Map(keys.map((k) => [k, 1])),
getRedisInstanceForShardGroup: () => redisClient,
shardingSchemeVersion: 1,
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
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 makeMockRedis = (): { mockRedisClient: Redis; redisResults: Map<string, string> } => {
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);
return { mockRedisClient, redisResults };
};
const [
{ mockRedisClient: mockRedisClient1, redisResults: redisResults1 },
{ mockRedisClient: mockRedisClient2, redisResults: redisResults2 },
] = [makeMockRedis(), makeMockRedis()];
const redisClient1 = instance(mockRedisClient1);
const redisClient2 = instance(mockRedisClient2);
const genericCacher = new ShardedGenericRedisCacher(
{
getShardGroupForKeysFn: (keys) =>
new Map(keys.map((k) => [k, k.includes('ins-1') ? 1 : 2])),
getRedisInstanceForShardGroup: (shardGroup) =>
shardGroup === 1 ? redisClient1 : redisClient2,
shardingSchemeVersion: 1,
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
},
entityConfiguration
);
const cacheKey1 = genericCacher['makeCacheKey']('id', 'wat-ins-1');
const cacheKey2 = genericCacher['makeCacheKey']('id', 'wat-ins-2');
await genericCacher.cacheManyAsync(
new Map([
[cacheKey1, { id: 'wat-ins-1' }],
[cacheKey2, { id: 'wat-ins-2' }],
])
);
expect(redisResults1.get(cacheKey1)).toMatchObject({
value: JSON.stringify({ id: 'wat-ins-1' }),
code: 'EX',
ttl: 1,
});
expect(redisResults2.get(cacheKey2)).toMatchObject({
value: JSON.stringify({ id: 'wat-ins-2' }),
code: 'EX',
ttl: 1,
});
expect(redisResults1.get(cacheKey2)).toBeUndefined();
expect(redisResults2.get(cacheKey1)).toBeUndefined();
});
});
describe('cacheDBMissesAsync', () => {
it('correctly caches misses', async () => {
const makeMockRedis = (): { mockRedisClient: Redis; redisResults: Map<string, string> } => {
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);
return { mockRedisClient, redisResults };
};
const [
{ mockRedisClient: mockRedisClient1, redisResults: redisResults1 },
{ mockRedisClient: mockRedisClient2, redisResults: redisResults2 },
] = [makeMockRedis(), makeMockRedis()];
const redisClient1 = instance(mockRedisClient1);
const redisClient2 = instance(mockRedisClient2);
const genericCacher = new ShardedGenericRedisCacher(
{
getShardGroupForKeysFn: (keys) =>
new Map(keys.map((k) => [k, k.includes('ins-1') ? 1 : 2])),
getRedisInstanceForShardGroup: (shardGroup) =>
shardGroup === 1 ? redisClient1 : redisClient2,
shardingSchemeVersion: 1,
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
},
entityConfiguration
);
const cacheKey1 = genericCacher['makeCacheKey']('id', 'wat-ins-1');
const cacheKey2 = genericCacher['makeCacheKey']('id', 'wat-ins-2');
await genericCacher.cacheDBMissesAsync([cacheKey1, cacheKey2]);
expect(redisResults1.get(cacheKey1)).toMatchObject({
value: '',
code: 'EX',
ttl: 2,
});
expect(redisResults2.get(cacheKey2)).toMatchObject({
value: '',
code: 'EX',
ttl: 2,
});
expect(redisResults1.get(cacheKey2)).toBeUndefined();
expect(redisResults2.get(cacheKey1)).toBeUndefined();
});
});
describe('invalidateManyAsync', () => {
it('invalidates correctly', async () => {
const makeMockRedis = (): { mockRedisClient: Redis } => {
const mockRedisClient = mock<Redis>();
return { mockRedisClient };
};
const [{ mockRedisClient: mockRedisClient1 }, { mockRedisClient: mockRedisClient2 }] = [
makeMockRedis(),
makeMockRedis(),
];
const redisClient1 = instance(mockRedisClient1);
const redisClient2 = instance(mockRedisClient2);
const genericCacher = new ShardedGenericRedisCacher(
{
getShardGroupForKeysFn: (keys) =>
new Map(keys.map((k) => [k, k.includes('ins-1') ? 1 : 2])),
getRedisInstanceForShardGroup: (shardGroup) =>
shardGroup === 1 ? redisClient1 : redisClient2,
shardingSchemeVersion: 1,
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
},
entityConfiguration
);
const cacheKey1 = genericCacher['makeCacheKey']('id', 'wat-ins-1');
const cacheKey2 = genericCacher['makeCacheKey']('id', 'wat-ins-2');
await genericCacher.invalidateManyAsync([cacheKey1, cacheKey2]);
verify(mockRedisClient1.del(cacheKey1)).once();
verify(mockRedisClient2.del(cacheKey2)).once();
verify(mockRedisClient1.del(cacheKey2)).never();
verify(mockRedisClient2.del(cacheKey1)).never();
});
it('returns when passed empty array of fieldValues', async () => {
const mockRedisClient = mock<Redis>();
const redisClient = instance(mockRedisClient);
const genericCacher = new ShardedGenericRedisCacher(
{
getShardGroupForKeysFn: (keys) => new Map(keys.map((k) => [k, 1])),
getRedisInstanceForShardGroup: () => redisClient,
shardingSchemeVersion: 1,
makeKeyFn: (...parts) => parts.join(':'),
cacheKeyVersion: 1,
cacheKeyPrefix: 'hello-',
ttlSecondsPositive: 1,
ttlSecondsNegative: 2,
},
entityConfiguration
);
await genericCacher.invalidateManyAsync([]);
});
});
});
@@ -8,3 +8,6 @@ export { default as RedisCacheAdapterProvider } from './RedisCacheAdapterProvide
export * from './RedisCommon';
export { default as GenericRedisCacher } from './GenericRedisCacher';
export * from './GenericRedisCacher';
export { default as ShardedRedisCacheAdapterProvider } from './ShardedRedisCacheAdapterProvider';
export { default as ShardedGenericRedisCacher } from './ShardedGenericRedisCacher';
export * from './ShardedGenericRedisCacher';
@@ -17,18 +17,14 @@ export type RedisTestEntityFields = {
};
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
RedisTestEntityFields,
string,
ViewerContext,
RedisTestEntity,
RedisTestEntityPrivacyPolicy
> {
return {
entityClass: RedisTestEntity,
entityConfiguration: redisTestEntityConfiguration,
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
};
return redisTestEntityCompanionDefinition;
}
}
@@ -91,3 +87,9 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: RedisTestEntity,
entityConfiguration: redisTestEntityConfiguration,
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
});
@@ -6,14 +6,11 @@ import {
StubDatabaseAdapterProvider,
} from '@expo/entity';
import { GenericRedisCacheContext } from '../GenericRedisCacher';
import { RedisCacheAdapterContext } from '../GenericRedisCacher';
import RedisCacheAdapterProvider from '../RedisCacheAdapterProvider';
// share across all in calls in test to simulate postgres
const adapterProvider = new StubDatabaseAdapterProvider();
export const createRedisIntegrationTestEntityCompanionProvider = (
genericRedisCacheContext: GenericRedisCacheContext,
redisCacheAdapterContext: RedisCacheAdapterContext,
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => {
return new EntityCompanionProvider(
@@ -22,7 +19,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
[
'postgres',
{
adapterProvider,
adapterProvider: new StubDatabaseAdapterProvider(),
queryContextProvider: StubQueryContextProvider,
},
],
@@ -31,7 +28,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
[
'redis',
{
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
},
],
])
@@ -0,0 +1,38 @@
import {
NoOpEntityMetricsAdapter,
IEntityMetricsAdapter,
EntityCompanionProvider,
StubQueryContextProvider,
StubDatabaseAdapterProvider,
} from '@expo/entity';
import { ShardedRedisCacheAdapterContext } from '../ShardedGenericRedisCacher';
import ShardedRedisCacheAdapterProvider from '../ShardedRedisCacheAdapterProvider';
export const createShardedRedisIntegrationTestEntityCompanionProvider = (
shardedRedisCacheAdapterContext: ShardedRedisCacheAdapterContext,
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => {
return new EntityCompanionProvider(
metricsAdapter,
new Map([
[
'postgres',
{
adapterProvider: new StubDatabaseAdapterProvider(),
queryContextProvider: StubQueryContextProvider,
},
],
]),
new Map([
[
'redis',
{
cacheAdapterProvider: new ShardedRedisCacheAdapterProvider(
shardedRedisCacheAdapterContext
),
},
],
])
);
};
@@ -3,72 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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)
@@ -1,6 +1,6 @@
{
"name": "@expo/entity-database-adapter-knex",
"version": "0.35.0",
"version": "0.28.0",
"description": "Knex database adapter for @expo/entity",
"files": [
"build",
@@ -19,7 +19,7 @@
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -30,10 +30,10 @@
"@expo/entity": "*"
},
"dependencies": {
"knex": "^2.4.2"
"knex": "^1.0.2"
},
"devDependencies": {
"@expo/entity": "^0.35.0",
"pg": "8.10.0"
"@expo/entity": "^0.28.0",
"pg": "^8.7.1"
}
}
@@ -1,8 +1,4 @@
import {
EntityQueryContextProvider,
TransactionConfig,
TransactionIsolationLevel,
} from '@expo/entity';
import { EntityQueryContextProvider } from '@expo/entity';
import { Knex } from 'knex';
/**
@@ -17,16 +13,10 @@ export default class PostgresEntityQueryContextProvider extends EntityQueryConte
return this.knexInstance;
}
protected createTransactionRunner<T>(
transactionConfig?: TransactionConfig
): (transactionScope: (trx: any) => Promise<T>) => Promise<T> {
return (transactionScope) =>
this.knexInstance.transaction(
transactionScope,
transactionConfig
? PostgresEntityQueryContextProvider.convertTransactionConfig(transactionConfig)
: undefined
);
protected createTransactionRunner<T>(): (
transactionScope: (trx: any) => Promise<T>
) => Promise<T> {
return (transactionScope) => this.knexInstance.transaction(transactionScope);
}
protected createNestedTransactionRunner<T>(
@@ -34,27 +24,4 @@ export default class PostgresEntityQueryContextProvider extends EntityQueryConte
): (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) }
: {}),
};
}
}
@@ -3,7 +3,6 @@ import {
createUnitTestEntityCompanionProvider,
enforceResultsAsync,
ViewerContext,
TransactionIsolationLevel,
} from '@expo/entity';
import { enforceAsyncResult } from '@expo/results';
import { knex, Knex } from 'knex';
@@ -112,44 +111,6 @@ describe('postgres entity integration', () => {
expect(entities).toHaveLength(1);
});
it('passes transaction config into transactions', async () => {
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
const firstEntity = await enforceAsyncResult(
PostgresTestEntity.creator(vc1).setField('name', 'hello').createAsync()
);
const loadAndUpdateAsync = async (newName: string): Promise<{ error?: Error }> => {
try {
await vc1.runInTransactionForDatabaseAdaptorFlavorAsync(
'postgres',
async (queryContext) => {
const entity = await PostgresTestEntity.loader(vc1, queryContext)
.enforcing()
.loadByIDAsync(firstEntity.getID());
await PostgresTestEntity.updater(entity, queryContext)
.setField('name', newName)
.enforceUpdateAsync();
},
{ isolationLevel: TransactionIsolationLevel.SERIALIZABLE }
);
return {};
} catch (e) {
return { error: e as Error };
}
};
// do some parallel updates to trigger serializable error in at least some of them
const results = await Promise.all([
loadAndUpdateAsync('hello2'),
loadAndUpdateAsync('hello3'),
loadAndUpdateAsync('hello4'),
loadAndUpdateAsync('hello5'),
]);
expect(results.filter((r) => (r.error as any)?.cause?.code === '40001').length > 0).toBe(true);
});
describe('JSON fields', () => {
it('supports both types of array fields', async () => {
const vc1 = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
@@ -27,24 +27,21 @@ export default class ErrorsTestEntity extends Entity<
number,
ViewerContext
> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
ErrorsTestEntityFields,
number,
ViewerContext,
ErrorsTestEntity,
ErrorsTestEntityPrivacyPolicy
> {
return {
entityClass: ErrorsTestEntity,
entityConfiguration: ErrorsTestEntityConfiguration,
privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
};
return errorsTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
await knex.raw('CREATE EXTENSION IF NOT EXISTS "btree_gist"'); // for gist exclusion on varchar
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasForeignTable = await knex.schema.hasTable(foreignTableName);
if (!hasForeignTable) {
await knex.schema.createTable(foreignTableName, (table) => {
@@ -90,7 +87,7 @@ export default class ErrorsTestEntity extends Entity<
}
public static async dropPostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (hasTable) {
await knex.schema.dropTable(tableName);
@@ -172,3 +169,9 @@ export const ErrorsTestEntityConfiguration = new EntityConfiguration<ErrorsTestE
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const errorsTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: ErrorsTestEntity,
entityConfiguration: ErrorsTestEntityConfiguration,
privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
});
@@ -20,22 +20,18 @@ export default class InvalidTestEntity extends Entity<
number,
ViewerContext
> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
InvalidTestEntityFields,
number,
ViewerContext,
InvalidTestEntity,
InvalidTestEntityPrivacyPolicy
> {
return {
entityClass: InvalidTestEntity,
entityConfiguration: invalidTestEntityConfiguration,
privacyPolicyClass: InvalidTestEntityPrivacyPolicy,
};
return invalidTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) {
await knex.schema.createTable(tableName, (table) => {
@@ -47,7 +43,7 @@ export default class InvalidTestEntity extends Entity<
}
public static async dropPostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (hasTable) {
await knex.schema.dropTable(tableName);
@@ -109,3 +105,9 @@ export const invalidTestEntityConfiguration = new EntityConfiguration<InvalidTes
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const invalidTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: InvalidTestEntity,
entityConfiguration: invalidTestEntityConfiguration,
privacyPolicyClass: InvalidTestEntityPrivacyPolicy,
});
@@ -36,22 +36,18 @@ export default class PostgresTestEntity extends Entity<
string,
ViewerContext
> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
PostgresTestEntityFields,
string,
ViewerContext,
PostgresTestEntity,
PostgresTestEntityPrivacyPolicy
> {
return {
entityClass: PostgresTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresTestEntityPrivacyPolicy,
};
return postgresTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) {
await knex.schema.createTable(tableName, (table) => {
@@ -71,7 +67,7 @@ export default class PostgresTestEntity extends Entity<
}
public static async dropPostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (hasTable) {
await knex.schema.dropTable(tableName);
@@ -158,3 +154,9 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: PostgresTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresTestEntityPrivacyPolicy,
});
@@ -24,33 +24,18 @@ export default class PostgresTriggerTestEntity extends Entity<
string,
ViewerContext
> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
PostgresTriggerTestEntityFields,
string,
ViewerContext,
PostgresTriggerTestEntity,
PostgresTriggerTestEntityPrivacyPolicy
> {
return {
entityClass: PostgresTriggerTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresTriggerTestEntityPrivacyPolicy,
mutationTriggers: {
beforeCreate: [new ThrowConditionallyTrigger('name', 'beforeCreate')],
afterCreate: [new ThrowConditionallyTrigger('name', 'afterCreate')],
beforeUpdate: [new ThrowConditionallyTrigger('name', 'beforeUpdate')],
afterUpdate: [new ThrowConditionallyTrigger('name', 'afterUpdate')],
beforeDelete: [new ThrowConditionallyTrigger('name', 'beforeDelete')],
afterDelete: [new ThrowConditionallyTrigger('name', 'afterDelete')],
beforeAll: [new ThrowConditionallyTrigger('name', 'beforeAll')],
afterAll: [new ThrowConditionallyTrigger('name', 'afterAll')],
afterCommit: [new ThrowConditionallyNonTransactionalTrigger('name', 'afterCommit')],
},
};
return postgresTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) {
await knex.schema.createTable(tableName, (table) => {
@@ -62,7 +47,7 @@ export default class PostgresTriggerTestEntity extends Entity<
}
public static async dropPostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (hasTable) {
await knex.schema.dropTable(tableName);
@@ -173,3 +158,20 @@ export const postgresTestEntityConfiguration =
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: PostgresTriggerTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresTriggerTestEntityPrivacyPolicy,
mutationTriggers: () => ({
beforeCreate: [new ThrowConditionallyTrigger('name', 'beforeCreate')],
afterCreate: [new ThrowConditionallyTrigger('name', 'afterCreate')],
beforeUpdate: [new ThrowConditionallyTrigger('name', 'beforeUpdate')],
afterUpdate: [new ThrowConditionallyTrigger('name', 'afterUpdate')],
beforeDelete: [new ThrowConditionallyTrigger('name', 'beforeDelete')],
afterDelete: [new ThrowConditionallyTrigger('name', 'afterDelete')],
beforeAll: [new ThrowConditionallyTrigger('name', 'beforeAll')],
afterAll: [new ThrowConditionallyTrigger('name', 'afterAll')],
afterCommit: [new ThrowConditionallyNonTransactionalTrigger('name', 'afterCommit')],
}),
});
@@ -20,22 +20,18 @@ export default class PostgresUniqueTestEntity extends Entity<
string,
ViewerContext
> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
PostgresUniqueTestEntityFields,
string,
ViewerContext,
PostgresUniqueTestEntity,
PostgresUniqueTestEntityPrivacyPolicy
> {
return {
entityClass: PostgresUniqueTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresUniqueTestEntityPrivacyPolicy,
};
return postgresTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) {
await knex.schema.createTable(tableName, (table) => {
@@ -47,7 +43,7 @@ export default class PostgresUniqueTestEntity extends Entity<
}
public static async dropPostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (hasTable) {
await knex.schema.dropTable(tableName);
@@ -111,3 +107,9 @@ export const postgresTestEntityConfiguration =
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: PostgresUniqueTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresUniqueTestEntityPrivacyPolicy,
});
@@ -23,23 +23,18 @@ export default class PostgresValidatorTestEntity extends Entity<
string,
ViewerContext
> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
PostgresValidatorTestEntityFields,
string,
ViewerContext,
PostgresValidatorTestEntity,
PostgresValidatorTestEntityPrivacyPolicy
> {
return {
entityClass: PostgresValidatorTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
mutationValidators: [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
};
return postgresTestEntityCompanionDefinition;
}
public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (!hasTable) {
await knex.schema.createTable(tableName, (table) => {
@@ -51,7 +46,7 @@ export default class PostgresValidatorTestEntity extends Entity<
}
public static async dropPostgresTable(knex: Knex): Promise<void> {
const tableName = 'postgres_test_entities';
const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
const hasTable = await knex.schema.hasTable(tableName);
if (hasTable) {
await knex.schema.dropTable(tableName);
@@ -145,3 +140,10 @@ export const postgresTestEntityConfiguration =
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: PostgresValidatorTestEntity,
entityConfiguration: postgresTestEntityConfiguration,
privacyPolicyClass: PostgresValidatorTestEntityPrivacyPolicy,
mutationValidators: () => [new ThrowConditionallyTrigger('name', 'beforeCreateAndBeforeUpdate')],
});
-66
View File
@@ -3,72 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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)
+10 -14
View File
@@ -1,7 +1,7 @@
{
"name": "@expo/entity-example",
"private": true,
"version": "0.35.0",
"version": "0.28.0",
"description": "An example integration of the @expo/entity framework",
"scripts": {
"tsc": "tsc",
@@ -15,7 +15,7 @@
"start": "tsnd --transpile-only --inspect --respawn --no-notify --async-stack-traces --throw-deprecation -- src/index.ts"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -23,20 +23,16 @@
"author": "Expo",
"license": "MIT",
"dependencies": {
"@apollo/server": "^4.7.3",
"@as-integrations/koa": "^1.1.1",
"@expo/entity": "^0.35.0",
"@koa/cors": "^4.0.0",
"@koa/router": "^12.0.0",
"graphql": "^16.6.0",
"koa": "^2.14.2",
"koa-bodyparser": "^4.4.0"
"@expo/entity": "^0.28.0",
"apollo-server-koa": "^2.16.1",
"graphql": "^15.3.0",
"koa": "^2.13.0",
"koa-body": "^4.2.0",
"koa-router": "^9.4.0"
},
"devDependencies": {
"@types/koa": "^2.13.6",
"@types/koa-bodyparser": "^4.3.10",
"@types/koa__cors": "^4.0.0",
"@types/koa__router": "^12.0.0",
"@types/koa": "^2.11.4",
"@types/koa-router": "^7.4.1",
"@types/supertest": "^2.0.10",
"supertest": "^4.0.2",
"ts-node-dev": "^1.0.0-pre.60"
@@ -2,11 +2,10 @@ import http from 'http';
import request from 'supertest';
import { v4 as uuidv4 } from 'uuid';
import createAppAsync from '../app';
import app from '../app';
describe('graphql', () => {
it('allows CRUD of user notes', async () => {
const app = await createAppAsync();
const server = request(http.createServer(app.callback()));
const userId = uuidv4();
@@ -118,7 +117,6 @@ describe('graphql', () => {
});
it('disallows anonymous note creation', async () => {
const app = await createAppAsync();
const server = request(http.createServer(app.callback()));
const createResponse1 = await server.post('/graphql').send({
query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
@@ -135,7 +133,6 @@ describe('graphql', () => {
});
it('disallows cross-user note impersonation', async () => {
const app = await createAppAsync();
const server = request(http.createServer(app.callback()));
const userId = uuidv4();
@@ -2,17 +2,15 @@ import http from 'http';
import request from 'supertest';
import { v4 as uuidv4 } from 'uuid';
import createAppAsync from '../app';
import app from '../app';
describe('notesRouter', () => {
it('returns empty array for logged-out', async () => {
const app = await createAppAsync();
const response = await request(http.createServer(app.callback())).get('/notes/').send();
expect(response.body.notes).toEqual([]);
});
it('allows CRUD of user notes', async () => {
const app = await createAppAsync();
const server = request(http.createServer(app.callback()));
const userId = uuidv4();
@@ -86,7 +84,6 @@ describe('notesRouter', () => {
});
it('disallows anonymous note creation', async () => {
const app = await createAppAsync();
const server = request(http.createServer(app.callback()));
const createResponse1 = await server.post('/notes/').send({
title: 'track',
@@ -97,7 +94,6 @@ describe('notesRouter', () => {
});
it('disallows cross-user note impersonation', async () => {
const app = await createAppAsync();
const server = request(http.createServer(app.callback()));
const userId = uuidv4();
const userId2 = uuidv4();
@@ -1,13 +1,13 @@
import { EntityQueryContextProvider, TransactionConfig } from '@expo/entity';
import { EntityQueryContextProvider } from '@expo/entity';
export default class InMemoryQueryContextProvider extends EntityQueryContextProvider {
protected getQueryInterface(): any {
return {};
}
protected createTransactionRunner<T>(
_transactionConfig?: TransactionConfig
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
protected createTransactionRunner<T>(): (
transactionScope: (queryInterface: any) => Promise<T>
) => Promise<T> {
return (transactionScope) => Promise.resolve(transactionScope({}));
}
+26 -37
View File
@@ -1,17 +1,15 @@
import { ApolloServer } from '@apollo/server';
import { koaMiddleware } from '@as-integrations/koa';
import { EntityCompanionProvider } from '@expo/entity';
import cors from '@koa/cors';
import Router from '@koa/router';
import { ApolloServer } from 'apollo-server-koa';
import Koa from 'koa';
import bodyParser from 'koa-bodyparser';
import koaBody from 'koa-body';
import KoaRouter, { RouterContext } from 'koa-router';
import { entityCompanionMiddleware, viewerContextMiddleware } from './middleware';
import notesRouter from './routers/notesRouter';
import { typeDefs, resolvers } from './schema';
import { ExampleViewerContext } from './viewerContexts';
export type ExampleContext = Koa.ParameterizedContext<ExampleState>;
export type ExampleContext = RouterContext<ExampleState>;
/**
* Koa provides a per-request state container to place custom properties.
@@ -23,40 +21,31 @@ export type ExampleState = {
entityCompanionProvider: EntityCompanionProvider; // entityCompanionMiddleware
};
export default async function createAppAsync(): Promise<Koa<ExampleState, ExampleContext>> {
const app = new Koa<ExampleState, ExampleContext>();
const app = new Koa();
// initialze the entity framework for each request
app.use(entityCompanionMiddleware);
// body parsing for POST/PUT requests
app.use(koaBody());
// generate a viewer context for each request
app.use(viewerContextMiddleware);
// initialze the entity framework for each request
app.use(entityCompanionMiddleware);
app.use(cors());
// generate a viewer context for each request
app.use(viewerContextMiddleware);
// body parsing for POST/PUT requests
app.use(bodyParser());
// serve routes that make use of the viewer context
const router = new KoaRouter<ExampleState>();
router.use(notesRouter.routes());
app.use(router.routes()).use(router.allowedMethods());
// serve routes that make use of the viewer context
const router = new Router<ExampleState, ExampleContext>();
const server = new ApolloServer({
typeDefs,
resolvers,
context: ({ ctx }) => {
return {
viewerContext: ctx.state.viewerContext,
};
},
});
app.use(server.getMiddleware({ cors: false, disableHealthCheck: true, bodyParserConfig: false }));
// normal API routes
router.use(notesRouter.routes());
// GraphQL routes
const server = new ApolloServer({
typeDefs,
resolvers,
});
await server.start();
router.post(
'/graphql',
koaMiddleware(server, {
context: async ({ ctx }) => ({ viewerContext: (ctx as ExampleContext).state.viewerContext }),
})
);
app.use(router.routes()).use(router.allowedMethods());
return app;
}
export default app;
@@ -1,10 +1,9 @@
import {
PrivacyPolicyRule,
ReadonlyEntity,
EntityQueryContext,
RuleEvaluationResult,
EntityPrivacyPolicyEvaluationContext,
RuleComplexity,
AllowOrSkipPrivacyPolicyRule,
} from '@expo/entity';
import { ExampleViewerContext } from '../viewerContexts';
@@ -24,23 +23,21 @@ import { ExampleViewerContext } from '../viewerContexts';
* Otherwise, it defers to the next rule in the policy.
*/
export default class AllowIfUserOwnerPrivacyRule<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>,
TSelectedFields extends keyof TFields = keyof TFields
> extends AllowOrSkipPrivacyPolicyRule<TFields, TID, ExampleViewerContext, TEntity> {
> extends PrivacyPolicyRule<TFields, TID, ExampleViewerContext, TEntity> {
constructor(private readonly entityOwnerField: keyof TFields) {
super();
}
override complexity = RuleComplexity.LOW;
async evaluateAsync(
viewerContext: ExampleViewerContext,
_queryContext: EntityQueryContext,
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
entity: TEntity
): Promise<RuleEvaluationResult.ALLOW | RuleEvaluationResult.SKIP> {
): Promise<RuleEvaluationResult> {
if (viewerContext.isUserViewerContext()) {
if (String(entity.getField(this.entityOwnerField)) === viewerContext.userID) {
return RuleEvaluationResult.ALLOW;
@@ -6,8 +6,8 @@ import {
StringField,
} from '@expo/entity';
import NotePrivacyPolicy from './NotePrivacyPolicy';
import { ExampleViewerContext } from '../viewerContexts';
import NotePrivacyPolicy from './NotePrivacyPolicy';
export interface NoteFields {
id: string;
@@ -20,41 +20,43 @@ export interface NoteFields {
* A simple entity representing a "notes" table/collection. Each note has an owner, title, and body.
*/
export default class NoteEntity extends Entity<NoteFields, string, ExampleViewerContext> {
/**
* The companion provides configuration instructions to the Entity framework for this type
* of entity. In some languages, this would be representable as "abstract" static members
* of the class itself, but TypeScript disallows static generic and abstract methods.
*/
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
NoteFields,
string,
ExampleViewerContext,
NoteEntity,
NotePrivacyPolicy
> {
return {
entityClass: NoteEntity,
entityConfiguration: new EntityConfiguration<NoteFields>({
idField: 'id',
tableName: 'notes',
schema: {
id: new UUIDField({
columnName: 'id',
}),
userID: new UUIDField({
columnName: 'user_id',
}),
title: new StringField({
columnName: 'title',
}),
body: new StringField({
columnName: 'body',
}),
},
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
}),
privacyPolicyClass: NotePrivacyPolicy,
};
return noteEntityCompanion;
}
}
/**
* The companion provides configuration instructions to the Entity framework for this type
* of entity. In some languages, this would be representable as "abstract" static members
* of the class itself, but TypeScript disallows static generic and abstract methods.
*/
export const noteEntityCompanion = new EntityCompanionDefinition({
entityClass: NoteEntity,
entityConfiguration: new EntityConfiguration<NoteFields>({
idField: 'id',
tableName: 'notes',
schema: {
id: new UUIDField({
columnName: 'id',
}),
userID: new UUIDField({
columnName: 'user_id',
}),
title: new StringField({
columnName: 'title',
}),
body: new StringField({
columnName: 'body',
}),
},
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
}),
privacyPolicyClass: NotePrivacyPolicy,
});
@@ -1,8 +1,8 @@
import { EntityPrivacyPolicy, AlwaysAllowPrivacyPolicyRule } from '@expo/entity';
import { ExampleViewerContext } from '../viewerContexts';
import AllowIfUserOwnerPrivacyRule from './AllowIfUserOwnerPrivacyRule';
import NoteEntity, { NoteFields } from './NoteEntity';
import { ExampleViewerContext } from '../viewerContexts';
/**
* For purposes of this demonstration, notes are considered public and can only be mutated by the owner.
+2 -7
View File
@@ -1,8 +1,3 @@
import createAppAsync from './app';
import app from './app';
async function main(): Promise<void> {
const app = await createAppAsync();
app.listen(3000);
}
main();
app.listen(3000);
@@ -1,4 +1,4 @@
import Router from '@koa/router';
import KoaRouter from 'koa-router';
import { ExampleState, ExampleContext } from '../app';
import NoteEntity from '../entities/NoteEntity';
@@ -11,11 +11,11 @@ import NoteEntity from '../entities/NoteEntity';
* PUT /notes/:id - update a note
* DELETE /notes/:id - delete a note
*/
const router = new Router<ExampleState, ExampleContext>({
const router = new KoaRouter<ExampleState>({
prefix: '/notes',
});
router.get('/', async (ctx) => {
router.get('/', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext;
let notes: readonly NoteEntity[] = [];
if (viewerContext.isUserViewerContext()) {
@@ -28,12 +28,11 @@ router.get('/', async (ctx) => {
};
});
router.get('/:id', async (ctx) => {
router.get('/:id', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext;
const noteResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
if (!noteResult.ok) {
ctx.throw(403, noteResult.reason);
return;
}
ctx.body = {
@@ -41,17 +40,16 @@ router.get('/:id', async (ctx) => {
};
});
router.post('/', async (ctx) => {
router.post('/', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext;
if (!viewerContext.isUserViewerContext()) {
// Only logged-in users can create notes. Technically this
// would be handled by the privacy policy (it would fail)
// but we throw here for better type safety.
ctx.throw(403);
return;
}
const { title, body } = ctx.request.body as any;
const { title, body } = ctx.request.body;
const createResult = await NoteEntity.creator(viewerContext)
.setField('userID', viewerContext.userID)
@@ -60,7 +58,6 @@ router.post('/', async (ctx) => {
.createAsync();
if (!createResult.ok) {
ctx.throw(403, createResult.reason);
return;
}
ctx.body = {
@@ -68,14 +65,13 @@ router.post('/', async (ctx) => {
};
});
router.put('/:id', async (ctx) => {
router.put('/:id', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext;
const { title, body } = ctx.request.body as any;
const { title, body } = ctx.request.body;
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
if (!noteLoadResult.ok) {
ctx.throw(403, noteLoadResult.reason);
return;
}
const noteUpdateResult = await NoteEntity.updater(noteLoadResult.value)
@@ -84,7 +80,6 @@ router.put('/:id', async (ctx) => {
.updateAsync();
if (!noteUpdateResult.ok) {
ctx.throw(403, noteUpdateResult.reason);
return;
}
ctx.body = {
@@ -92,19 +87,17 @@ router.put('/:id', async (ctx) => {
};
});
router.delete('/:id', async (ctx) => {
router.delete('/:id', async (ctx: ExampleContext) => {
const viewerContext = ctx.state.viewerContext;
const noteLoadResult = await NoteEntity.loader(viewerContext).loadByIDAsync(ctx.params['id']!);
if (!noteLoadResult.ok) {
ctx.throw(403, noteLoadResult.reason);
return;
}
const noteDeleteResult = await NoteEntity.deleteAsync(noteLoadResult.value);
if (!noteDeleteResult.ok) {
ctx.throw(403, noteDeleteResult.reason);
return;
}
ctx.body = {
+6 -6
View File
@@ -1,4 +1,4 @@
import { IResolvers, IObjectTypeResolver } from '@graphql-tools/utils';
import { gql, IResolvers, IResolverObject } from 'apollo-server-koa';
import NoteEntity from './entities/NoteEntity';
import { ExampleViewerContext } from './viewerContexts';
@@ -7,7 +7,7 @@ type GraphqlContext = {
viewerContext: ExampleViewerContext;
};
export const typeDefs = `#graphql
export const typeDefs = gql`
type User {
id: ID!
notes: [Note]!
@@ -48,7 +48,7 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
async noteByID(_root, args, { viewerContext }) {
return await NoteEntity.loader(viewerContext).enforcing().loadByIDAsync(args.id);
},
} as IObjectTypeResolver<any, GraphqlContext>,
} as IResolverObject<any, GraphqlContext>,
User: {
id: (root) => root,
@@ -57,14 +57,14 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
.enforcing()
.loadManyByFieldEqualingAsync('userID', root);
},
} as IObjectTypeResolver<string, GraphqlContext>,
} as IResolverObject<string, GraphqlContext>,
Note: {
id: (root) => root.getID(),
title: (root) => root.getField('title'),
body: (root) => root.getField('body'),
user: (root) => root.getField('userID'),
} as IObjectTypeResolver<NoteEntity, GraphqlContext>,
} as IResolverObject<NoteEntity, GraphqlContext>,
Mutation: {
async addNote(_root, args, { viewerContext }) {
@@ -94,5 +94,5 @@ export const resolvers: IResolvers<any, GraphqlContext> = {
await NoteEntity.enforceDeleteAsync(existingNote);
return existingNote;
},
} as IObjectTypeResolver<any, GraphqlContext>,
} as IResolverObject<any, GraphqlContext>,
};
@@ -3,79 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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
@@ -1,7 +1,7 @@
{
"name": "@expo/entity-full-integration-tests",
"private": true,
"version": "0.35.0",
"version": "0.28.0",
"description": "Full redis and knex integration tests for the entity framework",
"scripts": {
"tsc": "tsc",
@@ -14,7 +14,7 @@
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -27,8 +27,8 @@
"@expo/entity-database-adapter-knex": "*"
},
"devDependencies": {
"@expo/entity": "^0.35.0",
"@expo/entity-cache-adapter-redis": "^0.35.0",
"@expo/entity-database-adapter-knex": "^0.35.0"
"@expo/entity": "^0.28.0",
"@expo/entity-cache-adapter-redis": "^0.28.0",
"@expo/entity-database-adapter-knex": "^0.28.0"
}
}
@@ -8,7 +8,7 @@ import {
UUIDField,
StringField,
} from '@expo/entity';
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
import Redis from 'ioredis';
import { knex, Knex } from 'knex';
import nullthrows from 'nullthrows';
@@ -43,18 +43,14 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
}
class TestEntity extends Entity<TestFields, string, ViewerContext> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
TestFields,
string,
ViewerContext,
TestEntity,
TestEntityPrivacyPolicy
> {
return {
entityClass: TestEntity,
entityConfiguration: testEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
};
return testEntityCompanion;
}
}
@@ -78,6 +74,12 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
cacheAdapterFlavor: 'redis',
});
const testEntityCompanion = new EntityCompanionDefinition({
entityClass: TestEntity,
entityConfiguration: testEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
await knex.schema.createTable('testentities', (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
@@ -95,8 +97,7 @@ async function dropPostgresTable(knex: Knex): Promise<void> {
describe('Entity cache inconsistency', () => {
let knexInstance: Knex;
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let genericRedisCacheContext: GenericRedisCacheContext;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
knexInstance = knex({
@@ -109,8 +110,8 @@ describe('Entity cache inconsistency', () => {
database: nullthrows(process.env['PGDATABASE']),
},
});
genericRedisCacheContext = {
redisClient,
redisCacheAdapterContext = {
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
const escapedParts = parts.map((part) =>
@@ -119,6 +120,7 @@ describe('Entity cache inconsistency', () => {
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
@@ -126,18 +128,18 @@ describe('Entity cache inconsistency', () => {
beforeEach(async () => {
await createOrTruncatePostgresTables(knexInstance);
await redisClient.flushdb();
await redisCacheAdapterContext.redisClient.flushdb();
});
afterAll(async () => {
await dropPostgresTable(knexInstance);
await knexInstance.destroy();
redisClient.disconnect();
redisCacheAdapterContext.redisClient.disconnect();
});
test('lots of updates in long-ish running transactions', async () => {
const viewerContext = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
const entity1 = await TestEntity.creator(viewerContext)
@@ -170,7 +172,7 @@ describe('Entity cache inconsistency', () => {
await barrier1;
const viewerContextInternal = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
await TestEntity.loader(viewerContextInternal).enforcing().loadByIDAsync(entity1.getID());
@@ -193,7 +195,7 @@ describe('Entity cache inconsistency', () => {
// ensure cache consistency
const viewerContextLast = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
const loadedById = await TestEntity.loader(viewerContextLast)
@@ -1,13 +1,13 @@
import { ViewerContext } from '@expo/entity';
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
import Redis from 'ioredis';
import { knex, Knex } from 'knex';
import nullthrows from 'nullthrows';
import { URL } from 'url';
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
import ChildEntity from './entities/ChildEntity';
import ParentEntity from './entities/ParentEntity';
import { createFullIntegrationTestEntityCompanionProvider } from '../testfixtures/createFullIntegrationTestEntityCompanionProvider';
async function createOrTruncatePostgresTables(knex: Knex): Promise<void> {
await knex.schema.createTable('parents', (table) => {
@@ -33,8 +33,7 @@ async function dropPostgresTable(knex: Knex): Promise<void> {
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
let knexInstance: Knex;
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let genericRedisCacheContext: GenericRedisCacheContext;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
knexInstance = knex({
@@ -47,8 +46,8 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
database: nullthrows(process.env['PGDATABASE']),
},
});
genericRedisCacheContext = {
redisClient,
redisCacheAdapterContext = {
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
const escapedParts = parts.map((part) =>
@@ -57,6 +56,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
@@ -64,19 +64,19 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
beforeEach(async () => {
await createOrTruncatePostgresTables(knexInstance);
await redisClient.flushdb();
await redisCacheAdapterContext.redisClient.flushdb();
});
afterAll(async () => {
await dropPostgresTable(knexInstance);
await knexInstance.destroy();
redisClient.disconnect();
redisCacheAdapterContext.redisClient.disconnect();
});
describe('EntityEdgeDeletionBehavior.INVALIDATE_CACHE', () => {
it('invalidates the cache', async () => {
const viewerContext = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
const parent = await ParentEntity.creator(viewerContext).enforceCreateAsync();
@@ -8,7 +8,7 @@ import {
UUIDField,
EntityEdgeDeletionBehavior,
} from '@expo/entity';
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
import Redis from 'ioredis';
import { knex, Knex } from 'knex';
import nullthrows from 'nullthrows';
@@ -48,41 +48,33 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
const othersTableName = uuidv4();
class CategoryEntity extends Entity<CategoryFields, string, ViewerContext> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
CategoryFields,
string,
ViewerContext,
CategoryEntity,
PrivacyPolicy
> {
return {
entityClass: CategoryEntity,
entityConfiguration: categoryEntityConfiguration,
privacyPolicyClass: PrivacyPolicy,
};
return categoryEntityCompanion;
}
}
class OtherEntity extends Entity<OtherFields, string, ViewerContext> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
OtherFields,
string,
ViewerContext,
OtherEntity,
PrivacyPolicy
> {
return {
entityClass: OtherEntity,
entityConfiguration: otherEntityConfiguration,
privacyPolicyClass: PrivacyPolicy,
};
return otherEntityCompanion;
}
}
const categoryEntityConfiguration = new EntityConfiguration<CategoryFields>({
idField: 'id',
tableName: categoriesTableName,
inboundEdges: [OtherEntity],
getInboundEdges: () => [OtherEntity],
schema: {
id: new UUIDField({
columnName: 'id',
@@ -92,7 +84,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
columnName: 'parent_other_id',
cache: true,
association: {
associatedEntityClass: OtherEntity,
getAssociatedEntityClass: () => OtherEntity,
edgeDeletionBehavior,
},
}),
@@ -101,10 +93,16 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
cacheAdapterFlavor: 'redis',
});
const categoryEntityCompanion = new EntityCompanionDefinition({
entityClass: CategoryEntity,
entityConfiguration: categoryEntityConfiguration,
privacyPolicyClass: PrivacyPolicy,
});
const otherEntityConfiguration = new EntityConfiguration<OtherFields>({
idField: 'id',
tableName: othersTableName,
inboundEdges: [CategoryEntity],
getInboundEdges: () => [CategoryEntity],
schema: {
id: new UUIDField({
columnName: 'id',
@@ -114,7 +112,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
columnName: 'parent_category_id',
cache: true,
association: {
associatedEntityClass: CategoryEntity,
getAssociatedEntityClass: () => CategoryEntity,
edgeDeletionBehavior,
},
}),
@@ -123,6 +121,12 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
cacheAdapterFlavor: 'redis',
});
const otherEntityCompanion = new EntityCompanionDefinition({
entityClass: OtherEntity,
entityConfiguration: otherEntityConfiguration,
privacyPolicyClass: PrivacyPolicy,
});
await knex.schema.createTable(categoriesTableName, (table) => {
table.uuid('id').defaultTo(knex.raw('gen_random_uuid()')).primary();
});
@@ -172,8 +176,7 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
};
describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
let knexInstance: Knex;
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let genericRedisCacheContext: GenericRedisCacheContext;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
knexInstance = knex({
@@ -186,8 +189,8 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
database: nullthrows(process.env['PGDATABASE']),
},
});
genericRedisCacheContext = {
redisClient,
redisCacheAdapterContext = {
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(...parts: string[]): string {
const delimiter = ':';
const escapedParts = parts.map((part) =>
@@ -196,6 +199,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
return escapedParts.join(delimiter);
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
@@ -203,7 +207,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
afterAll(async () => {
await knexInstance.destroy();
redisClient.disconnect();
redisCacheAdapterContext.redisClient.disconnect();
});
it.each([
@@ -218,7 +222,7 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
);
const viewerContext = new ViewerContext(
createFullIntegrationTestEntityCompanionProvider(knexInstance, genericRedisCacheContext)
createFullIntegrationTestEntityCompanionProvider(knexInstance, redisCacheAdapterContext)
);
const category1 = await CategoryEntity.creator(viewerContext).enforceCreateAsync();
@@ -32,36 +32,40 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerCon
}
export default class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
ChildFields,
string,
ViewerContext,
ChildEntity,
TestEntityPrivacyPolicy
> {
return {
entityClass: ChildEntity,
entityConfiguration: new EntityConfiguration<ChildFields>({
idField: 'id',
tableName: 'children',
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
parent_id: new UUIDField({
columnName: 'parent_id',
cache: true,
association: {
associatedEntityClass: ParentEntity,
edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
},
}),
},
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
}),
privacyPolicyClass: TestEntityPrivacyPolicy,
};
return childEntityCompanion;
}
}
const childEntityConfiguration = new EntityConfiguration<ChildFields>({
idField: 'id',
tableName: 'children',
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
parent_id: new UUIDField({
columnName: 'parent_id',
cache: true,
association: {
getAssociatedEntityClass: () => ParentEntity,
edgeDeletionBehavior: EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE_ONLY,
},
}),
},
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const childEntityCompanion = new EntityCompanionDefinition({
entityClass: ChildEntity,
entityConfiguration: childEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
@@ -30,29 +30,33 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerCon
}
export default class ParentEntity extends Entity<ParentFields, string, ViewerContext> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
ParentFields,
string,
ViewerContext,
ParentEntity,
TestEntityPrivacyPolicy
> {
return {
entityClass: ParentEntity,
entityConfiguration: new EntityConfiguration<ParentFields>({
idField: 'id',
tableName: 'parents',
inboundEdges: [ChildEntity],
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
},
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
}),
privacyPolicyClass: TestEntityPrivacyPolicy,
};
return parentEntityCompanion;
}
}
const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
idField: 'id',
tableName: 'parents',
getInboundEdges: () => [ChildEntity],
schema: {
id: new UUIDField({
columnName: 'id',
cache: true,
}),
},
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const parentEntityCompanion = new EntityCompanionDefinition({
entityClass: ParentEntity,
entityConfiguration: parentEntityConfiguration,
privacyPolicyClass: TestEntityPrivacyPolicy,
});
@@ -4,7 +4,7 @@ import {
EntityCompanionProvider,
} from '@expo/entity';
import {
GenericRedisCacheContext,
RedisCacheAdapterContext,
RedisCacheAdapterProvider,
} from '@expo/entity-cache-adapter-redis';
import {
@@ -15,7 +15,7 @@ import { Knex } from 'knex';
export const createFullIntegrationTestEntityCompanionProvider = (
knex: Knex,
genericRedisCacheContext: GenericRedisCacheContext,
redisCacheAdapterContext: RedisCacheAdapterContext,
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => {
return new EntityCompanionProvider(
@@ -33,7 +33,7 @@ export const createFullIntegrationTestEntityCompanionProvider = (
[
'redis',
{
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
},
],
])
@@ -3,62 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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
@@ -1,6 +1,6 @@
{
"name": "@expo/entity-ip-address-field",
"version": "0.35.0",
"version": "0.28.0",
"description": "IP address EntityField definitions for @expo/entity",
"files": [
"build",
@@ -17,7 +17,7 @@
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --delete"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -28,7 +28,7 @@
"ip-address": "^8.1.0"
},
"devDependencies": {
"@expo/entity": "^0.35.0",
"@expo/entity": "^0.28.0",
"@types/jsbn": "^1.2.29"
},
"peerDependencies": {
@@ -3,71 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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
@@ -1,6 +1,6 @@
{
"name": "@expo/entity-secondary-cache-local-memory",
"version": "0.35.0",
"version": "0.28.0",
"description": "Local memory secondary cache for @expo/entity",
"files": [
"build",
@@ -19,7 +19,7 @@
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -31,8 +31,8 @@
"@expo/entity-cache-adapter-local-memory": "*"
},
"devDependencies": {
"@expo/entity": "^0.35.0",
"@expo/entity-cache-adapter-local-memory": "^0.35.0",
"@expo/entity": "^0.28.0",
"@expo/entity-cache-adapter-local-memory": "^0.28.0",
"nullthrows": "^1.1.1"
}
}
@@ -33,18 +33,14 @@ export default class LocalMemoryTestEntity extends Entity<
string,
ViewerContext
> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
LocalMemoryTestEntityFields,
string,
ViewerContext,
LocalMemoryTestEntity,
LocalMemoryTestEntityPrivacyPolicy
> {
return {
entityClass: LocalMemoryTestEntity,
entityConfiguration: localMemoryTestEntityConfiguration,
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
};
return localMemoryTestEntityCompanionDefinition;
}
}
@@ -104,6 +100,12 @@ export const localMemoryTestEntityConfiguration =
cacheAdapterFlavor: 'local-memory',
});
const localMemoryTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: LocalMemoryTestEntity,
entityConfiguration: localMemoryTestEntityConfiguration,
privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
});
export const createTestEntityCompanionProvider = (
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => {
@@ -122,7 +124,7 @@ export const createTestEntityCompanionProvider = (
[
'local-memory',
{
cacheAdapterProvider: LocalMemoryCacheAdapterProvider.createProviderWithOptions(),
cacheAdapterProvider: LocalMemoryCacheAdapterProvider.getProvider(),
},
],
])
@@ -3,79 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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
@@ -12,7 +12,7 @@
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
new RedisSecondaryEntityCache(
redisTestEntityConfiguration,
genericRedisCacheContext,
redisCacheAdapterContext,
(loadParams) => `${loadParams.id}`
),
RedisTestEntity.loader(viewerContext)
@@ -1,6 +1,6 @@
{
"name": "@expo/entity-secondary-cache-redis",
"version": "0.35.0",
"version": "0.28.0",
"description": "Redis secondary cache for @expo/entity",
"files": [
"build",
@@ -19,7 +19,7 @@
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -31,9 +31,9 @@
"@expo/entity-cache-adapter-redis": "*"
},
"devDependencies": {
"@expo/entity": "^0.35.0",
"@expo/entity-cache-adapter-redis": "^0.35.0",
"ioredis": "^5.2.5",
"@expo/entity": "^0.28.0",
"@expo/entity-cache-adapter-redis": "^0.28.0",
"ioredis": "^5.0.4",
"nullthrows": "^1.1.1"
}
}
@@ -1,5 +1,5 @@
import { EntityConfiguration, GenericSecondaryEntityCache } from '@expo/entity';
import { GenericRedisCacheContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
import { RedisCacheAdapterContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
/**
* A redis GenericSecondaryEntityCache.
@@ -10,7 +10,7 @@ export default class RedisSecondaryEntityCache<
> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
constructor(
entityConfiguration: EntityConfiguration<TFields>,
genericRedisCacheContext: GenericRedisCacheContext,
genericRedisCacheContext: RedisCacheAdapterContext,
constructRedisKey: (params: Readonly<TLoadParams>) => string
) {
super(new GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
@@ -1,5 +1,5 @@
import { EntitySecondaryCacheLoader, mapMapAsync, ViewerContext } from '@expo/entity';
import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
import Redis from 'ioredis';
import nullthrows from 'nullthrows';
import { URL } from 'url';
@@ -52,31 +52,31 @@ class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
}
describe(RedisSecondaryEntityCache, () => {
const redisClient = new Redis(new URL(process.env['REDIS_URL']!).toString());
let genericRedisCacheContext: GenericRedisCacheContext;
let redisCacheAdapterContext: RedisCacheAdapterContext;
beforeAll(() => {
genericRedisCacheContext = {
redisClient,
redisCacheAdapterContext = {
redisClient: new Redis(new URL(process.env['REDIS_URL']!).toString()),
makeKeyFn(..._parts: string[]): string {
throw new Error('should not be used by this test');
},
cacheKeyPrefix: 'test-',
cacheKeyVersion: 1,
ttlSecondsPositive: 86400, // 1 day
ttlSecondsNegative: 600, // 10 minutes
};
});
beforeEach(async () => {
await redisClient.flushdb();
await redisCacheAdapterContext.redisClient.flushdb();
});
afterAll(async () => {
redisClient.disconnect();
redisCacheAdapterContext.redisClient.disconnect();
});
it('Loads through secondary loader, caches, and invalidates', async () => {
const viewerContext = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const createdEntity = await RedisTestEntity.creator(viewerContext)
@@ -86,7 +86,7 @@ describe(RedisSecondaryEntityCache, () => {
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
new RedisSecondaryEntityCache(
redisTestEntityConfiguration,
genericRedisCacheContext,
redisCacheAdapterContext,
(loadParams) => `test-key-${loadParams.id}`
),
RedisTestEntity.loader(viewerContext)
@@ -119,13 +119,13 @@ describe(RedisSecondaryEntityCache, () => {
it('correctly handles uncached and unfetchable load params', async () => {
const viewerContext = new TestViewerContext(
createRedisIntegrationTestEntityCompanionProvider(genericRedisCacheContext)
createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
);
const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
new RedisSecondaryEntityCache(
redisTestEntityConfiguration,
genericRedisCacheContext,
redisCacheAdapterContext,
(loadParams) => `test-key-${loadParams.id}`
),
RedisTestEntity.loader(viewerContext)
@@ -15,18 +15,14 @@ export type RedisTestEntityFields = {
};
export default class RedisTestEntity extends Entity<RedisTestEntityFields, string, ViewerContext> {
static defineCompanionDefinition(): EntityCompanionDefinition<
static getCompanionDefinition(): EntityCompanionDefinition<
RedisTestEntityFields,
string,
ViewerContext,
RedisTestEntity,
RedisTestEntityPrivacyPolicy
> {
return {
entityClass: RedisTestEntity,
entityConfiguration: redisTestEntityConfiguration,
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
};
return redisTestEntityCompanionDefinition;
}
}
@@ -84,3 +80,9 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
databaseAdapterFlavor: 'postgres',
cacheAdapterFlavor: 'redis',
});
const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({
entityClass: RedisTestEntity,
entityConfiguration: redisTestEntityConfiguration,
privacyPolicyClass: RedisTestEntityPrivacyPolicy,
});
@@ -6,12 +6,12 @@ import {
StubDatabaseAdapterProvider,
} from '@expo/entity';
import {
GenericRedisCacheContext,
RedisCacheAdapterContext,
RedisCacheAdapterProvider,
} from '@expo/entity-cache-adapter-redis';
export const createRedisIntegrationTestEntityCompanionProvider = (
genericRedisCacheContext: GenericRedisCacheContext,
redisCacheAdapterContext: RedisCacheAdapterContext,
metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
): EntityCompanionProvider => {
return new EntityCompanionProvider(
@@ -29,7 +29,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
[
'redis',
{
cacheAdapterProvider: new RedisCacheAdapterProvider(genericRedisCacheContext),
cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
},
],
])
-70
View File
@@ -3,76 +3,6 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [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)
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/entity",
"version": "0.35.0",
"version": "0.28.0",
"description": "A privacy-first data model",
"files": [
"build",
@@ -19,7 +19,7 @@
"barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"
},
"engines": {
"node": ">=16"
"node": ">=12"
},
"keywords": [
"entity"
@@ -4,7 +4,7 @@ import IEntityCacheAdapter from './IEntityCacheAdapter';
import { CacheStatus, CacheLoadResult } from './internal/ReadThroughEntityCache';
/**
* A IEntityCacheAdapter that composes other IEntityCacheAdapter instances.
* An IEntityCacheAdapter that composes other IEntityCacheAdapter instances.
*/
export default class ComposedEntityCacheAdapter<TFields> implements IEntityCacheAdapter<TFields> {
/**
+1 -26
View File
@@ -14,7 +14,7 @@ import { mapMap } from './utils/collections/maps';
* if the loads are not successful.
*/
export default class EnforcingEntityLoader<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -114,31 +114,6 @@ export default class EnforcingEntityLoader<
return mapMap(entityResults, (result) => result.enforceValue());
}
/**
* Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
*/
async loadManyByIDsNullableAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, TEntity | null>> {
const entityResults = await this.entityLoader.loadManyByIDsNullableAsync(ids);
return mapMap(entityResults, (result) => result?.enforceValue() ?? null);
}
/**
* Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
*/
async loadFirstByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
querySelectionModifiers: Omit<QuerySelectionModifiers<TFields>, 'limit'> &
Required<Pick<QuerySelectionModifiers<TFields>, 'orderBy'>>
): Promise<TEntity | null> {
const entityResult = await this.entityLoader.loadFirstByFieldEqualityConjunctionAsync(
fieldEqualityOperands,
querySelectionModifiers
);
return entityResult ? entityResult.enforceValue() : null;
}
/**
* Enforcing version of entity loader method by the same name.
* @throws EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
+12 -23
View File
@@ -26,7 +26,7 @@ import ViewerContext from './ViewerContext';
* own EntityCompanionDefinition.
*/
export default abstract class Entity<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TSelectedFields extends keyof TFields = keyof TFields
@@ -38,7 +38,7 @@ export default abstract class Entity<
* @returns mutator for creating an entity
*/
static creator<
TMFields extends object,
TMFields,
TMID extends NonNullable<TMFields[TMSelectedFields]>,
TMViewerContext extends ViewerContext,
TMViewerContext2 extends TMViewerContext,
@@ -79,7 +79,7 @@ export default abstract class Entity<
* @returns mutator for updating existingEntity
*/
static updater<
TMFields extends object,
TMFields,
TMID extends NonNullable<TMFields[TMSelectedFields]>,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -120,7 +120,7 @@ export default abstract class Entity<
* @param queryContext - query context in which to perform the delete
*/
static deleteAsync<
TMFields extends object,
TMFields,
TMID extends NonNullable<TMFields[TMSelectedFields]>,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -162,7 +162,7 @@ export default abstract class Entity<
* @param queryContext - query context in which to perform the delete
*/
static enforceDeleteAsync<
TMFields extends object,
TMFields,
TMID extends NonNullable<TMFields[TMSelectedFields]>,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -215,7 +215,7 @@ export default abstract class Entity<
* @param queryContext - query context in which to perform the check
*/
static async canViewerUpdateAsync<
TMFields extends object,
TMFields,
TMID extends NonNullable<TMFields[TMSelectedFields]>,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -246,7 +246,7 @@ export default abstract class Entity<
const companion = existingEntity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(this);
const privacyPolicy = companion.entityCompanion.privacyPolicy;
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
const evaluationResult = await asyncResult(
privacyPolicy.authorizeUpdateAsync(
existingEntity.getViewerContext(),
@@ -269,7 +269,7 @@ export default abstract class Entity<
* @param queryContext - query context in which to perform the check
*/
static async canViewerDeleteAsync<
TMFields extends object,
TMFields,
TMID extends NonNullable<TMFields[TMSelectedFields]>,
TMViewerContext extends ViewerContext,
TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -300,7 +300,7 @@ export default abstract class Entity<
const companion = existingEntity
.getViewerContext()
.getViewerScopedEntityCompanionForClass(this);
const privacyPolicy = companion.entityCompanion.privacyPolicy;
const privacyPolicy = new (this.getCompanionDefinition().privacyPolicyClass)();
const evaluationResult = await asyncResult(
privacyPolicy.authorizeDeleteAsync(
existingEntity.getViewerContext(),
@@ -318,7 +318,7 @@ export default abstract class Entity<
* An interface to pass in constructor (class) of an Entity as a function argument.
*/
export interface IEntityClass<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -331,19 +331,8 @@ export interface IEntityClass<
>,
TSelectedFields extends keyof TFields = keyof TFields
> {
new (constructorParam: {
viewerContext: TViewerContext;
id: TID;
databaseFields: Readonly<TFields>;
selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
}): TEntity;
/**
* Returns a EntityCompanionDefinition for this entity.
*
* Memoized by the entity framework.
*/
defineCompanionDefinition(): EntityCompanionDefinition<
new (viewerContext: TViewerContext, obj: Readonly<TFields>): TEntity;
getCompanionDefinition(): EntityCompanionDefinition<
TFields,
TID,
TViewerContext,
+12 -12
View File
@@ -12,7 +12,7 @@ import ViewerContext from './ViewerContext';
* by foreign keys.
*/
export default class EntityAssociationLoader<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -29,7 +29,7 @@ export default class EntityAssociationLoader<
*/
async loadAssociatedEntityAsync<
TIdentifyingField extends keyof Pick<TFields, TSelectedFields>,
TAssociatedFields extends object,
TAssociatedFields,
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
@@ -91,7 +91,7 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the load
*/
async loadManyAssociatedEntitiesAsync<
TAssociatedFields extends object,
TAssociatedFields,
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
@@ -144,7 +144,7 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the load
*/
async loadAssociatedEntityByFieldEqualingAsync<
TAssociatedFields extends object,
TAssociatedFields,
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
@@ -201,7 +201,7 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the load
*/
async loadManyAssociatedEntitiesByFieldEqualingAsync<
TAssociatedFields extends object,
TAssociatedFields,
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
@@ -257,7 +257,7 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the loads
*/
async loadAssociatedEntityThroughAsync<
TFields2 extends object,
TFields2,
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<
@@ -291,7 +291,7 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the loads
*/
async loadAssociatedEntityThroughAsync<
TFields2 extends object,
TFields2,
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<
@@ -301,7 +301,7 @@ export default class EntityAssociationLoader<
TEntity2,
TSelectedFields2
>,
TFields3 extends object,
TFields3,
TID3 extends NonNullable<TFields3[TSelectedFields3]>,
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
TPrivacyPolicy3 extends EntityPrivacyPolicy<
@@ -346,7 +346,7 @@ export default class EntityAssociationLoader<
* @param queryContext - query context in which to perform the loads
*/
async loadAssociatedEntityThroughAsync<
TFields2 extends object,
TFields2,
TID2 extends NonNullable<TFields2[TSelectedFields2]>,
TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
TPrivacyPolicy2 extends EntityPrivacyPolicy<
@@ -356,7 +356,7 @@ export default class EntityAssociationLoader<
TEntity2,
TSelectedFields2
>,
TFields3 extends object,
TFields3,
TID3 extends NonNullable<TFields3[TSelectedFields3]>,
TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
TPrivacyPolicy3 extends EntityPrivacyPolicy<
@@ -366,7 +366,7 @@ export default class EntityAssociationLoader<
TEntity3,
TSelectedFields3
>,
TFields4 extends object,
TFields4,
TID4 extends NonNullable<TFields4[TSelectedFields4]>,
TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext, TSelectedFields4>,
TPrivacyPolicy4 extends EntityPrivacyPolicy<
@@ -482,7 +482,7 @@ export default class EntityAssociationLoader<
export interface EntityLoadThroughDirective<
TViewerContext extends ViewerContext,
TFields,
TAssociatedFields extends object,
TAssociatedFields,
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
+33 -14
View File
@@ -1,5 +1,7 @@
import EntityCompanionProvider, { EntityCompanionDefinition } from './EntityCompanionProvider';
import { IEntityClass } from './Entity';
import EntityLoaderFactory from './EntityLoaderFactory';
import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
import EntityMutationValidator from './EntityMutationValidator';
import EntityMutatorFactory from './EntityMutatorFactory';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import EntityQueryContextProvider from './EntityQueryContextProvider';
@@ -16,7 +18,7 @@ export interface IPrivacyPolicyClass<TPrivacyPolicy> {
* Composition root responsible for orchestrating setup of Entity mutators and loaders.
*/
export default class EntityCompanion<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -29,8 +31,6 @@ export default class EntityCompanion<
>,
TSelectedFields extends keyof TFields
> {
public readonly privacyPolicy: TPrivacyPolicy;
private readonly entityLoaderFactory: EntityLoaderFactory<
TFields,
TID,
@@ -49,8 +49,7 @@ export default class EntityCompanion<
>;
constructor(
public readonly entityCompanionProvider: EntityCompanionProvider,
public readonly entityCompanionDefinition: EntityCompanionDefinition<
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
@@ -59,9 +58,24 @@ export default class EntityCompanion<
TSelectedFields
>,
private readonly tableDataCoordinator: EntityTableDataCoordinator<TFields>,
PrivacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>,
mutationValidators: EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[],
mutationTriggers: EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>,
private readonly metricsAdapter: IEntityMetricsAdapter
) {
this.privacyPolicy = new entityCompanionDefinition.privacyPolicyClass();
const privacyPolicy = new PrivacyPolicyClass();
this.entityLoaderFactory = new EntityLoaderFactory<
TFields,
TID,
@@ -69,14 +83,19 @@ export default class EntityCompanion<
TEntity,
TPrivacyPolicy,
TSelectedFields
>(this, tableDataCoordinator.dataManager, metricsAdapter);
this.entityMutatorFactory = new EntityMutatorFactory(
entityCompanionProvider,
>(
tableDataCoordinator.entityConfiguration,
entityCompanionDefinition.entityClass,
this.privacyPolicy,
entityCompanionDefinition.mutationValidators ?? [],
entityCompanionDefinition.mutationTriggers ?? {},
entityClass,
privacyPolicy,
tableDataCoordinator.dataManager,
metricsAdapter
);
this.entityMutatorFactory = new EntityMutatorFactory(
tableDataCoordinator.entityConfiguration,
entityClass,
privacyPolicy,
mutationValidators,
mutationTriggers,
this.entityLoaderFactory,
tableDataCoordinator.databaseAdapter,
metricsAdapter
+80 -41
View File
@@ -49,8 +49,8 @@ export interface CacheAdapterFlavorDefinition {
* Definition for constructing a companion for an entity. Defines the core set of objects
* used to power the entity framework for a particular type of entity.
*/
export interface EntityCompanionDefinition<
TFields extends object,
export class EntityCompanionDefinition<
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -63,9 +63,6 @@ export interface EntityCompanionDefinition<
>,
TSelectedFields extends keyof TFields = keyof TFields
> {
/**
* The concrete Entity class for which this is the definition.
*/
readonly entityClass: IEntityClass<
TFields,
TID,
@@ -74,45 +71,85 @@ export interface EntityCompanionDefinition<
TPrivacyPolicy,
TSelectedFields
>;
/**
* The EntityConfiguration for this entity.
*/
readonly entityConfiguration: EntityConfiguration<TFields>;
/**
* The EntityPrivacyPolicy class for this entity.
*/
readonly privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
/**
* An optional list of EntityMutationValidator for this entity.
*/
readonly mutationValidators?: EntityMutationValidator<
readonly mutationValidators: () => EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[];
/**
* An optional list of EntityMutationTrigger for this entity.
*/
readonly mutationTriggers?: EntityMutationTriggerConfiguration<
readonly mutationTriggers: () => EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>;
readonly entitySelectedFields: TSelectedFields[];
/**
* An optional subset of fields defined in the EntityConfiguration which belong to this entity.
* For use when multiple types of entities are backed by a single table (EntityConfiguration) yet
* only expose a subset of the fields.
*/
readonly entitySelectedFields?: TSelectedFields[];
constructor({
entityClass,
entityConfiguration,
privacyPolicyClass,
mutationValidators = () => [],
mutationTriggers = () => ({}),
entitySelectedFields = Array.from(entityConfiguration.schema.keys()) as TSelectedFields[],
}: {
/**
* The concrete Entity class for which this is the definition.
*/
entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>;
/**
* The EntityConfiguration for this entity.
*/
entityConfiguration: EntityConfiguration<TFields>;
/**
* The EntityPrivacyPolicy class for this entity.
*/
privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
/**
* An optional list of EntityMutationValidator for this entity.
*/
mutationValidators?: () => EntityMutationValidator<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[];
/**
* An optional list of EntityMutationTrigger for this entity.
*/
mutationTriggers?: () => EntityMutationTriggerConfiguration<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>;
/**
* An optional subset of fields defined in the EntityConfiguration which belong to this entity.
* For use when multiple types of entities are backed by a single table (EntityConfiguration) yet
* only expose a subset of the fields.
*/
entitySelectedFields?: TSelectedFields[];
}) {
this.entityClass = entityClass;
this.entityConfiguration = entityConfiguration;
this.privacyPolicyClass = privacyPolicyClass;
this.mutationValidators = mutationValidators;
this.mutationTriggers = mutationTriggers;
this.entitySelectedFields = entitySelectedFields;
}
}
/**
@@ -125,10 +162,6 @@ export interface EntityCompanionDefinition<
* EntityCompanion for each type of Entity.
*/
export default class EntityCompanionProvider {
private readonly companionDefinitionMap: Map<
string,
EntityCompanionDefinition<any, any, any, any, any, any>
> = new Map();
private readonly companionMap: Map<string, EntityCompanion<any, any, any, any, any, any>> =
new Map();
private readonly tableDataCoordinatorMap: Map<string, EntityTableDataCoordinator<any>> =
@@ -154,9 +187,10 @@ export default class EntityCompanionProvider {
* companion is constructed using the configuration provided by the factory.
*
* @param entityClass - entity class to load
* @param factory - entity companion factory
*/
getCompanionForEntity<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -176,22 +210,27 @@ export default class EntityCompanionProvider {
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
entityCompanionDefinition: EntityCompanionDefinition<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>
): EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
const entityCompanionDefinition = computeIfAbsent(
this.companionDefinitionMap,
entityClass.name,
() => entityClass.defineCompanionDefinition()
);
const tableDataCoordinator = this.getTableDataCoordinatorForEntity(
entityCompanionDefinition.entityConfiguration,
entityClass.name
);
return computeIfAbsent(this.companionMap, entityClass.name, () => {
return new EntityCompanion(
this,
entityCompanionDefinition,
entityCompanionDefinition.entityClass,
tableDataCoordinator,
entityCompanionDefinition.privacyPolicyClass,
entityCompanionDefinition.mutationValidators(),
entityCompanionDefinition.mutationTriggers(),
this.metricsAdapter
);
});
+5 -4
View File
@@ -13,7 +13,7 @@ export default class EntityConfiguration<TFields> {
readonly cacheableKeys: ReadonlySet<keyof TFields>;
readonly cacheKeyVersion: number;
readonly inboundEdges: IEntityClass<any, any, any, any, any, any>[];
readonly getInboundEdges: () => IEntityClass<any, any, any, any, any, any>[];
readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>;
readonly entityToDBFieldsKeyMapping: ReadonlyMap<keyof TFields, string>;
readonly dbToEntityFieldsKeyMapping: ReadonlyMap<string, keyof TFields>;
@@ -25,7 +25,7 @@ export default class EntityConfiguration<TFields> {
idField,
tableName,
schema,
inboundEdges = [],
getInboundEdges = () => [],
cacheKeyVersion = 0,
databaseAdapterFlavor,
cacheAdapterFlavor,
@@ -48,7 +48,7 @@ export default class EntityConfiguration<TFields> {
/**
* List of other entity types that reference this type in EntityFieldDefinition associations.
*/
inboundEdges?: IEntityClass<any, any, any, any, any, any>[];
getInboundEdges?: () => IEntityClass<any, any, any, any, any, any>[];
/**
* Cache key version for this entity type. Should be bumped when a field is added to, removed from, or changed
@@ -71,7 +71,8 @@ export default class EntityConfiguration<TFields> {
this.cacheKeyVersion = cacheKeyVersion;
this.databaseAdapterFlavor = databaseAdapterFlavor;
this.cacheAdapterFlavor = cacheAdapterFlavor;
this.inboundEdges = inboundEdges;
this.getInboundEdges = getInboundEdges;
// external schema is a Record to typecheck that all fields have FieldDefinitions,
// but internally the most useful representation is a map for lookups
+2 -2
View File
@@ -41,7 +41,7 @@ export enum EntityEdgeDeletionBehavior {
*/
export interface EntityAssociationDefinition<
TViewerContext extends ViewerContext,
TAssociatedFields extends object,
TAssociatedFields,
TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
TAssociatedEntity extends ReadonlyEntity<
TAssociatedFields,
@@ -61,7 +61,7 @@ export interface EntityAssociationDefinition<
/**
* Class of entity on the other end of this edge.
*/
associatedEntityClass: IEntityClass<
getAssociatedEntityClass: () => IEntityClass<
TAssociatedFields,
TAssociatedID,
TViewerContext,
+3 -20
View File
@@ -1,8 +1,6 @@
import { EntityFieldDefinition } from './EntityFieldDefinition';
import { validate as validateUUID } from 'uuid';
// Use our own regex since the `uuid` package doesn't support validating UUIDv6/7/8 yet
const UUID_REGEX =
/^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/i;
import { EntityFieldDefinition } from './EntityFieldDefinition';
/**
* EntityFieldDefinition for a column with a JS string type.
@@ -19,7 +17,7 @@ export class StringField extends EntityFieldDefinition<string> {
*/
export class UUIDField extends StringField {
protected override validateInputValueInternal(value: string): boolean {
return super.validateInputValueInternal(value) && UUID_REGEX.test(value);
return validateUUID(value);
}
}
@@ -88,18 +86,3 @@ export class EnumField extends EntityFieldDefinition<string | number> {
return typeof value === 'number' || typeof value === 'string';
}
}
/**
* EntityFieldDefinition for a enum column with a strict typescript enum type.
*/
export class StrictEnumField<T extends object> extends EnumField {
private readonly enum: T;
constructor(options: ConstructorParameters<typeof EnumField>[0] & { enum: T }) {
super(options);
this.enum = options.enum;
}
protected override validateInputValueInternal(value: string | number): boolean {
return super.validateInputValueInternal(value) && Object.values(this.enum).includes(value);
}
}
+2 -62
View File
@@ -1,6 +1,5 @@
import { Result, asyncResult, result } from '@expo/results';
import invariant from 'invariant';
import nullthrows from 'nullthrows';
import EnforcingEntityLoader from './EnforcingEntityLoader';
import { IEntityClass } from './Entity';
@@ -15,7 +14,6 @@ import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './Ent
import { EntityQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
import { pick } from './entityUtils';
import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
import EntityNotFoundError from './errors/EntityNotFoundError';
import EntityDataManager from './internal/EntityDataManager';
@@ -27,7 +25,7 @@ import { mapMap, mapMapAsync } from './utils/collections/maps';
* cached, and authorized against the entity's EntityPrivacyPolicy.
*/
export default class EntityLoader<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -53,7 +51,6 @@ export default class EntityLoader<
TPrivacyPolicy,
TSelectedFields
>,
private readonly entitySelectedFields: TSelectedFields[] | undefined,
private readonly privacyPolicy: TPrivacyPolicy,
private readonly dataManager: EntityDataManager<TFields>,
protected readonly metricsAdapter: IEntityMetricsAdapter
@@ -185,49 +182,6 @@ export default class EntityLoader<
});
}
/**
* Loads many entities for a list of IDs, returning null for any IDs that are non-existent.
* @param ids - IDs of the entities to load
* @returns map from ID to nullable corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
*/
async loadManyByIDsNullableAsync(
ids: readonly TID[]
): Promise<ReadonlyMap<TID, Result<TEntity> | null>> {
const entityResults = (await this.loadManyByFieldEqualingManyAsync(
this.entityConfiguration.idField as TSelectedFields,
ids
)) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
return mapMap(entityResults, (entityResultsForId) => {
return entityResultsForId[0] ?? null;
});
}
/**
* Loads the first entity matching the selection constructed from the conjunction of specified
* operands, or null if no matching entity exists. Entities loaded using this method are not
* batched or cached.
*
* This is a convenience method for {@link loadManyByFieldEqualityConjunctionAsync}. However, the
* `orderBy` option must be specified to define what "first" means. If ordering doesn't matter,
* explicitly pass in an empty array.
*
* @param fieldEqualityOperands - list of field equality selection operand specifications
* @param querySelectionModifiers - orderBy and optional offset for the query
* @returns the first entity results that matches the query, where result error can be
* UnauthorizedError
*/
async loadFirstByFieldEqualityConjunctionAsync<N extends keyof Pick<TFields, TSelectedFields>>(
fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
querySelectionModifiers: Omit<QuerySelectionModifiers<TFields>, 'limit'> &
Required<Pick<QuerySelectionModifiers<TFields>, 'orderBy'>>
): Promise<Result<TEntity> | null> {
const results = await this.loadManyByFieldEqualityConjunctionAsync(fieldEqualityOperands, {
...querySelectionModifiers,
limit: 1,
});
return results[0] ?? null;
}
/**
* Loads many entities matching the selection constructed from the conjunction of specified operands.
* Entities loaded using this method are not batched or cached.
@@ -352,7 +306,7 @@ export default class EntityLoader<
private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
return fieldsObjects.map((fieldsObject) => {
try {
return result(this.constructEntity(fieldsObject));
return result(new this.entityClass(this.viewerContext, fieldsObject));
} catch (e) {
if (!(e instanceof Error)) {
throw e;
@@ -362,20 +316,6 @@ export default class EntityLoader<
});
}
public constructEntity(fieldsObject: TFields): TEntity {
const idField = this.entityConfiguration.idField;
const id = nullthrows(fieldsObject[idField], 'must provide ID to create an entity');
const entitySelectedFields =
this.entitySelectedFields ?? Array.from(this.entityConfiguration.schema.keys());
const selectedFields = pick(fieldsObject, entitySelectedFields);
return new this.entityClass({
viewerContext: this.viewerContext,
id: id as TID,
databaseFields: fieldsObject,
selectedFields,
});
}
/**
* Construct and authorize entities from fields map, returning error results for entities that fail
* to construct or fail to authorize.
+9 -7
View File
@@ -1,4 +1,5 @@
import EntityCompanion from './EntityCompanion';
import { IEntityClass } from './Entity';
import EntityConfiguration from './EntityConfiguration';
import EntityLoader from './EntityLoader';
import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext';
@@ -11,7 +12,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
* The primary entry point for loading entities.
*/
export default class EntityLoaderFactory<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -25,7 +26,8 @@ export default class EntityLoaderFactory<
TSelectedFields extends keyof TFields
> {
constructor(
private readonly entityCompanion: EntityCompanion<
private readonly entityConfiguration: EntityConfiguration<TFields>,
private readonly entityClass: IEntityClass<
TFields,
TID,
TViewerContext,
@@ -33,6 +35,7 @@ export default class EntityLoaderFactory<
TPrivacyPolicy,
TSelectedFields
>,
private readonly privacyPolicyClass: TPrivacyPolicy,
private readonly dataManager: EntityDataManager<TFields>,
protected readonly metricsAdapter: IEntityMetricsAdapter
) {}
@@ -51,10 +54,9 @@ export default class EntityLoaderFactory<
viewerContext,
queryContext,
privacyPolicyEvaluationContext,
this.entityCompanion.entityCompanionDefinition.entityConfiguration,
this.entityCompanion.entityCompanionDefinition.entityClass,
this.entityCompanion.entityCompanionDefinition.entitySelectedFields,
this.entityCompanion.privacyPolicy,
this.entityConfiguration,
this.entityClass,
this.privacyPolicyClass,
this.dataManager,
this.metricsAdapter
);
+2 -2
View File
@@ -8,7 +8,7 @@ export enum EntityMutationType {
}
export type EntityValidatorMutationInfo<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -39,7 +39,7 @@ export type EntityCascadingDeletionInfo = {
};
export type EntityTriggerMutationInfo<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -7,7 +7,7 @@ import ViewerContext from './ViewerContext';
* Interface to define trigger behavior for entities.
*/
export default interface EntityMutationTriggerConfiguration<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -45,14 +45,15 @@ export default interface EntityMutationTriggerConfiguration<
*/
beforeAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs within the transaction but after the entity is created in, updated in, or deleted from
* Trigger set that runs within the transaction but before the entity is created in, updated in, or deleted from
* the database and the cache is invalidated.
*/
afterAll?: EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
/**
* Trigger set that runs after committing the mutation transaction. If the call to the mutation is wrapped in a transaction, these
* will be run after the wrapping transaction is completed.
* Trigger set that runs after committing the transaction unless one is supplied
* after any mutation (create, update, delete). If the call to the mutation is wrapped in a transaction,
* this too will be within the transaction.
*/
afterCommit?: EntityNonTransactionalMutationTrigger<
TFields,
@@ -64,11 +65,12 @@ export default interface EntityMutationTriggerConfiguration<
}
/**
* A transactional trigger is a way to specify entity mutation operation side-effects that run within the
* same transaction as the mutation itself.
* A trigger is a way to specify entity mutation operation side-effects that run within the
* same transaction as the mutation itself. The one exception is afterCommit, which will run within
* the transaction if a transaction is supplied.
*/
export abstract class EntityMutationTrigger<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -84,10 +86,10 @@ export abstract class EntityMutationTrigger<
/**
* A non-transactional trigger is like a EntityMutationTrigger but used for afterCommit triggers
* since they run after the transaction is committed.
* since they explicitly occur outside of the transaction.
*/
export abstract class EntityNonTransactionalMutationTrigger<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -8,7 +8,7 @@ import ViewerContext from './ViewerContext';
* same transaction as the mutation itself before creating or updating an entity.
*/
export default abstract class EntityMutationValidator<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
+31 -38
View File
@@ -2,7 +2,7 @@ import { Result, asyncResult, result, enforceAsyncResult } from '@expo/results';
import invariant from 'invariant';
import Entity, { IEntityClass } from './Entity';
import EntityCompanionProvider from './EntityCompanionProvider';
import { EntityCompanionDefinition } from './EntityCompanionProvider';
import EntityConfiguration from './EntityConfiguration';
import EntityDatabaseAdapter from './EntityDatabaseAdapter';
import { EntityEdgeDeletionBehavior } from './EntityFieldDefinition';
@@ -28,7 +28,7 @@ import IEntityMetricsAdapter, { EntityMetricsMutationType } from './metrics/IEnt
import { mapMapAsync } from './utils/collections/maps';
abstract class BaseMutator<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -42,7 +42,6 @@ abstract class BaseMutator<
TSelectedFields extends keyof TFields
> {
constructor(
protected readonly companionProvider: EntityCompanionProvider,
protected readonly viewerContext: TViewerContext,
protected readonly queryContext: EntityQueryContext,
protected readonly entityConfiguration: EntityConfiguration<TFields>,
@@ -156,7 +155,7 @@ abstract class BaseMutator<
* Mutator for creating a new entity.
*/
export class CreateMutator<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -212,11 +211,7 @@ export class CreateMutator<
): Promise<Result<TEntity>> {
this.validateFields(this.fieldsForEntity);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext, {
cascadingDeleteCause: null,
});
const temporaryEntityForPrivacyCheck = entityLoader.constructEntity({
const temporaryEntityForPrivacyCheck = new this.entityClass(this.viewerContext, {
[this.entityConfiguration.idField]: '00000000-0000-0000-0000-000000000000', // zero UUID
...this.fieldsForEntity,
} as unknown as TFields);
@@ -255,11 +250,14 @@ export class CreateMutator<
const insertResult = await this.databaseAdapter.insertAsync(queryContext, this.fieldsForEntity);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext, {
cascadingDeleteCause: null,
});
queryContext.appendPostCommitInvalidationCallback(
entityLoader.invalidateFieldsAsync.bind(entityLoader, insertResult)
);
const unauthorizedEntityAfterInsert = entityLoader.constructEntity(insertResult);
const unauthorizedEntityAfterInsert = new this.entityClass(this.viewerContext, insertResult);
const newEntity = await entityLoader
.enforcing()
.loadByIDAsync(unauthorizedEntityAfterInsert.getID());
@@ -294,7 +292,7 @@ export class CreateMutator<
* Mutator for updating an existing entity.
*/
export class UpdateMutator<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -312,7 +310,6 @@ export class UpdateMutator<
private readonly updatedFields: Partial<TFields> = {};
constructor(
companionProvider: EntityCompanionProvider,
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
entityConfiguration: EntityConfiguration<TFields>,
@@ -352,7 +349,6 @@ export class UpdateMutator<
originalEntity: TEntity
) {
super(
companionProvider,
viewerContext,
queryContext,
entityConfiguration,
@@ -423,11 +419,7 @@ export class UpdateMutator<
): Promise<Result<TEntity>> {
this.validateFields(this.updatedFields);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext, {
cascadingDeleteCause,
});
const entityAboutToBeUpdated = entityLoader.constructEntity(this.fieldsForEntity);
const entityAboutToBeUpdated = new this.entityClass(this.viewerContext, this.fieldsForEntity);
const authorizeUpdateResult = await asyncResult(
this.privacyPolicy.authorizeUpdateAsync(
this.viewerContext,
@@ -470,6 +462,10 @@ export class UpdateMutator<
this.updatedFields
);
const entityLoader = this.entityLoaderFactory.forLoad(this.viewerContext, queryContext, {
cascadingDeleteCause,
});
queryContext.appendPostCommitInvalidationCallback(
entityLoader.invalidateFieldsAsync.bind(
entityLoader,
@@ -485,7 +481,7 @@ export class UpdateMutator<
const updatedEntity = updateResult
? await entityLoader
.enforcing()
.loadByIDAsync(entityLoader.constructEntity(updateResult).getID())
.loadByIDAsync(new this.entityClass(this.viewerContext, updateResult).getID())
: entityAboutToBeUpdated;
await this.executeMutationTriggersAsync(
@@ -522,7 +518,7 @@ export class UpdateMutator<
* Mutator for deleting an existing entity.
*/
export class DeleteMutator<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -536,7 +532,6 @@ export class DeleteMutator<
TSelectedFields extends keyof TFields
> extends BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
constructor(
companionProvider: EntityCompanionProvider,
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
entityConfiguration: EntityConfiguration<TFields>,
@@ -576,7 +571,6 @@ export class DeleteMutator<
private readonly entity: TEntity
) {
super(
companionProvider,
viewerContext,
queryContext,
entityConfiguration,
@@ -729,32 +723,31 @@ export class DeleteMutator<
}
processedEntityIdentifiers.add(entity.getUniqueIdentifier());
const companionDefinition = this.companionProvider.getCompanionForEntity(
entity.constructor as IEntityClass<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>
).entityCompanionDefinition;
const companionDefinition = (
entity.constructor as any
).getCompanionDefinition() as EntityCompanionDefinition<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>;
const entityConfiguration = companionDefinition.entityConfiguration;
const inboundEdges = entityConfiguration.inboundEdges;
const inboundEdges = entityConfiguration.getInboundEdges();
await Promise.all(
inboundEdges.map(async (entityClass) => {
return await mapMapAsync(
this.companionProvider.getCompanionForEntity(entityClass).entityCompanionDefinition
.entityConfiguration.schema,
entityClass.getCompanionDefinition().entityConfiguration.schema,
async (fieldDefinition, fieldName) => {
const association = fieldDefinition.association;
if (!association) {
return;
}
const associatedConfiguration = this.companionProvider.getCompanionForEntity(
association.associatedEntityClass
).entityCompanionDefinition.entityConfiguration;
const associatedConfiguration = association
.getAssociatedEntityClass()
.getCompanionDefinition().entityConfiguration;
if (associatedConfiguration !== entityConfiguration) {
return;
}
+1 -6
View File
@@ -1,5 +1,4 @@
import Entity, { IEntityClass } from './Entity';
import EntityCompanionProvider from './EntityCompanionProvider';
import EntityConfiguration from './EntityConfiguration';
import EntityDatabaseAdapter from './EntityDatabaseAdapter';
import EntityLoaderFactory from './EntityLoaderFactory';
@@ -15,7 +14,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
* The primary interface for creating, mutating, and deleting entities.
*/
export default class EntityMutatorFactory<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -29,7 +28,6 @@ export default class EntityMutatorFactory<
TSelectedFields extends keyof TFields = keyof TFields
> {
constructor(
private readonly entityCompanionProvider: EntityCompanionProvider,
private readonly entityConfiguration: EntityConfiguration<TFields>,
private readonly entityClass: IEntityClass<
TFields,
@@ -77,7 +75,6 @@ export default class EntityMutatorFactory<
queryContext: EntityQueryContext
): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new CreateMutator(
this.entityCompanionProvider,
viewerContext,
queryContext,
this.entityConfiguration,
@@ -102,7 +99,6 @@ export default class EntityMutatorFactory<
queryContext: EntityQueryContext
): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new UpdateMutator(
this.entityCompanionProvider,
existingEntity.getViewerContext(),
queryContext,
this.entityConfiguration,
@@ -127,7 +123,6 @@ export default class EntityMutatorFactory<
queryContext: EntityQueryContext
): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
return new DeleteMutator(
this.entityCompanionProvider,
existingEntity.getViewerContext(),
queryContext,
this.entityConfiguration,
+4 -30
View File
@@ -6,9 +6,7 @@ import EntityNotAuthorizedError from './errors/EntityNotAuthorizedError';
import IEntityMetricsAdapter, {
EntityMetricsAuthorizationResult,
} from './metrics/IEntityMetricsAdapter';
import { RuleEvaluationResult } from './rules/PrivacyPolicyRuleEnums';
import { PrivacyPolicyRule } from './rules/PrivacyPolicyRuleTypes';
import { reorderRulesByRuleComplexityGroups } from './rules/internal/PrivacyPolicyRuleOrdering';
import PrivacyPolicyRule, { RuleEvaluationResult } from './rules/PrivacyPolicyRule';
/**
* Information about the reason this privacy policy is being evaluated.
@@ -43,7 +41,7 @@ export enum EntityPrivacyPolicyEvaluationMode {
}
export type EntityPrivacyPolicyEvaluator<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -94,7 +92,7 @@ export enum EntityAuthorizationAction {
* ```
*/
export default abstract class EntityPrivacyPolicy<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -145,15 +143,6 @@ export default abstract class EntityPrivacyPolicy<
};
}
protected async shouldAutoReorderRulesAccordingToComplexityAsync(
_viewerContext: TViewerContext,
_queryContext: EntityQueryContext,
_evaluationContext: EntityPrivacyPolicyEvaluationContext,
_action: EntityAuthorizationAction
): Promise<boolean> {
return false;
}
/**
* Authorize an entity against creation policy.
* @param viewerContext - viewer context of user creating the entity
@@ -259,13 +248,7 @@ export default abstract class EntityPrivacyPolicy<
}
private async authorizeForRulesetAsync(
rulesetOriginalOrder: readonly PrivacyPolicyRule<
TFields,
TID,
TViewerContext,
TEntity,
TSelectedFields
>[],
ruleset: readonly PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>[],
viewerContext: TViewerContext,
queryContext: EntityQueryContext,
evaluationContext: EntityPrivacyPolicyEvaluationContext,
@@ -274,15 +257,6 @@ export default abstract class EntityPrivacyPolicy<
metricsAdapter: IEntityMetricsAdapter
): Promise<TEntity> {
const privacyPolicyEvaluator = this.getPrivacyPolicyEvaluator(viewerContext);
const shouldAutoReorder = await this.shouldAutoReorderRulesAccordingToComplexityAsync(
viewerContext,
queryContext,
evaluationContext,
action
);
const ruleset = shouldAutoReorder
? reorderRulesByRuleComplexityGroups(rulesetOriginalOrder)
: rulesetOriginalOrder;
switch (privacyPolicyEvaluator.mode) {
case EntityPrivacyPolicyEvaluationMode.ENFORCE:
try {
+4 -24
View File
@@ -8,16 +8,6 @@ export type PreCommitCallback = (
...args: any
) => Promise<any>;
export enum TransactionIsolationLevel {
READ_COMMITTED = 'READ_COMMITTED',
REPEATABLE_READ = 'REPEATABLE_READ',
SERIALIZABLE = 'SERIALIZABLE',
}
export type TransactionConfig = {
isolationLevel?: TransactionIsolationLevel;
};
/**
* Entity framework representation of transactional and non-transactional database
* query execution units.
@@ -35,8 +25,7 @@ export abstract class EntityQueryContext {
}
abstract runInTransactionIfNotInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>,
transactionConfig?: TransactionConfig
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T>;
}
@@ -59,13 +48,9 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
}
async runInTransactionIfNotInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>,
transactionConfig?: TransactionConfig
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T> {
return await this.entityQueryContextProvider.runInTransactionAsync(
transactionScope,
transactionConfig
);
return await this.entityQueryContextProvider.runInTransactionAsync(transactionScope);
}
}
@@ -147,13 +132,8 @@ export class EntityTransactionalQueryContext extends EntityQueryContext {
}
async runInTransactionIfNotInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>,
transactionConfig?: TransactionConfig
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T> {
assert(
transactionConfig === undefined,
'Should not pass transactionConfig to a nested transaction'
);
return await transactionScope(this);
}
@@ -2,7 +2,6 @@ import {
EntityTransactionalQueryContext,
EntityNonTransactionalQueryContext,
EntityNestedTransactionalQueryContext,
TransactionConfig,
} from './EntityQueryContext';
/**
@@ -24,9 +23,9 @@ export default abstract class EntityQueryContextProvider {
/**
* Vend a transaction runner for use in runInTransactionAsync.
*/
protected abstract createTransactionRunner<T>(
transactionConfig?: TransactionConfig
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T>;
protected abstract createTransactionRunner<T>(): (
transactionScope: (queryInterface: any) => Promise<T>
) => Promise<T>;
protected abstract createNestedTransactionRunner<T>(
outerQueryInterface: any
@@ -37,12 +36,11 @@ export default abstract class EntityQueryContextProvider {
* @param transactionScope - async callback to execute within the transaction
*/
async runInTransactionAsync<T>(
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>,
transactionConfig?: TransactionConfig
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
): Promise<T> {
const [returnedValue, queryContext] = await this.createTransactionRunner<
[T, EntityTransactionalQueryContext]
>(transactionConfig)(async (queryInterface) => {
>()(async (queryInterface) => {
const queryContext = new EntityTransactionalQueryContext(queryInterface, this);
const result = await transactionScope(queryContext);
await queryContext.runPreCommitCallbacksAsync();
@@ -45,7 +45,7 @@ export interface ISecondaryEntityCache<TFields, TLoadParams> {
*/
export default abstract class EntitySecondaryCacheLoader<
TLoadParams,
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -7,7 +7,7 @@ import IEntityCacheAdapter from './IEntityCacheAdapter';
*/
export default interface IEntityCacheAdapterProvider {
/**
* Vend a cache adapter for an entity configuration.
* Vend a cache adapter.
*/
getCacheAdapter<TFields>(
entityConfiguration: EntityConfiguration<TFields>
+2 -30
View File
@@ -1,45 +1,17 @@
import { CacheLoadResult } from './internal/ReadThroughEntityCache';
/**
* A generic cacher stores and loads key-value pairs. It also supports negative caching - it stores the absence
* of keys that don't exist in the backing datastore. It is also responsible for cache key creation.
* A cacher stores and loads key-value pairs. It also supports negative caching - it stores the absence
* of keys that don't exist in the backing datastore.
*/
export default interface IEntityGenericCacher<TFields> {
/**
* Load many keys from the cache. Return info in a format that is useful for read-through caching and
* negative caching.
*
* @param keys - cache keys to load
*/
loadManyAsync(keys: readonly string[]): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>>;
/**
* Cache many objects for specified keys.
*
* @param objectMap - map from cache key to object to cache for key
*/
cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void>;
/**
* Negatively-cache specified keys. Subsequent loads for these keys (without calling invalidate) may
* return a negative CacheLoadResult
*
* @param keys - keys to cache negatively
*/
cacheDBMissesAsync(keys: readonly string[]): Promise<void>;
/**
* Invalidate specified keys in cache. Subsequent loads for these keys may return a cache miss.
*
* @param keys - keys to invalidate
*/
invalidateManyAsync(keys: readonly string[]): Promise<void>;
/**
* Create a cache key for a field and value of a object being cached or invalidated.
*
* @param fieldName - name of the object field for this cache key
* @param fieldValue - value of the obejct field for this cache key
*/
makeCacheKey<N extends keyof TFields>(fieldName: N, fieldValue: NonNullable<TFields[N]>): string;
}
+32 -32
View File
@@ -2,10 +2,12 @@ import invariant from 'invariant';
import { IEntityClass } from './Entity';
import EntityAssociationLoader from './EntityAssociationLoader';
import { EntityCompanionDefinition } from './EntityCompanionProvider';
import EntityLoader from './EntityLoader';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import { EntityQueryContext } from './EntityQueryContext';
import ViewerContext from './ViewerContext';
import { pick } from './entityUtils';
/**
* A readonly entity exposes only the read functionality of an Entity. Used as the base
@@ -16,47 +18,45 @@ import ViewerContext from './ViewerContext';
* - Entities representing immutable tables.
*/
export default abstract class ReadonlyEntity<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TSelectedFields extends keyof TFields = keyof TFields
> {
private readonly viewerContext: TViewerContext;
private readonly id: TID;
private readonly databaseFields: Readonly<TFields>;
private readonly selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
private readonly rawFields: Readonly<Pick<TFields, TSelectedFields>>;
/**
* Constructs an instance of an Entity.
*
* @param constructorParam - data needed to construct an instance of an entity
* viewerContext - the ViewerContext reading this entity
* id - the ID of this entity
* databaseFields - all underlying fields for this entity's data
* selectedFields - selected fields for this entity from TSelectedFields type
*
* This should only be overridden in cases where additional data validation is needed.
* The params should not be modified when calling super during constructions.
* @param viewerContext - the ViewerContext reading this entity
* @param rawFields - all underlying fields for this entity's data
*
* @internal
*/
constructor({
viewerContext,
id,
databaseFields,
selectedFields,
}: {
viewerContext: TViewerContext;
id: TID;
databaseFields: Readonly<TFields>;
selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
}) {
invariant(id !== null && id !== undefined, 'id must be non-null');
constructor(
private readonly viewerContext: TViewerContext,
private readonly databaseFields: Readonly<TFields>
) {
const companionDefinition = (
this.constructor as any
).getCompanionDefinition() as EntityCompanionDefinition<
TFields,
TID,
TViewerContext,
this,
EntityPrivacyPolicy<TFields, TID, TViewerContext, this, TSelectedFields>,
TSelectedFields
>;
const idField = companionDefinition.entityConfiguration.idField as keyof Pick<
TFields,
TSelectedFields
>;
const id = databaseFields[idField];
invariant(id, 'must provide ID to create an entity');
this.id = id as any;
this.viewerContext = viewerContext;
this.id = id;
this.databaseFields = databaseFields;
this.selectedFields = selectedFields;
const entitySelectedFields = companionDefinition.entitySelectedFields as (keyof TFields)[];
this.rawFields = pick(databaseFields, entitySelectedFields);
}
toString(): string {
@@ -102,14 +102,14 @@ export default abstract class ReadonlyEntity<
getField<K extends keyof Pick<TFields, TSelectedFields>>(
fieldName: K
): Pick<TFields, TSelectedFields>[K] {
return this.selectedFields[fieldName];
return this.rawFields[fieldName];
}
/**
* @returns all underlying fields from this entity's data
*/
getAllFields(): Readonly<Pick<TFields, TSelectedFields>> {
return { ...this.selectedFields };
return { ...this.rawFields };
}
/**
@@ -125,7 +125,7 @@ export default abstract class ReadonlyEntity<
* @param queryContext - query context in which to perform the load
*/
static loader<
TMFields extends object,
TMFields,
TMID extends NonNullable<TMFields[TMSelectedFields]>,
TMViewerContext extends ViewerContext,
TMViewerContext2 extends TMViewerContext,
+8 -10
View File
@@ -1,11 +1,7 @@
import { IEntityClass } from './Entity';
import EntityCompanionProvider, { DatabaseAdapterFlavor } from './EntityCompanionProvider';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import {
EntityQueryContext,
EntityTransactionalQueryContext,
TransactionConfig,
} from './EntityQueryContext';
import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerScopedEntityCompanion from './ViewerScopedEntityCompanion';
import ViewerScopedEntityCompanionProvider from './ViewerScopedEntityCompanionProvider';
@@ -31,7 +27,7 @@ export default class ViewerContext {
}
getViewerScopedEntityCompanionForClass<
TMFields extends object,
TMFields,
TMID extends NonNullable<TMFields[TMSelectedFields]>,
TMViewerContext extends ViewerContext,
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -60,7 +56,10 @@ export default class ViewerContext {
TMPrivacyPolicy,
TMSelectedFields
> {
return this.viewerScopedEntityCompanionProvider.getViewerScopedCompanionForEntity(entityClass);
return this.viewerScopedEntityCompanionProvider.getViewerScopedCompanionForEntity(
entityClass,
entityClass.getCompanionDefinition()
);
}
/**
@@ -83,12 +82,11 @@ export default class ViewerContext {
*/
async runInTransactionForDatabaseAdaptorFlavorAsync<TResult>(
databaseAdaptorFlavor: DatabaseAdapterFlavor,
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>,
transactionConfig?: TransactionConfig
transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
): Promise<TResult> {
return await this.entityCompanionProvider
.getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
.getQueryContext()
.runInTransactionIfNotInTransactionAsync(transactionScope, transactionConfig);
.runInTransactionIfNotInTransactionAsync(transactionScope);
}
}
@@ -12,7 +12,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
* from the viewer-scoped entity companion provider.
*/
export default class ViewerScopedEntityCompanion<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -26,7 +26,7 @@ export default class ViewerScopedEntityCompanion<
TSelectedFields extends keyof TFields
> {
constructor(
public readonly entityCompanion: EntityCompanion<
private readonly entityCompanion: EntityCompanion<
TFields,
TID,
TViewerContext,
@@ -1,5 +1,5 @@
import { IEntityClass } from './Entity';
import EntityCompanionProvider from './EntityCompanionProvider';
import EntityCompanionProvider, { EntityCompanionDefinition } from './EntityCompanionProvider';
import EntityPrivacyPolicy from './EntityPrivacyPolicy';
import ReadonlyEntity from './ReadonlyEntity';
import ViewerContext from './ViewerContext';
@@ -19,10 +19,10 @@ export default class ViewerScopedEntityCompanionProvider {
* companion is constructed using the configuration provided by the factory.
*
* @param entityClass - entity class to load
* @param entityCompanionDefinitionFn - function defining entity companion definition
* @param factory - entity companion factory
*/
getViewerScopedCompanionForEntity<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -42,6 +42,14 @@ export default class ViewerScopedEntityCompanionProvider {
TEntity,
TPrivacyPolicy,
TSelectedFields
>,
entityCompanionDefinition: EntityCompanionDefinition<
TFields,
TID,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields
>
): ViewerScopedEntityCompanion<
TFields,
@@ -52,7 +60,7 @@ export default class ViewerScopedEntityCompanionProvider {
TSelectedFields
> {
return new ViewerScopedEntityCompanion(
this.entityCompanionProvider.getCompanionForEntity(entityClass),
this.entityCompanionProvider.getCompanionForEntity(entityClass, entityCompanionDefinition),
this.viewerContext as TViewerContext
);
}
@@ -9,7 +9,7 @@ import ViewerContext from './ViewerContext';
* Provides a cleaner API for loading entities by passing through the ViewerContext.
*/
export default class ViewerScopedEntityLoaderFactory<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -9,7 +9,7 @@ import ViewerContext from './ViewerContext';
* Provides a cleaner API for mutating entities by passing through the ViewerContext.
*/
export default class ViewerScopedEntityMutatorFactory<
TFields extends object,
TFields,
TID extends NonNullable<TFields[TSelectedFields]>,
TViewerContext extends ViewerContext,
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
Loaded 100 of 148 files, more files were not shown because too many files have changed in this diff. Show more