@fluidframework/container-runtime 2.4.0-299707 → 2.5.0-302463

package/lib/containerRuntime.js

@@ -25,7 +25,7 @@ import { FluidDataStoreRegistry } from "./dataStoreRegistry.js";
 import { DeltaManagerPendingOpsProxy, DeltaManagerSummarizerProxy, } from "./deltaManagerProxies.js";
 import { GCNodeType, GarbageCollector, gcGenerationOptionName, } from "./gc/index.js";
 import { ContainerMessageType, } from "./messageTypes.js";
-import { DuplicateBatchDetector, ensureContentsDeserialized, OpCompressor, OpDecompressor, OpGroupingManager, OpSplitter, Outbox, RemoteMessageProcessor, } from "./opLifecycle/index.js";
+import { DuplicateBatchDetector, ensureContentsDeserialized, OpCompressor, OpDecompressor, OpGroupingManager, OpSplitter, Outbox, RemoteMessageProcessor, serializeOpContents, } from "./opLifecycle/index.js";
 import { pkgVersion } from "./packageVersion.js";
 import { PendingStateManager, } from "./pendingStateManager.js";
 import { ScheduleManager } from "./scheduleManager.js";
@@ -89,12 +89,6 @@ export const TombstoneResponseHeaderKey = "isTombstoned";
  * to this was experimental and is no longer supported.
  */
 export const InactiveResponseHeaderKey = "isInactive";
-/** Default values for Runtime Headers */
-export const defaultRuntimeHeaderData = {
-    wait: true,
-    viaHandle: false,
-    allowTombstone: false,
-};
 /**
  * Available compression algorithms for op compression.
  * @legacy
@@ -232,7 +226,7 @@ function lastMessageFromMetadata(metadata) {
  * to understand if/when it is hit.
  * We only want to log this once, to avoid spamming telemetry if we are wrong and these cases are hit commonly.
  */
