@fluidframework/container-runtime 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

package/src/summary/runningSummarizer.ts

@@ -3,46 +3,48 @@
  * Licensed under the MIT License.
  */
 
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IDisposable, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { assert, Deferred, PromiseTimer, delay } from "@fluidframework/core-utils/internal";
+import { DriverErrorTypes } from "@fluidframework/driver-definitions";
+import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
 import {
-	isFluidError,
 	MonitoringContext,
-	createChildMonitoringContext,
-	createChildLogger,
 	UsageError,
-} from "@fluidframework/telemetry-utils";
-import { assert, delay, Deferred, PromiseTimer } from "@fluidframework/core-utils";
-import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { DriverErrorTypes } from "@fluidframework/driver-definitions";
-import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
+	createChildLogger,
+	createChildMonitoringContext,
+	isFluidError,
+} from "@fluidframework/telemetry-utils/internal";
+
 import { ISummaryConfiguration } from "../containerRuntime.js";
 import { opSize } from "../opProperties.js";
+
 import { SummarizeHeuristicRunner } from "./summarizerHeuristics.js";
 import {
+	EnqueueSummarizeResult,
 	IEnqueueSummarizeOptions,
-	ISummarizeOptions,
-	ISummarizeHeuristicData,
-	ISummarizeHeuristicRunner,
 	IOnDemandSummarizeOptions,
-	EnqueueSummarizeResult,
-	SummarizerStopReason,
+	IRefreshSummaryAckOptions,
 	ISubmitSummaryOptions,
-	SubmitSummaryResult,
-	ISummaryCancellationToken,
+	ISummarizeEventProps,
+	ISummarizeHeuristicData,
+	ISummarizeHeuristicRunner,
+	ISummarizeOptions,
 	ISummarizeResults,
-	ISummarizeTelemetryProperties,
-	ISummarizerRuntime,
 	ISummarizeRunnerTelemetry,
-	IRefreshSummaryAckOptions,
+	ISummarizeTelemetryProperties,
 	ISummarizerEvents,
-	ISummarizeEventProps,
+	ISummarizerRuntime,
+	ISummaryCancellationToken,
+	SubmitSummaryResult,
+	SummarizerStopReason,
 } from "./summarizerTypes.js";
 import { IAckedSummary, IClientSummaryWatcher, SummaryCollection } from "./summaryCollection.js";
 import {
-	raceTimer,
 	SummarizeReason,
 	SummarizeResultBuilder,
 	SummaryGenerator,
+	raceTimer,
 } from "./summaryGenerator.js";
 
 const maxSummarizeAckWaitTime = 10 * 60 * 1000; // 10 minutes

package/src/summary/summarizer.ts

@@ -3,37 +3,39 @@
  * Licensed under the MIT License.
  */
 
-import { Deferred } from "@fluidframework/core-utils";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { IFluidHandleContext } from "@fluidframework/core-interfaces";
+import { Deferred } from "@fluidframework/core-utils/internal";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import {
-	ITelemetryLoggerExt,
-	createChildLogger,
 	IFluidErrorBase,
 	LoggingError,
 	UsageError,
+	createChildLogger,
 	wrapErrorAndLog,
-} from "@fluidframework/telemetry-utils";
-import { IFluidHandleContext } from "@fluidframework/core-interfaces";
+} from "@fluidframework/telemetry-utils/internal";
+
 import { ISummaryConfiguration } from "../containerRuntime.js";
+
 import { ICancellableSummarizerController } from "./runWhileConnectedCoordinator.js";
-import { SummaryCollection } from "./summaryCollection.js";
 import { RunningSummarizer } from "./runningSummarizer.js";
+import { SummarizeHeuristicData } from "./summarizerHeuristics.js";
 import {
+	EnqueueSummarizeResult,
 	IConnectableRuntime,
-	ISummarizer,
+	IEnqueueSummarizeOptions,
+	IOnDemandSummarizeOptions,
+	ISummarizeEventProps,
 	ISummarizeHeuristicData,
+	ISummarizeResults,
+	ISummarizer,
+	ISummarizerEvents,
 	ISummarizerInternalsProvider,
 	ISummarizerRuntime,
 	ISummarizingWarning,
 	SummarizerStopReason,
-	IOnDemandSummarizeOptions,
-	ISummarizeResults,
-	IEnqueueSummarizeOptions,
-	EnqueueSummarizeResult,
-	ISummarizerEvents,
-	ISummarizeEventProps,
 } from "./summarizerTypes.js";
