@fluidframework/container-runtime 2.0.0-dev-rc.1.0.0.232845 → 2.0.0-dev-rc.2.0.0.245554

package/src/summary/index.ts

@@ -10,28 +10,28 @@ export {
 	ITrackedClient,
 	OrderedClientCollection,
 	OrderedClientElection,
-} from "./orderedClientElection";
-export { defaultMaxAttemptsForSubmitFailures, RunningSummarizer } from "./runningSummarizer";
+} from "./orderedClientElection.js";
+export { defaultMaxAttemptsForSubmitFailures, RunningSummarizer } from "./runningSummarizer.js";
 export {
 	ICancellableSummarizerController,
 	neverCancelledSummaryToken,
 	RunWhileConnectedCoordinator,
-} from "./runWhileConnectedCoordinator";
-export { Summarizer } from "./summarizer";
+} from "./runWhileConnectedCoordinator.js";
+export { Summarizer } from "./summarizer.js";
 export {
 	ISummarizerClientElection,
 	ISummarizerClientElectionEvents,
 	SummarizerClientElection,
 	summarizerClientType,
-} from "./summarizerClientElection";
-export { SummarizeHeuristicData, SummarizeHeuristicRunner } from "./summarizerHeuristics";
+} from "./summarizerClientElection.js";
+export { SummarizeHeuristicData, SummarizeHeuristicRunner } from "./summarizerHeuristics.js";
 export {
 	createRootSummarizerNode,
 	createRootSummarizerNodeWithGC,
 	IRefreshSummaryResult,
 	IRootSummarizerNode,
 	IRootSummarizerNodeWithGC,
-} from "./summarizerNode";
+} from "./summarizerNode/index.js";
 export {
 	IConnectableRuntime,
 	IGeneratedSummaryStats,
@@ -65,7 +65,7 @@ export {
 	SummaryStage,
 	IRetriableFailureResult,
 	ISummarizeEventProps,
-} from "./summarizerTypes";
+} from "./summarizerTypes.js";
 export {
 	IAckedSummary,
 	ISummaryCollectionOpEvents,
@@ -77,7 +77,7 @@ export {
 	ISummaryNackMessage,
 	OpActionEventListener,
 	OpActionEventName,
-} from "./summaryCollection";
+} from "./summaryCollection.js";
 export {
 	aliasBlobName,
 	blobsTreeName,
@@ -98,12 +98,13 @@ export {
 	WriteFluidDataStoreAttributes,
 	wrapSummaryInChannelsTree,
 	idCompressorBlobName,
-} from "./summaryFormat";
-export { getFailMessage, RetriableSummaryError, SummarizeReason } from "./summaryGenerator";
+	IdCompressorMode,
+} from "./summaryFormat.js";
+export { getFailMessage, RetriableSummaryError, SummarizeReason } from "./summaryGenerator.js";
 export {
 	IConnectedEvents,
 	IConnectedState,
 	ISummaryManagerConfig,
 	SummaryManager,
 	SummaryManagerState,
-} from "./summaryManager";
+} from "./summaryManager.js";

package/src/summary/orderedClientElection.ts

@@ -13,7 +13,7 @@ import { assert } from "@fluidframework/core-utils";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IDeltaManager } from "@fluidframework/container-definitions";
 import { IClient, IQuorumClients, ISequencedClient } from "@fluidframework/protocol-definitions";
-import { summarizerClientType } from "./summarizerClientElection";
+import { summarizerClientType } from "./summarizerClientElection.js";
 
 // helper types for recursive readonly.
 // eslint-disable-next-line @typescript-eslint/ban-types

package/src/summary/runWhileConnectedCoordinator.ts

