@fluidframework/container-loader 0.54.1 → 0.55.1

package/src/container.ts

@@ -8,7 +8,6 @@ import merge from "lodash/merge";
 import { v4 as uuid } from "uuid";
 import {
     IDisposable,
-    ITelemetryLogger,
 } from "@fluidframework/common-definitions";
 import { assert, performance, unreachableCase } from "@fluidframework/common-utils";
 import {
@@ -93,6 +92,8 @@ import {
     connectedEventName,
     disconnectedEventName,
     normalizeError,
+    MonitoringContext,
+    loggerToMonitoringContext,
 } from "@fluidframework/telemetry-utils";
 import { Audience } from "./audience";
 import { ContainerContext } from "./containerContext";
@@ -248,9 +249,9 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             });
 
         return PerformanceEvent.timedExecAsync(
-            container.logger,
+            container.mc.logger,
             { eventName: "Load" },
-            async (event) => new Promise<Container>((res, rej) => {
+            async (event) => new Promise<Container>((resolve, reject) => {
                 container._lifecycleState = "loading";
                 const version = loadOptions.version;
 
@@ -262,7 +263,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                 const mode: IContainerLoadMode = loadOptions.loadMode ?? defaultMode;
 
                 const onClosed = (err?: ICriticalContainerError) => {
-                    rej(err ?? new GenericError("containerClosedWithoutErrorDuringLoad"));
+                    reject(err ?? new GenericError("containerClosedWithoutErrorDuringLoad"));
                 };
                 container.on("closed", onClosed);
 
@@ -272,7 +273,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                     })
                     .then((props) => {
                         event.end({ ...props, ...loadOptions.loadMode });
-                        res(container);
+                        resolve(container);
                     },
                     (error) => {
                         const err = normalizeError(error);
@@ -299,7 +300,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             {});
 
         return PerformanceEvent.timedExecAsync(
-            container.logger,
+            container.mc.logger,
             { eventName: "CreateDetached" },
             async (_event) => {
                 container._lifecycleState = "loading";
@@ -321,7 +322,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             loader,
             {});
         return PerformanceEvent.timedExecAsync(
-            container.logger,
+            container.mc.logger,
             { eventName: "RehydrateDetachedFromSnapshot" },
             async (_event) => {
                 const deserializedSummary = JSON.parse(snapshot) as ISummaryTree;
@@ -338,7 +339,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
     // If false, container gets closed on loss of connection.
     private readonly _canReconnect: boolean = true;
 
-    private readonly logger: ITelemetryLogger;
+    private readonly mc: MonitoringContext;
 
     private _lifecycleState: "created" | "loading" | "loaded" | "closing" | "closed" = "created";
 
@@ -368,7 +369,6 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         return this._storage;
     }
 
-    // Active chaincode and associated runtime
     private _storageService: IDocumentStorageService & IDisposable | undefined;
     private get storageService(): IDocumentStorageService  {
         if (this._storageService === undefined) {
@@ -408,6 +408,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
     private _dirtyContainer = false;
 
     private lastVisible: number | undefined;
+    private readonly visibilityEventHandler: (() => void) | undefined;
     private readonly connectionStateHandler: ConnectionStateHandler;
 
     private setAutoReconnectTime = performance.now();
@@ -531,7 +532,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
 
     private get serviceFactory() {return this.loader.services.documentServiceFactory;}
     private get urlResolver() {return this.loader.services.urlResolver;}
-    public get options(): ILoaderOptions { return this.loader.services.options; }
+    public readonly options: ILoaderOptions;
     private get scope() { return this.loader.services.scope;}
     private get codeLoader() { return this.loader.services.codeLoader;}
 
@@ -540,7 +541,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         config: IContainerConfig,
     ) {
         super((name, error) => {
-            this.logger.sendErrorEvent(
+            this.mc.logger.sendErrorEvent(
                 {
                     eventName: "ContainerEventHandlerException",
                     name: typeof name === "string" ? name : undefined,
@@ -574,7 +575,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                     containerLifecycleState: () => this._lifecycleState,
                     containerConnectionState: () => ConnectionState[this.connectionState],
                 },
-                // we need to be judicious with our logging here to avoid generting too much data
+                // we need to be judicious with our logging here to avoid generating too much data
                 // all data logged here should be broadly applicable, and not specific to a
                 // specific error or class of errors
                 error: {
@@ -587,14 +588,22 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                     dmLastMsqSeqNumber: () => this.deltaManager?.lastMessage?.sequenceNumber,
                     dmLastMsqSeqTimestamp: () => this.deltaManager?.lastMessage?.timestamp,
                     dmLastMsqSeqClientId: () => this.deltaManager?.lastMessage?.clientId,
-                    connectionState: () => ConnectionState[this.connectionState],
                     connectionStateDuration:
                         () => performance.now() - this.connectionTransitionTimes[this.connectionState],
                 },
             });
 
         // Prefix all events in this file with container-loader
-        this.logger = ChildLogger.create(this.subLogger, "Container");
+        this.mc = loggerToMonitoringContext(ChildLogger.create(this.subLogger, "Container"));
+
+        const summarizeProtocolTree =
+            this.mc.config.getBoolean("Fluid.Container.summarizeProtocolTree")
+            ?? this.loader.services.options.summarizeProtocolTree;
+
+        this.options = {
+            ... this.loader.services.options,
+            summarizeProtocolTree,
+        };
 
         this.connectionStateHandler = new ConnectionStateHandler(
             {
@@ -617,7 +626,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                     }
                 },
             },
-            this.logger,
+            this.mc.logger,
         );
 
         this._deltaManager = this.createDeltaManager();
@@ -625,9 +634,9 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             () => {
                 if (this.attachState !== AttachState.Attached) {
                     if (this.loader.services.detachedBlobStorage !== undefined) {
-                        return new BlobOnlyStorage(this.loader.services.detachedBlobStorage, this.logger);
+                        return new BlobOnlyStorage(this.loader.services.detachedBlobStorage, this.mc.logger);
                     }
-                    this.logger.sendErrorEvent({
+                    this.mc.logger.sendErrorEvent({
                         eventName: "NoRealStorageInDetachedContainer",
                     });
                     throw new Error("Real storage calls not allowed in Unattached container");
@@ -643,14 +652,15 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         // keep track of last time page was visible for telemetry
         if (isDomAvailable) {
             this.lastVisible = document.hidden ? performance.now() : undefined;
-            document.addEventListener("visibilitychange", () => {
+            this.visibilityEventHandler = () => {
                 if (document.hidden) {
                     this.lastVisible = performance.now();
                 } else {
                     // settimeout so this will hopefully fire after disconnect event if being hidden caused it
                     setTimeout(() => this.lastVisible = undefined, 0);
                 }
-            });
+            };
+            document.addEventListener("visibilitychange", this.visibilityEventHandler);
         }
 
         // We observed that most users of platform do not check Container.connected event on load, causing bugs.
@@ -684,7 +694,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                     default:
                 }
             }).catch((error) =>  {
-                this.logger.sendErrorEvent({ eventName: "RaiseConnectedEventError" }, error);
+                this.mc.logger.sendErrorEvent({ eventName: "RaiseConnectedEventError" }, error);
             });
         });
     }
@@ -724,10 +734,10 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                 // Driver need to ensure all caches are cleared on critical errors
                 this.service?.dispose(error);
             } catch (exception) {
-                this.logger.sendErrorEvent({ eventName: "ContainerCloseException"}, exception);
+                this.mc.logger.sendErrorEvent({ eventName: "ContainerCloseException"}, exception);
             }
 
-            this.logger.sendTelemetryEvent(
+            this.mc.logger.sendTelemetryEvent(
                 {
                     eventName: "ContainerClose",
                     category: error === undefined ? "generic" : "error",
@@ -738,6 +748,9 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             this.emit("closed", error);
 
             this.removeAllListeners();
+            if (this.visibilityEventHandler !== undefined) {
+                document.removeEventListener("visibilitychange", this.visibilityEventHandler);
+            }
         } finally {
             this._lifecycleState = "closed";
         }
@@ -779,7 +792,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
     }
 
     public async attach(request: IRequest): Promise<void> {
-        await PerformanceEvent.timedExecAsync(this.logger, { eventName: "Attach" }, async () => {
+        await PerformanceEvent.timedExecAsync(this.mc.logger, { eventName: "Attach" }, async () => {
             if (this._lifecycleState !== "loaded") {
                 throw new UsageError(`containerNotValidForAttach [${this._lifecycleState}]`);
             }
@@ -824,7 +837,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                             this.subLogger,
                         ),
                         "containerAttach",
-                        this.logger,
+                        this.mc.logger,
                         {}, // progress
                     );
                 }
@@ -890,7 +903,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
 
     public async request(path: IRequest): Promise<IResponse> {
         return PerformanceEvent.timedExecAsync(
-            this.logger,
+            this.mc.logger,
             { eventName: "Request" },
             async () => this.context.request(path),
             { end: true, cancel: "error" },
@@ -900,7 +913,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
     public async snapshot(tagMessage: string, fullTree: boolean = false): Promise<void> {
         // Only snapshot once a code quorum has been established
         if (!this.protocolHandler.quorum.has("code") && !this.protocolHandler.quorum.has("code2")) {
-            this.logger.sendTelemetryEvent({ eventName: "SkipSnapshot" });
+            this.mc.logger.sendTelemetryEvent({ eventName: "SkipSnapshot" });
             return;
         }
 
@@ -909,7 +922,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             await this.deltaManager.inbound.pause();
             await this.snapshotCore(tagMessage, fullTree);
         } catch (ex) {
-            this.logger.sendErrorEvent({ eventName: "SnapshotExceptionError" }, ex);
+            this.mc.logger.sendErrorEvent({ eventName: "SnapshotExceptionError" }, ex);
             throw ex;
         } finally {
             this.deltaManager.inbound.resume();
@@ -931,7 +944,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         const duration = now - this.setAutoReconnectTime;
         this.setAutoReconnectTime = now;
 
-        this.logger.sendTelemetryEvent({
+        this.mc.logger.sendTelemetryEvent({
             eventName: reconnect ? "AutoReconnectEnabled" : "AutoReconnectDisabled",
             connectionMode: this.connectionMode,
             connectionState: ConnectionState[this.connectionState],
@@ -1007,15 +1020,15 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         }
 
         if (this.codeLoader.IFluidCodeDetailsComparer) {
-            const comparision = await this.codeLoader.IFluidCodeDetailsComparer.compare(
+            const comparison = await this.codeLoader.IFluidCodeDetailsComparer.compare(
                 codeDetails,
                 this.getCodeDetailsFromQuorum());
-            if (comparision !== undefined && comparision <= 0) {
+            if (comparison !== undefined && comparison <= 0) {
                 throw new Error("Proposed code details should be greater than the current");
             }
         }
 
-        return this.getQuorum().propose("code", codeDetails)
+        return this.protocolHandler.quorum.propose("code", codeDetails)
             .then(()=>true)
             .catch(()=>false);
     }
@@ -1341,9 +1354,10 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         const storageService = await this.service.connectToStorage();
 
         this._storageService =
-            new RetriableDocumentStorageService(storageService, this.logger);
+            new RetriableDocumentStorageService(storageService, this.mc.logger);
 
         if(this.options.summarizeProtocolTree === true) {
+            this.mc.logger.sendTelemetryEvent({eventName:"summarizeProtocolTreeEnabled"});
             this._storageService =
                 new ProtocolTreeStorageService(this._storageService, ()=>this.captureProtocolSummary());
         }
@@ -1449,7 +1463,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             (sequenceNumber, key, value) => {
                 if (key === "code" || key === "code2") {
                     if (!isFluidCodeDetails(value)) {
-                        this.logger.sendErrorEvent({
+                        this.mc.logger.sendErrorEvent({
                                 eventName: "CodeProposalNotIFluidCodeDetails",
                         });
                     }
@@ -1646,7 +1660,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             }
         }
 
-        this.logger.sendPerformanceEvent({
+        this.mc.logger.sendPerformanceEvent({
             eventName: `ConnectionStateChange_${ConnectionState[value]}`,
             from: ConnectionState[oldState],
             duration,
@@ -1684,10 +1698,10 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         }
         assert(this.protocolHandler !== undefined, 0x0dc /* "Protocol handler should be set here" */);
         this.protocolHandler.quorum.setConnectionState(state, this.clientId);
-        raiseConnectedEvent(this.logger, this, state, this.clientId);
+        raiseConnectedEvent(this.mc.logger, this, state, this.clientId);
 
         if (logOpsOnReconnect) {
-            this.logger.sendTelemetryEvent(
+            this.mc.logger.sendTelemetryEvent(
                 { eventName: "OpsSentOnReconnect", count: this.messageCountAfterDisconnection });
         }
     }
@@ -1722,7 +1736,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
 
     private submitMessage(type: MessageType, contents: any, batch?: boolean, metadata?: any): number {
         if (this.connectionState !== ConnectionState.Connected) {
-            this.logger.sendErrorEvent({ eventName: "SubmitMessageWithNoConnection", type });
+            this.mc.logger.sendErrorEvent({ eventName: "SubmitMessageWithNoConnection", type });
             return -1;
         }
 
@@ -1800,13 +1814,13 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
 
         if (version === undefined && specifiedVersion !== undefined) {
             // We should have a defined version to load from if specified version requested
-            this.logger.sendErrorEvent({ eventName: "NoVersionFoundWhenSpecified", id: specifiedVersion });
+            this.mc.logger.sendErrorEvent({ eventName: "NoVersionFoundWhenSpecified", id: specifiedVersion });
         }
         this._loadedFromVersion = version;
         const snapshot = await this.storageService.getSnapshotTree(version) ?? undefined;
 
         if (snapshot === undefined && version !== undefined) {
-            this.logger.sendErrorEvent({ eventName: "getSnapshotTreeFailed", id: version.id });
+            this.mc.logger.sendErrorEvent({ eventName: "getSnapshotTreeFailed", id: version.id });
         }
         return { snapshot, versionId: version?.id };
     }
@@ -1838,7 +1852,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         assert(this._context?.disposed !== false, 0x0dd /* "Existing context not disposed" */);
         // If this assert fires, our state tracking is likely not synchronized between COntainer & runtime.
         if (this._dirtyContainer) {
-            this.logger.sendErrorEvent({ eventName: "DirtyContainerReloadContainer" });
+            this.mc.logger.sendErrorEvent({ eventName: "DirtyContainerReloadContainer" });
         }
 
         // The relative loader will proxy requests to '/' to the loader itself assuming no non-cache flags
@@ -1872,6 +1886,6 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
     // Please avoid calling it directly.
     // raiseContainerWarning() is the right flow for most cases
     private logContainerError(warning: ContainerWarning) {
-        this.logger.sendErrorEvent({ eventName: "ContainerWarning" }, warning);
+        this.mc.logger.sendErrorEvent({ eventName: "ContainerWarning" }, warning);
     }
 }

package/src/containerContext.ts

@@ -132,6 +132,9 @@ export class ContainerContext implements IContainerContext {
         return this.container.options;
     }
 
+    /**
+     * @deprecated 0.55 - Configuration is not recommended to be used and will be removed in an upcoming release.
+     */
     public get configuration(): IFluidConfiguration {
         const config: Partial<IFluidConfiguration> = {
             scopes: this.container.scopes,
@@ -163,6 +166,10 @@ export class ContainerContext implements IContainerContext {
 
     public get codeDetails() { return this._codeDetails; }
 
+    private readonly _quorum: IQuorum;
+    // Update to return IQuorumClients after 0.45 container definitions are picked up.
+    public get quorum(): IQuorum { return this._quorum; }
+
     private readonly _fluidModuleP: Promise<IFluidModuleWithDetails>;
 
     constructor(
@@ -172,7 +179,7 @@ export class ContainerContext implements IContainerContext {
         private readonly _codeDetails: IFluidCodeDetails,
         private readonly _baseSnapshot: ISnapshotTree | undefined,
         public readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
-        public readonly quorum: IQuorum,
+        quorum: IQuorum,
         public readonly loader: ILoader,
         public readonly raiseContainerWarning: (warning: ContainerWarning) => void,
         public readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData: any) => number,
@@ -184,6 +191,7 @@ export class ContainerContext implements IContainerContext {
         public readonly pendingLocalState?: unknown,
 
     ) {
+        this._quorum = quorum;
         this.taggedLogger = container.subLogger;
         this._fluidModuleP = new LazyPromise<IFluidModuleWithDetails>(
             async () => this.loadCodeModule(_codeDetails),
@@ -192,7 +200,7 @@ export class ContainerContext implements IContainerContext {
     }
 
     public getSpecifiedCodeDetails(): IFluidCodeDetails | undefined {
-        return (this.quorum.get("code") ?? this.quorum.get("code2")) as IFluidCodeDetails | undefined;
+        return (this._quorum.get("code") ?? this._quorum.get("code2")) as IFluidCodeDetails | undefined;
     }
 
     public dispose(error?: Error): void {
@@ -202,7 +210,7 @@ export class ContainerContext implements IContainerContext {
         this._disposed = true;
 
         this.runtime.dispose(error);
-        this.quorum.dispose();
+        this._quorum.dispose();
         this.deltaManager.dispose();
     }
 

package/src/loader.ts

@@ -130,7 +130,7 @@ function createCachedResolver(resolver: IUrlResolver) {
 }
 
 export interface ILoaderOptions extends ILoaderOptions1{
-    summarizeProtocolTree?: true,
+    summarizeProtocolTree?: boolean,
 }
 
 /**
@@ -179,7 +179,7 @@ export interface ILoaderProps {
     readonly urlResolver: IUrlResolver;
     /**
      * The document service factory take the Fluid url provided
-     * by the resolved url and constucts all the necessary services
+     * by the resolved url and constructs all the necessary services
      * for communication with the container's server.
      */
     readonly documentServiceFactory: IDocumentServiceFactory;
@@ -235,7 +235,7 @@ export interface ILoaderServices {
     readonly urlResolver: IUrlResolver;
     /**
      * The document service factory take the Fluid url provided
-     * by the resolved url and constucts all the necessary services
+     * by the resolved url and constructs all the necessary services
      * for communication with the container's server.
      */
     readonly documentServiceFactory: IDocumentServiceFactory;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "0.54.1";
+export const pkgVersion = "0.55.1";