fix: remove ttl usage from getOrSetForever

Julien-R44 · Oct 1, 2024 · 32943e2 · 32943e2
1 parent 7267974
commit 32943e2
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 6 deletions.
diff --git a/packages/bentocache/src/bento_cache.ts b/packages/bentocache/src/bento_cache.ts
@@ -15,12 +15,14 @@ import type {
   HasOptions,
   ClearOptions,
   GetSetFactory,
+  GetOrSetForeverPojoOptions,
   GetOrSetPojoOptions,
   GetPojoOptions,
   SetPojoOptions,
   HasPojoOptions,
   DeletePojoOptions,
   DeleteManyPojoOptions,
+  GetOrSetForeverOptions,
 } from './types/main.js'
 
 export class BentoCache<KnownCaches extends Record<string, BentoStore>> implements CacheProvider {
@@ -197,9 +199,9 @@ export class BentoCache<KnownCaches extends Record<string, BentoStore>> implemen
    * provided by the factory forever and return it
    */
   getOrSetForever<T>(
-    key: string | GetOrSetPojoOptions<T>,
+    key: string | GetOrSetForeverPojoOptions<T>,
     cb?: GetSetFactory<T>,
-    opts?: GetOrSetOptions,
+    opts?: GetOrSetForeverOptions,
   ): Promise<T> {
     if (typeof key === 'string') {
       return this.use().getOrSetForever(key, cb!, opts)

diff --git a/packages/bentocache/src/cache/cache.ts b/packages/bentocache/src/cache/cache.ts
@@ -19,6 +19,8 @@ import type {
   HasPojoOptions,
   DeletePojoOptions,
   DeleteManyPojoOptions,
+  GetOrSetForeverPojoOptions,
+  GetOrSetForeverOptions,
 } from '../types/main.js'
 
 export class Cache implements CacheProvider {
@@ -153,9 +155,9 @@ export class Cache implements CacheProvider {
    * provided by the factory forever and return it
    */
   async getOrSetForever<T>(
-    keyOrOptions: string | GetOrSetPojoOptions<T>,
+    keyOrOptions: string | GetOrSetForeverPojoOptions<T>,
     factory?: GetSetFactory<T>,
-    options?: GetOrSetOptions,
+    options?: GetOrSetForeverOptions,
   ): Promise<T> {
     if (typeof keyOrOptions === 'string') {
       const cacheOptions = this.#stack.defaultOptions.cloneWith({ ttl: null, ...options })

diff --git a/packages/bentocache/src/types/options/methods_options.ts b/packages/bentocache/src/types/options/methods_options.ts
@@ -13,6 +13,22 @@ export type GetOrSetOptions = Pick<
  */
 export type GetOrSetPojoOptions<T> = { key: string; factory: GetSetFactory<T> } & GetOrSetOptions
 
+/**
+ * Options accepted by the `getOrSetForever` method
+ */
+export type GetOrSetForeverOptions = Pick<
+  RawCommonOptions,
+  'earlyExpiration' | 'gracePeriod' | 'suppressL2Errors' | 'lockTimeout' | 'timeouts'
+>
+
+/**
+ * Options accepted by the `getOrSetForever` method when passing an object
+ */
+export type GetOrSetForeverPojoOptions<T> = {
+  key: string
+  factory: GetSetFactory<T>
+} & GetOrSetForeverOptions
+
 /**
  * Options accepted by the `set` method
  */

diff --git a/packages/bentocache/src/types/provider.ts b/packages/bentocache/src/types/provider.ts
@@ -5,6 +5,8 @@ import type {
   DeleteOptions,
   DeletePojoOptions,
   GetOptions,
+  GetOrSetForeverOptions,
+  GetOrSetForeverPojoOptions,
   GetOrSetOptions,
   GetOrSetPojoOptions,
   GetPojoOptions,
@@ -53,8 +55,8 @@ export interface CacheProvider {
   /**
    * Get or set a value in the cache forever
    */
-  getOrSetForever<T>(options: GetOrSetPojoOptions<T>): Promise<T>
-  getOrSetForever<T>(key: string, cb: GetSetFactory<T>, opts?: GetOrSetOptions): Promise<T>
+  getOrSetForever<T>(options: GetOrSetForeverPojoOptions<T>): Promise<T>
+  getOrSetForever<T>(key: string, cb: GetSetFactory<T>, opts?: GetOrSetForeverOptions): Promise<T>
 
   /**
    * Check if a key exists in the cache

diff --git a/packages/bentocache/tests/typings.spec.ts b/packages/bentocache/tests/typings.spec.ts
@@ -198,4 +198,18 @@ test.group('Typings', () => {
   test('stores entries should accept raw options', async ({ expectTypeOf }) => {
     expectTypeOf(bentostore).toBeCallableWith({ gracePeriod: { enabled: true } })
   })
+
+  test('cant pass ttl when using getOrSetForever', async () => {
+    const { bento } = new BentoCacheFactory().create()
+
+    bento.getOrSetForever({
+      key: 'foo',
+      factory: () => 'bar',
+      // @ts-expect-error - should not accept ttl
+      ttl: 100,
+    })
+
+    // @ts-expect-error - should not accept ttl
+    bento.getOrSetForever('foo', () => 'bar', { ttl: 100 })
+  })
 })