@fluidframework/container-runtime 2.4.0-299374 → 2.4.0

package/dist/containerRuntime.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContainerRuntime = exports.loadContainerRuntime = exports.makeLegacySendBatchFn = exports.getDeviceSpec = exports.agentSchedulerId = exports.isUnpackedRuntimeMessage = exports.defaultPendingOpsRetryDelayMs = exports.defaultPendingOpsWaitTimeoutMs = exports.disabledCompressionConfig = exports.CompressionAlgorithms = exports.defaultRuntimeHeaderData = exports.InactiveResponseHeaderKey = exports.TombstoneResponseHeaderKey = exports.DeletedResponseHeaderKey = exports.DefaultSummaryConfiguration = void 0;
+exports.ContainerRuntime = exports.loadContainerRuntime = exports.getSingleUseLegacyLogCallback = exports.makeLegacySendBatchFn = exports.getDeviceSpec = exports.agentSchedulerId = exports.isUnpackedRuntimeMessage = exports.defaultPendingOpsRetryDelayMs = exports.defaultPendingOpsWaitTimeoutMs = exports.disabledCompressionConfig = exports.CompressionAlgorithms = exports.defaultRuntimeHeaderData = exports.InactiveResponseHeaderKey = exports.TombstoneResponseHeaderKey = exports.DeletedResponseHeaderKey = exports.DefaultSummaryConfiguration = void 0;
 const client_utils_1 = require("@fluid-internal/client-utils");
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const internal_1 = require("@fluidframework/container-definitions/internal");
@@ -33,16 +33,23 @@ const scheduleManager_js_1 = require("./scheduleManager.js");
 const index_js_4 = require("./summary/index.js");
 const throttler_js_1 = require("./throttler.js");
 /**
- * Utility to implement compat behaviors given an unknown message type
+ * Creates an error object to be thrown / passed to Container's close fn in case of an unknown message type.
  * The parameters are typed to support compile-time enforcement of handling all known types/behaviors
  *
- * @param _unknownContainerRuntimeMessageType - Typed as something unexpected, to ensure all known types have been
+ * @param unknownContainerRuntimeMessageType - Typed as something unexpected, to ensure all known types have been
  * handled before calling this function (e.g. in a switch statement).
- * @param compatBehavior - Typed redundantly with CompatModeBehavior to ensure handling is added when updating that type
+ *
+ * @param codePath - The code path where the unexpected message type was encountered.
+ *
+ * @param sequencedMessage - The sequenced message that contained the unexpected message type.
+ *
  */
-function compatBehaviorAllowsMessageType(_unknownContainerRuntimeMessageType, compatBehavior) {
-    // undefined defaults to same behavior as "FailToProcess"
-    return compatBehavior === "Ignore";
+function getUnknownMessageTypeError(unknownContainerRuntimeMessageType, codePath, sequencedMessage) {
+    return internal_7.DataProcessingError.create("Runtime message of unknown type", codePath, sequencedMessage, {
+        messageDetails: {
+            type: unknownContainerRuntimeMessageType,
+        },
+    });
 }
 /**
  * @legacy
@@ -236,9 +243,10 @@ let getSingleUseLegacyLogCallback = (logger, type) => {
             details: { codePath, type },
         });
         // Now that we've logged, prevent future logging (globally).
-        getSingleUseLegacyLogCallback = () => () => { };
+        exports.getSingleUseLegacyLogCallback = () => () => { };
     };
 };
+exports.getSingleUseLegacyLogCallback = getSingleUseLegacyLogCallback;
 /**
  * This is meant to be used by a {@link @fluidframework/container-definitions#IRuntimeFactory} to instantiate a container runtime.
  * @param params - An object which specifies all required and optional params necessary to instantiate a runtime.
@@ -1394,22 +1402,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 // GC op is only sent in summarizer which should never have stashed ops.
                 throw new internal_7.LoggingError("GC op not expected to be stashed in summarizer");
             default: {
-                // This should be extremely rare for stashed ops.
-                // It would require a newer runtime stashing ops and then an older one applying them,
-                // e.g. if an app rolled back its container version
-                const compatBehavior = opContents.compatDetails?.behavior;
-                if (!compatBehaviorAllowsMessageType(opContents.type, compatBehavior)) {
-                    const error = internal_7.DataProcessingError.create("Stashed runtime message of unexpected type", "applyStashedOp", undefined /* sequencedMessage */, {
-                        messageDetails: JSON.stringify({
-                            type: opContents.type,
-                            compatBehavior,
-                        }),
-                    });
-                    this.closeFn(error);
-                    throw error;
-                }
-                // Note: Even if its compat behavior allows it, we don't know how to apply this stashed op.
-                // All we can do is ignore it (similar to on process).
+                const error = getUnknownMessageTypeError(opContents.type, "applyStashedOp" /* codePath */);
+                this.closeFn(error);
+                throw error;
             }
         }
     }
