slonik-interceptor-query-cache 2.4.0 → 3.0.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2022, Gajus Kuizinas (http://gajus.com/)
+Copyright (c) 2023, Gajus Kuizinas (https://gajus.com/)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -8,14 +8,14 @@ modification, are permitted provided that the following conditions are met:
     * 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 (http://gajus.com/) nor the
+    * 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 ANUARY BE LIABLE FOR ANY
+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

package/README.md

@@ -1,7 +1,5 @@
 # slonik-interceptor-query-cache
 
-[![Travis build status](http://img.shields.io/travis/gajus/slonik-interceptor-query-cache/master.svg?style=flat-square)](https://travis-ci.com/github/gajus/slonik-interceptor-query-cache)
-[![Coveralls](https://img.shields.io/coveralls/gajus/slonik-interceptor-query-cache.svg?style=flat-square)](https://coveralls.io/github/gajus/slonik-interceptor-query-cache)
 [![NPM version](http://img.shields.io/npm/v/slonik-interceptor-query-cache.svg?style=flat-square)](https://www.npmjs.org/package/slonik-interceptor-query-cache)
 [![Canonical Code Style](https://img.shields.io/badge/code%20style-canonical-blue.svg?style=flat-square)](https://github.com/gajus/canonical)
 [![Twitter Follow](https://img.shields.io/twitter/follow/kuizinas.svg?style=social&label=Follow)](https://twitter.com/kuizinas)
@@ -10,7 +8,7 @@ Caches [Slonik](https://github.com/gajus/slonik) query results.
 
 ## Usage
 
-Query cache interceptor is initialised using a custom storage service. The [Example Usage](#example-usage) documentation shows how to create a compatible storage service using [`node-cache`](https://www.npmjs.com/package/node-cache).
+Query cache interceptor is initialized using a custom storage service. The [Example Usage](#example-usage) documentation shows how to create a compatible storage service using [`node-cache`](https://www.npmjs.com/package/node-cache).
 
 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))
 
@@ -20,11 +18,11 @@ Which queries are cached is controlled using cache attributes. Cache attributes
 
 ## 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`|
+|Cache attribute|Description|Required?|Format|Default|
+|---|---|---|---|---|
+|`@cache-ttl`|Number (in seconds) to cache the query for.|Yes|`/^d+$/`|N/A|
+|`@cache-key`|Uniquelly identifies the query. Overrides the default cache key that uniquely identifies the query. If present, `$bodyHash` is substituted with the hash of the query (comments and white-spaces are stripped before hashing the query). `$valueHash` is substituted with the hash of the parameter values.|No|`/^[$A-Za-z0-9\-_:]+$/`|`$bodyHash:$valueHash`|
+|`@cache-discard-empty`|If set to `true`, then `storage.set` is not invoked when query produces no results.|No|`/^(false|true)$/`|`false`|
 
 ### Example usage
 
@@ -61,6 +59,30 @@ const pool = await createPool('postgres://', {
   ]
 });
 
+// Caches the query results based on a combination of the query hash and the parameter value hash.
+await connection.any(sql`
+  -- @cache-ttl 60
+  SELECT
+    id,
+    code_alpha_2
+  FROM country
+  WHERE
+    code_alpha_2 = ${countryCode}
+`);
+
+// Caches the query results based only on the parameter value hash.
+await connection.any(sql`
+  -- @cache-ttl 60
+  -- @cache-key $bodyHash
+  SELECT
+    id,
+    code_alpha_2
+  FROM country
+  WHERE
+    code_alpha_2 = ${countryCode}
+`);
+
+// Caches the query results using 'foo' key.
 await connection.any(sql`
   -- @cache-ttl 60
   -- @cache-key foo

package/dist/{src/Logger.d.ts → Logger.d.ts}

@@ -1 +1 @@
-export declare const Logger: import("roarr").Logger<import("roarr/dist/src/types").JsonObject>;
+export declare const Logger: import("roarr").Logger<import("roarr/dist/types").JsonObject>;

package/dist/{src/factories → factories}/createQueryCacheInterceptor.d.ts

@@ -1,13 +1,14 @@
-import type { Interceptor, Query, QueryResultRow, QueryResult } from 'slonik';
-declare type CacheAttributes = {
+import { type Interceptor, type Query, type QueryResult, type QueryResultRow } from 'slonik';
+export type CacheAttributes = {
+    discardEmpty: boolean;
     key: string;
     ttl: number;
 };
-declare type Storage = {
+type Storage = {
     get: (query: Query, cacheAttributes: CacheAttributes) => Promise<QueryResult<QueryResultRow> | null>;
     set: (query: Query, cacheAttributes: CacheAttributes, queryResult: QueryResult<QueryResultRow>) => Promise<void>;
 };
-declare type ConfigurationInput = {
+type ConfigurationInput = {
     storage: Storage;
 };
 export declare const createQueryCacheInterceptor: (configurationInput: ConfigurationInput) => Interceptor;

package/dist/{src/factories → factories}/createQueryCacheInterceptor.js

@@ -12,17 +12,17 @@ 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;
+            const cacheAttributes = context.sandbox.cache
+                ?.cacheAttributes;
             if (!cacheAttributes) {
                 return null;
             }
             const maybeResult = await configuration.storage.get(query, cacheAttributes);
             if (maybeResult) {
-                log.info({
+                log.debug({
                     queryId: context.queryId,
                 }, 'query is served from cache');
                 return maybeResult;
@@ -30,13 +30,18 @@ const createQueryCacheInterceptor = (configurationInput) => {
             return null;
         },
         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;
+            const cacheAttributes = context.sandbox.cache
+                ?.cacheAttributes;
             if (cacheAttributes) {
-                await configuration.storage.set(query, cacheAttributes, result);
+                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;
         },
@@ -44,10 +49,11 @@ const createQueryCacheInterceptor = (configurationInput) => {
             if (context.transactionId) {
                 return null;
             }
-            const cacheAttributes = (0, utilities_1.extractCacheAttributes)(query.sql, query.values);
-            if (!cacheAttributes) {
+            const extractedCacheAttributes = (0, utilities_1.extractCacheAttributes)(query.sql, query.values);
+            if (!extractedCacheAttributes) {
                 return null;
             }
+            const cacheAttributes = (0, utilities_1.normalizeCacheAttributes)(extractedCacheAttributes);
             context.sandbox.cache = {
                 cacheAttributes,
             };

package/dist/factories/createQueryContext.d.ts

@@ -0,0 +1,3 @@
+import { type QueryContext } from 'slonik';
+declare const _default: () => QueryContext;
+export default _default;

package/dist/factories/createQueryContext.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = () => {
+    return {
+        connectionId: '1',
+        log: {
+            getContext: () => {
+                return {
+                    connectionId: '1',
+                    poolId: '1',
+                };
+            },
+        },
+        poolId: '1',
+    };
+};

package/dist/factories/index.d.ts

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

package/dist/index.d.ts

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

package/dist/utilities/extractCacheAttributes.d.ts

@@ -0,0 +1,9 @@
+import { type PrimitiveValueExpression } from 'slonik';
+export type ExtractedCacheAttributes = {
+    bodyHash: string;
+    discardEmpty: boolean;
+    key: string;
+    ttl: number;
+    valueHash: string;
+};
+export declare const extractCacheAttributes: (subject: string, values: readonly PrimitiveValueExpression[]) => ExtractedCacheAttributes | null;

package/dist/utilities/extractCacheAttributes.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractCacheAttributes = void 0;
+const node_crypto_1 = require("node:crypto");
+const strip_comments_1 = __importDefault(require("strip-comments"));
+const hash = (subject) => {
+    return (0, node_crypto_1.createHash)('shake256', {
+        outputLength: 12,
+    })
+        .update(subject)
+        .digest('hex');
+};
+// TODO throw an error if an unknown attribute is used
+const extractCacheAttributes = (subject, values) => {
+    const ttl = /-- @cache-ttl (\d+)/u.exec(subject)?.[1];
+    // https://github.com/jonschlinkert/strip-comments/issues/71
+    const bodyHash = hash((0, strip_comments_1.default)(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;
+};
+exports.extractCacheAttributes = extractCacheAttributes;

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

@@ -0,0 +1 @@
+export {};

package/dist/utilities/extractCacheAttributes.test.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const extractCacheAttributes_1 = require("./extractCacheAttributes");
+const ava_1 = __importDefault(require("ava"));
+(0, ava_1.default)('returns null when query does not contain cache attributes', (t) => {
+    t.is((0, extractCacheAttributes_1.extractCacheAttributes)('', []), null);
+});
+(0, ava_1.default)('extracts @cache-ttl', (t) => {
+    t.deepEqual((0, extractCacheAttributes_1.extractCacheAttributes)('-- @cache-ttl 60', []), {
+        bodyHash: '46b9dd2b0ba88d13233b3feb',
+        discardEmpty: false,
+        key: 'query:$bodyHash:$valueHash',
+        ttl: 60,
+        valueHash: 'ec784925b52067bce01fd820',
+    });
+});
+(0, ava_1.default)('extracts @cache-discard-empty', (t) => {
+    t.deepEqual((0, extractCacheAttributes_1.extractCacheAttributes)('-- @cache-ttl 60\n-- @cache-discard-empty false', []), {
+        bodyHash: '46b9dd2b0ba88d13233b3feb',
+        discardEmpty: false,
+        key: 'query:$bodyHash:$valueHash',
+        ttl: 60,
+        valueHash: 'ec784925b52067bce01fd820',
+    });
+    t.deepEqual((0, extractCacheAttributes_1.extractCacheAttributes)('-- @cache-ttl 60\n-- @cache-discard-empty true', []), {
+        bodyHash: '46b9dd2b0ba88d13233b3feb',
+        discardEmpty: true,
+        key: 'query:$bodyHash:$valueHash',
+        ttl: 60,
+        valueHash: 'ec784925b52067bce01fd820',
+    });
+});
+(0, ava_1.default)('computes the parameter value hash', (t) => {
+    t.deepEqual((0, extractCacheAttributes_1.extractCacheAttributes)('-- @cache-ttl 60', [1]), {
+        bodyHash: '46b9dd2b0ba88d13233b3feb',
+        discardEmpty: false,
+        key: 'query:$bodyHash:$valueHash',
+        ttl: 60,
+        valueHash: '62eb54746ae2932850f8d6ff',
+    });
+});
+(0, ava_1.default)('computes the body hash; white spaces do not affect the body hash', (t) => {
+    t.deepEqual((0, extractCacheAttributes_1.extractCacheAttributes)('-- @cache-ttl 60\nSELECT 1', []), {
+        bodyHash: '553ebdb024592064ca4c2c3a',
+        discardEmpty: false,
+        key: 'query:$bodyHash:$valueHash',
+        ttl: 60,
+        valueHash: 'ec784925b52067bce01fd820',
+    });
+    t.deepEqual((0, extractCacheAttributes_1.extractCacheAttributes)('-- @cache-ttl 60\n\nSELECT 1', []), {
+        bodyHash: '553ebdb024592064ca4c2c3a',
+        discardEmpty: false,
+        key: 'query:$bodyHash:$valueHash',
+        ttl: 60,
+        valueHash: 'ec784925b52067bce01fd820',
+    });
+});
+(0, ava_1.default)('computes the body hash; comments do not affect the body hash', (t) => {
+    t.deepEqual((0, extractCacheAttributes_1.extractCacheAttributes)('-- @cache-ttl 60\nSELECT 1', []), {
+        bodyHash: '553ebdb024592064ca4c2c3a',
+        discardEmpty: false,
+        key: 'query:$bodyHash:$valueHash',
+        ttl: 60,
+        valueHash: 'ec784925b52067bce01fd820',
+    });
+    t.deepEqual((0, extractCacheAttributes_1.extractCacheAttributes)('-- @cache-ttl 120\nSELECT 1', []), {
+        bodyHash: '553ebdb024592064ca4c2c3a',
+        discardEmpty: false,
+        key: 'query:$bodyHash:$valueHash',
+        ttl: 120,
+        valueHash: 'ec784925b52067bce01fd820',
+    });
+});

package/dist/utilities/index.d.ts

@@ -0,0 +1,2 @@
+export { extractCacheAttributes } from './extractCacheAttributes';
+export { normalizeCacheAttributes } from './normalizeCacheAttributes';

package/dist/utilities/index.js

@@ -0,0 +1,7 @@
+"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; } });

package/dist/utilities/normalizeCacheAttributes.d.ts

@@ -0,0 +1,3 @@
+import { type CacheAttributes } from '../factories/createQueryCacheInterceptor';
+import { type ExtractedCacheAttributes } from './extractCacheAttributes';
+export declare const normalizeCacheAttributes: (extractedCacheAttributes: ExtractedCacheAttributes) => CacheAttributes;

package/dist/utilities/normalizeCacheAttributes.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeCacheAttributes = void 0;
+const normalizeCacheAttributes = (extractedCacheAttributes) => {
+    return {
+        discardEmpty: extractedCacheAttributes.discardEmpty,
+        key: extractedCacheAttributes.key
+            .replaceAll('$bodyHash', extractedCacheAttributes.bodyHash)
+            .replaceAll('$valueHash', extractedCacheAttributes.valueHash),
+        ttl: extractedCacheAttributes.ttl,
+    };
+};
+exports.normalizeCacheAttributes = normalizeCacheAttributes;

package/dist/utilities/normalizeCacheAttributes.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utilities/normalizeCacheAttributes.test.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const normalizeCacheAttributes_1 = require("./normalizeCacheAttributes");
+const ava_1 = __importDefault(require("ava"));
+(0, ava_1.default)('replaces $bodyHash and $valueHash', (t) => {
+    t.deepEqual((0, normalizeCacheAttributes_1.normalizeCacheAttributes)({
+        bodyHash: 'foo',
+        discardEmpty: false,
+        key: '$bodyHash:$valueHash',
+        ttl: 60,
+        valueHash: 'bar',
+    }), {
+        discardEmpty: false,
+        key: 'foo:bar',
+        ttl: 60,
+    });
+});

package/package.json

@@ -9,36 +9,41 @@
       "ts"
     ],
     "files": [
-      "test/slonik-interceptor-query-cache/**/*"
+      "src/**/*.test.ts"
     ],
     "require": [
       "ts-node/register/transpile-only"
     ]
   },
+  "dependencies": {
+    "roarr": "^7.14.0",
+    "strip-comments": "^2.0.1"
+  },
   "description": "Cache Slonik query results.",
   "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",
     "del-cli": "^4.0.1",
-    "eslint": "^8.4.1",
-    "eslint-config-canonical": "^32.46.0",
-    "husky": "^7.0.4",
+    "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": "^18.0.1",
+    "semantic-release": "^20.1.3",
     "sinon": "^12.0.1",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.7.4"
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
   },
   "engines": {
-    "node": ">=8.0"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run lint && npm run test && npm run build"
-    }
+    "node": ">=16.0"
   },
+  "files": [
+    "dist"
+  ],
   "keywords": [
     "postgresql",
     "interceptor",
@@ -47,21 +52,20 @@
   "license": "BSD-3-Clause",
   "main": "./dist/src/index.js",
   "name": "slonik-interceptor-query-cache",
+  "peerDependencies": {
+    "slonik": ">=27.0.0"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/gajus/slonik-interceptor-query-cache"
   },
   "scripts": {
     "build": "del-cli ./dist && tsc",
-    "lint": "eslint ./src ./test && tsc --noEmit",
-    "test": "NODE_ENV=test nyc ava --verbose --serial"
+    "lint:eslint": "eslint .",
+    "lint:tsc": "tsc --noEmit",
+    "prepare": "husky install",
+    "test:ava": "nyc ava --verbose --serial"
   },
   "typings": "./dist/src/index.d.ts",
-  "version": "2.4.0",
-  "peerDependencies": {
-    "slonik": ">=27.0.0"
-  },
-  "dependencies": {
-    "roarr": "^7.14.0"
-  }
+  "version": "3.0.0"
 }

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

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

package/dist/src/index.d.ts

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

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

@@ -1,5 +0,0 @@
-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,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractCacheAttributes = void 0;
-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) && values.length > 0) {
-            key += ':' + (0, node_crypto_1.createHash)('sha256').update(JSON.stringify(values)).digest('hex');
-        }
-        return {
-            key,
-            ttl: Number(ttl),
-        };
-    }
-    return null;
-};
-exports.extractCacheAttributes = extractCacheAttributes;

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

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

package/dist/src/utilities/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractCacheAttributes = void 0;
-var extractCacheAttributes_1 = require("./extractCacheAttributes");
-Object.defineProperty(exports, "extractCacheAttributes", { enumerable: true, get: function () { return extractCacheAttributes_1.extractCacheAttributes; } });

package/src/Logger.ts

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

package/src/factories/createQueryCacheInterceptor.ts

@@ -1,102 +0,0 @@
-import type {
-  Interceptor,
-  Query,
-  QueryResultRow,
-  QueryResult,
-} from 'slonik';
-import {
-  Logger,
-} from '../Logger';
-import {
-  extractCacheAttributes,
-} from '../utilities';
-
-const log = Logger.child({
-  namespace: 'createQueryCacheInterceptor',
-});
-
-type Sandbox = {
-  cache: {
-    cacheAttributes: CacheAttributes,
-  },
-};
-
-type CacheAttributes = {
-  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.info({
-          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) {
-        await configuration.storage.set(query, cacheAttributes, result);
-      }
-
-      return null;
-    },
-    beforeTransformQuery: async (context, query) => {
-      if (context.transactionId) {
-        return null;
-      }
-
-      const cacheAttributes = extractCacheAttributes(query.sql, query.values);
-
-      if (!cacheAttributes) {
-        return null;
-      }
-
-      context.sandbox.cache = {
-        cacheAttributes,
-      };
-
-      return null;
-    },
-  };
-};

package/src/factories/index.ts

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

package/src/index.ts

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

package/src/utilities/extractCacheAttributes.ts

@@ -1,29 +0,0 @@
-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) && values.length > 0) {
-      key += ':' + createHash('sha256').update(JSON.stringify(values)).digest('hex');
-    }
-
-    return {
-      key,
-      ttl: Number(ttl),
-    };
-  }
-
-  return null;
-};

package/src/utilities/index.ts

@@ -1,3 +0,0 @@
-export {
-  extractCacheAttributes,
-} from './extractCacheAttributes';

package/tsconfig.json

@@ -1,26 +0,0 @@
-{
-  "compilerOptions": {
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "noImplicitAny": false,
-    "noImplicitReturns": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": false,
-    "outDir": "dist",
-    "skipLibCheck": true,
-    "strict": true,
-    "target": "es2018"
-  },
-  "exclude": [
-    "dist",
-    "node_modules"
-  ],
-  "include": [
-    "src",
-    "test"
-  ]
-}