slonik-interceptor-query-cache 2.0.1 → 2.2.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019, Gajus Kuizinas (http://gajus.com/)
+Copyright (c) 2022, Gajus Kuizinas (http://gajus.com/)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -1,55 +1,30 @@
 # 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.org/gajus/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)
 
-Caches [Slonik](https://github.com/gajus/slonik) queries.
+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).
 
-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))
+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))
 
-## API
+## Behavior
 
-```js
-import {
-  createQueryCacheInterceptor
-} from 'slonik-interceptor-query-cache';
-
-```
-
-```js
-type CacheAttributesType = {|
-  +ttl: number,
-|};
-
-type StorageType = {|
-  +get: (query: QueryType, cacheAttributes: CacheAttributesType) => Promise<QueryResultType<QueryResultRowType> | null>,
-  +set: (query: QueryType, cacheAttributes: CacheAttributesType, queryResult: QueryResultType<QueryResultRowType>) => Promise<void>,
-|};
-
-type ConfigurationInputType = {|
-  +storage: StorageType,
-|};
-
-type ConfigurationType = {|
-  +storage: StorageType,
-|};
-
-(configurationInput: ConfigurationInputType) => InterceptorType;
-
-```
+* Does not cache queries inside of a transaction.
+* Does not take into account the query parameters.
 
 ## 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|
 
 ### Example usage
 
@@ -70,29 +45,25 @@ const nodeCache = new NodeCache({
   useClones: false,
 });
 