-import { SummarizeHeuristicData } from "./summarizerHeuristics.js";
+import { SummaryCollection } from "./summaryCollection.js";
 import { SummarizeResultBuilder } from "./summaryGenerator.js";
 
 const summarizingError = "summarizingError";
@@ -240,7 +242,7 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 			this.summaryCollection.createWatcher(clientId),
 			this.configurationGetter(),
 			async (...args) => this.internalsProvider.submitSummary(...args), // submitSummaryCallback
-			async (...args) => this.internalsProvider.refreshLatestSummaryAck(...args), // refreshLatestSummaryCallback
+			async (...args) => this.internalsProvider.refreshLatestSummaryAck(...args), // refreshLatestSummaryAckCallback
 			this._heuristicData,
 			this.summaryCollection,
 			runCoordinator /* cancellationToken */,

package/src/summary/summarizerClientElection.ts

@@ -3,10 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { IEvent, IEventProvider } from "@fluidframework/core-interfaces";
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { IEvent, IEventProvider } from "@fluidframework/core-interfaces";
 import { IClientDetails, MessageType } from "@fluidframework/protocol-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+
 import {
 	IOrderedClientElection,
 	ISerializedElection,

package/src/summary/summarizerHeuristics.ts

@@ -3,13 +3,15 @@
  * Licensed under the MIT License.
  */
 
+import { Timer } from "@fluidframework/core-utils/internal";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
-import { Timer } from "@fluidframework/core-utils";
+
 import { ISummaryConfigurationHeuristics } from "../containerRuntime.js";
+
 import {
+	ISummarizeAttempt,
 	ISummarizeHeuristicData,
 	ISummarizeHeuristicRunner,
-	ISummarizeAttempt,
 	ISummaryHeuristicStrategy,
 } from "./summarizerTypes.js";
 import { SummarizeReason } from "./summaryGenerator.js";

package/src/summary/summarizerNode/summarizerNode.ts

@@ -4,41 +4,43 @@
  */
 
 import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
-import {
-	ISummarizerNode,
-	ISummarizerNodeConfig,
-	ISummarizeResult,
-	CreateChildSummarizerNodeParam,
-	CreateSummarizerNodeSource,
-	SummarizeInternalFn,
-	ITelemetryContext,
-	IExperimentalIncrementalSummaryContext,
-} from "@fluidframework/runtime-definitions";
+import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import {
 	ISequencedDocumentMessage,
-	SummaryType,
 	ISnapshotTree,
+	SummaryType,
 } from "@fluidframework/protocol-definitions";
 import {
-	ITelemetryLoggerExt,
-	createChildLogger,
+	IExperimentalIncrementalSummaryContext,
+	ITelemetryContext,
+} from "@fluidframework/runtime-definitions";
+import {
+	CreateChildSummarizerNodeParam,
+	CreateSummarizerNodeSource,
+	ISummarizeResult,
+	ISummarizerNode,
+	ISummarizerNodeConfig,
+	SummarizeInternalFn,
+} from "@fluidframework/runtime-definitions/internal";
+import { mergeStats } from "@fluidframework/runtime-utils/internal";
+import { type ITelemetryErrorEventExt, ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import {
 	LoggingError,
 	PerformanceEvent,
 	TelemetryDataTag,
+	createChildLogger,
 	tagCodeArtifacts,
-	type ITelemetryErrorEventExt,
-} from "@fluidframework/telemetry-utils";
-import { assert, unreachableCase } from "@fluidframework/core-utils";
-import { mergeStats } from "@fluidframework/runtime-utils";
+} from "@fluidframework/telemetry-utils/internal";
+
 import {
 	EscapedPath,
 	ICreateChildDetails,
 	IRefreshSummaryResult,
 	IStartSummaryResult,
 	ISummarizerNodeRootContract,
-	parseSummaryForSubtrees,
 	SummaryNode,
 	ValidateSummaryResult,
+	parseSummaryForSubtrees,
 } from "./summarizerNodeUtils.js";
 
 export interface IRootSummarizerNode extends ISummarizerNode, ISummarizerNodeRootContract {}

package/src/summary/summarizerNode/summarizerNodeUtils.ts

@@ -3,9 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLoggerExt, TelemetryDataTag } from "@fluidframework/telemetry-utils";
 import { ISnapshotTree, SummaryObject } from "@fluidframework/protocol-definitions";
