@cap-js-community/event-queue 1.1.0 → 1.2.0

package/cds-plugin.js

@@ -3,9 +3,9 @@
 const cds = require("@sap/cds");
 
 const eventQueue = require("./src");
+const COMPONENT_NAME = "/eventQueue/plugin";
 
-if (cds.env.eventQueue && cds.env.eventQueue.plugin) {
-  cds.on("serving", async () => {
-    await eventQueue.initialize();
-  });
+const eventQueueConfig = cds.env.eventQueue;
+if (!(cds.build.register || (!eventQueueConfig?.config && !eventQueueConfig?.configFilePath))) {
+  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.1.0",
+  "version": "1.2.0",
   "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.",
   "main": "src/index.js",
   "files": [
@@ -47,11 +47,11 @@
     "yaml": "2.3.4"
   },
   "devDependencies": {
-    "@sap/cds": "7.5.2",
-    "@sap/cds-dk": "7.5.1",
+    "@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.2",
+    "eslint-plugin-jest": "27.6.3",
     "eslint-plugin-node": "11.1.0",
     "express": "4.18.2",
     "hdb": "0.19.7",

package/src/config.js

@@ -55,6 +55,7 @@ class Config {
   #isPeriodicEventBlockedCb;
   #thresholdLoggingEventProcessing;
   #useAsCAPOutbox;
+  #userId;
   static #instance;
   constructor() {
     this.#logger = cds.log(COMPONENT_NAME);
@@ -453,6 +454,14 @@ class Config {
     return this.#useAsCAPOutbox;
   }
 
+  set userId(value) {
+    this.#userId = value;
+  }
+
+  get userId() {
+    return this.#userId;
+  }
+
   get isMultiTenancy() {
     return !!cds.requires.multitenancy;
   }

package/src/initialize.js

@@ -2,7 +2,6 @@
 
 const { promisify } = require("util");
 const fs = require("fs");
-const path = require("path");
 
 const cds = require("@sap/cds");
 const yaml = require("yaml");
@@ -37,6 +36,7 @@ const CONFIG_VARS = [
   ["updatePeriodicEvents", true],
   ["thresholdLoggingEventProcessing", 50],
   ["useAsCAPOutbox", false],
+  ["userId", null],
 ];
 
 const initialize = async ({
@@ -52,6 +52,7 @@ const initialize = async ({
   updatePeriodicEvents,
   thresholdLoggingEventProcessing,
   useAsCAPOutbox,
+  userId,
 } = {}) => {
   // TODO: initialize check:
   // - content of yaml check
@@ -74,19 +75,22 @@ const initialize = async ({
     skipCsnCheck,
     updatePeriodicEvents,
     thresholdLoggingEventProcessing,
-    useAsCAPOutbox
+    useAsCAPOutbox,
+    userId
   );
 
   const logger = cds.log(COMPONENT);
   config.fileContent = await readConfigFromFile(config.configFilePath);
   config.checkRedisEnabled();
 
-  const dbService = await cds.connect.to("db");
-  await (cds.model ? Promise.resolve() : new Promise((resolve) => cds.on("serving", resolve)));
-  !config.skipCsnCheck && (await csnCheck());
   if (config.processEventsAfterPublish) {
-    dbHandler.registerEventQueueDbHandler(dbService);
+    cds.on("connect", (service) => {
+      if (service.name === "db ") {
+        dbHandler.registerEventQueueDbHandler(service);
+      }
+    });
   }
+  !config.skipCsnCheck && (await csnCheck());
 
   monkeyPatchCAPOutbox();
   registerEventProcessors();
@@ -150,26 +154,30 @@ const monkeyPatchCAPOutbox = () => {
 };
 
 const csnCheck = async () => {
-  const eventCsn = cds.model.definitions[config.tableNameEventQueue];
-  if (!eventCsn) {
-    throw EventQueueError.missingTableInCsn(config.tableNameEventQueue);
-  }
+  cds.on("loaded", async (csn) => {
+    if (csn.namespace === "cds.xt") {
+      return;
+    }
+    const eventCsn = csn.definitions[config.tableNameEventQueue];
+    if (!eventCsn) {
+      throw EventQueueError.missingTableInCsn(config.tableNameEventQueue);
+    }
 
-  const lockCsn = cds.model.definitions[config.tableNameEventLock];
-  if (!lockCsn) {
-    throw EventQueueError.missingTableInCsn(config.tableNameEventLock);
-  }
+    const lockCsn = csn.definitions[config.tableNameEventLock];
+    if (!lockCsn) {
+      throw EventQueueError.missingTableInCsn(config.tableNameEventLock);
+    }
 
-  if (config.tableNameEventQueue === BASE_TABLES.EVENT && config.tableNameEventLock === BASE_TABLES.LOCK) {
-    return; // no need to check base tables
-  }
+    if (config.tableNameEventQueue === BASE_TABLES.EVENT && config.tableNameEventLock === BASE_TABLES.LOCK) {
+      return; // no need to check base tables
+    }
 
-  const csn = await cds.load(path.join(__dirname, "..", "db"));
-  const baseEvent = csn.definitions["sap.eventqueue.Event"];
-  const baseLock = csn.definitions["sap.eventqueue.Lock"];
+    const baseEvent = csn.definitions["sap.eventqueue.Event"];
+    const baseLock = csn.definitions["sap.eventqueue.Lock"];
 
-  checkCustomTable(baseEvent, eventCsn);
-  checkCustomTable(baseLock, lockCsn);
+    checkCustomTable(baseEvent, eventCsn);
+    checkCustomTable(baseLock, lockCsn);
+  });
 };
 
 const checkCustomTable = (baseCsn, customCsn) => {

package/src/redisPubSub.js

@@ -38,8 +38,10 @@ const _messageHandlerProcessEvents = async (messageData) => {
     }
 
     const subdomain = await getSubdomainForTenantId(tenantId);
+    const user = new cds.User.Privileged(config.userId);
     const tenantContext = {
       tenant: tenantId,
+      user,
       // NOTE: we need this because of logging otherwise logs would not contain the subdomain
       http: { req: { authInfo: { getSubdomain: () => subdomain } } },
     };
@@ -90,9 +92,11 @@ const broadcastEvent = async (tenantId, type, subType) => {
         let context = {};
         if (tenantId) {
           const subdomain = await getSubdomainForTenantId(tenantId);
+          const user = new cds.User.Privileged(config.userId);
           context = {
             // NOTE: we need this because of logging otherwise logs would not contain the subdomain
             tenant: tenantId,
+            user,
             http: { req: { authInfo: { getSubdomain: () => subdomain } } },
           };
         }

package/src/runner.js

@@ -2,6 +2,8 @@
 
 const { randomUUID } = require("crypto");
 
+const cds = require("@sap/cds");
+
 const eventQueueConfig = require("./config");
 const { processEventQueue } = require("./processEventQueue");
 const WorkerQueue = require("./shared/WorkerQueue");
@@ -11,6 +13,7 @@ const SetIntervalDriftSafe = require("./shared/SetIntervalDriftSafe");
 const { getSubdomainForTenantId } = require("./shared/cdsHelper");
 const periodicEvents = require("./periodicEvents");
 const { hashStringTo32Bit } = require("./shared/common");
+const config = require("./config");
 
 const COMPONENT_NAME = "/eventQueue/runner";
 const EVENT_QUEUE_RUN_ID = "EVENT_QUEUE_RUN_ID";
@@ -107,8 +110,10 @@ const _executeEventsAllTenants = (tenantIds, runId) => {
 
   return product.map(async ([tenantId, event]) => {
     const subdomain = await getSubdomainForTenantId(tenantId);
+    const user = new cds.User.Privileged(config.userId);
     const tenantContext = {
       tenant: tenantId,
+      user,
       // NOTE: we need this because of logging otherwise logs would not contain the subdomain
       http: { req: { authInfo: { getSubdomain: () => subdomain } } },
     };
@@ -140,8 +145,10 @@ const _executePeriodicEventsAllTenants = (tenantIds, runId) => {
     WorkerQueue.instance.addToQueue(1, label, async () => {
       try {
         const subdomain = await getSubdomainForTenantId(tenantId);
+        const user = new cds.User.Privileged(config.userId);
         const tenantContext = {
           tenant: tenantId,
+          user,
           // NOTE: we need this because of logging otherwise logs would not contain the subdomain
           http: { req: { authInfo: { getSubdomain: () => subdomain } } },
         };

package/src/shared/cdsHelper.js

@@ -24,13 +24,14 @@ async function executeInNewTransaction(context = {}, transactionTag, fn, args, {
   const parameters = Array.isArray(args) ? args : [args];
   const logger = cds.log(COMPONENT_NAME);
   try {
+    const user = new cds.User.Privileged(config.userId);
     if (cds.db.kind === "hana") {
       await cds.tx(
         {
           id: context.id,
           tenant: context.tenant,
           locale: context.locale,
-          user: context.user,
+          user,
           headers: context.headers,
           http: context.http,
         },
@@ -48,13 +49,14 @@ async function executeInNewTransaction(context = {}, transactionTag, fn, args, {
             id: context.id,
             tenant: context.tenant,
             locale: context.locale,
-            user: context.user,
+            user,
             headers: context.headers,
             http: context.http,
           },
           async (tx) => fn(tx, ...parameters)
         );
       } else {
+        contextTx.context.user = user;
         await fn(contextTx, ...parameters);
       }
     }