@@ -8,7 +8,7 @@ import {
 	SummarizerStopReason,
 	IConnectableRuntime,
 	ISummaryCancellationToken,
-} from "./summarizerTypes";
+} from "./summarizerTypes.js";
 
 /**
  * Similar to AbortController, but using promise instead of events

package/src/summary/runningSummarizer.ts

@@ -15,9 +15,9 @@ import { assert, delay, Deferred, PromiseTimer } from "@fluidframework/core-util
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { DriverErrorTypes } from "@fluidframework/driver-definitions";
 import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
-import { ISummaryConfiguration } from "../containerRuntime";
-import { opSize } from "../opProperties";
-import { SummarizeHeuristicRunner } from "./summarizerHeuristics";
+import { ISummaryConfiguration } from "../containerRuntime.js";
+import { opSize } from "../opProperties.js";
+import { SummarizeHeuristicRunner } from "./summarizerHeuristics.js";
 import {
 	IEnqueueSummarizeOptions,
 	ISummarizeOptions,
@@ -36,14 +36,14 @@ import {
 	IRefreshSummaryAckOptions,
 	ISummarizerEvents,
 	ISummarizeEventProps,
-} from "./summarizerTypes";
-import { IAckedSummary, IClientSummaryWatcher, SummaryCollection } from "./summaryCollection";
+} from "./summarizerTypes.js";
+import { IAckedSummary, IClientSummaryWatcher, SummaryCollection } from "./summaryCollection.js";
 import {
 	raceTimer,
 	SummarizeReason,
 	SummarizeResultBuilder,
 	SummaryGenerator,
-} from "./summaryGenerator";
+} from "./summaryGenerator.js";
 
 const maxSummarizeAckWaitTime = 10 * 60 * 1000; // 10 minutes
 
@@ -254,6 +254,9 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 			}
 		});
 
+		const immediatelyRefreshLatestSummaryAck =
+			this.mc.config.getBoolean("Fluid.Summarizer.immediatelyRefreshLatestSummaryAck") ??
+			true;
 		this.generator = new SummaryGenerator(
 			this.pendingAckTimer,
 			this.heuristicData,
@@ -261,6 +264,11 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 			() => {
 				this.totalSuccessfulAttempts++;
 			},
+			async (options: IRefreshSummaryAckOptions) => {
+				if (immediatelyRefreshLatestSummaryAck) {
+					await this.refreshLatestSummaryAckAndHandleError(options);
+				}
+			},
 			this.summaryWatcher,
 			this.mc.logger,
 		);
@@ -303,40 +311,48 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 		// https://dev.azure.com/fluidframework/internal/_workitems/edit/779
 		await this.lockedSummaryAction(
 			() => {},
-			async () =>
-				this.refreshLatestSummaryAckCallback({
+			async () => {
+				const options: IRefreshSummaryAckOptions = {
 					proposalHandle: summaryOpHandle,
 					ackHandle: summaryAckHandle,
 					summaryRefSeq: refSequenceNumber,
 					summaryLogger,
-				}).catch(async (error) => {
-					// If the error is 404, so maybe the fetched version no longer exists on server. We just
-					// ignore this error in that case, as that means we will have another summaryAck for the
-					// latest version with which we will refresh the state. However in case of single commit
-					// summary, we might me missing a summary ack, so in that case we are still fine as the
-					// code in `submitSummary` function in container runtime, will refresh the latest state
-					// by calling `prefetchLatestSummaryThenClose`. We will load the next summarizer from the
-					// updated state and be fine.
-					const isIgnoredError =
-						isFluidError(error) &&
-						error.errorType === DriverErrorTypes.fileNotFoundOrAccessDeniedError;
-
-					summaryLogger.sendTelemetryEvent(
-						{
-							eventName: isIgnoredError
-								? "HandleSummaryAckErrorIgnored"
-								: "HandleLastSummaryAckError",
-							referenceSequenceNumber: refSequenceNumber,
-							proposalHandle: summaryOpHandle,
-							ackHandle: summaryAckHandle,
-						},
-						error,
-					);
-				}),
+				};
+				await this.refreshLatestSummaryAckAndHandleError(options);
+			},
 			() => {},
 		);
 	}
 
+	private readonly refreshLatestSummaryAckAndHandleError = async (
+		options: IRefreshSummaryAckOptions,
+	) => {
+		return this.refreshLatestSummaryAckCallback(options).catch(async (error) => {
+			// If the error is 404, so maybe the fetched version no longer exists on server. We just
+			// ignore this error in that case, as that means we will have another summaryAck for the
+			// latest version with which we will refresh the state. However in case of single commit
+			// summary, we might be missing a summary ack, so in that case we are still fine as the
+			// code in `submitSummary` function in container runtime, will refresh the latest state
+			// by calling `prefetchLatestSummaryThenClose`. We will load the next summarizer from the
+			// updated state and be fine.
+			const isIgnoredError =
+				isFluidError(error) &&
+				error.errorType === DriverErrorTypes.fileNotFoundOrAccessDeniedError;
+
+			options.summaryLogger.sendTelemetryEvent(
+				{
+					eventName: isIgnoredError
+						? "HandleSummaryAckErrorIgnored"
+						: "HandleLastSummaryAckError",
+					referenceSequenceNumber: options.summaryRefSeq,
+					proposalHandle: options.proposalHandle,
+					ackHandle: options.ackHandle,
+				},
+				error,
+			);
+		});
+	};
+
 	/**
 	 * Responsible for receiving and processing all the summary acks.
 	 * It starts processing ACKs after the one for the summary this client loaded from (initialSequenceNumber). Any
@@ -565,6 +581,8 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 					...options,
 					summaryLogger,
 					cancellationToken: this.cancellationToken,
+					latestSummaryRefSeqNum:
+						this.heuristicData.lastSuccessfulSummary.refSequenceNumber,
 				};
 				const summarizeResult = this.generator.summarize(summaryOptions, resultsBuilder);
 				// ensure we wait till the end of the process
@@ -660,6 +678,7 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 				...summarizeOptions,
 				summaryLogger,
 				cancellationToken: this.cancellationToken,
+				latestSummaryRefSeqNum: this.heuristicData.lastSuccessfulSummary.refSequenceNumber,
 			};
 
 			// Note: no need to account for cancellationToken.waitCancelled here, as
@@ -731,6 +750,7 @@ export class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> impl
 				summaryLogger,
 				cancellationToken: this.cancellationToken,
 				finalAttempt,
+				latestSummaryRefSeqNum: this.heuristicData.lastSuccessfulSummary.refSequenceNumber,
 			};
 			const summarizeResult = this.generator.summarize(summaryOptions);
 			return { summarizeProps, summarizeResult };

package/src/summary/summarizer.ts

@@ -14,10 +14,10 @@ import {
 	wrapErrorAndLog,
 } from "@fluidframework/telemetry-utils";
 import { IFluidHandleContext } from "@fluidframework/core-interfaces";
-import { ISummaryConfiguration } from "../containerRuntime";
-import { ICancellableSummarizerController } from "./runWhileConnectedCoordinator";
-import { SummaryCollection } from "./summaryCollection";
-import { RunningSummarizer } from "./runningSummarizer";
+import { ISummaryConfiguration } from "../containerRuntime.js";
+import { ICancellableSummarizerController } from "./runWhileConnectedCoordinator.js";
+import { SummaryCollection } from "./summaryCollection.js";
+import { RunningSummarizer } from "./runningSummarizer.js";
 import {
 	IConnectableRuntime,
 	ISummarizer,
@@ -32,9 +32,9 @@ import {
 	EnqueueSummarizeResult,
 	ISummarizerEvents,
 	ISummarizeEventProps,
-} from "./summarizerTypes";
-import { SummarizeHeuristicData } from "./summarizerHeuristics";
-import { SummarizeResultBuilder } from "./summaryGenerator";
+} from "./summarizerTypes.js";
+import { SummarizeHeuristicData } from "./summarizerHeuristics.js";
+import { SummarizeResultBuilder } from "./summaryGenerator.js";
 
 const summarizingError = "summarizingError";
 

package/src/summary/summarizerClientElection.ts

@@ -11,8 +11,8 @@ import {
 	IOrderedClientElection,
 	ISerializedElection,
 	ITrackedClient,
-} from "./orderedClientElection";
-import { ISummaryCollectionOpEvents } from "./summaryCollection";
+} from "./orderedClientElection.js";
+import { ISummaryCollectionOpEvents } from "./summaryCollection.js";
 
 export const summarizerClientType = "summarizer";
 

package/src/summary/summarizerHeuristics.ts

@@ -5,14 +5,14 @@
 
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { Timer } from "@fluidframework/core-utils";
-import { ISummaryConfigurationHeuristics } from "../containerRuntime";
+import { ISummaryConfigurationHeuristics } from "../containerRuntime.js";
 import {
 	ISummarizeHeuristicData,
 	ISummarizeHeuristicRunner,
 	ISummarizeAttempt,
 	ISummaryHeuristicStrategy,
-} from "./summarizerTypes";
-import { SummarizeReason } from "./summaryGenerator";
+} from "./summarizerTypes.js";
+import { SummarizeReason } from "./summaryGenerator.js";
 
 /** Simple implementation of class for tracking summarize heuristic data. */
 export class SummarizeHeuristicData implements ISummarizeHeuristicData {

package/src/summary/summarizerNode/index.ts

@@ -7,6 +7,9 @@ export {
 	IRefreshSummaryResult,
 	ISummarizerNodeRootContract,
 	ValidateSummaryResult,
-} from "./summarizerNodeUtils";
-export { IRootSummarizerNode, createRootSummarizerNode } from "./summarizerNode";
-export { IRootSummarizerNodeWithGC, createRootSummarizerNodeWithGC } from "./summarizerNodeWithGc";
+} from "./summarizerNodeUtils.js";
+export { IRootSummarizerNode, createRootSummarizerNode } from "./summarizerNode.js";
+export {
+	IRootSummarizerNodeWithGC,
+	createRootSummarizerNodeWithGC,
+} from "./summarizerNodeWithGc.js";

