@medusajs/cache-redis 2.0.0-20230320210331

package/README.md

@@ -0,0 +1,26 @@
+# Medusa Cache Redis
+
+Use Redis as a Medusa cache store.
+
+## Installation
+
+```
+yarn add @medusajs/cache-redis
+```
+
+## Options
+
+```
+   {
+      ttl?: number                // Time to keep data in cache (in seconds)
+    
+      redisUrl?: string           // Redis instance connection string
+    
+      redisOptions?: RedisOptions // Redis client options
+    
+      namespace?: string          // Prefix for event keys (the default is `medusa:`)
+  }
+```
+
+### Other caching modules
+- [Medusa Cache In-Memory](../cache-inmemory/README.md)

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { ModuleExports } from "@medusajs/modules-sdk";
+declare const moduleDefinition: ModuleExports;
+export default moduleDefinition;

package/dist/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var loaders_1 = __importDefault(require("./loaders"));
+var services_1 = require("./services");
+var service = services_1.RedisCacheService;
+var loaders = [loaders_1.default];
+var moduleDefinition = {
+    service: service,
+    loaders: loaders,
+};
+exports.default = moduleDefinition;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAEA,sDAA8B;AAC9B,uCAA8C;AAE9C,IAAM,OAAO,GAAG,4BAAiB,CAAA;AACjC,IAAM,OAAO,GAAG,CAAC,iBAAM,CAAC,CAAA;AAExB,IAAM,gBAAgB,GAAkB;IACtC,OAAO,SAAA;IACP,OAAO,SAAA;CACR,CAAA;AAED,kBAAe,gBAAgB,CAAA"}

package/dist/loaders/index.d.ts

@@ -0,0 +1,3 @@
+import { LoaderOptions } from "@medusajs/modules-sdk";
+declare const _default: ({ container, logger, options, }: LoaderOptions) => Promise<void>;
+export default _default;

package/dist/loaders/index.js

@@ -0,0 +1,90 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var ioredis_1 = __importDefault(require("ioredis"));
+var awilix_1 = require("awilix");
+exports.default = (function (_a) {
+    var container = _a.container, logger = _a.logger, options = _a.options;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var _b, redisUrl, redisOptions, connection, err_1;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    _b = options, redisUrl = _b.redisUrl, redisOptions = _b.redisOptions;
+                    if (!redisUrl) {
+                        throw Error("No `redisUrl` provided in `cacheService` module options. It is required for the Redis Cache Module.");
+                    }
+                    connection = new ioredis_1.default(redisUrl, __assign({ 
+                        // Lazy connect to properly handle connection errors
+                        lazyConnect: true }, (redisOptions !== null && redisOptions !== void 0 ? redisOptions : {})));
+                    _c.label = 1;
+                case 1:
+                    _c.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, connection.connect()];
+                case 2:
+                    _c.sent();
+                    logger === null || logger === void 0 ? void 0 : logger.info("Connection to Redis in module 'cache-redis' established");
+                    return [3 /*break*/, 4];
+                case 3:
+                    err_1 = _c.sent();
+                    logger === null || logger === void 0 ? void 0 : logger.error("An error occurred while connecting to Redis in module 'cache-redis': ".concat(err_1));
+                    return [3 /*break*/, 4];
+                case 4:
+                    container.register({
+                        cacheRedisConnection: (0, awilix_1.asValue)(connection),
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    });
+});
+//# sourceMappingURL=index.js.map

package/dist/loaders/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/loaders/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAA2B;AAC3B,iCAAgC;AAKhC,mBAAe,UAAO,EAIN;QAHd,SAAS,eAAA,EACT,MAAM,YAAA,EACN,OAAO,aAAA;;;;;;oBAED,KAA6B,OAAkC,EAA7D,QAAQ,cAAA,EAAE,YAAY,kBAAA,CAAuC;oBAErE,IAAI,CAAC,QAAQ,EAAE;wBACb,MAAM,KAAK,CACT,qGAAqG,CACtG,CAAA;qBACF;oBAEK,UAAU,GAAG,IAAI,iBAAK,CAAC,QAAQ;wBACnC,oDAAoD;wBACpD,WAAW,EAAE,IAAI,IACd,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,EAAE,CAAC,EACvB,CAAA;;;;oBAGA,qBAAM,UAAU,CAAC,OAAO,EAAE,EAAA;;oBAA1B,SAA0B,CAAA;oBAC1B,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAC,yDAAyD,CAAC,CAAA;;;;oBAEvE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CACX,+EAAwE,KAAG,CAAE,CAC9E,CAAA;;;oBAGH,SAAS,CAAC,QAAQ,CAAC;wBACjB,oBAAoB,EAAE,IAAA,gBAAO,EAAC,UAAU,CAAC;qBAC1C,CAAC,CAAA;;;;;CACH,EAAA"}

