@fluidframework/container-loader 2.0.0-dev.2.2.0.111723 → 2.0.0-dev.2.3.0.115467

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.0.0-dev.2.2.0.111723",
+  "version": "2.0.0-dev.2.3.0.115467",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -65,14 +65,14 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
-    "@fluidframework/container-utils": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
-    "@fluidframework/driver-utils": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/container-definitions": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/container-utils": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/driver-utils": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
     "@fluidframework/protocol-base": "^0.1038.2000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
     "abort-controller": "^3.0.0",
     "double-ended-queue": "^2.1.0-0",
     "lodash": "^4.17.21",
@@ -80,13 +80,13 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.6.0-109663",
+    "@fluid-tools/build-cli": "^0.7.0",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.6.0-109663",
-    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.2.1.0",
+    "@fluidframework/build-tools": "^0.7.0",
+    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.2.2.0",
     "@fluidframework/eslint-config-fluid": "^1.2.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
-    "@fluidframework/test-loader-utils": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/test-loader-utils": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/double-ended-queue": "^2.1.0",
@@ -106,9 +106,9 @@
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.2.0",
-    "baselineRange": ">=2.0.0-internal.2.1.0 <2.0.0-internal.2.2.0",
-    "baselineVersion": "2.0.0-internal.2.1.0",
+    "version": "2.0.0-internal.2.3.0",
+    "baselineRange": ">=2.0.0-internal.2.2.0 <2.0.0-internal.2.3.0",
+    "baselineVersion": "2.0.0-internal.2.2.0",
     "broken": {}
   }
 }

package/src/audience.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 import { EventEmitter } from "events";
+import { assert } from "@fluidframework/common-utils";
 import { IAudienceOwner } from "@fluidframework/container-definitions";
 import { IClient } from "@fluidframework/protocol-definitions";
 
