@cap-js-community/event-queue 1.6.3 → 1.6.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "1.6.3",
+  "version": "1.6.5",
   "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",
@@ -27,7 +27,7 @@
     "test:all:coverage": "jest --runInBand --forceExit --collect-coverage",
     "test:prepare": "npm run build:ci --prefix=./test-integration/_env",
     "test:deploySchema": "node test-integration/_env/srv/hana/deploy.js",
-    "test:cleanSchemas": "node test-integration/_env/srv/hana/cleanObsoletSchemas.js",
+    "test:cleanSchemas": "node test-integration/_env/srv/hana/deleteTestSchema.js ",
     "lint": "npm run eslint && npm run prettier",
     "lint:ci": "npm run eslint:ci && npm run prettier:ci",
     "eslint": "eslint --fix .",
@@ -63,9 +63,6 @@
     "prettier": "^2.8.8",
     "sqlite3": "^5.1.7"
   },
-  "peerDependencies": {
-    "@cap-js/telemetry": "^0.2.2"
-  },
   "homepage": "https://cap-js-community.github.io/event-queue/",
   "repository": {
     "type": "git",

package/src/EventQueueProcessorBase.js

@@ -24,6 +24,7 @@ const TRIES_FOR_EXCEEDED_EVENTS = 3;
 const EVENT_START_AFTER_HEADROOM = 3 * 1000;
 const ETAG_CHECK_AFTER_MIN = 10;
 const SUFFIX_PERIODIC = "_PERIODIC";
+const DEFAULT_RETRY_AFTER = 5 * 60 * 1000;
 
 class EventQueueProcessorBase {
   #eventsWithExceededTries = [];
@@ -37,6 +38,7 @@ class EventQueueProcessorBase {
   #eventConfig;
   #isPeriodic;
   #lastSuccessfulRunTimestamp;
+  #retryFailedAfter;
 
   constructor(context, eventType, eventSubType, config) {
     this.__context = context;
@@ -57,6 +59,7 @@ class EventQueueProcessorBase {
     if (this.__parallelEventProcessing > LIMIT_PARALLEL_EVENT_PROCESSING) {
       this.__parallelEventProcessing = LIMIT_PARALLEL_EVENT_PROCESSING;
     }
+    this.#retryFailedAfter = this.#eventConfig.retryFailedAfter ?? DEFAULT_RETRY_AFTER;
     // NOTE: keep the feature, this might be needed again
     this.__concurrentEventProcessing = false;
     this.__startTime = this.#eventConfig.startTime ?? new Date();
@@ -454,11 +457,23 @@ class EventQueueProcessorBase {
         if (!eventIds.length) {
           continue;
         }
+        let startAfter;
+        if (status === EventProcessingStatus.Error) {
+          startAfter = new Date(Date.now() + this.#retryFailedAfter);
+          this.#eventSchedulerInstance.scheduleEvent(
+            this.__context.tenant,
+            this.#eventType,
+            this.#eventSubType,
+            startAfter
+          );
+        }
+
         await tx.run(
           UPDATE.entity(this.#config.tableNameEventQueue)
             .set({
               status: status,
               lastAttemptTimestamp: ts,
+              ...(status === EventProcessingStatus.Error ? { startAfter: startAfter.toISOString() } : {}),
             })
             .where("ID IN", eventIds)
         );
@@ -552,7 +567,8 @@ class EventQueueProcessorBase {
    */
   async getQueueEntriesAndSetToInProgress() {
     let result = [];
-    const refDateStartAfter = new Date(Date.now() + this.#config.runInterval * 1.2);
+    const baseDate = Date.now();
+    const refDateStartAfter = new Date(baseDate + this.#config.runInterval * 1.2);
     await executeInNewTransaction(this.__baseContext, "eventQueue-getQueueEntriesAndSetToInProgress", async (tx) => {
       const entries = await tx.run(
         SELECT.from(this.#config.tableNameEventQueue)
@@ -574,7 +590,7 @@ class EventQueueProcessorBase {
                   "OR lastAttemptTimestamp IS NULL ) OR ( status =",
                   EventProcessingStatus.InProgress,
                   "AND lastAttemptTimestamp <=",
-                  new Date(new Date().getTime() - this.#config.globalTxTimeout).toISOString(),
+                  new Date(baseDate - this.#config.globalTxTimeout).toISOString(),
                   ") )",
                 ]
               : [
@@ -585,7 +601,7 @@ class EventQueueProcessorBase {
                   ") OR ( status =",
                   EventProcessingStatus.InProgress,
                   "AND lastAttemptTimestamp <=",
-                  new Date(new Date().getTime() - this.#config.globalTxTimeout).toISOString(),
+                  new Date(baseDate - this.#config.globalTxTimeout).toISOString(),
                   ") )",
                 ])
           )
@@ -920,7 +936,7 @@ class EventQueueProcessorBase {
       return;
     }
     try {
-      await trace(this.baseContext, "persist-release-lock", async () => {
+      await trace(this.baseContext, "release-lock", async () => {
         await distributedLock.releaseLock(this.context, [this.#eventType, this.#eventSubType].join("##"));
       });
     } catch (err) {
@@ -1160,6 +1176,10 @@ class EventQueueProcessorBase {
   get isPeriodicEvent() {
     return this.#eventConfig.isPeriodic;
   }
+
+  get eventConfig() {
+    return this.#eventConfig;
+  }
 }
 
 module.exports = EventQueueProcessorBase;

package/src/config.js

@@ -282,6 +282,7 @@ class Config {
       checkForNextChunk: config.checkForNextChunk,
       deleteFinishedEventsAfterDays: config.deleteFinishedEventsAfterDays,
       appNames: config.appNames,
+      useEventQueueUser: config.useEventQueueUser,
       internalEvent: true,
     };
     eventConfig._appNameMap = eventConfig.appNames

package/src/index.d.ts

@@ -63,6 +63,24 @@ type EventConfigType = {
   isPeriodic: boolean;
 };
 
+export type EventConfig = {
+  type: string;
+  subType: string;
+  load: number;
+  impl: string;
+  selectMaxChunkSize: number | undefined;
+  parallelEventProcessing: boolean;
+  retryAttempts: number | undefined;
+  transactionMode: string | undefined;
+  processAfterCommit: boolean | undefined;
+  eventOutdatedCheck: boolean | undefined;
+  checkForNextChunk: boolean | undefined;
+  deleteFinishedEventsAfterDays: number | undefined;
+  appNames: string[] | undefined;
+  useEventQueueUser: boolean | undefined;
+  internalEvent: true;
+};
+
 // Define Status Type
 type Status = 0 | 1 | 2 | 3 | 4;
 
@@ -126,6 +144,7 @@ export declare class EventQueueProcessorBase {
   get isPeriodicEvent(): boolean;
   get eventType(): String;
   get eventSubType(): String;
+  get eventConfig(): EventConfig;
 }
 
 export function publishEvent(

package/src/outbox/EventQueueGenericOutboxHandler.js

@@ -5,6 +5,7 @@ const cds = require("@sap/cds");
 const EventQueueBaseClass = require("../EventQueueProcessorBase");
 const { EventProcessingStatus } = require("../constants");
 const common = require("../shared/common");
+const config = require("../config");
 
 const COMPONENT_NAME = "/eventQueue/outbox/generic";
 
@@ -18,7 +19,8 @@ class EventQueueGenericOutboxHandler extends EventQueueBaseClass {
     let status = EventProcessingStatus.Done;
     try {
       const service = await cds.connect.to(this.eventSubType);
-      const userId = payload.contextUser;
+      const { useEventQueueUser } = this.eventConfig;
+      const userId = useEventQueueUser ? config.userId : payload.contextUser;
       const msg = payload._fromSend ? new cds.Request(payload) : new cds.Event(payload);
       const invocationFn = payload._fromSend ? "send" : "emit";
       delete msg._fromSend;