@fluidframework/container-runtime 2.10.0 → 2.12.0

package/lib/containerRuntime.js

@@ -255,6 +255,10 @@ export async function loadContainerRuntime(params) {
 /**
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
+ *
+ * @deprecated To be removed from the Legacy-Alpha API in version 2.20.0.
+ * Use the loadContainerRuntime function and interfaces IContainerRuntime / IRuntime instead.
+ *
  * @legacy
  * @alpha
  */
@@ -421,7 +425,8 @@ export class ContainerRuntime extends TypedEventEmitter {
             runtime.onSchemaChange(schema);
         });
         const featureGatesForTelemetry = {};
-        const runtime = new containerRuntimeCtor(context, registry, metadata, electedSummarizerData, chunks ?? [], aliases ?? [], {
+        // Make sure we've got all the options including internal ones
+        const internalRuntimeOptions = {
             summaryOptions,
             gcOptions,
             loadSequenceNumberVerification,
@@ -433,7 +438,8 @@ export class ContainerRuntime extends TypedEventEmitter {
             enableRuntimeIdCompressor: enableRuntimeIdCompressor,
             enableGroupedBatching,
             explicitSchemaControl,
-        }, containerScope, logger, existing, blobManagerSnapshot, context.storage, createIdCompressorFn, documentSchemaController, featureGatesForTelemetry, provideEntryPoint, requestHandler, undefined, // summaryConfiguration
+        };
+        const runtime = new containerRuntimeCtor(context, registry, metadata, electedSummarizerData, chunks ?? [], aliases ?? [], internalRuntimeOptions, containerScope, logger, existing, blobManagerSnapshot, context.storage, createIdCompressorFn, documentSchemaController, featureGatesForTelemetry, provideEntryPoint, requestHandler, undefined, // summaryConfiguration
         recentBatchInfo);
         runtime.blobManager.stashedBlobsUploadP.then(() => {
             // make sure we didn't reconnect before the promise resolved
@@ -593,7 +599,6 @@ export class ContainerRuntime extends TypedEventEmitter {
         super();
         this.registry = registry;
         this.metadata = metadata;
-        this.runtimeOptions = runtimeOptions;
         this.containerScope = containerScope;
         this.baseLogger = baseLogger;
         this._storage = _storage;
@@ -632,6 +637,12 @@ export class ContainerRuntime extends TypedEventEmitter {
             expiry: { policy: "absolute", durationMs: 60000 },
         });
         const { options, clientDetails, connected, baseSnapshot, submitFn, submitBatchFn, submitSummaryFn, submitSignalFn, disposeFn, closeFn, deltaManager, quorum, audience, loader, pendingLocalState, supportedFeatures, snapshotWithContents, } = context;
+        // Backfill in defaults for the internal runtimeOptions, since they may not be present on the provided runtimeOptions object
+        this.runtimeOptions = {
+            flushMode: defaultFlushMode,
+            enableGroupedBatching: true,
+            ...runtimeOptions,
+        };
         this.logger = createChildLogger({ logger: this.baseLogger });
         this.mc = createChildMonitoringContext({
             logger: this.logger,
@@ -753,14 +764,15 @@ export class ContainerRuntime extends TypedEventEmitter {
         this.maxConsecutiveReconnects =
             this.mc.config.getNumber(maxConsecutiveReconnectsKey) ??
                 this.defaultMaxConsecutiveReconnects;
-        if (runtimeOptions.flushMode === FlushModeExperimental.Async &&
+        if (this.runtimeOptions.flushMode ===
+            FlushModeExperimental.Async &&
             supportedFeatures?.get("referenceSequenceNumbers") !== true) {
             // The loader does not support reference sequence numbers, falling back on FlushMode.TurnBased
             this.mc.logger.sendErrorEvent({ eventName: "FlushModeFallback" });
             this._flushMode = FlushMode.TurnBased;
         }
         else {
-            this._flushMode = runtimeOptions.flushMode;
+            this._flushMode = this.runtimeOptions.flushMode;
         }
         this.offlineEnabled =
             this.mc.config.getBoolean("Fluid.Container.enableOfflineLoad") ?? false;
@@ -970,8 +982,17 @@ export class ContainerRuntime extends TypedEventEmitter {
                 formExponentialFn({ coefficient: 20, initialDelay: 0 })), {
                     initialDelayMs: this.initialSummarizerDelayMs,
                 });
-                this.summaryManager.on("summarize", (eventProps) => {
-                    this.emit("summarize", eventProps);
+                // Forward events from SummaryManager
+                [
+                    "summarize",
+                    "summarizeAllAttemptsFailed",
+                    "summarizerStop",
+                    "summarizerStart",
+                    "summarizerStartupFailed",
+                ].forEach((eventName) => {
+                    this.summaryManager?.on(eventName, (...args) => {
+                        this.emit(eventName, ...args);
+                    });
                 });
                 this.summaryManager.start();
             }
@@ -1484,18 +1505,18 @@ export class ContainerRuntime extends TypedEventEmitter {
             this.flush();
         }
         this._connected = connected;
-        if (!connected) {
-            this._signalTracking.signalsLost = 0;
-            this._signalTracking.signalsOutOfOrder = 0;
-            this._signalTracking.signalTimestamp = 0;
-            this._signalTracking.signalsSentSinceLastLatencyMeasurement = 0;
-            this._signalTracking.totalSignalsSentInLatencyWindow = 0;
-            this._signalTracking.roundTripSignalSequenceNumber = undefined;
-            this._signalTracking.trackingSignalSequenceNumber = undefined;
-            this._signalTracking.minimumTrackingSignalSequenceNumber = undefined;
-        }
-        else {
+        if (connected) {
             assert(this.attachState === AttachState.Attached, 0x3cd /* Connection is possible only if container exists in storage */);
+            if (changeOfState) {
+                this._signalTracking.signalsLost = 0;
+                this._signalTracking.signalsOutOfOrder = 0;
+                this._signalTracking.signalTimestamp = 0;
+                this._signalTracking.signalsSentSinceLastLatencyMeasurement = 0;
+                this._signalTracking.totalSignalsSentInLatencyWindow = 0;
+                this._signalTracking.roundTripSignalSequenceNumber = undefined;
+                this._signalTracking.trackingSignalSequenceNumber = undefined;
+                this._signalTracking.minimumTrackingSignalSequenceNumber = undefined;
+            }
         }
         // Fail while disconnected
         if (reconnection) {
@@ -1909,14 +1930,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             targetClientId: message.targetClientId,
         };
         // Only collect signal telemetry for broadcast messages sent by the current client.
-        if (message.clientId === this.clientId &&
-            // jason-ha: This `connected` check seems incorrect. Signals that come through
-            // here must have been received while connected to service and there is no need
-            // to avoid processing when connection has dropped. Because container runtime's
-            // `connected` (and `_connected`) state also reflects some ops state, it may
-            //  easily be false when newly connected and signal tracking may very well
-            // complain lost signals (that were simply skipped per this check).
-            this.connected) {
+        if (message.clientId === this.clientId) {
             this.processSignalForTelemetry(envelope);
         }
         if (envelope.address === undefined) {
@@ -2957,7 +2971,6 @@ export class ContainerRuntime extends TypedEventEmitter {
                 this.channelCollection.rollback(type, contents, localOpMetadata);
                 break;
             default:
-                // Don't check message.compatDetails because this is for rolling back a local op so the type will be known
                 throw new Error(`Can't rollback ${type}`);
         }
     }