@fluidframework/container-loader 2.51.0 → 2.53.0-350190

package/src/containerContext.ts

@@ -18,12 +18,12 @@ import {
 	ILoader,
 	ILoaderOptions,
 	IDeltaManager,
+	type IContainerStorageService,
 } from "@fluidframework/container-definitions/internal";
 import { type FluidObject } from "@fluidframework/core-interfaces";
 import { type ISignalEnvelope } from "@fluidframework/core-interfaces/internal";
 import { IClientDetails, IQuorumClients } from "@fluidframework/driver-definitions";
 import {
-	IDocumentStorageService,
 	ISnapshot,
 	IDocumentMessage,
 	ISnapshotTree,
@@ -34,8 +34,53 @@ import {
 } from "@fluidframework/driver-definitions/internal";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
+import type { ConnectionState } from "./connectionState.js";
 import { loaderCompatDetailsForRuntime } from "./loaderLayerCompatState.js";
 
+/**
+ * Configuration object for ContainerContext constructor.
+ */
+export interface IContainerContextConfig {
+	readonly options: ILoaderOptions;
+	readonly scope: FluidObject;
+	readonly baseSnapshot: ISnapshotTree | undefined;
+	readonly version: IVersion | undefined;
+	readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+	readonly storage: IContainerStorageService;
+	readonly quorum: IQuorumClients;
+	readonly audience: IAudience;
+	readonly loader: ILoader;
+	readonly submitFn: (
+		type: MessageType,
+		contents: unknown,
+		batch: boolean,
+		appData: unknown,
+	) => number;
+	readonly submitSummaryFn: (
+		summaryOp: ISummaryContent,
+		referenceSequenceNumber?: number,
+	) => number;
+	readonly submitBatchFn: (batch: IBatchMessage[], referenceSequenceNumber?: number) => number;
+	readonly submitSignalFn: (
+		content: unknown | ISignalEnvelope,
+		targetClientId?: string,
+	) => void;
+	readonly disposeFn: (error?: ICriticalContainerError) => void;
+	readonly closeFn: (error?: ICriticalContainerError) => void;
+	readonly updateDirtyContainerState: (dirty: boolean) => void;
+	readonly getAbsoluteUrl: (relativeUrl: string) => Promise<string | undefined>;
+	readonly getContainerDiagnosticId: () => string | undefined;
+	readonly getClientId: () => string | undefined;
+	readonly getAttachState: () => AttachState;
+	readonly getConnected: () => boolean;
+	readonly getConnectionState: () => ConnectionState;
+	readonly clientDetails: IClientDetails;
+	readonly existing: boolean;
+	readonly taggedLogger: ITelemetryLoggerExt;
+	readonly pendingLocalState?: unknown;
+	readonly snapshotWithContents?: ISnapshot;
+}
+
 /**
  * {@inheritDoc @fluidframework/container-definitions#IContainerContext}
  */
@@ -52,6 +97,58 @@ export class ContainerContext implements IContainerContext, IProvideLayerCompatD
 		["referenceSequenceNumbers", true],
 	]);
 
+	public readonly options: ILoaderOptions;
+	public readonly scope: FluidObject;
+	public readonly baseSnapshot: ISnapshotTree | undefined;
+	public readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+	public readonly storage: IContainerStorageService;
+	public readonly quorum: IQuorumClients;
+	public readonly audience: IAudience;
+	public readonly loader: ILoader;
+	public readonly submitFn: (
+		type: MessageType,
+		contents: unknown,
+		batch: boolean,
+		appData: unknown,
+	) => number;
+	public readonly submitSummaryFn: (
+		summaryOp: ISummaryContent,
+		referenceSequenceNumber?: number,
+	) => number;
+	/**
+	 * @returns clientSequenceNumber of last message in a batch
+	 */
+	public readonly submitBatchFn: (
+		batch: IBatchMessage[],
+		referenceSequenceNumber?: number,
+	) => number;
+	/**
+	 * `unknown` should be removed once `@alpha` tag is removed from IContainerContext
+	 * @see {@link https://dev.azure.com/fluidframework/internal/_workitems/edit/7462}
+	 * Any changes to submitSignalFn `content` should be checked internally by temporarily changing IContainerContext and removing all `unknown`s
+	 */
+	public readonly submitSignalFn: (
+		content: unknown | ISignalEnvelope,
+		targetClientId?: string,
+	) => void;
+	public readonly disposeFn: (error?: ICriticalContainerError) => void;
+	public readonly closeFn: (error?: ICriticalContainerError) => void;
+	public readonly updateDirtyContainerState: (dirty: boolean) => void;
+	public readonly getAbsoluteUrl: (relativeUrl: string) => Promise<string | undefined>;
+	public readonly clientDetails: IClientDetails;
+	public readonly existing: boolean;
+	public readonly taggedLogger: ITelemetryLoggerExt;
+	public readonly pendingLocalState: unknown;
+	public readonly snapshotWithContents: ISnapshot | undefined;
+
+	public readonly getConnectionState: () => ConnectionState;
+
+	private readonly _getClientId: () => string | undefined;
+	private readonly _getContainerDiagnosticId: () => string | undefined;
+	private readonly _getConnected: () => boolean;
+	private readonly _getAttachState: () => AttachState;
+	private readonly version: IVersion | undefined;
+
 	public get clientId(): string | undefined {
 		return this._getClientId();
 	}
