slonik-interceptor-query-cache 3.3.1 → 43.0.6

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# slonik-interceptor-query-cache
+
+## 43.0.6
+
+### Patch Changes
+
+- [#591](https://github.com/gajus/slonik/pull/591) [`30e89a6`](https://github.com/gajus/slonik/commit/30e89a6f2ab1fc8f9d010bb0157ce41aa4da80e8) Thanks [@gajus](https://github.com/gajus)! - add slonik-interceptor-query-cache to monorepo
+
+- Updated dependencies [[`30e89a6`](https://github.com/gajus/slonik/commit/30e89a6f2ab1fc8f9d010bb0157ce41aa4da80e8), [`30e89a6`](https://github.com/gajus/slonik/commit/30e89a6f2ab1fc8f9d010bb0157ce41aa4da80e8)]:
+  - slonik@43.0.6

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

@@ -1 +1 @@
-{"version":3,"file":"createQueryCacheInterceptor.d.ts","sourceRoot":"","sources":["../../src/factories/createQueryCacheInterceptor.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,cAAc,EACpB,MAAM,QAAQ,CAAC;AAYhB,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,GAAG,EAAE,CACH,KAAK,EAAE,KAAK,EACZ,eAAe,EAAE,eAAe,KAC7B,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;IACjD,GAAG,EAAE,CACH,KAAK,EAAE,KAAK,EACZ,eAAe,EAAE,eAAe,EAChC,WAAW,EAAE,WAAW,CAAC,cAAc,CAAC,KACrC,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAMF,eAAO,MAAM,2BAA2B,uBAClB,kBAAkB,KACrC,WAiFF,CAAC"}
+{"version":3,"file":"createQueryCacheInterceptor.d.ts","sourceRoot":"","sources":["../../src/factories/createQueryCacheInterceptor.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,cAAc,EACpB,MAAM,QAAQ,CAAC;AAYhB,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,GAAG,EAAE,CACH,KAAK,EAAE,KAAK,EACZ,eAAe,EAAE,eAAe,KAC7B,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;IACjD,GAAG,EAAE,CACH,KAAK,EAAE,KAAK,EACZ,eAAe,EAAE,eAAe,EAChC,WAAW,EAAE,WAAW,CAAC,cAAc,CAAC,KACrC,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAMF,eAAO,MAAM,2BAA2B,uBAClB,kBAAkB,KACrC,WAiFF,CAAC"}

package/dist/factories/createQueryCacheInterceptor.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createQueryCacheInterceptor = void 0;
 const Logger_1 = require("../Logger");
-const utilities_1 = require("../utilities");
+const extractCacheAttributes_1 = require("../utilities/extractCacheAttributes");
+const normalizeCacheAttributes_1 = require("../utilities/normalizeCacheAttributes");
 const log = Logger_1.Logger.child({
     namespace: 'createQueryCacheInterceptor',
 });
@@ -49,11 +50,11 @@ const createQueryCacheInterceptor = (configurationInput) => {
             if (context.transactionId) {
                 return null;
             }
-            const extractedCacheAttributes = (0, utilities_1.extractCacheAttributes)(query.sql, query.values);
+            const extractedCacheAttributes = (0, extractCacheAttributes_1.extractCacheAttributes)(query.sql, query.values);
             if (!extractedCacheAttributes) {
                 return null;
             }
-            const cacheAttributes = (0, utilities_1.normalizeCacheAttributes)(extractedCacheAttributes);
+            const cacheAttributes = (0, normalizeCacheAttributes_1.normalizeCacheAttributes)(extractedCacheAttributes);
             context.sandbox.cache = {
                 cacheAttributes,
             };

package/dist/factories/createQueryCacheInterceptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"createQueryCacheInterceptor.js","sourceRoot":"","sources":["../../src/factories/createQueryCacheInterceptor.ts"],"names":[],"mappings":";;;AAAA,sCAAmC;AACnC,4CAAgF;AAQhF,MAAM,GAAG,GAAG,eAAM,CAAC,KAAK,CAAC;IACvB,SAAS,EAAE,6BAA6B;CACzC,CAAC,CAAC;AAkCI,MAAM,2BAA2B,GAAG,CACzC,kBAAsC,EACzB,EAAE;IACf,MAAM,aAAa,GAAkB;QACnC,GAAG,kBAAkB;KACtB,CAAC;IAEF,OAAO;QACL,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAC7C,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,eAAe,GAAI,OAAO,CAAC,OAAmB,CAAC,KAAK;gBACxD,EAAE,eAAe,CAAC;YAEpB,IAAI,CAAC,eAAe,EAAE;gBACpB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,CACjD,KAAK,EACL,eAAe,CAChB,CAAC;YAEF,IAAI,WAAW,EAAE;gBACf,GAAG,CAAC,KAAK,CACP;oBACE,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB,EACD,4BAA4B,CAC7B,CAAC;gBAEF,OAAO,WAAW,CAAC;aACpB;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QACD,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;YAClD,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,eAAe,GAAI,OAAO,CAAC,OAAmB,CAAC,KAAK;gBACxD,EAAE,eAAe,CAAC;YAEpB,IAAI,eAAe,EAAE;gBACnB,IAAI,eAAe,CAAC,YAAY,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE;oBACzD,GAAG,CAAC,KAAK,CACP,wEAAwE,CACzE,CAAC;iBACH;qBAAM;oBACL,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;iBACjE;aACF;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QACD,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAC7C,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,wBAAwB,GAAG,IAAA,kCAAsB,EACrD,KAAK,CAAC,GAAG,EACT,KAAK,CAAC,MAAM,CACb,CAAC;YAEF,IAAI,CAAC,wBAAwB,EAAE;gBAC7B,OAAO,IAAI,CAAC;aACb;YAED,MAAM,eAAe,GAAG,IAAA,oCAAwB,EAC9C,wBAAwB,CACzB,CAAC;YAEF,OAAO,CAAC,OAAO,CAAC,KAAK,GAAG;gBACtB,eAAe;aAChB,CAAC;YAEF,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAnFW,QAAA,2BAA2B,+BAmFtC"}
+{"version":3,"file":"createQueryCacheInterceptor.js","sourceRoot":"","sources":["../../src/factories/createQueryCacheInterceptor.ts"],"names":[],"mappings":";;;AAAA,sCAAmC;AACnC,gFAA6E;AAC7E,oFAAiF;AAQjF,MAAM,GAAG,GAAG,eAAM,CAAC,KAAK,CAAC;IACvB,SAAS,EAAE,6BAA6B;CACzC,CAAC,CAAC;AAkCI,MAAM,2BAA2B,GAAG,CACzC,kBAAsC,EACzB,EAAE;IACf,MAAM,aAAa,GAAkB;QACnC,GAAG,kBAAkB;KACtB,CAAC;IAEF,OAAO;QACL,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAC7C,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,eAAe,GAAI,OAAO,CAAC,OAAmB,CAAC,KAAK;gBACxD,EAAE,eAAe,CAAC;YAEpB,IAAI,CAAC,eAAe,EAAE;gBACpB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,CACjD,KAAK,EACL,eAAe,CAChB,CAAC;YAEF,IAAI,WAAW,EAAE;gBACf,GAAG,CAAC,KAAK,CACP;oBACE,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB,EACD,4BAA4B,CAC7B,CAAC;gBAEF,OAAO,WAAW,CAAC;aACpB;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QACD,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;YAClD,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,eAAe,GAAI,OAAO,CAAC,OAAmB,CAAC,KAAK;gBACxD,EAAE,eAAe,CAAC;YAEpB,IAAI,eAAe,EAAE;gBACnB,IAAI,eAAe,CAAC,YAAY,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE;oBACzD,GAAG,CAAC,KAAK,CACP,wEAAwE,CACzE,CAAC;iBACH;qBAAM;oBACL,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;iBACjE;aACF;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QACD,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAC7C,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,wBAAwB,GAAG,IAAA,+CAAsB,EACrD,KAAK,CAAC,GAAG,EACT,KAAK,CAAC,MAAM,CACb,CAAC;YAEF,IAAI,CAAC,wBAAwB,EAAE;gBAC7B,OAAO,IAAI,CAAC;aACb;YAED,MAAM,eAAe,GAAG,IAAA,mDAAwB,EAC9C,wBAAwB,CACzB,CAAC;YAEF,OAAO,CAAC,OAAO,CAAC,KAAK,GAAG;gBACtB,eAAe;aAChB,CAAC;YAEF,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAnFW,QAAA,2BAA2B,+BAmFtC"}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { createQueryCacheInterceptor } from './factories';
+export { createQueryCacheInterceptor } from './factories/createQueryCacheInterceptor';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createQueryCacheInterceptor = void 0;
-var factories_1 = require("./factories");
-Object.defineProperty(exports, "createQueryCacheInterceptor", { enumerable: true, get: function () { return factories_1.createQueryCacheInterceptor; } });
+var createQueryCacheInterceptor_1 = require("./factories/createQueryCacheInterceptor");
+Object.defineProperty(exports, "createQueryCacheInterceptor", { enumerable: true, get: function () { return createQueryCacheInterceptor_1.createQueryCacheInterceptor; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAA0D;AAAjD,wHAAA,2BAA2B,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uFAAsF;AAA7E,0IAAA,2BAA2B,OAAA"}

package/package.json

@@ -16,55 +16,47 @@
     ]
   },
   "dependencies": {
-    "roarr": "^7.14.0",
+    "roarr": "^7.21.1",
     "strip-comments": "^2.0.1"
   },
-  "description": "Cache Slonik query results.",
+  "description": "Logs Slonik queries.",
   "devDependencies": {
-    "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@semantic-release/commit-analyzer": "^9.0.2",
-    "@semantic-release/github": "^8.0.7",
-    "@semantic-release/npm": "^9.0.2",
-    "ava": "^3.15.0",
-    "coveralls": "^3.1.1",
-    "eslint": "^8.39.0",
-    "eslint-config-canonical": "^41.0.3",
-    "husky": "^8.0.0",
-    "inline-loops.macro": "^1.2.2",
-    "nyc": "^15.1.0",
-    "semantic-release": "^20.1.3",
-    "sinon": "^12.0.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "ava": "^5.3.1",
+    "eslint": "^8.57.0",
+    "eslint-config-canonical": "^42.8.1",
+    "slonik": "^43.0.6",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.3"
   },
   "engines": {
-    "node": ">=16.0"
+    "node": ">=18"
   },
-  "files": [
-    "dist"
-  ],
   "keywords": [
     "postgresql",
     "interceptor",
-    "format"
+    "logging"
   ],
   "license": "BSD-3-Clause",
   "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "name": "slonik-interceptor-query-cache",
   "peerDependencies": {
-    "slonik": ">=27.0.0"
+    "slonik": ">=43.0.6"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/gajus/slonik-interceptor-query-cache"
+    "url": "https://github.com/gajus/slonik"
   },
   "scripts": {
-    "build": "rm -fr ./dist && tsc --project tsconfig.build.json",
-    "lint:eslint": "eslint .",
-    "lint:tsc": "tsc",
-    "prepare": "husky install",
-    "test:ava": "nyc ava --verbose --serial"
+    "build": "rm -fr ./dist && tsc",
+    "lint": "eslint ./src && tsc --noEmit",
+    "test": "ava --verbose --serial"
   },
-  "types": "./dist/index.d.ts",
-  "version": "3.3.1"
+  "typings": "./dist/index.d.ts",
+  "version": "43.0.6"
 }

package/src/.eslintrc

@@ -0,0 +1,26 @@
+{
+  "extends": "canonical/auto",
+  "ignorePatterns": [
+    "dist",
+    "package-lock.json"
+  ],
+  "overrides": [
+    {
+      "files": "*.ts",
+      "rules": {
+        "import/no-cycle": 0,
+        "no-restricted-imports": ["error", "pg"]
+      }
+    },
+    {
+      "files": ["*.test.ts", "**/*.test/*"],
+      "extends": "canonical/ava",
+      "rules": {
+        "@typescript-eslint/no-explicit-any": 0,
+        "@typescript-eslint/no-unused-expressions": 0,
+        "ava/no-ignored-test-files": 0
+      }
+    }
+  ],
+  "root": true
+}

package/src/Logger.ts

@@ -0,0 +1,5 @@
+import { Roarr } from 'roarr';
+
+export const Logger = Roarr.child({
+  package: 'slonik-interceptor-query-cache',
+});

package/src/factories/createQueryCacheInterceptor.ts

@@ -0,0 +1,130 @@
+import { Logger } from '../Logger';
+import { extractCacheAttributes } from '../utilities/extractCacheAttributes';
+import { normalizeCacheAttributes } from '../utilities/normalizeCacheAttributes';
+import {
+  type Interceptor,
+  type Query,
+  type QueryResult,
+  type QueryResultRow,
+} from 'slonik';
+
+const log = Logger.child({
+  namespace: 'createQueryCacheInterceptor',
+});
+
+type Sandbox = {
+  cache: {
+    cacheAttributes: CacheAttributes;
+  };
+};
+
+export type CacheAttributes = {
+  discardEmpty: boolean;
+  key: string;
+  ttl: number;
+};
+
+type Storage = {
+  get: (
+    query: Query,
+    cacheAttributes: CacheAttributes,
+  ) => Promise<QueryResult<QueryResultRow> | null>;
+  set: (
+    query: Query,
+    cacheAttributes: CacheAttributes,
+    queryResult: QueryResult<QueryResultRow>,
+  ) => Promise<void>;
+};
+
+type ConfigurationInput = {
+  storage: Storage;
+};
+
+type Configuration = {
+  storage: Storage;
+};
+
+export const createQueryCacheInterceptor = (
+  configurationInput: ConfigurationInput,
+): Interceptor => {
+  const configuration: Configuration = {
+    ...configurationInput,
+  };
+
+  return {
+    beforeQueryExecution: async (context, query) => {
+      if (context.transactionId) {
+        return null;
+      }
+
+      const cacheAttributes = (context.sandbox as Sandbox).cache
+        ?.cacheAttributes;
+
+      if (!cacheAttributes) {
+        return null;
+      }
+
+      const maybeResult = await configuration.storage.get(
+        query,
+        cacheAttributes,
+      );
+
+      if (maybeResult) {
+        log.debug(
+          {
+            queryId: context.queryId,
+          },
+          'query is served from cache',
+        );
+
+        return maybeResult;
+      }
+
+      return null;
+    },
+    beforeQueryResult: async (context, query, result) => {
+      if (context.transactionId) {
+        return null;
+      }
+
+      const cacheAttributes = (context.sandbox as Sandbox).cache
+        ?.cacheAttributes;
+
+      if (cacheAttributes) {
+        if (cacheAttributes.discardEmpty && result.rowCount === 0) {
+          log.debug(
+            '@cache-discard-empty is set and the query result is empty; not caching',
+          );
+        } else {
+          await configuration.storage.set(query, cacheAttributes, result);
+        }
+      }
+
+      return null;
+    },
+    beforeTransformQuery: async (context, query) => {
+      if (context.transactionId) {
+        return null;
+      }
+
+      const extractedCacheAttributes = extractCacheAttributes(
+        query.sql,
+        query.values,
+      );
+
+      if (!extractedCacheAttributes) {
+        return null;
+      }
+
+      const cacheAttributes = normalizeCacheAttributes(
+        extractedCacheAttributes,
+      );
+
+      context.sandbox.cache = {
+        cacheAttributes,
+      };
+
+      return null;
+    },
+  };
+};

package/src/index.ts

@@ -0,0 +1 @@
+export { createQueryCacheInterceptor } from './factories/createQueryCacheInterceptor';

package/src/utilities/extractCacheAttributes.test.ts

@@ -0,0 +1,92 @@
+import { extractCacheAttributes } from './extractCacheAttributes';
+import test from 'ava';
+
+test('returns null when query does not contain cache attributes', (t) => {
+  t.is(extractCacheAttributes('', []), null);
+});
+
+test('extracts @cache-ttl', (t) => {
+  t.deepEqual(extractCacheAttributes('-- @cache-ttl 60', []), {
+    bodyHash: '46b9dd2b0ba88d13233b3feb',
+    discardEmpty: false,
+    key: 'query:$bodyHash:$valueHash',
+    ttl: 60,
+    valueHash: 'ec784925b52067bce01fd820',
+  });
+});
+
+test('extracts @cache-discard-empty', (t) => {
+  t.deepEqual(
+    extractCacheAttributes(
+      '-- @cache-ttl 60\n-- @cache-discard-empty false',
+      [],
+    ),
+    {
+      bodyHash: '46b9dd2b0ba88d13233b3feb',
+      discardEmpty: false,
+      key: 'query:$bodyHash:$valueHash',
+      ttl: 60,
+      valueHash: 'ec784925b52067bce01fd820',
+    },
+  );
+
+  t.deepEqual(
+    extractCacheAttributes(
+      '-- @cache-ttl 60\n-- @cache-discard-empty true',
+      [],
+    ),
+    {
+      bodyHash: '46b9dd2b0ba88d13233b3feb',
+      discardEmpty: true,
+      key: 'query:$bodyHash:$valueHash',
+      ttl: 60,
+      valueHash: 'ec784925b52067bce01fd820',
+    },
+  );
+});
+
+test('computes the parameter value hash', (t) => {
+  t.deepEqual(extractCacheAttributes('-- @cache-ttl 60', [1]), {
+    bodyHash: '46b9dd2b0ba88d13233b3feb',
+    discardEmpty: false,
+    key: 'query:$bodyHash:$valueHash',
+    ttl: 60,
+    valueHash: '62eb54746ae2932850f8d6ff',
+  });
+});
+
+test('computes the body hash; white spaces do not affect the body hash', (t) => {
+  t.deepEqual(extractCacheAttributes('-- @cache-ttl 60\nSELECT 1', []), {
+    bodyHash: '553ebdb024592064ca4c2c3a',
+    discardEmpty: false,
+    key: 'query:$bodyHash:$valueHash',
+    ttl: 60,
+    valueHash: 'ec784925b52067bce01fd820',
+  });
+
+  t.deepEqual(extractCacheAttributes('-- @cache-ttl 60\n\nSELECT 1', []), {
+    bodyHash: '553ebdb024592064ca4c2c3a',
+    discardEmpty: false,
+    key: 'query:$bodyHash:$valueHash',
+    ttl: 60,
+    valueHash: 'ec784925b52067bce01fd820',
+  });
+});
+
+test('computes the body hash; comments do not affect the body hash', (t) => {
+  t.deepEqual(extractCacheAttributes('-- @cache-ttl 60\nSELECT 1', []), {
+    bodyHash: '553ebdb024592064ca4c2c3a',
+    discardEmpty: false,
+    key: 'query:$bodyHash:$valueHash',
+    ttl: 60,
+    valueHash: 'ec784925b52067bce01fd820',
+  });
+
+  t.deepEqual(extractCacheAttributes('-- @cache-ttl 120\nSELECT 1', []), {
+    bodyHash: '553ebdb024592064ca4c2c3a',
+    discardEmpty: false,
+    key: 'query:$bodyHash:$valueHash',
+    ttl: 120,
+    valueHash: 'ec784925b52067bce01fd820',
+  });
+});

package/src/utilities/extractCacheAttributes.ts

@@ -0,0 +1,56 @@
+import { createHash } from 'node:crypto';
+import { type PrimitiveValueExpression } from 'slonik';
+import stripComments from 'strip-comments';
+
+const hash = (subject: string) => {
+  return createHash('shake256', {
+    outputLength: 12,
+  })
+    .update(subject)
+    .digest('hex');
+};
+
+export type ExtractedCacheAttributes = {
+  bodyHash: string;
+  discardEmpty: boolean;
+  key: string;
+  ttl: number;
+  valueHash: string;
+};
+
+// TODO throw an error if an unknown attribute is used
+export const extractCacheAttributes = (
+  subject: string,
+  values: readonly PrimitiveValueExpression[],
+): ExtractedCacheAttributes | null => {
+  const ttl = /-- @cache-ttl (\d+)/u.exec(subject)?.[1];
+
+  // https://github.com/jonschlinkert/strip-comments/issues/71
+  const bodyHash = hash(
+    stripComments(subject)
+      .replaceAll(/^\s*--.*$/gmu, '')
+      .replaceAll(/\s/gu, ''),
+  );
+
+  const discardEmpty =
+    (/-- @cache-discard-empty (true|false)/u.exec(subject)?.[1] ?? 'false') ===
+    'true';
+
+  const valueHash = hash(JSON.stringify(values));
+
+  if (ttl) {
+    const key =
+      /-- @cache-key ([$\w\-:/]+)/iu.exec(subject)?.[1] ??
+      'query:$bodyHash:$valueHash';
+
+    return {
+      bodyHash,
+      discardEmpty,
+      key,
+      ttl: Number(ttl),
+      valueHash,
+    };
+  }
+
+  return null;
+};

package/src/utilities/normalizeCacheAttributes.test.ts

@@ -0,0 +1,19 @@
+import { normalizeCacheAttributes } from './normalizeCacheAttributes';
+import test from 'ava';
+
+test('replaces $bodyHash and $valueHash', (t) => {
+  t.deepEqual(
+    normalizeCacheAttributes({
+      bodyHash: 'foo',
+      discardEmpty: false,
+      key: '$bodyHash:$valueHash',
+      ttl: 60,
+      valueHash: 'bar',
+    }),
+    {
+      discardEmpty: false,
+      key: 'foo:bar',
+      ttl: 60,
+    },
+  );
+});

package/src/utilities/normalizeCacheAttributes.ts

@@ -0,0 +1,14 @@
+import { type CacheAttributes } from '../factories/createQueryCacheInterceptor';
+import { type ExtractedCacheAttributes } from './extractCacheAttributes';
+
+export const normalizeCacheAttributes = (
+  extractedCacheAttributes: ExtractedCacheAttributes,
+): CacheAttributes => {
+  return {
+    discardEmpty: extractedCacheAttributes.discardEmpty,
+    key: extractedCacheAttributes.key
+      .replaceAll('$bodyHash', extractedCacheAttributes.bodyHash)
+      .replaceAll('$valueHash', extractedCacheAttributes.valueHash),
+    ttl: extractedCacheAttributes.ttl,
+  };
+};

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "lib": [
+      "es2021"
+    ],
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noImplicitAny": false,
+    "noImplicitReturns": true,
+    "outDir": "dist",
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "es2020",
+    "useUnknownInCatchVariables": false
+  },
+  "include": [
+    "src"
+  ]
+}

package/LICENSE

@@ -1,24 +0,0 @@
-Copyright (c) 2023, Gajus Kuizinas (https://gajus.com/)
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of the Gajus Kuizinas (https://gajus.com/) nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL GAJUS KUIZINAS BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/factories/createQueryContext.d.ts

@@ -1,4 +0,0 @@
-import { type QueryContext } from 'slonik';
-declare const _default: () => QueryContext;
-export default _default;
-//# sourceMappingURL=createQueryContext.d.ts.map

package/dist/factories/createQueryContext.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createQueryContext.d.ts","sourceRoot":"","sources":["../../src/factories/createQueryContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;;AAE3C,wBAaE"}

package/dist/factories/createQueryContext.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = () => {
-    return {
-        connectionId: '1',
-        log: {
-            getContext: () => {
-                return {
-                    connectionId: '1',
-                    poolId: '1',
-                };
-            },
-        },
-        poolId: '1',
-    };
-};
-//# sourceMappingURL=createQueryContext.js.map

package/dist/factories/createQueryContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createQueryContext.js","sourceRoot":"","sources":["../../src/factories/createQueryContext.ts"],"names":[],"mappings":";;AAEA,kBAAe,GAAG,EAAE;IAClB,OAAO;QACL,YAAY,EAAE,GAAG;QACjB,GAAG,EAAE;YACH,UAAU,EAAE,GAAG,EAAE;gBACf,OAAO;oBACL,YAAY,EAAE,GAAG;oBACjB,MAAM,EAAE,GAAG;iBACZ,CAAC;YACJ,CAAC;SACF;QACD,MAAM,EAAE,GAAG;KACe,CAAC;AAC/B,CAAC,CAAC"}

package/dist/factories/index.d.ts

@@ -1,2 +0,0 @@
-export { createQueryCacheInterceptor } from './createQueryCacheInterceptor';
-//# sourceMappingURL=index.d.ts.map

package/dist/factories/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/factories/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/factories/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createQueryCacheInterceptor = void 0;
-var createQueryCacheInterceptor_1 = require("./createQueryCacheInterceptor");
-Object.defineProperty(exports, "createQueryCacheInterceptor", { enumerable: true, get: function () { return createQueryCacheInterceptor_1.createQueryCacheInterceptor; } });
-//# sourceMappingURL=index.js.map

package/dist/factories/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/factories/index.ts"],"names":[],"mappings":";;;AAAA,6EAA4E;AAAnE,0IAAA,2BAA2B,OAAA"}

package/dist/utilities/index.d.ts

@@ -1,3 +0,0 @@
-export { extractCacheAttributes } from './extractCacheAttributes';
-export { normalizeCacheAttributes } from './normalizeCacheAttributes';
-//# sourceMappingURL=index.d.ts.map

package/dist/utilities/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utilities/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/utilities/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeCacheAttributes = exports.extractCacheAttributes = void 0;
-var extractCacheAttributes_1 = require("./extractCacheAttributes");
-Object.defineProperty(exports, "extractCacheAttributes", { enumerable: true, get: function () { return extractCacheAttributes_1.extractCacheAttributes; } });
-var normalizeCacheAttributes_1 = require("./normalizeCacheAttributes");
-Object.defineProperty(exports, "normalizeCacheAttributes", { enumerable: true, get: function () { return normalizeCacheAttributes_1.normalizeCacheAttributes; } });
-//# sourceMappingURL=index.js.map

package/dist/utilities/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utilities/index.ts"],"names":[],"mappings":";;;AAAA,mEAAkE;AAAzD,gIAAA,sBAAsB,OAAA;AAC/B,uEAAsE;AAA7D,oIAAA,wBAAwB,OAAA"}