Remove deprecated inbound and outbound queues on IDeltaManager (#22282)

## Description [AB#7202](https://dev.azure.com/fluidframework/internal/_workitems/edit/7202) 1.) Remove deprecated inbound and outbound queues on IDeltaManager. 2.) Move them to IDeltaManagerFull so that internal Fluid layers can still use it but not the apps. --------- Co-authored-by: Jatin Garg <jatingarg@Jatins-MacBook-Pro-2.local> Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com> Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
microsoft · Nov 7, 2024 · 45a5769 · 45a5769
1 parent 713f4e1
commit 45a5769
Show file tree

Hide file tree

Showing 53 changed files with 416 additions and 159 deletions.
diff --git a/.changeset/nice-flies-brake.md b/.changeset/nice-flies-brake.md
@@ -0,0 +1,25 @@
+---
+"@fluidframework/aqueduct": minor
+"@fluidframework/container-definitions": minor
+"@fluidframework/container-loader": minor
+"@fluidframework/container-runtime": minor
+"@fluidframework/container-runtime-definitions": minor
+"@fluidframework/datastore": minor
+"@fluidframework/devtools-core": minor
+"@fluidframework/fluid-static": minor
+"@fluidframework/runtime-definitions": minor
+"@fluidframework/runtime-utils": minor
+"@fluid-private/test-end-to-end-tests": minor
+"@fluidframework/test-runtime-utils": minor
+"@fluidframework/test-utils": minor
+---
+---
+"section": legacy
+---
+
+The inbound and outbound properties have been removed from IDeltaManager
+
+The inbound and outbound properties were deprecated in a previous release and have been removed from IDeltaManager. Please check pull request [#19636](https://github.com/microsoft/FluidFramework/pull/19636) for alternative APIs.
+
+This is the link to the [Release Notes](https://github.com/microsoft/FluidFramework/blob/main/RELEASE_NOTES/2.0.0-rc.2.0.0.md#container-definitions-deprecate-ideltamanagerinbound-and-ideltamanageroutbound)
+which contains more instructions on the alternatives.
diff --git a/...mmon/container-definitions/api-report/container-definitions.legacy.alpha.api.md b/...mmon/container-definitions/api-report/container-definitions.legacy.alpha.api.md
@@ -204,17 +204,13 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
     readonly active: boolean;
     readonly clientDetails: IClientDetails;
     readonly hasCheckpointSequenceNumber: boolean;
-    // @deprecated
-    readonly inbound: IDeltaQueue<T>;
     readonly inboundSignal: IDeltaQueue<ISignalMessage>;
     readonly initialSequenceNumber: number;
     readonly lastKnownSeqNumber: number;
     readonly lastMessage: ISequencedDocumentMessage | undefined;
     readonly lastSequenceNumber: number;
     readonly maxMessageSize: number;
     readonly minimumSequenceNumber: number;
-    // @deprecated
-    readonly outbound: IDeltaQueue<U[]>;
     // (undocumented)
     readonly readOnlyInfo: ReadOnlyInfo;
     readonly serviceConfiguration: IClientConfiguration | undefined;

diff --git a/packages/common/container-definitions/package.json b/packages/common/container-definitions/package.json
@@ -114,7 +114,17 @@
 		"typescript": "~5.4.5"
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"Interface_IContainer": {
+				"backCompat": false
+			},
+			"Interface_IContainerContext": {
+				"backCompat": false
+			},
+			"Interface_IDeltaManager": {
+				"backCompat": false
+			}
+		},
 		"entrypoint": "legacy"
 	}
 }