-import { channelsTreeName } from "@fluidframework/runtime-definitions";
+import { channelsTreeName } from "@fluidframework/runtime-definitions/internal";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { TelemetryDataTag } from "@fluidframework/telemetry-utils/internal";
 
 export interface IRefreshSummaryResult {
 	/** Tells whether this summary is tracked by this client. */

package/src/summary/summarizerNode/summarizerNodeWithGc.ts

@@ -3,23 +3,31 @@
  * Licensed under the MIT License.
  */
 
-import { LoggingError, TelemetryDataTag, tagCodeArtifacts } from "@fluidframework/telemetry-utils";
-import { assert, LazyPromise } from "@fluidframework/core-utils";
+import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { assert, LazyPromise } from "@fluidframework/core-utils/internal";
 import {
-	CreateChildSummarizerNodeParam,
+	IExperimentalIncrementalSummaryContext,
 	IGarbageCollectionData,
+	ITelemetryContext,
+} from "@fluidframework/runtime-definitions";
+import {
+	CreateChildSummarizerNodeParam,
 	IGarbageCollectionDetailsBase,
 	ISummarizeInternalResult,
 	ISummarizeResult,
 	ISummarizerNodeConfigWithGC,
 	ISummarizerNodeWithGC,
 	SummarizeInternalFn,
-	ITelemetryContext,
-	IExperimentalIncrementalSummaryContext,
-} from "@fluidframework/runtime-definitions";
-import { unpackChildNodesUsedRoutes } from "@fluidframework/runtime-utils";
-import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+} from "@fluidframework/runtime-definitions/internal";
+import { unpackChildNodesUsedRoutes } from "@fluidframework/runtime-utils/internal";
+import {
+	LoggingError,
+	TelemetryDataTag,
+	tagCodeArtifacts,
+} from "@fluidframework/telemetry-utils/internal";
+
 import { cloneGCData, unpackChildNodesGCDetails } from "../../gc/index.js";
