Deprecate unnecessary exports of container-runtime package

.changeset/many-gifts-strive.md

@@ -0,0 +1,40 @@
+---
+"@fluidframework/container-runtime": minor
+---
+---
+"section": deprecation
+---
+
+Deprecate unnecessary exports of container-runtime package
+
+The following types in the `@fluidframework/container-runtime` are 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

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

@@ -32,22 +32,22 @@ export enum ContainerMessageType {
     Rejoin = "rejoin"
 }
 
-// @alpha
+// @alpha @deprecated
 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;
@@ -73,26 +73,26 @@ export type EnqueueSummarizeResult = (ISummarizeResults & {
     readonly overridden?: undefined;
 };
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export type GCFeatureMatrix = {
     gcGeneration?: number;
     tombstoneGeneration?: undefined;
 } | {
     tombstoneGeneration: number;
 };
 
-// @alpha
+// @alpha @deprecated
 export const GCNodeType: {
     readonly DataStore: "DataStore";
     readonly SubDataStore: "SubDataStore";
     readonly Blob: "Blob";
     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
@@ -121,7 +121,7 @@ export interface IBaseSummarizeResult {
     readonly stage: "base";
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IBlobManagerLoadInfo {
     // (undocumented)
     ids?: string[];
@@ -137,13 +137,13 @@ export interface IBroadcastSummaryResult {
     readonly summarizeOp: ISummaryOpMessage;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface ICancellableSummarizerController extends ISummaryCancellationToken {
     // (undocumented)
     stop(reason: SummarizerStopReason): void;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface ICancellationToken<T> {
     readonly cancelled: boolean;
     readonly waitCancelled: Promise<T>;
@@ -163,7 +163,7 @@ export interface ICompressionRuntimeOptions {
     readonly minimumBatchSizeInBytes: number;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export interface IConnectableRuntime {
     // (undocumented)
     readonly clientId: string | undefined;
@@ -175,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)
@@ -205,7 +205,7 @@ export interface IContainerRuntimeOptions {
     readonly summaryOptions?: ISummaryRuntimeOptions;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export interface ICreateContainerMetadata {
     createContainerRuntimeVersion?: string;
     createContainerTimestamp?: number;
@@ -214,7 +214,7 @@ export interface ICreateContainerMetadata {
 // @alpha
 export type IdCompressorMode = "on" | "delayed" | undefined;
 
-// @alpha
+// @alpha @deprecated
 export interface IDocumentSchema {
     // (undocumented)
     refSeq: number;
@@ -224,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;
@@ -236,7 +236,7 @@ export type IDocumentSchemaCurrent = {
     };
 };
 
-// @alpha
+// @alpha @deprecated
 export interface IDocumentSchemaFeatures {
     // (undocumented)
     compressionLz4: boolean;
@@ -282,7 +282,7 @@ export interface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFlui
     readonly summaryFormatVersion: 2;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IGCMetadata {
     readonly gcFeature?: GCVersion;
     readonly gcFeatureMatrix?: GCFeatureMatrix;
@@ -301,7 +301,7 @@ export interface IGCRuntimeOptions {
     sweepGracePeriodMs?: number;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {
 }
 
@@ -324,7 +324,7 @@ export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "
     readonly summaryTree: ISummaryTree;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IMarkPhaseStats {
     attachmentBlobCount: number;
     dataStoreCount: number;
@@ -354,7 +354,7 @@ export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
     readonly retryOnFailure?: boolean;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface IRefreshSummaryAckOptions {
     readonly ackHandle: string;
     readonly proposalHandle: string | undefined;
@@ -368,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;
@@ -383,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;
@@ -416,13 +416,13 @@ export interface ISummarizeResults {
     readonly summarySubmitted: Promise<SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>>;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (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;
@@ -466,7 +466,7 @@ export interface ISummaryBaseConfiguration {
     maxOpsSinceLastSummary: number;
 }
 
-// @alpha
+// @alpha @deprecated
 export type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
 
 // @alpha (undocumented)
@@ -504,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
@@ -530,7 +530,7 @@ export interface ISummaryRuntimeOptions {
     summaryConfigOverrides?: ISummaryConfiguration;
 }
 
-// @alpha
+// @alpha @deprecated
 export interface ISweepPhaseStats {
     deletedAttachmentBlobCount: number;
     deletedDataStoreCount: number;
@@ -584,7 +584,7 @@ export interface SubmitSummaryFailureData {
 // @alpha
 export type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult;
 
-// @alpha
+// @alpha @deprecated
 export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
     constructor(
     runtime: ISummarizerRuntime, configurationGetter: () => ISummaryConfiguration,

packages/runtime/container-runtime/src/blobManager/blobManager.ts

@@ -51,6 +51,7 @@ import {
 	getStorageIds,
 	summarizeBlobManagerState,
 	toRedirectTable,
+	// eslint-disable-next-line import/no-deprecated
 	type IBlobManagerLoadInfo,
 } from "./blobManagerSnapSum.js";
 
@@ -187,6 +188,7 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 
 	constructor(props: {
 		readonly routeContext: IFluidHandleContext;
+		// eslint-disable-next-line import/no-deprecated
 		snapshot: IBlobManagerLoadInfo;
 		readonly getStorage: () => IDocumentStorageService;
 		/**

packages/runtime/container-runtime/src/blobManager/blobManagerSnapSum.ts

@@ -17,6 +17,7 @@ import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/intern
  * Information from a snapshot needed to load BlobManager
  * @legacy
  * @alpha
+ * @deprecated - This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface IBlobManagerLoadInfo {
 	ids?: string[];

packages/runtime/container-runtime/src/channelCollection.ts

@@ -76,6 +76,7 @@ import {
 import { v4 as uuid } from "uuid";
 
 import {
+	// eslint-disable-next-line import/no-deprecated
 	DeletedResponseHeaderKey,
 	RuntimeHeaderData,
 	defaultRuntimeHeaderData,
@@ -96,10 +97,12 @@ import {
 } from "./dataStoreContext.js";
 import { DataStoreContexts } from "./dataStoreContexts.js";
 import { FluidDataStoreRegistry } from "./dataStoreRegistry.js";
+// eslint-disable-next-line import/no-deprecated
 import { GCNodeType, IGCNodeUpdatedProps, urlToGCNodePath } from "./gc/index.js";
 import { ContainerMessageType, LocalContainerRuntimeMessage } from "./messageTypes.js";
 import { StorageServiceWithAttachBlobs } from "./storageServiceWithAttachBlobs.js";
 import {
+	// eslint-disable-next-line import/no-deprecated
 	IContainerRuntimeMetadata,
 	nonDataStorePaths,
 	rootHasIsolatedChannels,
@@ -985,6 +988,7 @@ export class ChannelCollection implements IFluidDataStoreChannel, IDisposable {
 			// The requested data store has been deleted by gc. Create a 404 response exception.
 			throw responseToException(
 				createResponseError(404, "DataStore was deleted", originalRequest, {
+					// eslint-disable-next-line import/no-deprecated
 					[DeletedResponseHeaderKey]: true,
 				}),
 				originalRequest,
@@ -1474,6 +1478,7 @@ export class ChannelCollection implements IFluidDataStoreChannel, IDisposable {
 	 * Called by GC to determine if a node is for a data store or for an object within a data store (for e.g. DDS).
 	 * @returns the GC node type if the node belongs to a data store or object within data store, undefined otherwise.
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	public getGCNodeType(nodePath: string): GCNodeType | undefined {
 		const pathParts = nodePath.split("/");
 		if (!this.contexts.has(pathParts[1])) {
@@ -1483,8 +1488,10 @@ export class ChannelCollection implements IFluidDataStoreChannel, IDisposable {
 		// Data stores paths are of the format "/dataStoreId".
 		// Sub data store paths are of the format "/dataStoreId/subPath/...".
 		if (pathParts.length === 2) {
+			// eslint-disable-next-line import/no-deprecated
 			return GCNodeType.DataStore;
 		}
+		// eslint-disable-next-line import/no-deprecated
 		return GCNodeType.SubDataStore;
 	}
 
@@ -1549,6 +1556,7 @@ export class ChannelCollection implements IFluidDataStoreChannel, IDisposable {
 
 export function getSummaryForDatastores(
 	snapshot: ISnapshotTree | undefined,
+	// eslint-disable-next-line import/no-deprecated
 	metadata?: IContainerRuntimeMetadata,
 ): ISnapshotTree | undefined {
 	if (!snapshot) {