@cap-js-community/common 0.1.0 → 0.1.2

package/README.md

@@ -136,7 +136,7 @@ Options can be passed to migration check via CDS environment via `cds.migrationC
 ### Usage
 
 ```cds
-@cds.rateLimit
+@cds.rateLimiting
 service BookshopService {
   entity Books @readonly   as projection on test.Books;
 }
@@ -144,10 +144,10 @@ service BookshopService {
 
 ### 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
+- `@cds.rateLimiting: Boolean`: Activate rate limit for service
+- `@cds.rateLimiting.maxConcurrent: Number`: Maximum number of concurrent requests per service and tenant
+- `@cds.rateLimiting.maxInWindow: Number`: Maximum number of requests in defined window per service and tenant
+- `@cds.rateLimiting.window: Number`: Window length in milliseconds
 
 ### Options
 

package/cds-plugin.js

@@ -10,9 +10,9 @@ const TIMEOUT_SHUTDOWN = 2500;
 if (cds.env.rateLimiting.plugin) {
   cds.on("serving", async (service) => {
     if (
-      service.definition["@cds.rateLimit"] ||
+      service.definition["@cds.rateLimiting"] ||
       Object.keys(service.definition).find((name) => {
-        return name.startsWith("@cds.rateLimit.");
+        return name.startsWith("@cds.rateLimiting.");
       })
     ) {
       const rateLimiting = new RateLimiting(service);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/common",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "CAP Node.js Community Common",
   "homepage": "https://cap.cloud.sap/",
   "engines": {
@@ -45,6 +45,7 @@
   },
   "dependencies": {
     "@cap-js/sqlite": "^1.10.0",
+    "commander": "^13.1.0",
     "redis": "^4.7.0",
     "verror": "^1.10.1"
   },
@@ -54,7 +55,6 @@
     "@sap/cds": "^8.9.1",
     "@sap/cds-common-content": "^2.1.0",
     "@sap/cds-dk": "^8.9.1",
-    "commander": "^13.1.0",
     "eslint": "9.24.0",
     "eslint-config-prettier": "10.1.1",
     "eslint-plugin-jest": "28.11.0",

package/src/migration-check/MigrationCheck.js

@@ -200,16 +200,25 @@ class MigrationCheck {
       if (admin) {
         result.adminHash = messageHash;
       }
-      if (this.options.adminHash && this.options.adminHash === messageHash) {
-        for (const message of result.messages) {
-          message.severity = message.severity === "error" ? "warning" : message.severity;
+      if (this.options.adminHash) {
+        if (this.options.adminHash === messageHash) {
+          for (const message of result.messages) {
+            message.severity = message.severity === "error" ? "warning" : message.severity;
+          }
+          messages.push({
+            code: "AcceptedByAdmin",
+            text: "Migration check errors accepted by admin",
+            severity: "info",
+          });
+          result.success = true;
+        } else {
+          messages.push({
+            code: "AdminHashInvalid",
+            text: "Admin hash is not valid for current migration check state",
+            severity: "error",
+          });
+          result.success = false;
         }
-        messages.push({
-          code: "AcceptedByAdmin",
-          text: "Migration check errors accepted by admin",
-          severity: "info",
-        });
-        result.success = true;
       } else {
         result.success = false;
       }
@@ -303,7 +312,7 @@ function releasedEntityCheck(csnBuild, csnProd, whitelist, options) {
   const messages = [];
   visitPersistenceEntities(csnProd, (definitionProd) => {
     let lookupName = definitionProd.name;
-    if (lookupName.startsWith("cds.xt.") && !this.options.checkMtx) {
+    if (lookupName.startsWith("cds.xt.") && !options.checkMtx) {
       return;
     }
     const definitionBuild = csnBuild.definitions[lookupName];

package/src/rate-limiting/RateLimiting.js

@@ -17,10 +17,10 @@ class RateLimiting {
     this.resetTime = null;
     this.tenantCounts = {}; // [<tenant>: {concurrent: 0, window: 0}]
     this.maxConcurrent =
-      maxConcurrent || service.definition["@cds.rateLimt.maxConcurrent"] || cds.env.rateLimiting.maxConcurrent;
+      maxConcurrent || service.definition["@cds.rateLimiting.maxConcurrent"] || cds.env.rateLimiting.maxConcurrent;
     this.maxInWindow =
-      maxInWindow || service.definition["@cds.rateLimt.maxInWindow"] || cds.env.rateLimiting.maxInWindow;
-    this.window = window || service.definition["@cds.rateLimt.window"] || cds.env.rateLimiting.window;
+      maxInWindow || service.definition["@cds.rateLimiting.maxInWindow"] || cds.env.rateLimiting.maxInWindow;
+    this.window = window || service.definition["@cds.rateLimiting.window"] || cds.env.rateLimiting.window;
     this.redisActive = cds.env.rateLimiting.redis;
   }
 
@@ -181,18 +181,21 @@ class RateLimiting {
       req.error({
         code: "TOO_MANY_REQUESTS",
         status: 429,
+        statusCode: 429,
         message: `Too many requests in time window (max ${this.maxInWindow}), please try again later.`,
       });
     } else if (status.exceeds?.concurrent) {
       req.error({
         code: "TOO_MANY_REQUESTS",
         status: 429,
+        statusCode: 429,
         message: `Too many concurrent requests (max ${this.maxConcurrent}), please try again later.`,
       });
     } else {
       req.error({
         code: "TOO_MANY_REQUESTS",
         status: 429,
+        statusCode: 429,
         message: "Too many requests, please try again later.",
       });
     }