-let getSingleUseLegacyLogCallback = (logger, type) => {
+export let getSingleUseLegacyLogCallback = (logger, type) => {
     return (codePath) => {
         logger.sendTelemetryEvent({
             eventName: "LegacyMessageFormat",
@@ -1519,8 +1513,11 @@ export class ContainerRuntime extends TypedEventEmitter {
         const hasModernRuntimeMessageEnvelope = messageCopy.type === MessageType.Operation;
         const savedOp = messageCopy.metadata?.savedOp;
         const logLegacyCase = getSingleUseLegacyLogCallback(this.logger, messageCopy.type);
-        // We expect runtime messages to have JSON contents - deserialize it in place.
-        ensureContentsDeserialized(messageCopy, hasModernRuntimeMessageEnvelope, logLegacyCase);
+        let runtimeBatch = hasModernRuntimeMessageEnvelope || isUnpackedRuntimeMessage(messageCopy);
+        if (runtimeBatch) {
+            // We expect runtime messages to have JSON contents - deserialize it in place.
+            ensureContentsDeserialized(messageCopy);
+        }
         if (hasModernRuntimeMessageEnvelope) {
             // If the message has the modern message envelope, then process it here.
             // Here we unpack the message (decompress, unchunk, and/or ungroup) into a batch of messages with ContainerMessageType
@@ -1549,7 +1546,6 @@ export class ContainerRuntime extends TypedEventEmitter {
                     throw error;
                 }
             }
-            let runtimeBatch = true;
             // Reach out to PendingStateManager, either to zip localOpMetadata into the *local* message list,
             // or to check to ensure the *remote* messages don't match the batchId of a pending local batch.
             // This latter case would indicate that the container has forked - two copies are trying to persist the same local changes.
@@ -1588,8 +1584,17 @@ export class ContainerRuntime extends TypedEventEmitter {
             this.processInboundMessages(messagesWithPendingState, locationInBatch, local, savedOp, runtimeBatch);
         }
         else {
+            if (!runtimeBatch) {
+                // The DeltaManager used to do this, but doesn't anymore as of Loader v2.4
+                // Anyone listening to our "op" event would expect the contents to be parsed per this same logic
+                if (typeof messageCopy.contents === "string" &&
+                    messageCopy.contents !== "" &&
+                    messageCopy.type !== MessageType.ClientLeave) {
+                    messageCopy.contents = JSON.parse(messageCopy.contents);
+                }
+            }
             this.processInboundMessages([{ message: messageCopy, localOpMetadata: undefined }], { batchStart: true, batchEnd: true }, // Single message
-            local, savedOp, isUnpackedRuntimeMessage(messageCopy) /* runtimeBatch */);
+            local, savedOp, runtimeBatch);
         }
         if (local) {
             // If we have processed a local op, this means that the container is
@@ -1732,11 +1737,13 @@ export class ContainerRuntime extends TypedEventEmitter {
         const duration = Date.now() - this._signalTracking.signalTimestamp;
         this.mc.logger.sendPerformanceEvent({
             eventName: "SignalLatency",
-            duration, // Roundtrip duration of the tracked signal in milliseconds.
-            signalsSent: this._signalTracking.totalSignalsSentInLatencyWindow, // Signals sent since the last logged SignalLatency event.
-            signalsLost: this._signalTracking.signalsLost, // Signals lost since the last logged SignalLatency event.
-            outOfOrderSignals: this._signalTracking.signalsOutOfOrder, // Out of order signals since the last logged SignalLatency event.
-            reconnectCount: this.consecutiveReconnects, // Container reconnect count.
+            details: {
+                duration, // Roundtrip duration of the tracked signal in milliseconds.
+                sent: this._signalTracking.totalSignalsSentInLatencyWindow, // Signals sent since the last logged SignalLatency event.
+                lost: this._signalTracking.signalsLost, // Signals lost since the last logged SignalLatency event.
+                outOfOrder: this._signalTracking.signalsOutOfOrder, // Out of order signals since the last logged SignalLatency event.
+                reconnectCount: this.consecutiveReconnects, // Container reconnect count.
+            },
         });
         this._signalTracking.signalsLost = 0;
         this._signalTracking.signalsOutOfOrder = 0;
@@ -1763,9 +1770,11 @@ export class ContainerRuntime extends TypedEventEmitter {
                 this._signalTracking.signalsLost += signalsLost;
                 this.mc.logger.sendErrorEvent({
                     eventName: "SignalLost",
-                    signalsLost, // Number of lost signals detected.
-                    trackingSequenceNumber: this._signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
-                    clientBroadcastSignalSequenceNumber, // Actual signal sequence number received.
+                    details: {
+                        signalsLost, // Number of lost signals detected.
+                        expectedSequenceNumber: this._signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
+                        clientBroadcastSignalSequenceNumber, // Actual signal sequence number received.
+                    },
                 });
             }
             // Update the tracking signal sequence number to the next expected signal in the sequence.
@@ -1777,11 +1786,18 @@ export class ContainerRuntime extends TypedEventEmitter {
         clientBroadcastSignalSequenceNumber >=
             this._signalTracking.minimumTrackingSignalSequenceNumber) {
             this._signalTracking.signalsOutOfOrder++;
+            const details = {
+                expectedSequenceNumber: this._signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
+                clientBroadcastSignalSequenceNumber, // Sequence number of the out of order signal.
+            };
+            // Only log `contents.type` when address is for container to avoid
+            // chance that contents type is customer data.
+            if (envelope.address === undefined) {
+                details.contentsType = envelope.contents.type; // Type of signal that was received out of order.
+            }
             this.mc.logger.sendTelemetryEvent({
                 eventName: "SignalOutOfOrder",
-                type: envelope.contents.type, // Type of signal that was received out of order.
-                trackingSequenceNumber: this._signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
-                clientBroadcastSignalSequenceNumber, // Sequence number of the out of order signal.
+                details,
             });
         }
         if (this._signalTracking.roundTripSignalSequenceNumber !== undefined &&
@@ -1790,7 +1806,8 @@ export class ContainerRuntime extends TypedEventEmitter {
                 this._signalTracking.roundTripSignalSequenceNumber) {
                 // Latency tracked signal has been received.
                 // We now log the roundtrip duration of the tracked signal.
-                // This telemetry event also logs metrics for signals sent, signals lost, and out of order signals received.
+                // This telemetry event also logs metrics for broadcast signals
+                // sent, lost, and out of order.
                 // These metrics are reset after logging the telemetry event.
                 this.sendSignalTelemetryEvent();
             }
@@ -2636,7 +2653,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                     contents: idRange,
                 };
                 const idAllocationBatchMessage = {
-                    contents: JSON.stringify(idAllocationMessage),
+                    contents: serializeOpContents(idAllocationMessage),
                     referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
                 };
                 this.outbox.submitIdAllocation(idAllocationBatchMessage);
@@ -2679,12 +2696,12 @@ export class ContainerRuntime extends TypedEventEmitter {
                     contents: schemaChangeMessage,
                 };
                 this.outbox.submit({
-                    contents: JSON.stringify(msg),
+                    contents: serializeOpContents(msg),
                     referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
                 });
             }
             const message = {
-                contents: JSON.stringify(containerRuntimeMessage) /* serialized content */,
+                contents: serializeOpContents(containerRuntimeMessage),
                 metadata,
                 localOpMetadata,
                 referenceSequenceNumber: this.deltaManager.lastSequenceNumber,