feat: expose createCacheEntry and createCacheMetaData helpers

as low level building block that can be used to manually set entries to a cache

Author: Xiphe

src/cachified.spec.ts

@@ -14,9 +14,10 @@ import {
   redisCacheAdapter,
   RedisLikeCache,
   GetFreshValue,
+  createCacheEntry,
 } from './index';
 import { Deferred } from './createBatch';
-import { createCacheEntry, delay, report } from './testHelpers';
+import { delay, report } from './testHelpers';
 
 jest.mock('./index', () => {
   if (process.version.startsWith('v18')) {
@@ -1471,13 +1472,9 @@ describe('cachified', () => {
     expect(get).toHaveBeenCalledTimes(1);
     expect(get).toHaveBeenCalledWith('test-3');
     expect(set).toHaveBeenCalledTimes(1);
-    expect(set).toHaveBeenCalledWith(
-      'test-3',
-      JSON.stringify({
-        metadata: { ttl: 1, swr: 0, createdTime: 0 },
-        value: 'FOUR',
-      }),
-      { EXAT: 1 },
+    expect(set).toHaveBeenCalledWith('test-3', expect.any(String), { EXAT: 1 });
+    expect(JSON.parse(set.mock.calls[0][1])).toEqual(
+      createCacheEntry('FOUR', { createdTime: 0, swr: 0, ttl: 1 }),
     );
 
     await cache.set('lel', undefined as any);

src/common.ts

@@ -229,11 +229,7 @@ export function createContext<Value>({
     staleRefreshTimeout: 0,
     forceFresh: false,
     ...options,
-    metadata: {
-      ttl: ttl === Infinity ? null : ttl,
-      swr: staleWhileRevalidate === Infinity ? null : staleWhileRevalidate,
-      createdTime: Date.now(),
-    },
+    metadata: createCacheMetaData({ ttl, swr: staleWhileRevalidate }),
   };
 
   const report =
@@ -263,3 +259,25 @@ export function totalTtl(metadata?: CacheMetadata): number {
   }
   return (metadata.ttl || 0) + (staleWhileRevalidate(metadata) || 0);
 }
+
+export function createCacheMetaData({
+  ttl = null,
+  swr = 0,
+  createdTime = Date.now(),
+}: Partial<Omit<CacheMetadata, 'swv'>> = {}) {
+  return {
+    ttl: ttl === Infinity ? null : ttl,
+    swr: swr === Infinity ? null : swr,
+    createdTime,
+  };
+}
+
+export function createCacheEntry<Value>(
+  value: Value,
+  metadata?: Partial<Omit<CacheMetadata, 'swv'>>,
+): CacheEntry<Value> {
+  return {
+    value,
+    metadata: createCacheMetaData(metadata),
+  };
+}

src/getFreshValue.ts

@@ -1,4 +1,4 @@
-import type { Context, CacheMetadata } from './common';
+import { Context, CacheMetadata, createCacheEntry } from './common';
 import { getCacheEntry, CACHE_EMPTY } from './getCachedValue';
 import { shouldRefresh } from './shouldRefresh';
 import { Reporter } from './reporter';
@@ -61,7 +61,7 @@ export async function getFreshValue<Value>(
   try {
     const write = shouldRefresh(metadata) !== 'now';
     if (write) {
-      await cache.set(key, { metadata, value });
+      await cache.set(key, createCacheEntry(value, metadata));
     }
     report({
       name: 'writeFreshValueSuccess',

src/index.ts

@@ -7,7 +7,7 @@ export type {
   GetFreshValue,
   GetFreshValueContext,
 } from './common';
-export { staleWhileRevalidate, totalTtl } from './common';
+export { staleWhileRevalidate, totalTtl, createCacheEntry } from './common';
 export * from './reporter';
 export * from './adapters';
 export { createBatch } from './createBatch';

src/reporter.spec.ts

@@ -1,5 +1,10 @@
-import { cachified, CacheEntry, verboseReporter } from './index';
-import { createCacheEntry, delay, prettyPrint } from './testHelpers';
+import {
+  cachified,
+  CacheEntry,
+  verboseReporter,
+  createCacheEntry,
+} from './index';
+import { delay, prettyPrint } from './testHelpers';
 
 jest.mock('./index', () => {
   if (process.version.startsWith('v18')) {

src/testHelpers.ts

@@ -26,16 +26,6 @@ export function delay(ms: number) {
   return new Promise((res) => setTimeout(res, ms));
 }
 
-export function createCacheEntry<Value>(
-  value: Value,
-  metadata: Partial<CacheMetadata> = {},
-): CacheEntry<Value> {
-  return {
-    value,
-    metadata: { createdTime: Date.now(), ttl: null, swr: 0, ...metadata },
-  };
-}
-
 export function report(calls: [event: CacheEvent<any>][]) {
   const totalCalls = String(calls.length + 1).length;
   return calls