@cap-js-community/event-queue 1.11.0 → 1.11.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "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",

package/src/config.js

@@ -65,6 +65,7 @@ const ALLOWED_EVENT_OPTIONS_AD_HOC = [
   "processAfterCommit",
   "checkForNextChunk",
   "retryFailedAfter",
+  "propagateHeaders",
   "multiInstanceProcessing",
   "kind",
   "timeBucket",
@@ -388,6 +389,7 @@ class Config {
       selectMaxChunkSize: config.selectMaxChunkSize ?? config.chunkSize,
       parallelEventProcessing: config.parallelEventProcessing ?? (config.parallel && CAP_PARALLEL_DEFAULT),
       retryAttempts: config.retryAttempts ?? config.maxAttempts ?? CAP_MAX_ATTEMPTS_DEFAULT,
+      propagateHeaders: config.propagateHeaders ?? [],
       ...config,
     });
     eventConfig.internalEvent = true;
@@ -583,6 +585,7 @@ class Config {
     event._appInstancesMap = event.appInstances
       ? Object.fromEntries(new Map(event.appInstances.map((a) => [a, true])))
       : null;
+    event.propagateHeaders = event.propagateHeaders ?? [];
   }
 
   #basicEventValidation(event) {

package/src/outbox/eventQueueAsOutbox.js

@@ -47,13 +47,15 @@ function outboxed(srv, customOpts) {
       customOpts || {}
     );
     config.addCAPOutboxEventBase(srv.name, outboxOpts);
-    const specificSettings = config.getCdsOutboxEventSpecificConfig(srv.name, req.event);
-    if (specificSettings) {
+    const hasSpecificSettings = !!config.getCdsOutboxEventSpecificConfig(srv.name, req.event);
+    if (hasSpecificSettings) {
       outboxOpts = config.addCAPOutboxEventSpecificAction(srv.name, req.event);
     }
-
+    const subType = hasSpecificSettings ? [srv.name, req.event].join(".") : srv.name;
+    outboxOpts = config.getEventConfig(CDS_EVENT_TYPE, subType);
+    const eventHeaders = getPropagatedHeaders(outboxOpts, req);
     if (["persistent-outbox", "persistent-queue"].includes(outboxOpts.kind)) {
-      await _mapToEventAndPublish(context, srv.name, req, !!specificSettings);
+      await _mapToEventAndPublish(context, subType, req, eventHeaders);
       return;
     }
     context.on("succeeded", async () => {
@@ -79,30 +81,41 @@ function unboxed(srv) {
   return srv[UNBOXED] || srv;
 }
 
-const _mapToEventAndPublish = async (context, name, req, actionSpecific) => {
+const getPropagatedHeaders = (config, req) => {
+  const propagateHeaders = config.propagateHeaders.reduce((headers, headerName) => {
+    if (headerName in req.tx.context.headers) {
+      headers[headerName] = req.tx.context.headers[headerName];
+    }
+    return headers;
+  }, {});
+  return Object.assign(propagateHeaders, req.headers);
+};
+
+const _mapToEventAndPublish = async (context, subType, req, eventHeaders) => {
   const eventQueueSpecificValues = {};
   for (const header in req.headers ?? {}) {
     for (const field of EVENT_QUEUE_SPECIFIC_FIELDS) {
       if (header.toLocaleLowerCase() === `x-eventqueue-${field.toLocaleLowerCase()}`) {
         eventQueueSpecificValues[field] = req.headers[header];
-        delete req.headers[header];
+        delete eventHeaders[header];
         break;
       }
     }
   }
+
   const event = {
     contextUser: context.user.id,
     ...(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 }),
+    ...(eventHeaders && { headers: eventHeaders }),
     ...(req.query && { query: req.query }),
   };
 
   await publishEvent(cds.tx(context), {
     type: CDS_EVENT_TYPE,
-    subType: actionSpecific ? [name, req.event].join(".") : name,
+    subType,
     payload: JSON.stringify(event),
     ...eventQueueSpecificValues,
   });