@cap-js-community/common 0.3.5 → 0.4.0

package/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## Version 0.4.0 - 2026-03-10
+
+### Added
+
+- Redis Sentinel Support
+- Open dependencies to allow Redis 5
+
 ## Version 0.3.5 - 2026-02-03
 
 ### Fixed

package/README.md

@@ -399,6 +399,31 @@ const mainClient = await RedisClient.create().createMainClientAndConnect(options
 
 For details on Redis `createClient` configuration options see [Redis Client Configuration](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
 
+### Redis Sentinel Support
+
+Redis Sentinel mode is activated when `credentials.sentinel_nodes` is present and takes priority over cluster mode.
+
+```json
+{
+  "cds": {
+    "requires": {
+      "redis": {
+        "credentials": {
+          "sentinel_nodes": [
+            { "host": "sentinel1.example.com", "port": 26379 },
+            { "host": "sentinel2.example.com", "port": 26379 }
+          ],
+          "master_name": "myprimary"
+        }
+      }
+    }
+  }
+}
+```
+
+The `master_name` identifies which Redis master the Sentinels monitor. Alternatively, the master name can be provided as a URI fragment in `credentials.uri` (e.g., `redis://host#myprimary`).
+If `sentinel_nodes[].port` is omitted, it defaults to `26379`. Both `host` and `hostname` are accepted for node addresses.
+
 ## Local HTML5 Repository
 
 Developing HTML5 apps against hybrid environments including Approuter component requires a local HTML5 repository to directly test the changes to UI5 applications without deployment to a remote HTML5 repository.
@@ -432,8 +457,12 @@ The CDM Builder allows to build a CDM file `cdm.json` from apps, roles and porta
 
 - Build CDM: `cdm-build`
 
-The generated CDM is generated at `app/cdm.json` and can be included into HTML5 Repository automatically
-when copied at `resources/cdm.json` during build time.
+The generated CDM is (per default) generated at `app/cdm.json`.
+
+### Options:
+
+- `-f, --force`: Overwrite existing CDM file. Default is `false`
+- `-t, --target`: Specify target path for generated CDM file. Default is `app/cdm.json`
 
 ## Support, Feedback, Contributing
 

package/bin/cdm-build.js

@@ -15,7 +15,11 @@ process.argv = process.argv.map((arg) => {
   return arg.toLowerCase();
 });
 
-program.version(packageJSON.version, "-v, --version").usage("[options]").option("-f, --force", "Force generation");
+program
+  .version(packageJSON.version, "-v, --version")
+  .usage("[options]")
+  .option("-f, --force", "Force generation")
+  .option("-t, --target <target>", "Target path");
 
 program.unknownOption = function () {};
 program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/common",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "CAP Node.js Community Common",
   "homepage": "https://cap.cloud.sap/",
   "engines": {
@@ -53,21 +53,21 @@
     "commander": "^14.0.3",
     "express": "^4.22.1 || ^5.2.1",
     "http-proxy-middleware": "^3.0.5",
-    "redis": "^4.7.1",
+    "redis": "^4.7.1 || ^5.11.0",
     "verror": "^1.10.1"
   },
   "devDependencies": {
     "@cap-js-community/common": "./",
     "@cap-js/cds-test": "^0.4.1",
-    "@cap-js/sqlite": "^2.1.2",
-    "@sap/cds": "^9.7.0",
+    "@cap-js/sqlite": "^2.2.0",
+    "@sap/cds": "^9.8.1",
     "@sap/cds-common-content": "^3.1.0",
-    "@sap/cds-dk": "^9.7.0",
-    "eslint": "^9.39.2",
+    "@sap/cds-dk": "^9.7.2",
+    "eslint": "^10.0.3",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-jest": "^29.12.1",
-    "eslint-plugin-n": "^17.23.2",
-    "jest": "^30.2.0",
+    "eslint-plugin-jest": "^29.15.0",
+    "eslint-plugin-n": "^17.24.0",
+    "jest": "^30.3.0",
     "jest-html-reporters": "^3.1.7",
     "jest-junit": "^16.0.0",
     "prettier": "^3.8.1",

package/src/cdm-build/CDMBuilder.js

@@ -64,7 +64,7 @@ class CDMBuilder {
     this.addRoles(cdm, roles);
     if (!this.options.skipWrite) {
       fs.mkdirSync(path.dirname(this.targetPath), { recursive: true });
-      fs.writeFileSync(this.targetPath, JSON.stringify(cdm, null, 2));
+      fs.writeFileSync(this.targetPath, JSON.stringify(Object.values(cdm.payload).flat(), null, 2));
     }
     return cdm;
   }
@@ -171,7 +171,7 @@ class CDMBuilder {
     cdm.payload.spaces.push(space);
     let index = 1;
     for (const group of cdm.payload.groups || []) {
-      const pageId = `${this.namespace}-page${cdm.payload.groups.length > 1 ? `-${index++}` : ""}\`;`;
+      const pageId = `${this.namespace}-page${cdm.payload.groups.length > 1 ? `-${index++}` : ""}`;
       cdm.payload.pages.push({
         _version: this.version,
         identification: {
@@ -221,11 +221,12 @@ class CDMBuilder {
               },
             },
             tags: {
+              keywords: [],
               technicalAttributes: ["APPTYPE_HOMEPAGE"],
             },
           },
           "sap.integration": {
-            urlTemplateId: `${this.namespace}-urltemplate.home`,
+            urlTemplateId: `${this.namespace}-urltemplate-home`,
             urlTemplateParams: { path: "" },
           },
           "sap.ui": {

package/src/redis-client/RedisClient.js

@@ -9,6 +9,7 @@ const TIMEOUT_SHUTDOWN = 2500;
 
 class RedisClient {
   #clusterClient = false;
+  #sentinelClient = false;
   #beforeCloseHandler;
   constructor(name, env) {
     this.name = name;
@@ -51,27 +52,26 @@ class RedisClient {
   async createClientAndConnect(options, errorHandlerCreateClient, isConnectionCheck) {
     try {
       const client = this.createClientBase(options);
-      if (!client) {
-        return;
-      }
-      if (!isConnectionCheck) {
-        client.on("error", (err) => {
-          const dateNow = Date.now();
-          if (dateNow - this.lastErrorLog > LOG_AFTER_SEC * 1000) {
-            this.log.error("Error from redis client", err);
-            this.lastErrorLog = dateNow;
-          }
-        });
+      if (client) {
+        if (!isConnectionCheck) {
+          client.on("error", (err) => {
+            const dateNow = Date.now();
+            if (dateNow - this.lastErrorLog > LOG_AFTER_SEC * 1000) {
+              this.log.error("Error from redis client", err);
+              this.lastErrorLog = dateNow;
+            }
+          });
 
-        client.on("reconnecting", () => {
-          const dateNow = Date.now();
-          if (dateNow - this.lastErrorLog > LOG_AFTER_SEC * 1000) {
-            this.log.info("Redis client trying reconnect...");
-            this.lastErrorLog = dateNow;
-          }
-        });
+          client.on("reconnecting", () => {
+            const dateNow = Date.now();
+            if (dateNow - this.lastErrorLog > LOG_AFTER_SEC * 1000) {
+              this.log.info("Redis client trying reconnect...");
+              this.lastErrorLog = dateNow;
+            }
+          });
+        }
+        await client.connect();
       }
-      await client.connect();
       return client;
     } catch (err) {
       errorHandlerCreateClient(err);
@@ -105,20 +105,24 @@ class RedisClient {
   createClientBase(redisOptions = {}) {
     const { credentials, options } =
       (this.env ? cds.env.requires[`redis-${this.env}`] : undefined) || cds.env.requires["redis"] || {};
-    const socket = {
-      host: credentials?.hostname ?? "127.0.0.1",
-      tls: !!credentials?.tls,
-      port: credentials?.port ?? 6379,
-      ...options?.socket,
-      ...redisOptions.socket,
-    };
-    const socketOptions = {
-      ...options,
-      ...redisOptions,
-      password: redisOptions?.password ?? options?.password ?? credentials?.password,
-      socket,
-    };
+
     try {
+      if (credentials?.sentinel_nodes?.length > 0) {
+        return this.createSentinelClient(credentials, options, redisOptions);
+      }
+      const socket = {
+        host: credentials?.hostname ?? "127.0.0.1",
+        tls: !!credentials?.tls,
+        port: credentials?.port ?? 6379,
+        ...options?.socket,
+        ...redisOptions.socket,
+      };
+      const socketOptions = {
+        ...options,
+        ...redisOptions,
+        password: redisOptions?.password ?? options?.password ?? credentials?.password,
+        socket,
+      };
       if (credentials?.cluster_mode) {
         this.#clusterClient = true;
         return redis.createCluster({
@@ -128,8 +132,61 @@ class RedisClient {
       }
       return redis.createClient(socketOptions);
     } catch (err) {
-      throw new Error("Error during create client with redis-cache service" + err);
+      throw new Error("Error during create client with redis-cache service", err);
+    }
+  }
+
+  createSentinelClient(credentials, options, redisOptions) {
+    const masterName = this.extractMasterName(credentials);
+    const sentinelNodes = credentials.sentinel_nodes.map((node) => ({
+      host: node.host ?? node.hostname,
+      port: node.port ?? 26379,
+    }));
+    const clientOptions = {
+      ...options,
+      ...redisOptions,
+      password: redisOptions?.password ?? options?.password ?? credentials?.password,
+      socket: {
+        tls: !!credentials?.tls,
+        ...options?.socket,
+        ...redisOptions?.socket,
+      },
+    };
+    this.#sentinelClient = true;
+    this.log.info("Creating Redis Sentinel client", { masterName, nodeCount: sentinelNodes.length });
+    return redis.createSentinel({
+      name: masterName,
+      sentinelRootNodes: sentinelNodes,
+      nodeClientOptions: clientOptions,
+      sentinelClientOptions: clientOptions,
+      passthroughClientErrorEvents: true,
+    });
+  }
+
+  /**
+   * Extracts the Sentinel master name from credentials.
+   * Priority: master_name field > URI fragment
+   * @param {Object} credentials - Redis credentials
+   * @returns {string} Master name
+   * @throws {Error} If master name cannot be determined
+   */
+  extractMasterName(credentials) {
+    if (credentials?.master_name) {
+      return credentials.master_name;
+    }
+    if (credentials?.uri) {
+      try {
+        const url = new URL(credentials.uri);
+        if (url.hash && url.hash.length > 1) {
+          return url.hash.slice(1);
+        }
+      } catch (e) {
+        this.log.warn("Failed to parse master name from URI", e.message);
+      }
     }
+    throw new Error(
+      "Redis Sentinel master name not found. Provide credentials.master_name or include #mastername in credentials.uri",
+    );
   }
 
   subscribeChannel(options, channel, subscribeHandler) {
@@ -149,6 +206,9 @@ class RedisClient {
   subscribeChannels(options, errorHandlerCreateClient) {
     this.subscriberClientPromise = this.createClientAndConnect(options, errorHandlerCreateClient)
       .then((client) => {
+        if (!client) {
+          return;
+        }
         for (const channel in this.subscribedChannels) {
           const fn = this.subscribedChannels[channel];
           client._subscribedChannels ??= {};
@@ -214,7 +274,9 @@ class RedisClient {
 
   async resilientClientClose(client) {
     try {
-      if (client?.quit) {
+      if (client?.close) {
+        await client.close();
+      } else if (client?.quit) {
         await client.quit();
       }
     } catch (err) {
@@ -248,6 +310,10 @@ class RedisClient {
     return this.#clusterClient;
   }
 
+  get isSentinel() {
+    return this.#sentinelClient;
+  }
+
   static create(name = "default", env) {
     env ??= name;
     RedisClient._create ??= {};

package/src/replication-cache/ReplicationCache.js

@@ -741,7 +741,7 @@ class ReplicationCacheEntry {
     selectQuery.replication = true;
     const chunkSize = this.cache.options.chunks;
     let offset = 0;
-    let entries = [];
+    let entries;
     do {
       entries = await srcTx.run(selectQuery.limit(chunkSize, offset));
       if (entries.length > 0) {