slonik-interceptor-query-cache 2.1.0 → 2.3.0

package/README.md

@@ -14,11 +14,17 @@ Query cache interceptor is initialised using a custom storage service. The [Exam
 
 Which queries are cached is controlled using cache attributes. Cache attributes are comments starting with `-- @cache-` prefix. Only queries with cache attributes are cached (see [Cache attributes](#cache-attributes))
 
+## Behavior
+
+* Does not cache queries inside of a transaction.
+
 ## Cache attributes
 
 |Cache attribute|Description|Required?|Default|
 |---|---|---|---|
 |`@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
 
@@ -39,19 +45,16 @@ const nodeCache = new NodeCache({
   useClones: false,
 });
 
-const hashQuery = (query: QueryType): string => {
-  return JSON.stringify(query);
-};
-
 const pool = await createPool('postgres://', {
   interceptors: [
     createQueryCacheInterceptor({
       storage: {
-        get: (query) => {
-          return cache.get(hashQuery(query)) || null;
+        get: (query, cacheAttributes) => {
+          // Returning null results in the query being executed.
+          return cache.get(cacheAttributes.key) || null;
         },
         set: (query, cacheAttributes, queryResult) => {
-          cache.set(hashQuery(query), queryResult, cacheAttributes.ttl);
+          cache.set(cacheAttributes.key, queryResult, cacheAttributes.ttl);
         },
       },
     }),
@@ -60,6 +63,7 @@ const pool = await createPool('postgres://', {
 
 await connection.any(sql`
   -- @cache-ttl 60
+  -- @cache-key foo
   SELECT
     id,
     code_alpha_2
@@ -67,4 +71,4 @@ await connection.any(sql`
   WHERE
     code_alpha_2 = ${countryCode}
 `);
-```
+```

package/dist/src/factories/createQueryCacheInterceptor.d.ts

@@ -1,5 +1,6 @@
 import type { Interceptor, Query, QueryResultRow, QueryResult } from 'slonik';
 declare type CacheAttributes = {
+    key: string;
     ttl: number;
 };
 declare type Storage = {

package/dist/src/factories/createQueryCacheInterceptor.js

@@ -13,6 +13,9 @@ const createQueryCacheInterceptor = (configurationInput) => {
     return {
         beforeQueryExecution: async (context, query) => {
             var _a;
+            if (context.transactionId) {
+                return null;
+            }
             const cacheAttributes = (_a = context.sandbox.cache) === null || _a === void 0 ? void 0 : _a.cacheAttributes;
             if (!cacheAttributes) {
                 return null;
@@ -28,6 +31,9 @@ const createQueryCacheInterceptor = (configurationInput) => {
         },
         beforeQueryResult: async (context, query, result) => {
             var _a;
+            if (context.transactionId) {
+                return null;
+            }
             const cacheAttributes = (_a = context.sandbox.cache) === null || _a === void 0 ? void 0 : _a.cacheAttributes;
             if (cacheAttributes) {
                 await configuration.storage.set(query, cacheAttributes, result);
@@ -35,7 +41,10 @@ const createQueryCacheInterceptor = (configurationInput) => {
             return null;
         },
         beforeTransformQuery: async (context, query) => {
-            const cacheAttributes = (0, utilities_1.extractCacheAttributes)(query.sql);
+            if (context.transactionId) {
+                return null;
+            }
+            const cacheAttributes = (0, utilities_1.extractCacheAttributes)(query.sql, query.values);
             if (!cacheAttributes) {
                 return null;
             }

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

@@ -1,3 +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,11 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractCacheAttributes = void 0;
-const extractCacheAttributes = (subject) => {
-    const matches = /-- @cache-ttl (\d+)/u.exec(subject);
-    if (matches) {
+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) {
+        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)) {
+            key += ':' + (0, node_crypto_1.createHash)('sha256').update(JSON.stringify(values)).digest('hex');
+        }
         return {
-            ttl: Number(matches[1]),
+            key,
+            ttl: Number(ttl),
         };
     }
     return null;

package/package.json

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

package/src/factories/createQueryCacheInterceptor.ts

@@ -22,6 +22,7 @@ type Sandbox = {
 };
 
 type CacheAttributes = {
+  key: string,
   ttl: number,
 };
 
@@ -45,6 +46,10 @@ export const createQueryCacheInterceptor = (configurationInput: ConfigurationInp
 
   return {
     beforeQueryExecution: async (context, query) => {
+      if (context.transactionId) {
+        return null;
+      }
+
       const cacheAttributes = (context.sandbox as Sandbox).cache?.cacheAttributes;
 
       if (!cacheAttributes) {
@@ -64,6 +69,10 @@ export const createQueryCacheInterceptor = (configurationInput: ConfigurationInp
       return null;
     },
     beforeQueryResult: async (context, query, result) => {
+      if (context.transactionId) {
+        return null;
+      }
+
       const cacheAttributes = (context.sandbox as Sandbox).cache?.cacheAttributes;
 
       if (cacheAttributes) {
@@ -73,7 +82,11 @@ export const createQueryCacheInterceptor = (configurationInput: ConfigurationInp
       return null;
     },
     beforeTransformQuery: async (context, query) => {
-      const cacheAttributes = extractCacheAttributes(query.sql);
+      if (context.transactionId) {
+        return null;
+      }
+
+      const cacheAttributes = extractCacheAttributes(query.sql, query.values);
 
       if (!cacheAttributes) {
         return null;

package/src/utilities/extractCacheAttributes.ts

@@ -1,9 +1,27 @@
-export const extractCacheAttributes = (subject: string) => {
-  const matches = /-- @cache-ttl (\d+)/u.exec(subject);
+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) {
+    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)) {
+      key += ':' + createHash('sha256').update(JSON.stringify(values)).digest('hex');
+    }
 
-  if (matches) {
     return {
-      ttl: Number(matches[1]),
+      key,
+      ttl: Number(ttl),
     };
   }