@cap-js-community/common 0.3.4 → 0.4.0

package/CHANGELOG.md

@@ -5,6 +5,23 @@ 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
+
+- Express 5 (with CDS 9.7)
+
+### Added
+
+- CDM Builder
+
 ## Version 0.3.4 - 2026-01-20
 
 ### Fixed

package/README.md

@@ -15,11 +15,13 @@ This project provides common functionality for CDS services to be consumed with
 
 ## Table of Contents
 
-- [Replication Cache](#replication-cache)
-- [Migration Check](#migration-check)
-- [Rate Limiting](#rate-limiting)
-- [Redis Client](#redis-client)
-- [Local HTML5 Repository](#local-html5-repository)
+- **Features:**
+  - [Replication Cache](#replication-cache)
+  - [Migration Check](#migration-check)
+  - [Rate Limiting](#rate-limiting)
+  - [Redis Client](#redis-client)
+  - [Local HTML5 Repository](#local-html5-repository)
+  - [CDM Builder](#cdm-builder)
 - [Support, Feedback, Contributing](#support-feedback-contributing)
 - [Code of Conduct](#code-of-conduct)
 - [Licensing](#licensing)
@@ -397,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.
@@ -424,6 +451,19 @@ Developing HTML5 apps against hybrid environments including Approuter component
 All apps and libraries located in `app` folder and containing an `ui5.yaml` are redirected to local HTML5 repository
 served from local file system. All other requests are proxied to the remote HTML5 repository.
 
+## CDM Builder
+
+The CDM Builder allows to build a CDM file `cdm.json` from apps, roles and portal content:
+
+- Build CDM: `cdm-build`
+
+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
 
 This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js-community/common/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).

package/bin/cdm-build.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+"use strict";
+
+/* eslint-disable no-console */
+/* eslint-disable n/no-process-exit */
+
+const commander = require("commander");
+const program = new commander.Command();
+
+const packageJSON = require("../package.json");
+
+const { CDMBuilder } = require("../src/cdm-build");
+
+process.argv = process.argv.map((arg) => {
+  return arg.toLowerCase();
+});
+
+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);
+
+(async () => {
+  try {
+    const options = program.opts();
+    await new CDMBuilder(options).build();
+  } catch (err) {
+    console.error(err);
+    process.exit(-1);
+  }
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/common",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "CAP Node.js Community Common",
   "homepage": "https://cap.cloud.sap/",
   "engines": {
@@ -26,9 +26,12 @@
   "main": "index.js",
   "types": "index.d.ts",
   "bin": {
-    "cdsmc": "bin/cdsmc.js",
-    "lh5r": "bin/local-html5-repo.js",
-    "local-html5-repo": "bin/local-html5-repo.js"
+    "cdsmc": "./bin/cdsmc.js",
+    "migration-check": "./bin/cdsmc.js",
+    "cdm": "./bin/cdm-build.js",
+    "cdm-build": "./bin/cdm-build.js",
+    "lh5r": "./bin/local-html5-repo.js",
+    "local-html5-repo": "./bin/local-html5-repo.js"
   },
   "scripts": {
     "start": "cds-serve",
@@ -47,27 +50,27 @@
     "audit": "npm audit --only=prod"
   },
   "dependencies": {
-    "commander": "^14.0.2",
-    "express": "^4.22.1",
+    "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.6.1",
+    "@cap-js/sqlite": "^2.2.0",
+    "@sap/cds": "^9.8.1",
     "@sap/cds-common-content": "^3.1.0",
-    "@sap/cds-dk": "^9.6.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.1",
-    "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.7.4",
+    "prettier": "^3.8.1",
     "shelljs": "^0.10.0"
   },
   "cds": {
@@ -76,7 +79,9 @@
         "vcap": {
           "label": "redis-cache"
         }
-      }
+      },
+      "html5-repo": true,
+      "portal": true
     },
     "migrationCheck": {
       "baseDir": "migration-check",

package/src/cdm-build/CDMBuilder.js

@@ -0,0 +1,497 @@
+"use strict";
+
+const path = require("path");
+const fs = require("fs");
+const cds = require("@sap/cds");
+
+const COMPONENT_NAME = "/cap-js-community-common/cdm-build";
+
+const DEFAULT_ICON = "sap-icon://activity-2";
+const DEFAULT_VERSION = "3.2.0";
+
+const regexLanguageFile = /.*\.properties$/;
+const regexLanguageSuffixFile = /.*?_([a-z]{2}(?:_[a-z]{2})?)\.properties/i;
+
+class CDMBuilder {
+  constructor(options = {}) {
+    this.component = COMPONENT_NAME;
+
+    this.options = options;
+    this.rootPath = options.root || process.cwd();
+
+    const project = this.deriveProject();
+
+    this.appPath = options.app || path.join(this.rootPath, "app");
+    this.portalSitePath = options.portalSite || path.join(this.appPath, "portal", "portal-site");
+    this.cdmPath = options.cdm || path.join(this.portalSitePath, "CommonDataModel.json");
+    this.targetPath = options.target || path.join(this.appPath, "cdm.json");
+    this.xsSecurityPath = options.xsSecurity || path.join(this.rootPath, "xs-security.json");
+
+    this.icon = options.icon || DEFAULT_ICON;
+    this.version = options.version || DEFAULT_VERSION;
+    this.namespace = options.namespace || project.name;
+    this.description = options.description || project.description;
+    this.defaultLanguage = cds.env.i18n?.default_language || options.language || "en";
+    this.i18nPath = options.i18n || "i18n";
+    this.i18nData = this.loadI18n(path.join(this.portalSitePath, this.i18nPath));
+    this.i18nBundle = options.i18nBundle || false;
+  }
+
+  async build() {
+    if (!this.options.skipWrite && !this.options.force && fs.existsSync(this.targetPath)) {
+      cds.log(this.component).info("Generation is skipped. CDM file already exists", this.targetPath);
+      return;
+    }
+    const cdm = fs.existsSync(this.cdmPath)
+      ? require(this.cdmPath)
+      : {
+          _version: this.version,
+          identification: {
+            id: `${this.namespace}-flp`,
+            title: this.namespace,
+            entityType: "bundle",
+          },
+          payload: {},
+        };
+    const apps = this.lookupApps(this.appPath);
+    const roles = this.lookupRoles(apps);
+    this.enhanceExisting(cdm);
+    this.addCatalogsAndGroups(cdm, apps);
+    this.addSitesAndPages(cdm);
+    this.addHomepageApp(cdm);
+    this.addBusinessApps(cdm, apps);
+    this.addUrlTemplates(cdm);
+    this.addRoles(cdm, roles);
+    if (!this.options.skipWrite) {
+      fs.mkdirSync(path.dirname(this.targetPath), { recursive: true });
+      fs.writeFileSync(this.targetPath, JSON.stringify(Object.values(cdm.payload).flat(), null, 2));
+    }
+    return cdm;
+  }
+
+  deriveProject() {
+    const packageJSON = require(path.join(this.rootPath, "package.json"));
+    const rawName = packageJSON.name.split("/").pop();
+    const parts = rawName.split(/[-.]/);
+    const name = parts.join(".");
+    return {
+      name,
+      description: packageJSON.description || name,
+    };
+  }
+
+  enhanceExisting(cdm) {
+    cdm._version = this.version;
+    cdm.payload.catalogs ||= [];
+    let index = 1;
+    for (const catalog of cdm.payload.catalogs) {
+      catalog._version = this.version;
+      catalog.identification.id = `${this.namespace}-catalog${cdm.payload.catalogs.length > 1 ? `-${index++}` : ""}`;
+      for (const viz of catalog.payload.viz || []) {
+        viz.appId ??= viz.id;
+      }
+      if (!this.i18nBundle) {
+        delete catalog.identification.i18n;
+        catalog.texts = this.buildTexts(this.i18nData);
+      }
+    }
+    cdm.payload.groups ||= [];
+    index = 1;
+    for (const group of cdm.payload.groups) {
+      group._version = this.version;
+      group.identification.id = `${this.namespace}-group${cdm.payload.groups.length > 1 ? `-${index++}` : ""}`;
+      if (!this.i18nBundle) {
+        delete group.identification.i18n;
+        group.texts = this.buildTexts(this.i18nData);
+      }
+    }
+    delete cdm.payload.sites;
+  }
+
+  addCatalogsAndGroups(cdm, apps) {
+    cdm.payload.catalogs ||= [];
+    if (!cdm.payload.catalogs.length) {
+      const catalog = {
+        _version: this.version,
+        identification: {
+          id: `${this.namespace}-catalog`,
+          title: "{{title}}",
+          entityType: "catalog",
+          ...(this.i18nBundle ? { i18n: "i18n/catalog.properties" } : {}),
+        },
+        payload: { viz: [] },
+        ...(!this.i18nBundle ? { texts: this.buildTexts(this.i18nData, ["title"], this.description) } : {}),
+      };
+      for (const app of apps) {
+        catalog.payload.viz.push({
+          appId: app.appId,
+          vizId: app.defaultViz,
+        });
+      }
+      cdm.payload.catalogs.push(catalog);
+    }
+    cdm.payload.groups ||= [];
+    if (!cdm.payload.groups.length) {
+      const group = {
+        _version: this.version,
+        identification: {
+          id: `${this.namespace}-group`,
+          title: "{{title}}",
+          entityType: "group",
+          ...(this.i18nBundle ? { i18n: "i18n/group.properties" } : {}),
+        },
+        payload: { viz: [] },
+        ...(!this.i18nBundle ? { texts: this.buildTexts(this.i18nData, ["title"], this.description) } : {}),
+      };
+      for (const app of apps) {
+        group.payload.viz.push({
+          id: app.id,
+          appId: app.appId,
+          vizId: app.defaultViz,
+        });
+      }
+      cdm.payload.groups.push(group);
+    }
+  }
+
+  addSitesAndPages(cdm) {
+    cdm.payload.spaces ||= [];
+    cdm.payload.pages ||= [];
+    const space = {
+      _version: this.version,
+      identification: {
+        id: `${this.namespace}-space`,
+        title: "{{title}}",
+        entityType: "space",
+        ...(this.i18nBundle ? { i18n: "i18n/space.properties" } : {}),
+      },
+      payload: { contentNodes: [] },
+      ...(!this.i18nBundle ? { texts: this.buildTexts(this.i18nData, ["title"], this.description) } : {}),
+    };
+    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++}` : ""}`;
+      cdm.payload.pages.push({
+        _version: this.version,
+        identification: {
+          id: pageId,
+          title: "{{title}}",
+          entityType: "page",
+          ...(this.i18nBundle ? { i18n: "i18n/page.properties" } : {}),
+        },
+        payload: {
+          sections: [
+            {
+              id: `${this.namespace}-section`,
+              title: "{{title}}",
+              viz: group.payload.viz,
+            },
+          ],
+        },
+        ...(!this.i18nBundle ? { texts: this.buildTexts(this.i18nData, ["title"], this.description) } : {}),
+      });
+      space.payload.contentNodes.push({
+        type: "page",
+        id: pageId,
+      });
+    }
+  }
+
+  addHomepageApp(cdm) {
+    cdm.payload.apps ||= [];
+    cdm.payload.apps.push({
+      _version: this.version,
+      identification: {
+        id: `${this.namespace}-shell-home`,
+        entityType: "businessapp",
+        title: "{{title}}",
+        ...(this.i18nBundle ? { i18n: "i18n/businessapp.properties" } : {}),
+      },
+      payload: {
+        targetAppConfig: {
+          "sap.app": {
+            crossNavigation: {
+              inbounds: {
+                default: {
+                  semanticObject: "Shell",
+                  action: "home",
+                  signature: {},
+                },
+              },
+            },
+            tags: {
+              keywords: [],
+              technicalAttributes: ["APPTYPE_HOMEPAGE"],
+            },
+          },
+          "sap.integration": {
+            urlTemplateId: `${this.namespace}-urltemplate-home`,
+            urlTemplateParams: { path: "" },
+          },
+          "sap.ui": {
+            icons: { icon: this.icon },
+          },
+        },
+        visualizations: {
+          default: {
+            vizType: "sap.ushell.StaticAppLauncher",
+            vizConfig: {
+              "sap.app": { title: "{{title}}" },
+              "sap.flp": {
+                target: { type: "IBN", inboundId: "default" },
+              },
+            },
+          },
+        },
+        defaultViz: "default",
+      },
+      ...(!this.i18nBundle ? { texts: this.buildTexts(this.i18nData, ["title"], this.description) } : {}),
+    });
+  }
+
+  addBusinessApps(cdm, apps) {
+    cdm.payload.apps ||= [];
+    for (const app of apps) {
+      const defaultViz = app.defaultViz;
+      if (!defaultViz) {
+        continue;
+      }
+      const icon = app.crossNavigation.inbounds[defaultViz].icon || this.icon;
+      const texts = this.buildAppTexts(app.i18n, app.id);
+      cdm.payload.apps.push({
+        _version: this.version,
+        identification: {
+          id: app.id,
+          entityType: "businessapp",
+          title: "{{title}}",
+          ...(this.i18nBundle ? { i18n: "i18n/app.properties" } : {}),
+        },
+        payload: {
+          targetAppConfig: {
+            "sap.app": { crossNavigation: app.crossNavigation },
+            "sap.integrations": [
+              {
+                navMode: "explace",
+                urlTemplateId: `${this.namespace}-urltemplate`,
+                urlTemplateParams: { path: "" },
+              },
+            ],
+            "sap.ui": { icons: { icon } },
+          },
+          visualizations: {
+            [defaultViz]: {
+              vizType: "sap.ushell.StaticAppLauncher",
+              vizConfig: {
+                "sap.app": { title: "{{title}}" },
+                "sap.flp": {
+                  target: { type: "IBN", inboundId: defaultViz },
+                },
+              },
+            },
+          },
+          defaultViz,
+        },
+        ...(!this.i18nBundle ? { texts } : {}),
+      });
+    }
+  }
+
+  addUrlTemplates(cdm) {
+    cdm.payload.urlTemplates ||= [];
+    const templates = [
+      {
+        id: `${this.namespace}-urltemplate-home`,
+        template: "{+_baseUrl}{+path}#Shell-home{?intentParameters*}",
+      },
+      {
+        id: `${this.namespace}-urltemplate`,
+        template: "{+_baseUrl}{+path}#{+semanticObject}-{+action}{?intentParameters*}",
+      },
+    ];
+    for (const template of templates) {
+      cdm.payload.urlTemplates.push({
+        _version: this.version,
+        identification: {
+          id: template.id,
+          entityType: "urltemplate",
+          title: "{{title}}",
+          ...(this.i18nBundle ? { i18n: "i18n/urltemplate.properties" } : {}),
+        },
+        payload: {
+          urlTemplate: template.template,
+          parameters: {
+            mergeWith: "/urlTemplates/urltemplate.base/payload/parameters/names",
+            names: {
+              path: "{./sap.integration/urlTemplateParams/path}",
+              intentParameters: "{*}",
+            },
+          },
+          capabilities: { navigationMode: "standalone" },
+        },
+        ...(!this.i18nBundle ? { texts: this.buildTexts(this.i18nData) } : {}),
+      });
+    }
+  }
+
+  addRoles(cdm, roles) {
+    cdm.payload.roles ||= [];
+    let scopes = {};
+    if (fs.existsSync(this.xsSecurityPath)) {
+      const xsSecurity = require(this.xsSecurityPath);
+      scopes = Object.fromEntries(xsSecurity.scopes.map((scope) => [this.localScope(scope.name), scope]));
+    }
+    for (const role of Object.keys(roles)) {
+      const scope = scopes[role];
+      cdm.payload.roles.push({
+        _version: this.version,
+        identification: {
+          id: role,
+          entityType: "role",
+          title: "{{title}}",
+          ...(this.i18nBundle ? { i18n: "i18n/role.properties" } : {}),
+        },
+        payload: {
+          catalogs: [{ id: `${this.namespace}-catalog` }],
+          groups: [{ id: `${this.namespace}-group` }],
+          spaces: [{ id: `${this.namespace}-space` }],
+          apps: [...roles[role].map((app) => ({ id: app.id })), { id: `${this.namespace}-shell-home` }],
+        },
+        ...(!this.i18nBundle
+          ? {
+              texts: [
+                {
+                  locale: "",
+                  textDictionary: {
+                    title: scope?.description || role,
+                  },
+                },
+              ],
+            }
+          : {}),
+      });
+    }
+  }
+
+  lookupApps(appRoot) {
+    const apps = [];
+    const dirs = fs
+      .readdirSync(appRoot, { withFileTypes: true })
+      .filter((dir) => dir.isDirectory())
+      .map((dir) => dir.name);
+    for (const dir of dirs) {
+      const ui5Yaml = path.join(appRoot, dir, "ui5.yaml");
+      if (!fs.existsSync(ui5Yaml)) {
+        continue;
+      }
+      const manifestPath = path.join(appRoot, dir, "webapp", "manifest.json");
+      if (!fs.existsSync(manifestPath)) {
+        continue;
+      }
+      const manifest = require(manifestPath);
+      if (manifest["sap.flp"]?.type === "plugin") {
+        continue;
+      }
+      const appId = manifest["sap.app"]?.id;
+      if (!appId || appId.endsWith(".extension")) {
+        continue;
+      }
+      const crossNavigation = manifest["sap.app"]?.crossNavigation || {};
+      const defaultViz = Object.keys(crossNavigation.inbounds || {})[0];
+      const scopes = manifest["sap.platform.cf"]?.oAuthScopes?.map((s) => this.localScope(s)) || [];
+      const i18n = this.loadI18n(path.join(appRoot, dir, "webapp", "i18n"));
+      apps.push({
+        id: appId,
+        appId,
+        defaultViz,
+        crossNavigation,
+        scopes,
+        i18n,
+      });
+    }
+    return apps;
+  }
+
+  lookupRoles(apps) {
+    const roles = {};
+    for (const app of apps) {
+      for (const scope of app.scopes) {
+        roles[scope] ||= [];
+        roles[scope].push(app);
+      }
+    }
+    return roles;
+  }
+
+  localScope(scope) {
+    return scope.startsWith("$XSAPPNAME.") ? scope.slice(11) : scope;
+  }
+
+  loadI18n(dir) {
+    const result = {
+      [this.defaultLanguage]: {},
+    };
+    try {
+      for (const file of fs.readdirSync(dir)) {
+        if (!regexLanguageFile.test(file)) {
+          continue;
+        }
+        const texts = cds.load.properties(path.join(dir, file));
+        const match = file.match(regexLanguageSuffixFile);
+        const lang = match?.[1] || this.defaultLanguage;
+        result[lang] ||= {};
+        Object.assign(result[lang], texts);
+      }
+    } catch {
+      /* ignore */
+    }
+    return result;
+  }
+
+  buildTexts(i18n, keys, defaultText = "") {
+    const texts = [];
+    for (const locale of Object.keys(i18n)) {
+      texts.push({
+        locale,
+        textDictionary: keys
+          ? Object.fromEntries(keys.map((key) => [key, i18n[locale][key] || defaultText]))
+          : i18n[locale],
+      });
+    }
+    texts.push({
+      locale: "",
+      textDictionary: keys
+        ? Object.fromEntries(keys.map((key) => [key, i18n[this.defaultLanguage][key] || defaultText]))
+        : i18n[this.defaultLanguage],
+    });
+    return texts;
+  }
+
+  buildAppTexts(i18n, app) {
+    const texts = [];
+    for (const locale of Object.keys(i18n)) {
+      const title =
+        i18n[locale].fioriAppTitle || i18n[locale].appTitle || i18n[locale].app_title || i18n[locale].appTitleReworked;
+      if (!title) {
+        throw new Error(`Missing title for locale ${locale} in app "${app}"`);
+      }
+      texts.push({
+        locale,
+        textDictionary: { title },
+      });
+    }
+    texts.push({
+      locale: "",
+      textDictionary: {
+        title:
+          i18n[this.defaultLanguage]?.fioriAppTitle ||
+          i18n[this.defaultLanguage]?.appTitle ||
+          i18n[this.defaultLanguage]?.app_title ||
+          i18n[this.defaultLanguage]?.appTitleReworked,
+      },
+    });
+    return texts;
+  }
+}
+
+module.exports = CDMBuilder;

package/src/cdm-build/index.js

@@ -0,0 +1,5 @@
+"use strict";
+
+module.exports = {
+  CDMBuilder: require("./CDMBuilder"),
+};

package/src/index.js

@@ -1,6 +1,7 @@
 "use strict";
 
 module.exports = {
+  CDMBuilder: require("./cdm-build").CDMBuilder,
   LocalHTML5Repo: require("./local-html5-repo").LocalHTML5Repo,
   MigrationCheck: require("./migration-check").MigrationCheck,
   RateLimiting: require("./rate-limiting").RateLimiting,

package/src/local-html5-repo/LocalHTML5Repo.js

@@ -1,6 +1,5 @@
 "use strict";
 
-/* eslint-disable no-console */
 /* eslint-disable n/no-process-exit */
 
 // Suppress deprecation warning in Node 22 due to http-proxy using util._extend()
@@ -10,23 +9,35 @@ const fs = require("fs");
 const path = require("path");
 const express = require("express");
 const { createProxyMiddleware } = require("http-proxy-middleware");
+const cds = require("@sap/cds");
 
-const PORT = process.env.PORT || 3001;
-const DEFAULT_ENV_PATH = path.join(process.cwd(), "approuter/default-env.json");
+const DEFAULT_ENV_NAME = "default-env.json";
+const DEFAULT_ENV_PATHS = [
+  path.join(process.cwd(), "app", "router", DEFAULT_ENV_NAME),
+  path.join(process.cwd(), "approuter", DEFAULT_ENV_NAME),
+];
 const APP_ROOT = path.join(process.cwd(), "app");
+const PORT = process.env.PORT || 3001;
 
-const COMPONENT_NAME = "/cap-js-community-common/localHTML5Repo";
+const COMPONENT_NAME = "/cap-js-community-common/local-html5-repo";
 
 class LocalHTML5Repo {
   constructor(options) {
     this.component = COMPONENT_NAME;
     this.port = options?.port || PORT;
-    this.path = options?.path || DEFAULT_ENV_PATH;
-
+    this.path = options?.path;
+    if (!this.path) {
+      for (const path of DEFAULT_ENV_PATHS) {
+        if (fs.existsSync(path)) {
+          this.path = path;
+          break;
+        }
+      }
+    }
     try {
       this.defaultEnv = require(this.path);
     } catch (err) {
-      console.error(`Cannot read default-env.json at ${this.path}`);
+      cds.log(this.component).error(`Cannot read default-env.json at ${this.path}`);
       throw err;
     }
   }
@@ -35,7 +46,7 @@ class LocalHTML5Repo {
     return new Promise((resolve) => {
       this.adjustDefaultEnv();
 
-      console.log("Registering apps:");
+      cds.log(this.component).info("Registering apps:");
       const app = express();
 
       // Serve every webapp
@@ -64,7 +75,7 @@ class LocalHTML5Repo {
             }),
           );
 
-          console.log(`- ${name} [${type}] -> ${path.join(APP_ROOT, appDirectory)}`);
+          cds.log(this.component).info(`- ${name} [${type}] -> ${path.join(APP_ROOT, appDirectory)}`);
         }
       }
 
@@ -80,7 +91,7 @@ class LocalHTML5Repo {
         ws: true,
         logLevel: "warn",
         onError(err, req, res) {
-          console.error("HTML5 Repo proxy error:", err.message);
+          cds.log(this.component).error("HTML5 Repo proxy error:", err.message);
           res.status(502).end("Bad Gateway");
         },
       });
@@ -89,7 +100,7 @@ class LocalHTML5Repo {
       app.use("/", html5RepoProxy);
 
       this.server = app.listen(this.port, () => {
-        console.log(`Local HTML5 repository running on port ${this.port}`);
+        cds.log(this.component).info(`Local HTML5 repository running on port ${this.port}`);
         resolve(this.server);
       });
     });
@@ -118,10 +129,8 @@ class LocalHTML5Repo {
 
   writeDefaultEnv() {
     const url = this.defaultEnv.VCAP_SERVICES["html5-apps-repo"][0].credentials.uri;
-
-    console.log(`Rewriting HTML5 Repo URL in default-env.json of approuter: ${url}`);
-
-    fs.writeFileSync(DEFAULT_ENV_PATH, JSON.stringify(this.defaultEnv, null, 2) + "\n");
+    cds.log(this.component).info(`Rewriting HTML5 Repo URL in default-env.json of approuter: ${url}`);
+    fs.writeFileSync(this.path, JSON.stringify(this.defaultEnv, null, 2) + "\n");
   }
 
   extractNameAndType(content) {

package/src/migration-check/MigrationCheck.js

@@ -5,7 +5,7 @@ const path = require("path");
 const fs = require("fs");
 const crypto = require("crypto");
 
-const COMPONENT_NAME = "/cap-js-community-common/migrationCheck";
+const COMPONENT_NAME = "/cap-js-community-common/migration-check";
 const STRING_DEFAULT_LENGTH = 5000;
 
 const Checks = [releasedEntityCheck, newEntityCheck, uniqueIndexCheck, journalModeCheck];

package/src/rate-limiting/RateLimiting.js

@@ -7,7 +7,7 @@ const redisResetTime = require("./redis/resetTime");
 
 const { connectionCheck } = require("./redis/common");
 
-const COMPONENT_NAME = "/cap-js-community-common/rateLimiting";
+const COMPONENT_NAME = "/cap-js-community-common/rate-limiting";
 
 class RateLimiting {
   constructor(service, { maxConcurrent, maxInWindow, window } = {}) {

package/src/rate-limiting/redis/common.js

@@ -4,7 +4,7 @@ const cds = require("@sap/cds");
 
 const { RedisClient } = require("../../redis-client");
 
-const COMPONENT_NAME = "/cap-js-community-common/rateLimiting";
+const COMPONENT_NAME = "/cap-js-community-common/rate-limiting";
 
 async function connectionCheck() {
   return await RedisClient.create(COMPONENT_NAME).connectionCheck();

package/src/redis-client/RedisClient.js

@@ -3,12 +3,13 @@
 const redis = require("redis");
 const cds = require("@sap/cds");
 
-const COMPONENT_NAME = "/cap-js-community-common/redisClient";
+const COMPONENT_NAME = "/cap-js-community-common/redis-client";
 const LOG_AFTER_SEC = 5;
 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) {