+
 import { SummarizerNode } from "./summarizerNode.js";
 import {
 	EscapedPath,

package/src/summary/summarizerTypes.ts

@@ -3,16 +3,20 @@
  * Licensed under the MIT License.
  */
 
+import { IDeltaManager } from "@fluidframework/container-definitions";
+import { ContainerWarning } from "@fluidframework/container-definitions/internal";
 import { IEvent, IEventProvider, ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
-import { ITelemetryLoggerExt, ITelemetryLoggerPropertyBag } from "@fluidframework/telemetry-utils";
-import { ContainerWarning, IDeltaManager } from "@fluidframework/container-definitions";
 import {
+	IDocumentMessage,
 	ISequencedDocumentMessage,
 	ISummaryTree,
-	IDocumentMessage,
 } from "@fluidframework/protocol-definitions";
 import { ISummaryStats } from "@fluidframework/runtime-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { ITelemetryLoggerPropertyBag } from "@fluidframework/telemetry-utils/internal";
+
 import { ISummaryConfigurationHeuristics } from "../containerRuntime.js";
+
 import { ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage } from "./summaryCollection.js";
 import { SummarizeReason } from "./summaryGenerator.js";
 

package/src/summary/summaryCollection.ts

@@ -3,11 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { IDisposable, IEvent } from "@fluidframework/core-interfaces";
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
-import { Deferred, assert } from "@fluidframework/core-utils";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IDeltaManager } from "@fluidframework/container-definitions";
+import { IDisposable, IEvent } from "@fluidframework/core-interfaces";
+import { assert, Deferred } from "@fluidframework/core-utils/internal";
 import {
 	IDocumentMessage,
 	ISequencedDocumentMessage,
@@ -16,6 +15,7 @@ import {
 	ISummaryNack,
 	MessageType,
 } from "@fluidframework/protocol-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 
 /**
  * Interface for summary op messages with typed contents.

package/src/summary/summaryFormat.ts

@@ -3,24 +3,24 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils";
-import { IDocumentStorageService } from "@fluidframework/driver-definitions";
+import { assert } from "@fluidframework/core-utils/internal";
+import { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
 import {
-	readAndParse,
 	blobHeadersBlobName as blobNameForBlobHeaders,
-} from "@fluidframework/driver-utils";
+	readAndParse,
+} from "@fluidframework/driver-utils/internal";
 import {
 	ISequencedDocumentMessage,
 	ISnapshotTree,
 	SummaryType,
 } from "@fluidframework/protocol-definitions";
-import {
-	channelsTreeName,
-	gcTreeKey,
-	ISummaryTreeWithStats,
-} from "@fluidframework/runtime-definitions";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { channelsTreeName, gcTreeKey } from "@fluidframework/runtime-definitions/internal";
+
 import { IGCMetadata } from "../gc/index.js";
 
+import { IDocumentSchema } from "./documentSchema.js";
+
 type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
 interface IFluidDataStoreAttributes0 {
 	readonly snapshotFormatVersion?: undefined;
@@ -85,35 +85,23 @@ export function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): b
 	return !!attributes.summaryFormatVersion && !attributes.disableIsolatedChannels;
 }
 
-/**
- * ID Compressor mode.
- * "on" - compressor is On. It's loaded as part of container load. This mode is sticky - once on, compressor is On for all
- * sessions for a given document. This results in IContainerRuntime.idCompressor to be always available.
- * "delayed" - ID compressor bundle is loaded only on establishing of first delta connection, i.e. it does not impact boot of cotnainer.
- * In such mode IContainerRuntime.idCompressor is not made available (unless previous sessions of same document had it "On").
- * The only thing that is available is IContainerRuntime.generateDocumentUniqueId() that provides opportunistically short IDs.
- * "off" - ID compressor is not laoded (unless it is "on" due to previous session for same document having it "on").
- * While IContainerRuntime.generateDocumentUniqueId() is available, it will produce long IDs that are do not compress well.
- *
- * @alpha
- */
-export type IdCompressorMode = "on" | "delayed" | "off";
-
 /**
  * @alpha
  */
 export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
 	readonly summaryFormatVersion: 1;
+	/** @deprecated - used by old (prior to 2.0 RC3) runtimes */
+	readonly message?: ISummaryMetadataMessage;
 	/** The last message processed at the time of summary. Only primitive property types are added to the summary. */
-	readonly message: ISummaryMetadataMessage | undefined;
+	readonly lastMessage?: ISummaryMetadataMessage;
 	/** True if channels are not isolated in .channels subtrees, otherwise isolated. */
 	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;
-	/** True if the runtime IdCompressor is enabled */
-	readonly idCompressorMode?: IdCompressorMode;
+
+	readonly documentSchema?: IDocumentSchema;
 }
 
 /**

package/src/summary/summaryGenerator.ts

@@ -3,36 +3,33 @@
  * Licensed under the MIT License.
  */
 
-import {
-	ITelemetryLoggerExt,
-	PerformanceEvent,
-	LoggingError,
-} from "@fluidframework/telemetry-utils";
 import { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
-
 import {
 	assert,
 	Deferred,
 	IPromiseTimer,
 	IPromiseTimerResult,
 	Timer,
-} from "@fluidframework/core-utils";
-import { MessageType } from "@fluidframework/protocol-definitions";
-import { getRetryDelaySecondsFromError } from "@fluidframework/driver-utils";
+} from "@fluidframework/core-utils/internal";
 import { DriverErrorTypes } from "@fluidframework/driver-definitions";
+import { getRetryDelaySecondsFromError } from "@fluidframework/driver-utils/internal";
+import { MessageType } from "@fluidframework/protocol-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { LoggingError, PerformanceEvent } from "@fluidframework/telemetry-utils/internal";
+
 import {
 	IAckSummaryResult,
-	INackSummaryResult,
 	IBroadcastSummaryResult,
-	ISummarizeResults,
-	ISummarizeHeuristicData,
+	INackSummaryResult,
+	IRefreshSummaryAckOptions,
 	ISubmitSummaryOptions,
+	ISummarizeHeuristicData,
+	ISummarizeResults,
+	ISummaryCancellationToken,
+	SubmitSummaryFailureData,
 	SubmitSummaryResult,
 	SummarizeResultPart,
-	ISummaryCancellationToken,
 	SummaryGeneratorTelemetry,
-	SubmitSummaryFailureData,
-	IRefreshSummaryAckOptions,
 } from "./summarizerTypes.js";
 import { IClientSummaryWatcher } from "./summaryCollection.js";
 

package/src/summary/summaryManager.ts

@@ -3,21 +3,21 @@
  * Licensed under the MIT License.
  */
 
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import {
 	IDisposable,
 	IEvent,
 	IEventProvider,
 	ITelemetryBaseLogger,
 } from "@fluidframework/core-interfaces";
-import { assert } from "@fluidframework/core-utils";
-import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import {
-	createChildLogger,
-	ITelemetryLoggerExt,
-	PerformanceEvent,
-} from "@fluidframework/telemetry-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 import { DriverErrorTypes } from "@fluidframework/driver-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { PerformanceEvent, createChildLogger } from "@fluidframework/telemetry-utils/internal";
+
 import { IThrottler } from "../throttler.js";
+
+import { Summarizer } from "./summarizer.js";
 import { ISummarizerClientElection } from "./summarizerClientElection.js";
 import {
 	EnqueueSummarizeResult,
@@ -30,7 +30,6 @@ import {
 	SummarizerStopReason,
 } from "./summarizerTypes.js";
 import { SummaryCollection } from "./summaryCollection.js";
-import { Summarizer } from "./summarizer.js";
 
 const defaultInitialDelayMs = 5000;
 const defaultOpsToBypassInitialDelay = 4000;
@@ -168,6 +167,10 @@ export class SummaryManager extends TypedEventEmitter<ISummarizerEvents> impleme
 		state === SummaryManagerState.Starting || state === SummaryManagerState.Running;
 
 	private getShouldSummarizeState(): ShouldSummarizeState {
+		if (this.disposed) {
+			return { shouldSummarize: false, stopReason: "parentNotConnected" };
+		}
+
 		// Note that if we're in the Running state, the electedClient may be a summarizer client, so we can't
 		// enforce connectedState.clientId === clientElection.electedClientId. But once we're Running, we should
 		// only transition to Stopping when the electedParentId changes. Stopping the summarizer without
@@ -190,11 +193,7 @@ export class SummaryManager extends TypedEventEmitter<ISummarizerEvents> impleme
 			return { shouldSummarize: false, stopReason: "parentNotConnected" };
 		}
 
-		if (this.disposed) {
-			assert(false, 0x260 /* "Disposed should mean disconnected!" */);
-		} else {
-			return { shouldSummarize: true };
-		}
+		return { shouldSummarize: true };
 	}
 
 	private readonly refreshSummarizer = () => {
@@ -238,6 +237,10 @@ export class SummaryManager extends TypedEventEmitter<ISummarizerEvents> impleme
 
 		this.delayBeforeCreatingSummarizer()
 			.then(async (startWithInitialDelay: boolean) => {
+				if (this.disposed) {
+					return "early exit (disposed)";
+				}
+
 				// Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore
 				// but only if creation was delayed. If it was not, then we want to ensure we always create
 				// a summarizer to kick off lastSummary. Without that, we would not be able to summarize and get

package/api-extractor-cjs.json

@@ -1,8 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
-	// CJS is actually secondary; so, no report.
-	"apiReport": {
-		"enabled": false
-	}
-}