@fluidframework/container-loader 0.51.3 → 0.53.0-46105

package/dist/container.js

@@ -65,7 +65,7 @@ async function waitContainerToCatchUp(container) {
     if (container.closed) {
         throw new Error("Container is closed");
     }
-    return new Promise((accept, reject) => {
+    return new Promise((resolve, reject) => {
         const deltaManager = container.deltaManager;
         container.on("closed", reject);
         const waitForOps = () => {
@@ -74,12 +74,12 @@ async function waitContainerToCatchUp(container) {
             const connectionOpSeqNumber = deltaManager.lastKnownSeqNumber;
             common_utils_1.assert(deltaManager.lastSequenceNumber <= connectionOpSeqNumber, 0x266 /* "lastKnownSeqNumber should never be below last processed sequence number" */);
             if (deltaManager.lastSequenceNumber === connectionOpSeqNumber) {
-                accept(hasCheckpointSequenceNumber);
+                resolve(hasCheckpointSequenceNumber);
                 return;
             }
             const callbackOps = (message) => {
                 if (connectionOpSeqNumber <= message.sequenceNumber) {
-                    accept(hasCheckpointSequenceNumber);
+                    resolve(hasCheckpointSequenceNumber);
                     deltaManager.off("op", callbackOps);
                 }
             };
@@ -144,7 +144,6 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this.subLogger = telemetry_utils_1.ChildLogger.create(loader.services.subLogger, undefined, {
             all: {
                 clientType,
-                loaderVersion: packageVersion_1.pkgVersion,
                 containerId: uuid_1.v4(),
                 docId: () => this.id,
                 containerAttachState: () => this._attachState,
@@ -229,22 +228,22 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 switch (event) {
                     case dirtyContainerEvent:
                         if (this._dirtyContainer) {
-                            listener(this._dirtyContainer);
+                            listener();
                         }
                         break;
                     case savedContainerEvent:
                         if (!this._dirtyContainer) {
-                            listener(this._dirtyContainer);
+                            listener();
                         }
                         break;
                     case telemetry_utils_1.connectedEventName:
                         if (this.connected) {
-                            listener(event, this.clientId);
+                            listener(this.clientId);
                         }
                         break;
                     case telemetry_utils_1.disconnectedEventName:
                         if (!this.connected) {
-                            listener(event);
+                            listener();
                         }
                         break;
                     default:
@@ -291,16 +290,18 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 container.close(err);
                 onClosed(err);
             });
-        }), { start: true, end: true, cancel: "error" });
+        }), { start: true, end: true, cancel: "generic" });
     }
     /**
      * Create a new container in a detached state.
      */
     static async createDetached(loader, codeDetails) {
         const container = new Container(loader, {});
-        container._lifecycleState = "loading";
-        await container.createDetached(codeDetails);
-        return container;
+        return telemetry_utils_1.PerformanceEvent.timedExecAsync(container.logger, { eventName: "CreateDetached" }, async (_event) => {
+            container._lifecycleState = "loading";
+            await container.createDetached(codeDetails);
+            return container;
+        }, { start: true, end: true, cancel: "generic" });
     }
     /**
      * Create a new container in a detached state that is initialized with a
@@ -308,10 +309,12 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
      */
     static async rehydrateDetachedFromSnapshot(loader, snapshot) {
         const container = new Container(loader, {});
-        const deserializedSummary = JSON.parse(snapshot);
-        container._lifecycleState = "loading";
-        await container.rehydrateDetachedFromSnapshot(deserializedSummary);
-        return container;
+        return telemetry_utils_1.PerformanceEvent.timedExecAsync(container.logger, { eventName: "RehydrateDetachedFromSnapshot" }, async (_event) => {
+            const deserializedSummary = JSON.parse(snapshot);
+            container._lifecycleState = "loading";
+            await container.rehydrateDetachedFromSnapshot(deserializedSummary);
+            return container;
+        }, { start: true, end: true, cancel: "generic" });
     }
     get loaded() {
         return (this._lifecycleState !== "created" && this._lifecycleState !== "loading");
@@ -356,31 +359,6 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
     get loadedFromVersion() {
         return this._loadedFromVersion;
     }
-    /**
-     * Tells if container is in read-only mode.
-     * Data stores should listen for "readonly" notifications and disallow user making changes to data stores.
-     * Readonly state can be because of no storage write permission,
-     * or due to host forcing readonly mode for container.
-     *
-     * We do not differentiate here between no write access to storage vs. host disallowing changes to container -
-     * in all cases container runtime and data stores should respect readonly state and not allow local changes.
-     *
-     * It is undefined if we have not yet established websocket connection
-     * and do not know if user has write access to a file.
-     * @deprecated - use readOnlyInfo
-     */
-    get readonly() {
-        return this._deltaManager.readonly;
-    }
-    /**
-     * Tells if user has no write permissions for file in storage
-     * It is undefined if we have not yet established websocket connection
-     * and do not know if user has write access to a file.
-     * @deprecated - use readOnlyInfo
-     */
-    get readonlyPermissions() {
-        return this._deltaManager.readonlyPermissions;
-    }
     get readOnlyInfo() {
         return this._deltaManager.readOnlyInfo;
     }
@@ -428,15 +406,31 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         return this._deltaManager.clientDetails;
     }
     /**
-     * @deprecated use codeDetails
+     * The current code details for the container's runtime
+     * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or
+     * getLoadedCodeDetails for the code details that the container's context was loaded with.
+     * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.
      */
-    get chaincodePackage() {
-        return this.codeDetails;
-    }
     get codeDetails() {
         var _a, _b;
         return (_b = (_a = this._context) === null || _a === void 0 ? void 0 : _a.codeDetails) !== null && _b !== void 0 ? _b : this.getCodeDetailsFromQuorum();
     }
+    /**
+     * Get the code details that are currently specified for the container.
+     * @returns The current code details if any are specified, undefined if none are specified.
+     */
+    getSpecifiedCodeDetails() {
+        return this.getCodeDetailsFromQuorum();
+    }
+    /**
+     * Get the code details that were used to load the container.
+     * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet
+     * loaded.
+     */
+    getLoadedCodeDetails() {
+        var _a;
+        return (_a = this._context) === null || _a === void 0 ? void 0 : _a.codeDetails;
+    }
     /**
      * Retrieves the audience associated with the document
      */
@@ -473,6 +467,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             try {
                 this._deltaManager.close(error);
                 (_a = this._protocolHandler) === null || _a === void 0 ? void 0 : _a.close();
+                this.connectionStateHandler.dispose();
                 (_b = this._context) === null || _b === void 0 ? void 0 : _b.dispose(error !== undefined ? new Error(error.message) : undefined);
                 common_utils_1.assert(this.connectionState === ConnectionState.Disconnected, 0x0cf /* "disconnect event was not raised!" */);
                 (_c = this._storageService) === null || _c === void 0 ? void 0 : _c.dispose();
@@ -517,95 +512,93 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const protocolSummary = this.captureProtocolSummary();
         const combinedSummary = driver_utils_1.combineAppAndProtocolSummary(appSummary, protocolSummary);
         if (this.loader.services.detachedBlobStorage && this.loader.services.detachedBlobStorage.size > 0) {
-            combinedSummary.tree[".hasAttachmentBlobs"] = { type: 2 /* Blob */, content: "true" };
+            combinedSummary.tree[".hasAttachmentBlobs"] = { type: protocol_definitions_1.SummaryType.Blob, content: "true" };
         }
         return JSON.stringify(combinedSummary);
     }
     async attach(request) {
-        if (this._lifecycleState !== "loaded") {
-            throw new container_utils_1.UsageError(`containerNotValidForAttach [${this._lifecycleState}]`);
-        }
-        // If container is already attached or attach is in progress, throw an error.
-        common_utils_1.assert(this._attachState === container_definitions_1.AttachState.Detached && !this.attachStarted, 0x205 /* "attach() called more than once" */);
-        this.attachStarted = true;
-        // If attachment blobs were uploaded in detached state we will go through a different attach flow
-        const hasAttachmentBlobs = this.loader.services.detachedBlobStorage !== undefined
-            && this.loader.services.detachedBlobStorage.size > 0;
-        try {
-            common_utils_1.assert(this.deltaManager.inbound.length === 0, 0x0d6 /* "Inbound queue should be empty when attaching" */);
-            let summary;
-            if (!hasAttachmentBlobs) {
-                // Get the document state post attach - possibly can just call attach but we need to change the
-                // semantics around what the attach means as far as async code goes.
-                const appSummary = this.context.createSummary();
-                const protocolSummary = this.captureProtocolSummary();
-                summary = driver_utils_1.combineAppAndProtocolSummary(appSummary, protocolSummary);
-                // Set the state as attaching as we are starting the process of attaching container.
-                // This should be fired after taking the summary because it is the place where we are
-                // starting to attach the container to storage.
-                // Also, this should only be fired in detached container.
-                this._attachState = container_definitions_1.AttachState.Attaching;
-                this.context.notifyAttaching();
-            }
-            // Actually go and create the resolved document
-            const createNewResolvedUrl = await this.urlResolver.resolve(request);
-            driver_utils_1.ensureFluidResolvedUrl(createNewResolvedUrl);
-            if (this.service === undefined) {
-                this.service = await driver_utils_1.runWithRetry(async () => this.serviceFactory.createContainer(summary, createNewResolvedUrl, this.subLogger), "containerAttach", this.logger, {});
+        await telemetry_utils_1.PerformanceEvent.timedExecAsync(this.logger, { eventName: "Attach" }, async () => {
+            if (this._lifecycleState !== "loaded") {
+                throw new container_utils_1.UsageError(`containerNotValidForAttach [${this._lifecycleState}]`);
             }
-            const resolvedUrl = this.service.resolvedUrl;
-            driver_utils_1.ensureFluidResolvedUrl(resolvedUrl);
-            this._resolvedUrl = resolvedUrl;
-            await this.connectStorageService();
-            if (hasAttachmentBlobs) {
-                // upload blobs to storage
-                common_utils_1.assert(!!this.loader.services.detachedBlobStorage, 0x24e /* "assertion for type narrowing" */);
-                // build a table mapping IDs assigned locally to IDs assigned by storage and pass it to runtime to
-                // support blob handles that only know about the local IDs
-                const redirectTable = new Map();
-                // if new blobs are added while uploading, upload them too
-                while (redirectTable.size < this.loader.services.detachedBlobStorage.size) {
-                    const newIds = this.loader.services.detachedBlobStorage.getBlobIds().filter((id) => !redirectTable.has(id));
-                    for (const id of newIds) {
-                        const blob = await this.loader.services.detachedBlobStorage.readBlob(id);
-                        const response = await this.storageService.createBlob(blob);
-                        redirectTable.set(id, response.id);
+            // If container is already attached or attach is in progress, throw an error.
+            common_utils_1.assert(this._attachState === container_definitions_1.AttachState.Detached && !this.attachStarted, 0x205 /* "attach() called more than once" */);
+            this.attachStarted = true;
+            // If attachment blobs were uploaded in detached state we will go through a different attach flow
+            const hasAttachmentBlobs = this.loader.services.detachedBlobStorage !== undefined
+                && this.loader.services.detachedBlobStorage.size > 0;
+            try {
+                common_utils_1.assert(this.deltaManager.inbound.length === 0, 0x0d6 /* "Inbound queue should be empty when attaching" */);
+                let summary;
+                if (!hasAttachmentBlobs) {
+                    // Get the document state post attach - possibly can just call attach but we need to change the
+                    // semantics around what the attach means as far as async code goes.
+                    const appSummary = this.context.createSummary();
+                    const protocolSummary = this.captureProtocolSummary();
+                    summary = driver_utils_1.combineAppAndProtocolSummary(appSummary, protocolSummary);
+                    // Set the state as attaching as we are starting the process of attaching container.
+                    // This should be fired after taking the summary because it is the place where we are
+                    // starting to attach the container to storage.
+                    // Also, this should only be fired in detached container.
+                    this._attachState = container_definitions_1.AttachState.Attaching;
+                    this.context.notifyAttaching();
+                }
+                // Actually go and create the resolved document
+                const createNewResolvedUrl = await this.urlResolver.resolve(request);
+                driver_utils_1.ensureFluidResolvedUrl(createNewResolvedUrl);
+                if (this.service === undefined) {
+                    this.service = await driver_utils_1.runWithRetry(async () => this.serviceFactory.createContainer(summary, createNewResolvedUrl, this.subLogger), "containerAttach", this.logger, {});
+                }
+                const resolvedUrl = this.service.resolvedUrl;
+                driver_utils_1.ensureFluidResolvedUrl(resolvedUrl);
+                this._resolvedUrl = resolvedUrl;
+                await this.connectStorageService();
+                if (hasAttachmentBlobs) {
+                    // upload blobs to storage
+                    common_utils_1.assert(!!this.loader.services.detachedBlobStorage, 0x24e /* "assertion for type narrowing" */);
+                    // build a table mapping IDs assigned locally to IDs assigned by storage and pass it to runtime to
+                    // support blob handles that only know about the local IDs
+                    const redirectTable = new Map();
+                    // if new blobs are added while uploading, upload them too
+                    while (redirectTable.size < this.loader.services.detachedBlobStorage.size) {
+                        const newIds = this.loader.services.detachedBlobStorage.getBlobIds().filter((id) => !redirectTable.has(id));
+                        for (const id of newIds) {
+                            const blob = await this.loader.services.detachedBlobStorage.readBlob(id);
+                            const response = await this.storageService.createBlob(blob);
+                            redirectTable.set(id, response.id);
+                        }
                     }
+                    // take summary and upload
+                    const appSummary = this.context.createSummary(redirectTable);
+                    const protocolSummary = this.captureProtocolSummary();
+                    summary = driver_utils_1.combineAppAndProtocolSummary(appSummary, protocolSummary);
+                    this._attachState = container_definitions_1.AttachState.Attaching;
+                    this.context.notifyAttaching();
+                    await this.storageService.uploadSummaryWithContext(summary, {
+                        referenceSequenceNumber: 0,
+                        ackHandle: undefined,
+                        proposalHandle: undefined,
+                    });
+                }
+                this._attachState = container_definitions_1.AttachState.Attached;
+                this.emit("attached");
+                // Propagate current connection state through the system.
+                this.propagateConnectionState();
+                if (!this.closed) {
+                    this.resumeInternal({ fetchOpsFromStorage: false, reason: "createDetached" });
                 }
-                // take summary and upload
-                const appSummary = this.context.createSummary(redirectTable);
-                const protocolSummary = this.captureProtocolSummary();
-                summary = driver_utils_1.combineAppAndProtocolSummary(appSummary, protocolSummary);
-                this._attachState = container_definitions_1.AttachState.Attaching;
-                this.context.notifyAttaching();
-                await this.storageService.uploadSummaryWithContext(summary, {
-                    referenceSequenceNumber: 0,
-                    ackHandle: undefined,
-                    proposalHandle: undefined,
-                });
-            }
-            this._attachState = container_definitions_1.AttachState.Attached;
-            this.emit("attached");
-            // Propagate current connection state through the system.
-            this.propagateConnectionState();
-            if (!this.closed) {
-                this.resumeInternal({ fetchOpsFromStorage: false, reason: "createDetached" });
             }
-        }
-        catch (error) {
-            // we should retry upon any retriable errors, so we shouldn't see them here
-            common_utils_1.assert(!driver_utils_1.canRetryOnError(error), 0x24f /* "retriable error thrown from attach()" */);
-            // add resolved URL on error object so that host has the ability to find this document and delete it
-            const newError = telemetry_utils_1.normalizeError(error);
-            const resolvedUrl = this.resolvedUrl;
-            if (resolvedUrl) {
-                driver_utils_1.ensureFluidResolvedUrl(resolvedUrl);
-                newError.addTelemetryProperties({ resolvedUrl: resolvedUrl.url });
+            catch (error) {
+                // add resolved URL on error object so that host has the ability to find this document and delete it
+                const newError = telemetry_utils_1.normalizeError(error);
+                const resolvedUrl = this.resolvedUrl;
+                if (driver_utils_1.isFluidResolvedUrl(resolvedUrl)) {
+                    newError.addTelemetryProperties({ resolvedUrl: resolvedUrl.url });
+                }
+                this.close(newError);
+                throw newError;
             }
-            this.close(newError);
-            // eslint-disable-next-line @typescript-eslint/no-throw-literal
-            throw newError;
-        }
+        }, { start: true, end: true, cancel: "generic" });
     }
     async request(path) {
         return telemetry_utils_1.PerformanceEvent.timedExecAsync(this.logger, { eventName: "Request" }, async () => this.context.request(path), { end: true, cancel: "error" });
@@ -922,7 +915,6 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
     }
     async createDetached(source) {
         const attributes = {
-            branch: "",
             sequenceNumber: detachedContainerRefSeqNumber,
             term: 1,
             minimumSequenceNumber: 0,
@@ -984,7 +976,6 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
     async getDocumentAttributes(storage, tree) {
         if (tree === undefined) {
             return {
-                branch: this.id,
                 minimumSequenceNumber: 0,
                 sequenceNumber: 0,
                 term: 1,
@@ -1053,7 +1044,6 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const quorumSnapshot = this.protocolHandler.quorum.snapshot();
         // Save attributes for the document
         const documentAttributes = {
-            branch: this.id,
             minimumSequenceNumber: this.protocolHandler.minimumSequenceNumber,
             sequenceNumber: this.protocolHandler.sequenceNumber,
             term: this.protocolHandler.term,
@@ -1062,22 +1052,22 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             tree: {
                 attributes: {
                     content: JSON.stringify(documentAttributes),
-                    type: 2 /* Blob */,
+                    type: protocol_definitions_1.SummaryType.Blob,
                 },
                 quorumMembers: {
                     content: JSON.stringify(quorumSnapshot.members),
-                    type: 2 /* Blob */,
+                    type: protocol_definitions_1.SummaryType.Blob,
                 },
                 quorumProposals: {
                     content: JSON.stringify(quorumSnapshot.proposals),
-                    type: 2 /* Blob */,
+                    type: protocol_definitions_1.SummaryType.Blob,
                 },
                 quorumValues: {
                     content: JSON.stringify(quorumSnapshot.values),
-                    type: 2 /* Blob */,
+                    type: protocol_definitions_1.SummaryType.Blob,
                 },
             },
-            type: 1 /* Tree */,
+            type: protocol_definitions_1.SummaryType.Tree,
         };
         return summary;
     }
@@ -1102,6 +1092,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         if (this.clientDetailsOverride !== undefined) {
             merge_1.default(client.details, this.clientDetailsOverride);
         }
+        client.details.environment = [client.details.environment, ` loaderVersion:${packageVersion_1.pkgVersion}`].join(";");
         return client;
     }
     /**
@@ -1111,14 +1102,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
      * If it's not true, runtime is not in position to send ops.
      */
     activeConnection() {
-        const active = this.connectionState === ConnectionState.Connected &&
+        return this.connectionState === ConnectionState.Connected &&
             this._deltaManager.connectionMode === "write";
-        // Check for presence of current client in quorum for "write" connections - inactive clients
-        // would get leave op after some long timeout (5 min) and that should automatically transition
-        // state to "read" mode.
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        common_utils_1.assert(!active || this.getQuorum().getMember(this.clientId) !== undefined, 0x276 /* "active connection not present in quorum" */);
-        return active;
     }
     createDeltaManager() {
         const deltaManager = new deltaManager_1.DeltaManager(() => this.service, this.client, telemetry_utils_1.ChildLogger.create(this.subLogger, "DeltaManager"), this._canReconnect, () => this.activeConnection());