@fluidframework/container-runtime 2.0.0-dev.4.1.0.148229 → 2.0.0-dev.4.3.0.157531

package/src/summary/summarizerTypes.ts

@@ -78,6 +78,14 @@ export interface ISummarizerRuntime extends IConnectableRuntime {
 	readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
 	disposeFn?(): void;
 	closeFn(): void;
+	on?(
+		event: "op",
+		listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void,
+	): this;
+	off?(
+		event: "op",
+		listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void,
+	): this;
 }
 
 /** Options affecting summarize behavior. */
@@ -294,8 +302,13 @@ export type SummarizerStopReason =
 	| "notElectedClient"
 	/** Summarizer client was disconnected */
 	| "summarizerClientDisconnected"
-	/* running summarizer threw an exception */
-	| "summarizerException";
+	/** running summarizer threw an exception */
+	| "summarizerException"
+	/**
+	 * The previous summary state on the summarizer is not the most recently acked summary. this also happens when the
+	 * first submitSummary attempt fails for any reason and there's a 2nd summary attempt without an ack
+	 */
+	| "latestSummaryStateStale";
 
 export interface ISummarizerEvents extends IEvent {
 	/**
@@ -398,6 +411,8 @@ export interface ISummarizeHeuristicData {
 
 	/** Mark that the last sent summary attempt has received an ack */
 	markLastAttemptAsSuccessful(): void;
+
+	opsSinceLastSummary: number;
 }
 
 /** Responsible for running heuristics determining when to summarize. */
@@ -491,7 +506,9 @@ type SummaryGeneratorOptionalTelemetryProperties =
 	/** Actual sequence number of the summary op proposal. */
 	| "summarySequenceNumber"
 	/** Optional Retry-After time in seconds. If specified, the client should wait this many seconds before retrying. */
-	| "nackRetryAfter";
+	| "nackRetryAfter"
+	/** The stage at which the submit summary method failed at. This can help determine what type of failure we have */
+	| "stage";
 
 export type SummaryGeneratorTelemetry = Pick<
 	ITelemetryProperties,

package/src/summary/summaryFormat.ts

@@ -91,6 +91,8 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
 	readonly summaryNumber?: number;
 	/** GUID to identify a document in telemetry */
 	readonly telemetryDocumentId?: string;
