@fluidframework/container-runtime 2.0.0-dev.4.4.0.162574 → 2.0.0-dev.5.3.2.178189

package/src/summary/summaryCollection.ts

@@ -3,7 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { IDisposable, IEvent, ITelemetryLogger } from "@fluidframework/common-definitions";
+import { IEvent } from "@fluidframework/common-definitions";
+import { IDisposable } from "@fluidframework/core-interfaces";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { Deferred, assert, TypedEventEmitter } from "@fluidframework/common-utils";
 import { IDeltaManager } from "@fluidframework/container-definitions";
 import {
@@ -70,7 +72,9 @@ class Summary implements ISummary {
 		return new Summary(clientId, clientSequenceNumber);
 	}
 	public static createFromOp(op: ISummaryOpMessage) {
-		const summary = new Summary(op.clientId, op.clientSequenceNumber);
+		// TODO: Verify whether this should be able to handle server-generated ops (with null clientId)
+		// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+		const summary = new Summary(op.clientId as string, op.clientSequenceNumber);
 		summary.broadcast(op);
 		return summary;
 	}
@@ -256,7 +260,7 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 
 	public constructor(
 		private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
-		private readonly logger: ITelemetryLogger,
+		private readonly logger: ITelemetryLoggerExt,
 	) {
 		super();
 		this.deltaManager.on("op", (op) => this.handleOp(op));
@@ -376,7 +380,9 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		let summary: Summary | undefined;
 
 		// Check if summary already being watched, broadcast if so
-		const watcher = this.summaryWatchers.get(op.clientId);
+		// TODO: Verify whether this should be able to handle server-generated ops (with null clientId)
+		// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+		const watcher = this.summaryWatchers.get(op.clientId as string);
 		if (watcher) {
 			summary = watcher.tryGetSummary(op.clientSequenceNumber);
 			if (summary) {

package/src/summary/summaryFormat.ts

@@ -5,7 +5,10 @@
 
 import { assert } from "@fluidframework/common-utils";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
-import { readAndParse } from "@fluidframework/driver-utils";
+import {
+	readAndParse,
+	blobHeadersBlobName as blobNameForBlobHeaders,
+} from "@fluidframework/driver-utils";
 import {
 	ISequencedDocumentMessage,
 	ISnapshotTree,
@@ -153,6 +156,7 @@ export const chunksBlobName = ".chunks";
 export const electedSummarizerBlobName = ".electedSummarizer";
 export const blobsTreeName = ".blobs";
 export const idCompressorBlobName = ".idCompressor";
+export const blobHeadersBlobName = blobNameForBlobHeaders;
 
 export function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): boolean {
 	return !!metadata && !metadata.disableIsolatedChannels;

package/src/summary/summaryGenerator.ts

@@ -3,7 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import {
+	ITelemetryLoggerExt,
+	PerformanceEvent,
+	LoggingError,
+	ChildLogger,
+} from "@fluidframework/telemetry-utils";
+import { ITelemetryProperties } from "@fluidframework/core-interfaces";
+
 import {
 	assert,
 	Deferred,
@@ -12,7 +19,6 @@ import {
 	Timer,
 } from "@fluidframework/common-utils";
 import { MessageType } from "@fluidframework/protocol-definitions";
-import { PerformanceEvent, LoggingError, ChildLogger } from "@fluidframework/telemetry-utils";
 import { getRetryDelaySecondsFromError } from "@fluidframework/driver-utils";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
 import {
@@ -28,6 +34,8 @@ import {
 	ISummaryCancellationToken,
 	ISummarizeTelemetryProperties,
 	SummaryGeneratorTelemetry,
+	SummaryStage,
+	SubmitSummaryFailureData,
 } from "./summarizerTypes";
 import { IClientSummaryWatcher } from "./summaryCollection";
 
@@ -125,7 +133,9 @@ export const getFailMessage = (errorCode: keyof typeof summarizeErrors) =>
 	`${errorCode}: ${summarizeErrors[errorCode]}`;
 
 export class SummarizeResultBuilder {
-	public readonly summarySubmitted = new Deferred<SummarizeResultPart<SubmitSummaryResult>>();
+	public readonly summarySubmitted = new Deferred<
+		SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>
+	>();
 	public readonly summaryOpBroadcasted = new Deferred<
 		SummarizeResultPart<IBroadcastSummaryResult>
 	>();
@@ -136,6 +146,7 @@ export class SummarizeResultBuilder {
 	public fail(
 		message: string,
 		error: any,
+		stage: SummaryStage = "unknown",
 		nackSummaryResult?: INackSummaryResult,
 		retryAfterSeconds?: number,
 	) {
@@ -151,7 +162,7 @@ export class SummarizeResultBuilder {
 			error,
 			retryAfterSeconds,
 		} as const;
-		this.summarySubmitted.resolve(result);
+		this.summarySubmitted.resolve({ ...result, data: { stage } });
 		this.summaryOpBroadcasted.resolve(result);
 		this.receivedSummaryAckOrNack.resolve({ ...result, data: nackSummaryResult });
 	}
@@ -164,6 +175,20 @@ export class SummarizeResultBuilder {
 	}
 }
 
+/**
+ * Errors type for errors hit during summary that may be retriable.
+ */
+export class RetriableSummaryError extends LoggingError {
+	public readonly canRetry = this.retryAfterSeconds !== undefined;
+	constructor(
+		message: string,
+		public readonly retryAfterSeconds?: number,
+		props?: ITelemetryProperties,
+	) {
+		super(message, props);
+	}
+}
+
 /**
  * This class generates and tracks a summary attempt.
  */
@@ -177,7 +202,7 @@ export class SummaryGenerator {
 		) => Promise<SubmitSummaryResult>,
 		private readonly successfulSummaryCallback: () => void,
 		private readonly summaryWatcher: Pick<IClientSummaryWatcher, "watchSummary">,
-		private readonly logger: ITelemetryLogger,
+		private readonly logger: ITelemetryLoggerExt,
 	) {
 		this.summarizeTimer = new Timer(maxSummarizeTimeoutTime, () =>
 			this.summarizeTimerHandler(maxSummarizeTimeoutTime, 1),
@@ -238,6 +263,7 @@ export class SummaryGenerator {
 			{ start: true, end: true, cancel: "generic" },
 		);
 
+		let summaryData: SubmitSummaryResult | undefined;
 		const fail = (
 			errorCode: keyof typeof summarizeErrors,
 			error?: any,
@@ -266,14 +292,15 @@ export class SummaryGenerator {
 				},
 				error ?? reason,
 			); // disconnect & summaryAckTimeout do not have proper error.
-			resultsBuilder.fail(reason, error, nackSummaryResult, retryAfterSeconds);
+
+			// If summarize did not hit an unexpected error, summaryData would be available. Otherwise, the state is
+			// unknown.
+			const stage = summaryData?.stage ?? "unknown";
+			resultsBuilder.fail(reason, error, stage, nackSummaryResult, retryAfterSeconds);
 		};
 
 		// Wait to generate and send summary
 		this.summarizeTimer.start();
-
-		// Use record type to prevent unexpected value types
-		let summaryData: SubmitSummaryResult | undefined;
 		try {
 			// Need to save refSeqNum before we record new attempt (happens as part of submitSummaryCallback)
 			const lastAttemptRefSeqNum = this.heuristicData.lastAttempt.refSequenceNumber;
@@ -355,10 +382,10 @@ export class SummaryGenerator {
 				cancellationToken,
 			);
 			if (waitBroadcastResult.result === "cancelled") {
-				return fail("disconnect");
+				return fail("disconnect", summaryData.stage);
 			}
 			if (waitBroadcastResult.result !== "done") {
-				return fail("summaryOpWaitTimeout");
+				return fail("summaryOpWaitTimeout", summaryData.stage);
 			}
 			const summarizeOp = waitBroadcastResult.value;
 

package/src/summary/summaryManager.ts

@@ -3,14 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import {
-	IDisposable,
-	IEvent,
-	IEventProvider,
-	ITelemetryLogger,
-} from "@fluidframework/common-definitions";
+import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
+import { IDisposable } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/common-utils";
-import { ChildLogger, PerformanceEvent } from "@fluidframework/telemetry-utils";
+import {
+	ChildLogger,
+	ITelemetryLoggerExt,
+	PerformanceEvent,
+} from "@fluidframework/telemetry-utils";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
 import { IThrottler } from "../throttler";
 import { ISummarizerClientElection } from "./summarizerClientElection";
@@ -74,7 +74,7 @@ export interface ISummaryManagerConfig {
  * stopping existing summarizer client.
  */
 export class SummaryManager implements IDisposable {
-	private readonly logger: ITelemetryLogger;
+	private readonly logger: ITelemetryLoggerExt;
 	private readonly opsToBypassInitialDelay: number;
 	private readonly initialDelayMs: number;
 	private latestClientId: string | undefined;
@@ -97,7 +97,7 @@ export class SummaryManager implements IDisposable {
 			SummaryCollection,
 			"opsSinceLastAck" | "addOpListener" | "removeOpListener"
 		>,
-		parentLogger: ITelemetryLogger,
+		parentLogger: ITelemetryLoggerExt,
 		/** Creates summarizer by asking interactive container to spawn summarizing container and
 		 * get back its Summarizer instance. */
 		private readonly requestSummarizerFn: () => Promise<ISummarizer>,