@fluidframework/container-runtime 2.0.0-dev-rc.5.0.0.271717 → 2.0.0-dev-rc.5.0.0.272889

package/src/pendingStateManager.ts

@@ -153,7 +153,7 @@ export class PendingStateManager implements IDisposable {
 				message.sequenceNumber !== undefined,
 				0x97c /* saved op should already have a sequence number */,
 			);
-			return message.sequenceNumber >= (snapshotSequenceNumber ?? 0);
+			return message.sequenceNumber > (snapshotSequenceNumber ?? 0);
 		});
 		this.pendingMessages.toArray().forEach((message) => {
 			if (
@@ -252,7 +252,9 @@ export class PendingStateManager implements IDisposable {
 	 * the batch information was preserved for batch messages.
 	 * @param message - The message that got ack'd and needs to be processed.
 	 */
-	public processPendingLocalMessage(message: InboundSequencedContainerRuntimeMessage): unknown {
+	public processPendingLocalMessage(
+		message: InboundSequencedContainerRuntimeMessage,
+	): unknown {
 		// Pre-processing part - This may be the start of a batch.
 		this.maybeProcessBatchBegin(message);
 		// Get the next message from the pending queue. Verify a message exists.

package/src/summary/documentSchema.ts

@@ -482,18 +482,16 @@ export class DocumentsSchemaController {
 		this.documentSchema = !existing
 			? this.desiredSchema
 			: (documentMetadataSchema as IDocumentSchemaCurrent) ??
-			  ({
+				({
 					version: currentDocumentVersionSchema,
 					// see comment in summarizeDocumentSchema() on why it has to stay zero
 					refSeq: 0,
 					// If it's existing document and it has no schema, then it was written by legacy client.
 					// If it's a new document, then we define it's legacy-related behaviors.
 					runtime: {
-						explicitSchemaControl: boolToProp(
-							!existing && features.explicitSchemaControl,
-						),
+						explicitSchemaControl: boolToProp(!existing && features.explicitSchemaControl),
 					},
-			  } satisfies IDocumentSchemaCurrent);
+				} satisfies IDocumentSchemaCurrent);
 
 		checkRuntimeCompatibility(this.documentSchema, "document");
 		this.validateSeqNumber(this.documentSchema.refSeq, snapshotSequenceNumber, "summary");
@@ -563,8 +561,7 @@ export class DocumentsSchemaController {
 		if (this.sendOp && this.futureSchema !== undefined) {
 			this.sendOp = false;
 			assert(
-				this.explicitSchemaControl &&
-					this.futureSchema.runtime.explicitSchemaControl === true,
+				this.explicitSchemaControl && this.futureSchema.runtime.explicitSchemaControl === true,
 				0x94e /* not legacy */,
 			);
 			return {

package/src/summary/index.ts

@@ -11,7 +11,10 @@ export {
 	OrderedClientCollection,
 	OrderedClientElection,
 } from "./orderedClientElection.js";
-export { defaultMaxAttemptsForSubmitFailures, RunningSummarizer } from "./runningSummarizer.js";
+export {
+	defaultMaxAttemptsForSubmitFailures,
+	RunningSummarizer,
+} from "./runningSummarizer.js";
 export {
 	ICancellableSummarizerController,
 	neverCancelledSummaryToken,

package/src/summary/orderedClientElection.ts

@@ -24,12 +24,12 @@ export type ImmutablePrimitives = undefined | null | boolean | string | number |
 export type Immutable<T> = T extends ImmutablePrimitives
 	? T
 	: T extends (infer A)[]
-	? readonly Immutable<A>[]
-	: T extends Map<infer K, infer V>
-	? ReadonlyMap<Immutable<K>, Immutable<V>>
-	: T extends Set<infer V>
-	? ReadonlySet<Immutable<V>>
-	: { readonly [K in keyof T]: Immutable<T[K]> };
+		? readonly Immutable<A>[]
+		: T extends Map<infer K, infer V>
+			? ReadonlyMap<Immutable<K>, Immutable<V>>
+			: T extends Set<infer V>
+				? ReadonlySet<Immutable<V>>
+				: { readonly [K in keyof T]: Immutable<T[K]> };
 
 /** Minimum information for a client tracked for election consideration. */
 export interface ITrackedClient {
@@ -68,7 +68,8 @@ export interface IOrderedClientCollectionEvents extends IEvent {
 }
 
 /** Contract for a sorted collection of all clients in the quorum. */
-export interface IOrderedClientCollection extends IEventProvider<IOrderedClientCollectionEvents> {
+export interface IOrderedClientCollection
+	extends IEventProvider<IOrderedClientCollectionEvents> {
 	/** Count of clients in the collection. */
 	readonly count: number;
 	/** Pointer to the oldest client in the collection. */
@@ -375,7 +376,9 @@ export class OrderedClientElection
 			}
 		}
 		orderedClientCollection.on("addClient", (client, seq) => this.addClient(client, seq));
-		orderedClientCollection.on("removeClient", (client, seq) => this.removeClient(client, seq));
+		orderedClientCollection.on("removeClient", (client, seq) =>
+			this.removeClient(client, seq),
+		);
 
 		if (typeof initialState === "number") {
 			this._electionSequenceNumber = initialState;
@@ -487,7 +490,9 @@ export class OrderedClientElection
 	 * @param client - client to start checking
 	 * @returns oldest eligible client starting with passed in client or undefined if none.
 	 */
-	private findFirstEligibleParent(client: ILinkedClient | undefined): ILinkedClient | undefined {
+	private findFirstEligibleParent(
+		client: ILinkedClient | undefined,
+	): ILinkedClient | undefined {
 		let candidateClient = client;
 		while (
 			candidateClient !== undefined &&
@@ -597,7 +602,9 @@ export class OrderedClientElection
 	 * and no client has been elected.
 	 */
 	public resetElectedClient(sequenceNumber: number): void {
-		const firstClient = this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);
+		const firstClient = this.findFirstEligibleParent(
+			this.orderedClientCollection.oldestClient,
+		);
 		if (this._electedClient === undefined || this._electedClient === this._electedParent) {
 			this.tryElectingClient(firstClient, sequenceNumber, "ResetElectedClient");
 		} else {

package/src/summary/runningSummarizer.ts

@@ -43,7 +43,11 @@ import {
 	SummarizerStopReason,
 	type IRetriableFailureError,
 } from "./summarizerTypes.js";
-import { IAckedSummary, IClientSummaryWatcher, SummaryCollection } from "./summaryCollection.js";
+import {
+	IAckedSummary,
+	IClientSummaryWatcher,
+	SummaryCollection,
+} from "./summaryCollection.js";
 import {
 	RetriableSummaryError,
 	SummarizeReason,
@@ -72,7 +76,10 @@ export const defaultMaxAttemptsForSubmitFailures = 5;
  * track of summaries that it is generating as they are broadcast and acked/nacked.
  * This object is created and controlled by Summarizer object.
  */
-export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> implements IDisposable {
+export class RunningSummarizer
+	extends TypedEventEmitter<ISummarizerEvents>
+	implements IDisposable
+{
 	public static async start(
 		logger: ITelemetryBaseLogger,
 		summaryWatcher: IClientSummaryWatcher,
@@ -234,7 +241,10 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 		// Cap the maximum amount of time client will wait for a summarize op ack to maxSummarizeAckWaitTime
 		// configuration.maxAckWaitTime is composed from defaults, server values, and runtime overrides
 
-		const maxAckWaitTime = Math.min(this.configuration.maxAckWaitTime, maxSummarizeAckWaitTime);
+		const maxAckWaitTime = Math.min(
+			this.configuration.maxAckWaitTime,
+			maxSummarizeAckWaitTime,
+		);
 
 		this.pendingAckTimer = new PromiseTimer(maxAckWaitTime, () => {
 			// Note: summarizeCount (from ChildLogger definition) may be 0,
@@ -262,8 +272,7 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 		});
 
 		const immediatelyRefreshLatestSummaryAck =
-			this.mc.config.getBoolean("Fluid.Summarizer.immediatelyRefreshLatestSummaryAck") ??
-			true;
+			this.mc.config.getBoolean("Fluid.Summarizer.immediatelyRefreshLatestSummaryAck") ?? true;
 		this.generator = new SummaryGenerator(
 			this.pendingAckTimer,
 			this.heuristicData,
@@ -442,7 +451,10 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 	 * @param op - op to check
 	 * @returns true if this op can trigger a summary
 	 */
-	private opCanTriggerSummary(op: ISequencedDocumentMessage, runtimeMessage: boolean): boolean {
+	private opCanTriggerSummary(
+		op: ISequencedDocumentMessage,
+		runtimeMessage: boolean,
+	): boolean {
 		switch (op.type) {
 			case MessageType.Summarize:
 			case MessageType.SummaryAck:
@@ -587,8 +599,7 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 					...options,
 					summaryLogger,
 					cancellationToken: this.cancellationToken,
-					latestSummaryRefSeqNum:
-						this.heuristicData.lastSuccessfulSummary.refSequenceNumber,
+					latestSummaryRefSeqNum: this.heuristicData.lastSuccessfulSummary.refSequenceNumber,
 				};
 				const summarizeResult = this.generator.summarize(summaryOptions, resultsBuilder);
 				// ensure we wait till the end of the process
@@ -882,7 +893,7 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 					...results,
 					alreadyEnqueued: true,
 					overridden: true,
-			  }
+				}
 			: results;
 	}
 

package/src/summary/summarizerClientElection.ts

@@ -22,7 +22,8 @@ export interface ISummarizerClientElectionEvents extends IEvent {
 	(event: "electedSummarizerChanged", handler: () => void): void;
 }
 
-export interface ISummarizerClientElection extends IEventProvider<ISummarizerClientElectionEvents> {
+export interface ISummarizerClientElection
+	extends IEventProvider<ISummarizerClientElectionEvents> {
 	readonly electedClientId: string | undefined;
 	readonly electedParentId: string | undefined;
 }

package/src/summary/summarizerNode/summarizerNode.ts

@@ -197,11 +197,10 @@ export class SummarizerNode implements IRootSummarizerNode {
 				this._latestSummary !== undefined
 					? {
 							summarySequenceNumber: this.wipReferenceSequenceNumber,
-							latestSummarySequenceNumber:
-								this._latestSummary.referenceSequenceNumber,
+							latestSummarySequenceNumber: this._latestSummary.referenceSequenceNumber,
 							// TODO: remove summaryPath
 							summaryPath: this._latestSummary.fullPath.path,
-					  }
+						}
 					: undefined;
 		}
 
@@ -323,7 +322,10 @@ export class SummarizerNode implements IRootSummarizerNode {
 		parentPath: EscapedPath | undefined,
 		parentSkipRecursion: boolean,
 	) {
-		assert(this.wipReferenceSequenceNumber !== undefined, 0x1a4 /* "Not tracking a summary" */);
+		assert(
+			this.wipReferenceSequenceNumber !== undefined,
+			0x1a4 /* "Not tracking a summary" */,
+		);
 		let localPathsToUse = this.wipLocalPaths;
 
 		if (parentSkipRecursion) {

package/src/summary/summarizerNode/summarizerNodeUtils.ts

@@ -6,7 +6,10 @@
 import { SummaryObject } from "@fluidframework/driver-definitions";
 import { ISnapshotTree } from "@fluidframework/driver-definitions/internal";
 import { channelsTreeName } from "@fluidframework/runtime-definitions/internal";
-import { ITelemetryLoggerExt, TelemetryDataTag } from "@fluidframework/telemetry-utils/internal";
+import {
+	ITelemetryLoggerExt,
+	TelemetryDataTag,
+} from "@fluidframework/telemetry-utils/internal";
 
 export interface IRefreshSummaryResult {
 	/** Tells whether this summary is tracked by this client. */
@@ -173,7 +176,9 @@ export interface ISubtreeInfo<T extends ISnapshotTree | SummaryObject> {
  * would be located if exists.
  * @param baseSummary - summary to check
  */
-export function parseSummaryForSubtrees(baseSummary: ISnapshotTree): ISubtreeInfo<ISnapshotTree> {
+export function parseSummaryForSubtrees(
+	baseSummary: ISnapshotTree,
+): ISubtreeInfo<ISnapshotTree> {
 	// New versions of snapshots have child nodes isolated in .channels subtree
 	const channelsSubtree = baseSummary.trees[channelsTreeName];
 	if (channelsSubtree !== undefined) {

package/src/summary/summarizerNode/summarizerNodeWithGc.ts

@@ -82,7 +82,9 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	private baseGCDetailsLoaded: boolean = false;
 
 	// The base GC details for the child nodes. This is passed to child nodes when creating them.
-	private readonly childNodesBaseGCDetailsP: Promise<Map<string, IGarbageCollectionDetailsBase>>;
+	private readonly childNodesBaseGCDetailsP: Promise<
+		Map<string, IGarbageCollectionDetailsBase>
+	>;
 
 	private gcData: IGarbageCollectionData | undefined;
 
@@ -224,7 +226,12 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		// GC data may not be available if loaded from a snapshot with either GC disabled or before GC was added.
 		// Note - canReuseHandle is checked to be consistent with summarize - generate GC data for nodes for which
 		// summary must be generated.
-		if (this.canReuseHandle && !fullGC && !this.hasDataChanged() && this.gcData !== undefined) {
+		if (
+			this.canReuseHandle &&
+			!fullGC &&
+			!this.hasDataChanged() &&
+			this.gcData !== undefined
+		) {
 			return cloneGCData(this.gcData);
 		}
 
@@ -320,10 +327,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		if (!this.gcDisabled) {
 			const summaryNode = this.pendingSummaries.get(proposalHandle);
 			if (summaryNode !== undefined) {
-				const summaryNodeWithGC = new SummaryNodeWithGC(
-					wipSerializedUsedRoutes,
-					summaryNode,
-				);
+				const summaryNodeWithGC = new SummaryNodeWithGC(wipSerializedUsedRoutes, summaryNode);
 				this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);
 			}
 		}

package/src/summary/summarizerTypes.ts

@@ -3,7 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { IDeltaManager, ContainerWarning } from "@fluidframework/container-definitions/internal";
+import {
+	IDeltaManager,
+	ContainerWarning,
+} from "@fluidframework/container-definitions/internal";
 import {
 	IEvent,
 	IEventProvider,
@@ -23,7 +26,11 @@ import {
 
 import { ISummaryConfigurationHeuristics } from "../containerRuntime.js";
 
-import { ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage } from "./summaryCollection.js";
+import {
+	ISummaryAckMessage,
+	ISummaryNackMessage,
+	ISummaryOpMessage,
+} from "./summaryCollection.js";
 import { SummarizeReason } from "./summaryGenerator.js";
 
 /**

package/src/summary/summaryCollection.ts

@@ -298,7 +298,10 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		this.summaryWatchers.delete(clientId);
 	}
 
-	public setPendingAckTimerTimeoutCallback(maxAckWaitTime: number, timeoutCallback: () => void) {
+	public setPendingAckTimerTimeoutCallback(
+		maxAckWaitTime: number,
+		timeoutCallback: () => void,
+	) {
 		this.maxAckWaitTime = maxAckWaitTime;
 		this.pendingAckTimerTimeoutCallback = timeoutCallback;
 	}

package/src/summary/summaryFormat.ts

@@ -28,7 +28,10 @@ import { IDocumentSchema } from "./documentSchema.js";
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
  * @alpha
  */
-export type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
+export type OmitAttributesVersions<T> = Omit<
+	T,
+	"snapshotFormatVersion" | "summaryFormatVersion"
+>;
 
 /**
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
@@ -87,7 +90,9 @@ export type ReadFluidDataStoreAttributes =
 	| IFluidDataStoreAttributes0
 	| IFluidDataStoreAttributes1
 	| IFluidDataStoreAttributes2;
-export type WriteFluidDataStoreAttributes = IFluidDataStoreAttributes1 | IFluidDataStoreAttributes2;
+export type WriteFluidDataStoreAttributes =
+	| IFluidDataStoreAttributes1
+	| IFluidDataStoreAttributes2;
 
 export function getAttributesFormatVersion(attributes: ReadFluidDataStoreAttributes): number {
 	if (attributes.summaryFormatVersion) {
@@ -175,7 +180,7 @@ export const extractSummaryMetadataMessage = (
 				sequenceNumber: message.sequenceNumber,
 				timestamp: message.timestamp,
 				type: message.type,
-		  };
+			};
 
 export function getMetadataFormatVersion(metadata?: IContainerRuntimeMetadata): number {
 	/**

package/src/summary/summaryGenerator.ts

@@ -318,8 +318,7 @@ export class SummaryGenerator {
 				minimumSequenceNumber: summaryData.minimumSequenceNumber,
 				opsSinceLastAttempt: referenceSequenceNumber - lastAttemptRefSeqNum,
 				opsSinceLastSummary:
-					referenceSequenceNumber -
-					this.heuristicData.lastSuccessfulSummary.refSequenceNumber,
+					referenceSequenceNumber - this.heuristicData.lastSuccessfulSummary.refSequenceNumber,
 				stage: summaryData.stage,
 			};
 			summarizeTelemetryProps = this.addSummaryDataToTelemetryProps(
@@ -489,13 +488,9 @@ export class SummaryGenerator {
 				const errorCode: SummarizeErrorCode = "summaryNack";
 
 				// pre-0.58 error message prefix: summaryNack
-				const error = new RetriableSummaryError(
-					getFailMessage(errorCode),
-					retryAfterSeconds,
-					{
-						errorMessage,
-					},
-				);
+				const error = new RetriableSummaryError(getFailMessage(errorCode), retryAfterSeconds, {
+					errorMessage,
+				});
 
 				assert(
 					getRetryDelaySecondsFromError(error) === retryAfterSeconds,

package/src/summary/summaryManager.ts

@@ -89,7 +89,10 @@ export interface ISummaryManagerConfig {
  * It observes changes in calculated summarizer and reacts to changes by either creating summarizer client or
  * stopping existing summarizer client.
  */
-export class SummaryManager extends TypedEventEmitter<ISummarizerEvents> implements IDisposable {
+export class SummaryManager
+	extends TypedEventEmitter<ISummarizerEvents>
+	implements IDisposable
+{
 	private readonly logger: ITelemetryLoggerExt;
 	private readonly opsToBypassInitialDelay: number;
 	private readonly initialDelayMs: number;
@@ -263,10 +266,7 @@ export class SummaryManager extends TypedEventEmitter<ISummarizerEvents> impleme
 				// when the electedClient will be replaced with the new summarizer client.
 				// The alternative would be to let connectedState.clientId !== clientElection.electedClientId when
 				// state === Starting || state === Running.
-				assert(
-					this.state === SummaryManagerState.Starting,
-					0x263 /* "Expected: starting" */,
-				);
+				assert(this.state === SummaryManagerState.Starting, 0x263 /* "Expected: starting" */);
 				this.state = SummaryManagerState.Running;
 
 				const summarizer = await this.createSummarizerFn();
@@ -326,10 +326,7 @@ export class SummaryManager extends TypedEventEmitter<ISummarizerEvents> impleme
 				// means it also lost connection), and error happened on load (we do not have summarizer).
 				// We could annotate the error raised in Container.load where the container closed during load with no error
 				// and check for that case here, but that does not seem to be necessary.
-				if (
-					this.getShouldSummarizeState().shouldSummarize ||
-					this.summarizer !== undefined
-				) {
+				if (this.getShouldSummarizeState().shouldSummarize || this.summarizer !== undefined) {
 					// Report any failure as an error unless it was due to cancellation (like "disconnected" error)
 					// If failure happened on container load, we may not yet realized that socket disconnected, so check
 					// offlineError.

package/src/throttler.ts

@@ -52,7 +52,9 @@ export class Throttler implements IThrottler {
 	 * by adding the delay time to the actual time.
 	 */
 	public get latestAttemptTime() {
-		return this.startTimes.length > 0 ? this.startTimes[this.startTimes.length - 1] : undefined;
+		return this.startTimes.length > 0
+			? this.startTimes[this.startTimes.length - 1]
+			: undefined;
 	}
 
 	constructor(

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"extends": ["../../../common/build/build-common/tsdoc-base.json"]
+}