@fluidframework/container-runtime 2.23.0 → 2.31.0

package/src/summary/documentSchema.ts

@@ -13,9 +13,7 @@ import { pkgVersion } from "../packageVersion.js";
  * Please note that for all property types we should use undefined to indicate that particular capability is off.
  * Using false, or some string value (like "off") will result in clients who do not understand that property failing, whereas
  * we want them to continue to collaborate alongside clients who support that capability, but such capability is shipping dark for now.
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export type DocumentSchemaValueType = string | string[] | true | number | undefined;
 
@@ -58,9 +56,7 @@ export type IdCompressorMode = "on" | "delayed" | undefined;
  *
  * For now we are limiting it to just plain properties, and only really simple types, but that can be changed in the future.
  *
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export interface IDocumentSchema {
 	// version that describes how data is stored in this structure.
@@ -80,9 +76,7 @@ export interface IDocumentSchema {
  * ContainerMessageType.DocumentSchemaChange messages use CAS (Compare-and-swap) semantics, and convey
  * regSeq of last known schema change (known to a client proposing schema change).
  * @see ContainerRuntimeDocumentSchemaMessage
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export type IDocumentSchemaChangeMessage = IDocumentSchema;
 
@@ -92,9 +86,7 @@ export type IDocumentSchemaChangeMessage = IDocumentSchema;
  * WARNING: This type is used to infer IDocumentSchemaCurrent type!
  * Any changes here (including renaming of properties) are potentially changing document format and should be considered carefully!
  *
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export interface IDocumentSchemaFeatures {
 	// Tells if client uses legacy behavior of changing schema.
@@ -123,17 +115,13 @@ export interface IDocumentSchemaFeatures {
  * This must be bumped whenever the format of document schema or protocol for changing the current document schema changes.
  * Ex: adding a new configuration property (under IDocumentSchema.runtime) does not require changing this version.
  * Ex: Changing the 'document schema acceptance' mechanism from convert-and-swap to one requiring consensus does require changing this version.
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export const currentDocumentVersionSchema = 1;
 
 /**
  * Current document schema.
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export type IDocumentSchemaCurrent = {
@@ -441,9 +429,7 @@ function arrayToProp(arr: string[]): string[] | undefined {
  * Clients can retry, but current implementation is simply - they will not (and will rely on next session / reload to do
  * recalc and decide if schema needs to be changed or not).
  *
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  * @sealed
  */
 export class DocumentsSchemaController {
@@ -614,23 +600,6 @@ export class DocumentsSchemaController {
 		}
 	}
 
-	/**
-	 * Process document schema change message
-	 * Called by ContainerRuntime whenever it sees document schema messages.
-	 * @param content - content of the message
-	 * @param local - whether op is local
-	 * @param sequenceNumber - sequence number of the op
-	 * @returns - true if schema was accepted, otherwise false (rejected due to failed CAS)
-	 * @deprecated It has been replaced by processDocumentSchemaMessages instead.
-	 */
-	public processDocumentSchemaOp(
-		content: IDocumentSchemaChangeMessage,
-		local: boolean,
-		sequenceNumber: number,
-	): boolean {
-		return this.processDocumentSchemaMessages([content], local, sequenceNumber);
-	}
-
 	/**
 	 * Process document schema change messages
 	 * Called by ContainerRuntime whenever it sees document schema messages.

package/src/summary/index.ts

@@ -65,6 +65,11 @@ export {
 	SubmitSummaryFailureData,
 	SummaryStage,
 	IRetriableFailureError,
+	type ISummaryConfiguration,
+	type ISummaryConfigurationDisableHeuristics,
+	type ISummaryConfigurationDisableSummarizer,
+	type ISummaryConfigurationHeuristics,
+	type ISummaryBaseConfiguration,
 } from "./summarizerTypes.js";
 export {
 	IAckedSummary,
@@ -103,6 +108,13 @@ export {
 	IFluidDataStoreAttributes2,
 	OmitAttributesVersions,
 } from "./summaryFormat.js";
+export {
+	formCreateSummarizerFn,
+	validateSummaryHeuristicConfiguration,
+	summarizerRequestUrl,
+	DefaultSummaryConfiguration,
+	isSummariesDisabled,
+} from "./summaryHelpers.js";
 export {
 	IdCompressorMode,
 	IDocumentSchemaCurrent,

package/src/summary/orderedClientElection.ts

@@ -271,9 +271,7 @@ export interface IOrderedClientElectionEvents extends IEvent {
 
 /**
  * Serialized state of IOrderedClientElection.
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export interface ISerializedElection {
 	/**

package/src/summary/runWhileConnectedCoordinator.ts

@@ -6,16 +6,13 @@
 import type { SummarizerStopReason } from "@fluidframework/container-runtime-definitions/internal";
 import { assert, Deferred } from "@fluidframework/core-utils/internal";
 
-// eslint-disable-next-line import/no-deprecated
 import { IConnectableRuntime, ISummaryCancellationToken } from "./summarizerTypes.js";
 
 /**
  * Similar to AbortController, but using promise instead of events
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
-// eslint-disable-next-line import/no-deprecated
+
 export interface ICancellableSummarizerController extends ISummaryCancellationToken {
 	stop(reason: SummarizerStopReason): void;
 }
@@ -25,7 +22,7 @@ export interface ICancellableSummarizerController extends ISummaryCancellationTo
  * This object implements ISummaryCancellationToken interface but cancellation is never leveraged.
  * @internal
  */
-// eslint-disable-next-line import/no-deprecated
+
 export const neverCancelledSummaryToken: ISummaryCancellationToken = {
 	cancelled: false,
 	waitCancelled: new Promise(() => {}),
@@ -68,7 +65,6 @@ export class RunWhileConnectedCoordinator implements ICancellableSummarizerContr
 	}
 
 	public static async create(
-		// eslint-disable-next-line import/no-deprecated
 		runtime: IConnectableRuntime,
 		active: () => boolean,
 	): Promise<RunWhileConnectedCoordinator> {
@@ -78,7 +74,6 @@ export class RunWhileConnectedCoordinator implements ICancellableSummarizerContr
 	}
 
 	protected constructor(
-		// eslint-disable-next-line import/no-deprecated
 		private readonly runtime: IConnectableRuntime,
 		private readonly active: () => boolean,
 	) {}

package/src/summary/runningSummarizer.ts

@@ -26,17 +26,15 @@ import {
 	type ITelemetryLoggerExt,
 } from "@fluidframework/telemetry-utils/internal";
 
-import { ISummaryConfiguration } from "../containerRuntime.js";
 import { opSize } from "../opProperties.js";
 
 import { SummarizeHeuristicRunner } from "./summarizerHeuristics.js";
-import {
+import type {
+	ISummaryConfiguration,
 	EnqueueSummarizeResult,
 	IEnqueueSummarizeOptions,
 	IOnDemandSummarizeOptions,
-	// eslint-disable-next-line import/no-deprecated
 	IRefreshSummaryAckOptions,
-	// eslint-disable-next-line import/no-deprecated
 	ISubmitSummaryOptions,
 	ISummarizeHeuristicData,
 	ISummarizeHeuristicRunner,
@@ -44,12 +42,10 @@ import {
 	ISummarizeResults,
 	ISummarizeRunnerTelemetry,
 	ISummarizeTelemetryProperties,
-	// eslint-disable-next-line import/no-deprecated
 	ISummarizerRuntime,
-	// eslint-disable-next-line import/no-deprecated
 	ISummaryCancellationToken,
 	SubmitSummaryResult,
-	type IRetriableFailureError,
+	IRetriableFailureError,
 } from "./summarizerTypes.js";
 import {
 	IAckedSummary,
@@ -92,16 +88,16 @@ export class RunningSummarizer
 		logger: ITelemetryBaseLogger,
 		summaryWatcher: IClientSummaryWatcher,
 		configuration: ISummaryConfiguration,
-		// eslint-disable-next-line import/no-deprecated
+
 		submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,
-		// eslint-disable-next-line import/no-deprecated
+
 		refreshLatestSummaryAckCallback: (options: IRefreshSummaryAckOptions) => Promise<void>,
 		heuristicData: ISummarizeHeuristicData,
 		summaryCollection: SummaryCollection,
-		// eslint-disable-next-line import/no-deprecated
+
 		cancellationToken: ISummaryCancellationToken,
 		stopSummarizerCallback: (reason: SummarizerStopReason) => void,
-		// eslint-disable-next-line import/no-deprecated
+
 		runtime: ISummarizerRuntime,
 	): Promise<RunningSummarizer> {
 		const summarizer = new RunningSummarizer(
@@ -218,19 +214,17 @@ export class RunningSummarizer
 		private readonly summaryWatcher: IClientSummaryWatcher,
 		private readonly configuration: ISummaryConfiguration,
 		private readonly submitSummaryCallback: (
-			// eslint-disable-next-line import/no-deprecated
 			options: ISubmitSummaryOptions,
 		) => Promise<SubmitSummaryResult>,
 		private readonly refreshLatestSummaryAckCallback: (
-			// eslint-disable-next-line import/no-deprecated
 			options: IRefreshSummaryAckOptions,
 		) => Promise<void>,
 		private readonly heuristicData: ISummarizeHeuristicData,
 		private readonly summaryCollection: SummaryCollection,
-		// eslint-disable-next-line import/no-deprecated
+
 		private readonly cancellationToken: ISummaryCancellationToken,
 		private readonly stopSummarizerCallback: (reason: SummarizerStopReason) => void,
-		// eslint-disable-next-line import/no-deprecated
+
 		private readonly runtime: ISummarizerRuntime,
 	) {
 		super();
@@ -308,7 +302,7 @@ export class RunningSummarizer
 			() => {
 				this.totalSuccessfulAttempts++;
 			},
-			// eslint-disable-next-line import/no-deprecated
+
 			async (options: IRefreshSummaryAckOptions) => {
 				if (immediatelyRefreshLatestSummaryAck) {
 					await this.refreshLatestSummaryAckAndHandleError(options);
@@ -357,7 +351,6 @@ export class RunningSummarizer
 		await this.lockedSummaryAction(
 			() => {},
 			async () => {
-				// eslint-disable-next-line import/no-deprecated
 				const options: IRefreshSummaryAckOptions = {
 					proposalHandle: summaryOpHandle,
 					ackHandle: summaryAckHandle,
@@ -371,7 +364,6 @@ export class RunningSummarizer
 	}
 
 	private readonly refreshLatestSummaryAckAndHandleError = async (
-		// eslint-disable-next-line import/no-deprecated
 		options: IRefreshSummaryAckOptions,
 	): Promise<void> => {
 		return this.refreshLatestSummaryAckCallback(options).catch(async (error) => {
@@ -647,7 +639,7 @@ export class RunningSummarizer
 					logger: this.mc.logger,
 					properties: { all: summarizeProps },
 				});
-				// eslint-disable-next-line import/no-deprecated
+
 				const summaryOptions: ISubmitSummaryOptions = {
 					...options,
 					summaryLogger,
@@ -764,7 +756,7 @@ export class RunningSummarizer
 				logger: this.mc.logger,
 				properties: { all: summarizeProps },
 			});
-			// eslint-disable-next-line import/no-deprecated
+
 			const summaryOptions: ISubmitSummaryOptions = {
 				...summarizeOptions,
 				summaryLogger,

package/src/summary/summarizer.ts

@@ -19,38 +19,31 @@ import {
 	wrapErrorAndLog,
 } from "@fluidframework/telemetry-utils/internal";
 
-import { ISummaryConfiguration } from "../containerRuntime.js";
-
-// eslint-disable-next-line import/no-deprecated
 import { ICancellableSummarizerController } from "./runWhileConnectedCoordinator.js";
 import { RunningSummarizer } from "./runningSummarizer.js";
 import { SummarizeHeuristicData } from "./summarizerHeuristics.js";
 import {
 	EnqueueSummarizeResult,
-	// eslint-disable-next-line import/no-deprecated
 	IConnectableRuntime,
 	IEnqueueSummarizeOptions,
 	IOnDemandSummarizeOptions,
 	ISummarizeHeuristicData,
 	ISummarizeResults,
 	ISummarizer,
-	// eslint-disable-next-line import/no-deprecated
 	ISummarizerInternalsProvider,
-	// eslint-disable-next-line import/no-deprecated
 	ISummarizerRuntime,
 	ISummarizingWarning,
 	type IRetriableFailureError,
+	type ISummaryConfiguration,
 } from "./summarizerTypes.js";
 import { SummaryCollection } from "./summaryCollection.js";
 import { SummarizeResultBuilder } from "./summaryGenerator.js";
 
-const summarizingError = "summarizingError";
-
 export class SummarizingWarning
 	extends LoggingError
 	implements ISummarizingWarning, IFluidErrorBase
 {
-	readonly errorType = summarizingError;
+	readonly errorType = "summarizingError";
 	readonly canRetry = true;
 
 	constructor(
@@ -80,9 +73,7 @@ export const createSummarizingWarning = (
  * Summarizer is responsible for coordinating when to generate and send summaries.
  * It is the main entry point for summary work.
  * It is created only by summarizing container (i.e. one with clientType === "summarizer")
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
 	public get ISummarizer(): this {
@@ -101,21 +92,19 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 		 * Reference to runtime that created this object.
 		 * i.e. runtime with clientType === "summarizer"
 		 */
-		// eslint-disable-next-line import/no-deprecated
+
 		private readonly runtime: ISummarizerRuntime,
 		private readonly configurationGetter: () => ISummaryConfiguration,
 		/**
 		 * Represents an object that can generate summary.
 		 * In practical terms, it's same runtime (this.runtime) with clientType === "summarizer".
 		 */
-		// eslint-disable-next-line import/no-deprecated
+
 		private readonly internalsProvider: ISummarizerInternalsProvider,
 		handleContext: IFluidHandleContext,
 		public readonly summaryCollection: SummaryCollection,
 		private readonly runCoordinatorCreateFn: (
-			// eslint-disable-next-line import/no-deprecated
 			runtime: IConnectableRuntime,
-			// eslint-disable-next-line import/no-deprecated
 		) => Promise<ICancellableSummarizerController>,
 	) {
 		super();
@@ -165,7 +154,6 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 	}
 
 	private async runCore(onBehalfOf: string): Promise<SummarizerStopReason> {
-		// eslint-disable-next-line import/no-deprecated
 		const runCoordinator: ICancellableSummarizerController = await this.runCoordinatorCreateFn(
 			this.runtime,
 		);
@@ -251,7 +239,7 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 	 */
 	private async start(
 		onBehalfOf: string,
-		// eslint-disable-next-line import/no-deprecated
+
 		runCoordinator: ICancellableSummarizerController,
 	): Promise<RunningSummarizer> {
 		if (this.runningSummarizer) {

package/src/summary/summarizerClientElection.ts

@@ -11,7 +11,6 @@ import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
 import {
 	IOrderedClientElection,
-	// eslint-disable-next-line import/no-deprecated
 	ISerializedElection,
 	ITrackedClient,
 } from "./orderedClientElection.js";
@@ -120,7 +119,6 @@ export class SummarizerClientElection
 		});
 	}
 
-	// eslint-disable-next-line import/no-deprecated
 	public serialize(): ISerializedElection {
 		const { electedClientId, electedParentId, electionSequenceNumber } =
 			this.clientElection.serialize();

package/src/summary/summarizerHeuristics.ts

@@ -6,8 +6,7 @@
 import { Timer } from "@fluidframework/core-utils/internal";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
-import { ISummaryConfigurationHeuristics } from "../containerRuntime.js";
-
+import type { ISummaryConfigurationHeuristics } from "./summarizerTypes.js";
 import {
 	ISummarizeAttempt,
 	ISummarizeHeuristicData,

package/src/summary/summarizerNode/summarizerNode.ts

@@ -11,6 +11,7 @@ import {
 	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
 import {
+	channelsTreeName,
 	IExperimentalIncrementalSummaryContext,
 	ITelemetryContext,
 	CreateChildSummarizerNodeParam,
@@ -32,7 +33,6 @@ import {
 } from "@fluidframework/telemetry-utils/internal";
 
 import {
-	EscapedPath,
 	ICreateChildDetails,
 	IRefreshSummaryResult,
 	IStartSummaryResult,
@@ -70,7 +70,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 	 * (this getter is primarily only used in the test code)
 	 */
 	public get summaryHandleId(): string {
-		return this._summaryHandleId.toString();
+		return this._summaryHandleId;
 	}
 
 	protected readonly children = new Map<string, SummarizerNode>();
@@ -101,7 +101,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 		/**
 		 * Encoded handle or path to the node
 		 */
-		private readonly _summaryHandleId: EscapedPath,
+		private readonly _summaryHandleId: string,
 		private _changeSequenceNumber: number,
 		/**
 		 * Summary reference sequence number, i.e. last sequence number seen when last successful summary was created
@@ -591,7 +591,8 @@ export class SummarizerNode implements IRootSummarizerNode {
 		}
 
 		const childTelemetryNodeId = `${this.telemetryNodeId ?? ""}/${id}`;
-		const childSummaryHandleId = this._summaryHandleId.createChildPath(EscapedPath.create(id));
+		// parentHandleId/.channels/childId
+		const childSummaryHandleId = `${this._summaryHandleId}/${channelsTreeName}/${id}`;
 
 		return {
 			changeSequenceNumber,
@@ -671,7 +672,7 @@ export const createRootSummarizerNode = (
 		logger,
 		summarizeInternalFn,
 		config,
-		EscapedPath.create("") /* summaryHandleId */,
+		"" /* summaryHandleId */,
 		changeSequenceNumber,
 		referenceSequenceNumber,
 		undefined /* wipSummaryLogger */,

package/src/summary/summarizerNode/summarizerNodeUtils.ts

@@ -5,7 +5,6 @@
 
 import { SummaryObject } from "@fluidframework/driver-definitions";
 import { ISnapshotTree } from "@fluidframework/driver-definitions/internal";
-import { channelsTreeName } from "@fluidframework/runtime-definitions/internal";
 import {
 	ITelemetryLoggerExt,
 	TelemetryDataTag,
@@ -80,31 +79,6 @@ export interface ISummarizerNodeRootContract {
 	): Promise<IRefreshSummaryResult>;
 }
 
-/**
- * Class to build paths for nodes in a tree with escaped special characters
- */
-export class EscapedPath {
-	private constructor(public readonly path: string) {}
-
-	/**
-	 * Creates and returns a new instance of this class.
-	 * @param path - Id or path part of a node
-	 */
-	public static create(path: string): EscapedPath {
-		return new EscapedPath(encodeURIComponent(path));
-	}
-	public toString(): string {
-		return this.path;
-	}
-	/**
-	 * Creates and returns a new instance of this class for child of the current node.
-	 */
-	public createChildPath(childNodePath: EscapedPath): EscapedPath {
-		return new EscapedPath(
-			`${this.path}/${encodeURIComponent(channelsTreeName)}/${childNodePath.path}`,
-		);
-	}
-}
 export interface PendingSummaryInfo {
 	/**
 	 * The sequence number at which the summary was created.
@@ -127,7 +101,7 @@ export interface ICreateChildDetails {
 	/**
 	 * Summary handle for child node
 	 */
-	summaryHandleId: EscapedPath;
+	summaryHandleId: string;
 	/**
 	 * the reference sequence number of the last successful summary.
 	 */

package/src/summary/summarizerNode/summarizerNodeWithGc.ts

@@ -24,7 +24,6 @@ import { cloneGCData, unpackChildNodesGCDetails } from "../../gc/index.js";
 
 import { SummarizerNode } from "./summarizerNode.js";
 import {
-	EscapedPath,
 	ICreateChildDetails,
 	IStartSummaryResult,
 	ISummarizerNodeRootContract,
@@ -93,7 +92,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		logger: ITelemetryBaseLogger,
 		summarizeInternalFn: SummarizeInternalFn,
 		config: ISummarizerNodeConfigWithGC,
-		_summaryHandleId: EscapedPath,
+		_summaryHandleId: string,
 		changeSequenceNumber: number,
 		/**
 		 * Summary reference sequence number, i.e. last sequence number seen when it was created
@@ -525,7 +524,7 @@ export const createRootSummarizerNodeWithGC = (
 		logger,
 		summarizeInternalFn,
 		config,
-		EscapedPath.create("") /* summaryHandleId */,
+		"" /* summaryHandleId */,
 		changeSequenceNumber,
 		referenceSequenceNumber,
 		undefined /* wipSummaryLogger */,