-const hashQuery = (query: QueryType): string => {
-  return JSON.stringify(query);
-};
-
-const interceptors = [
-  createQueryCacheInterceptor({
-    storage: {
-      get: (query) => {
-        return cache.get(hashQuery(query)) || null;
-      },
-      set: (query, cacheAttributes, queryResult) => {
-        cache.set(hashQuery(query), queryResult, cacheAttributes.ttl);
+const pool = await createPool('postgres://', {
+  interceptors: [
+    createQueryCacheInterceptor({
+      storage: {
+        get: (query, cacheAttributes) => {
+          // Returning null results in the query being executed.
+          return cache.get(cacheAttributes.key) || null;
+        },
+        set: (query, cacheAttributes, queryResult) => {
+          cache.set(cacheAttributes.key, queryResult, cacheAttributes.ttl);
+        },
       },
-    },
-  }),
-];
-
-const pool = createPool('postgres://', {
-  interceptors
+    }),
+  ]
 });
 
 await connection.any(sql`
   -- @cache-ttl 60
+  -- @cache-key foo
   SELECT
     id,
     code_alpha_2
@@ -100,5 +71,4 @@ await connection.any(sql`
   WHERE
     code_alpha_2 = ${countryCode}
 `);
-
-```
+```

package/dist/src/Logger.d.ts

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

package/dist/src/Logger.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const roarr_1 = require("roarr");
+exports.Logger = roarr_1.Roarr.child({
+    package: 'slonik-interceptor-query-cache',
+});

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

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

package/dist/src/factories/createQueryCacheInterceptor.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createQueryCacheInterceptor = void 0;
+const Logger_1 = require("../Logger");
+const utilities_1 = require("../utilities");
+const log = Logger_1.Logger.child({
+    namespace: 'createQueryCacheInterceptor',
+});
+const createQueryCacheInterceptor = (configurationInput) => {
+    const configuration = {
+        ...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;
+            }
+            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) => {
+            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);
+            }
+            return null;
+        },
+        beforeTransformQuery: async (context, query) => {
+            if (context.transactionId) {
+                return null;
+            }
+            const cacheAttributes = (0, utilities_1.extractCacheAttributes)(query.sql);
+            if (!cacheAttributes) {
+                return null;
+            }
+            context.sandbox.cache = {
+                cacheAttributes,
+            };
+            return null;
+        },
+    };
+};
+exports.createQueryCacheInterceptor = createQueryCacheInterceptor;

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

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

package/dist/src/factories/index.js

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

package/dist/src/index.d.ts

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

package/dist/src/index.js

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

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

@@ -0,0 +1,4 @@
+export declare const extractCacheAttributes: (subject: string) => {
+    key: string;
+    ttl: number;
+} | null;

package/dist/src/utilities/extractCacheAttributes.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractCacheAttributes = void 0;
+const extractCacheAttributes = (subject) => {
+    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];
+        if (!key) {
+            throw new Error('@cache-key must be specified when @cache-ttl is specified.');
+        }
+        return {
+            key,
+            ttl: Number(ttl),
+        };
+    }
+    return null;
+};
+exports.extractCacheAttributes = extractCacheAttributes;

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

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

package/dist/src/utilities/index.js

@@ -0,0 +1,5 @@
+"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/package.json

@@ -5,44 +5,31 @@
     "url": "http://gajus.com"
   },
   "ava": {
-    "babel": {
-      "compileAsTests": [
-        "test/helpers/**/*"
-      ]
-    },
+    "extensions": [
+      "ts"
+    ],
     "files": [
       "test/slonik-interceptor-query-cache/**/*"
     ],
     "require": [
-      "@babel/register"
+      "ts-node/register/transpile-only"
     ]
   },
-  "dependencies": {
-    "roarr": "^2.15.2",
-    "slonik": "^22.4.0"
-  },
-  "description": "Caches Slonik queries.",
+  "description": "Cache Slonik query results.",
   "devDependencies": {
-    "@ava/babel": "^1.0.1",
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.8.4",
-    "@babel/plugin-transform-flow-strip-types": "^7.8.3",
-    "@babel/preset-env": "^7.8.4",
-    "@babel/register": "^7.8.3",
-    "ava": "^3.3.0",
-    "babel-plugin-istanbul": "^6.0.0",
-    "babel-plugin-macros": "^2.8.0",
-    "babel-plugin-transform-export-default-name": "^2.0.4",
-    "coveralls": "^3.0.9",
-    "eslint": "^6.8.0",
-    "eslint-config-canonical": "^18.1.1",
-    "flow-bin": "^0.118.0",
-    "flow-copy-source": "^2.0.9",
-    "husky": "^4.2.3",
+    "@istanbuljs/nyc-config-typescript": "^1.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",
     "inline-loops.macro": "^1.2.2",
-    "nyc": "^15.0.0",
-    "semantic-release": "^17.0.3",
-    "sinon": "^8.1.1"
+    "nyc": "^15.1.0",
+    "semantic-release": "^18.0.1",
+    "sinon": "^12.0.1",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.7.4"
   },
   "engines": {
     "node": ">=8.0"
@@ -55,39 +42,26 @@
   "keywords": [
     "postgresql",
     "interceptor",
-    "cache"
+    "format"
   ],
   "license": "BSD-3-Clause",
-  "main": "./dist/index.js",
+  "main": "./dist/src/index.js",
   "name": "slonik-interceptor-query-cache",
-  "nyc": {
-    "all": true,
-    "exclude": [
-      "src/bin",
-      "src/queries/*.js"
-    ],
-    "include": [
-      "src/**/*.js"
-    ],
-    "instrument": false,
-    "reporter": [
-      "html",
-      "text-summary"
-    ],
-    "require": [
-      "@babel/register"
-    ],
-    "silent": true,
-    "sourceMap": false
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/gajus/slonik-interceptor-query-cache"
   },
   "scripts": {
-    "build": "rm -fr ./dist && NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps && flow-copy-source src dist",
-    "lint": "eslint ./src ./test && flow",
+    "build": "del-cli ./dist && tsc",
+    "lint": "eslint ./src ./test && tsc --noEmit",
     "test": "NODE_ENV=test nyc ava --verbose --serial"
   },
-  "version": "2.0.1"
+  "typings": "./dist/src/index.d.ts",
+  "version": "2.2.0",
+  "peerDependencies": {
+    "slonik": ">=27.0.0"
+  },
+  "dependencies": {
+    "roarr": "^7.14.0"
+  }
 }

package/src/Logger.ts

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

package/src/factories/createQueryCacheInterceptor.ts

@@ -0,0 +1,102 @@
+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);
+
+      if (!cacheAttributes) {
+        return null;
+      }
+
+      context.sandbox.cache = {
+        cacheAttributes,
+      };
+
+      return null;
+    },
+  };
+};

package/src/{index.js → factories/index.ts}

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

package/{dist/index.js.flow → src/index.ts}

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

package/src/utilities/extractCacheAttributes.ts

@@ -0,0 +1,18 @@
+export const extractCacheAttributes = (subject: string) => {
+  const ttl = /-- @cache-ttl (\d+)/u.exec(subject)?.[1];
+
+  if (ttl) {
+    const 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.');
+    }
+
+    return {
+      key,
+      ttl: Number(ttl),
+    };
+  }
+
+  return null;
+};

package/src/utilities/index.ts

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

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "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"
+  ]
+}

package/.flowconfig

@@ -1,3 +0,0 @@
-[ignore]
-.*/node_modules/.*/test/.*
-<PROJECT_ROOT>/dist/.*

package/dist/Logger.js

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _roarr = _interopRequireDefault(require("roarr"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var _default = _roarr.default.child({
-  package: 'slonik-interceptor-query-cache'
-});
-
-exports.default = _default;
-//# sourceMappingURL=Logger.js.map

package/dist/Logger.js.flow

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

package/dist/Logger.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/Logger.js"],"names":["Logger","child","package"],"mappings":";;;;;;;AAEA;;;;eAEeA,eAAOC,KAAP,CAAa;AAC1BC,EAAAA,OAAO,EAAE;AADiB,CAAb,C","sourcesContent":["// @flow\n\nimport Logger from 'roarr';\n\nexport default Logger.child({\n  package: 'slonik-interceptor-query-cache',\n});\n"],"file":"Logger.js"}

package/dist/factories/createQueryCacheInterceptor.js

@@ -1,67 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _utilities = require("../utilities");
-
-var _Logger = _interopRequireDefault(require("../Logger"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// eslint-disable-next-line flowtype/no-weak-types
-const defaultConfiguration = {};
-
-const createQueryCacheInterceptor = configurationInput => {
-  const configuration = { ...defaultConfiguration,
-    ...configurationInput
-  };
-  return {
-    beforeQueryExecution: async (context, query) => {
-      const cacheAttributes = context.sandbox.cache && context.sandbox.cache.cacheAttributes;
-
-      if (!cacheAttributes) {
-        return null;
-      }
-
-      const maybeResult = await configuration.storage.get(query, cacheAttributes);
-
-      if (maybeResult) {
-        _Logger.default.info({
-          queryId: context.queryId
-        }, 'query is served from cache');
-
-        return maybeResult;
-      }
-
-      return null;
-    },
-    beforeQueryResult: async (context, query, result) => {
-      const cacheAttributes = context.sandbox.cache && context.sandbox.cache.cacheAttributes;
-
-      if (cacheAttributes) {
-        await configuration.storage.set(query, cacheAttributes, result);
-      }
-
-      return null;
-    },
-    beforeTransformQuery: async (context, query) => {
-      const cacheAttributes = (0, _utilities.extractCacheAttributes)(query.sql);
-
-      if (!cacheAttributes) {
-        return null;
-      }
-
-      context.sandbox.cache = {
-        cacheAttributes
-      };
-      return null;
-    }
-  };
-};
-
-var _default = createQueryCacheInterceptor;
-exports.default = _default;
-//# sourceMappingURL=createQueryCacheInterceptor.js.map

package/dist/factories/createQueryCacheInterceptor.js.flow

@@ -1,83 +0,0 @@
-// @flow
-
-import type {
-  InterceptorType,
-  QueryType,
-  QueryResultRowType,
-  QueryResultType,
-} from 'slonik';
-import {
-  extractCacheAttributes,
-} from '../utilities';
-import log from '../Logger';
-
-type CacheAttributesType = {|
-  +ttl: number,
-|};
-
-type StorageType = {|
-  +get: (query: QueryType, cacheAttributes: CacheAttributesType) => Promise<QueryResultType<QueryResultRowType> | null>,
-  +set: (query: QueryType, cacheAttributes: CacheAttributesType, queryResult: QueryResultType<QueryResultRowType>) => Promise<void>,
-|};
-
-type ConfigurationInputType = {|
-  +storage: StorageType,
-|};
-
-type ConfigurationType = {|
-  +storage: StorageType,
-|};
-
-// eslint-disable-next-line flowtype/no-weak-types
-const defaultConfiguration: Object = {};
-
-export default (configurationInput?: ConfigurationInputType): InterceptorType => {
-  const configuration: ConfigurationType = {
-    ...defaultConfiguration,
-    ...configurationInput,
-  };
-
-  return {
-    beforeQueryExecution: async (context, query) => {
-      const cacheAttributes = context.sandbox.cache && context.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) => {
-      const cacheAttributes = context.sandbox.cache && context.sandbox.cache.cacheAttributes;
-
-      if (cacheAttributes) {
-        await configuration.storage.set(query, cacheAttributes, result);
-      }
-
-      return null;
-    },
-    beforeTransformQuery: async (context, query) => {
-      const cacheAttributes = extractCacheAttributes(query.sql);
-
-      if (!cacheAttributes) {
-        return null;
-      }
-
-      context.sandbox.cache = {
-        cacheAttributes,
-      };
-
-      return null;
-    },
-  };
-};

package/dist/factories/createQueryCacheInterceptor.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/factories/createQueryCacheInterceptor.js"],"names":["defaultConfiguration","configurationInput","configuration","beforeQueryExecution","context","query","cacheAttributes","sandbox","cache","maybeResult","storage","get","log","info","queryId","beforeQueryResult","result","set","beforeTransformQuery","sql"],"mappings":";;;;;;;AAQA;;AAGA;;;;AAmBA;AACA,MAAMA,oBAA4B,GAAG,EAArC;;oCAEgBC,kB,IAAiE;AAC/E,QAAMC,aAAgC,GAAG,EACvC,GAAGF,oBADoC;AAEvC,OAAGC;AAFoC,GAAzC;AAKA,SAAO;AACLE,IAAAA,oBAAoB,EAAE,OAAOC,OAAP,EAAgBC,KAAhB,KAA0B;AAC9C,YAAMC,eAAe,GAAGF,OAAO,CAACG,OAAR,CAAgBC,KAAhB,IAAyBJ,OAAO,CAACG,OAAR,CAAgBC,KAAhB,CAAsBF,eAAvE;;AAEA,UAAI,CAACA,eAAL,EAAsB;AACpB,eAAO,IAAP;AACD;;AAED,YAAMG,WAAW,GAAG,MAAMP,aAAa,CAACQ,OAAd,CAAsBC,GAAtB,CAA0BN,KAA1B,EAAiCC,eAAjC,CAA1B;;AAEA,UAAIG,WAAJ,EAAiB;AACfG,wBAAIC,IAAJ,CAAS;AACPC,UAAAA,OAAO,EAAEV,OAAO,CAACU;AADV,SAAT,EAEG,4BAFH;;AAIA,eAAOL,WAAP;AACD;;AAED,aAAO,IAAP;AACD,KAnBI;AAoBLM,IAAAA,iBAAiB,EAAE,OAAOX,OAAP,EAAgBC,KAAhB,EAAuBW,MAAvB,KAAkC;AACnD,YAAMV,eAAe,GAAGF,OAAO,CAACG,OAAR,CAAgBC,KAAhB,IAAyBJ,OAAO,CAACG,OAAR,CAAgBC,KAAhB,CAAsBF,eAAvE;;AAEA,UAAIA,eAAJ,EAAqB;AACnB,cAAMJ,aAAa,CAACQ,OAAd,CAAsBO,GAAtB,CAA0BZ,KAA1B,EAAiCC,eAAjC,EAAkDU,MAAlD,CAAN;AACD;;AAED,aAAO,IAAP;AACD,KA5BI;AA6BLE,IAAAA,oBAAoB,EAAE,OAAOd,OAAP,EAAgBC,KAAhB,KAA0B;AAC9C,YAAMC,eAAe,GAAG,uCAAuBD,KAAK,CAACc,GAA7B,CAAxB;;AAEA,UAAI,CAACb,eAAL,EAAsB;AACpB,eAAO,IAAP;AACD;;AAEDF,MAAAA,OAAO,CAACG,OAAR,CAAgBC,KAAhB,GAAwB;AACtBF,QAAAA;AADsB,OAAxB;AAIA,aAAO,IAAP;AACD;AAzCI,GAAP;AA2CD,C","sourcesContent":["// @flow\n\nimport type {\n  InterceptorType,\n  QueryType,\n  QueryResultRowType,\n  QueryResultType,\n} from 'slonik';\nimport {\n  extractCacheAttributes,\n} from '../utilities';\nimport log from '../Logger';\n\ntype CacheAttributesType = {|\n  +ttl: number,\n|};\n\ntype StorageType = {|\n  +get: (query: QueryType, cacheAttributes: CacheAttributesType) => Promise<QueryResultType<QueryResultRowType> | null>,\n  +set: (query: QueryType, cacheAttributes: CacheAttributesType, queryResult: QueryResultType<QueryResultRowType>) => Promise<void>,\n|};\n\ntype ConfigurationInputType = {|\n  +storage: StorageType,\n|};\n\ntype ConfigurationType = {|\n  +storage: StorageType,\n|};\n\n// eslint-disable-next-line flowtype/no-weak-types\nconst defaultConfiguration: Object = {};\n\nexport default (configurationInput?: ConfigurationInputType): InterceptorType => {\n  const configuration: ConfigurationType = {\n    ...defaultConfiguration,\n    ...configurationInput,\n  };\n\n  return {\n    beforeQueryExecution: async (context, query) => {\n      const cacheAttributes = context.sandbox.cache && context.sandbox.cache.cacheAttributes;\n\n      if (!cacheAttributes) {\n        return null;\n      }\n\n      const maybeResult = await configuration.storage.get(query, cacheAttributes);\n\n      if (maybeResult) {\n        log.info({\n          queryId: context.queryId,\n        }, 'query is served from cache');\n\n        return maybeResult;\n      }\n\n      return null;\n    },\n    beforeQueryResult: async (context, query, result) => {\n      const cacheAttributes = context.sandbox.cache && context.sandbox.cache.cacheAttributes;\n\n      if (cacheAttributes) {\n        await configuration.storage.set(query, cacheAttributes, result);\n      }\n\n      return null;\n    },\n    beforeTransformQuery: async (context, query) => {\n      const cacheAttributes = extractCacheAttributes(query.sql);\n\n      if (!cacheAttributes) {\n        return null;\n      }\n\n      context.sandbox.cache = {\n        cacheAttributes,\n      };\n\n      return null;\n    },\n  };\n};\n"],"file":"createQueryCacheInterceptor.js"}

package/dist/factories/index.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "createQueryCacheInterceptor", {
-  enumerable: true,
-  get: function () {
-    return _createQueryCacheInterceptor.default;
-  }
-});
-
-var _createQueryCacheInterceptor = _interopRequireDefault(require("./createQueryCacheInterceptor"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-//# sourceMappingURL=index.js.map

package/dist/factories/index.js.flow

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

package/dist/factories/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/factories/index.js"],"names":[],"mappings":";;;;;;;;;;;;AAEA","sourcesContent":["// @flow\n\nexport {default as createQueryCacheInterceptor} from './createQueryCacheInterceptor';\n"],"file":"index.js"}

package/dist/index.js

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

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;AAEA","sourcesContent":["// @flow\n\nexport {\n  createQueryCacheInterceptor,\n} from './factories';\n"],"file":"index.js"}

package/dist/utilities/extractCacheAttributes.js

@@ -1,22 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-const extractCacheAttributes = subject => {
-  const matches = subject.match(/@cache-ttl (\d+)/);
-
-  if (matches) {
-    return {
-      ttl: Number(matches[1])
-    };
-  }
-
-  return null;
-};
-
-var _default = extractCacheAttributes;
-exports.default = _default;
-//# sourceMappingURL=extractCacheAttributes.js.map

package/dist/utilities/extractCacheAttributes.js.flow

@@ -1,13 +0,0 @@
-// @flow
-
-export default (subject: string) => {
-  const matches = subject.match(/@cache-ttl (\d+)/);
-
-  if (matches) {
-    return {
-      ttl: Number(matches[1]),
-    };
-  }
-
-  return null;
-};

package/dist/utilities/extractCacheAttributes.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/extractCacheAttributes.js"],"names":["subject","matches","match","ttl","Number"],"mappings":";;;;;;;+BAEgBA,O,IAAoB;AAClC,QAAMC,OAAO,GAAGD,OAAO,CAACE,KAAR,CAAc,kBAAd,CAAhB;;AAEA,MAAID,OAAJ,EAAa;AACX,WAAO;AACLE,MAAAA,GAAG,EAAEC,MAAM,CAACH,OAAO,CAAC,CAAD,CAAR;AADN,KAAP;AAGD;;AAED,SAAO,IAAP;AACD,C","sourcesContent":["// @flow\n\nexport default (subject: string) => {\n  const matches = subject.match(/@cache-ttl (\\d+)/);\n\n  if (matches) {\n    return {\n      ttl: Number(matches[1]),\n    };\n  }\n\n  return null;\n};\n"],"file":"extractCacheAttributes.js"}

package/dist/utilities/index.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "extractCacheAttributes", {
-  enumerable: true,
-  get: function () {
-    return _extractCacheAttributes.default;
-  }
-});
-
-var _extractCacheAttributes = _interopRequireDefault(require("./extractCacheAttributes"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-//# sourceMappingURL=index.js.map

package/dist/utilities/index.js.flow

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

package/dist/utilities/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/index.js"],"names":[],"mappings":";;;;;;;;;;;;AAEA","sourcesContent":["// @flow\n\nexport {default as extractCacheAttributes} from './extractCacheAttributes';\n"],"file":"index.js"}

package/src/Logger.js

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

package/src/factories/createQueryCacheInterceptor.js

@@ -1,83 +0,0 @@
-// @flow
-
-import type {
-  InterceptorType,
-  QueryType,
-  QueryResultRowType,
-  QueryResultType,
-} from 'slonik';
-import {
-  extractCacheAttributes,
-} from '../utilities';
-import log from '../Logger';
-
-type CacheAttributesType = {|
-  +ttl: number,
-|};
-
-type StorageType = {|
-  +get: (query: QueryType, cacheAttributes: CacheAttributesType) => Promise<QueryResultType<QueryResultRowType> | null>,
-  +set: (query: QueryType, cacheAttributes: CacheAttributesType, queryResult: QueryResultType<QueryResultRowType>) => Promise<void>,
-|};
-
-type ConfigurationInputType = {|
-  +storage: StorageType,
-|};
-
-type ConfigurationType = {|
-  +storage: StorageType,
-|};
-
-// eslint-disable-next-line flowtype/no-weak-types
-const defaultConfiguration: Object = {};
-
-export default (configurationInput?: ConfigurationInputType): InterceptorType => {
-  const configuration: ConfigurationType = {
-    ...defaultConfiguration,
-    ...configurationInput,
-  };
-
-  return {
-    beforeQueryExecution: async (context, query) => {
-      const cacheAttributes = context.sandbox.cache && context.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) => {
-      const cacheAttributes = context.sandbox.cache && context.sandbox.cache.cacheAttributes;
-
-      if (cacheAttributes) {
-        await configuration.storage.set(query, cacheAttributes, result);
-      }
-
-      return null;
-    },
-    beforeTransformQuery: async (context, query) => {
-      const cacheAttributes = extractCacheAttributes(query.sql);
-
-      if (!cacheAttributes) {
-        return null;
-      }
-
-      context.sandbox.cache = {
-        cacheAttributes,
-      };
-
-      return null;
-    },
-  };
-};

package/src/factories/index.js

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

package/src/utilities/extractCacheAttributes.js

@@ -1,13 +0,0 @@
-// @flow
-
-export default (subject: string) => {
-  const matches = subject.match(/@cache-ttl (\d+)/);
-
-  if (matches) {
-    return {
-      ttl: Number(matches[1]),
-    };
-  }
-
-  return null;
-};

package/src/utilities/index.js

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