@fluidframework/container-loader 0.58.3000-61081 → 0.59.1001-62246

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "0.58.3000-61081",
+  "version": "0.59.1001-62246",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,14 +62,14 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^0.47.1000",
-    "@fluidframework/container-utils": "0.58.3000-61081",
-    "@fluidframework/core-interfaces": "^0.42.0",
-    "@fluidframework/driver-definitions": "^0.45.2000-0",
-    "@fluidframework/driver-utils": "0.58.3000-61081",
-    "@fluidframework/protocol-base": "^0.1035.1000",
-    "@fluidframework/protocol-definitions": "^0.1027.1000",
-    "@fluidframework/telemetry-utils": "0.58.3000-61081",
+    "@fluidframework/container-definitions": "^0.48.1000",
+    "@fluidframework/container-utils": "0.59.1001-62246",
+    "@fluidframework/core-interfaces": "^0.43.1000",
+    "@fluidframework/driver-definitions": "^0.46.1000",
+    "@fluidframework/driver-utils": "0.59.1001-62246",
+    "@fluidframework/protocol-base": "^0.1036.1000",
+    "@fluidframework/protocol-definitions": "^0.1028.1000",
+    "@fluidframework/telemetry-utils": "0.59.1001-62246",
     "abort-controller": "^3.0.0",
     "double-ended-queue": "^2.1.0-0",
     "lodash": "^4.17.21",
