@fluidframework/container-loader 0.59.4001 → 1.1.0-75972

package/src/containerContext.ts

@@ -21,7 +21,7 @@ import {
     IProvideFluidCodeDetailsComparer,
     ICodeDetailsLoader,
     IFluidModuleWithDetails,
-    IFluidModule,
+    ISnapshotTreeWithBlobContents,
 } from "@fluidframework/container-definitions";
 import {
     IRequest,
@@ -92,7 +92,9 @@ export class ContainerContext implements IContainerContext {
         return this.container.clientId;
     }
 
-    /** @deprecated Added back to unblock 0.56 integration */
+    /**
+     * DISCLAIMER: this id is only for telemetry purposes. Not suitable for any other usages.
+     */
     public get id(): string {
         const resolvedUrl = this.container.resolvedUrl;
         if (isFluidResolvedUrl(resolvedUrl)) {
@@ -159,7 +161,7 @@ export class ContainerContext implements IContainerContext {
         public readonly scope: FluidObject,
         private readonly codeLoader: ICodeDetailsLoader,
         private readonly _codeDetails: IFluidCodeDetails,
-        private readonly _baseSnapshot: ISnapshotTree | undefined,
+        private _baseSnapshot: ISnapshotTree | undefined,
         public readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
         quorum: IQuorum,
         public readonly loader: ILoader,
@@ -287,7 +289,9 @@ export class ContainerContext implements IContainerContext {
         return true;
     }
 
-    public notifyAttaching() {
+    public notifyAttaching(snapshot: ISnapshotTreeWithBlobContents) {
+        this._baseSnapshot = snapshot;
+        this.runtime.notifyAttaching?.(snapshot);
         this.runtime.setAttachState(AttachState.Attaching);
     }
 
@@ -316,11 +320,7 @@ export class ContainerContext implements IContainerContext {
     }
 
     private async loadCodeModule(codeDetails: IFluidCodeDetails): Promise<IFluidModuleWithDetails> {
-        // load may actually produce a IFluidModule if using a legacy ICodeLoader.
-        // Because the type system currently does not capture this in load,
-        // explicitly declare the type here to support both cases.
-        // See also comment about this below.
-        const loadCodeResult: IFluidModuleWithDetails | IFluidModule = await PerformanceEvent.timedExecAsync(
+        const loadCodeResult = await PerformanceEvent.timedExecAsync(
             this.taggedLogger,
             { eventName: "CodeLoad" },
             async () => this.codeLoader.load(codeDetails),
@@ -336,7 +336,7 @@ export class ContainerContext implements IContainerContext {
             // If "module" is not in the result, we are using a legacy ICodeLoader.  Fix the result up with details.
             // Once usage drops to 0 we can remove this compat path.
             this.taggedLogger.sendTelemetryEvent({ eventName: "LegacyCodeLoader" });
-            return { module: loadCodeResult, details: codeDetails };
+            return loadCodeResult;
         }
     }
     // #endregion

package/src/containerStorageAdapter.ts

@@ -4,6 +4,7 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ISnapshotTreeWithBlobContents } from "@fluidframework/container-definitions";
 import {
     IDocumentStorageService,
     IDocumentStorageServicePolicies,
@@ -14,11 +15,9 @@ import {
     ISnapshotTree,
     ISummaryHandle,
     ISummaryTree,
-    ITree,
     IVersion,
 } from "@fluidframework/protocol-definitions";
 import { IDetachedBlobStorage } from "./loader";
-import { ISnapshotTreeWithBlobContents } from "./utils";
 
 /**
  * This class wraps the actual storage and make sure no wrong apis are called according to
@@ -54,8 +53,8 @@ export class ContainerStorageAdapter implements IDocumentStorageService {
         return this.storageGetter().repositoryUrl;
     }
 
-    public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
-        return this.storageGetter().getSnapshotTree(version);
+    public async getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null> {
+        return this.storageGetter().getSnapshotTree(version, scenarioName);
     }
 
     public async readBlob(id: string): Promise<ArrayBufferLike> {
@@ -66,12 +65,8 @@ export class ContainerStorageAdapter implements IDocumentStorageService {
         return this.storageGetter().readBlob(id);
     }
 
-    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
-        return this.storageGetter().getVersions(versionId, count);
-    }
-
-    public async write(tree: ITree, parents: string[], message: string, ref: string): Promise<IVersion> {
-        return this.storageGetter().write(tree, parents, message, ref);
+    public async getVersions(versionId: string | null, count: number, scenarioName?: string): Promise<IVersion[]> {
+        return this.storageGetter().getVersions(versionId, count, scenarioName);
     }
 
     public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {

package/src/contracts.ts

@@ -163,7 +163,7 @@ export interface IConnectionManagerFactoryArgs {
 
 /**
  *
- * @param codeDetails- Data structure used to describe the code to load on the Fluid document
+ * @param codeDetails- - Data structure used to describe the code to load on the Fluid document
  * @returns The name of the Fluid package
  */
 export const getPackageName = (codeDetails: IFluidCodeDetails | undefined): IContainerPackageInfo => {

package/src/deltaManager.ts

@@ -267,8 +267,14 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
     ) {
         super();
         const props: IConnectionManagerFactoryArgs = {
-            incomingOpHandler: (messages: ISequencedDocumentMessage[], reason: string) =>
-                this.enqueueMessages(messages, reason),
+            incomingOpHandler: (messages: ISequencedDocumentMessage[], reason: string) => {
+                try {
+                    this.enqueueMessages(messages, reason);
+                } catch (error) {
+                    this.logger.sendErrorEvent({ eventName: "EnqueueMessages_Exception" }, error);
+                    this.close(normalizeError(error));
+                }
+            },
             signalHandler: (message: ISignalMessage) => this._inboundSignal.push(message),
             reconnectionDelayHandler: (delayMs: number, error: unknown) =>
                 this.emitDelayInfo(this.deltaStreamDelayId, delayMs, error),

package/src/deltaManagerProxy.ts

@@ -148,10 +148,6 @@ export class DeltaManagerProxy
         super.dispose();
     }
 
-    public close(): void {
-        return this.deltaManager.close();
-    }
-
     public submitSignal(content: any): void {
         return this.deltaManager.submitSignal(content);
     }

package/src/deltaQueue.ts

@@ -85,9 +85,13 @@ export class DeltaQueue<T>
     }
 
     public push(task: T) {
-        this.q.push(task);
-        this.emit("push", task);
-        this.ensureProcessing();
+        try {
+            this.q.push(task);
+            this.emit("push", task);
+            this.ensureProcessing();
+        } catch (error) {
+            this.emit("error", error);
+        }
     }
 
     public async pause(): Promise<void> {

package/src/index.ts

@@ -8,6 +8,7 @@ export {
     Container,
     IContainerLoadOptions,
     IContainerConfig,
+    IPendingContainerState,
     waitContainerToCatchUp,
 } from "./container";
 export {

package/src/loader.ts

@@ -17,9 +17,7 @@ import {
     IFluidModule,
     IHostLoader,
     ILoader,
-    IPendingLocalState,
     ILoaderOptions as ILoaderOptions1,
-    IProxyLoaderFactory,
     LoaderHeader,
     IProvideFluidCodeDetailsComparer,
     IFluidCodeDetails,
@@ -47,7 +45,7 @@ import {
     MultiUrlResolver,
     MultiDocumentServiceFactory,
 } from "@fluidframework/driver-utils";
-import { Container } from "./container";
+import { Container, IPendingContainerState } from "./container";
 import { IParsedUrl, parseUrl } from "./utils";
 import { pkgVersion } from "./packageVersion";
 
@@ -200,13 +198,6 @@ export interface ILoaderProps {
      */
     readonly scope?: FluidObject;
 
-    /**
-     * Proxy loader factories for loading containers via proxy in other contexts,
-     * like web workers, or worker threads.
-     * @deprecated Not recommended for general use and will be removed in an upcoming release.
-     */
-    readonly proxyLoaderFactories?: Map<string, IProxyLoaderFactory>;
-
     /**
      * The logger that all telemetry should be pushed to.
      */
@@ -257,13 +248,6 @@ export interface ILoaderServices {
      */
     readonly scope: FluidObject;
 
-    /**
-     * Proxy loader factories for loading containers via proxy in other contexts,
-     * like web workers, or worker threads.
-     * @deprecated Not recommended for general use and will be removed in an upcoming release.
-     */
-    readonly proxyLoaderFactories: Map<string, IProxyLoaderFactory>;
-
     /**
      * The logger downstream consumers should construct their loggers from
      */
@@ -318,7 +302,6 @@ export class Loader implements IHostLoader {
             options: loaderProps.options ?? {},
             scope,
             subLogger: subMc.logger,
-            proxyLoaderFactories: loaderProps.proxyLoaderFactories ?? new Map<string, IProxyLoaderFactory>(),
             detachedBlobStorage: loaderProps.detachedBlobStorage,
         };
         this.mc = loggerToMonitoringContext(
@@ -394,7 +377,7 @@ export class Loader implements IHostLoader {
 
     private async resolveCore(
         request: IRequest,
-        pendingLocalState?: IPendingLocalState,
+        pendingLocalState?: IPendingContainerState,
     ): Promise<{ container: Container; parsed: IParsedUrl; }> {
         const resolvedAsFluid = await this.services.urlResolver.resolve(request);
         ensureFluidResolvedUrl(resolvedAsFluid);
@@ -436,7 +419,7 @@ export class Loader implements IHostLoader {
                 await this.loadContainer(
                     request,
                     resolvedAsFluid,
-                    pendingLocalState?.pendingRuntimeState);
+                    pendingLocalState);
         }
 
         if (container.deltaManager.lastSequenceNumber <= fromSequenceNumber) {
@@ -487,7 +470,7 @@ export class Loader implements IHostLoader {
     private async loadContainer(
         request: IRequest,
         resolved: IFluidResolvedUrl,
-        pendingLocalState?: unknown,
+        pendingLocalState?: IPendingContainerState,
     ): Promise<Container> {
         return Container.load(
             this,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "0.59.4001";
+export const pkgVersion = "1.1.0-75972";

package/src/protocolTreeDocumentStorageService.ts

@@ -31,7 +31,6 @@ export class ProtocolTreeStorageService implements IDocumentStorageService, IDis
 
     getSnapshotTree = this.internalStorageService.getSnapshotTree.bind(this.internalStorageService);
     getVersions = this.internalStorageService.getVersions.bind(this.internalStorageService);
-    write = this.internalStorageService.write.bind(this.internalStorageService);
     createBlob = this.internalStorageService.createBlob.bind(this.internalStorageService);
     readBlob = this.internalStorageService.readBlob.bind(this.internalStorageService);
     downloadSummary = this.internalStorageService.downloadSummary.bind(this.internalStorageService);

package/src/retriableDocumentStorageService.ts

@@ -15,7 +15,6 @@ import {
     ISnapshotTree,
     ISummaryHandle,
     ISummaryTree,
-    ITree,
     IVersion,
 } from "@fluidframework/protocol-definitions";
 import { IDisposable, ITelemetryLogger } from "@fluidframework/common-definitions";
@@ -41,9 +40,9 @@ export class RetriableDocumentStorageService implements IDocumentStorageService,
         return this.internalStorageService.repositoryUrl;
     }
 
-    public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
+    public async getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null> {
         return this.runWithRetry(
-            async () => this.internalStorageService.getSnapshotTree(version),
+            async () => this.internalStorageService.getSnapshotTree(version, scenarioName),
             "storage_getSnapshotTree",
         );
     }
@@ -55,20 +54,13 @@ export class RetriableDocumentStorageService implements IDocumentStorageService,
         );
     }
 
-    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
+    public async getVersions(versionId: string | null, count: number, scenarioName?: string): Promise<IVersion[]> {
         return this.runWithRetry(
-            async () => this.internalStorageService.getVersions(versionId, count),
+            async () => this.internalStorageService.getVersions(versionId, count, scenarioName),
             "storage_getVersions",
         );
     }
 
-    public async write(tree: ITree, parents: string[], message: string, ref: string): Promise<IVersion> {
-        return this.runWithRetry(
-            async () => this.internalStorageService.write(tree, parents, message, ref),
-            "storage_write",
-        );
-    }
-
     public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {
         // Not using retry loop here. Couple reasons:
         // 1. If client lost connectivity, then retry loop will result in uploading stale summary

package/src/utils.ts

@@ -12,6 +12,7 @@ import {
     unreachableCase,
 } from "@fluidframework/common-utils";
 import { ISummaryTree, ISnapshotTree, SummaryType } from "@fluidframework/protocol-definitions";
+import { LoggingError } from "@fluidframework/telemetry-utils";
 
 // This is used when we rehydrate a container from the snapshot. Here we put the blob contents
 // in separate property: blobContents.
@@ -35,7 +36,7 @@ export interface IParsedUrl {
 export function parseUrl(url: string): IParsedUrl | undefined {
     const parsed = parse(url, true);
     if (typeof parsed.pathname !== "string") {
-        throw new Error("Failed to parse pathname");
+        throw new LoggingError("Failed to parse pathname");
     }
     const query = parsed.search ?? "";
     const regex = /^\/([^/]*\/[^/]*)(\/?.*)$/;
@@ -86,7 +87,7 @@ function convertSummaryToSnapshotWithEmbeddedBlobContents(
                 break;
             }
             case SummaryType.Handle:
-                throw new Error("No handles should be there in summary in detached container!!");
+                throw new LoggingError("No handles should be there in summary in detached container!!");
                 break;
             default: {
                 unreachableCase(summaryObject, `Unknown tree type ${(summaryObject as any).type}`);