diff --git a/packages/common/container-definitions/src/deltas.ts b/packages/common/container-definitions/src/deltas.ts
@@ -156,20 +156,6 @@ export interface IDeltaManagerEvents extends IEvent {
 export interface IDeltaManager<T, U>
 	extends IEventProvider<IDeltaManagerEvents>,
 		IDeltaSender {
-	/**
-	 * The queue of inbound delta messages
-	 * @deprecated Do not use, for internal use only. There are a lot of complications in core pieces of the runtime
-	 * may break if this is used directly. For example summarization and op processing.
-	 */
-	readonly inbound: IDeltaQueue<T>;
-
-	/**
-	 * The queue of outbound delta messages
-	 * @deprecated Do not use, for internal use only. There are a lot of complications in core pieces of the runtime
-	 * may break if this is used directly. For example op submission
-	 */
-	readonly outbound: IDeltaQueue<U[]>;
-
 	/**
 	 * The queue of inbound delta signals
 	 */
@@ -241,6 +227,33 @@ export interface IDeltaManager<T, U>
 	submitSignal(content: any, targetClientId?: string): void;
 }
 
+/**
+ * DeltaManager which is used internally by the Fluid layers and not exposed to the end users.
+ * @internal
+ */
+export interface IDeltaManagerFull<T = ISequencedDocumentMessage, U = IDocumentMessage>
+	extends IDeltaManager<T, U> {
+	/**
+	 * The queue of inbound delta messages
+	 */
+	readonly inbound: IDeltaQueue<T>;
+
+	/**
+	 * The queue of outbound delta messages
+	 */
+	readonly outbound: IDeltaQueue<U[]>;
+}
+
+/**
+ * Type guard to check if the given deltaManager is of type {@link @fluidframework/container-definitions#IDeltaManagerFull}.
+ * @internal
+ */
+export function isIDeltaManagerFull(
+	deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
+): deltaManager is IDeltaManagerFull {
+	return "inbound" in deltaManager && "outbound" in deltaManager;
+}
+
 /**
  * Events emitted by {@link IDeltaQueue}.
  * @sealed

diff --git a/packages/common/container-definitions/src/index.ts b/packages/common/container-definitions/src/index.ts
@@ -19,11 +19,13 @@ export type {
 	IConnectionDetails,
 	IDeltaManager,
 	IDeltaManagerEvents,
+	IDeltaManagerFull,
 	IDeltaQueue,
 	IDeltaQueueEvents,
 	IDeltaSender,
 	ReadOnlyInfo,
 } from "./deltas.js";
+export { isIDeltaManagerFull } from "./deltas.js";
 export type { ContainerWarning, ICriticalContainerError } from "./error.js";
 export { ContainerErrorTypes } from "./error.js";
 export type {

diff --git a/...on/container-definitions/src/test/types/validateContainerDefinitionsPrevious.generated.ts b/...on/container-definitions/src/test/types/validateContainerDefinitionsPrevious.generated.ts
@@ -193,6 +193,7 @@ declare type old_as_current_for_Interface_IContainer = requireAssignableTo<TypeO
  * typeValidation.broken:
  * "Interface_IContainer": {"backCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type current_as_old_for_Interface_IContainer = requireAssignableTo<TypeOnly<current.IContainer>, TypeOnly<old.IContainer>>
 
 /*
@@ -211,6 +212,7 @@ declare type old_as_current_for_Interface_IContainerContext = requireAssignableT
  * typeValidation.broken:
  * "Interface_IContainerContext": {"backCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type current_as_old_for_Interface_IContainerContext = requireAssignableTo<TypeOnly<current.IContainerContext>, TypeOnly<old.IContainerContext>>
 
 /*
@@ -256,6 +258,7 @@ declare type current_as_old_for_Interface_IContainerLoadMode = requireAssignable
  * typeValidation.broken:
  * "Interface_IDeltaManager": {"backCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type current_as_old_for_Interface_IDeltaManager = requireAssignableTo<TypeOnly<current.IDeltaManager<any,any>>, TypeOnly<old.IDeltaManager<any,any>>>
 
 /*

diff --git a/packages/framework/aqueduct/package.json b/packages/framework/aqueduct/package.json
@@ -156,7 +156,11 @@
 		"typescript": "~5.4.5"
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"Interface_IDataObjectProps": {
+				"backCompat": false
+			}
+		},
 		"entrypoint": "legacy"
 	}
 }
diff --git a/packages/framework/aqueduct/src/test/types/validateAqueductPrevious.generated.ts b/packages/framework/aqueduct/src/test/types/validateAqueductPrevious.generated.ts
@@ -247,4 +247,5 @@ declare type old_as_current_for_Interface_IDataObjectProps = requireAssignableTo
  * typeValidation.broken:
  * "Interface_IDataObjectProps": {"backCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type current_as_old_for_Interface_IDataObjectProps = requireAssignableTo<TypeOnly<current.IDataObjectProps>, TypeOnly<old.IDataObjectProps>>
diff --git a/packages/framework/fluid-static/package.json b/packages/framework/fluid-static/package.json
@@ -140,7 +140,11 @@
 		"typescript": "~5.4.5"
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"Interface_IFluidContainerInternal": {
+				"backCompat": false
+			}
+		},
 		"entrypoint": "public"
 	}
 }
diff --git a/packages/loader/container-loader/package.json b/packages/loader/container-loader/package.json
@@ -216,7 +216,11 @@
 		"typescript": "~5.4.5"
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"Interface_IContainerExperimental": {
+				"backCompat": false
+			}
+		},
 		"entrypoint": "legacy"
 	}
 }
diff --git a/packages/loader/container-loader/src/container.ts b/packages/loader/container-loader/src/container.ts
@@ -1319,7 +1319,7 @@ export class Container
 					) => {
 						try {
 							assert(
-								this.deltaManager.inbound.length === 0,
+								this._deltaManager.inbound.length === 0,
 								0x0d6 /* "Inbound queue should be empty when attaching" */,
 							);
 							return combineAppAndProtocolSummary(
@@ -1523,13 +1523,13 @@ export class Container
 		const codeDetails = this.getCodeDetailsFromQuorum();
 
 		await Promise.all([
-			this.deltaManager.inbound.pause(),
-			this.deltaManager.inboundSignal.pause(),
+			this._deltaManager.inbound.pause(),
+			this._deltaManager.inboundSignal.pause(),
 		]);
 
 		if ((await this.satisfies(codeDetails)) === true) {
-			this.deltaManager.inbound.resume();
-			this.deltaManager.inboundSignal.resume();
+			this._deltaManager.inbound.resume();
+			this._deltaManager.inboundSignal.resume();
 			return;
 		}
 

diff --git a/packages/loader/container-loader/src/deltaManager.ts b/packages/loader/container-loader/src/deltaManager.ts
@@ -5,8 +5,8 @@
 
 import { ICriticalContainerError } from "@fluidframework/container-definitions";
 import {
-	IDeltaManager,
 	IDeltaManagerEvents,
+	IDeltaManagerFull,
 	IDeltaQueue,
 	type IDeltaSender,
 	type ReadOnlyInfo,
@@ -151,9 +151,7 @@ function logIfFalse(
  */
 export class DeltaManager<TConnectionManager extends IConnectionManager>
 	extends EventEmitterWithErrorHandling<IDeltaManagerInternalEvents>
-	implements
-		IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
-		IEventProvider<IDeltaManagerInternalEvents>
+	implements IDeltaManagerFull, IEventProvider<IDeltaManagerInternalEvents>
 {
 	public readonly connectionManager: TConnectionManager;
 

diff --git a/packages/loader/container-loader/src/index.ts b/packages/loader/container-loader/src/index.ts
@@ -20,7 +20,10 @@ export {
 	resolveWithLocationRedirectionHandling,
 } from "./location-redirection-utilities/index.js";
 export { IProtocolHandler, ProtocolHandlerBuilder } from "./protocol.js";
-export { tryParseCompatibleResolvedUrl, IParsedUrl } from "./utils.js";
+export {
+	tryParseCompatibleResolvedUrl,
+	IParsedUrl,
+} from "./utils.js";
 export {
 	IBaseProtocolHandler,
 	IScribeProtocolState,

diff --git a/packages/loader/container-loader/src/loadPaused.ts b/packages/loader/container-loader/src/loadPaused.ts
@@ -5,11 +5,13 @@
 
 import {
 	ILoader,
+	isIDeltaManagerFull,
 	LoaderHeader,
 	type IContainer,
 } from "@fluidframework/container-definitions/internal";
 import { IRequest } from "@fluidframework/core-interfaces";
 import type { IErrorBase } from "@fluidframework/core-interfaces";
+import { assert } from "@fluidframework/core-utils/internal";
 import { GenericError } from "@fluidframework/telemetry-utils/internal";
 
 /* eslint-disable jsdoc/check-indentation */
@@ -63,6 +65,7 @@ export async function loadContainerPaused(
 	const lastProcessedSequenceNumber = dm.initialSequenceNumber;
 
 	const pauseContainer = (): void => {
+		assert(isIDeltaManagerFull(dm), "Delta manager does not have inbound/outbound queues.");
 		// eslint-disable-next-line no-void
 		void dm.inbound.pause();
 		// eslint-disable-next-line no-void

diff --git a/packages/runtime/container-runtime-definitions/package.json b/packages/runtime/container-runtime-definitions/package.json
@@ -103,7 +103,14 @@
 		"typescript": "~5.4.5"
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"Interface_IContainerRuntime": {
+				"backCompat": false
+			},
+			"Interface_IContainerRuntimeWithResolveHandle_Deprecated": {
+				"backCompat": false
+			}
+		},
 		"entrypoint": "legacy"
 	}
 }
diff --git a/...ntime-definitions/src/test/types/validateContainerRuntimeDefinitionsPrevious.generated.ts b/...ntime-definitions/src/test/types/validateContainerRuntimeDefinitionsPrevious.generated.ts
@@ -22,6 +22,7 @@ declare type MakeUnusedImportErrorsGoAway<T> = TypeOnly<T> | MinimalType<T> | Fu
  * typeValidation.broken:
  * "Interface_IContainerRuntime": {"backCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type current_as_old_for_Interface_IContainerRuntime = requireAssignableTo<TypeOnly<current.IContainerRuntime>, TypeOnly<old.IContainerRuntime>>
 
 /*
@@ -49,6 +50,7 @@ declare type old_as_current_for_Interface_IContainerRuntimeWithResolveHandle_Dep
  * typeValidation.broken:
  * "Interface_IContainerRuntimeWithResolveHandle_Deprecated": {"backCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type current_as_old_for_Interface_IContainerRuntimeWithResolveHandle_Deprecated = requireAssignableTo<TypeOnly<current.IContainerRuntimeWithResolveHandle_Deprecated>, TypeOnly<old.IContainerRuntimeWithResolveHandle_Deprecated>>
 
 /*

diff --git a/...ages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md b/...ages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md
@@ -67,7 +67,7 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents
     // (undocumented)
     deleteChildSummarizerNode(id: string): void;
     deleteSweepReadyNodes(sweepReadyRoutes: readonly string[]): readonly string[];
-    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+    get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
     // (undocumented)
     dispose(error?: Error): void;
     // (undocumented)

diff --git a/packages/runtime/container-runtime/package.json b/packages/runtime/container-runtime/package.json
@@ -231,7 +231,59 @@
 		"typescript": "~5.4.5"
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"Class_LocalFluidDataStoreContext": {
+				"backCompat": false
+			},
+			"ClassStatics_LocalFluidDataStoreContext": {
+				"backCompat": false
+			},
+			"Class_LocalFluidDataStoreContextBase": {
+				"backCompat": false
+			},
+			"ClassStatics_LocalFluidDataStoreContextBase": {
+				"backCompat": false
+			},
+			"Class_ChannelCollection": {
+				"backCompat": false
+			},
+			"ClassStatics_ChannelCollection": {
+				"backCompat": false
+			},
+			"Class_ContainerRuntime": {
+				"backCompat": false
+			},
+			"Class_DocumentsSchemaController": {
+				"forwardCompat": false
+			},
+			"ClassStatics_ContainerRuntime": {
+				"backCompat": false
+			},
+			"Class_FluidDataStoreContext": {
+				"backCompat": false
+			},
+			"ClassStatics_FluidDataStoreContext": {
+				"backCompat": false
+			},
+			"Interface_ISummarizerRuntime": {
+				"backCompat": false
+			},
+			"Interface_ILocalFluidDataStoreContextProps": {
+				"backCompat": false
+			},
+			"Interface_IFluidDataStoreContextInternal": {
+				"backCompat": false
+			},
+			"Interface_IFluidDataStoreContextProps": {
+				"backCompat": false
+			},
+			"Interface_ILocalDetachedFluidDataStoreContextProps": {
+				"backCompat": false
+			},
+			"Interface_LoadContainerRuntimeParams": {
+				"backCompat": false
+			}
+		},
 		"entrypoint": "legacy"
 	}
 }