@fluidframework/container-runtime 2.0.0-dev.3.1.0.125672 → 2.0.0-dev.4.2.0.153917

package/src/{summarizerTypes.ts → summary/summarizerTypes.ts}

@@ -10,7 +10,6 @@ import {
 	ITelemetryProperties,
 } from "@fluidframework/common-definitions";
 import { ITelemetryLoggerPropertyBag } from "@fluidframework/telemetry-utils";
-import { IFluidLoadable } from "@fluidframework/core-interfaces";
 import { ContainerWarning, IDeltaManager } from "@fluidframework/container-definitions";
 import {
 	ISequencedDocumentMessage,
@@ -18,24 +17,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 ".";
-
-/**
- * @deprecated This will be removed in a later release.
- */
-export const ISummarizer: keyof IProvideSummarizer = "ISummarizer";
-
-/**
- * @deprecated This will be removed in a later release.
- */
-export interface IProvideSummarizer {
-	/**
-	 * @deprecated This will be removed in a later release.
-	 */
-	readonly ISummarizer: ISummarizer;
-}
 
 /**
  * Similar to AbortSignal, but using promise instead of events
@@ -84,7 +68,6 @@ export interface IConnectableRuntime {
 	readonly disposed: boolean;
 	readonly connected: boolean;
 	readonly clientId: string | undefined;
-	readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
 	once(event: "connected" | "disconnected" | "dispose", listener: () => void): this;
 }
 
@@ -92,8 +75,17 @@ export interface ISummarizerRuntime extends IConnectableRuntime {
 	readonly logger: ITelemetryLogger;
 	/** clientId of parent (non-summarizing) container that owns summarizer container */
 	readonly summarizerClientId: string | undefined;
+	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. */
@@ -310,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 {
 	/**
@@ -320,10 +317,12 @@ export interface ISummarizerEvents extends IEvent {
 	(event: "summarizingError", listener: (error: ISummarizingWarning) => void);
 }
 
-export interface ISummarizer
-	extends IEventProvider<ISummarizerEvents>,
-		IFluidLoadable,
-		Partial<IProvideSummarizer> {
+export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
+	/**
+	 * Allows {@link ISummarizer} to be used with our {@link @fluidframework/core-interfaces#FluidObject} pattern.
+	 */
+	readonly ISummarizer?: ISummarizer;
+
 	/*
 	 * Asks summarizer to move to exit.
 	 * Summarizer will finish current processes, which may take a while.
@@ -412,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. */
@@ -505,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/{summaryFormat.ts → summary/summaryFormat.ts}

@@ -16,6 +16,7 @@ import {
 	gcTreeKey,
 	ISummaryTreeWithStats,
 } from "@fluidframework/runtime-definitions";
+import { IGCMetadata } from "../gc";
 
 type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
 interface IFluidDataStoreAttributes0 {
@@ -88,6 +89,8 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
 	readonly disableIsolatedChannels?: true;
 	/** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */
 	readonly summaryNumber?: number;
+	/** GUID to identify a document in telemetry */
+	readonly telemetryDocumentId?: string;
 }
 
 export interface ICreateContainerMetadata {
@@ -97,27 +100,6 @@ export interface ICreateContainerMetadata {
 	createContainerTimestamp?: number;
 }
 
-export type GCVersion = number;
-export interface IGCMetadata {
-	/**
-	 * The version of the GC code that was run to generate the GC data that is written in the summary.
-	 * Also, used to determine whether GC is enabled for this container or not:
-	 * - A value of 0 or undefined means GC is disabled.
-	 * - A value greater than 0 means GC is enabled.
-	 */
-	readonly gcFeature?: GCVersion;
-	/**
-	 * Tells whether the GC sweep phase is enabled for this container.
-	 * - True means sweep phase is enabled.
-	 * - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.
-	 */
-	readonly sweepEnabled?: boolean;
-	/** If this is present, the session for this container will expire after this time and the container will close */
-	readonly sessionExpiryTimeoutMs?: number;
-	/** How long to wait after an object is unreferenced before deleting it via GC Sweep */
-	readonly sweepTimeoutMs?: number;
-}
-
 /** The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary. */
 export type ISummaryMetadataMessage = Pick<
 	ISequencedDocumentMessage,
@@ -173,14 +155,6 @@ export function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): b
 	return !!metadata && !metadata.disableIsolatedChannels;
 }
 
-export function getGCVersion(metadata?: IGCMetadata): GCVersion {
-	if (!metadata) {
-		// Force to 0/disallowed in prior versions
-		return 0;
-	}
-	return metadata.gcFeature ?? 0;
-}
-
 export const protocolTreeName = ".protocol";
 
 /**

package/src/{summaryGenerator.ts → 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,
@@ -194,10 +197,6 @@ export class SummaryGenerator {
 		cancellationToken: ISummaryCancellationToken,
 		resultsBuilder = new SummarizeResultBuilder(),
 	): ISummarizeResults {
-		this.logger.sendTelemetryEvent({
-			eventName: "Summarize_start",
-			...summarizeProps,
-		});
 		this.summarizeCore(summarizeProps, options, resultsBuilder, cancellationToken).catch(
 			(error) => {
 				const message = "UnexpectedSummarizeError";
@@ -229,22 +228,22 @@ export class SummaryGenerator {
 			timeSinceLastSummary,
 		};
 
-		const summarizeEvent = PerformanceEvent.start(logger, {
-			eventName: "Summarize",
-			refreshLatestAck,
-			...summarizeTelemetryProps,
-		});
+		const summarizeEvent = PerformanceEvent.start(
+			logger,
+			{
+				eventName: "Summarize",
+				refreshLatestAck,
+				...summarizeTelemetryProps,
+			},
+			{ 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();
 		}
 
@@ -414,12 +420,13 @@ export class SummaryGenerator {
 				// Check for retryDelay in summaryNack response.
 				assert(ackNackOp.type === MessageType.SummaryNack, 0x274 /* "type check" */);
 				const summaryNack = ackNackOp.contents;
-				const message = summaryNack?.message;
+				const errorMessage = summaryNack?.message;
 				const retryAfterSeconds = summaryNack?.retryAfter;
 
 				// pre-0.58 error message prefix: summaryNack
-				const error = new LoggingError(`Received summaryNack: ${message}`, {
+				const error = new LoggingError(`Received summaryNack`, {
 					retryAfterSeconds,
+					errorMessage,
 				});
 
 				assert(

package/src/{summaryManager.ts → summary/summaryManager.ts}

@@ -12,8 +12,8 @@ import {
 import { assert } from "@fluidframework/common-utils";
 import { ChildLogger, PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
+import { IThrottler } from "../throttler";
 import { ISummarizerClientElection } from "./summarizerClientElection";
-import { IThrottler } from "./throttler";
 import { ISummarizer, SummarizerStopReason } from "./summarizerTypes";
 import { SummaryCollection } from "./summaryCollection";
 import { Summarizer } from "./summarizer";