@cap-js-community/event-queue 2.1.0-beta.0 → 2.1.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "2.1.0-beta.0",
+  "version": "2.1.0-beta.2",
   "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",
@@ -22,8 +22,6 @@
     "multi-tenancy"
   ],
   "scripts": {
-    "start": "PORT=4005 cds-serve",
-    "watch": "PORT=4005 cds watch",
     "test:unit": "jest --selectProjects unit",
     "test:integration": "jest --selectProjects integration --runInBand",
     "voter:test:integration": "jest --selectProjects integration",
@@ -38,13 +36,12 @@
     "eslint:ci": "eslint .",
     "prettier": "prettier --write --loglevel error .",
     "prettier:ci": "prettier --check .",
-    "prepareRelease": "npm prune --production",
     "docs": "cd docs && bundle exec jekyll serve",
     "docs:install": "cd docs && npx shx rm -rf vendor Gemfile.lock && bundle install",
     "upgrade-lock": "npx shx rm -rf package-lock.json node_modules && npm i --package-lock"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "dependencies": {
     "@cap-js-community/common": "^0.3.4",

package/src/EventQueueProcessorBase.js

@@ -408,7 +408,7 @@ class EventQueueProcessorBase {
       UPDATE.entity(this.#config.tableNameEventQueue)
         .set({
           status: status,
-          ...(error && { error: this.#error2String(error) }),
+          ...(error && { error: this._error2String(error) }),
         })
         .where({
           ID: queueEntryIds,
@@ -498,16 +498,22 @@ class EventQueueProcessorBase {
         }
 
         if (data.error) {
-          data.error = this.#error2String(data.error);
+          data.error = this._error2String(data.error);
         }
 
         if (!data.startAfter && [EventProcessingStatus.Error, EventProcessingStatus.Open].includes(data.status)) {
           data.startAfter = new Date(
             Date.now() +
-              (EventProcessingStatus.Error ? this.#eventConfig.retryFailedAfter : this.#eventConfig.retryOpenAfter)
+              (data.status === EventProcessingStatus.Error
+                ? this.#eventConfig.retryFailedAfter
+                : this.#eventConfig.retryOpenAfter)
           );
         }
 
+        if (data.status === EventProcessingStatus.Open && !("attempts" in data)) {
+          data.attempts = { "-=": 1 };
+        }
+
         if (data.startAfter) {
           this.#eventSchedulerInstance.scheduleEvent(
             this.__context.tenant,
@@ -535,7 +541,7 @@ class EventQueueProcessorBase {
     });
   }
 
-  #error2String(error) {
+  _error2String(error) {
     return JSON.stringify(error, (_, value) => this.#errorReplacer(value));
   }
 

package/src/config.js

@@ -64,7 +64,7 @@ const ALLOWED_EVENT_OPTIONS_AD_HOC = [
   "checkForNextChunk",
   "retryFailedAfter",
   "propagateHeaders",
-  "propagatedContextProperties",
+  "propagateContextProperties",
   "retryOpenAfter",
   "multiInstanceProcessing",
   "kind",
@@ -518,7 +518,7 @@ class Config {
       ? Object.fromEntries(new Map(event.appInstances.map((a) => [a, true])))
       : null;
     event.propagateHeaders = event.propagateHeaders ?? [];
-    event.propagatedContextProperties = event.propagatedContextProperties ?? [];
+    event.propagateContextProperties = event.propagateContextProperties ?? [];
     event.retryFailedAfter = event.retryFailedAfter ?? DEFAULT_RETRY_AFTER;
     event.retryOpenAfter = event.retryOpenAfter ?? DEFAULT_RETRY_AFTER;
   }

package/src/outbox/EventQueueGenericOutboxHandler.js

@@ -64,7 +64,7 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
         }
       } else {
         for (const actionName in genericClusterEvents) {
-          const reg = new cds.Request({
+          const req = new cds.Request({
             event: EVENT_QUEUE_ACTIONS.CLUSTER,
             user: this.context.user,
             eventQueue: {
@@ -77,14 +77,14 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
                 this.#clusterByDataProperty(actionName, genericClusterEvents[actionName], propertyName, cb),
             },
           });
-          const clusterResult = await this.__srvUnboxed.tx(this.context).send(reg);
+          const clusterResult = await this.__srvUnboxed.tx(this.context).send(req);
           if (this.#validateCluster(clusterResult)) {
             Object.assign(clusterMap, clusterResult);
           } else {
             this.logger.error(
               "cluster result of handler is not valid. Check the documentation for the expected structure. Continuing without clustering!",
               {
-                handler: reg.event,
+                handler: req.event,
                 clusterResult: JSON.stringify(clusterResult),
               }
             );
@@ -95,7 +95,7 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
     }
 
     for (const actionName in specificClusterEvents) {
-      const reg = new cds.Request({
+      const req = new cds.Request({
         event: `${EVENT_QUEUE_ACTIONS.CLUSTER}.${actionName}`,
         user: this.context.user,
         eventQueue: {
@@ -108,14 +108,14 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
             this.#clusterByDataProperty(actionName, specificClusterEvents[actionName], propertyName, cb),
         },
       });
-      const clusterResult = await this.__srvUnboxed.tx(this.context).send(reg);
+      const clusterResult = await this.__srvUnboxed.tx(this.context).send(req);
       if (this.#validateCluster(clusterResult)) {
         Object.assign(clusterMap, clusterResult);
       } else {
         this.logger.error(
           "cluster result of handler is not valid. Check the documentation for the expected structure. Continuing without clustering!",
           {
-            handler: reg.event,
+            handler: req.event,
             clusterResult: JSON.stringify(clusterResult),
           }
         );
@@ -267,12 +267,12 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
       return payload;
     }
 
-    const { reg, userId } = this.#buildDispatchData(this.context, payload, {
+    const { req, userId } = this.#buildDispatchData(payload, {
       queueEntries: [queueEntry],
     });
-    reg.event = handlerName;
-    await this.#setContextUser(this.context, userId, reg);
-    const data = await this.__srvUnboxed.tx(this.context).send(reg);
+    req.event = handlerName;
+    await this.#setContextUser(this.context, userId, req);
+    const data = await this.__srvUnboxed.tx(this.context).send(req);
     if (data) {
       payload.data = data;
       return payload;
@@ -288,12 +288,12 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
       return await super.hookForExceededEvents(exceededEvent);
     }
 
-    const { reg, userId } = this.#buildDispatchData(this.context, exceededEvent.payload, {
+    const { req, userId } = this.#buildDispatchData(exceededEvent.payload, {
       queueEntries: [exceededEvent],
     });
-    await this.#setContextUser(this.context, userId, reg);
-    reg.event = handlerName;
-    await this.__srvUnboxed.tx(this.context).send(reg);
+    await this.#setContextUser(this.context, userId, req);
+    req.event = handlerName;
+    await this.__srvUnboxed.tx(this.context).send(req);
   }
 
   // NOTE: Currently not exposed to CAP service; we wait for a valid use case
@@ -312,6 +312,10 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
       return genericHandler ?? null;
     }
 
+    if (event.endsWith(EVENT_QUEUE_ACTIONS.SAGA_SUCCESS)) {
+      [event] = event.split("/");
+    }
+
     const specificHandler = this.__onHandlers[[event, saga].join("/")];
     if (specificHandler) {
       return specificHandler;
@@ -322,47 +326,53 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
 
   async processPeriodicEvent(processContext, key, queueEntry) {
     const { actionName } = config.normalizeSubType(this.eventType, this.eventSubType);
-    const reg = new cds.Event({ event: actionName, eventQueue: { processor: this, key, queueEntries: [queueEntry] } });
-    await this.#setContextUser(processContext, config.userId, reg);
-    await this.__srvUnboxed.tx(processContext).emit(reg);
+    const req = new cds.Event({ event: actionName, eventQueue: { processor: this, key, queueEntries: [queueEntry] } });
+    await this.#setContextUser(processContext, config.userId, req);
+    await this.__srvUnboxed.tx(processContext).emit(req);
   }
 
-  #buildDispatchData(context, payload, { key, queueEntries } = {}) {
+  #buildDispatchData(payload, { key, queueEntries } = {}) {
     const { useEventQueueUser } = this.eventConfig;
     const userId = useEventQueueUser ? config.userId : payload.contextUser;
-    const reg = payload._fromSend ? new cds.Request(payload) : new cds.Event(payload);
+    const req = payload._fromSend ? new cds.Request(payload) : new cds.Event(payload);
     const invocationFn = payload._fromSend ? "send" : "emit";
-    delete reg._fromSend;
-    delete reg.contextUser;
-    reg.eventQueue = { processor: this, key, queueEntries, payload };
-    return { reg, userId, invocationFn };
+    delete req._fromSend;
+    delete req.contextUser;
+    req.eventQueue = { processor: this, key, queueEntries, payload };
+
+    if (this.eventConfig.propagateContextProperties?.length && this.transactionMode === "isolated" && cds.context) {
+      for (const prop of this.eventConfig.propagateContextProperties) {
+        req[prop] && (cds.context[prop] = req[prop]);
+      }
+    }
+
+    return { req, userId, invocationFn };
   }
 
-  async #setContextUser(context, userId, reg) {
+  async #setContextUser(context, userId, req) {
     const authInfo = await common.getAuthContext(context.tenant);
     context.user = new cds.User.Privileged({
       id: userId,
       authInfo,
       tokenInfo: authInfo?.token,
     });
-    if (reg) {
-      reg.user = context.user;
+    if (req) {
+      req.user = context.user;
     }
   }
 
   async processEvent(processContext, key, queueEntries, payload) {
+    let statusTuple;
+    const { userId, invocationFn, req } = this.#buildDispatchData(payload, { key, queueEntries });
     try {
-      const { userId, invocationFn, reg } = this.#buildDispatchData(processContext, payload, { key, queueEntries });
-      await this.#setContextUser(processContext, userId, reg);
-      const result = await this.__srvUnboxed.tx(processContext)[invocationFn](reg);
-      const statusTuple = this.#determineResultStatus(result, queueEntries);
-      await this.#publishFollowupEvents(processContext, reg, statusTuple);
-      return statusTuple;
+      await this.#setContextUser(processContext, userId, req);
+      const result = await this.__srvUnboxed.tx(processContext)[invocationFn](req);
+      statusTuple = this.#determineResultStatus(result, queueEntries);
     } catch (err) {
       this.logger.error("error processing outboxed service call", err, {
         serviceName: this.eventSubType,
       });
-      return queueEntries.map((queueEntry) => [
+      statusTuple = queueEntries.map((queueEntry) => [
         queueEntry.ID,
         {
           status: EventProcessingStatus.Error,
@@ -370,6 +380,9 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
         },
       ]);
     }
+
+    await this.#publishFollowupEvents(processContext, req, statusTuple);
+    return statusTuple;
   }
 
   async #publishFollowupEvents(processContext, req, statusTuple) {
@@ -380,7 +393,7 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
       return;
     }
 
-    if (req.event.endsWith(EVENT_QUEUE_ACTIONS.SAGA_SUCCESS) || req.event.endsWith(EVENT_QUEUE_ACTIONS.SAGA_FAILED)) {
+    if (req.event.endsWith(EVENT_QUEUE_ACTIONS.SAGA_FAILED)) {
       return;
     }
 
@@ -393,23 +406,32 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
     }
 
     for (const [, result] of statusTuple) {
-      if (succeeded && result.status === EventProcessingStatus.Done) {
-        await this.__srv.tx(processContext).send(succeeded, result.nextData ?? req.data);
+      const data = result.nextData ?? req.data;
+      if (
+        succeeded &&
+        result.status === EventProcessingStatus.Done &&
+        !req.event.endsWith(EVENT_QUEUE_ACTIONS.SAGA_SUCCESS)
+      ) {
+        await this.__srv.tx(processContext).send(succeeded, data);
       }
 
       if (failed && result.status === EventProcessingStatus.Error) {
-        await this.__srv.tx(processContext).send(failed, result.nextData ?? req.data);
+        result.error && (data.error = this._error2String(result.error));
+        await this.__srv.tx(processContext).send(failed, data);
       }
 
       delete result.nextData;
     }
 
     if (config.insertEventsBeforeCommit) {
-      this.nextSagaEvents = tx._eventQueue.events;
+      this.nextSagaEvents = tx._eventQueue?.events;
     } else {
-      this.nextSagaEvents = tx._eventQueue.events.filter((event) => JSON.parse(event.payload).event === failed);
+      this.nextSagaEvents = tx._eventQueue?.events.filter((event) => JSON.parse(event.payload).event === failed);
+    }
+
+    if (tx._eventQueue) {
+      tx._eventQueue.events = nextEvents ?? [];
     }
-    tx._eventQueue.events = nextEvents ?? [];
   }
 
   #determineResultStatus(result, queueEntries) {

package/src/outbox/eventQueueAsOutbox.js

@@ -43,7 +43,7 @@ function outboxed(srv, customOpts) {
 
     const outboxOpts = config.getEventConfig(CDS_EVENT_TYPE, subType, srvConfig.namespace);
     const eventHeaders = getPropagatedHeaders(outboxOpts, req);
-    const contextProperties = getPropagatedContextProperties(outboxOpts, req);
+    const contextProperties = getPropagateContextProperties(outboxOpts, req);
     if (["persistent-outbox", "persistent-queue"].includes(outboxOpts.kind)) {
       await _mapToEventAndPublish(req, srvConfig.namespace, subType, eventHeaders, contextProperties);
       return;
@@ -81,8 +81,8 @@ const getPropagatedHeaders = (config, req) => {
   return Object.assign(propagateHeaders, req.headers);
 };
 
-const getPropagatedContextProperties = (config, req) => {
-  return config.propagatedContextProperties.reduce((properties, name) => {
+const getPropagateContextProperties = (config, req) => {
+  return config.propagateContextProperties.reduce((properties, name) => {
     if (name in req.tx.context) {
       properties[name] = req.tx.context[name];
     }