@cap-js-community/common 0.1.2 → 0.1.4

package/README.md

@@ -1,5 +1,10 @@
 # CAP Node.js Community Common
 
+[![npm version](https://img.shields.io/npm/v/@cap-js-community/common)](https://www.npmjs.com/package/@cap-js-community/common)
+[![monthly downloads](https://img.shields.io/npm/dm/@cap-js-community/common)](https://www.npmjs.com/package/@cap-js-community/common)
+[![REUSE status](https://api.reuse.software/badge/github.com/cap-js-community/common)](https://api.reuse.software/info/github.com/cap-js-community/common)
+[![Main CI](https://github.com/cap-js-community/common/actions/workflows/main-ci.yml/badge.svg)](https://github.com/cap-js-community/common/commits/main)
+
 ## Getting Started
 
 - Run `npm add @cap-js-community/common` in `@sap/cds` project
@@ -72,6 +77,22 @@ Options can be passed to replication cache via CDS environment via `cds.replicat
 - `tmpDir: Boolean`: Store replication cache file in temporary directory. Default is `false`
 - `baseDir: String`: Base directory for replication cache files. Default is `"temp"`
 
+### Test
+
+Replication cache is inactive per default for tests (`test` profile). It can be enabled via CDS env:
+
+```json
+{
+  "cds": {
+    "replicationCache": {
+      "[test]": {
+        "plugin": true
+      }
+    }
+  }
+}
+```
+
 ## Migration Check
 
 ### Options
@@ -196,6 +217,22 @@ For shared redis configuration Redis service name can be provided in CDS env as
 }
 ```
 
+### Test
+
+Rate limiting is inactive per default for tests (`test` profile). It can be enabled via CDS env:
+
+```json
+{
+  "cds": {
+    "rateLimiting": {
+      "[test]": {
+        "plugin": true
+      }
+    }
+  }
+}
+```
+
 ## Redis Client
 
 A Redis Client broker is provided to connect to Redis service.
@@ -220,7 +257,7 @@ const mainClient = await RedisClient.default("name").createMainClientAndConnect(
 
 ```js
 const { RedisClient } = require("@cap-js-community/common");
-const client = await new RedisClient(name).createClientAndConnect(options);
+const client = await new RedisClient("name").createClientAndConnect(options);
 ```
 
 ### Options
@@ -243,6 +280,28 @@ Redis options can be provided in CDS env as follows:
 }
 ```
 
+Specific Redis options for a custom name can be established as follows:
+
+```json
+{
+  "cds": {
+    "requires": {
+      "redis-customName": {
+        "vcap": {
+          "tag": "redis-cache"
+        },
+        "options": {}
+      }
+    }
+  }
+}
+```
+
+```js
+const { RedisClient } = require("@cap-js-community/common");
+const mainClient = await RedisClient.default("customName").createMainClientAndConnect(options);
+```
+
 In addition, options can be passed to Redis client during creation via `options` parameter:
 
 ```js
@@ -262,4 +321,4 @@ We as members, contributors, and leaders pledge to make participation in our com
 
 ## Licensing
 
-Copyright 2025 SAP SE or an SAP affiliate company and sap-afc-sdk contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js-community/common).
+Copyright 2025 SAP SE or an SAP affiliate company and common contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js-community/common).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/common",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "CAP Node.js Community Common",
   "homepage": "https://cap.cloud.sap/",
   "engines": {
@@ -56,7 +56,7 @@
     "@sap/cds-common-content": "^2.1.0",
     "@sap/cds-dk": "^8.9.1",
     "eslint": "9.24.0",
-    "eslint-config-prettier": "10.1.1",
+    "eslint-config-prettier": "10.1.2",
     "eslint-plugin-jest": "28.11.0",
     "eslint-plugin-n": "^17.17.0",
     "jest": "29.7.0",

package/src/redis-client/RedisClient.js

@@ -103,7 +103,7 @@ class RedisClient {
 
   createClientBase(redisOptions = {}) {
     const { credentials, options } =
-      (this.name ? cds.requires[`redis-${this.name}`] : undefined) || cds.requires["redis"] || {};
+      (this.name ? cds.env.requires[`redis-${this.name}`] : undefined) || cds.env.requires["redis"] || {};
     const socket = {
       host: credentials?.hostname ?? "127.0.0.1",
       tls: !!credentials?.tls,
@@ -114,7 +114,7 @@ class RedisClient {
     const socketOptions = {
       ...options,
       ...redisOptions,
-      password: options?.password ?? options?.password ?? credentials?.password,
+      password: redisOptions?.password ?? options?.password ?? credentials?.password,
       socket,
     };
     try {
@@ -184,6 +184,9 @@ class RedisClient {
   }
 
   async closeMainClient() {
+    if (!this.mainClientPromise) {
+      return;
+    }
     const client = this.mainClientPromise;
     this.mainClientPromise = null;
     await this.resilientClientClose(await client);
@@ -191,6 +194,9 @@ class RedisClient {
   }
 
   async closeAdditionalClient() {
+    if (!this.additionalClientPromise) {
+      return;
+    }
     const client = this.additionalClientPromise;
     this.additionalClientPromise = null;
     await this.resilientClientClose(await client);
@@ -198,6 +204,9 @@ class RedisClient {
   }
 
   async closeSubscribeClient() {
+    if (!this.subscriberClientPromise) {
+      return;
+    }
     const client = this.subscriberClientPromise;
     this.subscriberClientPromise = null;
     await this.resilientClientClose(await client);