@fluidframework/container-loader 2.0.2 → 2.1.0-276326

package/src/deltaQueue.ts

@@ -29,7 +29,7 @@ export class DeltaQueue<T>
 	 */
 	private pauseCount = 1;
 
-	private error: any | undefined;
+	private error: Error | undefined;
 
 	/**
 	 * When processing is ongoing, holds a deferred that will resolve once processing stops.
@@ -42,7 +42,7 @@ export class DeltaQueue<T>
 	}
 
 	/**
-	 * @returns True if the queue is paused, false if not.
+	 * Whether or not the queue is paused.
 	 */
 	public get paused(): boolean {
 		return this.pauseCount !== 0;
@@ -56,7 +56,10 @@ export class DeltaQueue<T>
 		return this.processingPromise === undefined && this.q.length === 0;
 	}
 
-	public async waitTillProcessingDone() {
+	public async waitTillProcessingDone(): Promise<{
+		count: number;
+		duration: number;
+	}> {
 		return this.processingPromise ?? { count: 0, duration: 0 };
 	}
 
@@ -67,7 +70,7 @@ export class DeltaQueue<T>
 		super();
 	}
 
-	public dispose() {
+	public dispose(): void {
 		throw new Error("Not implemented.");
 		this.isDisposed = true;
 	}
@@ -84,7 +87,7 @@ export class DeltaQueue<T>
 		return this.q.toArray();
 	}
 
