@cosyte/mllp 0.0.4 → 0.0.5

package/dist/index.cjs

@@ -2007,8 +2007,8 @@ var Correlator = class {
    *   removed from live store. Caller calls `entry.resolve(ackPayload)`.
    * - controlId: keyed lookup by `controlIdFromAck`. Live-store hit returns
    *   the entry; graveyard hit fires `MLLP_ACK_AFTER_TIMEOUT` warning
-   *   and returns `null`; otherwise fires
-   *   `onUnmatchedAck(controlIdFromAck)` and returns `null`.
+   *   and returns `null`; otherwise fires `onUnmatchedAck` with the id's
+   *   **byte length** and returns `null`.
    *
    * Triggers lazy graveyard eviction.
    *
@@ -2031,7 +2031,7 @@ var Correlator = class {
     }
     if (controlIdFromAck === null) {
       if (this._opts.onUnmatchedAck !== void 0) {
-        this._opts.onUnmatchedAck("");
+        this._opts.onUnmatchedAck(null);
       }
       return null;
     }
@@ -2046,7 +2046,9 @@ var Correlator = class {
     if (grave !== void 0) {
       const elapsedSinceSendMs = this._opts.now() - grave.timedOutAt;
       this._opts.onWarning("MLLP_ACK_AFTER_TIMEOUT", {
-        controlId: grave.controlId,
+        // The LENGTH, never the id. Control IDs are decoded `latin1`, a 1:1
+        // byte to code-unit map, so `.length` is a byte count.
+        controlIdBytes: grave.controlId === null ? null : grave.controlId.length,
         elapsedSinceSendMs,
         byteOffset: byteOffsetFromAck
       });
@@ -2054,7 +2056,7 @@ var Correlator = class {
       return null;
     }
     if (this._opts.onUnmatchedAck !== void 0) {
-      this._opts.onUnmatchedAck(controlIdFromAck);
+      this._opts.onUnmatchedAck(controlIdFromAck.length);
     }
     return null;
   }
@@ -2129,11 +2131,32 @@ var Correlator = class {
   }
 };
 
+// src/client/ack-diagnostics.ts
+var ACK_DIAGNOSTIC_MESSAGES = Object.freeze({
+  MLLP_ACK_UNMATCHED_CONTROL_ID: "Inbound ACK control ID matched no in-flight send and no timed-out send; the ACK was dropped. Field values are withheld: MSA-2 is inbound payload content and this diagnostic goes to a log. The inbound bytes are on the 'message' event; controlIdBytes gives the length.",
+  MLLP_ACK_AFTER_TIMEOUT: "ACK arrived after its send had already timed out; the ACK was dropped. Field values are withheld: a control ID is payload content and this diagnostic goes to a log. The outbound bytes are the payload you passed to send(); controlIdBytes gives the length."
+});
+function ackDiagnosticMessage(code) {
+  return ACK_DIAGNOSTIC_MESSAGES[code];
+}
+
 // src/client/error.ts
 var MllpTimeoutError = class _MllpTimeoutError extends Error {
   name = "MllpTimeoutError";
-  /** MSH-10 control ID of the timed-out send (FIFO mode: `undefined`). */
-  messageControlId;
+  /**
+   * Byte length of the timed-out send's MSH-10 control ID, or `undefined` when
+   * there was none to read (FIFO mode, or a payload with no MSH-10).
+   *
+   * **The control ID itself is deliberately not here.** An `Error` is a
+   * diagnostic surface: it is logged, and its `stack` is what an error reporter
+   * ships off the box. MSH-10 is payload content, and a scanner that returns
+   * the wrong field returns payload content of some other kind, which is how a
+   * patient identifier reaches a log line. Nothing is lost by withholding it,
+   * because this error rejects the very `send()` whose payload the caller
+   * passed in, so the caller already holds the bytes. Control IDs are decoded
+   * `latin1`, a 1:1 byte to code-unit map, so this count is a byte count.
+   */
+  messageControlIdBytes;
   /** Milliseconds elapsed between write-flush and timeout fire. */
   elapsedMs;
   /** Epoch ms timestamp recorded at write-flush callback. */
@@ -2141,12 +2164,12 @@ var MllpTimeoutError = class _MllpTimeoutError extends Error {
   /**
    * Construct an MLLP timeout error.
    *
-   * @param message - Human-readable error message.
-   * @param opts - Timeout context (originating message control id, elapsed time, flush timestamp).
+   * @param message - Human-readable error message. Structural facts only, never field content.
+   * @param opts - Timeout context (control-id byte length, elapsed time, flush timestamp).
    */
   constructor(message, opts) {
     super(message);
-    this.messageControlId = opts.messageControlId;
+    this.messageControlIdBytes = opts.messageControlIdBytes;
     this.elapsedMs = opts.elapsedMs;
     this.sentAt = opts.sentAt;
     if (Error.captureStackTrace) {
@@ -2589,31 +2612,34 @@ var MllpClient = class extends events.EventEmitter {
         maxInFlight: this._pipeline ? Number.POSITIVE_INFINITY : 1,
         onWarning: (code, ctx) => {
           this._aggregatedWarningsByCode[code] = (this._aggregatedWarningsByCode[code] ?? 0) + 1;
-          this._emitContained(
-            "warning",
-            Object.freeze({
-              code,
-              byteOffset: ctx.byteOffset,
-              message: `${code}: controlId=${ctx.controlId} elapsed=${ctx.elapsedSinceSendMs}ms`,
-              connectionId: this._connection?.connectionId ?? conn.connectionId,
-              timestamp: /* @__PURE__ */ new Date()
-            })
-          );
+          const warning = Object.freeze({
+            code,
+            byteOffset: ctx.byteOffset,
+            message: ackDiagnosticMessage(code),
+            controlIdBytes: ctx.controlIdBytes,
+            elapsedSinceSendMs: ctx.elapsedSinceSendMs,
+            connectionId: this._connection?.connectionId ?? conn.connectionId,
+            timestamp: /* @__PURE__ */ new Date()
+          });
+          this._emitContained("warning", warning);
         },
-        onUnmatchedAck: (controlId) => {
+        onUnmatchedAck: (controlIdBytes) => {
           if (this.listenerCount("error") === 0) return;
           const err = new MllpFramingError(
             "MLLP_ACK_UNMATCHED_CONTROL_ID",
             0,
             Buffer.alloc(0),
-            `Unmatched ACK control ID${controlId === "" ? "" : `: ${controlId}`}`
+            ackDiagnosticMessage("MLLP_ACK_UNMATCHED_CONTROL_ID")
           );
           safeEmitError(
             this,
             Object.freeze({
               connectionId: this._connection?.connectionId ?? conn.connectionId,
               error: err,
-              controlId
+              // The peer's MSA-2 byte LENGTH. The bytes themselves used to be
+              // here and on the message above; a peer sending a one-megabyte
+              // MSA-2 produced a one-megabyte Error.message, straight into a log.
+              controlIdBytes
             })
           );
         },
@@ -2621,7 +2647,7 @@ var MllpClient = class extends events.EventEmitter {
           this._timedOutTotal += 1;
           entry.reject(
             new MllpTimeoutError(`ACK timeout after ${elapsedMs}ms`, {
-              messageControlId: entry.controlId ?? void 0,
+              messageControlIdBytes: entry.controlId?.length,
               elapsedMs,
               sentAt: entry.sentAt ?? 0
             })
@@ -3174,7 +3200,7 @@ var MllpClient = class extends events.EventEmitter {
         cleanup();
         reject(
           new MllpTimeoutError(`waiting for drain timed out after ${ackTimeoutMs}ms`, {
-            messageControlId: void 0,
+            messageControlIdBytes: void 0,
             elapsedMs: ackTimeoutMs,
             sentAt: Date.now()
           })
@@ -3412,7 +3438,7 @@ async function createStarterClient(opts) {
 }
 
 // src/index.ts
-var VERSION = "0.0.4";
+var VERSION = "0.0.5";
 
 exports.Connection = Connection;
 exports.FrameReader = FrameReader;
@@ -3428,6 +3454,7 @@ exports.MllpTimeoutError = MllpTimeoutError;
 exports.NetTransport = NetTransport;
 exports.TlsTransport = TlsTransport;
 exports.VERSION = VERSION;
+exports.ackDiagnosticMessage = ackDiagnosticMessage;
 exports.buildRawAck = buildRawAck;
 exports.createClient = createClient;
 exports.createServer = createServer;