@@ -1529,9 +1524,12 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         // or something different, like a system message.
         const hasModernRuntimeMessageEnvelope = messageCopy.type === internal_3.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.
-        (0, index_js_3.ensureContentsDeserialized)(messageCopy, hasModernRuntimeMessageEnvelope, logLegacyCase);
+        const logLegacyCase = (0, exports.getSingleUseLegacyLogCallback)(this.logger, messageCopy.type);
+        let runtimeBatch = hasModernRuntimeMessageEnvelope || isUnpackedRuntimeMessage(messageCopy);
+        if (runtimeBatch) {
+            // We expect runtime messages to have JSON contents - deserialize it in place.
+            (0, index_js_3.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
@@ -1560,7 +1558,6 @@ class ContainerRuntime extends client_utils_1.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.
@@ -1599,8 +1596,17 @@ class ContainerRuntime extends client_utils_1.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 !== internal_3.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
@@ -1729,23 +1735,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 this.documentsSchemaController.processDocumentSchemaOp(message.contents, local, message.sequenceNumber);
                 break;
             default: {
-                const compatBehavior = message.compatDetails?.behavior;
-                if (!compatBehaviorAllowsMessageType(message.type, compatBehavior)) {
-                    const error = internal_7.DataProcessingError.create(
-                    // Former assert 0x3ce
-                    "Runtime message of unknown type", "OpProcessing", message, {
-                        local,
-                        messageDetails: JSON.stringify({
-                            type: message.type,
-                            contentType: typeof message.contents,
-                            compatBehavior,
-                            batch: message.metadata?.batch,
-                            compression: message.compression,
-                        }),
-                    });
-                    this.closeFn(error);
-                    throw error;
-                }
+                const error = getUnknownMessageTypeError(message.type, "validateAndProcessRuntimeMessage" /* codePath */, message);
+                this.closeFn(error);
+                throw error;
             }
         }
         this.emit("op", message, true /* runtimeMessage */);
@@ -2661,7 +2653,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                     contents: idRange,
                 };
                 const idAllocationBatchMessage = {
-                    contents: JSON.stringify(idAllocationMessage),
+                    contents: (0, index_js_3.serializeOpContents)(idAllocationMessage),
                     referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
                 };
                 this.outbox.submitIdAllocation(idAllocationBatchMessage);
@@ -2704,12 +2696,12 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                     contents: schemaChangeMessage,
                 };
                 this.outbox.submit({
-                    contents: JSON.stringify(msg),
+                    contents: (0, index_js_3.serializeOpContents)(msg),
                     referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
                 });
             }
             const message = {
-                contents: JSON.stringify(containerRuntimeMessage) /* serialized content */,
+                contents: (0, index_js_3.serializeOpContents)(containerRuntimeMessage),
                 metadata,
                 localOpMetadata,
                 referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
@@ -2853,26 +2845,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 // send any ops, as some other client already changed schema.
                 break;
             default: {
-                // This case should be very rare - it would imply an op was stashed from a
-                // future version of runtime code and now is being applied on an older version.
-                const compatBehavior = message.compatDetails?.behavior;
-                if (compatBehaviorAllowsMessageType(message.type, compatBehavior)) {
-                    // We do not ultimately resubmit it, to be consistent with this version of the code.
-                    this.logger.sendTelemetryEvent({
-                        eventName: "resubmitUnrecognizedMessageTypeAllowed",
-                        messageDetails: { type: message.type, compatBehavior },
-                    });
-                }
-                else {
-                    const error = internal_7.DataProcessingError.create("Resubmitting runtime message of unexpected type", "reSubmitCore", undefined /* sequencedMessage */, {
-                        messageDetails: JSON.stringify({
-                            type: message.type,
-                            compatBehavior,
-                        }),
-                    });
-                    this.closeFn(error);
-                    throw error;
-                }
+                const error = getUnknownMessageTypeError(message.type, "reSubmitCore" /* codePath */);
+                this.closeFn(error);
+                throw error;
             }
         }
     }