package/dist/services/index.d.ts

@@ -0,0 +1 @@
+export { default as RedisCacheService } from "./redis-cache";

package/dist/services/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisCacheService = void 0;
+var redis_cache_1 = require("./redis-cache");
+Object.defineProperty(exports, "RedisCacheService", { enumerable: true, get: function () { return __importDefault(redis_cache_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;AAAA,6CAA4D;AAAnD,iIAAA,OAAO,OAAqB"}

package/dist/services/redis-cache.d.ts

@@ -0,0 +1,36 @@
+import { Redis } from "ioredis";
+import { ICacheService } from "@medusajs/medusa";
+import { RedisCacheModuleOptions } from "../types";
+declare type InjectedDependencies = {
+    cacheRedisConnection: Redis;
+};
+declare class RedisCacheService implements ICacheService {
+    protected readonly TTL: number;
+    protected readonly redis: Redis;
+    private readonly namespace;
+    constructor({ cacheRedisConnection }: InjectedDependencies, options?: RedisCacheModuleOptions);
+    /**
+     * Set a key/value pair to the cache.
+     * If the ttl is 0 it will act like the value should not be cached at all.
+     * @param key
+     * @param data
+     * @param ttl
+     */
+    set(key: string, data: Record<string, unknown>, ttl?: number): Promise<void>;
+    /**
+     * Retrieve a cached value belonging to the given key.
+     * @param cacheKey
+     */
+    get<T>(cacheKey: string): Promise<T | null>;
+    /**
+     * Invalidate cache for a specific key. a key can be either a specific key or more global such as "ps:*".
+     * @param key
+     */
+    invalidate(key: string): Promise<void>;
+    /**
+     * Returns namespaced cache key
+     * @param key
+     */
+    private getCacheKey;
+}
+export default RedisCacheService;

package/dist/services/redis-cache.js

@@ -0,0 +1,137 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var DEFAULT_NAMESPACE = "medusa";
+var DEFAULT_CACHE_TIME = 30; // 30 seconds
+var EXPIRY_MODE = "EX"; // "EX" stands for an expiry time in second
+var RedisCacheService = /** @class */ (function () {
+    function RedisCacheService(_a, options) {
+        var cacheRedisConnection = _a.cacheRedisConnection;
+        if (options === void 0) { options = {}; }
+        var _b;
+        this.redis = cacheRedisConnection;
+        this.TTL = (_b = options.ttl) !== null && _b !== void 0 ? _b : DEFAULT_CACHE_TIME;
+        this.namespace = options.namespace || DEFAULT_NAMESPACE;
+    }
+    /**
+     * Set a key/value pair to the cache.
+     * If the ttl is 0 it will act like the value should not be cached at all.
+     * @param key
+     * @param data
+     * @param ttl
+     */
+    RedisCacheService.prototype.set = function (key, data, ttl) {
+        if (ttl === void 0) { ttl = this.TTL; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.redis.set(this.getCacheKey(key), JSON.stringify(data), EXPIRY_MODE, ttl)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve a cached value belonging to the given key.
+     * @param cacheKey
+     */
+    RedisCacheService.prototype.get = function (cacheKey) {
+        return __awaiter(this, void 0, void 0, function () {
+            var cached, err_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        cacheKey = this.getCacheKey(cacheKey);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 5]);
+                        return [4 /*yield*/, this.redis.get(cacheKey)];
+                    case 2:
+                        cached = _a.sent();
+                        if (cached) {
+                            return [2 /*return*/, JSON.parse(cached)];
+                        }
+                        return [3 /*break*/, 5];
+                    case 3:
+                        err_1 = _a.sent();
+                        return [4 /*yield*/, this.redis.del(cacheKey)];
+                    case 4:
+                        _a.sent();
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/, null];
+                }
+            });
+        });
+    };
+    /**
+     * Invalidate cache for a specific key. a key can be either a specific key or more global such as "ps:*".
+     * @param key
+     */
+    RedisCacheService.prototype.invalidate = function (key) {
+        return __awaiter(this, void 0, void 0, function () {
+            var keys, pipeline;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.redis.keys(this.getCacheKey(key))];
+                    case 1:
+                        keys = _a.sent();
+                        pipeline = this.redis.pipeline();
+                        keys.forEach(function (key) {
+                            pipeline.del(key);
+                        });
+                        return [4 /*yield*/, pipeline.exec()];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Returns namespaced cache key
+     * @param key
+     */
+    RedisCacheService.prototype.getCacheKey = function (key) {
+        return this.namespace ? "".concat(this.namespace, ":").concat(key) : key;
+    };
+    return RedisCacheService;
+}());
+exports.default = RedisCacheService;
+//# sourceMappingURL=redis-cache.js.map

package/dist/services/redis-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-cache.js","sourceRoot":"","sources":["../../src/services/redis-cache.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,IAAM,iBAAiB,GAAG,QAAQ,CAAA;AAClC,IAAM,kBAAkB,GAAG,EAAE,CAAA,CAAC,aAAa;AAC3C,IAAM,WAAW,GAAG,IAAI,CAAA,CAAC,2CAA2C;AAMpE;IAKE,2BACE,EAA8C,EAC9C,OAAqC;YADnC,oBAAoB,0BAAA;QACtB,wBAAA,EAAA,YAAqC;;QAErC,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAA;QACjC,IAAI,CAAC,GAAG,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,kBAAkB,CAAA;QAC5C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,iBAAiB,CAAA;IACzD,CAAC;IACD;;;;;;OAMG;IACG,+BAAG,GAAT,UACE,GAAW,EACX,IAA6B,EAC7B,GAAsB;QAAtB,oBAAA,EAAA,MAAc,IAAI,CAAC,GAAG;;;;4BAEtB,qBAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAClB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EACrB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EACpB,WAAW,EACX,GAAG,CACJ,EAAA;;wBALD,SAKC,CAAA;;;;;KACF;IAED;;;OAGG;IACG,+BAAG,GAAT,UAAa,QAAgB;;;;;;wBAC3B,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;;;;wBAEpB,qBAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAA;;wBAAvC,MAAM,GAAG,SAA8B;wBAC7C,IAAI,MAAM,EAAE;4BACV,sBAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAA;yBAC1B;;;;wBAED,qBAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAA;;wBAA9B,SAA8B,CAAA;;4BAEhC,sBAAO,IAAI,EAAA;;;;KACZ;IAED;;;OAGG;IACG,sCAAU,GAAhB,UAAiB,GAAW;;;;;4BACb,qBAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAA;;wBAAnD,IAAI,GAAG,SAA4C;wBACnD,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAA;wBAEtC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG;4BACxB,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;wBACnB,CAAC,CAAC,CAAA;wBAEF,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;wBAArB,SAAqB,CAAA;;;;;KACtB;IAED;;;OAGG;IACK,uCAAW,GAAnB,UAAoB,GAAW;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,GAAG,CAAE,CAAC,CAAC,CAAC,GAAG,CAAA;IAC1D,CAAC;IACH,wBAAC;AAAD,CAAC,AAxED,IAwEC;AAED,kBAAe,iBAAiB,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+import { RedisOptions } from "ioredis";
+/**
+ * Module config type
+ */
+export declare type RedisCacheModuleOptions = {
+    /**
+     * Time to keep data in cache (in seconds)
+     */
+    ttl?: number;
+    /**
+     * Redis connection string
+     */
+    redisUrl?: string;
+    /**
+     * Redis client options
+     */
+    redisOptions?: RedisOptions;
+    /**
+     * Prefix for event keys
+     * @default `medusa:`
+     */
+    namespace?: string;
+};

package/dist/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@medusajs/cache-redis",
+  "version": "2.0.0-20230320210331",
+  "description": "Redis Cache Module for Medusa",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/cache-redis"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Medusa",
+  "license": "MIT",
+  "devDependencies": {
+    "@medusajs/medusa": "2.0.0-20230320210331",
+    "cross-env": "^5.2.1",
+    "jest": "^25.5.4",
+    "ts-jest": "^25.5.1",
+    "typescript": "^4.4.4"
+  },
+  "scripts": {
+    "watch": "tsc --build --watch",
+    "prepare": "cross-env NODE_ENV=production yarn run build",
+    "build": "tsc --build",
+    "test": "jest --passWithNoTests",
+    "test:unit": "jest --passWithNoTests"
+  },
+  "peerDependencies": {
+    "@medusajs/medusa": "2.0.0-20230320210331"
+  }
+}