@fluidframework/container-loader 2.0.0-internal.1.0.0.83139 → 2.0.0-internal.1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.0.0-internal.1.0.0.83139",
+  "version": "2.0.0-internal.1.1.1",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,15 +62,15 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/container-utils": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/core-interfaces": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/driver-definitions": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/driver-utils": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/protocol-base": "^0.1037.1000-0",
-    "@fluidframework/protocol-definitions": "^0.1029.1000-0",
-    "@fluidframework/telemetry-utils": "2.0.0-internal.1.0.0.83139",
+    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/container-definitions": "^2.0.0-internal.1.1.1",
+    "@fluidframework/container-utils": "^2.0.0-internal.1.1.1",
+    "@fluidframework/core-interfaces": "^2.0.0-internal.1.1.1",
+    "@fluidframework/driver-definitions": "^2.0.0-internal.1.1.1",
+    "@fluidframework/driver-utils": "^2.0.0-internal.1.1.1",
+    "@fluidframework/protocol-base": "^0.1037.1000",
+    "@fluidframework/protocol-definitions": "^1.0.0",
+    "@fluidframework/telemetry-utils": "^2.0.0-internal.1.1.1",
     "abort-controller": "^3.0.0",
     "double-ended-queue": "^2.1.0-0",
     "lodash": "^4.17.21",
@@ -79,11 +79,11 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.3.0-0",
+    "@fluidframework/build-tools": "^0.3.1000",
     "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@^1.0.0",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/test-loader-utils": "2.0.0-internal.1.0.0.83139",
+    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.1.1",
+    "@fluidframework/test-loader-utils": "^2.0.0-internal.1.1.1",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/double-ended-queue": "^2.1.0",
@@ -92,7 +92,7 @@
     "@types/node": "^14.18.0",
     "@types/sinon": "^7.0.13",
     "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.2",
     "eslint": "~8.6.0",
     "mocha": "^10.0.0",

package/src/catchUpMonitor.ts

@@ -45,7 +45,7 @@ export class CatchUpMonitor extends TypedEventEmitter<ICatchUpMonitorEvents> imp
         this.targetSeqNumber = this.deltaManager.lastKnownSeqNumber;
 
         assert(this.targetSeqNumber >= this.deltaManager.lastSequenceNumber,
-            "Cannot wait for seqNumber below last processed sequence number");
+            0x37c /* Cannot wait for seqNumber below last processed sequence number */);
 
         this.deltaManager.on("op", this.opHandler);
 

package/src/collabWindowTracker.ts

@@ -69,9 +69,17 @@ export class CollabWindowTracker {
         }
 
         this.opsCountSinceNoop++;
