@fluidframework/container-loader 0.51.2 → 0.52.1

package/lib/container.js

@@ -11,7 +11,7 @@ import { AttachState, } from "@fluidframework/container-definitions";
 import { DataCorruptionError, extractSafePropertiesFromMessage, GenericError, UsageError, } from "@fluidframework/container-utils";
 import { readAndParse, OnlineStatus, isOnline, ensureFluidResolvedUrl, combineAppAndProtocolSummary, runWithRetry, canRetryOnError, } from "@fluidframework/driver-utils";
 import { isSystemMessage, ProtocolOpHandler, } from "@fluidframework/protocol-base";
-import { FileMode, MessageType, TreeEntry, } from "@fluidframework/protocol-definitions";
+import { FileMode, MessageType, TreeEntry, SummaryType, } from "@fluidframework/protocol-definitions";
 import { ChildLogger, EventEmitterWithErrorHandling, PerformanceEvent, raiseConnectedEvent, TelemetryLogger, connectedEventName, disconnectedEventName, normalizeError, } from "@fluidframework/telemetry-utils";
 import { Audience } from "./audience";
 import { ContainerContext } from "./containerContext";
@@ -59,7 +59,7 @@ export 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 = () => {
@@ -68,12 +68,12 @@ export async function waitContainerToCatchUp(container) {
             const connectionOpSeqNumber = deltaManager.lastKnownSeqNumber;
             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);
                 }
             };
@@ -222,12 +222,12 @@ export class Container extends EventEmitterWithErrorHandling {
                 switch (event) {
                     case dirtyContainerEvent:
                         if (this._dirtyContainer) {
-                            listener(this._dirtyContainer);
+                            listener(dirtyContainerEvent);
                         }
                         break;
                     case savedContainerEvent:
                         if (!this._dirtyContainer) {
-                            listener(this._dirtyContainer);
+                            listener(savedContainerEvent);
                         }
                         break;
                     case connectedEventName:
@@ -421,15 +421,31 @@ export class Container extends 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
      */
@@ -510,7 +526,7 @@ export class Container extends EventEmitterWithErrorHandling {
         const protocolSummary = this.captureProtocolSummary();
         const combinedSummary = 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: SummaryType.Blob, content: "true" };
         }
         return JSON.stringify(combinedSummary);
     }
@@ -596,7 +612,6 @@ export class Container extends EventEmitterWithErrorHandling {
                 newError.addTelemetryProperties({ resolvedUrl: resolvedUrl.url });
             }
             this.close(newError);
-            // eslint-disable-next-line @typescript-eslint/no-throw-literal
             throw newError;
         }
     }
@@ -915,7 +930,6 @@ export class Container extends EventEmitterWithErrorHandling {
     }
     async createDetached(source) {
         const attributes = {
-            branch: "",
             sequenceNumber: detachedContainerRefSeqNumber,
             term: 1,
             minimumSequenceNumber: 0,
@@ -977,7 +991,6 @@ export class Container extends EventEmitterWithErrorHandling {
     async getDocumentAttributes(storage, tree) {
         if (tree === undefined) {
             return {
-                branch: this.id,
                 minimumSequenceNumber: 0,
                 sequenceNumber: 0,
                 term: 1,
@@ -1046,7 +1059,6 @@ export class Container extends 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,
@@ -1055,22 +1067,22 @@ export class Container extends EventEmitterWithErrorHandling {
             tree: {
                 attributes: {
                     content: JSON.stringify(documentAttributes),
-                    type: 2 /* Blob */,
+                    type: SummaryType.Blob,
                 },
                 quorumMembers: {
                     content: JSON.stringify(quorumSnapshot.members),
-                    type: 2 /* Blob */,
+                    type: SummaryType.Blob,
                 },
                 quorumProposals: {
                     content: JSON.stringify(quorumSnapshot.proposals),
-                    type: 2 /* Blob */,
+                    type: SummaryType.Blob,
                 },
                 quorumValues: {
                     content: JSON.stringify(quorumSnapshot.values),
-                    type: 2 /* Blob */,
+                    type: SummaryType.Blob,
                 },
             },
-            type: 1 /* Tree */,
+            type: SummaryType.Tree,
         };
         return summary;
     }