@fluidframework/container-loader 0.58.1001 → 0.58.2001

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "0.58.1001",
+  "version": "0.58.2001",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
-  "repository": "https://github.com/microsoft/FluidFramework",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/loader/container-loader"
+  },
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
@@ -59,13 +63,13 @@
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
     "@fluidframework/container-definitions": "^0.47.1000",
-    "@fluidframework/container-utils": "^0.58.1001",
+    "@fluidframework/container-utils": "^0.58.2001",
     "@fluidframework/core-interfaces": "^0.42.0",
     "@fluidframework/driver-definitions": "^0.45.1000",
-    "@fluidframework/driver-utils": "^0.58.1001",
+    "@fluidframework/driver-utils": "^0.58.2001",
     "@fluidframework/protocol-base": "^0.1035.1000",
     "@fluidframework/protocol-definitions": "^0.1027.1000",
-    "@fluidframework/telemetry-utils": "^0.58.1001",
+    "@fluidframework/telemetry-utils": "^0.58.2001",
     "abort-controller": "^3.0.0",
     "double-ended-queue": "^2.1.0-0",
     "lodash": "^4.17.21",
@@ -73,9 +77,9 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.26.0",
-    "@fluidframework/mocha-test-setup": "^0.58.1001",
-    "@fluidframework/test-loader-utils": "^0.58.1001",
+    "@fluidframework/eslint-config-fluid": "^0.27.0",
+    "@fluidframework/mocha-test-setup": "^0.58.2001",
+    "@fluidframework/test-loader-utils": "^0.58.2001",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/double-ended-queue": "^2.1.0",

package/src/connectionManager.ts

@@ -29,9 +29,9 @@ import {
     createGenericNetworkError,
     getRetryDelayFromError,
     IAnyDriverError,
-    logNetworkFailure,
     waitForConnectedState,
     DeltaStreamConnectionForbiddenError,
+    logNetworkFailure,
 } from "@fluidframework/driver-utils";
 import {
     ConnectionMode,
@@ -490,18 +490,15 @@ export class ConnectionManager implements IConnectionManager {
                     throw error;
                 }
 
-                // Log error once - we get too many errors in logs when we are offline,
-                // and unfortunately there is no reliable way to detect that.
-                if (connectRepeatCount === 1) {
-                    logNetworkFailure(
-                        this.logger,
-                        {
-                            delay: delayMs, // milliseconds
-                            eventName: "DeltaConnectionFailureToConnect",
-                            duration: TelemetryLogger.formatTick(performance.now() - connectStartTime),
-                        },
-                        origError);
-                }
+                logNetworkFailure(
+                    this.logger,
+                    {
+                        attempts: connectRepeatCount,
+                        delay: delayMs, // milliseconds
+                        eventName: "DeltaConnectionFailureToConnect",
+                        duration: TelemetryLogger.formatTick(performance.now() - connectStartTime),
+                    },
+                    origError);
 
                 lastError = origError;
 
@@ -515,9 +512,10 @@ export class ConnectionManager implements IConnectionManager {
             }
         }
 
