@fluidframework/container-loader 2.0.0-internal.7.1.0 → 2.0.0-internal.7.2.0

package/dist/container.js

@@ -36,6 +36,7 @@ const detachedContainerRefSeqNumber = 0;
 const dirtyContainerEvent = "dirty";
 const savedContainerEvent = "saved";
 const packageNotFactoryError = "Code package does not implement IRuntimeFactory";
+const hasBlobsSummaryTree = ".hasAttachmentBlobs";
 /**
  * Waits until container connects to delta storage and gets up-to-date.
  *
@@ -189,6 +190,9 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const container = new Container(createProps);
         return telemetry_utils_1.PerformanceEvent.timedExecAsync(container.mc.logger, { eventName: "RehydrateDetachedFromSnapshot" }, async (_event) => {
             const deserializedSummary = JSON.parse(snapshot);
+            if (!(0, driver_utils_1.isCombinedAppAndProtocolSummary)(deserializedSummary, hasBlobsSummaryTree)) {
+                throw new telemetry_utils_1.UsageError("Cannot rehydrate detached container. Incorrect format");
+            }
             await container.rehydrateDetachedFromSnapshot(deserializedSummary);
             return container;
         }, { start: true, end: true, cancel: "generic" });
@@ -422,6 +426,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const type = this.client.details.type;
         const interactive = this.client.details.capabilities.interactive;
         const clientType = `${interactive ? "interactive" : "noninteractive"}${type !== undefined && type !== "" ? `/${type}` : ""}`;
+        this._containerId = (0, uuid_1.v4)();
         // Need to use the property getter for docId because for detached flow we don't have the docId initially.
         // We assign the id later so property getter is used.
         this.subLogger = (0, telemetry_utils_1.createChildLogger)({
@@ -429,7 +434,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             properties: {
                 all: {
                     clientType,
-                    containerId: (0, uuid_1.v4)(),
+                    containerId: this._containerId,
                     docId: () => this.resolvedUrl?.id,
                     containerAttachState: () => this._attachState,
                     containerLifecycleState: () => this._lifecycleState,
@@ -642,12 +647,15 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             this._lifecycleEvents.emit("disposed");
         }
     }
-    async closeAndGetPendingLocalState() {
+    async closeAndGetPendingLocalState(stopBlobAttachingSignal) {
         // runtime matches pending ops to successful ones by clientId and client seq num, so we need to close the
         // container at the same time we get pending state, otherwise this container could reconnect and resubmit with
         // a new clientId and a future container using stale pending state without the new clientId would resubmit them
         this.disconnectInternal({ text: "closeAndGetPendingLocalState" }); // TODO https://dev.azure.com/fluidframework/internal/_workitems/edit/5127
-        const pendingState = await this.getPendingLocalStateCore({ notifyImminentClosure: true });
+        const pendingState = await this.getPendingLocalStateCore({
+            notifyImminentClosure: true,
+            stopBlobAttachingSignal,
+        });
         this.close();
         return pendingState;
     }
@@ -693,7 +701,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const protocolSummary = this.captureProtocolSummary();
         const combinedSummary = (0, utils_1.combineAppAndProtocolSummary)(appSummary, protocolSummary);
         if (this.detachedBlobStorage && this.detachedBlobStorage.size > 0) {
-            combinedSummary.tree[".hasAttachmentBlobs"] = {
+            combinedSummary.tree[hasBlobsSummaryTree] = {
                 type: protocol_definitions_1.SummaryType.Blob,
                 content: "true",
             };
@@ -743,7 +751,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                         cancel: this._deltaManager.closeAbortController.signal,
                     });
                 }
-                await this.storageAdapter.connectToService(this.service);
+                this.storageAdapter.connectToService(this.service);
                 if (hasAttachmentBlobs) {
                     // upload blobs to storage
                     (0, core_utils_1.assert)(!!this.detachedBlobStorage, 0x24e /* "assertion for type narrowing" */);
@@ -967,15 +975,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         if (loadMode.deltaConnection === undefined && !pendingLocalState) {
             this.connectToDeltaStream(connectionArgs);
         }
-        if (!pendingLocalState) {
-            await this.storageAdapter.connectToService(this.service);
-        }
-        else {
-            // if we have pendingLocalState we can load without storage; don't wait for connection
-            this.storageAdapter.connectToService(this.service).catch((error) => {
-                this.close(error);
-            });
-        }
+        this.storageAdapter.connectToService(this.service);
         this._attachState = container_definitions_1.AttachState.Attached;
         timings.phase2 = client_utils_1.performance.now();
         // Fetch specified snapshot.
@@ -1138,9 +1138,10 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this.setLoaded();
     }
     async rehydrateDetachedFromSnapshot(detachedContainerSnapshot) {
-        if (detachedContainerSnapshot.tree[".hasAttachmentBlobs"] !== undefined) {
+        if (detachedContainerSnapshot.tree[hasBlobsSummaryTree] !== undefined) {
             (0, core_utils_1.assert)(!!this.detachedBlobStorage && this.detachedBlobStorage.size > 0, 0x250 /* "serialized container with attachment blobs must be rehydrated with detached blob storage" */);
-            delete detachedContainerSnapshot.tree[".hasAttachmentBlobs"];
+            // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+            delete detachedContainerSnapshot.tree[hasBlobsSummaryTree];
         }
         const snapshotTree = (0, utils_1.getSnapshotTreeFromSerializedContainer)(detachedContainerSnapshot);
         this.storageAdapter.loadSnapshotForRehydratingContainer(snapshotTree);
@@ -1273,6 +1274,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         client.details.environment = [
             client.details.environment,
             ` loaderVersion:${packageVersion_1.pkgVersion}`,
+            ` containerId:${this._containerId}`,
         ].join(";");
         return client;
     }
@@ -1486,8 +1488,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         }
         this.emit("op", message);
     }
-    submitSignal(message) {
-        this._deltaManager.submitSignal(JSON.stringify(message));
+    submitSignal(content, targetClientId) {
+        this._deltaManager.submitSignal(JSON.stringify(content), targetClientId);
     }
     processSignal(message) {
         // No clientId indicates a system signal message.
@@ -1542,7 +1544,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const getSpecifiedCodeDetails = () => (this.protocolHandler.quorum.get("code") ??
             this.protocolHandler.quorum.get("code2"));
         const existing = snapshot !== undefined;
-        const context = new containerContext_1.ContainerContext(this.options, this.scope, snapshot, 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), (message) => this.submitSignal(message), (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);
+        const context = new containerContext_1.ContainerContext(this.options, this.scope, snapshot, 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);
         this._runtime = await telemetry_utils_1.PerformanceEvent.timedExecAsync(this.subLogger, { eventName: "InstantiateRuntime" }, async () => runtimeFactory.instantiateRuntime(context, existing));
         this._lifecycleEvents.emit("runtimeInstantiated");
         this._loadedCodeDetails = codeDetails;