@cap-js-community/common 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,265 @@
+# CAP Node.js Community Common
+
+## Getting Started
+
+- Run `npm add @cap-js-community/common` in `@sap/cds` project
+
+## About this Project
+
+This project provides common functionality for CDS services to be consumed with [SAP Cloud Application Programming Model (Node.js)](https://www.npmjs.com/package/@sap/cds).
+
+## Table of Contents
+
+- [Replication Cache](#replication-cache)
+- [Migration Check](#migration-check)
+- [Rate Limiting](#rate-limiting)
+- [Redis Client](#redis-client)
+- [Support, Feedback, Contributing](#support-feedback-contributing)
+- [Code of Conduct](#code-of-conduct)
+- [Licensing](#licensing)
+
+## Replication Cache
+
+The replication cache allows to cache a service (e.g. db service) into a tenant-aware SQLite database.
+Local replicated SQLite database can be queried with same query as the original service.
+
+### Usage
+
+```cds
+@cds.replicate
+entity Books {
+  key ID       : Integer;
+      title    : localized String;
+      descr    : localized String;
+}
+```
+
+### Annotations
+
+Annotations can be used to enable replication cache for a service:
+
+- `@cds.replicate: Boolean | Object`: Enable replication cache for entity
+  - `@cds.replicate.ttl: Number`: Time-To-Live (TTL) of cache entry in milliseconds
+  - `@cds.replicate.auto: Boolean`: Replication is managed automatically
+  - `@cds.replicate.preload: Boolean`: Preload replication for entity
+  - `@cds.replicate.group: String`: Replication group name
+
+Defaults are taken from CDS environment.
+
+### Options
+
+Options can be passed to replication cache via CDS environment via `cds.replicationCache` section:
+
+- `plugin: Boolean`: Replication cache is activated via CDS plugin for `db` service. Default is `true`
+- `name: String`: Service name. Default is `"db"`
+- `group: String`: Replication group name. Default is `"default"`
+- `credentials: Object`: SQLite credentials
+  - `database: String`: Database file. Default is `":memory:"` and in production: `"data.sqlite"`
+- `ttl: Number`: Time-To-Live (TTL) of cache entries in milliseconds. Default is `1800000` (30 minutes)
+- `check: Number`: Interval to check size and prune. Default is `60000` (1 minute)
+- `stats: Number`: Interval to log statistics. Default is `300000` (5 minutes)
+- `size: Number`: Maximal cache size in bytes. Default is `10485760` (10 MB) and in production: `104857600` (100 MB)
+- `chunks: Number`: Replication chunk size. Default is `1000`
+- `retries: Number`: Replication retries for failed replications. Default is `3`
+- `auto: Boolean`: Replication is managed automatically. Default is `true`
+- `prune: Boolean`: Check and prune directly after replication. Default is `true`
+- `validate: Boolean`: Validate count of replicated records. Default is `true`
+- `deploy: Boolean`: Deploy whole schema to allow queries on projections. Default is `true`
+- `preload: Boolean`: Preload all replication enables entity. Default is `false`
+- `wait: Boolean`: Delay read query until replication finished. Default is `false`
+- `search: Boolean`: Search queries are allowed on replication cache. Default is `true`
+- `measure: Boolean`: Measure and compare replication cache and service query execution. Default is `false`
+- `tmpDir: Boolean`: Store replication cache file in temporary directory. Default is `false`
+- `baseDir: String`: Base directory for replication cache files. Default is `"temp"`
+
+## Migration Check
+
+### Options
+
+Options can be passed to migration check via CDS environment via `cds.migrationCheck` section:
+
+- `baseDir: String`: Specifies the base directory for migration check. Default is `"migration-check"`
+- `whitelist: Boolean`: Requires to maintain a whitelist for compatible changes. Default is `true`
+- `checkMtx: Boolean`: Includes CDS MTXS persistence into check. Default is `true`
+- `keep: Boolean`: Keeps whitelist after update, otherwise whitelist is cleared. Default is `false`
+- `freeze: Boolean`: Freeze the persistence. Event compatible changes are not allowed, Default is `false`
+- `label: String`: Label to describe the updated hash files in addition to the timestamp. Default is `""`
+- `buildPath: String`: Path to the build CSN. If not specified it derived from CAP project type. Default is `null`
+- `adminHash: String`: Specify admin hash to acknowledge incompatible changes. Default is `null`
+
+### Usage
+
+#### Basic Flow
+
+- Build CSN: `cds build --production`
+- Check migrations: `cdsmc`
+- Update Production CSN: `cdsmc -u`
+
+### Whitelisting
+
+- Maintain the whitelist extension file `migration-extension-whitelist.json` for compatible changes:
+  - **Whitelist Entity**:
+  ```json
+  {
+    "definitions": {
+      "test.Test": {}
+    }
+  }
+  ```
+  - **Whitelist Entity Element**:
+  ```json
+  {
+    "definitions": {
+      "test.Test": {
+        "elements": {
+          "value": {}
+        }
+      }
+    }
+  }
+  ```
+
+### Admin Mode
+
+- Get Admin Hash: `cdsmc -a`
+- (Un-)Freeze Persistence (based on options): `cdsmc -u -a`
+
+### Pipeline
+
+- Build & Check: `cds build --production && cdsmc`
+- Update Production CSN: `cdsmc -u`
+
+> Production CSN MUST be added to version control
+
+## Rate Limiting
+
+### Usage
+
+```cds
+@cds.rateLimit
+service BookshopService {
+  entity Books @readonly   as projection on test.Books;
+}
+```
+
+### Annotations
+
+- `@cds.rateLimt: Boolean`: Activate rate limit for service
+- `@cds.rateLimt.maxConcurrent: Number`: Maximum number of concurrent requests per service and tenant
+- `@cds.rateLimt.maxInWindow: Number`: Maximum number of requests in defined window per service and tenant
+- `@cds.rateLimt.window: Number`: Window length in milliseconds
+
+### Options
+
+Options can be passed to migration check via CDS environment via `cds.rateLimiting` section:
+
+- `plugin: Boolean`: Rate limiting is activated via CDS plugin for annotated services. Default is `true`
+- `maxConcurrent: Boolean`: Maximum number of concurrent requests per service and tenant. Default is `3`
+- `maxWindow: Boolean`: Maximum number of requests in defined window per service and tenant. Default is `10000` (10 seconds)
+- `window: Boolean`: Window length in milliseconds. Default is `3600000` (1 hour)
+- `retry: Boolean`: Default is `5`
+
+### Redis
+
+Redis options can be provided in CDS env as follows:
+
+```json
+{
+  "cds": {
+    "requires": {
+      "redis-rateLimiting": {
+        "vcap": {
+          "tag": "my-redis"
+        },
+        "options": {}
+      }
+    }
+  }
+}
+```
+
+For shared redis configuration Redis service name can be provided in CDS env as follows:
+
+```json
+{
+  "cds": {
+    "requires": {
+      "redis-rateLimiting": false,
+      "redis": {
+        "vcap": {
+          "tag": "my-redis"
+        },
+        "options": {}
+      }
+    }
+  }
+}
+```
+
+## Redis Client
+
+A Redis Client broker is provided to connect to Redis service.
+
+### Usage
+
+#### Main default singleton
+
+```js
+const { RedisClient } = require("@cap-js-community/common");
+const mainClient = await RedisClient.default().createMainClientAndConnect(options);
+```
+
+#### Main named singleton
+
+```js
+const { RedisClient } = require("@cap-js-community/common");
+const mainClient = await RedisClient.default("name").createMainClientAndConnect(options);
+```
+
+#### Custom named
+
+```js
+const { RedisClient } = require("@cap-js-community/common");
+const client = await new RedisClient(name).createClientAndConnect(options);
+```
+
+### Options
+
+Options can be passed to Redis client via CDS environment via `cds.redis` section:
+Redis options can be provided in CDS env as follows:
+
+```json
+{
+  "cds": {
+    "requires": {
+      "redis": {
+        "vcap": {
+          "tag": "redis-cache"
+        },
+        "options": {}
+      }
+    }
+  }
+}
+```
+
+In addition, options can be passed to Redis client during creation via `options` parameter:
+
+```js
+const { RedisClient } = require("@cap-js-community/common");
+const mainClient = await RedisClient.default().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).
+
+## 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).
+
+## Code of Conduct
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
+
+## 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).

package/bin/cdsmc.js

@@ -0,0 +1,51 @@
+#!/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 { MigrationCheck } = require("../src/migration-check");
+
+process.argv = process.argv.map((arg) => {
+  return arg.toLowerCase();
+});
+
+program
+  .version(packageJSON.version, "-v, --version")
+  .usage("[options]")
+  .option("-u, --update", "Update prod CSN")
+  .option("-a, --admin", "Admin mode");
+
+program.unknownOption = function () {};
+program.parse(process.argv);
+
+(() => {
+  try {
+    const options = program.opts();
+    const migrationCheck = new MigrationCheck(options);
+    if (options.update) {
+      const result = migrationCheck.update(options.admin);
+      for (const message of result.messages) {
+        console.log(message);
+      }
+      process.exit(result.success ? 0 : -1);
+    } else {
+      const result = migrationCheck.check(options.admin);
+      for (const message of result.messages) {
+        console.log(message);
+      }
+      if (result.adminHash) {
+        console.log(`Admin hash: ${result.adminHash}`);
+      }
+      process.exit(result.success ? 0 : -1);
+    }
+  } catch (err) {
+    console.error(err);
+    process.exit(-1);
+  }
+})();

package/cds-plugin.js

@@ -0,0 +1,48 @@
+"use strict";
+
+const cds = require("@sap/cds");
+require("./src/common/promise");
+
+const { ReplicationCache, RateLimiting, RedisClient } = require("./src");
+
+const TIMEOUT_SHUTDOWN = 2500;
+
+if (cds.env.rateLimiting.plugin) {
+  cds.on("serving", async (service) => {
+    if (
+      service.definition["@cds.rateLimit"] ||
+      Object.keys(service.definition).find((name) => {
+        return name.startsWith("@cds.rateLimit.");
+      })
+    ) {
+      const rateLimiting = new RateLimiting(service);
+      await rateLimiting.setup();
+    }
+  });
+}
+
+if (cds.env.replicationCache.plugin) {
+  cds.replicationCache = new ReplicationCache();
+}
+
+cds.on("shutdown", async () => {
+  await shutdownWebSocketServer();
+});
+
+async function shutdownWebSocketServer() {
+  return await new Promise((resolve, reject) => {
+    const timeoutRef = setTimeout(() => {
+      clearTimeout(timeoutRef);
+      resolve();
+    }, TIMEOUT_SHUTDOWN);
+    RedisClient.closeAllClients()
+      .then((result) => {
+        clearTimeout(timeoutRef);
+        resolve(result);
+      })
+      .catch((err) => {
+        clearTimeout(timeoutRef);
+        reject(err);
+      });
+  });
+}

package/index.js

@@ -0,0 +1,3 @@
+"use strict";
+
+module.exports = require("./src");