package/src/summary/summarizerNode/summarizerNode.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryBaseLogger, ITelemetryErrorEvent } from "@fluidframework/core-interfaces";
+import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 import {
 	ISummarizerNode,
 	ISummarizerNodeConfig,
@@ -26,6 +26,7 @@ import {
 	PerformanceEvent,
 	TelemetryDataTag,
 	tagCodeArtifacts,
+	type ITelemetryErrorEventExt,
 } from "@fluidframework/telemetry-utils";
 import { assert, unreachableCase } from "@fluidframework/core-utils";
 import { mergeStats } from "@fluidframework/runtime-utils";
@@ -33,11 +34,12 @@ import {
 	EscapedPath,
 	ICreateChildDetails,
 	IRefreshSummaryResult,
+	IStartSummaryResult,
 	ISummarizerNodeRootContract,
 	parseSummaryForSubtrees,
 	SummaryNode,
 	ValidateSummaryResult,
-} from "./summarizerNodeUtils";
+} from "./summarizerNodeUtils.js";
 
 export interface IRootSummarizerNode extends ISummarizerNode, ISummarizerNodeRootContract {}
 
@@ -96,7 +98,22 @@ export class SummarizerNode implements IRootSummarizerNode {
 		});
 	}
 
-	public startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryBaseLogger) {
+	/**
+	 * In order to produce a summary with a summarizer node, the summarizer node system must be notified a summary has
+	 * started. This is done by calling startSummary. This will track the reference sequence number of the summary and
+	 * run some validation checks to ensure the summary is correct.
+	 * @param referenceSequenceNumber - the number of ops processed up to this point
+	 * @param summaryLogger - the logger to use for the summary
+	 * @param latestSummaryRefSeqNum - the reference sequence number of the latest summary. Another way to think about
+	 * it is the reference sequence number of the previous summary.
+	 * @returns the number of nodes in the tree, the number of nodes that are invalid, and the different types of
+	 * sequence number mismatches
+	 */
+	public startSummary(
+		referenceSequenceNumber: number,
+		summaryLogger: ITelemetryBaseLogger,
+		latestSummaryRefSeqNum: number,
+	): IStartSummaryResult {
 		assert(
 			this.wipSummaryLogger === undefined,
 			0x19f /* "wipSummaryLogger should not be set yet in startSummary" */,
@@ -106,12 +123,40 @@ export class SummarizerNode implements IRootSummarizerNode {
 			0x1a0 /* "Already tracking a summary" */,
 		);
 
+		let nodes = 1;
+		let invalidNodes = 0;
+		const sequenceNumberMismatchKeySet = new Set<string>();
+		const nodeLatestSummaryRefSeqNum = this._latestSummary?.referenceSequenceNumber;
+		if (
+			nodeLatestSummaryRefSeqNum !== undefined &&
+			latestSummaryRefSeqNum !== nodeLatestSummaryRefSeqNum
+		) {
+			invalidNodes++;
+			sequenceNumberMismatchKeySet.add(
+				`${latestSummaryRefSeqNum}-${nodeLatestSummaryRefSeqNum}`,
+			);
+		}
+
 		this.wipSummaryLogger = summaryLogger;
 
 		for (const child of this.children.values()) {
-			child.startSummary(referenceSequenceNumber, this.wipSummaryLogger);
+			const childStartSummaryResult = child.startSummary(
+				referenceSequenceNumber,
+				this.wipSummaryLogger,
+				latestSummaryRefSeqNum,
+			);
+			nodes += childStartSummaryResult.nodes;
+			invalidNodes += childStartSummaryResult.invalidNodes;
+			for (const invalidSequenceNumber of childStartSummaryResult.mismatchNumbers) {
+				sequenceNumberMismatchKeySet.add(invalidSequenceNumber);
+			}
 		}
 		this.wipReferenceSequenceNumber = referenceSequenceNumber;
+		return {
+			nodes,
+			invalidNodes,
+			mismatchNumbers: sequenceNumberMismatchKeySet,
+		};
 	}
 
 	public async summarize(
@@ -623,7 +668,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 	/**
 	 * Creates and throws an error due to unexpected conditions.
 	 */
-	protected throwUnexpectedError(eventProps: ITelemetryErrorEvent): never {
+	protected throwUnexpectedError(eventProps: ITelemetryErrorEventExt): never {
 		const error = new LoggingError(eventProps.eventName, {
 			...eventProps,
 			referenceSequenceNumber: this.wipReferenceSequenceNumber,

package/src/summary/summarizerNode/summarizerNodeUtils.ts

@@ -14,6 +14,15 @@ export interface IRefreshSummaryResult {
 	isSummaryNewer: boolean;
 }
 
+export interface IStartSummaryResult {
+	/** The number of summarizerNodes at the start of the summary. */
+	nodes: number;
+	/** The number of summarizerNodes in the wrong state. */
+	invalidNodes: number;
+	/** The invalid sequence numbers and their values. It should be in the format of validateSequenceNumber-nodeSequenceNumber */
+	mismatchNumbers: Set<string>;
+}
+
 /**
  * Return type of validateSummary function. In case of success, the object returned should have success: true.
  * In case of failure, the object returned should have success: false and additional properties to indicate what
@@ -37,7 +46,11 @@ export type ValidateSummaryResult =
 	  };
 
 export interface ISummarizerNodeRootContract {
-	startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLoggerExt): void;
+	startSummary(
+		referenceSequenceNumber: number,
+		summaryLogger: ITelemetryLoggerExt,
+		latestSummaryRefSeqNum: number,
+	): IStartSummaryResult;
 	validateSummary(): ValidateSummaryResult;
 	completeSummary(proposalHandle: string, validate: boolean): void;
 	clearSummary(): void;

package/src/summary/summarizerNode/summarizerNodeWithGc.ts

@@ -3,12 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import {
-	ITelemetryLoggerExt,
-	LoggingError,
-	TelemetryDataTag,
-	tagCodeArtifacts,
-} from "@fluidframework/telemetry-utils";
+import { LoggingError, TelemetryDataTag, tagCodeArtifacts } from "@fluidframework/telemetry-utils";
 import { assert, LazyPromise } from "@fluidframework/core-utils";
 import {
 	CreateChildSummarizerNodeParam,
@@ -24,15 +19,16 @@ import {
 } from "@fluidframework/runtime-definitions";
 import { unpackChildNodesUsedRoutes } from "@fluidframework/runtime-utils";
 import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
-import { cloneGCData, unpackChildNodesGCDetails } from "../../gc";
-import { SummarizerNode } from "./summarizerNode";
+import { cloneGCData, unpackChildNodesGCDetails } from "../../gc/index.js";
+import { SummarizerNode } from "./summarizerNode.js";
 import {
 	EscapedPath,
 	ICreateChildDetails,
+	IStartSummaryResult,
 	ISummarizerNodeRootContract,
 	SummaryNode,
 	ValidateSummaryResult,
-} from "./summarizerNodeUtils";
+} from "./summarizerNodeUtils.js";
 
 export interface IRootSummarizerNodeWithGC
 	extends ISummarizerNodeWithGC,
@@ -236,7 +232,11 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	/**
 	 * Called during the start of a summary. Updates the work-in-progress used routes.
 	 */
-	public startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLoggerExt) {
+	public startSummary(
+		referenceSequenceNumber: number,
+		summaryLogger: ITelemetryBaseLogger,
+		latestSummaryRefSeqNum: number,
+	): IStartSummaryResult {
 		// If GC is disabled, skip setting wip used routes since we should not track GC state.
 		if (!this.gcDisabled) {
 			assert(
@@ -244,7 +244,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 				0x1b4 /* "We should not already be tracking used routes when to track a new summary" */,
 			);
 		}
-		super.startSummary(referenceSequenceNumber, summaryLogger);
+		return super.startSummary(referenceSequenceNumber, summaryLogger, latestSummaryRefSeqNum);
 	}
 
 	/**

package/src/summary/summarizerTypes.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { IEvent, IEventProvider, ITelemetryProperties } from "@fluidframework/core-interfaces";
+import { IEvent, IEventProvider, ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
 import { ITelemetryLoggerExt, ITelemetryLoggerPropertyBag } from "@fluidframework/telemetry-utils";
 import { ContainerWarning, IDeltaManager } from "@fluidframework/container-definitions";
 import {
@@ -12,9 +12,9 @@ import {
 	IDocumentMessage,
 } from "@fluidframework/protocol-definitions";
 import { ISummaryStats } from "@fluidframework/runtime-definitions";
-import { ISummaryConfigurationHeuristics } from "../containerRuntime";
-import { ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage } from "./summaryCollection";
-import { SummarizeReason } from "./summaryGenerator";
+import { ISummaryConfigurationHeuristics } from "../containerRuntime.js";
+import { ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage } from "./summaryCollection.js";
+import { SummarizeReason } from "./summaryGenerator.js";
 
 /**
  * Similar to AbortSignal, but using promise instead of events
@@ -63,20 +63,6 @@ export interface ISummarizerInternalsProvider {
 	refreshLatestSummaryAck(options: IRefreshSummaryAckOptions): Promise<void>;
 }
 
-/**
- * @deprecated Options that control the behavior of a running summarizer.
- * @public
- * */
-export interface ISummarizerOptions {
-	/**
-	 * Set to true to disable the default heuristics from running; false by default.
-	 * This affects only the heuristics around when a summarizer should
-	 * submit summaries. So when it is disabled, summarizer clients should
-	 * not be expected to summarize unless an on-demand summary is requested.
-	 */
-	disableHeuristics: boolean;
-}
-
 /**
  * @internal
  */
@@ -141,6 +127,8 @@ export interface ISubmitSummaryOptions extends ISummarizeOptions {
 	readonly cancellationToken: ISummaryCancellationToken;
 	/** Summarization may be attempted multiple times. This tells whether this is the final summarization attempt. */
 	readonly finalAttempt?: boolean;
+	/** The sequence number of the latest summary used to validate if summary state is correct before summarizing */
+	readonly latestSummaryRefSeqNum: number;
 }
 
 /**
@@ -438,7 +426,7 @@ export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
 	/* Closes summarizer. Any pending processes (summary in flight) are abandoned. */
 	close(): void;
 
-	run(onBehalfOf: string, disableHeuristics?: boolean): Promise<SummarizerStopReason>;
+	run(onBehalfOf: string): Promise<SummarizerStopReason>;
 
 	/**
 	 * Attempts to generate a summary on demand. If already running, takes no action.
@@ -551,10 +539,10 @@ type ISummarizeTelemetryOptionalProperties =
 	| keyof ISummarizeOptions;
 
 export type ISummarizeTelemetryProperties = Pick<
-	ITelemetryProperties,
+	ITelemetryBaseProperties,
 	ISummarizeTelemetryRequiredProperties
 > &
-	Partial<Pick<ITelemetryProperties, ISummarizeTelemetryOptionalProperties>>;
+	Partial<Pick<ITelemetryBaseProperties, ISummarizeTelemetryOptionalProperties>>;
 
 /** Strategy used to heuristically determine when we should run a summary */
 export interface ISummaryHeuristicStrategy {
@@ -620,10 +608,10 @@ type SummaryGeneratorOptionalTelemetryProperties =
 	| "stage";
 
 export type SummaryGeneratorTelemetry = Pick<
-	ITelemetryProperties,
+	ITelemetryBaseProperties,
 	SummaryGeneratorRequiredTelemetryProperties
 > &
-	Partial<Pick<ITelemetryProperties, SummaryGeneratorOptionalTelemetryProperties>>;
+	Partial<Pick<ITelemetryBaseProperties, SummaryGeneratorOptionalTelemetryProperties>>;
 
 export interface ISummarizeRunnerTelemetry extends ITelemetryLoggerPropertyBag {
 	/** Number of times the summarizer run. */

package/src/summary/summaryFormat.ts

@@ -19,7 +19,7 @@ import {
 	gcTreeKey,
 	ISummaryTreeWithStats,
 } from "@fluidframework/runtime-definitions";
-import { IGCMetadata } from "../gc";
+import { IGCMetadata } from "../gc/index.js";
 
 type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
 interface IFluidDataStoreAttributes0 {
@@ -85,6 +85,20 @@ export function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): b
 	return !!attributes.summaryFormatVersion && !attributes.disableIsolatedChannels;
 }
 
+/**
+ * ID Compressor mode.
+ * "on" - compressor is On. It's loaded as part of container load. This mode is sticky - once on, compressor is On for all
+ * sessions for a given document. This results in IContainerRuntime.idCompressor to be always available.
+ * "delayed" - ID compressor bundle is loaded only on establishing of first delta connection, i.e. it does not impact boot of cotnainer.
+ * In such mode IContainerRuntime.idCompressor is not made available (unless previous sessions of same document had it "On").
+ * The only thing that is available is IContainerRuntime.generateDocumentUniqueId() that provides opportunistically short IDs.
+ * "off" - ID compressor is not laoded (unless it is "on" due to previous session for same document having it "on").
+ * While IContainerRuntime.generateDocumentUniqueId() is available, it will produce long IDs that are do not compress well.
+ *
+ * @alpha
+ */
+export type IdCompressorMode = "on" | "delayed" | "off";
+
 /**
  * @alpha
  */
@@ -99,7 +113,7 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
 	/** GUID to identify a document in telemetry */
 	readonly telemetryDocumentId?: string;
 	/** True if the runtime IdCompressor is enabled */
-	readonly idCompressorEnabled?: boolean;
+	readonly idCompressorMode?: IdCompressorMode;
 }
 
 /**