@@ -79,60 +176,39 @@ export class ContainerContext implements IContainerContext, IProvideLayerCompatD
 		return loaderCompatDetailsForRuntime;
 	}
 
-	constructor(
-		public readonly options: ILoaderOptions,
-		public readonly scope: FluidObject,
-		public readonly baseSnapshot: ISnapshotTree | undefined,
-		private readonly _version: IVersion | undefined,
-		public readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
-		public readonly storage: IDocumentStorageService,
-		public readonly quorum: IQuorumClients,
-		public readonly audience: IAudience,
-		public readonly loader: ILoader,
-		public readonly submitFn: (
-			type: MessageType,
-			contents: unknown,
-			batch: boolean,
-			appData: unknown,
-		) => number,
-		public readonly submitSummaryFn: (
-			summaryOp: ISummaryContent,
-			referenceSequenceNumber?: number,
-		) => number,
-		/**
-		 * @returns clientSequenceNumber of last message in a batch
-		 */
-		public readonly submitBatchFn: (
-			batch: IBatchMessage[],
-			referenceSequenceNumber?: number,
-		) => number,
+	constructor(config: IContainerContextConfig) {
+		this.options = config.options;
+		this.scope = config.scope;
+		this.baseSnapshot = config.baseSnapshot;
+		this.deltaManager = config.deltaManager;
+		this.storage = config.storage;
+		this.quorum = config.quorum;
+		this.audience = config.audience;
+		this.loader = config.loader;
+		this.submitFn = config.submitFn;
+		this.submitSummaryFn = config.submitSummaryFn;
+		this.submitBatchFn = config.submitBatchFn;
+		this.submitSignalFn = config.submitSignalFn;
+		this.disposeFn = config.disposeFn;
+		this.closeFn = config.closeFn;
+		this.updateDirtyContainerState = config.updateDirtyContainerState;
+		this.getAbsoluteUrl = config.getAbsoluteUrl;
+		this.clientDetails = config.clientDetails;
+		this.existing = config.existing;
+		this.taggedLogger = config.taggedLogger;
+		this.pendingLocalState = config.pendingLocalState;
+		this.snapshotWithContents = config.snapshotWithContents;
 
-		/**
-		 * `unknown` should be removed once `@alpha` tag is removed from IContainerContext
-		 * @see {@link https://dev.azure.com/fluidframework/internal/_workitems/edit/7462}
-		 * Any changes to submitSignalFn `content` should be checked internally by temporarily changing IContainerContext and removing all `unknown`s
-		 */
-		public readonly submitSignalFn: (
-			content: unknown | ISignalEnvelope,
-			targetClientId?: string,
-		) => void,
-		public readonly disposeFn: (error?: ICriticalContainerError) => void,
-		public readonly closeFn: (error?: ICriticalContainerError) => void,
-		public readonly updateDirtyContainerState: (dirty: boolean) => void,
-		public readonly getAbsoluteUrl: (relativeUrl: string) => Promise<string | undefined>,
-		private readonly _getContainerDiagnosticId: () => string | undefined,
-		private readonly _getClientId: () => string | undefined,
-		private readonly _getAttachState: () => AttachState,
-		private readonly _getConnected: () => boolean,
-		public readonly clientDetails: IClientDetails,
-		public readonly existing: boolean,
-		public readonly taggedLogger: ITelemetryLoggerExt,
-		public readonly pendingLocalState?: unknown,
-		public readonly snapshotWithContents?: ISnapshot,
-	) {}
+		this.getConnectionState = config.getConnectionState;
+		this._getClientId = config.getClientId;
+		this._getContainerDiagnosticId = config.getContainerDiagnosticId;
+		this._getConnected = config.getConnected;
+		this._getAttachState = config.getAttachState;
+		this.version = config.version;
+	}
 
 	public getLoadedFromVersion(): IVersion | undefined {
-		return this._version;
+		return this.version;
 	}
 
 	public get attachState(): AttachState {

package/src/containerStorageAdapter.ts

@@ -4,7 +4,10 @@
  */
 
 import { bufferToString, stringToBuffer } from "@fluid-internal/client-utils";
-import { ISnapshotTreeWithBlobContents } from "@fluidframework/container-definitions/internal";
+import {
+	ISnapshotTreeWithBlobContents,
+	type IContainerStorageService,
+} from "@fluidframework/container-definitions/internal";
 import { IDisposable } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
 import { ISummaryHandle, ISummaryTree } from "@fluidframework/driver-definitions";
@@ -47,7 +50,7 @@ export interface ISerializableBlobContents {
 export class ContainerStorageAdapter
 	implements
 		ISerializedStateManagerDocumentStorageService,
-		IDocumentStorageService,
+		IContainerStorageService,
 		IDisposable
 {
 	private _storageService: IDocumentStorageService & Partial<IDisposable>;
@@ -159,6 +162,10 @@ export class ContainerStorageAdapter
 		return undefined;
 	}
 
+	public get maximumCacheDurationMs(): IDocumentStorageServicePolicies["maximumCacheDurationMs"] {
+		return this.policies?.maximumCacheDurationMs;
+	}
+
 	public async getSnapshotTree(
 		version?: IVersion,
 		scenarioName?: string,
@@ -241,13 +248,19 @@ export class ContainerStorageAdapter
 		return this._storageService.uploadSummaryWithContext(summary, context);
 	}
 
-	public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {
-		return this._storageService.downloadSummary(handle);
-	}
-
 	public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {
 		return this._storageService.createBlob(file);
 	}
+
+	/**
+	 * {@link IRuntimeStorageService.downloadSummary}.
+	 *
+	 * @deprecated - This API is deprecated and will be removed in a future release. No replacement is planned as
+	 * it is unused in the Runtime and below layers.
+	 */
+	public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {
+		return this._storageService.downloadSummary(handle);
+	}
 }
 
 /**

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.51.0";
+export const pkgVersion = "2.53.0-350190";

package/src/serializedStateManager.ts

@@ -4,10 +4,7 @@
  */
 
 import { stringToBuffer } from "@fluid-internal/client-utils";
-import {
-	IGetPendingLocalStateProps,
-	IRuntime,
-} from "@fluidframework/container-definitions/internal";
+import { IRuntime } from "@fluidframework/container-definitions/internal";
 import type {
 	IEventProvider,
 	IEvent,
@@ -422,7 +419,6 @@ export class SerializedStateManager {
 	 * to be stored and used to rehydrate the container at a later time.
 	 */
 	public async getPendingLocalState(
-		props: IGetPendingLocalStateProps,
 		clientId: string | undefined,
 		runtime: Pick<IRuntime, "getPendingLocalState">,
 		resolvedUrl: IResolvedUrl,
@@ -432,9 +428,9 @@ export class SerializedStateManager {
 			{
 				eventName: "getPendingLocalState",
 				details: {
-					notifyImminentClosure: props.notifyImminentClosure,
-					sessionExpiryTimerStarted: props.sessionExpiryTimerStarted,
-					snapshotSequenceNumber: props.snapshotSequenceNumber,
+					notifyImminentClosure: false,
+					sessionExpiryTimerStarted: undefined,
+					snapshotSequenceNumber: undefined,
 					processedOpsSize: this.processedOps.length,
 				},
 				clientId,
@@ -445,7 +441,7 @@ export class SerializedStateManager {
 				}
 				assert(this.snapshot !== undefined, 0x8e5 /* no base data */);
 				const pendingRuntimeState = await runtime.getPendingLocalState({
-					...props,
+					notifyImminentClosure: false,
 					snapshotSequenceNumber: this.snapshot.snapshotSequenceNumber,
 					sessionExpiryTimerStarted: this.snapshot.snapshotFetchedTime,
 				});