@fluidframework/container-loader 2.1.0-274160 → 2.1.0-276985

package/lib/container.js

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable unicorn/consistent-function-scoping */
 import { TypedEventEmitter, performance } from "@fluid-internal/client-utils";
 import { AttachState, } from "@fluidframework/container-definitions";
 import { isFluidCodeDetails, } from "@fluidframework/container-definitions/internal";
@@ -50,6 +51,7 @@ const packageNotFactoryError = "Code package does not implement IRuntimeFactory"
  * but it maybe still behind.
  *
  * @throws an error beginning with `"Container closed"` if the container is closed before it catches up.
+ * @legacy
  * @alpha
  */
 export async function waitContainerToCatchUp(container) {
@@ -62,9 +64,9 @@ export async function waitContainerToCatchUp(container) {
         const closedCallback = (err) => {
             container.off("closed", closedCallback);
             const baseMessage = "Container closed while waiting to catch up";
-            reject(err !== undefined
-                ? wrapError(err, (innerMessage) => new GenericError(`${baseMessage}: ${innerMessage}`))
-                : new GenericError(baseMessage));
+            reject(err === undefined
+                ? new GenericError(baseMessage)
+                : wrapError(err, (innerMessage) => new GenericError(`${baseMessage}: ${innerMessage}`)));
         };
         container.on("closed", closedCallback);
         // Depending on config, transition to "connected" state may include the guarantee
@@ -388,7 +390,9 @@ export class Container extends EventEmitterWithErrorHandling {
          * disposed: Container has been disposed
          */
         this._lifecycleState = "loading";
-        /** During initialization we pause the inbound queues. We track this state to ensure we only call resume once */
+        /**
+         * During initialization we pause the inbound queues. We track this state to ensure we only call resume once
+         */
         this.inboundQueuePausedFromInit = true;
         this.firstConnection = true;
         this.connectionTransitionTimes = [];
@@ -469,7 +473,7 @@ export class Container extends EventEmitterWithErrorHandling {
                 const snapshotWithBlobs = await attachP;
                 this.serializedStateManager.setInitialSnapshot(snapshotWithBlobs);
                 if (!this.closed) {
-                    this.detachedBlobStorage.dispose?.();
+                    this.detachedBlobStorage?.dispose?.();
                     this.handleDeltaConnectionArg(attachProps?.deltaConnection, {
                         fetchOpsFromStorage: false,
                         reason: { text: "createDetached" },
@@ -507,7 +511,6 @@ export class Container extends EventEmitterWithErrorHandling {
         // Tracking alternative ways to handle this in AB#4129.
         this.options = { ...options };
         this.scope = scope;
-        this.detachedBlobStorage = detachedBlobStorage ?? createMemoryDetachedBlobStorage();
         this.protocolHandlerBuilder =
             protocolHandlerBuilder ??
                 ((attributes, quorumSnapshot, sendProposal) => new ProtocolHandler(attributes, quorumSnapshot, sendProposal, new Audience(), (clientId) => this.clientsWhoShouldHaveLeft.has(clientId)));
@@ -632,11 +635,16 @@ export class Container extends EventEmitterWithErrorHandling {
         // Whether the combined summary tree has been forced on by either the supportedFeatures flag by the service or the the loader option or the monitoring context
         const enableSummarizeProtocolTree = this.mc.config.getBoolean("Fluid.Container.summarizeProtocolTree2") ??
             options.summarizeProtocolTree;
+        this.detachedBlobStorage =
+            detachedBlobStorage ??
+                (this.mc.config.getBoolean("Fluid.Container.MemoryBlobStorageEnabled") === true
+                    ? createMemoryDetachedBlobStorage()
+                    : undefined);
         this.storageAdapter = new ContainerStorageAdapter(this.detachedBlobStorage, this.mc.logger, pendingLocalState?.snapshotBlobs, pendingLocalState?.loadedGroupIdSnapshots, addProtocolSummaryIfMissing, enableSummarizeProtocolTree);
         const offlineLoadEnabled = (this.isInteractiveClient &&
             this.mc.config.getBoolean("Fluid.Container.enableOfflineLoad")) ??
             options.enableOfflineLoad === true;
-        this.serializedStateManager = new SerializedStateManager(pendingLocalState, this.subLogger, this.storageAdapter, offlineLoadEnabled, this, () => this._deltaManager.connectionManager.shouldJoinWrite(), () => this.supportGetSnapshotApi());
+        this.serializedStateManager = new SerializedStateManager(pendingLocalState, this.subLogger, this.storageAdapter, offlineLoadEnabled, this, () => this._deltaManager.connectionManager.shouldJoinWrite(), () => this.supportGetSnapshotApi(), this.mc.config.getNumber("Fluid.Container.snapshotRefreshTimeoutMs"));
         const isDomAvailable = typeof document === "object" &&
             document !== null &&
             typeof document.addEventListener === "function" &&
@@ -701,8 +709,8 @@ export class Container extends EventEmitterWithErrorHandling {
                 this._protocolHandler?.close();
                 this.connectionStateHandler.dispose();
             }
-            catch (exception) {
-                this.mc.logger.sendErrorEvent({ eventName: "ContainerCloseException" }, exception);
+            catch (newError) {
+                this.mc.logger.sendErrorEvent({ eventName: "ContainerCloseException" }, newError);
             }
             this.emit("closed", error);
             if (this.visibilityEventHandler !== undefined) {
@@ -736,7 +744,7 @@ export class Container extends EventEmitterWithErrorHandling {
                 }
                 this._protocolHandler?.close();
                 this.connectionStateHandler.dispose();
-                const maybeError = error !== undefined ? new Error(error.message) : undefined;
+                const maybeError = error === undefined ? undefined : new Error(error.message);
                 this._runtime?.dispose(maybeError);
                 this.storageAdapter.dispose();
                 // Notify storage about critical errors. They may be due to disconnect between client & server knowledge
@@ -744,8 +752,8 @@ export class Container extends EventEmitterWithErrorHandling {
                 // Driver need to ensure all caches are cleared on critical errors
                 this.service?.dispose(error);
             }
-            catch (exception) {
-                this.mc.logger.sendErrorEvent({ eventName: "ContainerDisposeException" }, exception);
+            catch (error_) {
+                this.mc.logger.sendErrorEvent({ eventName: "ContainerDisposeException" }, error_);
             }
             this.emit("disposed", error);
             this.removeAllListeners();
@@ -803,14 +811,14 @@ export class Container extends EventEmitterWithErrorHandling {
         const combinedSummary = attachingData?.summary ??
             combineAppAndProtocolSummary(this.runtime.createSummary(), this.captureProtocolSummary());
         const { baseSnapshot, snapshotBlobs } = getSnapshotTreeAndBlobsFromSerializedContainer(combinedSummary);
-        const pendingRuntimeState = attachingData !== undefined ? this.runtime.getPendingLocalState() : undefined;
+        const pendingRuntimeState = attachingData === undefined ? undefined : this.runtime.getPendingLocalState();
         assert(!isPromiseLike(pendingRuntimeState), 0x8e3 /* should not be a promise */);
         const detachedContainerState = {
             attached: false,
             baseSnapshot,
             snapshotBlobs,
             pendingRuntimeState,
-            hasAttachmentBlobs: this.detachedBlobStorage.size > 0,
+            hasAttachmentBlobs: this.detachedBlobStorage !== undefined && this.detachedBlobStorage.size > 0,
             attachmentBlobs: serializeMemoryDetachedBlobStorage(this.detachedBlobStorage),
         };
         return JSON.stringify(detachedContainerState);
@@ -1003,17 +1011,20 @@ export class Container extends EventEmitterWithErrorHandling {
         // Attach op handlers to finish initialization and be able to start processing ops
         // Kick off any ops fetching if required.
         switch (loadMode.opsBeforeReturn) {
-            case undefined:
+            case undefined: {
                 // Start prefetch, but not set opsBeforeReturnP - boot is not blocked by it!
                 // eslint-disable-next-line @typescript-eslint/no-floating-promises
-                this.attachDeltaManagerOpHandler(attributes, loadMode.deltaConnection !== "none" ? "all" : "none", lastProcessedSequenceNumber);
+                this.attachDeltaManagerOpHandler(attributes, loadMode.deltaConnection === "none" ? "none" : "all", lastProcessedSequenceNumber);
                 break;
+            }
             case "cached":
-            case "all":
+            case "all": {
                 opsBeforeReturnP = this.attachDeltaManagerOpHandler(attributes, loadMode.opsBeforeReturn, lastProcessedSequenceNumber);
                 break;
-            default:
+            }
+            default: {
                 unreachableCase(loadMode.opsBeforeReturn);
+            }
         }
         // ...load in the existing quorum
         // Initialize the protocol handler
@@ -1099,7 +1110,7 @@ export class Container extends EventEmitterWithErrorHandling {
             if (attachmentBlobs !== undefined) {
                 tryInitializeMemoryDetachedBlobStorage(this.detachedBlobStorage, attachmentBlobs);
             }
-            assert(this.detachedBlobStorage.size > 0, 0x250 /* "serialized container with attachment blobs must be rehydrated with detached blob storage" */);
+            assert(this.detachedBlobStorage !== undefined && this.detachedBlobStorage.size > 0, 0x250 /* "serialized container with attachment blobs must be rehydrated with detached blob storage" */);
         }
         const snapshotTreeWithBlobContents = combineSnapshotTreeAndSnapshotBlobs(baseSnapshot, snapshotBlobs);
         this.storageAdapter.loadSnapshotFromSnapshotBlobs(snapshotBlobs);
@@ -1135,7 +1146,9 @@ export class Container extends EventEmitterWithErrorHandling {
         this.initializeProtocolState(attributes, quorumSnapshot);
     }
     initializeProtocolState(attributes, quorumSnapshot) {
-        const protocol = this.protocolHandlerBuilder(attributes, quorumSnapshot, (key, value) => this.submitMessage(MessageType.Propose, JSON.stringify({ key, value })));
+        const protocol = this.protocolHandlerBuilder(attributes, quorumSnapshot, (key, value) => 
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        this.submitMessage(MessageType.Propose, JSON.stringify({ key, value })));
         const protocolLogger = createChildLogger({
             logger: this.subLogger,
             namespace: "ProtocolHandler",
@@ -1199,9 +1212,8 @@ export class Container extends EventEmitterWithErrorHandling {
         return pkg;
     }
     static setupClient(containerId, loaderOptionsClient, clientDetailsOverride) {
-        const client = loaderOptionsClient !== undefined
-            ? structuredClone(loaderOptionsClient)
-            : {
+        const client = loaderOptionsClient === undefined
+            ? {
                 details: {
                     capabilities: { interactive: true },
                 },
@@ -1209,7 +1221,8 @@ export class Container extends EventEmitterWithErrorHandling {
                 permission: [],
                 scopes: [],
                 user: { id: "" },
-            };
+            }
+            : structuredClone(loaderOptionsClient);
         if (clientDetailsOverride !== undefined) {
             client.details = {
                 ...client.details,
@@ -1352,7 +1365,7 @@ export class Container extends EventEmitterWithErrorHandling {
             autoReconnect,
             opsBehind,
             online: OnlineStatus[isOnline()],
-            lastVisible: this.lastVisible !== undefined ? performance.now() - this.lastVisible : undefined,
+            lastVisible: this.lastVisible === undefined ? undefined : performance.now() - this.lastVisible,
             checkpointSequenceNumber,
             quorumSize: this._protocolHandler?.quorum.getMembers().size,
             isDirty: this.isDirty,
@@ -1383,10 +1396,12 @@ export class Container extends EventEmitterWithErrorHandling {
     // back-compat: ADO #1385: Remove in the future, summary op should come through submitSummaryMessage()
     submitContainerMessage(type, contents, batch, metadata) {
         switch (type) {
-            case MessageType.Operation:
+            case MessageType.Operation: {
                 return this.submitMessage(type, JSON.stringify(contents), batch, metadata);
-            case MessageType.Summarize:
+            }
+            case MessageType.Summarize: {
                 return this.submitSummaryMessage(contents);
+            }
             default: {
                 const newError = new GenericError("invalidContainerSubmitOpType", undefined /* error */, { messageType: type });
                 this.close(newError);
@@ -1394,7 +1409,9 @@ export class Container extends EventEmitterWithErrorHandling {
             }
         }
     }
-    /** @returns clientSequenceNumber of last message in a batch */
+    /**
+     * Gets the `clientSequenceNumber` of last message in a batch.
+     */
     submitBatch(batch, referenceSequenceNumber) {
         let clientSequenceNumber = -1;
         for (const message of batch) {
@@ -1520,22 +1537,26 @@ export class Container extends EventEmitterWithErrorHandling {
         // and runtime implementation may miss such events.
         assert(this.loaded, 0x96f /* has to be called after container transitions to loaded state */);
         switch (deltaConnectionArg) {
-            case undefined:
+            case undefined: {
                 if (connectionArgs) {
                     // connect to delta stream now since we did not before
                     this.connectToDeltaStream(connectionArgs);
                 }
+            }
             // intentional fallthrough
-            case "delayed":
+            case "delayed": {
                 assert(this.inboundQueuePausedFromInit, 0x346 /* inboundQueuePausedFromInit should be true */);
                 this.inboundQueuePausedFromInit = false;
                 this._deltaManager.inbound.resume();
                 this._deltaManager.inboundSignal.resume();
                 break;
-            case "none":
+            }
+            case "none": {
                 break;
-            default:
+            }
+            default: {
                 unreachableCase(deltaConnectionArg);
+            }
         }
     }
 }