@cap-js-community/event-queue 1.3.0 → 1.3.2

package/README.md

@@ -15,24 +15,9 @@ allowing for processing at defined intervals. This feature further extends its c
 transaction management, ensuring that even regularly occurring tasks are handled efficiently and effectively without
 overloading any single instance. This makes it an ideal solution for applications needing consistent, reliable event processing.
 
-## Getting started
+## Getting Started
 
-- Run `npm add @cap-js-community/event-queue` in `@sap/cds` project
-- Activate the cds-plugin in the cds section of the package.json.
-
-### As cds-plugin
-
-For detailed information check out the [documentation](https://cap-js-community.github.io/event-queue/setup).
-
-```json
-{
-  "cds": {
-    "eventQueue": {
-      "configFilePath": "./srv/eventQueueConfig.yml"
-    }
-  }
-}
-```
+Dive right in and check out the getting started [documentation](https://cap-js-community.github.io/event-queue/setup).
 
 ## Features
 

package/cds-plugin.js

@@ -5,7 +5,6 @@ const cds = require("@sap/cds");
 const eventQueue = require("./src");
 const COMPONENT_NAME = "/eventQueue/plugin";
 
-const eventQueueConfig = cds.env.eventQueue;
-if (!(cds.build.register || (!eventQueueConfig?.config && !eventQueueConfig?.configFilePath))) {
+if (!cds.build.register && cds.env.eventQueue) {
   eventQueue.initialize().catch((err) => cds.log(COMPONENT_NAME).error(err));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "1.3.0",
+  "version": "1.3.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",
   "files": [
@@ -44,14 +44,16 @@
   "dependencies": {
     "redis": "4.6.13",
     "verror": "1.10.1",
-    "yaml": "2.3.4"
+    "yaml": "2.4.0"
   },
   "devDependencies": {
+    "@cap-js/hana": "^0.0.5",
+    "@cap-js/sqlite": "^1.5.0",
     "@sap/cds": "^7.5.3",
     "@sap/cds-dk": "^7.5.1",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jest": "^27.6.3",
+    "eslint-plugin-jest": "^27.9.0",
     "eslint-plugin-node": "^11.1.0",
     "express": "^4.18.2",
     "hdb": "^0.19.7",

package/src/EventQueueProcessorBase.js

@@ -20,6 +20,7 @@ const LIMIT_PARALLEL_EVENT_PROCESSING = 10;
 const SELECT_LIMIT_EVENTS_PER_TICK = 100;
 const TRIES_FOR_EXCEEDED_EVENTS = 3;
 const EVENT_START_AFTER_HEADROOM = 3 * 1000;
+const ETAG_CHECK_AFTER_MIN = 10;
 
 let serviceBindingCache = null;
 
@@ -901,7 +902,7 @@ class EventQueueProcessorBase {
    * @return {Promise<boolean>} true if the db record of the event has been modified since selection
    */
   async isOutdatedAndKeepalive(queueEntries) {
-    if (!this.__outdatedCheckEnabled) {
+    if (!this.__outdatedCheckEnabled || new Date() - this.__startTime <= ETAG_CHECK_AFTER_MIN * 60 * 1000) {
       return false;
     }
     let eventOutdated;

package/src/initialize.js

@@ -40,7 +40,7 @@ const CONFIG_VARS = [
   ["useAsCAPOutbox", false],
   ["userId", null],
   ["enableTxConsistencyCheck", false],
-  ["registerCleanupForDev", true],
+  ["cleanupLocksAndEventsForDev", false],
 ];
 
 const initialize = async ({
@@ -84,21 +84,19 @@ const initialize = async ({
   );
 
   const logger = cds.log(COMPONENT);
-  config.fileContent = await readConfigFromFile(config.configFilePath);
   config.checkRedisEnabled();
+  cds.on("connect", (service) => {
+    if (service.name === "db") {
+      config.processEventsAfterPublish && dbHandler.registerEventQueueDbHandler(service);
+      config.cleanupLocksAndEventsForDev && registerCleanupForDevDb().catch(() => {});
+      registerEventProcessors();
+    }
+  });
+  config.fileContent = await readConfigFromFile(config.configFilePath);
 
-  if (config.processEventsAfterPublish) {
-    cds.on("connect", (service) => {
-      if (service.name === "db") {
-        dbHandler.registerEventQueueDbHandler(service);
-        config.cleanupLocksAndEventsForDev && registerCleanupForDevDb().catch(() => {});
-      }
-    });
-  }
   !config.skipCsnCheck && (await csnCheck());
 
   monkeyPatchCAPOutbox();
-  registerEventProcessors();
   registerCdsShutdown();
   logger.info("event queue initialized", {
     registerAsEventProcessor: config.registerAsEventProcessor,
@@ -227,7 +225,7 @@ const registerCdsShutdown = () => {
 
 const registerCleanupForDevDb = async () => {
   const profile = cds.env.profiles.find((profile) => profile === "development");
-  if (!profile) {
+  if (!profile || process.env.NODE_ENV === "production") {
     return;
   }
 

package/src/outbox/eventQueueAsOutbox.js

@@ -68,21 +68,30 @@ function unboxed(srv) {
   return srv[UNBOXED] || srv;
 }
 
-const _mapToEventAndPublish = async (context, name, msg) => {
+const _mapToEventAndPublish = async (context, name, req) => {
+  let startAfter;
+  for (const header in req.headers ?? {}) {
+    if (header.toLocaleLowerCase() === "x-eventqueue-startafter") {
+      startAfter = req.headers[header];
+      delete req.headers[header];
+      break;
+    }
+  }
   const event = {
     contextUser: context.user.id,
-    ...(msg._fromSend || (msg.reply && { _fromSend: true })), // send or emit
-    ...(msg.inbound && { inbound: msg.inbound }),
-    ...(msg.event && { event: msg.event }),
-    ...(msg.data && { data: msg.data }),
-    ...(msg.headers && { headers: msg.headers }),
-    ...(msg.query && { query: msg.query }),
+    ...(req._fromSend || (req.reply && { _fromSend: true })), // send or emit
+    ...(req.inbound && { inbound: req.inbound }),
+    ...(req.event && { event: req.event }),
+    ...(req.data && { data: req.data }),
+    ...(req.headers && { headers: req.headers }),
+    ...(req.query && { query: req.query }),
   };
 
   await publishEvent(cds.tx(context), {
     type: CDS_EVENT_TYPE,
     subType: name,
     payload: JSON.stringify(event),
+    ...(startAfter && { startAfter }),
   });
 };
 

package/src/processEventQueue.js

@@ -274,7 +274,7 @@ const _checkEventIsBlocked = async (baseInstance) => {
   }
 
   if (eventBlocked) {
-    baseInstance.logger.info("skipping run because periodic event is blocked by configuration", {
+    baseInstance.logger.info("skipping run because event is blocked by configuration", {
       type: baseInstance.eventType,
       subType: baseInstance.eventSubType,
     });

package/src/redisPubSub.js

@@ -112,7 +112,7 @@ const broadcastEvent = async (tenantId, type, subType) => {
       [type, subType].join("##")
     );
     if (result) {
-      logger.info("skip publish redis event as no lock is available", {
+      logger.debug("skip publish redis event as no lock is available", {
         type,
         subType,
       });

package/src/shared/cdsHelper.js

@@ -57,6 +57,13 @@ async function executeInNewTransaction(context = {}, transactionTag, fn, args, {
         );
       } else {
         contextTx.context.user = user;
+        try {
+          contextTx.set?.({
+            "$user.id": user.id,
+          });
+        } catch {
+          /* empty */
+        }
         await fn(contextTx, ...parameters);
       }
     }