@@ -23,7 +24,11 @@ export class Audience extends EventEmitter implements IAudienceOwner {
     public addMember(clientId: string, details: IClient) {
         // Given that signal delivery is unreliable process, we might observe same client being added twice
         // In such case we should see exactly same payload (IClient), and should not raise event twice!
-        if (!this.members.has(clientId)) {
+        if (this.members.has(clientId)) {
+            const client = this.members.get(clientId);
+            assert(JSON.stringify(client) === JSON.stringify(details), 0x4b2 /* new client has different payload from existing one */);
+        }
+        else {
             this.members.set(clientId, details);
             this.emit("addMember", clientId, details);
         }

package/src/collabWindowTracker.ts

@@ -73,11 +73,11 @@ export class CollabWindowTracker {
             // Ensure we only send noop after a batch of many ops is processed
             // eslint-disable-next-line @typescript-eslint/no-floating-promises
             Promise.resolve().then(() => {
-                assert(this.opsCountSinceNoop >= this.NoopCountFrequency,
-                    0x3ae /* not enough ops were sent to reach the noop frequency */);
-                this.submitNoop(false /* immediate */);
-                // reset count now that all ops are processed
-                this.opsCountSinceNoop = 0;
+                if (this.opsCountSinceNoop >= this.NoopCountFrequency) {
+                    this.submitNoop(false /* immediate */);
+                    // reset count now that all ops are processed
+                    this.opsCountSinceNoop = 0;
+                }
                 return;
             });
         }

package/src/connectionManager.ts

@@ -267,7 +267,7 @@ export class ConnectionManager implements IConnectionManager {
      * It is undefined if we have not yet established websocket connection
      * and do not know if user has write access to a file.
      */
-    private get readonly() {
+    private get readonly(): boolean | undefined {
         if (this._forceReadonly) {
             return true;
         }
@@ -665,6 +665,9 @@ export class ConnectionManager implements IConnectionManager {
         // But if we ask read, server can still give us write.
         const readonly = !connection.claims.scopes.includes(ScopeType.DocWrite);
 
+        if (connection.mode !== requestedMode) {
+            this.logger.sendTelemetryEvent({ eventName: "ConnectionModeMismatch", requestedMode, mode: connection.mode });
+        }
         // This connection mode validation logic is moving to the driver layer in 0.44.  These two asserts can be
         // removed after those packages have released and become ubiquitous.
         assert(requestedMode === "read" || readonly === (this.connectionMode === "read"),

package/src/connectionStateHandler.ts

@@ -288,7 +288,7 @@ class ConnectionStateHandler implements IConnectionStateHandler {
 
     private startJoinOpTimer() {
         assert(!this.joinOpTimer.hasTimer, 0x234 /* "has joinOpTimer" */);
-        assert(this.connection !== undefined, "have connection");
+        assert(this.connection !== undefined, 0x4b3 /* have connection */);
         this.joinOpTimer.start(
             this.connection.mode === "write" ? JoinOpTimeoutMs : JoinSignalTimeoutMs,
         );
@@ -388,7 +388,7 @@ class ConnectionStateHandler implements IConnectionStateHandler {
     }
 
     private shouldWaitForJoinSignal() {
-        assert(this.connection !== undefined, "all callers call here with active connection");
+        assert(this.connection !== undefined, 0x4b4 /* all callers call here with active connection */);
         return this.connection.mode === "write" || this.readClientsWaitForJoinSignal;
     }
 
@@ -525,12 +525,12 @@ class ConnectionStateHandler implements IConnectionStateHandler {
 
         this.membership?.on("addMember", (clientId, details) => {
             assert((details as IClient).mode === "read" || protocol.quorum.getMember(clientId) !== undefined,
-                "Audience is subset of quorum");
+                0x4b5 /* Audience is subset of quorum */);
             this.receivedAddMemberEvent(clientId);
         });
 
         this.membership?.on("removeMember", (clientId) => {
-            assert(protocol.quorum.getMember(clientId) === undefined, "Audience is subset of quorum");
+            assert(protocol.quorum.getMember(clientId) === undefined, 0x4b6 /* Audience is subset of quorum */);
             this.receivedRemoveMemberEvent(clientId);
         });
 

package/src/container.ts

@@ -241,14 +241,14 @@ const getCodeProposal =
  * @param eventName - event name
  * @param action - functor to call and measure
  */
-async function ReportIfTooLong(
+export async function ReportIfTooLong(
     logger: ITelemetryLogger,
     eventName: string,
     action: () => Promise<ITelemetryProperties>,
 ) {
     const event = PerformanceEvent.start(logger, { eventName });
     const props = await action();
-    if (event.duration > 1000) {
+    if (event.duration > 200) {
         event.end(props);
     }
 }
@@ -1525,7 +1525,7 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         deltaManager.inboundSignal.pause();
 
         deltaManager.on("connect", (details: IConnectionDetails, _opsBehind?: number) => {
-            assert(this.connectionMode === details.mode, "mismatch");
+            assert(this.connectionMode === details.mode, 0x4b7 /* mismatch */);
             this.connectionStateHandler.receivedConnectEvent(
                 details,
             );

package/src/containerContext.ts

@@ -46,7 +46,7 @@ import {
     ISummaryContent,
 } from "@fluidframework/protocol-definitions";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
-import { Container } from "./container";
+import { Container, ReportIfTooLong } from "./container";
 
 const PackageNotFactoryError = "Code package does not implement IRuntimeFactory";
 
@@ -324,7 +324,13 @@ export class ContainerContext implements IContainerContext {
 
     private async instantiateRuntime(existing: boolean) {
         const runtimeFactory = await this.getRuntimeFactory();
-        this._runtime = await runtimeFactory.instantiateRuntime(this, existing);
+        await ReportIfTooLong(
+            this.taggedLogger,
+            "instantiateRuntime",
+            async () => {
+                this._runtime = await runtimeFactory.instantiateRuntime(this, existing);
+                return {};
+            });
     }
 
     private attachListener() {

package/src/contracts.ts

@@ -148,15 +148,23 @@ export interface IConnectionManagerFactoryArgs {
 
     /**
      * Called whenever ping/pong messages are roundtripped on connection.
+     *
+     * @deprecated No replacement API intended.
      */
     readonly pongHandler: (latency: number) => void;
 
     /**
      * Called whenever connection type changes from writable to read-only or vice versa.
+     *
+     * @remarks
+     *
      * Connection can be read-only if user has no edit permissions, or if container forced
      * connection to be read-only.
      * This should not be confused with "read" / "write"connection mode which is internal
      * optimization.
+     *
+     * @param readonly - Whether or not the container is now read-only.
+     * `undefined` indicates that user permissions are not yet known.
      */
     readonly readonlyChangeHandler: (readonly?: boolean) => void;
 }

package/src/deltaManager.ts

@@ -118,8 +118,8 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
     // There are three numbers we track
     // * lastQueuedSequenceNumber is the last queued sequence number. If there are gaps in seq numbers, then this number
     //   is not updated until we cover that gap, so it increases each time by 1.
-    // * lastObservedSeqNumber is  an estimation of last known sequence number for container in storage. It's initially
-    //   populated at web socket connection time (if storage provides that info) and is  updated once ops shows up.
+    // * lastObservedSeqNumber is an estimation of last known sequence number for container in storage. It's initially
+    //   populated at web socket connection time (if storage provides that info) and is updated once ops shows up.
     //   It's never less than lastQueuedSequenceNumber
     // * lastProcessedSequenceNumber - last processed sequence number
     private lastQueuedSequenceNumber: number = 0;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.0.0-dev.2.2.0.111723";
+export const pkgVersion = "2.0.0-dev.2.3.0.115467";