exframe-cache-manager 2.1.3 → 2.2.0

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-alpine
+FROM node:24-alpine
 
 LABEL maintainer=Exzeo
 
@@ -10,8 +10,10 @@ COPY ./package.json /app/package.json
 COPY . /app
 
 WORKDIR /app
-RUN npm install
+RUN npm install --ignore-scripts
 RUN npm run peers
 
+USER node
+
 # Override the command, to run the test instead of the application
 CMD ["npm", "run", "unit-test"]

package/docker-compose.yml

@@ -1,4 +1,3 @@
-version: "2"
 services:
   exframe-cache-manager:
     container_name: exframe-cache-manager

package/index.js

@@ -1,13 +1,15 @@
 'use strict';
 
-const util = require('util');
-const { setTimeout: waitTimeout } = require('timers/promises');
-const CacheManager = require('cache-manager');
-const RedisStore = require('cache-manager-redis-store');
-const { lazyInstrument } = require('exframe-metrics');
-const health = require('exframe-health');
-const service = require('exframe-service');
-const { generateShortId } = require('exframe-utilities');
+import util from 'node:util';
+import { setTimeout as waitTimeout } from 'node:timers/promises';
+import CacheManager from 'cache-manager';
+import RedisStore from 'cache-manager-redis-store';
+import { lazyInstrument } from 'exframe-metrics';
+import health from 'exframe-health';
+import service from 'exframe-service';
+import { generateShortId } from 'exframe-utilities';
+
+const DEFAULT_TTL = 600;
 
 const db = 0;
 