-        if (this.opsCountSinceNoop >= this.NoopCountFrequency) {
-            this.submitNoop(false /* immediate */);
-            return;
+        if (this.opsCountSinceNoop === this.NoopCountFrequency) {
+            // 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;
+                return;
+            });
         }
 
         if (this.timer !== undefined) {

package/src/connectionManager.ts

@@ -136,8 +136,8 @@ interface IPendingConnection {
 
 /**
  * Implementation of IConnectionManager, used by Container class
- * Implements constant connectivity to relay service, by reconnecting in case of loast connection or error.
- * Exposes various controls to influecen this process, including manual reconnects, forced read-only mode, etc.
+ * Implements constant connectivity to relay service, by reconnecting in case of lost connection or error.
+ * Exposes various controls to influence this process, including manual reconnects, forced read-only mode, etc.
  */
 export class ConnectionManager implements IConnectionManager {
     /** Connection mode used when reconnecting on error or disconnect. */
@@ -201,7 +201,7 @@ export class ConnectionManager implements IConnectionManager {
      * Automatic reconnecting enabled or disabled.
      * If set to Never, then reconnecting will never be allowed.
      */
-     public get reconnectMode(): ReconnectMode {
+    public get reconnectMode(): ReconnectMode {
         return this._reconnectMode;
     }
 
@@ -233,7 +233,7 @@ export class ConnectionManager implements IConnectionManager {
      * Returns set of props that can be logged in telemetry that provide some insights / statistics
      * about current or last connection (if there is no connection at the moment)
     */
-     public get connectionProps(): ITelemetryProperties {
+    public get connectionProps(): ITelemetryProperties {
         if (this.connection !== undefined) {
             return this._connectionProps;
         } else {
@@ -378,7 +378,7 @@ export class ConnectionManager implements IConnectionManager {
      *
      * @param readonly - set or clear force readonly.
      */
-     public forceReadonly(readonly: boolean) {
+    public forceReadonly(readonly: boolean) {
         if (readonly !== this._forceReadonly) {
             this.logger.sendTelemetryEvent({
                 eventName: "ForceReadOnly",
@@ -567,11 +567,11 @@ export class ConnectionManager implements IConnectionManager {
     }
 
     /**
-     * Start the connection. Any error should result in container being close.
-     * And report the error if it excape for any reason.
+     * Start the connection. Any error should result in container being closed.
+     * And report the error if it escapes for any reason.
      * @param args - The connection arguments
      */
-     private triggerConnect(connectionMode: ConnectionMode) {
+    private triggerConnect(connectionMode: ConnectionMode) {
         assert(this.connection === undefined, 0x239 /* "called only in disconnected state" */);
         if (this.reconnectMode !== ReconnectMode.Enabled) {
             return;
@@ -584,7 +584,7 @@ export class ConnectionManager implements IConnectionManager {
      * @param reason - Text description of disconnect reason to emit with disconnect event
      * @returns A boolean that indicates if there was an existing connection (or pending connection) to disconnect
      */
-     private disconnectFromDeltaStream(reason: string): boolean {
+    private disconnectFromDeltaStream(reason: string): boolean {
         this.pendingReconnect = false;
 
         if (this.connection === undefined) {
@@ -637,7 +637,7 @@ export class ConnectionManager implements IConnectionManager {
      * initial messages.
      * @param connection - The newly established connection
      */
-     private setupNewSuccessfulConnection(connection: IDocumentDeltaConnection, requestedMode: ConnectionMode) {
+    private setupNewSuccessfulConnection(connection: IDocumentDeltaConnection, requestedMode: ConnectionMode) {
         // Old connection should have been cleaned up before establishing a new one
         assert(this.connection === undefined, 0x0e6 /* "old connection exists on new connection setup" */);
         assert(!connection.disposed, 0x28a /* "can't be disposed - Callers need to ensure that!" */);
@@ -735,7 +735,7 @@ export class ConnectionManager implements IConnectionManager {
      * @param error - Error reconnect information including whether or not to reconnect
      * @returns A promise that resolves when the connection is reestablished or we stop trying
      */
-     private reconnectOnError(
+    private reconnectOnError(
         requestedMode: ConnectionMode,
         error: IAnyDriverError,
     ) {
@@ -743,7 +743,7 @@ export class ConnectionManager implements IConnectionManager {
             requestedMode,
             error.message,
             error)
-        .catch(this.props.closeHandler);
+            .catch(this.props.closeHandler);
     }
 
     /**
@@ -772,7 +772,7 @@ export class ConnectionManager implements IConnectionManager {
             this.logger.sendTelemetryEvent({
                 eventName: "reconnectingDespiteFatalError",
                 reconnectMode: this.reconnectMode,
-             }, error);
+            }, error);
         }
 
         if (this.reconnectMode === ReconnectMode.Never) {
@@ -857,8 +857,7 @@ export class ConnectionManager implements IConnectionManager {
                             "Switch to write", // message
                         );
                     }
-                })
-                .catch(() => {});
+                }).catch(() => { });
             }
             return;
         }

package/src/connectionStateHandler.ts

@@ -190,7 +190,7 @@ export class ConnectionStateHandler {
             this.waitEvent?.end({ source });
 
             assert(this.catchUpMonitor !== undefined,
-                "catchUpMonitor should always be set if pendingClientId is set");
+                0x37d /* catchUpMonitor should always be set if pendingClientId is set */);
             this.catchUpMonitor.on("caughtUp", this.transitionToConnectedState);
         } else {
             // Adding this event temporarily so that we can get help debugging if something goes wrong.

package/src/container.ts

@@ -800,12 +800,12 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
         // runtime matches pending ops to successful ones by clientId and client seq num, so we need to close the
         // container at the same time we get pending state, otherwise this container could reconnect and resubmit with
         // a new clientId and a future container using stale pending state without the new clientId would resubmit them
-
         assert(this.attachState === AttachState.Attached, 0x0d1 /* "Container should be attached before close" */);
         assert(this.resolvedUrl !== undefined && this.resolvedUrl.type === "fluid",
             0x0d2 /* "resolved url should be valid Fluid url" */);
         assert(!!this._protocolHandler, 0x2e3 /* "Must have a valid protocol handler instance" */);
-        assert(this._protocolHandler.attributes.term !== undefined, "Must have a valid protocol handler instance");
+        assert(this._protocolHandler.attributes.term !== undefined,
+            0x37e /* Must have a valid protocol handler instance */);
         const pendingState: IPendingContainerState = {
             pendingRuntimeState: this.context.getPendingLocalState(),
             url: this.resolvedUrl.url,
@@ -814,6 +814,8 @@ export class Container extends EventEmitterWithErrorHandling<IContainerEvents> i
             clientId: this.clientId,
         };
 
+        this.mc.logger.sendTelemetryEvent({ eventName: "CloseAndGetPendingLocalState" });
+
         this.close();
 
         return JSON.stringify(pendingState);

package/src/contracts.ts

@@ -56,13 +56,13 @@ export interface IConnectionManager {
 
     readonly readOnlyInfo: ReadOnlyInfo;
 
-    // Various connectivity propetries for telemetry describing type of current connection
+    // Various connectivity properties for telemetry describing type of current connection
     // Things like connection mode, service info, etc.
     // Called when connection state changes (connect / disconnect)
     readonly connectionProps: ITelemetryProperties;
 
     // Verbose information about connection logged to telemetry in case of issues with
-    // maintaining healphy connection, including op gaps, not receiving join op in time, etc.
+    // maintaining healthy connection, including op gaps, not receiving join op in time, etc.
     // Contains details information, like sequence numbers at connection time, initial ops info, etc.
     readonly connectionVerboseProps: ITelemetryProperties;
 
@@ -73,7 +73,7 @@ export interface IConnectionManager {
     prepareMessageToSend(message: Omit<IDocumentMessage, "clientSequenceNumber">): IDocumentMessage | undefined;
 
     /**
-     * Called before incomming message is processed. Incomming messages can be comming from connection,
+     * Called before incoming message is processed. Incoming messages can be combing from connection,
      * but also could come from storage.
      * This call allows connection manager to adjust knowledge about acked ops sent on previous connection.
      * Can be called at any time, including when there is no active connection.
@@ -107,11 +107,11 @@ export interface IConnectionManager {
 
 /**
  * This interface represents a set of callbacks provided by DeltaManager to IConnectionManager on its creation
- * IConnectionManager instance will use them to communicate to DeltaManager abour various events.
+ * IConnectionManager instance will use them to communicate to DeltaManager about various events.
  */
 export interface IConnectionManagerFactoryArgs {
     /**
-     * Called by connection manager for each incomming op. Some ops maybe delivered before
+     * Called by connection manager for each incoming op. Some ops maybe delivered before
      * connectHandler is called (initial ops on socket connection)
      */
     readonly incomingOpHandler: (messages: ISequencedDocumentMessage[], reason: string) => void;
@@ -131,8 +131,8 @@ export interface IConnectionManagerFactoryArgs {
     readonly reconnectionDelayHandler: (delayMs: number, error: unknown) => void;
 
     /**
-     * Called by connection manager whwnever critical error happens and container should be closed.
-     * Expects dispose() call in respose to this call.
+     * Called by connection manager whenever critical error happens and container should be closed.
+     * Expects dispose() call in response to this call.
      */
     readonly closeHandler: (error?: any) => void;
 

package/src/deltaManager.ts

@@ -25,6 +25,8 @@ import {
     normalizeError,
     logIfFalse,
     safeRaiseEvent,
+    MonitoringContext,
+    loggerToMonitoringContext,
 } from "@fluidframework/telemetry-utils";
 import {
     IDocumentDeltaStorageService,
@@ -47,6 +49,7 @@ import {
     DataCorruptionError,
     extractSafePropertiesFromMessage,
     DataProcessingError,
+    UsageError,
 } from "@fluidframework/container-utils";
 import { DeltaQueue } from "./deltaQueue";
 import {
@@ -89,6 +92,15 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
     private pending: ISequencedDocumentMessage[] = [];
     private fetchReason: string | undefined;
 
+    private readonly mc: MonitoringContext;
+
+    // A boolean used to assert that ops are not being sent while processing another op.
+    private currentlyProcessingOps: boolean = false;
+
+    // Feature gate that closes a container when sending an op if the container is
+    // concurrently processing another op
+    private readonly preventConcurrentOpSend: boolean = true;
+
     // The minimum sequence number and last sequence number received from the server
     private minSequenceNumber: number = 0;
 
@@ -113,6 +125,8 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
     private previouslyProcessedMessage: ISequencedDocumentMessage | undefined;
 
     // The sequence number we initially loaded from
+    // In case of reading from a snapshot or pending state, its value will be equal to
+    // the last message that got serialized.
     private initSequenceNumber: number = 0;
 
     private readonly _inbound: DeltaQueue<ISequencedDocumentMessage>;
@@ -186,6 +200,9 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
     public get clientDetails() { return this.connectionManager.clientDetails; }
 
     public submit(type: MessageType, contents: any, batch = false, metadata?: any) {
+        if (this.currentlyProcessingOps && this.preventConcurrentOpSend) {
+            this.close(new UsageError("Making changes to data model is disallowed while processing ops."));
+        }
         const messagePartial: Omit<IDocumentMessage, "clientSequenceNumber"> = {
             contents: JSON.stringify(contents),
             metadata,
@@ -196,7 +213,6 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
         if (!batch) {
             this.flush();
         }
-
         const message = this.connectionManager.prepareMessageToSend(messagePartial);
         if (message === undefined) {
             return -1;
@@ -211,7 +227,6 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
         if (!batch) {
             this.flush();
         }
-
         return message.clientSequenceNumber;
     }
 
@@ -293,7 +308,8 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
         };
 
         this.connectionManager = createConnectionManager(props);
-
+        this.mc = loggerToMonitoringContext(logger);
+        this.preventConcurrentOpSend = this.mc.config.getBoolean("Fluid.Container.ConcurrentOpSend") === true;
         this._inbound = new DeltaQueue<ISequencedDocumentMessage>(
             (op) => {
                 this.processInboundMessage(op);
@@ -762,6 +778,8 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
 
     private processInboundMessage(message: ISequencedDocumentMessage): void {
         const startTime = Date.now();
+        assert(!this.currentlyProcessingOps, 0x3af /* Already processing ops. */);
+        this.currentlyProcessingOps = true;
         this.lastProcessedMessage = message;
 
         // All non-system messages are coming from some client, and should have clientId
@@ -816,7 +834,7 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
             throw new Error("Attempted to process an inbound message without a handler attached");
         }
         this.handler.process(message);
-
+        this.currentlyProcessingOps = false;
         const endTime = Date.now();
 
         // Should be last, after changing this.lastProcessedSequenceNumber above, as many callers

package/src/deltaQueue.ts

@@ -114,9 +114,9 @@ export class DeltaQueue<T>
         if (this.anythingToProcess() && this.processingPromise === undefined) {
             // Use a resolved promise to start the processing on a separate stack.
             this.processingPromise = Promise.resolve().then(() => {
-                assert(this.processingPromise !== undefined, "reentrancy?");
+                assert(this.processingPromise !== undefined, 0x37f /* reentrancy? */);
                 const result = this.processDeltas();
-                assert(this.processingPromise !== undefined, "reentrancy?");
+                assert(this.processingPromise !== undefined, 0x380 /* reentrancy? */);
                 // WARNING: Do not move next line to .finally() clause!
                 // It runs async and creates a race condition where incoming ensureProcessing() call observes
                 // from previous run while previous run is over (but finally clause was not scheduled yet)
@@ -128,7 +128,7 @@ export class DeltaQueue<T>
                 this.emit("error", error);
                 return { count: 0, duration: 0 };
             });
-            assert(this.processingPromise !== undefined, "processDeltas() should run async");
+            assert(this.processingPromise !== undefined, 0x381 /* processDeltas() should run async */);
         }
     }
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.0.0-internal.1.0.0.83139";
+export const pkgVersion = "2.0.0-internal.1.1.1";