@zlink-systems/framework 0.31.0 → 0.32.0

package/dist/runtime/channels/channel-dispatchers.d.ts

@@ -13,6 +13,7 @@ import { type ZLinkOneWayDispatch, type ZLinkRequestDispatch } from './channel-d
 export interface ZLinkChannelRequestDispatcherOptions {
     readonly meshName?: string;
     readonly channelName: string;
+    readonly receivedAtClock?: () => Date;
     /**
      * Mesh channels use the routed message context so a handler can associate
      * a report with the node that sent it.
@@ -57,7 +58,7 @@ export declare class ZLinkChannelRequestDispatcher {
         send?: () => ZLinkMultipartOperation<ZLinkMultipartAsyncSubmitOperation>;
     }, router: {
         reply(routingId: unknown, replyToken: unknown): ZLinkMultipartReplyOperation;
-    }, signal?: AbortSignal, decodedHeader?: ZLinkChannelEnvelopeHeader): Promise<boolean | void>;
+    }, signal?: AbortSignal, decodedHeader?: ZLinkChannelEnvelopeHeader, receivedAt?: Date): Promise<boolean | void>;
     dispatchMesh(record: ReceiveRecord, signal?: AbortSignal, admit?: ZLinkMeshDispatchAdmission): void | Promise<void>;
     private submitReply;
     private createMeshContext;
@@ -65,6 +66,7 @@ export declare class ZLinkChannelRequestDispatcher {
 export interface ZLinkChannelPublishDispatcherOptions {
     readonly meshName?: string;
     readonly channelName: string;
+    readonly receivedAtClock?: () => Date;
     readonly codecs?: ZLinkChannelEnvelopeCodecRegistry;
     readonly dispatchErrors: ZLinkDispatchErrorReporter;
     readonly handlers: ReadonlyMap<string, Pick<ZLinkOneWayDispatch<ZLinkPublishMessageContext>, 'handler' | 'messageType'>>;
@@ -82,10 +84,11 @@ export declare class ZLinkChannelPublishDispatcher {
     dispatch(topicMessage: {
         readonly topic: string;
         readonly parts: readonly Message[];
-    }, signal?: AbortSignal, decodedHeader?: ZLinkChannelEnvelopeHeader): Promise<void>;
+    }, signal?: AbortSignal, decodedHeader?: ZLinkChannelEnvelopeHeader, receivedAt?: Date): Promise<void>;
 }
 export interface ZLinkRoutePacketDispatcherOptions {
     readonly routerChannelId: string;
+    readonly receivedAtClock?: () => Date;
     readonly codecs?: ZLinkChannelEnvelopeCodecRegistry;
     readonly dispatchErrors: ZLinkDispatchErrorReporter;
     readonly handlers: readonly ZLinkRouteHandlerRegistration[];
@@ -98,6 +101,7 @@ export declare class ZLinkRoutePacketDispatcher {
     private readonly sendHandlers;
     private readonly requestHandlers;
     private readonly codecs?;
+    private readonly receivedAtClock;
     private readonly pipeline;
     constructor(options: ZLinkRoutePacketDispatcherOptions);
     private readonly routerChannelId;
@@ -120,7 +124,7 @@ export declare class ZLinkRoutePacketDispatcher {
         send?: () => ZLinkMultipartOperation<ZLinkMultipartAsyncSubmitOperation>;
     }, router: {
         reply(routingId: unknown, replyToken: unknown): ZLinkMultipartReplyOperation;
-    }, signal?: AbortSignal, decodedHeader?: ZLinkChannelEnvelopeHeader, infrastructureChecked?: boolean): Promise<boolean | void>;
+    }, signal?: AbortSignal, decodedHeader?: ZLinkChannelEnvelopeHeader, infrastructureChecked?: boolean, receivedAt?: Date): Promise<boolean | void>;
     dispatchMesh(record: ReceiveRecord, signal?: AbortSignal, admit?: ZLinkMeshDispatchAdmission): void | Promise<void>;
     dispatchLocalCommand(parts: readonly Message[], sourceNodeRid: RoutingId, signal?: AbortSignal): Promise<void>;
     private dispatchMeshCommand;

package/dist/runtime/channels/channel-dispatchers.js

@@ -30,7 +30,7 @@ class ZLinkChannelRequestDispatcher {
     flowEnabled() {
         return this.options.dispatchErrors.flow.flowCreationEnabled();
     }
-    async dispatch(received, router, signal, decodedHeader) {
+    async dispatch(received, router, signal, decodedHeader, receivedAt = this.options.receivedAtClock?.() ?? new Date()) {
         if (received.spotId !== null && received.spotId !== undefined) {
             if (received.send === undefined) {
                 throw new configuration_1.ZLinkConfigurationException('Routed SPOT packet is missing a local SPOT delivery context.');
@@ -78,7 +78,8 @@ class ZLinkChannelRequestDispatcher {
                 contentType: envelope.header.contentType,
                 packetName,
                 metadata: (0, contracts_1.zlinkMessageMetadata)(envelope.header.metadata),
-                correlationId
+                correlationId,
+                receivedAt
             };
             await this.pipeline.dispatchOneWay({
                 fields,
@@ -113,7 +114,8 @@ class ZLinkChannelRequestDispatcher {
             contentType: envelope.header.contentType,
             packetName,
             metadata: (0, contracts_1.zlinkMessageMetadata)(envelope.header.metadata),
-            correlationId
+            correlationId,
+            receivedAt
         };
         await this.pipeline.dispatchRequest({
             fields: requestFields,
@@ -167,7 +169,7 @@ class ZLinkChannelRequestDispatcher {
                 codecs: this.options.codecs,
                 handler: handler?.handler,
                 messageType: handler?.messageType,
-                context: this.createMeshContext(envelope, record.sourceNodeRid),
+                context: this.createMeshContext(envelope, record.sourceNodeRid, record.receivedAt),
                 signal
             }, admit);
         }
@@ -181,7 +183,7 @@ class ZLinkChannelRequestDispatcher {
             flowId: envelope.header.flowId,
             flowOrigin: envelope.header.flowOrigin
         };
-        return this.pipeline.dispatchRequest(new ZLinkMeshRequestDispatch(fields, envelope, this.options.codecs, this.options.handlers.get(packetName), this.createMeshContext(envelope, record.sourceNodeRid), signal, record, 'channel', this.options.channelName), admit);
+        return this.pipeline.dispatchRequest(new ZLinkMeshRequestDispatch(fields, envelope, this.options.codecs, this.options.handlers.get(packetName), this.createMeshContext(envelope, record.sourceNodeRid, record.receivedAt), signal, record, 'channel', this.options.channelName), admit);
     }
     submitReply(operation, signal) {
         void signal;
@@ -190,14 +192,15 @@ class ZLinkChannelRequestDispatcher {
         }
         return completedChannelReply;
     }
-    createMeshContext(envelope, sourceNodeRid) {
+    createMeshContext(envelope, sourceNodeRid, receivedAt) {
         const base = {
             meshName: this.options.meshName,
             channelName: this.options.channelName,
             contentType: envelope.header.contentType,
             packetName: envelope.packetName,
             metadata: (0, contracts_1.zlinkMessageMetadata)(envelope.header.metadata),
-            correlationId: envelope.header.correlationId ?? undefined
+            correlationId: envelope.header.correlationId ?? undefined,
+            receivedAt: receivedAt ?? this.options.receivedAtClock?.() ?? new Date()
         };
         if (this.options.routeMesh !== true) {
             return base;
@@ -270,7 +273,7 @@ class ZLinkChannelPublishDispatcher {
             unhandled: options.unhandled
         });
     }
-    async dispatch(topicMessage, signal, decodedHeader) {
+    async dispatch(topicMessage, signal, decodedHeader, receivedAt = this.options.receivedAtClock?.() ?? new Date()) {
         if (topicMessage.parts.length === 0 || topicMessage.parts[0].data().length === 0) {
             return;
         }
@@ -315,7 +318,8 @@ class ZLinkChannelPublishDispatcher {
             topic: publishTopic,
             source: publishSource,
             metadata: (0, contracts_1.zlinkMessageMetadata)(envelope.header.metadata),
-            correlationId: publishCorr
+            correlationId: publishCorr,
+            receivedAt
         };
         await this.pipeline.dispatchOneWay({
             fields,
@@ -346,10 +350,12 @@ class ZLinkRoutePacketDispatcher {
     sendHandlers = new Map();
     requestHandlers = new Map();
     codecs;
+    receivedAtClock;
     pipeline;
     constructor(options) {
         this.routerChannelId = options.routerChannelId;
         this.codecs = options.codecs;
+        this.receivedAtClock = options.receivedAtClock ?? (() => new Date());
         this.dispatchErrors = options.dispatchErrors;
         this.pipeline = new channel_dispatch_pipeline_1.ZLinkChannelDispatchPipeline({
             dispatchErrors: options.dispatchErrors,
@@ -389,7 +395,7 @@ class ZLinkRoutePacketDispatcher {
         }
         return false;
     }
-    async dispatch(received, router, signal, decodedHeader, infrastructureChecked = false) {
+    async dispatch(received, router, signal, decodedHeader, infrastructureChecked = false, receivedAt = this.receivedAtClock()) {
         const channelHeader = decodedHeader ?? (0, channel_envelope_inspection_1.tryDecodeChannelHeader)(received.parts, this.flowEnabled());
         if (!infrastructureChecked) {
             const infrastructure = this.dispatchInfrastructure(received);
@@ -442,7 +448,7 @@ class ZLinkRoutePacketDispatcher {
                 codecs: (0, channel_framework_packets_1.codecsForFrameworkPacket)(packetName, this.codecs),
                 handler: handler?.handler,
                 messageType: handler?.messageType,
-                context: this.createRouteContext(envelope, received.routingId),
+                context: this.createRouteContext(envelope, received.routingId, receivedAt),
                 signal
             });
             return;
@@ -478,7 +484,7 @@ class ZLinkRoutePacketDispatcher {
             codecs,
             handler: handler?.handler,
             messageType: handler?.messageType,
-            context: this.createRouteContext(envelope, received.routingId),
+            context: this.createRouteContext(envelope, received.routingId, receivedAt),
             signal,
             missingHandlerMessage: `No routed request handler is registered for '${this.routerChannelId}:${packetName}'.`,
             writeReply: (reply) => this.submitReply((0, channel_multipart_1.appendParts)(router.reply(received.routingId, replyToken), (0, channel_envelope_1.encodeChannelReplyParts)(envelope.header, reply, codecs))),
@@ -512,7 +518,7 @@ class ZLinkRoutePacketDispatcher {
         const sourceNodeRid = String(record.sourceNodeRid ?? '');
         const correlationId = envelope.header.correlationId ?? undefined;
         if (envelope.header.kind === 3 /* ZLinkChannelMessageKind.Command */) {
-            return this.dispatchMeshCommand(envelope, packetName, sourceNodeRid, record.sourceNodeRid, signal, admit);
+            return this.dispatchMeshCommand(envelope, packetName, sourceNodeRid, record.sourceNodeRid, signal, admit, record.receivedAt ?? this.receivedAtClock());
         }
         if (envelope.header.kind !== 1 /* ZLinkChannelMessageKind.Request */) {
             return completedChannelReply;
@@ -525,9 +531,10 @@ class ZLinkRoutePacketDispatcher {
             flowId: envelope.header.flowId,
             flowOrigin: envelope.header.flowOrigin
         };
-        return this.pipeline.dispatchRequest(new ZLinkMeshRequestDispatch(fields, envelope, (0, channel_framework_packets_1.codecsForFrameworkPacket)(packetName, this.codecs), this.requestHandlers.get(packetName), this.createRouteContext(envelope, record.sourceNodeRid), signal, record, 'routed', this.routerChannelId), admit);
+        return this.pipeline.dispatchRequest(new ZLinkMeshRequestDispatch(fields, envelope, (0, channel_framework_packets_1.codecsForFrameworkPacket)(packetName, this.codecs), this.requestHandlers.get(packetName), this.createRouteContext(envelope, record.sourceNodeRid, record.receivedAt), signal, record, 'routed', this.routerChannelId), admit);
     }
     async dispatchLocalCommand(parts, sourceNodeRid, signal) {
+        const receivedAt = this.receivedAtClock();
         if (parts.length === 0 || parts[0].data().length === 0)
             return;
         let envelope;
@@ -551,9 +558,9 @@ class ZLinkRoutePacketDispatcher {
         if (packetName === undefined) {
             throw new configuration_1.ZLinkConfigurationException('Route packet is missing packetName.');
         }
-        await this.dispatchMeshCommand(envelope, packetName, String(sourceNodeRid), sourceNodeRid, signal);
+        await this.dispatchMeshCommand(envelope, packetName, String(sourceNodeRid), sourceNodeRid, signal, undefined, receivedAt);
     }
-    dispatchMeshCommand(envelope, packetName, sourceRid, sourceNodeRid, signal, admit) {
+    dispatchMeshCommand(envelope, packetName, sourceRid, sourceNodeRid, signal, admit, receivedAt = this.receivedAtClock()) {
         const handler = this.sendHandlers.get(packetName);
         return this.pipeline.dispatchOneWay({
             fields: {
@@ -568,7 +575,7 @@ class ZLinkRoutePacketDispatcher {
             codecs: (0, channel_framework_packets_1.codecsForFrameworkPacket)(packetName, this.codecs),
             handler: handler?.handler,
             messageType: handler?.messageType,
-            context: this.createRouteContext(envelope, sourceNodeRid),
+            context: this.createRouteContext(envelope, sourceNodeRid, receivedAt),
             signal
         }, admit);
     }
@@ -578,7 +585,7 @@ class ZLinkRoutePacketDispatcher {
         }
         return completedChannelReply;
     }
-    createRouteContext(envelope, sourceRid) {
+    createRouteContext(envelope, sourceRid, receivedAt = this.receivedAtClock()) {
         const sourceNodeRid = String(sourceRid ?? '');
         return {
             meshName: this.routerChannelId,
@@ -586,7 +593,8 @@ class ZLinkRoutePacketDispatcher {
             contentType: envelope.header.contentType,
             sourceNodeRid,
             metadata: (0, contracts_1.zlinkMessageMetadata)(envelope.header.metadata),
-            correlationId: envelope.header.correlationId ?? undefined
+            correlationId: envelope.header.correlationId ?? undefined,
+            receivedAt
         };
     }
 }