@fluidframework/container-runtime 2.13.0 → 2.21.0

package/.eslintrc.cjs

@@ -4,24 +4,90 @@
  */
 
 module.exports = {
-	extends: [
-		require.resolve("@fluidframework/eslint-config-fluid/minimal-deprecated"),
-		"prettier",
-	],
+	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
 	parserOptions: {
 		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
 	},
 	rules: {
 		"@typescript-eslint/strict-boolean-expressions": "off",
+
+		// TODO: fix violations and remove overrides
 		"@fluid-internal/fluid/no-unchecked-record-access": "warn",
+		"require-atomic-updates": "warn",
+		"unicorn/no-array-reduce": "warn",
+
+		// False positives on non-array `push` methods.
+		// TODO:AB#28686: remove this override once this rule has been disabled in the root config.
+		"unicorn/no-array-push-push": "off",
+
+		// #region TODO:AB#3027: remove overrides and upgrade config to `recommended`
+
+		"@typescript-eslint/explicit-function-return-type": [
+			"error",
+			{
+				allowExpressions: true,
+				allowTypedFunctionExpressions: true,
+				allowHigherOrderFunctions: true,
+				allowDirectConstAssertionInArrowFunctions: true,
+				allowConciseArrowFunctionExpressionsStartingWithVoid: false,
+			},
+		],
+		"@typescript-eslint/explicit-module-boundary-types": "error",
+		"@typescript-eslint/no-explicit-any": [
+			"error",
+			{
+				/**
+				 * For certain cases, like rest parameters, any is required to allow arbitrary argument types.
+				 * @see https://typescript-eslint.io/rules/no-explicit-any/#ignorerestargs
+				 */
+				ignoreRestArgs: true,
+			},
+		],
+		"@typescript-eslint/no-unsafe-argument": "error",
+		"@typescript-eslint/no-unsafe-assignment": "error",
+		"@typescript-eslint/no-unsafe-call": "error",
+		"@typescript-eslint/no-unsafe-member-access": "error",
+		"@typescript-eslint/no-unsafe-return": "error",
+
+		"jsdoc/multiline-blocks": ["error", { noSingleLineBlocks: true }],
+		"jsdoc/require-description": ["error", { checkConstructors: false }],
+
+		"unicorn/catch-error-name": "error",
+		"unicorn/consistent-destructuring": "error",
+		"unicorn/consistent-function-scoping": "error",
+		"unicorn/error-message": "error",
+		"unicorn/explicit-length-check": "error",
+		"unicorn/new-for-builtins": "error",
+		"unicorn/no-array-callback-reference": "error",
+		"unicorn/no-array-for-each": "error",
+		"unicorn/no-lonely-if": "error",
+		"unicorn/no-negated-condition": "error",
+		"unicorn/no-new-array": "error",
+		"unicorn/no-null": "error",
+		"unicorn/no-zero-fractions": "error",
+		"unicorn/prefer-includes": "error",
+		"unicorn/prefer-node-protocol": "error",
+		"unicorn/prefer-number-properties": "error",
+		"unicorn/prefer-optional-catch-binding": "error",
+		"unicorn/prefer-spread": "error",
+		"unicorn/prefer-string-slice": "error",
+		"unicorn/switch-case-braces": "error",
+		"unicorn/throw-new-error": "error",
+
+		// #endregion
 	},
 	overrides: [
 		{
 			// Rules only for test files
 			files: ["*.spec.ts", "src/test/**"],
 			rules: {
+				// TODO: remove these overrides and fix violations
+				"@typescript-eslint/explicit-function-return-type": "warn",
+				"unicorn/consistent-function-scoping": "warn",
+				"unicorn/error-message": "warn",
+
 				// Test files are run in node only so additional node libraries can be used.
-				"import/no-nodejs-modules": ["error", { allow: ["assert", "crypto"] }],
+				"import/no-nodejs-modules": ["error", { allow: ["node:assert", "node:crypto"] }],
 			},
 		},
 	],

package/CHANGELOG.md

@@ -1,5 +1,89 @@
 # @fluidframework/container-runtime
 
+## 2.21.0
+
+### Minor Changes
+
+-   Many unnecessary exports have been deprecated in the container-runtime package ([#23607](https://github.com/microsoft/FluidFramework/pull/23607)) [3da5b427ef](https://github.com/microsoft/FluidFramework/commit/3da5b427ef406799abade04196e43bb6d66d898d)
+
+    The following types in the `@fluidframework/container-runtime` package are now deprecated. These types are unnecessary for external users of this package.
+
+    -   currentDocumentVersionSchema
+    -   DeletedResponseHeaderKey
+    -   DocumentSchemaValueType
+    -   DocumentsSchemaController
+    -   GCFeatureMatrix
+    -   GCNodeType
+    -   GCVersion
+    -   IBlobManagerLoadInfo
+    -   ICancellableSummarizerController
+    -   ICancellationToken
+    -   IConnectableRuntime
+    -   IContainerRuntimeMetadata
+    -   ICreateContainerMetadata
+    -   IDocumentSchema
+    -   IDocumentSchemaChangeMessage
+    -   IDocumentSchemaCurrent
+    -   IDocumentSchemaFeatures
+    -   IGCMetadata
+    -   IGCStats
+    -   IMarkPhaseStats
+    -   IRefreshSummaryAckOptions
+    -   ISerializedElection
+    -   ISubmitSummaryOptions
+    -   ISummarizerInternalsProvider
+    -   ISummarizerRuntime
+    -   ISummaryCancellationToken
+    -   ISummaryMetadataMessage
+    -   ISweepPhaseStats
+    -   Summarizer
+
+## 2.20.0
+
+### Minor Changes
+
+-   The ContainerRuntime class has been removed ([#23341](https://github.com/microsoft/FluidFramework/pull/23341)) [61ba06aa98](https://github.com/microsoft/FluidFramework/commit/61ba06aa9881c30ffeeedcaaede9c5a1a0c81abd)
+
+    The `ContainerRuntime` class was [deprecated in version 2.12.0](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.12.0#user-content-the-containerruntime-class-is-now-deprecated-23331) and has been removed.
+    Use `IContainerRuntime` to replace type usages and use the free function `loadContainerRuntime` to replace usages of the static method `ContainerRuntime.loadRuntime`.
+
+    See the [deprecation
+    announcement](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.12.0#user-content-the-containerruntime-class-is-now-deprecated-23331)
+    for more details about how to update existing code.
+
+-   The IContainerRuntimeOptions.flushMode property has been removed ([#23337](https://github.com/microsoft/FluidFramework/pull/23337)) [fe8279c774](https://github.com/microsoft/FluidFramework/commit/fe8279c774fcc3c4805b49ce4f64d0e03a64c39b)
+
+    The `IContainerRuntimeOptions.flushMode` property was [deprecated in version 2.12.0](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.12.0#user-content-icontainerruntimeoptionsflushmode-is-now-deprecated-23288) and has been removed.
+
+    Only the default value, `FlushMode.TurnBased`, is supported when calling `ContainerRuntime.loadRuntime` directly,
+    so there's no need for consumers to pass this option in.
+
+-   The createDataStoreWithProps APIs on ContainerRuntime and IContainerRuntimeBase have been removed ([#22996](https://github.com/microsoft/FluidFramework/pull/22996)) [bd243fb292](https://github.com/microsoft/FluidFramework/commit/bd243fb2927915d87c42486e21ee0c990962a9a7)
+
+    `ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps`
+    were [deprecated in version 0.25.0](https://github.com/microsoft/FluidFramework/blob/main/BREAKING.md#icontainerruntimebase_createdatastorewithprops-is-removed) and have been removed.
+
+    Replace uses of these APIs with `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState`
+    parameter.
+
+    These changes were originally announced in version 0.25.0. See the following issues for more details:
+
+    -   [#1537](https://github.com/microsoft/FluidFramework/issues/1537)
+    -   [#2931](https://github.com/microsoft/FluidFramework/pull/2931)
+
+-   Enabling Op Compression without Op Grouping is no longer supported ([#23608](https://github.com/microsoft/FluidFramework/pull/23608)) [92b695aa4b](https://github.com/microsoft/FluidFramework/commit/92b695aa4b36eee41a4d235a71c6408d2c70b54b)
+
+    `IContainerRuntimeOptions.enableGroupedBatching` was deprecated in 2.12 (see [release notes](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.12.0#user-content-icontainerruntimeoptionsenablegroupedbatching-is-now-deprecated-23260)).
+    While this option is not yet removed (and still defaults to `true`), disabling it (by setting to `false`) is not supported
+    if compression is enabled (by passing a finite value for `IContainerRuntimeOptions.compressionOptions.minimumBatchSizeInBytes`).
+
+-   Summarizer-related types have been moved to container-runtime-definitions ([#23483](https://github.com/microsoft/FluidFramework/pull/23483)) [6666d496e6](https://github.com/microsoft/FluidFramework/commit/6666d496e63031026cdedee98c24bb59fa79edcf)
+
+    `SummarizerStopReason`, `ISummarizeEventProps`, and `ISummarizerEvents` have all been moved from the
+    `"@fluidframework/container-runtime"` package to `@fluidframework/container-runtime-definitions`.
+
+    Users should now import them from `@fluidframework/container-runtime-definitions`.
+
 ## 2.13.0
 
 Dependency updates only.

package/api-report/container-runtime.legacy.alpha.api.md

@@ -33,168 +33,21 @@ export enum ContainerMessageType {
 }
 
 // @alpha @deprecated
-export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents> implements IContainerRuntime, IRuntime, ISummarizerRuntime, ISummarizerInternalsProvider, IProvideFluidHandleContext {
-    protected constructor(context: IContainerContext, registry: IFluidDataStoreRegistry, metadata: IContainerRuntimeMetadata | undefined, electedSummarizerData: ISerializedElection | undefined, chunks: [string, string[]][], dataStoreAliasMap: [string, string][], runtimeOptions: Readonly<Required<Omit<IContainerRuntimeOptions, "flushMode" | "enableGroupedBatching">> & IContainerRuntimeOptions>, containerScope: FluidObject, baseLogger: ITelemetryBaseLogger, existing: boolean, blobManagerSnapshot: IBlobManagerLoadInfo, _storage: IDocumentStorageService, createIdCompressor: () => Promise<IIdCompressor & IIdCompressorCore>, documentsSchemaController: DocumentsSchemaController, featureGatesForTelemetry: Record<string, boolean | number | undefined>, provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>, requestHandler?: ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>) | undefined, summaryConfiguration?: ISummaryConfiguration, recentBatchInfo?: [number, string][]);
-    // (undocumented)
-    protected addContainerStateToSummary(summaryTree: ISummaryTreeWithStats, fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext): void;
-    addedGCOutboundRoute(fromPath: string, toPath: string, messageTimestampMs?: number): void;
-    // (undocumented)
-    get attachState(): AttachState;
-    // (undocumented)
-    readonly baseLogger: ITelemetryBaseLogger;
-    // (undocumented)
-    readonly clientDetails: IClientDetails;
-    // (undocumented)
-    get clientId(): string | undefined;
-    // (undocumented)
-    readonly closeFn: (error?: ICriticalContainerError) => void;
-    collectGarbage(options: {
-        logger?: ITelemetryLoggerExt;
-        runSweep?: boolean;
-        fullGC?: boolean;
-    }, telemetryContext?: ITelemetryContext): Promise<IGCStats | undefined>;
-    // (undocumented)
-    get connected(): boolean;
-    // (undocumented)
-    get containerRuntime(): this;
-    // (undocumented)
-    createDataStore(pkg: Readonly<string | string[]>, loadingGroupId?: string): Promise<IDataStore>;
-    // @deprecated (undocumented)
-    _createDataStoreWithProps(pkg: Readonly<string | string[]>, props?: any): Promise<IDataStore>;
-    // (undocumented)
-    createDetachedDataStore(pkg: Readonly<string[]>, loadingGroupId?: string): IFluidDataStoreContextDetached;
-    createSummary(blobRedirectTable?: Map<string, string>, telemetryContext?: ITelemetryContext): ISummaryTree;
-    // (undocumented)
-    deleteChildSummarizerNode(id: string): void;
-    deleteSweepReadyNodes(sweepReadyRoutes: readonly string[]): readonly string[];
-    get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
-    // (undocumented)
-    dispose(error?: Error): void;
-    // (undocumented)
-    get disposed(): boolean;
-    // (undocumented)
-    readonly disposeFn: (error?: ICriticalContainerError) => void;
-    // (undocumented)
-    enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult;
-    ensureNoDataModelChanges<T>(callback: () => T): T;
-    // (undocumented)
-    get flushMode(): FlushMode;
-    // @deprecated
-    get gcThrowOnTombstoneUsage(): boolean;
-    // @deprecated
-    get gcTombstoneEnforcementAllowed(): boolean;
-    generateDocumentUniqueId(): string | (number & {
-        readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
-    } & {
-        readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
-    });
-    // (undocumented)
-    readonly getAbsoluteUrl: (relativeUrl: string) => Promise<string | undefined>;
-    getAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;
-    // (undocumented)
-    getAudience(): IAudience;
-    // (undocumented)
-    getCreateChildSummarizerNodeFn(id: string, createParam: CreateChildSummarizerNodeParam): (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>) => ISummarizerNodeWithGC;
-    getCurrentReferenceTimestampMs(): number | undefined;
-    getEntryPoint(): Promise<FluidObject>;
-    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
-    getGCNodePackagePath(nodePath: string): Promise<readonly string[] | undefined>;
-    getNodeType(nodePath: string): GCNodeType;
-    // (undocumented)
-    getPendingLocalState(props?: IGetPendingLocalStateProps): unknown;
-    // (undocumented)
-    getQuorum(): IQuorumClients;
-    getSnapshotForLoadingGroupId(loadingGroupIds: string[], pathParts: string[]): Promise<{
-        snapshotTree: ISnapshotTree;
-        sequenceNumber: number;
-    }>;
-    get idCompressor(): (IIdCompressor & IIdCompressorCore) | undefined;
-    // (undocumented)
-    get idCompressorMode(): IdCompressorMode;
-    // (undocumented)
-    get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
-    // (undocumented)
-    get IFluidHandleContext(): IFluidHandleContext;
-    get isDirty(): boolean;
-    protected _loadIdCompressor: Promise<void> | undefined;
-    static loadRuntime(params: {
-        context: IContainerContext;
-        registryEntries: NamedFluidDataStoreRegistryEntries;
-        existing: boolean;
-        runtimeOptions?: IContainerRuntimeOptions;
-        containerScope?: FluidObject;
-        containerRuntimeCtor?: typeof ContainerRuntime;
-        requestHandler?: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>;
-        provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>;
-    }): Promise<ContainerRuntime>;
-    // (undocumented)
-    makeLocallyVisible(): void;
-    // (undocumented)
-    notifyOpReplay(message: ISequencedDocumentMessage): Promise<void>;
-    // (undocumented)
-    onSchemaChange(schema: IDocumentSchemaCurrent): void;
-    // (undocumented)
-    readonly options: Record<string | number, any>;
-    orderSequentially<T>(callback: () => T): T;
-    process({ ...messageCopy }: ISequencedDocumentMessage, local: boolean): void;
-    // (undocumented)
-    processSignal(message: ISignalMessage, local: boolean): void;
-    refreshLatestSummaryAck(options: IRefreshSummaryAckOptions): Promise<void>;
-    resolveHandle(request: IRequest): Promise<IResponse>;
-    // (undocumented)
-    get scope(): FluidObject;
-    get sessionSchema(): {
-        explicitSchemaControl?: true | undefined;
-        compressionLz4?: true | undefined;
-        idCompressorMode?: IdCompressorMode;
-        opGroupingEnabled?: true | undefined;
-        disallowedVersions?: string[] | undefined;
-    };
-    // (undocumented)
-    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
-    // (undocumented)
-    setChannelDirty(address: string): void;
-    // (undocumented)
-    setConnectionState(connected: boolean, clientId?: string): void;
-    // (undocumented)
-    get storage(): IDocumentStorageService;
-    // (undocumented)
-    submitMessage(type: ContainerMessageType.FluidDataStoreOp | ContainerMessageType.Alias | ContainerMessageType.Attach, contents: any, localOpMetadata?: unknown): void;
-    submitSignal(type: string, content: unknown, targetClientId?: string): void;
-    submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
-    summarize(options: {
-        fullTree?: boolean;
-        trackState?: boolean;
-        summaryLogger?: ITelemetryLoggerExt;
-        runGC?: boolean;
-        fullGC?: boolean;
-        runSweep?: boolean;
-    }): Promise<ISummaryTreeWithStats>;
-    // (undocumented)
-    summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
-    get summarizerClientId(): string | undefined;
-    updateTombstonedRoutes(tombstonedRoutes: readonly string[]): void;
-    updateUsedRoutes(usedRoutes: readonly string[]): void;
-    // (undocumented)
-    uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandleInternal<ArrayBufferLike>>;
-}
-
-// @alpha
 export const currentDocumentVersionSchema = 1;
 
 // @alpha (undocumented)
 export const DefaultSummaryConfiguration: ISummaryConfiguration;
 
-// @alpha
+// @alpha @deprecated
 export const DeletedResponseHeaderKey = "wasDeleted";
 
 // @alpha (undocumented)
 export const disabledCompressionConfig: ICompressionRuntimeOptions;
 
-// @alpha
+// @alpha @deprecated
 export type DocumentSchemaValueType = string | string[] | true | number | undefined;
 
-// @alpha @sealed
+// @alpha @sealed @deprecated
 export class DocumentsSchemaController {
     constructor(existing: boolean, snapshotSequenceNumber: number, documentMetadataSchema: IDocumentSchema | undefined, features: IDocumentSchemaFeatures, onSchemaChange: (schema: IDocumentSchemaCurrent) => void);
     maybeSendSchemaMessage(): IDocumentSchemaChangeMessage | undefined;
@@ -220,7 +73,7 @@ export type EnqueueSummarizeResult = (ISummarizeResults & {
     readonly overridden?: undefined;
 };
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export type GCFeatureMatrix = {
     gcGeneration?: number;
     tombstoneGeneration?: undefined;
@@ -228,7 +81,7 @@ export type GCFeatureMatrix = {
     tombstoneGeneration: number;
 };
 
-// @alpha
+// @alpha @deprecated
 export const GCNodeType: {
     readonly DataStore: "DataStore";
     readonly SubDataStore: "SubDataStore";
@@ -236,10 +89,10 @@ export const GCNodeType: {
     readonly Other: "Other";
 };
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export type GCVersion = number;
 
 // @alpha
@@ -268,7 +121,7 @@ export interface IBaseSummarizeResult {
     readonly stage: "base";
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IBlobManagerLoadInfo {
     // (undocumented)
     ids?: string[];
@@ -284,13 +137,13 @@ export interface IBroadcastSummaryResult {
     readonly summarizeOp: ISummaryOpMessage;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface ICancellableSummarizerController extends ISummaryCancellationToken {
     // (undocumented)
-    stop(reason: SummarizerStopReason_2): void;
+    stop(reason: SummarizerStopReason): void;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface ICancellationToken<T> {
     readonly cancelled: boolean;
     readonly waitCancelled: Promise<T>;
@@ -310,7 +163,7 @@ export interface ICompressionRuntimeOptions {
     readonly minimumBatchSizeInBytes: number;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export interface IConnectableRuntime {
     // (undocumented)
     readonly clientId: string | undefined;
@@ -322,7 +175,7 @@ export interface IConnectableRuntime {
     once(event: "connected" | "disconnected" | "dispose", listener: () => void): this;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
     readonly disableIsolatedChannels?: true;
     // (undocumented)
@@ -344,8 +197,6 @@ export interface IContainerRuntimeOptions {
     readonly enableGroupedBatching?: boolean;
     readonly enableRuntimeIdCompressor?: IdCompressorMode;
     readonly explicitSchemaControl?: boolean;
-    // @deprecated
-    readonly flushMode?: FlushMode;
     // (undocumented)
     readonly gcOptions?: IGCRuntimeOptions;
     readonly loadSequenceNumberVerification?: "close" | "log" | "bypass";
@@ -354,7 +205,7 @@ export interface IContainerRuntimeOptions {
     readonly summaryOptions?: ISummaryRuntimeOptions;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export interface ICreateContainerMetadata {
     createContainerRuntimeVersion?: string;
     createContainerTimestamp?: number;
@@ -363,7 +214,7 @@ export interface ICreateContainerMetadata {
 // @alpha
 export type IdCompressorMode = "on" | "delayed" | undefined;
 
-// @alpha
+// @alpha @deprecated
 export interface IDocumentSchema {
     // (undocumented)
     refSeq: number;
@@ -373,10 +224,10 @@ export interface IDocumentSchema {
     version: number;
 }
 
-// @alpha
+// @alpha @deprecated
 export type IDocumentSchemaChangeMessage = IDocumentSchema;
 
-// @alpha
+// @alpha @deprecated
 export type IDocumentSchemaCurrent = {
     version: 1;
     refSeq: number;
@@ -385,7 +236,7 @@ export type IDocumentSchemaCurrent = {
     };
 };
 
-// @alpha
+// @alpha @deprecated
 export interface IDocumentSchemaFeatures {
     // (undocumented)
     compressionLz4: boolean;
@@ -431,7 +282,7 @@ export interface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFlui
     readonly summaryFormatVersion: 2;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IGCMetadata {
     readonly gcFeature?: GCVersion;
     readonly gcFeatureMatrix?: GCFeatureMatrix;
@@ -450,7 +301,7 @@ export interface IGCRuntimeOptions {
     sweepGracePeriodMs?: number;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {
 }
 
@@ -473,7 +324,7 @@ export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "
     readonly summaryTree: ISummaryTree;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IMarkPhaseStats {
     attachmentBlobCount: number;
     dataStoreCount: number;
@@ -503,7 +354,7 @@ export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
     readonly retryOnFailure?: boolean;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IRefreshSummaryAckOptions {
     readonly ackHandle: string;
     readonly proposalHandle: string | undefined;
@@ -517,7 +368,7 @@ export interface IRetriableFailureError extends Error {
     readonly retryAfterSeconds?: number;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface ISerializedElection {
     readonly electedClientId: string | undefined;
     readonly electedParentId: string | undefined;
@@ -532,7 +383,7 @@ export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stag
     readonly submitOpDuration: number;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export interface ISubmitSummaryOptions extends ISummarizeOptions {
     readonly cancellationToken: ISummaryCancellationToken;
     readonly finalAttempt?: boolean;
@@ -540,33 +391,21 @@ export interface ISubmitSummaryOptions extends ISummarizeOptions {
     readonly summaryLogger: ITelemetryLoggerExt;
 }
 
-// @alpha @deprecated (undocumented)
-export interface ISummarizeEventProps {
-    // (undocumented)
-    currentAttempt: number;
-    // (undocumented)
-    error?: any;
-    // (undocumented)
-    maxAttempts: number;
-    // (undocumented)
-    result: "success" | "failure" | "canceled";
-}
-
 // @alpha
 export interface ISummarizeOptions {
     readonly fullTree?: boolean;
 }
 
 // @alpha (undocumented)
-export interface ISummarizer extends IEventProvider<ISummarizerEvents_2> {
+export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
     // (undocumented)
     close(): void;
     enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult;
     readonly ISummarizer?: ISummarizer;
     // (undocumented)
-    run(onBehalfOf: string): Promise<SummarizerStopReason_2>;
+    run(onBehalfOf: string): Promise<SummarizerStopReason>;
     // (undocumented)
-    stop(reason: SummarizerStopReason_2): void;
+    stop(reason: SummarizerStopReason): void;
     summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
 }
 
@@ -578,18 +417,12 @@ export interface ISummarizeResults {
 }
 
 // @alpha @deprecated (undocumented)
-export interface ISummarizerEvents extends IEvent {
-    // (undocumented)
-    (event: "summarize", listener: (props: ISummarizeEventProps) => void): any;
-}
-
-// @alpha (undocumented)
 export interface ISummarizerInternalsProvider {
     refreshLatestSummaryAck(options: IRefreshSummaryAckOptions): Promise<void>;
     submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export interface ISummarizerRuntime extends IConnectableRuntime {
     // (undocumented)
     readonly baseLogger: ITelemetryBaseLogger;
@@ -633,8 +466,8 @@ export interface ISummaryBaseConfiguration {
     maxOpsSinceLastSummary: number;
 }
 
-// @alpha
-export type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason_2>;
+// @alpha @deprecated
+export type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
 
 // @alpha (undocumented)
 export interface ISummaryCollectionOpEvents extends IEvent {
@@ -671,7 +504,7 @@ export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfigurati
     state: "enabled";
 }
 
-// @alpha
+// @alpha @deprecated
 export type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage, "clientId" | "clientSequenceNumber" | "minimumSequenceNumber" | "referenceSequenceNumber" | "sequenceNumber" | "timestamp" | "type">;
 
 // @alpha
@@ -697,7 +530,7 @@ export interface ISummaryRuntimeOptions {
     summaryConfigOverrides?: ISummaryConfiguration;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface ISweepPhaseStats {
     deletedAttachmentBlobCount: number;
     deletedDataStoreCount: number;
@@ -751,8 +584,8 @@ export interface SubmitSummaryFailureData {
 // @alpha
 export type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult;
 
-// @alpha
-export class Summarizer extends TypedEventEmitter<ISummarizerEvents_2> implements ISummarizer {
+// @alpha @deprecated
+export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
     constructor(
     runtime: ISummarizerRuntime, configurationGetter: () => ISummaryConfiguration,
     internalsProvider: ISummarizerInternalsProvider, handleContext: IFluidHandleContext, summaryCollection: SummaryCollection, runCoordinatorCreateFn: (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>);
@@ -766,9 +599,9 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents_2> implement
     // (undocumented)
     recordSummaryAttempt?(summaryRefSeqNum?: number): void;
     // (undocumented)
-    run(onBehalfOf: string): Promise<SummarizerStopReason_2>;
-    stop(reason: SummarizerStopReason_2): void;
-    static stopReasonCanRunLastSummary(stopReason: SummarizerStopReason_2): boolean;
+    run(onBehalfOf: string): Promise<SummarizerStopReason>;
+    stop(reason: SummarizerStopReason): void;
+    static stopReasonCanRunLastSummary(stopReason: SummarizerStopReason): boolean;
     // (undocumented)
     summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
     // (undocumented)
@@ -786,36 +619,9 @@ export type SummarizeResultPart<TSuccess, TFailure = undefined> = {
     error: IRetriableFailureError;
 };
 
-// @alpha @deprecated (undocumented)
-export type SummarizerStopReason =
-/** Summarizer client failed to summarize in all attempts. */
-"failToSummarize"
-/** Parent client reported that it is no longer connected. */
-| "parentNotConnected"
-/**
-* Parent client reported that it is no longer elected the summarizer.
-* This is the normal flow; a disconnect will always trigger the parent
-* client to no longer be elected as responsible for summaries. Then it
-* tries to stop its spawned summarizer client.
-*/
-| "notElectedParent"
-/**
-* We are not already running the summarizer and we are not the current elected client id.
-*/
-| "notElectedClient"
-/** Summarizer client was disconnected */
-| "summarizerClientDisconnected"
-/** 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";
-
 // @alpha
 export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents> {
-    constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, logger: ITelemetryLoggerExt);
+    constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, logger: ITelemetryBaseLogger);
     // (undocumented)
     addOpListener(listener: () => void): void;
     createWatcher(clientId: string): IClientSummaryWatcher;