@cap-js-community/common 0.3.2 → 0.3.3

package/CHANGELOG.md

@@ -5,6 +5,16 @@ 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.3.3 - 2026-01-07
+
+### Added
+
+- Local HTML5 repository
+
+### Fixed
+
+- Fix rate limiting redis env
+
 ## Version 0.3.2 - 2025-11-05
 
 ### Fixed

package/README.md

@@ -19,6 +19,7 @@ This project provides common functionality for CDS services to be consumed with
 - [Migration Check](#migration-check)
 - [Rate Limiting](#rate-limiting)
 - [Redis Client](#redis-client)
+- [Local HTML5 Repository](#local-html5-repository)
 - [Support, Feedback, Contributing](#support-feedback-contributing)
 - [Code of Conduct](#code-of-conduct)
 - [Licensing](#licensing)
@@ -396,6 +397,33 @@ 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).
 
+## 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.
+
+### Usage
+
+- Create a `default-env.json` in `approuter` folder, including a valid HTML5 repository configuration from deployment environment:
+
+```json
+{
+  "VCAP_SERVICES": {
+    "html5-apps-repo": [
+      {
+        "credentials": {
+          "uri": "https://html5-apps-repo-rt.cfapps.sap.hana.ondemand.com"
+        }
+      }
+    ]
+  }
+}
+```
+
+- Call command: `local-html5-repo` (shortcut: `lh5r`)
+
+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.
+
 ## 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/local-html5-repo.js

@@ -0,0 +1,34 @@
+#!/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 { LocalHTML5Repo } = require("../src/local-html5-repo");
+
+process.argv = process.argv.map((arg) => {
+  return arg.toLowerCase();
+});
+
+program
+  .version(packageJSON.version, "-v, --version")
+  .usage("[options]")
+  .option("-p, --port", "Port of local HTML5 repo");
+
+program.unknownOption = function () {};
+program.parse(process.argv);
+
+(async () => {
+  try {
+    const options = program.opts();
+    await new LocalHTML5Repo(options).start();
+  } catch (err) {
+    console.error(err);
+    process.exit(-1);
+  }
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/common",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "CAP Node.js Community Common",
   "homepage": "https://cap.cloud.sap/",
   "engines": {
@@ -26,7 +26,9 @@
   "main": "index.js",
   "types": "index.d.ts",
   "bin": {
-    "cdsmc": "bin/cdsmc.js"
+    "cdsmc": "bin/cdsmc.js",
+    "lh5r": "bin/local-html5-repo.js",
+    "local-html5-repo": "bin/local-html5-repo.js"
   },
   "scripts": {
     "start": "cds-serve",
@@ -45,30 +47,32 @@
     "audit": "npm audit --only=prod"
   },
   "dependencies": {
-    "commander": "^14.0.1",
+    "commander": "^14.0.2",
+    "express": "^4.22.1",
+    "http-proxy-middleware": "^3.0.5",
     "redis": "^4.7.1",
     "verror": "^1.10.1"
   },
   "devDependencies": {
     "@cap-js-community/common": "./",
-    "@cap-js/cds-test": "^0.4.0",
-    "@cap-js/sqlite": "^2.0.3",
-    "@sap/cds": "^9.4.3",
-    "@sap/cds-common-content": "^3.0.1",
-    "@sap/cds-dk": "^9.4.1",
-    "eslint": "^9.39.1",
+    "@cap-js/cds-test": "^0.4.1",
+    "@cap-js/sqlite": "^2.1.2",
+    "@sap/cds": "^9.6.1",
+    "@sap/cds-common-content": "^3.1.0",
+    "@sap/cds-dk": "^9.6.0",
+    "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-jest": "^29.0.1",
+    "eslint-plugin-jest": "^29.12.1",
     "eslint-plugin-n": "^17.23.1",
     "jest": "^30.2.0",
     "jest-html-reporters": "^3.1.7",
     "jest-junit": "^16.0.0",
-    "prettier": "^3.6.2",
+    "prettier": "^3.7.4",
     "shelljs": "^0.10.0"
   },
   "cds": {
     "requires": {
-      "redis-ratelimit": {
+      "redis-ratelimiting": {
         "vcap": {
           "label": "redis-cache"
         }

package/src/index.js

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

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

@@ -0,0 +1,150 @@
+"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()
+require("util")._extend = Object.assign;
+
+const fs = require("fs");
+const path = require("path");
+const express = require("express");
+const { createProxyMiddleware } = require("http-proxy-middleware");
+
+const PORT = process.env.PORT || 3001;
+const DEFAULT_ENV_PATH = path.join(process.cwd(), "approuter/default-env.json");
+const APP_ROOT = path.join(process.cwd(), "app");
+
+const COMPONENT_NAME = "/cap-js-community-common/localHTML5Repo";
+
+class LocalHTML5Repo {
+  constructor(options) {
+    this.component = COMPONENT_NAME;
+    this.port = options?.port || PORT;
+    this.path = options?.path || DEFAULT_ENV_PATH;
+
+    try {
+      this.defaultEnv = require(this.path);
+    } catch (err) {
+      console.error(`Cannot read default-env.json at ${this.path}`);
+      throw err;
+    }
+  }
+
+  start() {
+    return new Promise((resolve) => {
+      this.adjustDefaultEnv();
+
+      console.log("Registering apps:");
+      const app = express();
+
+      // Serve every webapp
+      const appDirectories = fs
+        .readdirSync(APP_ROOT, { withFileTypes: true })
+        .filter((dirent) => dirent.isDirectory())
+        .map((dirent) => dirent.name);
+
+      for (const appDirectory of appDirectories) {
+        const ui5ConfigPath = path.join(APP_ROOT, appDirectory, "ui5.yaml");
+        if (!fs.existsSync(ui5ConfigPath)) {
+          continue;
+        }
+
+        const ui5Config = fs.readFileSync(ui5ConfigPath, "utf-8");
+        const { name, type } = this.extractNameAndType(ui5Config);
+        const appId = name?.replace(/\./g, "");
+
+        if (appId) {
+          app.use(
+            [`/${appId}`, `/${appId}-:version`],
+            express.static(path.join(APP_ROOT, appDirectory, type === "application" ? "webapp" : "src")),
+            // Serve xs-app.json and other non-webapp files
+            express.static(path.join(APP_ROOT, appDirectory), {
+              fallthrough: false,
+            }),
+          );
+
+          console.log(`- ${name} [${type}] -> ${path.join(APP_ROOT, appDirectory)}`);
+        }
+      }
+
+      process.on("SIGINT", () => {
+        this.stop();
+        process.exit(0);
+      });
+
+      // Forward everything else to the original HTML5 Apps Repo
+      const html5RepoProxy = createProxyMiddleware({
+        target: this.originalHtmlRepoUrl,
+        changeOrigin: true,
+        ws: true,
+        logLevel: "warn",
+        onError(err, req, res) {
+          console.error("HTML5 Repo proxy error:", err.message);
+          res.status(502).end("Bad Gateway");
+        },
+      });
+
+      // Catch-all proxy (must be last)
+      app.use("/", html5RepoProxy);
+
+      this.server = app.listen(this.port, () => {
+        console.log(`Local HTML5 repository running on port ${this.port}`);
+        resolve(this.server);
+      });
+    });
+  }
+
+  async stop() {
+    if (this.server) {
+      this.server.close();
+    }
+    this.restoreDefaultEnv();
+  }
+
+  adjustDefaultEnv() {
+    this.originalHtmlRepoUrl = this.defaultEnv.VCAP_SERVICES["html5-apps-repo"][0].credentials.uri;
+
+    this.defaultEnv.VCAP_SERVICES["html5-apps-repo"][0].credentials.uri = `http://localhost:${this.port}`;
+
+    this.writeDefaultEnv();
+  }
+
+  restoreDefaultEnv() {
+    this.defaultEnv.VCAP_SERVICES["html5-apps-repo"][0].credentials.uri = this.originalHtmlRepoUrl;
+
+    this.writeDefaultEnv();
+  }
+
+  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");
+  }
+
+  extractNameAndType(content) {
+    const result = { name: "", type: "" };
+
+    for (const line of content.split("\n")) {
+      const trimmed = line.trim();
+
+      if (trimmed.startsWith("name:")) {
+        result.name = trimmed.split(" ")[1];
+      }
+
+      if (trimmed.startsWith("type:")) {
+        result.type = trimmed.split(" ")[1];
+      }
+
+      if (result.name && result.type) {
+        break;
+      }
+    }
+
+    return result;
+  }
+}
+
+module.exports = LocalHTML5Repo;

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

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

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

@@ -11,7 +11,7 @@ async function connectionCheck() {
 }
 
 async function perform(key, cb, cbFallback, retry = cds.env.rateLimiting.retry) {
-  const client = cds.env.rateLimiting.redis && (await RedisClient.create(COMPONENT_NAME).createMainClientAndConnect());
+  const client = cds.env.rateLimiting.redis && (await RedisClient.create("rateLimiting").createMainClientAndConnect());
   if (client) {
     const value = await cb(client, key);
     if (value === undefined) {