@cap-js-community/event-queue 1.2.3 → 1.2.5

package/README.md

@@ -28,7 +28,6 @@ For detailed information check out the [documentation](https://cap-js-community.
 {
   "cds": {
     "eventQueue": {
-      "plugin": true,
       "configFilePath": "./srv/eventQueueConfig.yml"
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "1.2.3",
-  "description": "An event queue that enables secure transactional processing of asynchronous events, featuring instant event processing with Redis Pub/Sub and load distribution across all application instances.",
+  "version": "1.2.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",
   "files": [
     "src",
@@ -49,15 +49,15 @@
   "devDependencies": {
     "@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-node": "11.1.0",
-    "express": "4.18.2",
-    "hdb": "0.19.7",
-    "jest": "29.7.0",
-    "prettier": "2.8.8",
-    "sqlite3": "5.1.7"
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jest": "^27.6.3",
+    "eslint-plugin-node": "^11.1.0",
+    "express": "^4.18.2",
+    "hdb": "^0.19.7",
+    "jest": "^29.7.0",
+    "prettier": "^2.8.8",
+    "sqlite3": "^5.1.7"
   },
   "homepage": "https://cap-js-community.github.io/event-queue/",
   "repository": {

package/src/EventQueueProcessorBase.js

@@ -21,7 +21,7 @@ const SELECT_LIMIT_EVENTS_PER_TICK = 100;
 const TRIES_FOR_EXCEEDED_EVENTS = 3;
 const EVENT_START_AFTER_HEADROOM = 3 * 1000;
 
-let serviceBindingCache = {};
+let serviceBindingCache = null;
 
 class EventQueueProcessorBase {
   #eventsWithExceededTries = [];
@@ -700,13 +700,16 @@ class EventQueueProcessorBase {
   }
 
   async #getServiceBindings() {
-    if (serviceBindingCache && serviceBindingCache.exipreTs >= Date.now()) {
-      return serviceBindingCache.value;
+    if (!(serviceBindingCache && serviceBindingCache.expireTs >= Date.now())) {
+      const mtxServiceManager = require("@sap/cds-mtxs/srv/plugins/hana/srv-mgr");
+      serviceBindingCache = {
+        expireTs: Date.now() + 10 * 60 * 1000,
+        value: mtxServiceManager.getAll().catch(() => {
+          serviceBindingCache = null;
+        }),
+      };
     }
-    const mtxServiceManager = require("@sap/cds-mtxs/srv/plugins/hana/srv-mgr");
-    serviceBindingCache.value = await mtxServiceManager.getAll();
-    serviceBindingCache.exipreTs = Date.now() + 10 * 60 * 1000;
-    return serviceBindingCache.value;
+    return await serviceBindingCache.value;
   }
 
   async #selectLastSuccessfulPeriodicTimestamp() {

package/src/config.js

@@ -57,6 +57,7 @@ class Config {
   #useAsCAPOutbox;
   #userId;
   #enableTxConsistencyCheck;
+  #cleanupLocksAndEventsForDev;
   static #instance;
   constructor() {
     this.#logger = cds.log(COMPONENT_NAME);
@@ -340,6 +341,9 @@ class Config {
   }
 
   set runInterval(value) {
+    if (!Number.isInteger(value) || value <= 10 * 1000) {
+      throw EventQueueError.invalidInterval();
+    }
     this.#runInterval = value;
   }
 
@@ -471,6 +475,14 @@ class Config {
     return this.#enableTxConsistencyCheck;
   }
 
+  set cleanupLocksAndEventsForDev(value) {
+    this.#cleanupLocksAndEventsForDev = value;
+  }
+
+  get cleanupLocksAndEventsForDev() {
+    return this.#cleanupLocksAndEventsForDev;
+  }
+
   get isMultiTenancy() {
     return !!cds.requires.multitenancy;
   }

package/src/initialize.js

@@ -14,6 +14,8 @@ const config = require("./config");
 const { initEventQueueRedisSubscribe, closeSubscribeClient } = require("./redisPubSub");
 const { closeMainClient } = require("./shared/redis");
 const eventQueueAsOutbox = require("./outbox/eventQueueAsOutbox");
+const { getAllTenantIds } = require("./shared/cdsHelper");
+const { EventProcessingStatus } = require("./constants");
 
 const readFileAsync = promisify(fs.readFile);
 
@@ -38,6 +40,7 @@ const CONFIG_VARS = [
   ["useAsCAPOutbox", false],
   ["userId", null],
   ["enableTxConsistencyCheck", false],
+  ["registerCleanupForDev", true],
 ];
 
 const initialize = async ({
@@ -55,11 +58,8 @@ const initialize = async ({
   useAsCAPOutbox,
   userId,
   enableTxConsistencyCheck,
+  cleanupLocksAndEventsForDev,
 } = {}) => {
-  // TODO: initialize check:
-  // - content of yaml check
-  // - betweenRuns
-
   if (config.initialized) {
     return;
   }
@@ -79,7 +79,8 @@ const initialize = async ({
     thresholdLoggingEventProcessing,
     useAsCAPOutbox,
     userId,
-    enableTxConsistencyCheck
+    enableTxConsistencyCheck,
+    cleanupLocksAndEventsForDev
   );
 
   const logger = cds.log(COMPONENT);
@@ -90,6 +91,7 @@ const initialize = async ({
     cds.on("connect", (service) => {
       if (service.name === "db") {
         dbHandler.registerEventQueueDbHandler(service);
+        config.cleanupLocksAndEventsForDev && registerCleanupForDevDb().catch(() => {});
       }
     });
   }
@@ -108,20 +110,28 @@ const initialize = async ({
 };
 
 const readConfigFromFile = async (configFilepath) => {
-  const fileData = await readFileAsync(configFilepath);
-  if (/\.ya?ml$/i.test(configFilepath)) {
-    return yaml.parse(fileData.toString());
-  }
-  if (/\.json$/i.test(configFilepath)) {
-    return JSON.parse(fileData.toString());
+  try {
+    const fileData = await readFileAsync(configFilepath);
+    if (/\.ya?ml$/i.test(configFilepath)) {
+      return yaml.parse(fileData.toString());
+    }
+    if (/\.json$/i.test(configFilepath)) {
+      return JSON.parse(fileData.toString());
+    }
+
+    throw new VError(
+      {
+        name: VERROR_CLUSTER_NAME,
+        info: { configFilepath },
+      },
+      "configFilepath with unsupported extension, allowed extensions are .yaml and .json"
+    );
+  } catch (err) {
+    if (config.useAsCAPOutbox) {
+      return {};
+    }
+    throw err;
   }
-  throw new VError(
-    {
-      name: VERROR_CLUSTER_NAME,
-      info: { configFilepath },
-    },
-    "configFilepath with unsupported extension, allowed extensions are .yaml and .json"
-  );
 };
 
 const registerEventProcessors = () => {
@@ -149,9 +159,11 @@ const monkeyPatchCAPOutbox = () => {
   if (config.useAsCAPOutbox) {
     Object.defineProperty(cds, "outboxed", {
       get: () => eventQueueAsOutbox.outboxed,
+      configurable: true,
     });
     Object.defineProperty(cds, "unboxed", {
       get: () => eventQueueAsOutbox.unboxed,
+      configurable: true,
     });
   }
 };
@@ -213,6 +225,25 @@ const registerCdsShutdown = () => {
   });
 };
 
+const registerCleanupForDevDb = async () => {
+  const profile = cds.env.profiles.find((profile) => profile === "development");
+  if (!profile) {
+    return;
+  }
+
+  const tenantIds = await getAllTenantIds();
+  for (const tenantId of tenantIds) {
+    await cds.tx({ tenant: tenantId }, async (tx) => {
+      await tx.run(DELETE.from(config.tableNameEventLock));
+      await tx.run(
+        UPDATE.entity(config.tableNameEventQueue).where({ status: EventProcessingStatus.InProgress }).set({
+          status: EventProcessingStatus.Error,
+        })
+      );
+    });
+  }
+};
+
 module.exports = {
   initialize,
 };