@@ -24,7 +26,7 @@ function cachemanager(options) {
 
   const redisCache = CacheManager.caching({
     store: RedisStore,
-    ttl: 600,
+    ttl: DEFAULT_TTL,
     db,
     ...options
   });
@@ -98,6 +100,30 @@ function cachemanager(options) {
       return value;
     },
 
+    /**
+     * Set the item if it does not exist yet. If the item already exists, do not set and return null.
+     * @template T
+     * @param {String} key
+     * @param {T} value
+     * @param {Number} ttl
+     * @returns {Promise<T|null>}
+     */
+    async setItemIfNotExists(key, value, ttl) {
+      const ttlToSet = ttl ?? (process.env.REDIS_CACHE_TTL
+        ? Number(process.env.REDIS_CACHE_TTL)
+        : DEFAULT_TTL);
+
+      return new Promise((resolve, reject) => {
+        redisClient.set(key, value, 'NX', 'EX', ttlToSet, (error, result) => {
+          if (error) {
+            return reject(error);
+          }
+
+          resolve(result === 'OK' ? value : null);
+        });
+      });
+    },
+
     /**
      *
      * @param {string} key
@@ -226,9 +252,8 @@ function cachemanager(options) {
   return instance;
 }
 
-module.exports = {
-  create: cachemanager
-};
+// eslint-disable-next-line import/prefer-default-export
+export { cachemanager as create };
 
 /**
  * @typedef {RedisCacheManagerOptions & { store?: any, ttl?: number, db?: number }} Options

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "exframe-cache-manager",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "description": "Managing the cache",
   "main": "index.js",
+  "type": "module",
   "config": {
     "reporter": "mocha-exzeo-reporter"
   },
@@ -24,14 +25,14 @@
     "exframe-service": "1.x"
   },
   "dependencies": {
-    "@types/cache-manager": "^3.4.2",
+    "@types/cache-manager": "^4.0.6",
     "cache-manager": "^3.6.0",
     "cache-manager-redis-store": "^2.0.0",
-    "exframe-metrics": "^1.1.0",
+    "exframe-metrics": "^1.5.0",
     "exframe-utilities": "^1.1.0"
   },
   "devDependencies": {
-    "chai": "^4",
+    "chai": "^6",
     "eslint": "*",
     "eslint-config-exzeo": "*",
     "eslint-plugin-import": "*",
@@ -46,5 +47,5 @@
     "url": "https://bitbucket.org/exzeo-usa/exframe",
     "directory": "packages/exframe-cache-manager"
   },
-  "gitHead": "fc8904cc6138fcd0976e4cc3692134e84dcaa985"
+  "gitHead": "25463e1a2459e770277640472111e372cacf4aa5"
 }

package/test/cacheManager.test.js

@@ -1,11 +1,12 @@
 'use strict';
 
-const { expect } = require('chai');
-const sinon = require('sinon');
-const service = require('exframe-service');
-const health = require('exframe-health');
-const { setTimeout: waitTimeout } = require('timers/promises');
-const cacheManager = require('../index');
+import { expect } from 'chai';
+import { createSandbox, match, stub as _stub } from 'sinon';
+import service from 'exframe-service';
+import health from 'exframe-health';
+import { setTimeout as waitTimeout } from 'node:timers/promises';
+
+import { create } from '../index.js';
 
 const { prometheusClient } = service;
 const userId = 'auth0|1234567890';
@@ -25,7 +26,7 @@ context('Test User Profile Middleware', () => {
       let sinonInstance;
 
       beforeEach(() => {
-        sinonInstance = sinon.createSandbox();
+        sinonInstance = createSandbox();
       });
 
       afterEach(() => {
@@ -35,25 +36,25 @@ context('Test User Profile Middleware', () => {
       it('adds a health check with the instance ID in the name, check function, and liveness timeout of 60 seconds', () => {
         const healthAddSpy = sinonInstance.spy(health, 'add');
 
-        const instance = cacheManager.create(options);
+        const instance = create(options);
         expect(healthAddSpy.calledOnce).to.equal(true);
-        expect(healthAddSpy.calledWithMatch(`redis-${instance.id}`, sinon.match.func, { promotionTimeout: 60000 })).to.be.true;
+        expect(healthAddSpy.calledWithMatch(`redis-${instance.id}`, match.func, { promotionTimeout: 60000 })).to.be.true;
       });
 
       it('registers a service resource with the instance ID in the name, onSignal function, and order of "last"', () => {
         const registerSpy = sinonInstance.spy(service, 'registerResource');
 
-        const instance = cacheManager.create(options);
+        const instance = create(options);
         expect(registerSpy.calledOnce).to.equal(true);
-        expect(registerSpy.calledWithMatch(`exframe-cache-manager-${instance.id}`, sinon.match({
-          onSignal: sinon.match.func,
+        expect(registerSpy.calledWithMatch(`exframe-cache-manager-${instance.id}`, match({
+          onSignal: match.func,
           order: 'last'
         }))).to.be.true;
       });
     });
 
     describe('instance', () => {
-      const app = cacheManager.create(options);
+      const app = create(options);
 
       beforeEach(() => {
         prometheusClient.register.clear();
@@ -69,6 +70,39 @@ context('Test User Profile Middleware', () => {
         await app.flushCache({ log: { info: (info) => { console.log(info); } } }, cacheKey);
       });
 
+      it('validates the setItemIfNotExists function on the basis of key and value', async () => {
+        const data = await app.setItemIfNotExists(cacheKey, 'value1');
+        expect(data).to.be.ok.and.to.eql('value1');
+
+        const metrics = prometheusClient.register.getMetricsAsArray().filter(({ name }) => name.includes('setItemIfNotExists'));
+        expect(metrics).to.be.an('array').and.to.have.lengthOf(1);
+
+        await app.flushCache({ log: { info: (info) => { console.log(info); } } }, cacheKey);
+      });
+
+      it('validates the setItemIfNotExists function on the basis of key, value, and ttl', async () => {
+        const data = await app.setItemIfNotExists(cacheKey, 'value1', 1000);
+        expect(data).to.be.ok.and.to.eql('value1');
+
+        const metrics = prometheusClient.register.getMetricsAsArray().filter(({ name }) => name.includes('setItemIfNotExists'));
+        expect(metrics).to.be.an('array').and.to.have.lengthOf(1);
+
+        await app.flushCache({ log: { info: (info) => { console.log(info); } } }, cacheKey);
+      });
+
+      it('validates the setItemIfNotExists function returns null if key is already set', async () => {
+        const data1 = await app.setItemIfNotExists(cacheKey, 'value1', 1000);
+        expect(data1).to.be.ok.and.to.eql('value1');
+
+        const data2 = await app.setItemIfNotExists(cacheKey, 'value2');
+        expect(data2).to.eql(null);
+
+        const metrics = prometheusClient.register.getMetricsAsArray().filter(({ name }) => name.includes('setItemIfNotExists'));
+        expect(metrics).to.be.an('array').and.to.have.lengthOf(1);
+
+        await app.flushCache({ log: { info: (info) => { console.log(info); } } }, cacheKey);
+      });
+
       it('validate the getItem function on the basis of key', async () => {
         await app.setItem(cacheKey, 'someValue');
         const value = await app.getItem(cacheKey);
@@ -94,7 +128,7 @@ context('Test User Profile Middleware', () => {
           await waitTimeout(5000);
           return 'finished';
         };
-        const stub = sinon.stub(app.redisCache, 'get').callsFake(fake);
+        const stub = _stub(app.redisCache, 'get').callsFake(fake);
 
         await app.setItem(cacheKey, 'someValue');
         const context = { log: { info: (info) => { console.log(info); } } };
@@ -144,7 +178,7 @@ context('Test User Profile Middleware', () => {
       });
 
       it('close drains the redis pool', async () => {
-        const app1 = cacheManager.create(options);
+        const app1 = create(options);
         await app1.setItem(cacheKey, 'someValue');
         const value = await app1.getItem(cacheKey);
         expect(value).to.eql('someValue');