@autofleet/matmon 1.0.0

package/README.md

@@ -0,0 +1,20 @@
+# matmon
+
+# How to use:
+
+    import { getNewLRU, getWithCacheSupport } from '@autofleet/matmon';
+    const LIFETIME_IN_SEC = 15;
+    const SIZE = 300;
+    const VEHICLES_CACHE_KEY = 'vehicles';
+
+    const VehiclesCache = CacheUtil.getNewLRU(LIFETIME_IN_SEC, SIZE);
+    const getVehicle = async vehicleId => VehiclesCache.get(vehicleId);
+    const setVehicle = async (vehicleId, vehicle) => VehiclesCache.set(vehicleId, vehicle);
+
+    export const getVehicle = async (vehicleId, rideId, skipCache) => getWithCacheSupport({
+    cacheKey: VEHICLES_CACHE_KEY,
+    cacheGet: () => getVehicle(vehicleId),
+    cacheSet: value => setVehicle(vehicleId, value),
+    fetching: () => vehicleMs.getVehicle(vehicleId, rideId),
+    skipCache,
+    });

package/lib/cache.d.ts

@@ -0,0 +1,8 @@
+export declare const getNewLRU: (lifeTimeInSec: any, size: any) => any;
+export declare const getWithCacheSupport: ({ cacheKey, cacheGet, cacheSet, fetching, skipCache, }: {
+    cacheKey: any;
+    cacheGet: any;
+    cacheSet: any;
+    fetching: any;
+    skipCache: any;
+}) => Promise<any>;

package/lib/cache.js

@@ -0,0 +1,81 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWithCacheSupport = exports.getNewLRU = void 0;
+const lru_cache_1 = __importDefault(require("lru-cache"));
+const locking = __importStar(require("./locking"));
+const dotenv_1 = __importDefault(require("dotenv"));
+dotenv_1.default.config();
+const DEFAULT_CACHE_SIZE = 300;
+const MAX_SIZE = 1000;
+const MUTEX_MAP = {};
+const getOptions = ({ lifeTimeInSec, size = DEFAULT_CACHE_SIZE, }) => ({
+    max: Math.min(size, MAX_SIZE),
+    maxAge: process.env.NODE_ENV !== 'test' ? 1000 * lifeTimeInSec : 0,
+});
+const getMutexByCacheKey = (key) => {
+    if (!MUTEX_MAP[key]) {
+        MUTEX_MAP[key] = locking.getMutex();
+    }
+    return MUTEX_MAP[key];
+};
+exports.getNewLRU = (lifeTimeInSec, size) => new lru_cache_1.default(getOptions({
+    lifeTimeInSec,
+    size,
+}));
+exports.getWithCacheSupport = ({ cacheKey, cacheGet, cacheSet, fetching, skipCache, }) => __awaiter(void 0, void 0, void 0, function* () {
+    if (skipCache || process.env.NODE_ENV === 'test') {
+        const res = yield fetching();
+        yield cacheSet(res);
+        return res;
+    }
+    let valueToReturn = null;
+    try {
+        yield locking.wrapWithMutex(getMutexByCacheKey(cacheKey), () => __awaiter(void 0, void 0, void 0, function* () {
+            valueToReturn = yield cacheGet();
+            if (!valueToReturn) {
+                valueToReturn = yield fetching();
+                yield cacheSet(valueToReturn);
+            }
+            else {
+                // logger.info('get value from cache');
+            }
+        }));
+        // retry without locking if failed
+    }
+    catch (e) {
+        valueToReturn = yield fetching();
+        yield cacheSet(valueToReturn);
+    }
+    return valueToReturn;
+});

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+    getNewLRU: (lifeTimeInSec: any, size: any) => any;
+    getWithCacheSupport: ({ cacheKey, cacheGet, cacheSet, fetching, skipCache, }: {
+        cacheKey: any;
+        cacheGet: any;
+        cacheSet: any;
+        fetching: any;
+        skipCache: any;
+    }) => Promise<any>;
+};
+export default _default;

package/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cache_1 = require("./cache");
+exports.default = {
+    getNewLRU: cache_1.getNewLRU,
+    getWithCacheSupport: cache_1.getWithCacheSupport,
+};

package/lib/locking.d.ts

@@ -0,0 +1,3 @@
+import { MutexInterface } from 'async-mutex';
+export declare const wrapWithMutex: (mutex: any, funcToRun: any) => Promise<void>;
+export declare const getMutex: () => MutexInterface;

package/lib/locking.js

@@ -0,0 +1,26 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMutex = exports.wrapWithMutex = void 0;
+const async_mutex_1 = require("async-mutex");
+const CACHE_LOCK_TIMEOUT_MILIS = 3000;
+const LOCK_TIMEOUT_MESSAGE = 'mutex - locking timeout';
+// eslint-disable-next-line import/prefer-default-export
+exports.wrapWithMutex = (mutex, funcToRun) => __awaiter(void 0, void 0, void 0, function* () {
+    const release = yield mutex.acquire();
+    try {
+        yield funcToRun();
+    }
+    finally {
+        release();
+    }
+});
+exports.getMutex = () => async_mutex_1.withTimeout(new async_mutex_1.Mutex(), CACHE_LOCK_TIMEOUT_MILIS, new Error(LOCK_TIMEOUT_MESSAGE));

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@autofleet/matmon",
+  "version": "1.0.0",
+  "description": "manage cache",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "rm -rf lib && tsc",
+    "prepublish": "npm run build",
+    "coverage": "jest --coverage --forceExit --runInBand",
+    "test": "jest --forceExit --runInBand",
+    "test-auto": "jest --watch --runInBand",
+    "linter": "./node_modules/.bin/eslint ."
+  },
+  "jest": {
+    "setupTestFrameworkScriptFile": "jest-extended",
+    "testURL": "http://localhost:8085/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.com/AutoFleet/matmon.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Autofleet/matmon/issues"
+  },
+  "homepage": "https://github.com/Autofleet/matmon",
+  "dependencies": {
+    "@types/node": "^14.14.20",
+    "async-mutex": "^0.2.6",
+    "dotenv": "^8.2.0",
+    "lru-cache": "^6.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^3.9.5"
+  },
+  "files": [
+    "lib/**/*"
+  ]
+}