@@ -77,10 +77,10 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@0.58.2000",
-    "@fluidframework/eslint-config-fluid": "^0.27.2000-59622",
-    "@fluidframework/mocha-test-setup": "0.58.3000-61081",
-    "@fluidframework/test-loader-utils": "0.58.3000-61081",
+    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@^0.58.0",
+    "@fluidframework/eslint-config-fluid": "^0.28.1000",
+    "@fluidframework/mocha-test-setup": "0.59.1001-62246",
+    "@fluidframework/test-loader-utils": "0.59.1001-62246",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/double-ended-queue": "^2.1.0",
@@ -108,11 +108,12 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.58.3000",
+    "version": "0.59.1000",
     "broken": {
-      "0.58.2000": {
+      "0.58.2002": {
         "ClassDeclaration_Container": {
-          "forwardCompat": false
+          "forwardCompat": false,
+          "backCompat": false
         }
       }
     }

package/src/container.ts

@@ -14,8 +14,6 @@ import {
     IRequest,
     IResponse,
     IFluidRouter,
-    IFluidCodeDetails,
-    isFluidCodeDetails,
 } from "@fluidframework/core-interfaces";
 import {
     IAudience,
@@ -30,6 +28,8 @@ import {
     IPendingLocalState,
     ReadOnlyInfo,
     IContainerLoadMode,
+    IFluidCodeDetails,
+    isFluidCodeDetails,
 } from "@fluidframework/container-definitions";
 import {
     DataCorruptionError,
@@ -92,7 +92,7 @@ import {
 } from "@fluidframework/telemetry-utils";
 import { Audience } from "./audience";
 import { ContainerContext } from "./containerContext";
-import { ReconnectMode, IConnectionManagerFactoryArgs } from "./contracts";
+import { ReconnectMode, IConnectionManagerFactoryArgs, getPackageName } from "./contracts";
 import { DeltaManager, IConnectionArgs } from "./deltaManager";
 import { DeltaManagerProxy } from "./deltaManagerProxy";
 import { ILoaderOptions, Loader, RelativeLoader } from "./loader";
@@ -824,7 +824,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                 ensureFluidResolvedUrl(createNewResolvedUrl);
                 if (this.service === undefined) {
                     assert(this.client.details.type !== summarizerClientType,
-                        "client should not be summarizer before container is created");
+                        0x2c4 /* "client should not be summarizer before container is created" */);
                     this.service = await runWithRetry(
                         async () => this.serviceFactory.createContainer(
                             summary,
@@ -969,8 +969,9 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
     }
 
     private connectInternal(args: IConnectionArgs) {
-        assert(!this.closed, "Attempting to connect() a closed Container");
-        assert(this._attachState === AttachState.Attached, "Attempting to connect() a container that is not attached");
+        assert(!this.closed, 0x2c5 /* "Attempting to connect() a closed Container" */);
+        assert(this._attachState === AttachState.Attached,
+            0x2c6 /* "Attempting to connect() a container that is not attached" */);
 
         // Resume processing ops and connect to delta stream
         this.resumeInternal(args);
@@ -990,7 +991,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
     }
 
     private disconnectInternal() {
-        assert(!this.closed, "Attempting to disconnect() a closed Container");
+        assert(!this.closed, 0x2c7 /* "Attempting to disconnect() a closed Container" */);
 
         // Set Auto Reconnect Mode
         const mode = ReconnectMode.Disabled;
@@ -1026,21 +1027,6 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         this.connectToDeltaStream(args);
     }
 
-    /**
-     * @deprecated 0.56, will be removed in next release from IContainerContext
-     * Raise non-critical error to host. Calling this API will not close container.
-     * For critical errors, please call Container.close(error).
-     * @param error - an error to raise
-     */
-    public raiseContainerWarning(warning: ContainerWarning) {
-        // Some "warning" events come from outside the container and are logged
-        // elsewhere (e.g. summarizing container). We shouldn't log these here.
-        if (warning.logged !== true) {
-            this.logContainerError(warning);
-        }
-        this.emit("warning", warning);
-    }
-
     public async getAbsoluteUrl(relativeUrl: string): Promise<string | undefined> {
         if (this.resolvedUrl === undefined) {
             return undefined;
@@ -1049,7 +1035,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         return this.urlResolver.getAbsoluteUrl(
             this.resolvedUrl,
             relativeUrl,
-            this._context?.codeDetails);
+            getPackageName(this._context?.codeDetails));
     }
 
     public async proposeCodeDetails(codeDetails: IFluidCodeDetails) {
@@ -1553,7 +1539,13 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         });
 
         deltaManager.on("throttled", (warning: IThrottlingWarning) => {
-            this.raiseContainerWarning(warning);
+            const warn = warning as ContainerWarning;
+            // Some "warning" events come from outside the container and are logged
+            // elsewhere (e.g. summarizing container). We shouldn't log these here.
+            if (warn.logged !== true) {
+                this.logContainerError(warn);
+            }
+            this.emit("warning", warn);
         });
 
         deltaManager.on("readonly", (readonly) => {
@@ -1823,7 +1815,6 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             new DeltaManagerProxy(this._deltaManager),
             new QuorumProxy(this.protocolHandler.quorum),
             loader,
-            (warning: ContainerWarning) => this.raiseContainerWarning(warning),
             (type, contents, batch, metadata) => this.submitContainerMessage(type, contents, batch, metadata),
             (message) => this.submitSignal(message),
             (error?: ICriticalContainerError) => this.close(error),

package/src/containerContext.ts

@@ -12,20 +12,19 @@ import {
     ILoader,
     IRuntime,
     ICriticalContainerError,
-    ContainerWarning,
     AttachState,
     ILoaderOptions,
     IRuntimeFactory,
-    ICodeLoader,
     IProvideRuntimeFactory,
+    IFluidCodeDetails,
+    IFluidCodeDetailsComparer,
+    IProvideFluidCodeDetailsComparer,
+    ICodeDetailsLoader,
+    IFluidModuleWithDetails,
 } from "@fluidframework/container-definitions";
 import {
-    IFluidObject,
     IRequest,
     IResponse,
-    IFluidCodeDetails,
-    IFluidCodeDetailsComparer,
-    IProvideFluidCodeDetailsComparer,
     FluidObject,
 } from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
@@ -45,7 +44,6 @@ import {
 } from "@fluidframework/protocol-definitions";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { Container } from "./container";
-import { ICodeDetailsLoader, IFluidModuleWithDetails } from "./loader";
 
 const PackageNotFactoryError = "Code package does not implement IRuntimeFactory";
 
@@ -53,13 +51,12 @@ export class ContainerContext implements IContainerContext {
     public static async createOrLoad(
         container: Container,
         scope: FluidObject,
-        codeLoader: ICodeDetailsLoader | ICodeLoader,
+        codeLoader: ICodeDetailsLoader,
         codeDetails: IFluidCodeDetails,
         baseSnapshot: ISnapshotTree | undefined,
         deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
         quorum: IQuorum,
         loader: ILoader,
-        raiseContainerWarning: (warning: ContainerWarning) => void,
         submitFn: (type: MessageType, contents: any, batch: boolean, appData: any) => number,
         submitSignalFn: (contents: any) => void,
         closeFn: (error?: ICriticalContainerError) => void,
@@ -77,7 +74,6 @@ export class ContainerContext implements IContainerContext {
             deltaManager,
             quorum,
             loader,
-            raiseContainerWarning,
             submitFn,
             submitSignalFn,
             closeFn,
@@ -159,14 +155,13 @@ export class ContainerContext implements IContainerContext {
 
     constructor(
         private readonly container: Container,
-        public readonly scope: IFluidObject & FluidObject,
-        private readonly codeLoader: ICodeDetailsLoader | ICodeLoader,
+        public readonly scope: FluidObject,
+        private readonly codeLoader: ICodeDetailsLoader,
         private readonly _codeDetails: IFluidCodeDetails,
         private readonly _baseSnapshot: ISnapshotTree | undefined,
         public readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
         quorum: IQuorum,
         public readonly loader: ILoader,
-        public readonly raiseContainerWarning: (warning: ContainerWarning) => void,
         public readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData: any) => number,
         public readonly submitSignalFn: (contents: any) => void,
         public readonly closeFn: (error?: ICriticalContainerError) => void,
@@ -333,6 +328,9 @@ export class ContainerContext implements IContainerContext {
                 details: details ?? codeDetails,
             };
         } else {
+            // 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 };
         }
     }

package/src/contracts.ts

@@ -11,6 +11,8 @@ import {
     ReadOnlyInfo,
     IConnectionDetails,
     ICriticalContainerError,
+    IFluidCodeDetails,
+    isFluidPackage,
 } from "@fluidframework/container-definitions";
 import {
     ConnectionMode,
@@ -20,6 +22,7 @@ import {
     IClientDetails,
     ISignalMessage,
 } from "@fluidframework/protocol-definitions";
+import { IContainerPackageInfo } from "@fluidframework/driver-definitions";
 
 export enum ReconnectMode {
     Never = "Never",
@@ -155,3 +158,20 @@ export interface IConnectionManagerFactoryArgs {
      */
     readonly readonlyChangeHandler: (readonly?: boolean) => void,
 }
+
+/**
+ *
+ * @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 => {
+    let containerPackageName;
+    if (codeDetails && "name" in codeDetails) {
+        containerPackageName = codeDetails;
+    } else if (isFluidPackage(codeDetails?.package)) {
+        containerPackageName = codeDetails?.package.name;
+    } else {
+        containerPackageName = codeDetails?.package;
+    }
+    return { name: containerPackageName };
+};

package/src/loader.ts

@@ -7,15 +7,12 @@ import { v4 as uuid } from "uuid";
 import { ITelemetryBaseLogger, ITelemetryLogger } from "@fluidframework/common-definitions";
 import {
     FluidObject,
-    IFluidCodeDetails,
     IFluidRouter,
-    IProvideFluidCodeDetailsComparer,
     IRequest,
     IRequestHeader,
     IResponse,
 } from "@fluidframework/core-interfaces";
 import {
-    ICodeLoader,
     IContainer,
     IFluidModule,
     IHostLoader,
@@ -24,6 +21,8 @@ import {
     ILoaderOptions as ILoaderOptions1,
     IProxyLoaderFactory,
     LoaderHeader,
+    IProvideFluidCodeDetailsComparer,
+    IFluidCodeDetails,
 } from "@fluidframework/container-definitions";
 import {
     ChildLogger,
@@ -187,7 +186,7 @@ export interface ILoaderProps {
      * The code loader handles loading the necessary code
      * for running a container once it is loaded.
      */
-    readonly codeLoader: ICodeDetailsLoader | ICodeLoader;
+    readonly codeLoader: ICodeDetailsLoader;
 
     /**
      * A property bag of options used by various layers
@@ -243,7 +242,7 @@ export interface ILoaderServices {
      * The code loader handles loading the necessary code
      * for running a container once it is loaded.
      */
-    readonly codeLoader: ICodeDetailsLoader | ICodeLoader;
+    readonly codeLoader: ICodeDetailsLoader;
 
     /**
      * A property bag of options used by various layers
@@ -295,7 +294,7 @@ export class Loader implements IHostLoader {
     private readonly mc: MonitoringContext;
 
     constructor(loaderProps: ILoaderProps) {
-        const scope = { ...loaderProps.scope as FluidObject<ILoader> };
+        const scope: FluidObject<ILoader> = { ...loaderProps.scope };
         if (loaderProps.options?.provideScopeLoader !== false) {
             scope.ILoader = this;
         }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "0.58.3000-61081";
+export const pkgVersion = "0.59.1001-62246";

package/src/utils.ts

@@ -62,7 +62,6 @@ function convertSummaryToSnapshotWithEmbeddedBlobContents(
         blobs: {},
         blobsContents: {},
         trees: {},
-        commits: {},
         id: uuid(),
         unreferenced: summary.unreferenced,
     };