-	public push(task: T) {
+	public push(task: T): void {
 		try {
 			this.q.push(task);
 			this.emit("push", task);
@@ -112,7 +115,7 @@ export class DeltaQueue<T>
 	 * accidental reentrancy. ensureProcessing can be called safely to start the processing loop if it is
 	 * not already started.
 	 */
-	private ensureProcessing() {
+	private ensureProcessing(): void {
 		if (this.anythingToProcess() && this.processingPromise === undefined) {
 			// Use a resolved promise to start the processing on a separate stack.
 			this.processingPromise = Promise.resolve()
@@ -126,7 +129,7 @@ export class DeltaQueue<T>
 					this.processingPromise = undefined;
 					return result;
 				})
-				.catch((error) => {
+				.catch((error: Error) => {
 					this.error = error;
 					this.processingPromise = undefined;
 					this.emit("error", error);
@@ -139,14 +142,17 @@ export class DeltaQueue<T>
 		}
 	}
 
-	private anythingToProcess() {
-		return this.q.length !== 0 && !this.paused && this.error === undefined;
+	private anythingToProcess(): boolean {
+		return this.q.length > 0 && !this.paused && this.error === undefined;
 	}
 
 	/**
 	 * Executes the delta processing loop until a stop condition is reached.
 	 */
-	private processDeltas() {
+	private processDeltas(): {
+		count: number;
+		duration: number;
+	} {
 		const start = performance.now();
 		let count = 0;
 

package/src/disposal.ts

@@ -13,9 +13,9 @@ import { IDisposable } from "@fluidframework/core-interfaces";
  */
 export function doIfNotDisposed<T>(
 	disposable: IDisposable,
-	f: (...args: any[]) => T,
-): (...args: any[]) => T {
-	return (...args: any[]): T => {
+	f: (...args: unknown[]) => T,
+): (...args: unknown[]) => T {
+	return (...args: unknown[]): T => {
 		if (disposable.disposed) {
 			throw new Error("Already disposed");
 		} else {

package/src/error.ts

@@ -42,7 +42,8 @@ export class ThrottlingWarning
 		retryAfterSeconds: number,
 		logger: ITelemetryLoggerExt,
 	): IThrottlingWarning {
-		const newErrorFn = (errMsg: string) => new ThrottlingWarning(errMsg, retryAfterSeconds);
+		const newErrorFn = (errMsg: string): ThrottlingWarning =>
+			new ThrottlingWarning(errMsg, retryAfterSeconds);
 		return wrapErrorAndLog(error, newErrorFn, logger);
 	}
 }

package/src/loadPaused.ts

@@ -3,7 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { ILoader, LoaderHeader } from "@fluidframework/container-definitions/internal";
+import {
+	ILoader,
+	LoaderHeader,
+	type IContainer,
+} from "@fluidframework/container-definitions/internal";
 import { IRequest } from "@fluidframework/core-interfaces";
 import type { IErrorBase } from "@fluidframework/core-interfaces";
 import { GenericError } from "@fluidframework/telemetry-utils/internal";
@@ -42,7 +46,7 @@ export async function loadContainerPaused(
 	request: IRequest,
 	loadToSequenceNumber?: number,
 	signal?: AbortSignal,
-) {
+): Promise<IContainer> {
 	const container = await loader.resolve({
 		url: request.url,
 		headers: {
@@ -58,8 +62,10 @@ export async function loadContainerPaused(
 	const dm = container.deltaManager;
 	const lastProcessedSequenceNumber = dm.initialSequenceNumber;
 
-	const pauseContainer = () => {
+	const pauseContainer = (): void => {
+		// eslint-disable-next-line no-void
 		void dm.inbound.pause();
+		// eslint-disable-next-line no-void
 		void dm.outbound.pause();
 	};
 
@@ -86,12 +92,12 @@ export async function loadContainerPaused(
 	let onAbort: () => void;
 	let onClose: (error?: IErrorBase) => void;
 
-	const promise = new Promise<void>((resolve, rejectArg) => {
-		onAbort = () => rejectArg(new GenericError("Canceled due to cancellation request."));
-		onClose = (error?: IErrorBase) => rejectArg(error);
+	const promise = new Promise<void>((resolve, reject) => {
+		onAbort = (): void => reject(new GenericError("Canceled due to cancellation request."));
+		onClose = (error?: IErrorBase): void => reject(error);
 
 		// We need to setup a listener to stop op processing once we reach the desired sequence number (if specified).
-		opHandler = () => {
+		opHandler = (): void => {
 			// If there is a specified sequence number, keep processing until we reach it.
 			if (
 				loadToSequenceNumber !== undefined &&
@@ -119,7 +125,9 @@ export async function loadContainerPaused(
 
 	// Wait for the ops to be processed.
 	await promise
-		.catch((error) => {
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		.catch((error: any) => {
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
 			container.close(error);
 			throw error;
 		})

package/src/loader.ts

@@ -68,11 +68,15 @@ export class RelativeLoader implements ILoader {
 			const container = await this.container.clone(
 				{
 					resolvedUrl: { ...this.container.resolvedUrl },
+					// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 					version: request.headers?.[LoaderHeader.version] ?? undefined,
+					// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 					loadMode: request.headers?.[LoaderHeader.loadMode],
 				},
 				{
+					// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 					canReconnect: request.headers?.[LoaderHeader.reconnect],
+					// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 					clientDetailsOverride: request.headers?.[LoaderHeader.clientDetails],
 				},
 			);
@@ -87,6 +91,7 @@ export class RelativeLoader implements ILoader {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ILoaderOptions extends ILoaderOptions1 {
@@ -98,10 +103,13 @@ export interface ILoaderOptions extends ILoaderOptions1 {
  * {@link @fluidframework/container-definitions#IFluidModuleWithDetails}
  * to have all the code loading modules in one package. #8193
  * Encapsulates a module entry point with corresponding code details.
+ * @legacy
  * @alpha
  */
 export interface IFluidModuleWithDetails {
-	/** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
+	/**
+	 * Fluid code module that implements the runtime factory needed to instantiate the container runtime.
+	 */
 	module: IFluidModule;
 	/**
 	 * Code details associated with the module. Represents a document schema this module supports.
@@ -116,6 +124,7 @@ export interface IFluidModuleWithDetails {
  * to have code loading modules in one package. #8193
  * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
  * a package name and package version range.
+ * @legacy
  * @alpha
  */
 export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
@@ -130,6 +139,7 @@ export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComp
 
 /**
  * Services and properties necessary for creating a loader
+ * @legacy
  * @alpha
  */
 export interface ILoaderProps {
@@ -187,6 +197,7 @@ export interface ILoaderProps {
 
 /**
  * Services and properties used by and exposed by the loader
+ * @legacy
  * @alpha
  */
 export interface ILoaderServices {
@@ -241,6 +252,7 @@ export interface ILoaderServices {
 /**
  * Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support
  * blobs in detached containers.
+ * @legacy
  * @alpha
  *
  * @deprecated - IDetachedBlobStorage will be removed in a future release without a replacement. Blobs created while detached will be stored in memory to align with attached container behavior. AB#8049
@@ -260,6 +272,7 @@ export type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" |
 
 /**
  * Manages Fluid resource loading
+ * @legacy
  * @alpha
  */
 export class Loader implements IHostLoader {
@@ -298,7 +311,7 @@ export class Loader implements IHostLoader {
 			codeLoader,
 			options: options ?? {},
 			scope:
-				options?.provideScopeLoader !== false ? { ...scope, ILoader: this } : { ...scope },
+				options?.provideScopeLoader === false ? { ...scope } : { ...scope, ILoader: this },
 			detachedBlobStorage,
 			protocolHandlerBuilder,
 			subLogger: subMc.logger,
@@ -377,6 +390,7 @@ export class Loader implements IHostLoader {
 
 		request.headers ??= {};
 		// If set in both query string and headers, use query string.  Also write the value from the query string into the header either way.
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 		request.headers[LoaderHeader.version] =
 			parsed.version ?? request.headers[LoaderHeader.version];
 
@@ -391,12 +405,16 @@ export class Loader implements IHostLoader {
 		return Container.load(
 			{
 				resolvedUrl,
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 				version: request.headers?.[LoaderHeader.version] ?? undefined,
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 				loadMode: request.headers?.[LoaderHeader.loadMode],
 				pendingLocalState,
 			},
 			{
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 				canReconnect: request.headers?.[LoaderHeader.reconnect],
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 				clientDetailsOverride: request.headers?.[LoaderHeader.clientDetails],
 				...this.services,
 			},

package/src/location-redirection-utilities/resolveWithLocationRedirection.ts

@@ -17,11 +17,14 @@ import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
  * @returns `true` is the error is location redirection error, otherwise `false`.
  * @internal
  */
-export function isLocationRedirectionError(error: any): error is ILocationRedirectionError {
+export function isLocationRedirectionError(
+	error: unknown,
+): error is ILocationRedirectionError {
 	return (
 		typeof error === "object" &&
 		error !== null &&
-		error.errorType === DriverErrorTypes.locationRedirection
+		(error as Partial<ILocationRedirectionError>).errorType ===
+			DriverErrorTypes.locationRedirection
 	);
 }
 
@@ -32,6 +35,7 @@ export function isLocationRedirectionError(error: any): error is ILocationRedire
  * @param urlResolver - resolver used to resolve the url.
  * @param logger - logger to send events.
  * @returns Response from the API call.
+ * @legacy
  * @alpha
  */
 export async function resolveWithLocationRedirectionHandling<T>(
@@ -45,7 +49,7 @@ export async function resolveWithLocationRedirectionHandling<T>(
 	for (;;) {
 		try {
 			return await api(req);
-		} catch (error: any) {
+		} catch (error: unknown) {
 			if (!isLocationRedirectionError(error)) {
 				throw error;
 			}

package/src/memoryBlobStorage.ts

@@ -48,7 +48,7 @@ export function tryInitializeMemoryDetachedBlobStorage(
 	// eslint-disable-next-line import/no-deprecated
 	detachedStorage: IDetachedBlobStorage | undefined,
 	attachmentBlobs: string,
-) {
+): void {
 	if (!isMemoryDetachedBlobStorage(detachedStorage)) {
 		throw new Error(
 			"DetachedBlobStorage was not provided to the loader during serialize so cannot be provided during rehydrate.",
@@ -56,9 +56,11 @@ export function tryInitializeMemoryDetachedBlobStorage(
 	}
 
 	assert(detachedStorage.size === 0, 0x99e /* Blob storage already initialized */);
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 	const maybeAttachmentBlobs = JSON.parse(attachmentBlobs);
 	assert(Array.isArray(maybeAttachmentBlobs), 0x99f /* Invalid attachmentBlobs */);
 
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
 	detachedStorage.initialize(maybeAttachmentBlobs);
 }
 
@@ -77,9 +79,9 @@ export function createMemoryDetachedBlobStorage(): IDetachedBlobStorage {
 		},
 		getBlobIds: (): string[] => blobs.map((_, i) => `${i}`),
 		dispose: () => blobs.splice(0),
-		serialize: () => JSON.stringify(blobs.map((b) => bufferToString(b, "utf-8"))),
+		serialize: () => JSON.stringify(blobs.map((b) => bufferToString(b, "utf8"))),
 		initialize: (attachmentBlobs: string[]) =>
-			blobs.push(...attachmentBlobs.map((maybeBlob) => stringToBuffer(maybeBlob, "utf-8"))),
+			blobs.push(...attachmentBlobs.map((maybeBlob) => stringToBuffer(maybeBlob, "utf8"))),
 	};
 	return storage;
 }

package/src/noopHeuristic.ts

@@ -44,7 +44,7 @@ export class NoopHeuristic extends TypedEventEmitter<INoopSenderEvents> {
 		private readonly NoopCountFrequency: number = defaultNoopCountFrequency,
 	) {
 		super();
-		if (NoopTimeFrequency !== Infinity) {
+		if (NoopTimeFrequency !== Number.POSITIVE_INFINITY) {
 			this.timer = new Timer(NoopTimeFrequency, () => {
 				// We allow the timer to expire even if an op is sent or we disconnect.
 				// This condition is to guard against trying to send a noop anyway in that case.

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.0.2";
+export const pkgVersion = "2.1.0-276326";

package/src/protocol/protocol.ts

@@ -4,8 +4,8 @@
  */
 
 import { ISequencedClient } from "@fluidframework/driver-definitions";
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
 import {
+	ISequencedDocumentMessage,
 	IDocumentAttributes,
 	IClientJoin,
 	ICommittedProposal,
@@ -20,6 +20,7 @@ import {
 import { IQuorumSnapshot, Quorum } from "./quorum.js";
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IScribeProtocolState {
@@ -31,6 +32,7 @@ export interface IScribeProtocolState {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IProtocolHandler {
@@ -61,7 +63,7 @@ export class ProtocolOpHandler implements IProtocolHandler {
 		members: [string, ISequencedClient][],
 		proposals: [number, ISequencedProposal, string[]][],
 		values: [string, ICommittedProposal][],
-		sendProposal: (key: string, value: any) => number,
+		sendProposal: (key: string, value: unknown) => number,
 	) {
 		this._quorum = new Quorum(members, proposals, values, sendProposal);
 	}
@@ -73,7 +75,7 @@ export class ProtocolOpHandler implements IProtocolHandler {
 		};
 	}
 
-	setConnectionState(connected: boolean, clientId: string | undefined) {
+	setConnectionState(connected: boolean, clientId: string | undefined): void {
 		this._quorum.setConnectionState(connected, clientId);
 	}
 
@@ -81,7 +83,7 @@ export class ProtocolOpHandler implements IProtocolHandler {
 		return this._quorum.snapshot();
 	}
 
-	public close() {
+	public close(): void {
 		this._quorum.close();
 	}
 
@@ -103,10 +105,8 @@ export class ProtocolOpHandler implements IProtocolHandler {
 
 		let immediateNoOp = false;
 
-		/* eslint-disable no-case-declarations */
-
 		switch (message.type) {
-			case MessageType.ClientJoin:
+			case MessageType.ClientJoin: {
 				const systemJoinMessage = message as ISequencedDocumentSystemMessage;
 				const join = JSON.parse(systemJoinMessage.data) as IClientJoin;
 				const member: ISequencedClient = {
@@ -115,14 +115,16 @@ export class ProtocolOpHandler implements IProtocolHandler {
 				};
 				this._quorum.addMember(join.clientId, member);
 				break;
+			}
 
-			case MessageType.ClientLeave:
+			case MessageType.ClientLeave: {
 				const systemLeaveMessage = message as ISequencedDocumentSystemMessage;
 				const clientId = JSON.parse(systemLeaveMessage.data) as string;
 				this._quorum.removeMember(clientId);
 				break;
+			}
 
-			case MessageType.Propose:
+			case MessageType.Propose: {
 				// back-compat: ADO #1385: This should become unconditional eventually.
 				// Can be done only after Container.processRemoteMessage() stops parsing content!
 				if (typeof message.contents === "string") {
@@ -140,12 +142,11 @@ export class ProtocolOpHandler implements IProtocolHandler {
 				// On a quorum proposal, immediately send a response to expedite the approval.
 				immediateNoOp = true;
 				break;
+			}
 
 			default:
 		}
 
-		/* eslint-enable no-case-declarations */
-
 		// Notify the quorum of the MSN from the message. We rely on it to handle duplicate values but may
 		// want to move that logic to this class.
 		this._quorum.updateMinimumSequenceNumber(message);