@fluidframework/container-loader 2.0.0-dev-rc.2.0.0.246488 → 2.0.0-dev-rc.3.0.0.253463

package/lib/container.js

@@ -2,31 +2,32 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { v4 as uuid } from "uuid";
-import { assert, unreachableCase, isPromiseLike } from "@fluidframework/core-utils";
 import { TypedEventEmitter, performance } from "@fluid-internal/client-utils";
+import { AttachState, } from "@fluidframework/container-definitions";
+import { isFluidCodeDetails, } from "@fluidframework/container-definitions/internal";
 import { LogLevel, } from "@fluidframework/core-interfaces";
-import { AttachState, isFluidCodeDetails, } from "@fluidframework/container-definitions";
-import { readAndParse, OnlineStatus, isOnline, isCombinedAppAndProtocolSummary, MessageType2, isInstanceOfISnapshot, runWithRetry, } from "@fluidframework/driver-utils";
+import { assert, isPromiseLike, unreachableCase } from "@fluidframework/core-utils/internal";
+import { MessageType2, OnlineStatus, isCombinedAppAndProtocolSummary, isInstanceOfISnapshot, isOnline, readAndParse, runWithRetry, } from "@fluidframework/driver-utils/internal";
 import { MessageType, SummaryType, } from "@fluidframework/protocol-definitions";
-import { createChildLogger, EventEmitterWithErrorHandling, PerformanceEvent, raiseConnectedEvent, connectedEventName, normalizeError, createChildMonitoringContext, wrapError, formatTick, GenericError, UsageError, } from "@fluidframework/telemetry-utils";
+import { EventEmitterWithErrorHandling, GenericError, PerformanceEvent, UsageError, connectedEventName, createChildLogger, createChildMonitoringContext, formatTick, normalizeError, raiseConnectedEvent, wrapError, } from "@fluidframework/telemetry-utils/internal";
 import structuredClone from "@ungap/structured-clone";
+import { v4 as uuid } from "uuid";
+import { runRetriableAttachProcess } from "./attachment.js";
 import { Audience } from "./audience.js";
+import { ConnectionManager } from "./connectionManager.js";
+import { ConnectionState } from "./connectionState.js";
+import { createConnectionStateHandler } from "./connectionStateHandler.js";
 import { ContainerContext } from "./containerContext.js";
+import { ContainerStorageAdapter } from "./containerStorageAdapter.js";
 import { ReconnectMode, getPackageName, } from "./contracts.js";
 import { DeltaManager } from "./deltaManager.js";
 import { RelativeLoader } from "./loader.js";
-import { pkgVersion } from "./packageVersion.js";
-import { ContainerStorageAdapter } from "./containerStorageAdapter.js";
-import { createConnectionStateHandler } from "./connectionStateHandler.js";
-import { combineAppAndProtocolSummary, getProtocolSnapshotTree, getSnapshotTreeAndBlobsFromSerializedContainer, combineSnapshotTreeAndSnapshotBlobs, getDetachedContainerStateFromSerializedContainer, runSingle, } from "./utils.js";
-import { initQuorumValuesFromCodeDetails } from "./quorum.js";
 import { NoopHeuristic } from "./noopHeuristic.js";
-import { ConnectionManager } from "./connectionManager.js";
-import { ConnectionState } from "./connectionState.js";
+import { pkgVersion } from "./packageVersion.js";
 import { ProtocolHandler, protocolHandlerShouldProcessSignal, } from "./protocol.js";
-import { runRetriableAttachProcess } from "./attachment.js";
-import { SerializedStateManager } from "./serializedStateManager.js";
+import { initQuorumValuesFromCodeDetails } from "./quorum.js";
+import { SerializedStateManager, } from "./serializedStateManager.js";
+import { combineAppAndProtocolSummary, combineSnapshotTreeAndSnapshotBlobs, getDetachedContainerStateFromSerializedContainer, getDocumentAttributes, getProtocolSnapshotTree, getSnapshotTreeAndBlobsFromSerializedContainer, runSingle, } from "./utils.js";
 const detachedContainerRefSeqNumber = 0;
 const dirtyContainerEvent = "dirty";
 const savedContainerEvent = "saved";
