@fluidframework/container-runtime 2.10.0 → 2.11.0

package/src/messageTypes.ts

@@ -58,29 +58,6 @@ export enum ContainerMessageType {
 	GC = "GC",
 }
 
-/**
- * How should an older client handle an unrecognized remote op type?
- *
- * @deprecated The utility of a mechanism to handle unknown messages is outweighed by the nuance required to get it right.
- * @internal
- */
-export type CompatModeBehavior =
-	/** Ignore the op. It won't be persisted if this client summarizes */
-	| "Ignore"
-	/** Fail processing immediately. (The container will close) */
-	| "FailToProcess";
-
-/**
- * All the info an older client would need to know how to handle an unrecognized remote op type
- *
- * @deprecated The utility of a mechanism to handle unknown messages is outweighed by the nuance required to get it right.
- * @internal
- */
-export interface IContainerRuntimeMessageCompatDetails {
-	/** How should an older client handle an unrecognized remote op type? */
-	behavior: CompatModeBehavior;
-}
-
 /**
  * The unpacked runtime message / details to be handled or dispatched by the ContainerRuntime.
  * Message type are differentiated via a `type` string and contain different contents depending on their type.
@@ -88,27 +65,11 @@ export interface IContainerRuntimeMessageCompatDetails {
  * IMPORTANT: when creating one to be serialized, set the properties in the order they appear here.
  * This way stringified values can be compared.
  */
-type TypedContainerRuntimeMessage<
-	TType extends ContainerMessageType,
-	TContents,
-	TUSedCompatDetails extends boolean = false,
-> = {
+interface TypedContainerRuntimeMessage<TType extends ContainerMessageType, TContents> {
 	/** Type of the op, within the ContainerRuntime's domain */
 	type: TType;
 	/** Domain-specific contents, interpreted according to the type */
 	contents: TContents;
-} & (TUSedCompatDetails extends true
-	? Partial<RecentlyAddedContainerRuntimeMessageDetails>
-	: { compatDetails?: undefined });
-
-/**
- * Additional details expected for any recently added message.
- * @deprecated The utility of a mechanism to handle unknown messages is outweighed by the nuance required to get it right.
- * @internal
- */
-export interface RecentlyAddedContainerRuntimeMessageDetails {
-	/** Info describing how to handle this op in case the type is unrecognized (default: fail to process) */
-	compatDetails: IContainerRuntimeMessageCompatDetails;
 }
 
 export type ContainerRuntimeDataStoreOpMessage = TypedContainerRuntimeMessage<
@@ -145,8 +106,7 @@ export type ContainerRuntimeIdAllocationMessage = TypedContainerRuntimeMessage<
 >;
 export type ContainerRuntimeGCMessage = TypedContainerRuntimeMessage<
 	ContainerMessageType.GC,
-	GarbageCollectionMessage,
-	true // TUsedCompatDetails
+	GarbageCollectionMessage
 >;
 export type ContainerRuntimeDocumentSchemaMessage = TypedContainerRuntimeMessage<
 	ContainerMessageType.DocumentSchemaChange,
@@ -157,8 +117,7 @@ export type ContainerRuntimeDocumentSchemaMessage = TypedContainerRuntimeMessage
  * Represents an unrecognized TypedContainerRuntimeMessage, e.g. a message from a future version of the container runtime.
  * @internal
  */
-export interface UnknownContainerRuntimeMessage
-	extends Partial<RecentlyAddedContainerRuntimeMessageDetails> {
+export interface UnknownContainerRuntimeMessage {
 	/** Invalid type of the op, within the ContainerRuntime's domain. This value should never exist at runtime.
 	 * This is useful for type narrowing but should never be used as an actual message type at runtime.
 	 * Actual value will not be "__unknown...", but the type `Exclude<string, ContainerMessageType>` is not supported.
@@ -222,9 +181,3 @@ export type InboundSequencedContainerRuntimeMessage = Omit<
 	"type" | "contents"
 > &
 	InboundContainerRuntimeMessage;
-
-/** A [loose] InboundSequencedContainerRuntimeMessage that is recent and may contain compat details.
- * It exists solely to to provide access to those details.
- */
-export type InboundSequencedRecentlyAddedContainerRuntimeMessage = ISequencedDocumentMessage &
-	Partial<RecentlyAddedContainerRuntimeMessageDetails>;

package/src/opLifecycle/remoteMessageProcessor.ts

@@ -13,7 +13,6 @@ import {
 	ContainerMessageType,
 	type InboundContainerRuntimeMessage,
 	type InboundSequencedContainerRuntimeMessage,
-	type InboundSequencedRecentlyAddedContainerRuntimeMessage,
 } from "../messageTypes.js";
 import { asBatchMetadata } from "../metadata.js";
 
@@ -259,7 +258,7 @@ export function ensureContentsDeserialized(mutableMessage: ISequencedDocumentMes
  *
  * The return type illustrates the assumption that the message param
  * becomes a InboundSequencedContainerRuntimeMessage by the time the function returns
- * (but there is no runtime validation of the 'type' or 'compatDetails' values).
+ * (but there is no runtime validation of the 'type').
  */
 function unpack(message: ISequencedDocumentMessage): InboundSequencedContainerRuntimeMessage {
 	// We assume the contents is an InboundContainerRuntimeMessage (the message is "packed")
@@ -270,10 +269,6 @@ function unpack(message: ISequencedDocumentMessage): InboundSequencedContainerRu
 
 	messageUnpacked.type = contents.type;
 	messageUnpacked.contents = contents.contents;
-	if ("compatDetails" in contents) {
-		(messageUnpacked as InboundSequencedRecentlyAddedContainerRuntimeMessage).compatDetails =
-			contents.compatDetails;
-	}
 	return messageUnpacked;
 }
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.10.0";
+export const pkgVersion = "2.11.0";

package/src/pendingStateManager.ts

@@ -105,9 +105,9 @@ function isEmptyBatchPendingMessage(message: IPendingMessageFromStash): boolean
 function buildPendingMessageContent(message: InboundSequencedContainerRuntimeMessage): string {
 	// IMPORTANT: Order matters here, this must match the order of the properties used
 	// when submitting the message.
-	const { type, contents, compatDetails }: InboundContainerRuntimeMessage = message;
+	const { type, contents }: InboundContainerRuntimeMessage = message;
 	// Any properties that are not defined, won't be emitted by stringify.
-	return JSON.stringify({ type, contents, compatDetails });
+	return JSON.stringify({ type, contents });
 }
 
 function typesOfKeys<T extends object>(obj: T): Record<keyof T, string> {
@@ -126,7 +126,6 @@ function scrubAndStringify(
 	// For these known/expected keys, we can either drill in (for contents)
 	// or just use the value as-is (since it's not personal info)
 	scrubbed.contents = message.contents && typesOfKeys(message.contents);
-	scrubbed.compatDetails = message.compatDetails;
 	scrubbed.type = message.type;
 
 	return JSON.stringify(scrubbed);