Narrow down supported types for In-Memory cache configuration (#240)

kibertoad · Apr 16, 2023 · 7209078 · 7209078
1 parent 7ae96af
commit 7209078
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 8 deletions.
diff --git a/lib/AbstractCache.ts b/lib/AbstractCache.ts
@@ -24,12 +24,13 @@ export const DEFAULT_CACHE_ERROR_HANDLER: LoaderErrorHandler = (err, key, cache,
 
 export type CommonCacheConfig<
   LoadedValue,
-  CacheType extends Cache<LoadedValue> | GroupCache<LoadedValue> = Cache<LoadedValue>
+  CacheType extends Cache<LoadedValue> | GroupCache<LoadedValue> = Cache<LoadedValue>,
+  InMemoryCacheType extends InMemoryCacheConfiguration | InMemoryGroupCacheConfiguration = InMemoryCacheConfiguration
 > = {
   logger?: Logger
   cacheUpdateErrorHandler?: LoaderErrorHandler
   loadErrorHandler?: LoaderErrorHandler
-  inMemoryCache?: InMemoryCacheConfiguration | InMemoryGroupCacheConfiguration | false
+  inMemoryCache?: InMemoryCacheType | false
   asyncCache?: CacheType
 }
 

diff --git a/lib/GroupLoader.ts b/lib/GroupLoader.ts
@@ -1,12 +1,14 @@
 import type { GroupCache, GroupDataSource } from './types/DataSources'
 import type { LoaderConfig } from './Loader'
 import { AbstractGroupCache } from './AbstractGroupCache'
+import type { InMemoryGroupCacheConfiguration } from './memory/InMemoryGroupCache'
 
 export type GroupLoaderConfig<LoadedValue, LoaderParams = undefined> = LoaderConfig<
   LoadedValue,
   GroupCache<LoadedValue>,
   LoaderParams,
-  GroupDataSource<LoadedValue, LoaderParams>
+  GroupDataSource<LoadedValue, LoaderParams>,
+  InMemoryGroupCacheConfiguration
 >
 export class GroupLoader<LoadedValue, LoaderParams = undefined> extends AbstractGroupCache<LoadedValue, LoaderParams> {
   private readonly loaders: readonly GroupDataSource<LoadedValue, LoaderParams>[]

diff --git a/lib/Loader.ts b/lib/Loader.ts
@@ -1,17 +1,20 @@
 import type { CommonCacheConfig } from './AbstractCache'
 import type { Cache, DataSource, GroupCache } from './types/DataSources'
 import { AbstractFlatCache } from './AbstractFlatCache'
+import type { InMemoryCacheConfiguration } from './memory'
+import type { InMemoryGroupCacheConfiguration } from './memory/InMemoryGroupCache'
 
 export type LoaderConfig<
   LoadedValue,
   CacheType extends Cache<LoadedValue> | GroupCache<LoadedValue> = Cache<LoadedValue>,
   LoaderParams = undefined,
-  LoaderType = DataSource<LoadedValue, LoaderParams>
+  LoaderType = DataSource<LoadedValue, LoaderParams>,
+  InMemoryCacheType extends InMemoryCacheConfiguration | InMemoryGroupCacheConfiguration = InMemoryCacheConfiguration
 > = {
   loaders?: readonly LoaderType[]
   throwIfLoadError?: boolean
   throwIfUnresolved?: boolean
-} & CommonCacheConfig<LoadedValue, CacheType>
+} & CommonCacheConfig<LoadedValue, CacheType, InMemoryCacheType>
 
 export class Loader<LoadedValue, LoaderParams = undefined> extends AbstractFlatCache<LoadedValue, LoaderParams> {
   private readonly loaders: readonly DataSource<LoadedValue, LoaderParams>[]

diff --git a/lib/memory/InMemoryGroupCache.ts b/lib/memory/InMemoryGroupCache.ts
@@ -22,7 +22,7 @@ const DEFAULT_GROUP_CONFIGURATION = {
 export class InMemoryGroupCache<T> implements SynchronousGroupCache<T> {
   private readonly groups: ToadCache<ToadCache<T | null> | undefined | null>
   private readonly maxItemsPerGroup: number
-  name = 'In-memory cache'
+  name = 'In-memory group cache'
   private readonly ttlInMsecs: number | undefined
   public readonly ttlLeftBeforeRefreshInMsecs?: number
   private readonly cacheConstructor: CacheConstructor<ToadCache<T>>

diff --git a/test/GroupLoader-main.spec.ts b/test/GroupLoader-main.spec.ts
@@ -1,4 +1,3 @@
-import type { InMemoryCacheConfiguration } from '../lib/memory/InMemoryCache'
 import type { User } from './types/testTypes'
 import { GroupLoader } from '../lib/GroupLoader'
 import { DummyGroupedCache } from './fakes/DummyGroupedCache'
@@ -10,8 +9,9 @@ import { CountingGroupedLoader } from './fakes/CountingGroupedLoader'
 import type { DummyLoaderParams } from './fakes/DummyLoaderWithParams'
 import { DummyGroupedLoaderWithParams } from './fakes/DummyGroupedLoaderWithParams'
 import { setTimeout } from 'timers/promises'
+import type { InMemoryGroupCacheConfiguration } from '../lib/memory/InMemoryGroupCache'
 
-const IN_MEMORY_CACHE_CONFIG = { ttlInMsecs: 9999999 } satisfies InMemoryCacheConfiguration
+const IN_MEMORY_CACHE_CONFIG = { ttlInMsecs: 9999999 } satisfies InMemoryGroupCacheConfiguration
 
 const user1: User = {
   companyId: '1',