@cap-js-community/event-queue 1.6.0 → 1.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "1.6.0",
+  "version": "1.6.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",
   "types": "src/index.d.ts",
@@ -43,16 +43,16 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@sap/xssec": "^3.6.1",
-    "redis": "^4.6.15",
+    "@sap/xssec": "^4.2.1",
+    "redis": "^4.7.0",
     "verror": "^1.10.1",
-    "yaml": "^2.4.2"
+    "yaml": "^2.5.0"
   },
   "devDependencies": {
-    "@cap-js/hana": "^1.1.0",
-    "@cap-js/sqlite": "^1.7.2",
-    "@sap/cds": "^7.9.2",
-    "@sap/cds-dk": "^7.8.0",
+    "@cap-js/hana": "^1.1.1",
+    "@cap-js/sqlite": "^1.7.3",
+    "@sap/cds": "^8.1.0",
+    "@sap/cds-dk": "^8.1.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jest": "^28.6.0",

package/src/EventQueueProcessorBase.js

@@ -163,12 +163,13 @@ class EventQueueProcessorBase {
     );
   }
 
-  logTimeExceeded(iterationCounter) {
-    this.logger.info("Exiting event queue processing as max time exceeded", {
+  logTimeExceededAndPublishContinue(iterationCounter) {
+    this.logger.info("Exiting event queue processing as max time exceeded - but broadcast to trigger processing", {
       eventType: this.#eventType,
       eventSubType: this.#eventSubType,
       iterationCounter,
     });
+    this.#eventSchedulerInstance.scheduleEvent(this.__context.tenant, this.#eventType, this.#eventSubType, new Date());
   }
 
   logStartMessage() {

package/src/index.d.ts

@@ -117,6 +117,7 @@ export declare class EventQueueProcessorBase {
   setShouldRollbackTransaction(key: string): void;
   shouldRollbackTransaction(key: string): boolean;
   beforeProcessingEvents(): Promise<void>;
+  addEntryToProcessingMap(key: string, queueEntry: EventEntity, payload: Object): void;
 
   set logger(value: CdsLogger);
   get logger(): CdsLogger;
@@ -214,3 +215,38 @@ declare class Config {
 }
 
 export const config: Config;
+
+export const workerQueue: WorkerQueue;
+
+declare class WorkerQueue {
+  constructor(concurrency: number);
+
+  addToQueue(load: number, label: string, priority?: Priorities, cb?: () => any): Promise<any>;
+
+  _executeFunction(
+    load: number,
+    label: string,
+    cb: () => any,
+    resolve: (value?: unknown) => void,
+    reject: (reason?: any) => void,
+    startTime: bigint,
+    priority: string
+  ): void;
+
+  get runningPromises(): Array<Promise<any>>;
+  get runningLoad(): number;
+
+  static get instance(): WorkerQueue;
+
+  get queue(): Record<
+    string,
+    Array<[number, string, () => any, (value?: unknown) => void, (reason?: any) => void, bigint]>
+  >;
+}
+
+interface Priorities {
+  Low: string;
+  Medium: string;
+  High: string;
+  VeryHigh: string;
+}

package/src/index.js

@@ -10,4 +10,5 @@ module.exports = {
   ...require("./constants"),
   ...require("./publishEvent"),
   EventQueueProcessorBase: require("./EventQueueProcessorBase"),
+  WorkerQueue: require("./shared/WorkerQueue"),
 };

package/src/processEventQueue.js

@@ -120,7 +120,7 @@ const reevaluateShouldContinue = (eventTypeInstance, iterationCounter, startTime
     return true;
   }
 
-  eventTypeInstance.logTimeExceeded(iterationCounter);
+  eventTypeInstance.logTimeExceededAndPublishContinue(iterationCounter);
   return false;
 };
 

package/src/shared/WorkerQueue.js

@@ -8,7 +8,7 @@ const { Priorities } = require("../constants");
 const SetIntervalDriftSafe = require("./SetIntervalDriftSafe");
 
 const PRIORITIES = Object.values(Priorities).reverse();
-const PRIORITY_MULTIPLICATOR = PRIORITIES.reduce((result, element, index) => {
+const PRIORITY_MULTIPLICATION = PRIORITIES.reduce((result, element, index) => {
   result[element] = index + 1;
   return result;
 }, {});
@@ -152,6 +152,10 @@ class WorkerQueue {
     return this.#queue;
   }
 
+  get runningLoad() {
+    return this.#runningLoad;
+  }
+
   #checkAndLogWaitingTime(startTime, label, priority) {
     const ts = Date.now();
     if (ts - lastLogTs <= 1000) {
@@ -159,7 +163,7 @@ class WorkerQueue {
     }
     lastLogTs = ts;
     const diffMs = Math.round(Number(process.hrtime.bigint() - startTime) / NANO_TO_MS);
-    const priorityMultiplication = PRIORITY_MULTIPLICATOR[priority];
+    const priorityMultiplication = PRIORITY_MULTIPLICATION[priority];
     let logLevel;
     if (diffMs >= THRESHOLD.ERROR * priorityMultiplication) {
       logLevel = "error";

package/src/shared/common.js

@@ -1,15 +1,10 @@
 "use strict";
 
 const crypto = require("crypto");
-const { promisify } = require("util");
 
 const cds = require("@sap/cds");
 const xssec = require("@sap/xssec");
 
-const getAuthTokenAsync = promisify(xssec.requests.requestClientCredentialsToken);
-const getCreateSecurityContextAsync = promisify(xssec.createSecurityContext);
-
-let authInfoCache = {};
 const MARGIN_AUTH_INFO_EXPIRY = 60 * 1000;
 const COMPONENT_NAME = "/eventQueue/common";
 
@@ -74,9 +69,15 @@ const processChunkedSync = (inputs, chunkSize, chunkHandler) => {
 const hashStringTo32Bit = (value) => crypto.createHash("sha256").update(String(value)).digest("base64").slice(0, 32);
 
 const _getNewAuthInfo = async (tenantId) => {
+  const authInfoCache = getAuthInfo._authInfoCache;
+  authInfoCache[tenantId] = authInfoCache[tenantId] ?? {};
   try {
-    const token = await getAuthTokenAsync(null, cds.requires.auth.credentials, null, tenantId);
-    const authInfo = await getCreateSecurityContextAsync(token, cds.requires.auth.credentials);
+    if (!_getNewAuthInfo._xsuaaService) {
+      _getNewAuthInfo._xsuaaService = new xssec.XsuaaService(cds.requires.auth.credentials);
+    }
+    const authService = _getNewAuthInfo._xsuaaService;
+    const token = await authService.fetchClientCredentialsToken({ zid: tenantId });
+    const authInfo = await authService.createSecurityContext(token.access_token);
     authInfoCache[tenantId].expireTs = authInfo.getExpirationDate().getTime() - MARGIN_AUTH_INFO_EXPIRY;
     return authInfo;
   } catch (err) {
@@ -89,7 +90,13 @@ const getAuthInfo = async (tenantId) => {
   if (!cds.requires?.auth?.credentials) {
     return null; // no credentials not authInfo
   }
+  if (!cds.requires?.auth.kind.match(/jwt|xsuaa/i)) {
+    cds.log(COMPONENT_NAME).warn("Only 'jwt' or 'xsuaa' are supported as values for auth.kind.");
+    return null;
+  }
 
+  getAuthInfo._authInfoCache = getAuthInfo._authInfoCache ?? {};
+  const authInfoCache = getAuthInfo._authInfoCache;
   // not existing or existing but expired
   if (
     !authInfoCache[tenantId] ||
@@ -110,6 +117,6 @@ module.exports = {
   hashStringTo32Bit,
   getAuthInfo,
   __: {
-    clearAuthInfoCache: () => (authInfoCache = {}),
+    clearAuthInfoCache: () => (getAuthInfo._authInfoCache = {}),
   },
 };