@cap-js-community/event-queue 0.1.49 → 0.1.50

package/README.md

@@ -21,7 +21,7 @@ enhancing the overall performance of your application.
 
 ```js
 const cds = require("@sap/cds");
-const eventQueue = require("@sap/cds-event-queue");
+const eventQueue = require("@cap-js-community/event-queue");
 
 cds.on("bootstrap", () => {
   eventQueue.initialize({
@@ -86,7 +86,7 @@ Use the tables provided by this library. For that add the following to `package.
   "cds": {
     "requires": {
       "cds-event-queue": {
-        "model": "@sap/cds-event-queue"
+        "model": "@cap-js-community/event-queue"
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "0.1.49",
+  "version": "0.1.50",
   "description": "event queue for cds",
   "main": "src/index.js",
   "files": [

package/src/EventQueueProcessorBase.js

@@ -3,7 +3,7 @@
 const cds = require("@sap/cds");
 
 const { executeInNewTransaction } = require("./shared/cdsHelper");
-const { EventProcessingStatus } = require("./constants");
+const { EventProcessingStatus, TransactionMode } = require("./constants");
 const distributedLock = require("./shared/distributedLock");
 const EventQueueError = require("./EventQueueError");
 const { arrayToFlatMap } = require("./shared/common");
@@ -48,7 +48,8 @@ class EventQueueProcessorBase {
     this.__selectNextChunk = !!this.__config.checkForNextChunk;
     this.__keepalivePromises = {};
     this.__outdatedCheckEnabled = this.__config.eventOutdatedCheck ?? true;
-    this.__commitOnEventLevel = this.__config.commitOnEventLevel ?? true;
+    this.__transactionMode =
+      this.__config.transactionMode ?? TransactionMode.isolated;
     this.__eventsWithExceededTries = [];
     this.__emptyChunkSelected = false;
     this.__lockAcquired = false;
@@ -175,7 +176,7 @@ class EventQueueProcessorBase {
       eventType: this.__eventType,
       eventSubType: this.__eventSubType,
     });
-    this._determineAndAddEventStatusToMap(
+    this.#determineAndAddEventStatusToMap(
       queueEntry.ID,
       EventProcessingStatus.Done
     );
@@ -191,12 +192,19 @@ class EventQueueProcessorBase {
   clusterQueueEntries() {
     Object.entries(this.__queueEntriesWithPayloadMap).forEach(
       ([key, { queueEntry, payload }]) => {
-        this._addEntryToProcessingMap(key, queueEntry, payload);
+        this.addEntryToProcessingMap(key, queueEntry, payload);
       }
     );
   }
 
-  _addEntryToProcessingMap(key, queueEntry, payload) {
+  /**
+   * This function allows to add entries to the process map. This function is needed if the function clusterQueueEntries
+   * is redefined. For each entry in the processing map the processEvent function will be called once.
+   * @param {String} key key for event
+   * @param {Object} queueEntry queueEntry which should be clustered with this key
+   * @param {Object} payload payload which should be clustered with this key
+   */
+  addEntryToProcessingMap(key, queueEntry, payload) {
     this.logger.debug("add entry to processing map", {
       key,
       queueEntry,
@@ -212,8 +220,8 @@ class EventQueueProcessorBase {
 
   /**
    * This function sets the status of multiple events to a given status. If the structure of queueEntryProcessingStatusTuple
-   * is not as expected all events will be set to error. The function respects the config commitOnEventLevel. If
-   * commitOnEventLevel is true the status will be written to a dedicated map and returned afterwards to handle concurrent
+   * is not as expected all events will be set to error. The function respects the config transactionMode. If
+   * transactionMode is isolated the status will be written to a dedicated map and returned afterwards to handle concurrent
    * event processing.
    * @param {Array} queueEntries which has been selected from event queue table and been modified by modifyQueueEntry
    * @param {Array<Object>} queueEntryProcessingStatusTuple Array of tuple <queueEntryId, processingStatus>
@@ -227,14 +235,14 @@ class EventQueueProcessorBase {
       eventType: this.__eventType,
       eventSubType: this.__eventSubType,
     });
-    const statusMap = this.__commitOnEventLevel ? {} : this.__statusMap;
+    const statusMap = this.commitOnEventLevel ? {} : this.__statusMap;
     try {
       queueEntryProcessingStatusTuple.forEach(([id, processingStatus]) =>
-        this._determineAndAddEventStatusToMap(id, processingStatus, statusMap)
+        this.#determineAndAddEventStatusToMap(id, processingStatus, statusMap)
       );
     } catch (error) {
       queueEntries.forEach((queueEntry) =>
-        this._determineAndAddEventStatusToMap(
+        this.#determineAndAddEventStatusToMap(
           queueEntry.ID,
           EventProcessingStatus.Error,
           statusMap
@@ -265,7 +273,7 @@ class EventQueueProcessorBase {
     }
   }
 
-  _determineAndAddEventStatusToMap(
+  #determineAndAddEventStatusToMap(
     id,
     processingStatus,
     statusMap = this.__statusMap
@@ -298,7 +306,7 @@ class EventQueueProcessorBase {
       }
     );
     queueEntries.forEach((queueEntry) =>
-      this._determineAndAddEventStatusToMap(
+      this.#determineAndAddEventStatusToMap(
         queueEntry.ID,
         EventProcessingStatus.Error
       )
@@ -324,11 +332,11 @@ class EventQueueProcessorBase {
       eventType: this.__eventType,
       eventSubType: this.__eventSubType,
     });
-    this._ensureOnlySelectedQueueEntries(statusMap);
+    this.#ensureOnlySelectedQueueEntries(statusMap);
     if (!skipChecks) {
-      this._ensureEveryQueueEntryHasStatus();
+      this.#ensureEveryQueueEntryHasStatus();
     }
-    this._ensureEveryStatusIsAllowed(statusMap);
+    this.#ensureEveryStatusIsAllowed(statusMap);
 
     const { success, failed, exceeded, invalidAttempts } = Object.entries(
       statusMap
@@ -408,7 +416,7 @@ class EventQueueProcessorBase {
     });
   }
 
-  _ensureEveryQueueEntryHasStatus() {
+  #ensureEveryQueueEntryHasStatus() {
     this.__queueEntries.forEach((queueEntry) => {
       if (
         queueEntry.ID in this.__statusMap ||
@@ -424,14 +432,14 @@ class EventQueueProcessorBase {
           queueEntry,
         }
       );
-      this._determineAndAddEventStatusToMap(
+      this.#determineAndAddEventStatusToMap(
         queueEntry.ID,
         EventProcessingStatus.Error
       );
     });
   }
 
-  _ensureEveryStatusIsAllowed(statusMap) {
+  #ensureEveryStatusIsAllowed(statusMap) {
     Object.entries(statusMap).forEach(([queueEntryId, status]) => {
       if (
         [
@@ -457,7 +465,7 @@ class EventQueueProcessorBase {
     });
   }
 
-  _ensureOnlySelectedQueueEntries(statusMap) {
+  #ensureOnlySelectedQueueEntries(statusMap) {
     Object.keys(statusMap).forEach((queueEntryId) => {
       if (this.__queueEntriesMap[queueEntryId]) {
         return;
@@ -484,7 +492,7 @@ class EventQueueProcessorBase {
       }
     );
     this.__queueEntries.forEach((queueEntry) => {
-      this._determineAndAddEventStatusToMap(
+      this.#determineAndAddEventStatusToMap(
         queueEntry.ID,
         EventProcessingStatus.Error
       );
@@ -500,7 +508,7 @@ class EventQueueProcessorBase {
         eventSubType: this.__eventSubType,
       }
     );
-    this._determineAndAddEventStatusToMap(
+    this.#determineAndAddEventStatusToMap(
       queueEntry.ID,
       EventProcessingStatus.Error
     );
@@ -574,7 +582,7 @@ class EventQueueProcessorBase {
         }
 
         const { exceededTries, openEvents } =
-          this._filterExceededEvents(entries);
+          this.#filterExceededEvents(entries);
         if (exceededTries.length) {
           this.__eventsWithExceededTries = exceededTries;
         }
@@ -620,7 +628,7 @@ class EventQueueProcessorBase {
     return result;
   }
 
-  _filterExceededEvents(events) {
+  #filterExceededEvents(events) {
     return events.reduce(
       (result, event) => {
         if (event.attempts === this.__retryAttempts) {
@@ -819,13 +827,6 @@ class EventQueueProcessorBase {
     this.__processTx = null;
   }
 
-  get shouldTriggerRollback() {
-    return (
-      this.statusMapContainsError(this.__statusMap) ||
-      this.statusMapContainsError(this.__commitedStatusMap)
-    );
-  }
-
   get logger() {
     return this.__logger ?? this.__baseLogger;
   }
@@ -875,7 +876,11 @@ class EventQueueProcessorBase {
   }
 
   get commitOnEventLevel() {
-    return this.__commitOnEventLevel;
+    return this.__transactionMode === TransactionMode.isolated;
+  }
+
+  get transactionMode() {
+    return this.__transactionMode;
   }
 
   get eventType() {

package/src/constants.js

@@ -8,4 +8,9 @@ module.exports = {
     Error: 3,
     Exceeded: 4,
   },
+  TransactionMode: {
+    isolated: "isolated",
+    alwaysCommit: "alwaysCommit",
+    alwaysRollback: "alwaysRollback",
+  },
 };

package/src/processEventQueue.js

@@ -5,6 +5,7 @@ const pathLib = require("path");
 const cds = require("@sap/cds");
 
 const { getConfigInstance } = require("./config");
+const { TransactionMode } = require("./constants");
 const { limiter, Funnel } = require("./shared/common");
 
 const EventQueueBase = require("./EventQueueProcessorBase");
@@ -136,7 +137,8 @@ const processEventQueue = async (
               eventTypeInstance.handleErrorDuringClustering(err);
             }
             if (
-              eventTypeInstance.shouldTriggerRollback ||
+              eventTypeInstance.transactionMode !==
+                TransactionMode.alwaysCommit ||
               Object.entries(eventTypeInstance.eventProcessingMap).some(
                 ([key]) => eventTypeInstance.shouldRollbackTransaction(key)
               )

package/src/publishEvent.js

@@ -15,7 +15,7 @@ const publishEvent = async (tx, events) => {
       throw EventQueueError.unknownEventType(type, subType);
     }
   }
-  await tx.run(
+  return await tx.run(
     INSERT.into(configInstance.tableNameEventQueue).entries(eventsForProcessing)
   );
 };