+	/** True if the runtime IdCompressor is enabled */
+	readonly idCompressorEnabled?: boolean;
 }
 
 export interface ICreateContainerMetadata {
@@ -150,6 +152,7 @@ export const metadataBlobName = ".metadata";
 export const chunksBlobName = ".chunks";
 export const electedSummarizerBlobName = ".electedSummarizer";
 export const blobsTreeName = ".blobs";
+export const idCompressorBlobName = ".idCompressor";
 
 export function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): boolean {
 	return !!metadata && !metadata.disableIsolatedChannels;
@@ -169,6 +172,7 @@ export const nonDataStorePaths = [
 	".serviceProtocol",
 	blobsTreeName,
 	gcTreeKey,
+	idCompressorBlobName,
 ];
 
 export const dataStoreAttributesBlobName = ".component";

package/src/summary/summaryGenerator.ts

@@ -120,6 +120,10 @@ const summarizeErrors = {
 	disconnect: "Summary cancelled due to summarizer or main client disconnect",
 } as const;
 
+// Helper functions to report failures and return.
+export const getFailMessage = (errorCode: keyof typeof summarizeErrors) =>
+	`${errorCode}: ${summarizeErrors[errorCode]}`;
+
 export class SummarizeResultBuilder {
 	public readonly summarySubmitted = new Deferred<SummarizeResultPart<SubmitSummaryResult>>();
 	public readonly summaryOpBroadcasted = new Deferred<
@@ -171,7 +175,6 @@ export class SummaryGenerator {
 		private readonly submitSummaryCallback: (
 			options: ISubmitSummaryOptions,
 		) => Promise<SubmitSummaryResult>,
-		private readonly raiseSummarizingError: (errorMessage: string) => void,
 		private readonly successfulSummaryCallback: () => void,
 		private readonly summaryWatcher: Pick<IClientSummaryWatcher, "watchSummary">,
 		private readonly logger: ITelemetryLogger,
@@ -235,16 +238,12 @@ export class SummaryGenerator {
 			{ start: true, end: true, cancel: "generic" },
 		);
 
-		// Helper functions to report failures and return.
-		const getFailMessage = (errorCode: keyof typeof summarizeErrors) =>
-			`${errorCode}: ${summarizeErrors[errorCode]}`;
 		const fail = (
 			errorCode: keyof typeof summarizeErrors,
 			error?: any,
 			properties?: SummaryGeneratorTelemetry,
 			nackSummaryResult?: INackSummaryResult,
 		) => {
-			this.raiseSummarizingError(summarizeErrors[errorCode]);
 			// UploadSummary may fail with 429 and retryAfter - respect that
 			// Summary Nack also can have retryAfter, it's parsed below and comes as a property.
 			const retryAfterSeconds = getRetryDelaySecondsFromError(error);
@@ -257,17 +256,17 @@ export class SummaryGenerator {
 					? "generic"
 					: "error";
 
-			const message = getFailMessage(errorCode);
+			const reason = getFailMessage(errorCode);
 			summarizeEvent.cancel(
 				{
 					...properties,
-					reason: errorCode,
+					reason,
 					category,
 					retryAfterSeconds,
 				},
-				error ?? message,
+				error ?? reason,
 			); // disconnect & summaryAckTimeout do not have proper error.
-			resultsBuilder.fail(message, error, nackSummaryResult, retryAfterSeconds);
+			resultsBuilder.fail(reason, error, nackSummaryResult, retryAfterSeconds);
 		};
 
 		// Wait to generate and send summary
@@ -283,18 +282,20 @@ export class SummaryGenerator {
 				cancellationToken,
 			});
 
+			this.heuristicData.recordAttempt(summaryData.referenceSequenceNumber);
+
 			// Cumulatively add telemetry properties based on how far generateSummary went.
 			const referenceSequenceNumber = summaryData.referenceSequenceNumber;
-			const opsSinceLastSummary =
-				referenceSequenceNumber -
-				this.heuristicData.lastSuccessfulSummary.refSequenceNumber;
 			summarizeTelemetryProps = {
 				...summarizeTelemetryProps,
 				referenceSequenceNumber,
 				minimumSequenceNumber: summaryData.minimumSequenceNumber,
 				opsSinceLastAttempt:
 					referenceSequenceNumber - this.heuristicData.lastAttempt.refSequenceNumber,
-				opsSinceLastSummary,
+				opsSinceLastSummary:
+					referenceSequenceNumber -
+					this.heuristicData.lastSuccessfulSummary.refSequenceNumber,
+				stage: summaryData.stage,
 			};
 			summarizeTelemetryProps = this.addSummaryDataToTelemetryProps(
 				summaryData,
@@ -318,12 +319,15 @@ export class SummaryGenerator {
 			if (!fullTree && !summaryData.forcedFullTree) {
 				const { summarizedDataStoreCount, gcStateUpdatedDataStoreCount = 0 } =
 					summaryData.summaryStats;
-				if (summarizedDataStoreCount > gcStateUpdatedDataStoreCount + opsSinceLastSummary) {
+				if (
+					summarizedDataStoreCount >
+					gcStateUpdatedDataStoreCount + this.heuristicData.opsSinceLastSummary
+				) {
 					logger.sendErrorEvent({
 						eventName: "IncrementalSummaryViolation",
 						summarizedDataStoreCount,
 						gcStateUpdatedDataStoreCount,
-						opsSinceLastSummary,
+						opsSinceLastSummary: this.heuristicData.opsSinceLastSummary,
 					});
 				}
 			}
@@ -334,7 +338,9 @@ export class SummaryGenerator {
 		} catch (error) {
 			return fail("submitSummaryFailure", error);
 		} finally {
-			this.heuristicData.recordAttempt(summaryData?.referenceSequenceNumber);
+			if (summaryData === undefined) {
+				this.heuristicData.recordAttempt();
+			}
 			this.summarizeTimer.clear();
 		}
 

package/src/summary/summaryManager.ts

@@ -356,6 +356,8 @@ export class SummaryManager implements IDisposable {
 			startThrottlerMaxDelayMs: this.startThrottler.maxDelayMs,
 			opsSinceLastAck: this.summaryCollection.opsSinceLastAck,
 			opsToBypassInitialDelay: this.opsToBypassInitialDelay,
+			electedParentId: this.clientElection.electedParentId,
+			electedClientId: this.clientElection.electedClientId,
 		});
 
 		// This delay helps ensure that last summarizer that might be left from previous client