slonik-interceptor-query-cache 2.2.0 → 2.4.0

package/README.md

@@ -17,7 +17,6 @@ Which queries are cached is controlled using cache attributes. Cache attributes
 ## Behavior
 
 * Does not cache queries inside of a transaction.
-* Does not take into account the query parameters.
 
 ## Cache attributes
 
@@ -25,6 +24,7 @@ Which queries are cached is controlled using cache attributes. Cache attributes
 |---|---|---|---|
 |`@cache-ttl`|Number (in seconds) to cache the query for.|Yes|N/A|
 |`@cache-key`|Key (`/^[A-Za-z0-9\-_:]+$/`) that uniquely identifies the query.|Yes|N/A|
+|`@cache-hash-values`|Sets this value to `false` to ignore values and only use `@cache-key`.|No|`true`|
 
 ### Example usage
 

package/dist/src/factories/createQueryCacheInterceptor.js

@@ -44,7 +44,7 @@ const createQueryCacheInterceptor = (configurationInput) => {
             if (context.transactionId) {
                 return null;
             }
-            const cacheAttributes = (0, utilities_1.extractCacheAttributes)(query.sql);
+            const cacheAttributes = (0, utilities_1.extractCacheAttributes)(query.sql, query.values);
             if (!cacheAttributes) {
                 return null;
             }

package/dist/src/utilities/extractCacheAttributes.d.ts

@@ -1,4 +1,5 @@
-export declare const extractCacheAttributes: (subject: string) => {
+import type { PrimitiveValueExpression } from 'slonik';
+export declare const extractCacheAttributes: (subject: string, values: readonly PrimitiveValueExpression[]) => {
     key: string;
     ttl: number;
 } | null;

package/dist/src/utilities/extractCacheAttributes.js

@@ -1,14 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractCacheAttributes = void 0;
-const extractCacheAttributes = (subject) => {
+const node_crypto_1 = require("node:crypto");
+const extractCacheAttributes = (subject, values) => {
     var _a, _b;
     const ttl = (_a = /-- @cache-ttl (\d+)/u.exec(subject)) === null || _a === void 0 ? void 0 : _a[1];
     if (ttl) {
-        const key = (_b = /-- @cache-key ([a-zA-Z0-9\-_:/]+)/ui.exec(subject)) === null || _b === void 0 ? void 0 : _b[1];
+        let key = (_b = /-- @cache-key ([a-zA-Z0-9\-_:/]+)/ui.exec(subject)) === null || _b === void 0 ? void 0 : _b[1];
         if (!key) {
             throw new Error('@cache-key must be specified when @cache-ttl is specified.');
         }
+        if (!/-- @cache-hash-values false/ui.test(subject) && values.length > 0) {
+            key += ':' + (0, node_crypto_1.createHash)('sha256').update(JSON.stringify(values)).digest('hex');
+        }
         return {
             key,
             ttl: Number(ttl),

package/package.json

@@ -57,7 +57,7 @@
     "test": "NODE_ENV=test nyc ava --verbose --serial"
   },
   "typings": "./dist/src/index.d.ts",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "peerDependencies": {
     "slonik": ">=27.0.0"
   },

package/src/factories/createQueryCacheInterceptor.ts

@@ -86,7 +86,7 @@ export const createQueryCacheInterceptor = (configurationInput: ConfigurationInp
         return null;
       }
 
-      const cacheAttributes = extractCacheAttributes(query.sql);
+      const cacheAttributes = extractCacheAttributes(query.sql, query.values);
 
       if (!cacheAttributes) {
         return null;

package/src/utilities/extractCacheAttributes.ts

@@ -1,13 +1,24 @@
-export const extractCacheAttributes = (subject: string) => {
+import {
+  createHash,
+} from 'node:crypto';
+import type {
+  PrimitiveValueExpression,
+} from 'slonik';
+
+export const extractCacheAttributes = (subject: string, values: readonly PrimitiveValueExpression[]) => {
   const ttl = /-- @cache-ttl (\d+)/u.exec(subject)?.[1];
 
   if (ttl) {
-    const key = /-- @cache-key ([a-zA-Z0-9\-_:/]+)/ui.exec(subject)?.[1];
+    let key = /-- @cache-key ([a-zA-Z0-9\-_:/]+)/ui.exec(subject)?.[1];
 
     if (!key) {
       throw new Error('@cache-key must be specified when @cache-ttl is specified.');
     }
 
+    if (!/-- @cache-hash-values false/ui.test(subject) && values.length > 0) {
+      key += ':' + createHash('sha256').update(JSON.stringify(values)).digest('hex');
+    }
+
     return {
       key,
       ttl: Number(ttl),