@keq-request/cache 5.0.0-alpha.24 → 5.0.0-alpha.25

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 5.0.0-alpha.25
+
+### Minor Changes
+
+- d1090d3: **Feat:** add debug logs and Server-Timing header.
+
+### Patch Changes
+
+- Updated dependencies [214ae66]
+- Updated dependencies [9290139]
+  - keq@5.0.0-alpha.25
+
 ## 5.0.0-alpha.24
 
 ### Patch Changes

package/dist/cache.d.ts

@@ -1,8 +1,7 @@
 import type { Keq, KeqMiddleware, KeqContext } from 'keq';
 import { KeqCacheStorage } from './storage/keq-cache-storage.js';
-import { RequestCacheOptions } from './request-cache-handler/index.js';
-import { KeqCacheKeyFactory, KeqCacheRule } from './types/index.js';
-export interface KeqCacheOptions {
+import { KeqCacheKeyFactory, KeqCacheRule, RequestCacheOptions } from './types/index.js';
+export interface KeqCacheOptions extends Pick<RequestCacheOptions, 'serverTiming'> {
     storage: KeqCacheStorage;
     /**
      * Cache Key Factory

package/dist/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,mBAAmB,EAAuB,MAAM,kCAAkC,CAAA;AAC3F,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAGnE,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,eAAe,CAAA;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAE/B,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CACvB;AAGD,OAAO,QAAQ,KAAK,CAAC;IACnB,UAAiB,oBAAoB,CAAC,EAAE;QACtC;;WAEG;QACH,KAAK,CAAC,MAAM,EAAE,mBAAmB,GAAG,KAAK,GAAG,GAAG,CAAC,EAAE,CAAC,CAAA;KACpD;IAED,UAAiB,SAAS;QACxB,WAAW,EAAE;YACX,GAAG,EAAE,MAAM,CAAA;YACX,QAAQ,EAAE,QAAQ,CAAA;YAClB,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;QAED,YAAY,EAAE;YACZ,GAAG,EAAE,MAAM,CAAA;YACX,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;QAED,cAAc,EAAE;YACd,GAAG,EAAE,MAAM,CAAA;YACX,WAAW,CAAC,EAAE,QAAQ,CAAA;YACtB,WAAW,EAAE,QAAQ,CAAA;YACrB,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;KACF;CACF;AAGD,wBAAgB,KAAK,CAAC,OAAO,EAAE,eAAe,GAAG,aAAa,CAuC7D"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAEhE,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAGxF,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC;IAChF,OAAO,EAAE,eAAe,CAAA;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAE/B,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CACvB;AAGD,OAAO,QAAQ,KAAK,CAAC;IACnB,UAAiB,oBAAoB,CAAC,EAAE;QACtC;;WAEG;QACH,KAAK,CAAC,MAAM,EAAE,mBAAmB,GAAG,KAAK,GAAG,GAAG,CAAC,EAAE,CAAC,CAAA;KACpD;IAED,UAAiB,SAAS;QACxB,WAAW,EAAE;YACX,GAAG,EAAE,MAAM,CAAA;YACX,QAAQ,EAAE,QAAQ,CAAA;YAClB,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;QAED,YAAY,EAAE;YACZ,GAAG,EAAE,MAAM,CAAA;YACX,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;QAED,cAAc,EAAE;YACd,GAAG,EAAE,MAAM,CAAA;YACX,WAAW,CAAC,EAAE,QAAQ,CAAA;YACtB,WAAW,EAAE,QAAQ,CAAA;YACrB,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;KACF;CACF;AAGD,wBAAgB,KAAK,CAAC,OAAO,EAAE,eAAe,GAAG,aAAa,CA4C7D"}

package/dist/index.js

@@ -92,9 +92,33 @@ var Size = /* @__PURE__ */ ((Size2) => {
   return Size2;
 })(Size || {});
 
+// src/utils/logger.ts
+var Logger = class {
+  static debug(...args) {
+    console.debug("[@keq-request/cache] [DEBUG] ", ...args);
+  }
+  static error(...args) {
+    console.error("[@keq-request/cache] [ERROR] ", ...args);
+  }
+};
+
+// src/utils/random.ts
+function random(min, max) {
+  return Math.floor(Math.random() * (max - min)) + min;
+}
+
 // src/strategies/cache-first.ts
 var cacheFirst = async function cacheFirst2(handler, context, next) {
   const [cacheKey, cacheValue] = await handler.getCache(context);
+  if (handler.options.debug) {
+    Logger.debug([
+      "",
+      "Request: ".concat(context.request.method.toUpperCase(), " ").concat(context.request.__url__.href),
+      "Strategy: Cache First",
+      "Cache Key: ".concat(cacheKey),
+      "Cache Status: ".concat(cacheValue ? "HIT" : "MISS")
+    ].join("\n"));
+  }
   if (cacheValue) {
     context.emitter.emit("cache:hit", { key: cacheKey, response: cacheValue.response, context });
     context.res = cacheValue.response;
@@ -103,6 +127,15 @@ var cacheFirst = async function cacheFirst2(handler, context, next) {
   context.emitter.emit("cache:miss", { key: cacheKey, context });
   await next();
   const [, entry] = await handler.setCache(context);
+  if (handler.options.debug) {
+    Logger.debug([
+      "",
+      "Request: ".concat(context.request.method.toUpperCase(), " ").concat(context.request.__url__.href),
+      "Strategy: Cache First",
+      "Cache Key: ".concat(cacheKey),
+      "ACTIONS: ".concat(entry ? "UPDATED" : "EXCLUDED")
+    ].join("\n"));
+  }
   if (entry) {
     context.emitter.emit("cache:update", {
       key: entry.key,
@@ -117,8 +150,17 @@ var cacheFirst = async function cacheFirst2(handler, context, next) {
 var networkFirst = async function networkFirst2(handler, context, next) {
   try {
     await next();
-    const [, cache2] = await handler.getCache(context);
+    const [cacheKey, cache2] = await handler.getCache(context);
     const [, entry] = await handler.setCache(context);
+    if (handler.options.debug) {
+      Logger.debug([
+        "",
+        "Request: ".concat(context.request.method.toUpperCase(), " ").concat(context.request.__url__.href),
+        "Strategy: Network First",
+        "Cache Key: ".concat(cacheKey),
+        "ACTIONS: ".concat(entry ? "UPDATED" : "EXCLUDED")
+      ].join("\n"));
+    }
     if (entry) {
       context.emitter.emit("cache:update", {
         key: entry.key,
@@ -128,12 +170,21 @@ var networkFirst = async function networkFirst2(handler, context, next) {
       });
     }
   } catch (err) {
-    const [key, cache2] = await handler.getCache(context);
+    const [cacheKey, cache2] = await handler.getCache(context);
+    if (handler.options.debug) {
+      Logger.debug([
+        "",
+        "Request: ".concat(context.request.method.toUpperCase(), " ").concat(context.request.__url__.href),
+        "Strategy: Network First",
+        "Cache Key: ".concat(cacheKey),
+        "Cache Status: ".concat(cache2 ? "HIT" : "MISS")
+      ].join("\n"));
+    }
     if (!cache2) {
-      context.emitter.emit("cache:miss", { key, context });
+      context.emitter.emit("cache:miss", { key: cacheKey, context });
       throw err;
     }
-    context.emitter.emit("cache:hit", { key, response: cache2.response, context });
+    context.emitter.emit("cache:hit", { key: cacheKey, response: cache2.response, context });
     context.res = cache2.response;
   }
 };
@@ -145,19 +196,41 @@ var networkOnly = async function(handler, context, next) {
 
 // src/strategies/stale-while-revalidate.ts
 var staleWhileRevalidate = async function(handler, context, next) {
-  const [key, cache2] = await handler.getCache(context);
+  const [cacheKey, cache2] = await handler.getCache(context);
+  if (handler.options.debug) {
+    Logger.debug([
+      "",
+      "Request: ".concat(context.request.method.toUpperCase(), " ").concat(context.request.__url__.href),
+      "Strategy: Stale While Revalidate",
+      "Cache Key: ".concat(cacheKey),
+      "Cache Status: ".concat(cache2 ? "HIT" : "MISS")
+    ].join("\n"));
+  }
+  if (cache2) {
+    context.emitter.emit("cache:hit", { key: cacheKey, response: cache2.response, context });
+  } else {
+    context.emitter.emit("cache:miss", { key: cacheKey, context });
+  }
   if (cache2) {
-    context.emitter.emit("cache:hit", { key, response: cache2.response, context });
     const orchestrator = context.orchestration.fork();
     context.res = cache2.response;
     setTimeout(async () => {
       try {
         await orchestrator.execute();
         const context2 = orchestrator.context;
-        const [, entry] = await handler.setCache(context2);
+        const [cacheKey2, entry] = await handler.setCache(context2);
+        if (handler.options.debug) {
+          Logger.debug([
+            "",
+            "Request: ".concat(context2.request.method.toUpperCase(), " ").concat(context2.request.__url__.href),
+            "Strategy: Stale While Revalidate",
+            "Cache Key: ".concat(cacheKey2),
+            "ACTIONS: ".concat(entry ? "UPDATED" : "EXCLUDED")
+          ].join("\n"));
+        }
         if (entry) {
           context2.emitter.emit("cache:update", {
-            key,
+            key: cacheKey2,
             oldResponse: cache2.response,
             newResponse: entry.response,
             context: context2
@@ -167,12 +240,20 @@ var staleWhileRevalidate = async function(handler, context, next) {
       }
     }, 1);
   } else {
-    context.emitter.emit("cache:miss", { key, context });
     await next();
-    const [, entry] = await handler.setCache(context);
+    const [cacheKey2, entry] = await handler.setCache(context);
+    if (handler.options.debug) {
+      Logger.debug([
+        "",
+        "Request: ".concat(context.request.method.toUpperCase(), " ").concat(context.request.__url__.href),
+        "Strategy: Stale While Revalidate",
+        "Cache Key: ".concat(cacheKey2),
+        "ACTIONS: ".concat(entry ? "UPDATED" : "EXCLUDED")
+      ].join("\n"));
+    }
     if (entry) {
       context.emitter.emit("cache:update", {
-        key,
+        key: cacheKey2,
         oldResponse: void 0,
         newResponse: entry.response,
         context
@@ -255,6 +336,15 @@ var RequestCacheHandler = class {
    */
   async getCache(context) {
     const key = this.getRequestCacheKey(context);
+    if (this.options.serverTiming) {
+      const startAt = /* @__PURE__ */ new Date();
+      const entry = await this.storage.get(key);
+      if (entry) {
+        const dur = (/* @__PURE__ */ new Date()).getTime() - startAt.getTime();
+        entry.response.headers.append("Server-Timing", "keq-cache; dur=".concat(dur, '; desc="HIT"'));
+      }
+      return [key, entry];
+    }
     return [key, await this.storage.get(key)];
   }
   /**
@@ -301,6 +391,9 @@ function cache(options) {
       await next();
       return;
     }
+    if (requestCacheOptions.serverTiming === void 0 && options.serverTiming !== void 0) {
+      requestCacheOptions.serverTiming = options.serverTiming;
+    }
     const handler = new RequestCacheHandler(storage, requestCacheOptions);
     const strategy = requestCacheOptions.strategy;
     await strategy(handler, ctx, next);
@@ -319,21 +412,6 @@ var R3 = __toESM(require("ramda"));
 var KeqCacheStorage = class {
 };
 
-// src/utils/logger.ts
-var Logger = class {
-  static debug(...args) {
-    console.debug("[@keq-cache] [DEBUG] ", ...args);
-  }
-  static error(...args) {
-    console.error("[@keq-cache] [ERROR] ", ...args);
-  }
-};
-
-// src/utils/random.ts
-function random(min, max) {
-  return Math.floor(Math.random() * (max - min)) + min;
-}
-
 // src/storage/internal-storage/internal-storage.ts
 var InternalStorage = class extends KeqCacheStorage {
   constructor(options) {