@cap-js-community/event-queue 1.10.0-beta.5 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "1.10.0-beta.5",
+  "version": "1.10.0",
   "description": "An event queue that enables secure transactional processing of asynchronous and periodic events, featuring instant event processing with Redis Pub/Sub and load distribution across all application instances.",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -44,17 +44,17 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@sap/xssec": "^4.5.0",
-    "cron-parser": "^5.0.0",
+    "@sap/xssec": "^4.6.0",
+    "cron-parser": "^5.1.0",
     "redis": "^4.7.0",
     "verror": "^1.10.1",
-    "yaml": "^2.6.1"
+    "yaml": "^2.7.1"
   },
   "devDependencies": {
-    "@cap-js/cds-test": "^0.2.0",
-    "@cap-js/hana": "^1.7.0",
-    "@cap-js/sqlite": "^1.9.0",
-    "@sap/cds": "^8.8.0",
+    "@cap-js/cds-test": "^0.3.0",
+    "@cap-js/hana": "^1.8.0",
+    "@cap-js/sqlite": "^1.10.0",
+    "@sap/cds": "^8.9.0",
     "@sap/cds-dk": "^8.8.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",

package/src/config.js

@@ -153,18 +153,50 @@ class Config {
     return !!this.#env.redisRequires?.credentials;
   }
 
+  #parseRegexOrString(str) {
+    const regexLiteralPattern = /^\/((?:\\.|[^\\/])*)\/([gimsuy]*)$/;
+    const match = str.match(regexLiteralPattern);
+
+    if (match) {
+      try {
+        return { type: "regex", value: new RegExp(match[1], match[2]) };
+      } catch {
+        return { type: "string", value: str };
+      }
+    }
+    return { type: "string", value: str };
+  }
+
   shouldBeProcessedInThisApplication(type, subType) {
     const config = this.#eventMap[this.generateKey(type, subType)];
     const appNameConfig = config._appNameMap;
     const appInstanceConfig = config._appInstancesMap;
+    let result = true;
     if (!appNameConfig && !appInstanceConfig) {
-      return true;
+      return result;
     }
 
     if (appNameConfig) {
-      const shouldBeProcessedBasedOnAppName = appNameConfig[this.#env.applicationName];
-      if (!shouldBeProcessedBasedOnAppName) {
-        return false;
+      if (config._appNameContainsRegex) {
+        for (const configKey in appNameConfig) {
+          const config = appNameConfig[configKey];
+          if (config.type === "regex") {
+            result = config.value.test(this.#env.applicationName);
+          } else {
+            const shouldBeProcessedBasedOnAppName = appNameConfig[this.#env.applicationName];
+            if (!shouldBeProcessedBasedOnAppName) {
+              result = config.value === this.#env.applicationName;
+            }
+          }
+          if (result) {
+            break;
+          }
+        }
+      } else {
+        const shouldBeProcessedBasedOnAppName = appNameConfig[this.#env.applicationName];
+        if (!shouldBeProcessedBasedOnAppName) {
+          return false;
+        }
       }
     }
 
@@ -175,7 +207,7 @@ class Config {
       }
     }
 
-    return true;
+    return result;
   }
 
   checkRedisEnabled() {
@@ -530,7 +562,12 @@ class Config {
   }
 
   #basicEventTransformationAfterValidate(event) {
-    event._appNameMap = event.appNames ? Object.fromEntries(new Map(event.appNames.map((a) => [a, true]))) : null;
+    event._appNameMap = event.appNames
+      ? Object.fromEntries(new Map(event.appNames.map((a) => [a, this.#parseRegexOrString(a)])))
+      : null;
+    event._appNameContainsRegex = event.appNames
+      ? event.appNames.some((appName) => this.#parseRegexOrString(appName).type === "regex")
+      : null;
     event._appInstancesMap = event.appInstances
       ? Object.fromEntries(new Map(event.appInstances.map((a) => [a, true])))
       : null;

package/src/outbox/EventQueueGenericOutboxHandler.js

@@ -9,6 +9,12 @@ const config = require("../config");
 
 const COMPONENT_NAME = "/eventQueue/outbox/generic";
 
+const EVENT_QUEUE_ACTIONS = {
+  EXCEEDED: "eventQueueRetriesExceeded",
+  CLUSTER: "eventQueueCluster",
+  CHECK_AND_ADJUST: "eventQueueCheckAndAdjustPayload",
+};
+
 class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
   constructor(context, eventType, eventSubType, config) {
     super(context, eventType, eventSubType, config);
@@ -21,7 +27,7 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
     this.__srvUnboxed = cds.unboxed(this.__srv);
     const { handlers, clusterRelevant, specificClusterRelevant } = this.__srvUnboxed.handlers.on.reduce(
       (result, handler) => {
-        if (handler.on.startsWith("clusterQueueEntries")) {
+        if (handler.on.startsWith(EVENT_QUEUE_ACTIONS.CLUSTER)) {
           if (handler.on.split(".").length === 2) {
             result.specificClusterRelevant = true;
           } else {
@@ -41,8 +47,6 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
     return await super.getQueueEntriesAndSetToInProgress();
   }
 
-  // document structure is a map of { key: { queueEntries: [], payload: {} }
-  // TODO: document that clusterQueueEntries is now async!!!
   async clusterQueueEntries(queueEntriesWithPayloadMap) {
     if (!this.__genericClusterRelevantAndAvailable && !this.__specificClusterRelevantAndAvailable) {
       return super.clusterQueueEntries(queueEntriesWithPayloadMap);
@@ -58,7 +62,7 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
       } else {
         for (const actionName in genericClusterEvents) {
           const msg = new cds.Request({
-            event: `clusterQueueEntries`,
+            event: EVENT_QUEUE_ACTIONS.CLUSTER,
             user: this.context.user,
             eventQueue: {
               processor: this,
@@ -67,7 +71,7 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
               clusterByEventProperty: (propertyName, cb) =>
                 this.#clusterByEventProperty(actionName, genericClusterEvents[actionName], propertyName, cb),
               clusterByDataProperty: (propertyName, cb) =>
-                this.#clusterByDataProperty(actionName, specificClusterEvents[actionName], propertyName, cb),
+                this.#clusterByDataProperty(actionName, genericClusterEvents[actionName], propertyName, cb),
             },
           });
           const clusterResult = await this.__srvUnboxed.tx(this.context).send(msg);
@@ -89,7 +93,7 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
 
     for (const actionName in specificClusterEvents) {
       const msg = new cds.Request({
-        event: `clusterQueueEntries.${actionName}`,
+        event: `${EVENT_QUEUE_ACTIONS.CLUSTER}.${actionName}`,
         user: this.context.user,
         eventQueue: {
           processor: this,
@@ -249,13 +253,13 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
   }
 
   #hasEventSpecificClusterHandler(queueEntry) {
-    return !!this.__onHandlers[["clusterQueueEntries", queueEntry.payload.event].join(".")];
+    return !!this.__onHandlers[[EVENT_QUEUE_ACTIONS.CLUSTER, queueEntry.payload.event].join(".")];
   }
 
   async checkEventAndGeneratePayload(queueEntry) {
     const payload = await super.checkEventAndGeneratePayload(queueEntry);
     const { event } = payload;
-    const handlerName = this.#checkHandlerExists("checkEventAndGeneratePayload", event);
+    const handlerName = this.#checkHandlerExists(EVENT_QUEUE_ACTIONS.CHECK_AND_ADJUST, event);
     if (!handlerName) {
       return payload;
     }
@@ -276,7 +280,7 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
 
   async hookForExceededEvents(exceededEvent) {
     const { event } = exceededEvent.payload;
-    const handlerName = this.#checkHandlerExists("hookForExceededEvents", event);
+    const handlerName = this.#checkHandlerExists(EVENT_QUEUE_ACTIONS.EXCEEDED, event);
     if (!handlerName) {
       return await super.hookForExceededEvents(exceededEvent);
     }

package/src/publishEvent.js

@@ -63,7 +63,7 @@ const publishEvent = async (
       event.context = JSON.stringify({ traceContext: openTelemetry.getCurrentTraceContext() });
     }
 
-    if (eventConfig.timeBucket && event.startAfter !== undefined) {
+    if (eventConfig.timeBucket && !(startAfter in event)) {
       event.startAfter = CronExpressionParser.parse(eventConfig.timeBucket).next().toISOString();
     }
   }