-        // If we retried more than once, log an event about how long it took
+        // If we retried more than once, log an event about how long it took (this will not log to error table)
         if (connectRepeatCount > 1) {
-            this.logger.sendTelemetryEvent(
+            logNetworkFailure(
+                this.logger,
                 {
                     eventName: "MultipleDeltaConnectionFailures",
                     attempts: connectRepeatCount,
@@ -856,9 +854,9 @@ export class ConnectionManager implements IConnectionManager {
     // Always connect in write mode after getting nacked.
     private readonly nackHandler = (documentId: string, messages: INack[]) => {
         const message = messages[0];
-        if (this._readonlyPermissions) {
+        if (this._readonlyPermissions === true) {
             this.props.closeHandler(createWriteError("writeOnReadOnlyDocument", { driverVersion: undefined }));
-            return
+            return;
         }
 
         const reconnectInfo = getNackReconnectInfo(message.content);

package/src/container.ts

@@ -258,6 +258,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
                 const mode: IContainerLoadMode = loadOptions.loadMode ?? defaultMode;
 
                 const onClosed = (err?: ICriticalContainerError) => {
+                    // pre-0.58 error message: containerClosedWithoutErrorDuringLoad
                     reject(err ?? new GenericError("Container closed without error during load"));
                 };
                 container.on("closed", onClosed);
@@ -780,6 +781,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
     public async attach(request: IRequest): Promise<void> {
         await PerformanceEvent.timedExecAsync(this.mc.logger, { eventName: "Attach" }, async () => {
             if (this._lifecycleState !== "loaded") {
+                // pre-0.58 error message: containerNotValidForAttach
                 throw new UsageError(`The Container is not in a valid state for attach [${this._lifecycleState}]`);
             }
 
@@ -1014,6 +1016,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             return;
         }
 
+        // pre-0.58 error message: existingContextDoesNotSatisfyIncomingProposal
         this.close(new GenericError("Existing context does not satisfy incoming proposal"));
     }
 
@@ -1640,8 +1643,10 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             const client: ILocalSequencedClient | undefined =
                 this.getQuorum().getMember(message.clientId);
             if (client === undefined && message.type !== MessageType.ClientJoin) {
+                // pre-0.58 error message: messageClientIdMissingFromQuorum
                 errorMsg = "Remote message's clientId is missing from the quorum";
             } else if (client?.shouldHaveLeft === true && message.type !== MessageType.NoOp) {
+                // pre-0.58 error message: messageClientIdShouldHaveLeft
                 errorMsg = "Remote message's clientId already should have left";
             }
             if (errorMsg !== undefined) {

package/src/containerContext.ts

@@ -4,15 +4,7 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import {
-    IFluidObject,
-    IRequest,
-    IResponse,
-    IFluidCodeDetails,
-    IFluidCodeDetailsComparer,
-    IProvideFluidCodeDetailsComparer,
-    FluidObject,
-} from "@fluidframework/core-interfaces";
+import { assert, LazyPromise } from "@fluidframework/common-utils";
 import {
     IAudience,
     IContainerContext,
@@ -27,7 +19,17 @@ import {
     ICodeLoader,
     IProvideRuntimeFactory,
 } from "@fluidframework/container-definitions";
+import {
+    IFluidObject,
+    IRequest,
+    IResponse,
+    IFluidCodeDetails,
+    IFluidCodeDetailsComparer,
+    IProvideFluidCodeDetailsComparer,
+    FluidObject,
+} from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
+import { isFluidResolvedUrl } from "@fluidframework/driver-utils";
 import {
     IClientConfiguration,
     IClientDetails,
@@ -42,9 +44,7 @@ import {
     MessageType,
 } from "@fluidframework/protocol-definitions";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
-import { assert, LazyPromise } from "@fluidframework/common-utils";
 import { Container } from "./container";
-import { isFluidResolvedUrl } from "@fluidframework/driver-utils";
 import { ICodeDetailsLoader, IFluidModuleWithDetails } from "./loader";
 
 const PackageNotFactoryError = "Code package does not implement IRuntimeFactory";

package/src/deltaManager.ts

@@ -53,7 +53,6 @@ import {
     IConnectionManagerFactoryArgs,
     IConnectionManager,
  } from "./contracts";
-import { TelemetryDataTag } from "@fluidframework/telemetry-utils";
 
 export interface IConnectionArgs {
     mode?: ConnectionMode;
@@ -184,7 +183,6 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
     public get clientDetails() { return this.connectionManager.clientDetails; }
 
     public submit(type: MessageType, contents: any, batch = false, metadata?: any) {
-
         const messagePartial: Omit<IDocumentMessage, "clientSequenceNumber"> = {
             contents: JSON.stringify(contents),
             metadata,
@@ -571,21 +569,7 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
     }
 
     private disconnectHandler(reason: string) {
-        if (this.messageBuffer.length > 0) {
-            // Behavior is not well defined here RE batches across connections / disconnect.
-            // DeltaManager overall policy - drop all ops on disconnection and rely on
-            // container runtime to deal with resubmitting any ops that did not make it through.
-            // So drop them, but also raise error event to look into details.
-            this.logger.sendTelemetryEvent({
-                eventName: "OpenBatchOnDisconnect",
-                length: this.messageBuffer.length,
-                reason: {
-                    value: reason,
-                    tag: TelemetryDataTag.PackageData,
-                }
-            });
-            this.messageBuffer.length = 0;
-        }
+        this.messageBuffer.length = 0;
         this.emit("disconnect", reason);
     }
 
@@ -726,6 +710,7 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
                         // This looks like a data corruption but the culprit has been found instead
                         // to be the file being overwritten in storage.  See PR #5882.
                         const error = new NonRetryableError(
+                            // pre-0.58 error message: twoMessagesWithSameSeqNumAndDifferentPayload
                             "Found two messages with the same sequenceNumber but different payloads",
                             DriverErrorType.fileOverwrittenInStorage,
                             {
@@ -780,6 +765,7 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
 
         // Watch the minimum sequence number and be ready to update as needed
         if (this.minSequenceNumber > message.minimumSequenceNumber) {
+            // pre-0.58 error message: msnMovesBackwards
             throw new DataCorruptionError("Found a lower minimumSequenceNumber (msn) than previously recorded", {
                 ...extractSafePropertiesFromMessage(message),
                 clientId: this.connectionManager.clientId,
@@ -788,6 +774,7 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
         this.minSequenceNumber = message.minimumSequenceNumber;
 
         if (message.sequenceNumber !== this.lastProcessedSequenceNumber + 1) {
+            // pre-0.58 error message: nonSequentialSequenceNumber
             throw new DataCorruptionError("Found a non-Sequential sequenceNumber", {
                 ...extractSafePropertiesFromMessage(message),
                 clientId: this.connectionManager.clientId,

package/src/packageVersion.ts

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

package/src/retriableDocumentStorageService.ts

@@ -108,6 +108,7 @@ export class RetriableDocumentStorageService implements IDocumentStorageService,
 
     private checkStorageDisposed() {
         if (this._disposed) {
+            // pre-0.58 error message: storageServiceDisposedCannotRetry
             throw new GenericError("Storage Service is disposed. Cannot retry", { canRetry: false });
         }
         return undefined;