@@ -744,13 +745,13 @@ export class Container extends EventEmitterWithErrorHandling {
         const attachingData = this.attachmentData.state === AttachState.Attaching ? this.attachmentData : undefined;
         const combinedSummary = attachingData?.summary ??
             combineAppAndProtocolSummary(this.runtime.createSummary(), this.captureProtocolSummary());
-        const { tree: snapshot, blobs } = getSnapshotTreeAndBlobsFromSerializedContainer(combinedSummary);
+        const { baseSnapshot, snapshotBlobs } = getSnapshotTreeAndBlobsFromSerializedContainer(combinedSummary);
         const pendingRuntimeState = attachingData !== undefined ? this.runtime.getPendingLocalState() : undefined;
         assert(!isPromiseLike(pendingRuntimeState), 0x8e3 /* should not be a promise */);
         const detachedContainerState = {
             attached: false,
-            baseSnapshot: snapshot,
-            snapshotBlobs: blobs,
+            baseSnapshot,
+            snapshotBlobs,
             pendingRuntimeState,
             hasAttachmentBlobs: !!this.detachedBlobStorage && this.detachedBlobStorage.size > 0,
         };
@@ -927,10 +928,12 @@ export class Container extends EventEmitterWithErrorHandling {
             state: AttachState.Attached,
         };
         timings.phase2 = performance.now();
+        const supportGetSnapshotApi = this.mc.config.getBoolean("Fluid.Container.UseLoadingGroupIdForSnapshotFetch") ===
+            true && this.service?.policies?.supportGetSnapshotApi === true;
         // Fetch specified snapshot.
-        const { snapshotTree, version } = await this.serializedStateManager.fetchSnapshot(specifiedVersion, this.service?.policies?.supportGetSnapshotApi);
+        const { baseSnapshot, version } = await this.serializedStateManager.fetchSnapshot(specifiedVersion, supportGetSnapshotApi);
         this._loadedFromVersion = version;
-        const attributes = await this.getDocumentAttributes(this.storageAdapter, snapshotTree);
+        const attributes = await getDocumentAttributes(this.storageAdapter, baseSnapshot);
         // If we saved ops, we will replay them and don't need DeltaManager to fetch them
         const sequenceNumber = pendingLocalState?.savedOps[pendingLocalState.savedOps.length - 1]?.sequenceNumber;
         const dmAttributes = sequenceNumber !== undefined ? { ...attributes, sequenceNumber } : attributes;
@@ -995,12 +998,12 @@ export class Container extends EventEmitterWithErrorHandling {
         }
         // ...load in the existing quorum
         // Initialize the protocol handler
-        await this.initializeProtocolStateFromSnapshot(attributes, this.storageAdapter, snapshotTree);
+        await this.initializeProtocolStateFromSnapshot(attributes, this.storageAdapter, baseSnapshot);
         timings.phase3 = performance.now();
         const codeDetails = this.getCodeDetailsFromQuorum();
-        await this.instantiateRuntime(codeDetails, snapshotTree, 
+        await this.instantiateRuntime(codeDetails, baseSnapshot, 
         // give runtime a dummy value so it knows we're loading from a stash blob
-        pendingLocalState ? pendingLocalState?.pendingRuntimeState ?? {} : undefined, isInstanceOfISnapshot(snapshotTree) ? snapshotTree : undefined);
+        pendingLocalState ? pendingLocalState?.pendingRuntimeState ?? {} : undefined, isInstanceOfISnapshot(baseSnapshot) ? baseSnapshot : undefined);
         // replay saved ops
         if (pendingLocalState) {
             for (const message of pendingLocalState.savedOps) {
@@ -1082,7 +1085,7 @@ export class Container extends EventEmitterWithErrorHandling {
         }
         const snapshotTreeWithBlobContents = combineSnapshotTreeAndSnapshotBlobs(baseSnapshot, snapshotBlobs);
         this.storageAdapter.loadSnapshotFromSnapshotBlobs(snapshotBlobs);
-        const attributes = await this.getDocumentAttributes(this.storageAdapter, snapshotTreeWithBlobContents);
+        const attributes = await getDocumentAttributes(this.storageAdapter, snapshotTreeWithBlobContents);
         await this.attachDeltaManagerOpHandler(attributes);
         // Initialize the protocol handler
         const baseTree = getProtocolSnapshotTree(snapshotTreeWithBlobContents);
@@ -1096,20 +1099,6 @@ export class Container extends EventEmitterWithErrorHandling {
         await this.instantiateRuntime(codeDetails, snapshotTreeWithBlobContents, pendingRuntimeState);
         this.setLoaded();
     }
-    async getDocumentAttributes(storage, tree) {
-        if (tree === undefined) {
-            return {
-                minimumSequenceNumber: 0,
-                sequenceNumber: 0,
-            };
-        }
-        // Backward compatibility: old docs would have ".attributes" instead of "attributes"
-        const attributesHash = ".protocol" in tree.trees
-            ? tree.trees[".protocol"].blobs.attributes
-            : tree.blobs[".attributes"];
-        const attributes = await readAndParse(storage, attributesHash);
-        return attributes;
-    }
     async initializeProtocolStateFromSnapshot(attributes, storage, snapshot) {
         const quorumSnapshot = {
             members: [],
@@ -1430,6 +1419,7 @@ export class Container extends EventEmitterWithErrorHandling {
         }
         this.emit("op", message);
     }
+    // unknown should be removed once `@alpha` tag is removed from IContainerContext
     submitSignal(content, targetClientId) {
         this._deltaManager.submitSignal(JSON.stringify(content), targetClientId);
     }
@@ -1462,10 +1452,8 @@ export class Container extends EventEmitterWithErrorHandling {
         if (runtimeFactory === undefined) {
             throw new Error(packageNotFactoryError);
         }
-        const getSpecifiedCodeDetails = () => (this.protocolHandler.quorum.get("code") ??
-            this.protocolHandler.quorum.get("code2"));
         const existing = snapshotTree !== undefined;
-        const context = new ContainerContext(this.options, this.scope, snapshotTree, this._loadedFromVersion, this._deltaManager, this.storageAdapter, this.protocolHandler.quorum, this.protocolHandler.audience, loader, (type, contents, batch, metadata) => this.submitContainerMessage(type, contents, batch, metadata), (summaryOp, referenceSequenceNumber) => this.submitSummaryMessage(summaryOp, referenceSequenceNumber), (batch, referenceSequenceNumber) => this.submitBatch(batch, referenceSequenceNumber), (content, targetClientId) => this.submitSignal(content, targetClientId), (error) => this.dispose(error), (error) => this.close(error), this.updateDirtyContainerState, this.getAbsoluteUrl, () => this.resolvedUrl?.id, () => this.clientId, () => this.attachState, () => this.connected, getSpecifiedCodeDetails, this._deltaManager.clientDetails, existing, this.subLogger, pendingLocalState, snapshot);
+        const context = new ContainerContext(this.options, this.scope, snapshotTree, this._loadedFromVersion, this._deltaManager, this.storageAdapter, this.protocolHandler.quorum, this.protocolHandler.audience, loader, (type, contents, batch, metadata) => this.submitContainerMessage(type, contents, batch, metadata), (summaryOp, referenceSequenceNumber) => this.submitSummaryMessage(summaryOp, referenceSequenceNumber), (batch, referenceSequenceNumber) => this.submitBatch(batch, referenceSequenceNumber), (content, targetClientId) => this.submitSignal(content, targetClientId), (error) => this.dispose(error), (error) => this.close(error), this.updateDirtyContainerState, this.getAbsoluteUrl, () => this.resolvedUrl?.id, () => this.clientId, () => this.attachState, () => this.connected, this._deltaManager.clientDetails, existing, this.subLogger, pendingLocalState, snapshot);
         this._runtime = await PerformanceEvent.timedExecAsync(this.subLogger, { eventName: "InstantiateRuntime" }, async () => runtimeFactory.instantiateRuntime(context, existing));
         this._lifecycleEvents.emit("runtimeInstantiated");
         this._loadedCodeDetails = codeDetails;