@fluidframework/driver-base 2.0.0-dev.1.4.6.106135 → 2.0.0-dev.2.3.0.115467

package/lib/documentDeltaConnection.js

@@ -227,15 +227,27 @@ export class DocumentDeltaConnection extends EventEmitterWithErrorHandling {
         this.submitCore("submitSignal", [message]);
     }
     /**
-     * Disconnect from the websocket, and permanently disable this DocumentDeltaConnection.
+     * Disconnect from the websocket and close the websocket too.
+     */
+    closeSocket(error) {
+        this.disconnect(error);
+    }
+    /**
+     * Disconnect from the websocket, and permanently disable this DocumentDeltaConnection and close the socket.
+     * However the OdspDocumentDeltaConnection differ in dispose as in there we don't close the socket. There is no
+     * multiplexing here, so we need to close the socket here.
      */
     dispose() {
-        this.disposeCore(false, // socketProtocolError
-        createGenericNetworkError(
+        this.logger.sendTelemetryEvent({
+            eventName: "ClientClosingDeltaConnection",
+            driverVersion,
+            details: JSON.stringify({ disposed: this._disposed, socketConnected: this.socket.connected }),
+        });
+        this.disconnect(createGenericNetworkError(
         // pre-0.58 error message: clientClosingConnection
         "Client closing delta connection", { canRetry: true }, { driverVersion }));
     }
-    disposeCore(socketProtocolError, err) {
+    disconnect(err) {
         // Can't check this.disposed here, as we get here on socket closure,
         // so _disposed & socket.connected might be not in sync while processing
         // "dispose" event.
@@ -248,16 +260,28 @@ export class DocumentDeltaConnection extends EventEmitterWithErrorHandling {
         // OdspDocumentDeltaConnection may still send disconnect_document which is allowed; this is only intended
         // to prevent normal messages from being emitted.
         this._disposed = true;
+        // Let user of connection object know about disconnect. This has to happen in between setting _disposed and
+        // removing all listeners!
+        this.emit("disconnect", err);
+        this.logger.sendTelemetryEvent({
+            eventName: "AfterDisconnectEvent",
+            driverVersion,
+            details: JSON.stringify({
+                socketConnected: this.socket.connected,
+                disconnectListenerCount: this.listenerCount("disconnect"),
+            }),
+        });
+        // user of DeltaConnection should have processed "disconnect" event and removed all listeners. Not clear
+        // if we want to enforce that, as some users (like LocalDocumentService) do not unregister any handlers
+        // assert(this.listenerCount("disconnect") === 0, "'disconnect` events should be processed synchronously");
         this.removeTrackedListeners();
-        this.disconnect(socketProtocolError, err);
+        this.disconnectCore();
     }
     /**
      * Disconnect from the websocket.
-     * @param socketProtocolError - true if error happened on socket / socket.io protocol level
-     * (not on Fluid protocol level)
      * @param reason - reason for disconnect
      */
-    disconnect(socketProtocolError, reason) {
+    disconnectCore() {
         this.socket.disconnect();
     }
     async initialize(connectMessage, timeout) {
@@ -272,8 +296,12 @@ export class DocumentDeltaConnection extends EventEmitterWithErrorHandling {
             : 0;
         const getMaxAllowedInternalSocketConnectionFailures = () => getMaxInternalSocketReconnectionAttempts() + 1;
         this._details = await new Promise((resolve, reject) => {
-            const fail = (socketProtocolError, err) => {
-                this.disposeCore(socketProtocolError, err);
+            const failAndCloseSocket = (err) => {
+                this.closeSocket(err);
+                reject(err);
+            };
+            const failConnection = (err) => {
+                this.disconnect(err);
                 reject(err);
             };
             // Listen for connection issues
@@ -311,11 +339,11 @@ export class DocumentDeltaConnection extends EventEmitterWithErrorHandling {
                     // Reconnection is enabled and maximum reconnect attempts have not been reached.
                     return;
                 }
-                fail(true, this.createErrorObject("connect_error", error));
+                failAndCloseSocket(this.createErrorObject("connect_error", error));
             });
             // Listen for timeouts
             this.addConnectionListener("connect_timeout", () => {
-                fail(true, this.createErrorObject("connect_timeout"));
+                failAndCloseSocket(this.createErrorObject("connect_timeout"));
             });
             this.addConnectionListener("connect_document_success", (response) => {
                 // If we sent a nonce and the server supports nonces, check that the nonces match
@@ -331,13 +359,13 @@ export class DocumentDeltaConnection extends EventEmitterWithErrorHandling {
                     // The only time we expect a mismatch in requested/actual is if we lack write permissions
                     // In this case we will get "read", even if we requested "write"
                     if (actualMode !== requestedMode) {
-                        fail(false, this.createErrorObject("connect_document_success", "Connected in a different mode than was requested", false));
+                        failConnection(this.createErrorObject("connect_document_success", "Connected in a different mode than was requested", false));
                         return;
                     }
                 }
                 else {
                     if (actualMode === "write") {
-                        fail(false, this.createErrorObject("connect_document_success", "Connected in write mode without write permissions", false));
+                        failConnection(this.createErrorObject("connect_document_success", "Connected in write mode without write permissions", false));
                         return;
                     }
                 }
@@ -350,16 +378,13 @@ export class DocumentDeltaConnection extends EventEmitterWithErrorHandling {
             // had a chance to register its handlers.
             this.addTrackedListener("disconnect", (reason) => {
                 const err = this.createErrorObject("disconnect", reason);
-                this.emit("disconnect", err);
-                fail(true, err);
+                failAndCloseSocket(err);
             });
             this.addTrackedListener("error", ((error) => {
-                // First, raise an error event, to give clients a chance to observe error contents
                 // This includes "Invalid namespace" error, which we consider critical (reconnecting will not help)
                 const err = this.createErrorObject("error", error, error !== "Invalid namespace");
-                this.emit("error", err);
                 // Disconnect socket - required if happened before initial handshake
-                fail(true, err);
+                failAndCloseSocket(err);
             }));
             this.addConnectionListener("connect_document_error", ((error) => {
                 // If we sent a nonce and the server supports nonces, check that the nonces match
@@ -370,12 +395,12 @@ export class DocumentDeltaConnection extends EventEmitterWithErrorHandling {
                 }
                 // This is not an socket.io error - it's Fluid protocol error.
                 // In this case fail connection and indicate that we were unable to create connection
-                fail(false, this.createErrorObject("connect_document_error", error));
+                failConnection(this.createErrorObject("connect_document_error", error));
             }));
             this.socket.emit("connect_document", connectMessage);
             // Give extra 2 seconds for handshake on top of socket connection timeout
             this.socketConnectionTimeout = setTimeout(() => {
-                fail(false, this.createErrorObject("orderingServiceHandshakeTimeout"));
+                failConnection(this.createErrorObject("orderingServiceHandshakeTimeout"));
             }, timeout + 2000);
         });
         assert(!this.disposed, 0x246 /* "checking consistency of socket & _disposed flags" */);

package/lib/documentDeltaConnection.js.map

@@ -1 +1 @@
-{"version":3,"file":"documentDeltaConnection.js","sourceRoot":"","sources":["../src/documentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAKtD,OAAO,EAAE,yBAAyB,EAAmB,MAAM,8BAA8B,CAAC;AAC1F,OAAO,EAUH,SAAS,GACZ,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EACH,WAAW,EACX,6BAA6B,EAC7B,mBAAmB,EACnB,yBAAyB,EAEzB,6BAA6B,GAChC,MAAM,iCAAiC,CAAC;AAEzC,sFAAsF;AACtF,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE/D;;GAEG;AACH,MAAM,OAAO,uBACT,SAAQ,6BAA6D;IAkErE;;;;;OAKG;IACH,YACuB,MAAc,EAC1B,UAAkB,EACzB,MAAwB,EACP,8BAAuC,KAAK;QAE7D,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAClB,MAAM,CAAC,cAAc,CACjB;gBACI,SAAS,EAAE,gCAAgC;gBAC3C,IAAI;aACP,EACD,KAAK,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAZgB,WAAM,GAAN,MAAM,CAAQ;QAC1B,eAAU,GAAV,UAAU,CAAQ;QAER,gCAA2B,GAA3B,2BAA2B,CAAiB;QA3DjE,uEAAuE;QACpD,mBAAc,GAAgC,EAAE,CAAC;QACjD,kBAAa,GAAqB,EAAE,CAAC;QAExD;;;WAGG;QACK,2BAAsB,GAAY,KAAK,CAAC;QAMhD,4DAA4D;QAC3C,wBAAmB,GAA0C,IAAI,GAAG,EAAE,CAAC;QACxF,wEAAwE;QACvD,qBAAgB,GAA0C,IAAI,GAAG,EAAE,CAAC;QAWrF;;;WAGG;QACO,cAAS,GAAY,KAAK,CAAC;QAyZ3B,mBAAc,GAAG,CAAC,UAAkB,EAAE,IAAiC,EAAE,EAAE;YACjF,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC;QAEQ,uBAAkB,GAAG,CAAC,GAAmB,EAAE,EAAE;YACnD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC;QAzXE,IAAI,CAAC,EAAE,GAAG,yBAAyB,CAC/B,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;QAEnD,IAAI,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACvC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,6CAA6C,CAAC,CAAC;YAE5E,2FAA2F;YAC3F,IAAI,uBAAuB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC/D,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;gBACzE,OAAO;aACV;YAED,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,2DAA2D,KAAK,EAAE,CAAC,CAAC;aACvF;YAED,+FAA+F;YAC/F,kGAAkG;YAClG,yFAAyF;YACzF,iGAAiG;YACjG,0GAA0G;YAC1G,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;YAC1G,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACnC,IAAI,CAAC,kBAAkB,CACnB,KAAK,EACL,CAAC,GAAG,IAAW,EAAE,EAAE;oBACf,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;gBAC9B,CAAC,CAAC,CAAC;aACV;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAjFD,IAAc,UAAU;QACpB,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAW,QAAQ;QACf,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACxG,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IASD;;OAEG;IACH,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,IAAW,OAAO;QACd,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;SACrF;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAuDD;;;;OAIG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,cAAc,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,oBAAoB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC;IAC7C,CAAC;IAEO,cAAc;QAClB,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,IAAW,eAAe;QACtB,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,uGAAuG;QACvG,mFAAmF;QACnF,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACvF,qFAAqF;QACrF,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAEjF,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,6BAA6B;YAC7B,0DAA0D;YAC1D,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;YAC1D,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC;YACjF,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;SAClC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,IAAW,cAAc;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAEzF,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAEhC,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,4BAA4B;YAC5B,yDAAyD;YACzD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACxD,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;SACjC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,IAAW,cAAc;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACvC,CAAC;IAES,YAAY,CAAC,IAAY,EAAE,QAA8B;QAC/D,kGAAkG;QAClG,sGAAsG;QACtG,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAChB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;SACnD;IACL,CAAC;IAES,UAAU,CAAC,IAAY,EAAE,QAA4B;QAC3D,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAA4B;QACtC,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,OAAyB;QACzC,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,WAAW,CACZ,KAAK,EAAE,sBAAsB;QAC7B,yBAAyB;QACrB,kDAAkD;QAClD,iCAAiC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;IACvF,CAAC;IAES,WAAW,CAAC,mBAA4B,EAAE,GAAoB;QACpE,oEAAoE;QACpE,wEAAwE;QACxE,mBAAmB;QACnB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO;SACV;QAED,2GAA2G;QAC3G,qGAAqG;QACrG,8GAA8G;QAC9G,yGAAyG;QACzG,iDAAiD;QACjD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACO,UAAU,CAAC,mBAA4B,EAAE,MAAuB;QACtE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAC7B,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,cAAwB,EAAE,OAAe;QAChE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAClD,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAEnC,8FAA8F;QAC9F,IAAI,oCAAoC,GAAW,CAAC,CAAC;QACrD,MAAM,mCAAmC,GAAG,GAAY,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC;QACzF,MAAM,wCAAwC,GAAG,GAAW,EAAE,CAAC,mCAAmC,EAAE;YAChG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,EAAE;YACvC,CAAC,CAAC,CAAC,CAAC;QACR,MAAM,6CAA6C,GAAG,GAAW,EAAE,CAC/D,wCAAwC,EAAE,GAAG,CAAC,CAAC;QAEnD,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAC,mBAA4B,EAAE,GAAoB,EAAE,EAAE;gBAChE,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;gBAC3C,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,CAAC,CAAC;YAEF,+BAA+B;YAC/B,IAAI,CAAC,qBAAqB,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE;;gBAClD,oCAAoC,EAAE,CAAC;gBACvC,IAAI,yBAAyB,GAAG,KAAK,CAAC;gBACtC,IAAI;oBACA,MAAM,WAAW,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,CAAC;oBACvC,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;wBAChD,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE;4BACjC,yBAAyB,GAAG,IAAI,CAAC;yBACpC;wBACD,mDAAmD;wBACnD,WAAW,CAAC,MAAM,GAAG,SAAS,CAAC;qBAClC;iBACJ;gBAAC,OAAO,EAAE,EAAE,GAAG;gBAEhB,wDAAwD;gBACxD,IACI,yBAAyB;oBACzB,IAAI,CAAC,2BAA2B;oBAChC,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,0CAAG,CAAC,CAAC,MAAK,SAAS,EAAE;oBACnD,qDAAqD;oBACrD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;oBAC1D,wDAAwD;oBACxD,IAAI,CAAC,mCAAmC,EAAE,EAAE;wBACxC,qEAAqE;wBACrE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;wBAClC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;qBAC1C;iBACJ;gBAED,kDAAkD;gBAClD,IAAI,mCAAmC,EAAE;oBACrC,oCAAoC,GAAG,6CAA6C,EAAE,EAAE;oBACxF,gFAAgF;oBAChF,OAAO;iBACV;gBAED,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YAEH,sBAAsB;YACtB,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBAC/C,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,qBAAqB,CAAC,0BAA0B,EAAE,CAAC,QAAoB,EAAE,EAAE;gBAC5E,iFAAiF;gBACjF,IAAI,cAAc,CAAC,KAAK,KAAK,SAAS;oBAClC,QAAQ,CAAC,KAAK,KAAK,SAAS;oBAC5B,QAAQ,CAAC,KAAK,KAAK,cAAc,CAAC,KAAK,EAAE;oBACzC,OAAO;iBACV;gBAED,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC;gBAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC;gBACjC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAE7E,IAAI,gBAAgB,EAAE;oBAClB,yFAAyF;oBACzF,gEAAgE;oBAChE,IAAI,UAAU,KAAK,aAAa,EAAE;wBAC9B,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAC9B,0BAA0B,EAC1B,kDAAkD,EAClD,KAAK,CACR,CAAC,CAAC;wBACH,OAAO;qBACV;iBACJ;qBAAM;oBACH,IAAI,UAAU,KAAK,OAAO,EAAE;wBACxB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAC9B,0BAA0B,EAC1B,mDAAmD,EACnD,KAAK,CACR,CAAC,CAAC;wBACH,OAAO;qBACV;iBACJ;gBAED,IAAI,CAAC,wBAAwB,GAAG,QAAQ,CAAC,wBAAwB,CAAC;gBAElE,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACjC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,uEAAuE;YACvE,sFAAsF;YACtF,yCAAyC;YACzC,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;gBAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBACzD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;gBAC7B,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE;gBACxC,kFAAkF;gBAClF,mGAAmG;gBACnG,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,KAAK,mBAAmB,CAAC,CAAC;gBAClF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBACxB,oEAAoE;gBACpE,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC,CAAC;YAEJ,IAAI,CAAC,qBAAqB,CAAC,wBAAwB,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC5D,iFAAiF;gBACjF,IAAI,cAAc,CAAC,KAAK,KAAK,SAAS;oBAClC,KAAK,CAAC,KAAK,KAAK,SAAS;oBACzB,KAAK,CAAC,KAAK,KAAK,cAAc,CAAC,KAAK,EAAE;oBACtC,OAAO;iBACV;gBAED,8DAA8D;gBAC9D,qFAAqF;gBACrF,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC,CAAC;YACzE,CAAC,CAAC,CAAC,CAAC;YAEJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC;YAErD,yEAAyE;YACzE,IAAI,CAAC,uBAAuB,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC3C,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,iCAAiC,CAAC,CAAC,CAAC;YAC3E,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC3F,CAAC;IAUO,oBAAoB;QACxB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;IACxC,CAAC;IAEO,wBAAwB;QAC5B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAClE,CAAC;IAEO,qBAAqB,CAAC,KAAa,EAAE,QAAkC;QAC3E,MAAM,CAAC,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,EACjE,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAClD,MAAM,CAAC,CAAC,uBAAuB,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAC3D,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAChC,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACvF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAES,kBAAkB,CAAC,KAAa,EAAE,QAAkC;QAC1E,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAChC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACjF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAEO,sBAAsB;QAC1B,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE;YAC7D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;SACpC;QACD,+EAA+E;QAC/E,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAEjC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAEhC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAEO,yBAAyB;QAC7B,IAAI,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAAE;YAC5C,YAAY,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;SAC9C;QAED,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE;YAChE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;SACpC;QACD,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,OAAe,EAAE,KAAW,EAAE,QAAQ,GAAG,IAAI;QACrE,wDAAwD;QACxD,4GAA4G;QAC5G,mFAAmF;QACnF,IAAI,OAAe,CAAC;QACpB,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,gBAAgB,EAAE;YAClC,qCAAqC;YACrC,MAAM,aAAa,GAAG,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,MAAK,SAAS,CAAC;gBAChD,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,IAAI;gBACtB,CAAC,CAAC,EAAE,CAAC;YAET,iDAAiD;YACjD,iGAAiG;YACjG,6FAA6F;YAC7F,OAAO,GAAG,GAAG,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,mBAAmB,EAAE,CAAC,EAAE,CAAC;SAC/E;aAAM;YACH,OAAO,GAAG,6BAA6B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC;SAChE;QAED,MAAM,QAAQ,GAAG,yBAAyB,CACtC,cAAc,OAAO,MAAM,OAAO,EAAE,EACpC,EAAE,QAAQ,EAAE,EACZ,EAAE,aAAa,EAAE,CACpB,CAAC;QAEF,OAAO,QAAQ,CAAC;IACpB,CAAC;;AA9hBe,uCAAe,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEnE,mHAAmH;AACnH,oHAAoH;AACpG,6CAAqB,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    IDocumentDeltaConnection,\n    IDocumentDeltaConnectionEvents,\n} from \"@fluidframework/driver-definitions\";\nimport { createGenericNetworkError, IAnyDriverError } from \"@fluidframework/driver-utils\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IConnect,\n    IConnected,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n    ScopeType,\n} from \"@fluidframework/protocol-definitions\";\nimport { IDisposable, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    ChildLogger,\n    extractLogSafeErrorProperties,\n    getCircularReplacer,\n    loggerToMonitoringContext,\n    MonitoringContext,\n    EventEmitterWithErrorHandling,\n} from \"@fluidframework/telemetry-utils\";\nimport type { Socket } from \"socket.io-client\";\n// For now, this package is versioned and released in unison with the specific drivers\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n/**\n * Represents a connection to a stream of delta updates\n */\nexport class DocumentDeltaConnection\n    extends EventEmitterWithErrorHandling<IDocumentDeltaConnectionEvents>\n    implements IDocumentDeltaConnection, IDisposable {\n    static readonly eventsToForward = [\"nack\", \"op\", \"signal\", \"pong\"];\n\n    // WARNING: These are critical events that we can't miss, so registration for them has to be in place at all times!\n    // Including before handshake is over, and after that (but before DeltaManager had a chance to put its own handlers)\n    static readonly eventsAlwaysForwarded = [\"disconnect\", \"error\"];\n\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    public checkpointSequenceNumber: number | undefined;\n\n    // Listen for ops sent before we receive a response to connect_document\n    protected readonly queuedMessages: ISequencedDocumentMessage[] = [];\n    protected readonly queuedSignals: ISignalMessage[] = [];\n\n    /**\n     * A flag to indicate whether we have our handler attached.  If it's attached, we're queueing incoming ops\n     * to later be retrieved via initialMessages.\n     */\n    private earlyOpHandlerAttached: boolean = false;\n\n    private socketConnectionTimeout: ReturnType<typeof setTimeout> | undefined;\n\n    private _details: IConnected | undefined;\n\n    // Listeners only needed while the connection is in progress\n    private readonly connectionListeners: Map<string, (...args: any[]) => void> = new Map();\n    // Listeners used throughout the lifetime of the DocumentDeltaConnection\n    private readonly trackedListeners: Map<string, (...args: any[]) => void> = new Map();\n\n    protected get hasDetails(): boolean {\n        return !!this._details;\n    }\n\n    public get disposed() {\n        assert(this._disposed || this.socket.connected, 0x244 /* \"Socket is closed, but connection is not!\" */);\n        return this._disposed;\n    }\n\n    /**\n     * Flag to indicate whether the DocumentDeltaConnection is expected to still be capable of sending messages.\n     * After disconnection, we flip this to prevent any stale messages from being emitted.\n     */\n    protected _disposed: boolean = false;\n    private readonly mc: MonitoringContext;\n\n    /**\n     * @deprecated Implementors should manage their own logger or monitoring context\n     */\n    protected get logger(): ITelemetryLogger {\n        return this.mc.logger;\n    }\n\n    public get details(): IConnected {\n        if (!this._details) {\n            throw new Error(\"Internal error: calling method before _details is initialized!\");\n        }\n        return this._details;\n    }\n\n    /**\n     * @param socket - websocket to be used\n     * @param documentId - ID of the document\n     * @param logger - for reporting telemetry events\n     * @param enableLongPollingDowngrades - allow connection to be downgraded to long-polling on websocket failure\n     */\n    protected constructor(\n        protected readonly socket: Socket,\n        public documentId: string,\n        logger: ITelemetryLogger,\n        private readonly enableLongPollingDowngrades: boolean = false,\n    ) {\n        super((name, error) => {\n            logger.sendErrorEvent(\n                {\n                    eventName: \"DeltaConnection:EventException\",\n                    name,\n                },\n                error);\n        });\n\n        this.mc = loggerToMonitoringContext(\n            ChildLogger.create(logger, \"DeltaConnection\"));\n\n        this.on(\"newListener\", (event, listener) => {\n            assert(!this.disposed, 0x20a /* \"register for event on disposed object\" */);\n\n            // Some events are already forwarded - see this.addTrackedListener() calls in initialize().\n            if (DocumentDeltaConnection.eventsAlwaysForwarded.includes(event)) {\n                assert(this.trackedListeners.has(event), 0x245 /* \"tracked listener\" */);\n                return;\n            }\n\n            if (!DocumentDeltaConnection.eventsToForward.includes(event)) {\n                throw new Error(`DocumentDeltaConnection: Registering for unknown event: ${event}`);\n            }\n\n            // Whenever listener is added, we should subscribe on same event on socket, so these two things\n            // should be in sync. This currently assumes that nobody unregisters and registers back listeners,\n            // and that there are no \"internal\" listeners installed (like \"error\" case we skip above)\n            // Better flow might be to always unconditionally register all handlers on successful connection,\n            // though some logic (naming assert in initialMessages getter) might need to be adjusted (it becomes noop)\n            assert((this.listeners(event).length !== 0) === this.trackedListeners.has(event), 0x20b /* \"mismatch\" */);\n            if (!this.trackedListeners.has(event)) {\n                this.addTrackedListener(\n                    event,\n                    (...args: any[]) => {\n                        this.emit(event, ...args);\n                    });\n            }\n        });\n    }\n\n    /**\n     * Get the ID of the client who is sending the message\n     *\n     * @returns the client ID\n     */\n    public get clientId(): string {\n        return this.details.clientId;\n    }\n\n    /**\n     * Get the mode of the client\n     *\n     * @returns the client mode\n     */\n    public get mode(): ConnectionMode {\n        return this.details.mode;\n    }\n\n    /**\n     * Get the claims of the client who is sending the message\n     *\n     * @returns client claims\n     */\n    public get claims(): ITokenClaims {\n        return this.details.claims;\n    }\n\n    /**\n     * Get whether or not this is an existing document\n     *\n     * @returns true if the document exists\n     */\n    public get existing(): boolean {\n        return this.details.existing;\n    }\n\n    /**\n     * Get the maximum size of a message before chunking is required\n     *\n     * @returns the maximum size of a message before chunking is required\n     */\n    public get maxMessageSize(): number {\n        return this.details.serviceConfiguration.maxMessageSize;\n    }\n\n    /**\n     * Semver of protocol being used with the service\n     */\n    public get version(): string {\n        return this.details.version;\n    }\n\n    /**\n     * Configuration details provided by the service\n     */\n    public get serviceConfiguration(): IClientConfiguration {\n        return this.details.serviceConfiguration;\n    }\n\n    private checkNotClosed() {\n        assert(!this.disposed, 0x20c /* \"connection disposed\" */);\n    }\n\n    /**\n     * Get messages sent during the connection\n     *\n     * @returns messages sent during the connection\n     */\n    public get initialMessages(): ISequencedDocumentMessage[] {\n        this.checkNotClosed();\n\n        // If we call this when the earlyOpHandler is not attached, then the queuedMessages may not include the\n        // latest ops.  This could possibly indicate that initialMessages was called twice.\n        assert(this.earlyOpHandlerAttached, 0x08e /* \"Potentially missed initial messages\" */);\n        // We will lose ops and perf will tank as we need to go to storage to become current!\n        assert(this.listeners(\"op\").length !== 0, 0x08f /* \"No op handler is setup!\" */);\n\n        this.removeEarlyOpHandler();\n\n        if (this.queuedMessages.length > 0) {\n            // Some messages were queued.\n            // add them to the list of initialMessages to be processed\n            this.details.initialMessages.push(...this.queuedMessages);\n            this.details.initialMessages.sort((a, b) => a.sequenceNumber - b.sequenceNumber);\n            this.queuedMessages.length = 0;\n        }\n        return this.details.initialMessages;\n    }\n\n    /**\n     * Get signals sent during the connection\n     *\n     * @returns signals sent during the connection\n     */\n    public get initialSignals(): ISignalMessage[] {\n        this.checkNotClosed();\n        assert(this.listeners(\"signal\").length !== 0, 0x090 /* \"No signal handler is setup!\" */);\n\n        this.removeEarlySignalHandler();\n\n        if (this.queuedSignals.length > 0) {\n            // Some signals were queued.\n            // add them to the list of initialSignals to be processed\n            this.details.initialSignals.push(...this.queuedSignals);\n            this.queuedSignals.length = 0;\n        }\n        return this.details.initialSignals;\n    }\n\n    /**\n     * Get initial client list\n     *\n     * @returns initial client list sent during the connection\n     */\n    public get initialClients(): ISignalClient[] {\n        this.checkNotClosed();\n        return this.details.initialClients;\n    }\n\n    protected emitMessages(type: string, messages: IDocumentMessage[][]) {\n        // Although the implementation here disconnects the socket and does not reuse it, other subclasses\n        // (e.g. OdspDocumentDeltaConnection) may reuse the socket.  In these cases, we need to avoid emitting\n        // on the still-live socket.\n        if (!this.disposed) {\n            this.socket.emit(type, this.clientId, messages);\n        }\n    }\n\n    protected submitCore(type: string, messages: IDocumentMessage[]) {\n        this.emitMessages(type, [messages]);\n    }\n\n    /**\n     * Submits a new delta operation to the server\n     *\n     * @param message - delta operation to submit\n     */\n    public submit(messages: IDocumentMessage[]): void {\n        this.checkNotClosed();\n        this.submitCore(\"submitOp\", messages);\n    }\n\n    /**\n     * Submits a new signal to the server\n     *\n     * @param message - signal to submit\n     */\n    public submitSignal(message: IDocumentMessage): void {\n        this.checkNotClosed();\n        this.submitCore(\"submitSignal\", [message]);\n    }\n\n    /**\n     * Disconnect from the websocket, and permanently disable this DocumentDeltaConnection.\n     */\n    public dispose() {\n        this.disposeCore(\n            false, // socketProtocolError\n            createGenericNetworkError(\n                // pre-0.58 error message: clientClosingConnection\n                \"Client closing delta connection\", { canRetry: true }, { driverVersion }));\n    }\n\n    protected disposeCore(socketProtocolError: boolean, err: IAnyDriverError) {\n        // Can't check this.disposed here, as we get here on socket closure,\n        // so _disposed & socket.connected might be not in sync while processing\n        // \"dispose\" event.\n        if (this._disposed) {\n            return;\n        }\n\n        // We set the disposed flag as a part of the contract for overriding the disconnect method. This is used by\n        // DocumentDeltaConnection to determine if emitting messages (ops) on the socket is allowed, which is\n        // important since OdspDocumentDeltaConnection reuses the socket rather than truly disconnecting it. Note that\n        // OdspDocumentDeltaConnection may still send disconnect_document which is allowed; this is only intended\n        // to prevent normal messages from being emitted.\n        this._disposed = true;\n\n        this.removeTrackedListeners();\n        this.disconnect(socketProtocolError, err);\n    }\n\n    /**\n     * Disconnect from the websocket.\n     * @param socketProtocolError - true if error happened on socket / socket.io protocol level\n     * (not on Fluid protocol level)\n     * @param reason - reason for disconnect\n     */\n    protected disconnect(socketProtocolError: boolean, reason: IAnyDriverError) {\n        this.socket.disconnect();\n    }\n\n    protected async initialize(connectMessage: IConnect, timeout: number) {\n        this.socket.on(\"op\", this.earlyOpHandler);\n        this.socket.on(\"signal\", this.earlySignalHandler);\n        this.earlyOpHandlerAttached = true;\n\n        // Socket.io's reconnect_attempt event is unreliable, so we track connect_error count instead.\n        let internalSocketConnectionFailureCount: number = 0;\n        const isInternalSocketReconnectionEnabled = (): boolean => this.socket.io.reconnection();\n        const getMaxInternalSocketReconnectionAttempts = (): number => isInternalSocketReconnectionEnabled()\n            ? this.socket.io.reconnectionAttempts()\n            : 0;\n        const getMaxAllowedInternalSocketConnectionFailures = (): number =>\n            getMaxInternalSocketReconnectionAttempts() + 1;\n\n        this._details = await new Promise<IConnected>((resolve, reject) => {\n            const fail = (socketProtocolError: boolean, err: IAnyDriverError) => {\n                this.disposeCore(socketProtocolError, err);\n                reject(err);\n            };\n\n            // Listen for connection issues\n            this.addConnectionListener(\"connect_error\", (error) => {\n                internalSocketConnectionFailureCount++;\n                let isWebSocketTransportError = false;\n                try {\n                    const description = error?.description;\n                    if (description && typeof description === \"object\") {\n                        if (error.type === \"TransportError\") {\n                            isWebSocketTransportError = true;\n                        }\n                        // That's a WebSocket. Clear it as we can't log it.\n                        description.target = undefined;\n                    }\n                } catch (_e) { }\n\n                // Handle socket transport downgrading when not offline.\n                if (\n                    isWebSocketTransportError &&\n                    this.enableLongPollingDowngrades &&\n                    this.socket.io.opts.transports?.[0] !== \"polling\") {\n                    // Downgrade transports to polling upgrade mechanism.\n                    this.socket.io.opts.transports = [\"polling\", \"websocket\"];\n                    // Don't alter reconnection behavior if already enabled.\n                    if (!isInternalSocketReconnectionEnabled()) {\n                        // Allow single reconnection attempt using polling upgrade mechanism.\n                        this.socket.io.reconnection(true);\n                        this.socket.io.reconnectionAttempts(1);\n                    }\n                }\n\n                // Allow built-in socket.io reconnection handling.\n                if (isInternalSocketReconnectionEnabled() &&\n                    internalSocketConnectionFailureCount < getMaxAllowedInternalSocketConnectionFailures()) {\n                    // Reconnection is enabled and maximum reconnect attempts have not been reached.\n                    return;\n                }\n\n                fail(true, this.createErrorObject(\"connect_error\", error));\n            });\n\n            // Listen for timeouts\n            this.addConnectionListener(\"connect_timeout\", () => {\n                fail(true, this.createErrorObject(\"connect_timeout\"));\n            });\n\n            this.addConnectionListener(\"connect_document_success\", (response: IConnected) => {\n                // If we sent a nonce and the server supports nonces, check that the nonces match\n                if (connectMessage.nonce !== undefined &&\n                    response.nonce !== undefined &&\n                    response.nonce !== connectMessage.nonce) {\n                    return;\n                }\n\n                const requestedMode = connectMessage.mode;\n                const actualMode = response.mode;\n                const writingPermitted = response.claims.scopes.includes(ScopeType.DocWrite);\n\n                if (writingPermitted) {\n                    // The only time we expect a mismatch in requested/actual is if we lack write permissions\n                    // In this case we will get \"read\", even if we requested \"write\"\n                    if (actualMode !== requestedMode) {\n                        fail(false, this.createErrorObject(\n                            \"connect_document_success\",\n                            \"Connected in a different mode than was requested\",\n                            false,\n                        ));\n                        return;\n                    }\n                } else {\n                    if (actualMode === \"write\") {\n                        fail(false, this.createErrorObject(\n                            \"connect_document_success\",\n                            \"Connected in write mode without write permissions\",\n                            false,\n                        ));\n                        return;\n                    }\n                }\n\n                this.checkpointSequenceNumber = response.checkpointSequenceNumber;\n\n                this.removeConnectionListeners();\n                resolve(response);\n            });\n\n            // Socket can be disconnected while waiting for Fluid protocol messages\n            // (connect_document_error / connect_document_success), as well as before DeltaManager\n            // had a chance to register its handlers.\n            this.addTrackedListener(\"disconnect\", (reason) => {\n                const err = this.createErrorObject(\"disconnect\", reason);\n                this.emit(\"disconnect\", err);\n                fail(true, err);\n            });\n\n            this.addTrackedListener(\"error\", ((error) => {\n                // First, raise an error event, to give clients a chance to observe error contents\n                // This includes \"Invalid namespace\" error, which we consider critical (reconnecting will not help)\n                const err = this.createErrorObject(\"error\", error, error !== \"Invalid namespace\");\n                this.emit(\"error\", err);\n                // Disconnect socket - required if happened before initial handshake\n                fail(true, err);\n            }));\n\n            this.addConnectionListener(\"connect_document_error\", ((error) => {\n                // If we sent a nonce and the server supports nonces, check that the nonces match\n                if (connectMessage.nonce !== undefined &&\n                    error.nonce !== undefined &&\n                    error.nonce !== connectMessage.nonce) {\n                    return;\n                }\n\n                // This is not an socket.io error - it's Fluid protocol error.\n                // In this case fail connection and indicate that we were unable to create connection\n                fail(false, this.createErrorObject(\"connect_document_error\", error));\n            }));\n\n            this.socket.emit(\"connect_document\", connectMessage);\n\n            // Give extra 2 seconds for handshake on top of socket connection timeout\n            this.socketConnectionTimeout = setTimeout(() => {\n                fail(false, this.createErrorObject(\"orderingServiceHandshakeTimeout\"));\n            }, timeout + 2000);\n        });\n\n        assert(!this.disposed, 0x246 /* \"checking consistency of socket & _disposed flags\" */);\n    }\n\n    protected earlyOpHandler = (documentId: string, msgs: ISequencedDocumentMessage[]) => {\n        this.queuedMessages.push(...msgs);\n    };\n\n    protected earlySignalHandler = (msg: ISignalMessage) => {\n        this.queuedSignals.push(msg);\n    };\n\n    private removeEarlyOpHandler() {\n        this.socket.removeListener(\"op\", this.earlyOpHandler);\n        this.earlyOpHandlerAttached = false;\n    }\n\n    private removeEarlySignalHandler() {\n        this.socket.removeListener(\"signal\", this.earlySignalHandler);\n    }\n\n    private addConnectionListener(event: string, listener: (...args: any[]) => void) {\n        assert(!DocumentDeltaConnection.eventsAlwaysForwarded.includes(event),\n            0x247 /* \"Use addTrackedListener instead\" */);\n        assert(!DocumentDeltaConnection.eventsToForward.includes(event),\n            0x248 /* \"should not subscribe to forwarded events\" */);\n        this.socket.on(event, listener);\n        assert(!this.connectionListeners.has(event), 0x20d /* \"double connection listener\" */);\n        this.connectionListeners.set(event, listener);\n    }\n\n    protected addTrackedListener(event: string, listener: (...args: any[]) => void) {\n        this.socket.on(event, listener);\n        assert(!this.trackedListeners.has(event), 0x20e /* \"double tracked listener\" */);\n        this.trackedListeners.set(event, listener);\n    }\n\n    private removeTrackedListeners() {\n        for (const [event, listener] of this.trackedListeners.entries()) {\n            this.socket.off(event, listener);\n        }\n        // removeTrackedListeners removes all listeners, including connection listeners\n        this.removeConnectionListeners();\n\n        this.removeEarlyOpHandler();\n        this.removeEarlySignalHandler();\n\n        this.trackedListeners.clear();\n    }\n\n    private removeConnectionListeners() {\n        if (this.socketConnectionTimeout !== undefined) {\n            clearTimeout(this.socketConnectionTimeout);\n        }\n\n        for (const [event, listener] of this.connectionListeners.entries()) {\n            this.socket.off(event, listener);\n        }\n        this.connectionListeners.clear();\n    }\n\n    /**\n     * Error raising for socket.io issues\n     */\n    protected createErrorObject(handler: string, error?: any, canRetry = true): IAnyDriverError {\n        // Note: we suspect the incoming error object is either:\n        // - a string: log it in the message (if not a string, it may contain PII but will print as [object Object])\n        // - an Error object thrown by socket.io engine. Be careful with not recording PII!\n        let message: string;\n        if (error?.type === \"TransportError\") {\n            // JSON.stringify drops Error.message\n            const messagePrefix = (error?.message !== undefined)\n                ? `${error.message}: `\n                : \"\";\n\n            // Websocket errors reported by engine.io-client.\n            // They are Error objects with description containing WS error and description = \"TransportError\"\n            // Please see https://github.com/socketio/engine.io-client/blob/7245b80/lib/transport.ts#L44,\n            message = `${messagePrefix}${JSON.stringify(error, getCircularReplacer())}`;\n        } else {\n            message = extractLogSafeErrorProperties(error, true).message;\n        }\n\n        const errorObj = createGenericNetworkError(\n            `socket.io (${handler}): ${message}`,\n            { canRetry },\n            { driverVersion },\n        );\n\n        return errorObj;\n    }\n}\n"]}
+{"version":3,"file":"documentDeltaConnection.js","sourceRoot":"","sources":["../src/documentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAMtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAUH,SAAS,GACZ,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EACH,WAAW,EACX,6BAA6B,EAC7B,mBAAmB,EACnB,yBAAyB,EAEzB,6BAA6B,GAChC,MAAM,iCAAiC,CAAC;AAEzC,sFAAsF;AACtF,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE/D;;GAEG;AACH,MAAM,OAAO,uBACT,SAAQ,6BAA6D;IAkErE;;;;;OAKG;IACH,YACuB,MAAc,EAC1B,UAAkB,EACzB,MAAwB,EACP,8BAAuC,KAAK;QAE7D,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAClB,MAAM,CAAC,cAAc,CACjB;gBACI,SAAS,EAAE,gCAAgC;gBAC3C,IAAI;aACP,EACD,KAAK,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAZgB,WAAM,GAAN,MAAM,CAAQ;QAC1B,eAAU,GAAV,UAAU,CAAQ;QAER,gCAA2B,GAA3B,2BAA2B,CAAiB;QA3DjE,uEAAuE;QACpD,mBAAc,GAAgC,EAAE,CAAC;QACjD,kBAAa,GAAqB,EAAE,CAAC;QAExD;;;WAGG;QACK,2BAAsB,GAAY,KAAK,CAAC;QAMhD,4DAA4D;QAC3C,wBAAmB,GAA0C,IAAI,GAAG,EAAE,CAAC;QACxF,wEAAwE;QACvD,qBAAgB,GAA0C,IAAI,GAAG,EAAE,CAAC;QAWrF;;;WAGG;QACO,cAAS,GAAY,KAAK,CAAC;QAob3B,mBAAc,GAAG,CAAC,UAAkB,EAAE,IAAiC,EAAE,EAAE;YACjF,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC;QAEQ,uBAAkB,GAAG,CAAC,GAAmB,EAAE,EAAE;YACnD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC;QApZE,IAAI,CAAC,EAAE,GAAG,yBAAyB,CAC/B,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;QAEnD,IAAI,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACvC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,6CAA6C,CAAC,CAAC;YAE5E,2FAA2F;YAC3F,IAAI,uBAAuB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC/D,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;gBACzE,OAAO;aACV;YAED,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,2DAA2D,KAAK,EAAE,CAAC,CAAC;aACvF;YAED,+FAA+F;YAC/F,kGAAkG;YAClG,yFAAyF;YACzF,iGAAiG;YACjG,0GAA0G;YAC1G,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;YAC1G,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACnC,IAAI,CAAC,kBAAkB,CACnB,KAAK,EACL,CAAC,GAAG,IAAW,EAAE,EAAE;oBACf,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;gBAC9B,CAAC,CAAC,CAAC;aACV;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAjFD,IAAc,UAAU;QACpB,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAW,QAAQ;QACf,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACxG,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IASD;;OAEG;IACH,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,IAAW,OAAO;QACd,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;SACrF;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAuDD;;;;OAIG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,cAAc,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,oBAAoB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC;IAC7C,CAAC;IAEO,cAAc;QAClB,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,IAAW,eAAe;QACtB,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,uGAAuG;QACvG,mFAAmF;QACnF,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACvF,qFAAqF;QACrF,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAEjF,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,6BAA6B;YAC7B,0DAA0D;YAC1D,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;YAC1D,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC;YACjF,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;SAClC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,IAAW,cAAc;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAEzF,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAEhC,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,4BAA4B;YAC5B,yDAAyD;YACzD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACxD,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;SACjC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,IAAW,cAAc;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACvC,CAAC;IAES,YAAY,CAAC,IAAY,EAAE,QAA8B;QAC/D,kGAAkG;QAClG,sGAAsG;QACtG,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAChB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;SACnD;IACL,CAAC;IAES,UAAU,CAAC,IAAY,EAAE,QAA4B;QAC3D,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAA4B;QACtC,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,OAAyB;QACzC,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,KAAsB;QACxC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,OAAO;QACV,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,8BAA8B;YACzC,aAAa;YACb,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;SAChG,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CAAC,yBAAyB;QACrC,kDAAkD;QAClD,iCAAiC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,CAC5E,CAAC;IACN,CAAC;IAES,UAAU,CAAC,GAAoB;QACrC,oEAAoE;QACpE,wEAAwE;QACxE,mBAAmB;QACnB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO;SACV;QAED,2GAA2G;QAC3G,qGAAqG;QACrG,8GAA8G;QAC9G,yGAAyG;QACzG,iDAAiD;QACjD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,2GAA2G;QAC3G,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,sBAAsB;YACjC,aAAa;YACb,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;gBACtC,uBAAuB,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;aAC5D,CAAC;SACL,CAAC,CAAC;QACH,wGAAwG;QACxG,uGAAuG;QACvG,2GAA2G;QAE3G,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACO,cAAc;QACpB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAC7B,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,cAAwB,EAAE,OAAe;QAChE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAClD,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAEnC,8FAA8F;QAC9F,IAAI,oCAAoC,GAAW,CAAC,CAAC;QACrD,MAAM,mCAAmC,GAAG,GAAY,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC;QACzF,MAAM,wCAAwC,GAAG,GAAW,EAAE,CAAC,mCAAmC,EAAE;YAChG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,EAAE;YACvC,CAAC,CAAC,CAAC,CAAC;QACR,MAAM,6CAA6C,GAAG,GAAW,EAAE,CAC/D,wCAAwC,EAAE,GAAG,CAAC,CAAC;QAEnD,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9D,MAAM,kBAAkB,GAAG,CAAC,GAAoB,EAAE,EAAE;gBAChD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,CAAC,CAAC;YAEF,MAAM,cAAc,GAAG,CAAC,GAAoB,EAAE,EAAE;gBAC5C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,CAAC,CAAC;YACF,+BAA+B;YAC/B,IAAI,CAAC,qBAAqB,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE;;gBAClD,oCAAoC,EAAE,CAAC;gBACvC,IAAI,yBAAyB,GAAG,KAAK,CAAC;gBACtC,IAAI;oBACA,MAAM,WAAW,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,CAAC;oBACvC,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;wBAChD,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE;4BACjC,yBAAyB,GAAG,IAAI,CAAC;yBACpC;wBACD,mDAAmD;wBACnD,WAAW,CAAC,MAAM,GAAG,SAAS,CAAC;qBAClC;iBACJ;gBAAC,OAAO,EAAE,EAAE,GAAG;gBAEhB,wDAAwD;gBACxD,IACI,yBAAyB;oBACzB,IAAI,CAAC,2BAA2B;oBAChC,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,0CAAG,CAAC,CAAC,MAAK,SAAS,EAAE;oBACnD,qDAAqD;oBACrD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;oBAC1D,wDAAwD;oBACxD,IAAI,CAAC,mCAAmC,EAAE,EAAE;wBACxC,qEAAqE;wBACrE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;wBAClC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;qBAC1C;iBACJ;gBAED,kDAAkD;gBAClD,IAAI,mCAAmC,EAAE;oBACrC,oCAAoC,GAAG,6CAA6C,EAAE,EAAE;oBACxF,gFAAgF;oBAChF,OAAO;iBACV;gBAED,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;YACvE,CAAC,CAAC,CAAC;YAEH,sBAAsB;YACtB,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBAC/C,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,qBAAqB,CAAC,0BAA0B,EAAE,CAAC,QAAoB,EAAE,EAAE;gBAC5E,iFAAiF;gBACjF,IAAI,cAAc,CAAC,KAAK,KAAK,SAAS;oBAClC,QAAQ,CAAC,KAAK,KAAK,SAAS;oBAC5B,QAAQ,CAAC,KAAK,KAAK,cAAc,CAAC,KAAK,EAAE;oBACzC,OAAO;iBACV;gBAED,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC;gBAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC;gBACjC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAE7E,IAAI,gBAAgB,EAAE;oBAClB,yFAAyF;oBACzF,gEAAgE;oBAChE,IAAI,UAAU,KAAK,aAAa,EAAE;wBAC9B,cAAc,CAAC,IAAI,CAAC,iBAAiB,CACjC,0BAA0B,EAC1B,kDAAkD,EAClD,KAAK,CACR,CAAC,CAAC;wBACH,OAAO;qBACV;iBACJ;qBAAM;oBACH,IAAI,UAAU,KAAK,OAAO,EAAE;wBACxB,cAAc,CAAC,IAAI,CAAC,iBAAiB,CACjC,0BAA0B,EAC1B,mDAAmD,EACnD,KAAK,CACR,CAAC,CAAC;wBACH,OAAO;qBACV;iBACJ;gBAED,IAAI,CAAC,wBAAwB,GAAG,QAAQ,CAAC,wBAAwB,CAAC;gBAElE,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACjC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,uEAAuE;YACvE,sFAAsF;YACtF,yCAAyC;YACzC,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;gBAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBACzD,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAC5B,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE;gBACxC,mGAAmG;gBACnG,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,KAAK,mBAAmB,CAAC,CAAC;gBAClF,oEAAoE;gBACpE,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAC5B,CAAC,CAAC,CAAC,CAAC;YAEJ,IAAI,CAAC,qBAAqB,CAAC,wBAAwB,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC5D,iFAAiF;gBACjF,IAAI,cAAc,CAAC,KAAK,KAAK,SAAS;oBAClC,KAAK,CAAC,KAAK,KAAK,SAAS;oBACzB,KAAK,CAAC,KAAK,KAAK,cAAc,CAAC,KAAK,EAAE;oBACtC,OAAO;iBACV;gBAED,8DAA8D;gBAC9D,qFAAqF;gBACrF,cAAc,CAAC,IAAI,CAAC,iBAAiB,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC,CAAC;YAEJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC;YAErD,yEAAyE;YACzE,IAAI,CAAC,uBAAuB,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC3C,cAAc,CAAC,IAAI,CAAC,iBAAiB,CAAC,iCAAiC,CAAC,CAAC,CAAC;YAC9E,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC3F,CAAC;IAUO,oBAAoB;QACxB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;IACxC,CAAC;IAEO,wBAAwB;QAC5B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAClE,CAAC;IAEO,qBAAqB,CAAC,KAAa,EAAE,QAAkC;QAC3E,MAAM,CAAC,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,EACjE,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAClD,MAAM,CAAC,CAAC,uBAAuB,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAC3D,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAChC,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACvF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAES,kBAAkB,CAAC,KAAa,EAAE,QAAkC;QAC1E,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAChC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACjF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAEO,sBAAsB;QAC1B,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE;YAC7D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;SACpC;QACD,+EAA+E;QAC/E,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAEjC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAEhC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAEO,yBAAyB;QAC7B,IAAI,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAAE;YAC5C,YAAY,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;SAC9C;QAED,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE;YAChE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;SACpC;QACD,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,OAAe,EAAE,KAAW,EAAE,QAAQ,GAAG,IAAI;QACrE,wDAAwD;QACxD,4GAA4G;QAC5G,mFAAmF;QACnF,IAAI,OAAe,CAAC;QACpB,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,gBAAgB,EAAE;YAClC,qCAAqC;YACrC,MAAM,aAAa,GAAG,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,MAAK,SAAS,CAAC;gBAChD,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,IAAI;gBACtB,CAAC,CAAC,EAAE,CAAC;YAET,iDAAiD;YACjD,iGAAiG;YACjG,6FAA6F;YAC7F,OAAO,GAAG,GAAG,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,mBAAmB,EAAE,CAAC,EAAE,CAAC;SAC/E;aAAM;YACH,OAAO,GAAG,6BAA6B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC;SAChE;QAED,MAAM,QAAQ,GAAG,yBAAyB,CACtC,cAAc,OAAO,MAAM,OAAO,EAAE,EACpC,EAAE,QAAQ,EAAE,EACZ,EAAE,aAAa,EAAE,CACpB,CAAC;QAEF,OAAO,QAAQ,CAAC;IACpB,CAAC;;AAzjBe,uCAAe,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEnE,mHAAmH;AACnH,oHAAoH;AACpG,6CAAqB,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    IAnyDriverError,\n    IDocumentDeltaConnection,\n    IDocumentDeltaConnectionEvents,\n} from \"@fluidframework/driver-definitions\";\nimport { createGenericNetworkError } from \"@fluidframework/driver-utils\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IConnect,\n    IConnected,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n    ScopeType,\n} from \"@fluidframework/protocol-definitions\";\nimport { IDisposable, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    ChildLogger,\n    extractLogSafeErrorProperties,\n    getCircularReplacer,\n    loggerToMonitoringContext,\n    MonitoringContext,\n    EventEmitterWithErrorHandling,\n} from \"@fluidframework/telemetry-utils\";\nimport type { Socket } from \"socket.io-client\";\n// For now, this package is versioned and released in unison with the specific drivers\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n/**\n * Represents a connection to a stream of delta updates\n */\nexport class DocumentDeltaConnection\n    extends EventEmitterWithErrorHandling<IDocumentDeltaConnectionEvents>\n    implements IDocumentDeltaConnection, IDisposable {\n    static readonly eventsToForward = [\"nack\", \"op\", \"signal\", \"pong\"];\n\n    // WARNING: These are critical events that we can't miss, so registration for them has to be in place at all times!\n    // Including before handshake is over, and after that (but before DeltaManager had a chance to put its own handlers)\n    static readonly eventsAlwaysForwarded = [\"disconnect\", \"error\"];\n\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    public checkpointSequenceNumber: number | undefined;\n\n    // Listen for ops sent before we receive a response to connect_document\n    protected readonly queuedMessages: ISequencedDocumentMessage[] = [];\n    protected readonly queuedSignals: ISignalMessage[] = [];\n\n    /**\n     * A flag to indicate whether we have our handler attached.  If it's attached, we're queueing incoming ops\n     * to later be retrieved via initialMessages.\n     */\n    private earlyOpHandlerAttached: boolean = false;\n\n    private socketConnectionTimeout: ReturnType<typeof setTimeout> | undefined;\n\n    private _details: IConnected | undefined;\n\n    // Listeners only needed while the connection is in progress\n    private readonly connectionListeners: Map<string, (...args: any[]) => void> = new Map();\n    // Listeners used throughout the lifetime of the DocumentDeltaConnection\n    private readonly trackedListeners: Map<string, (...args: any[]) => void> = new Map();\n\n    protected get hasDetails(): boolean {\n        return !!this._details;\n    }\n\n    public get disposed() {\n        assert(this._disposed || this.socket.connected, 0x244 /* \"Socket is closed, but connection is not!\" */);\n        return this._disposed;\n    }\n\n    /**\n     * Flag to indicate whether the DocumentDeltaConnection is expected to still be capable of sending messages.\n     * After disconnection, we flip this to prevent any stale messages from being emitted.\n     */\n    protected _disposed: boolean = false;\n    private readonly mc: MonitoringContext;\n\n    /**\n     * @deprecated Implementors should manage their own logger or monitoring context\n     */\n    protected get logger(): ITelemetryLogger {\n        return this.mc.logger;\n    }\n\n    public get details(): IConnected {\n        if (!this._details) {\n            throw new Error(\"Internal error: calling method before _details is initialized!\");\n        }\n        return this._details;\n    }\n\n    /**\n     * @param socket - websocket to be used\n     * @param documentId - ID of the document\n     * @param logger - for reporting telemetry events\n     * @param enableLongPollingDowngrades - allow connection to be downgraded to long-polling on websocket failure\n     */\n    protected constructor(\n        protected readonly socket: Socket,\n        public documentId: string,\n        logger: ITelemetryLogger,\n        private readonly enableLongPollingDowngrades: boolean = false,\n    ) {\n        super((name, error) => {\n            logger.sendErrorEvent(\n                {\n                    eventName: \"DeltaConnection:EventException\",\n                    name,\n                },\n                error);\n        });\n\n        this.mc = loggerToMonitoringContext(\n            ChildLogger.create(logger, \"DeltaConnection\"));\n\n        this.on(\"newListener\", (event, listener) => {\n            assert(!this.disposed, 0x20a /* \"register for event on disposed object\" */);\n\n            // Some events are already forwarded - see this.addTrackedListener() calls in initialize().\n            if (DocumentDeltaConnection.eventsAlwaysForwarded.includes(event)) {\n                assert(this.trackedListeners.has(event), 0x245 /* \"tracked listener\" */);\n                return;\n            }\n\n            if (!DocumentDeltaConnection.eventsToForward.includes(event)) {\n                throw new Error(`DocumentDeltaConnection: Registering for unknown event: ${event}`);\n            }\n\n            // Whenever listener is added, we should subscribe on same event on socket, so these two things\n            // should be in sync. This currently assumes that nobody unregisters and registers back listeners,\n            // and that there are no \"internal\" listeners installed (like \"error\" case we skip above)\n            // Better flow might be to always unconditionally register all handlers on successful connection,\n            // though some logic (naming assert in initialMessages getter) might need to be adjusted (it becomes noop)\n            assert((this.listeners(event).length !== 0) === this.trackedListeners.has(event), 0x20b /* \"mismatch\" */);\n            if (!this.trackedListeners.has(event)) {\n                this.addTrackedListener(\n                    event,\n                    (...args: any[]) => {\n                        this.emit(event, ...args);\n                    });\n            }\n        });\n    }\n\n    /**\n     * Get the ID of the client who is sending the message\n     *\n     * @returns the client ID\n     */\n    public get clientId(): string {\n        return this.details.clientId;\n    }\n\n    /**\n     * Get the mode of the client\n     *\n     * @returns the client mode\n     */\n    public get mode(): ConnectionMode {\n        return this.details.mode;\n    }\n\n    /**\n     * Get the claims of the client who is sending the message\n     *\n     * @returns client claims\n     */\n    public get claims(): ITokenClaims {\n        return this.details.claims;\n    }\n\n    /**\n     * Get whether or not this is an existing document\n     *\n     * @returns true if the document exists\n     */\n    public get existing(): boolean {\n        return this.details.existing;\n    }\n\n    /**\n     * Get the maximum size of a message before chunking is required\n     *\n     * @returns the maximum size of a message before chunking is required\n     */\n    public get maxMessageSize(): number {\n        return this.details.serviceConfiguration.maxMessageSize;\n    }\n\n    /**\n     * Semver of protocol being used with the service\n     */\n    public get version(): string {\n        return this.details.version;\n    }\n\n    /**\n     * Configuration details provided by the service\n     */\n    public get serviceConfiguration(): IClientConfiguration {\n        return this.details.serviceConfiguration;\n    }\n\n    private checkNotClosed() {\n        assert(!this.disposed, 0x20c /* \"connection disposed\" */);\n    }\n\n    /**\n     * Get messages sent during the connection\n     *\n     * @returns messages sent during the connection\n     */\n    public get initialMessages(): ISequencedDocumentMessage[] {\n        this.checkNotClosed();\n\n        // If we call this when the earlyOpHandler is not attached, then the queuedMessages may not include the\n        // latest ops.  This could possibly indicate that initialMessages was called twice.\n        assert(this.earlyOpHandlerAttached, 0x08e /* \"Potentially missed initial messages\" */);\n        // We will lose ops and perf will tank as we need to go to storage to become current!\n        assert(this.listeners(\"op\").length !== 0, 0x08f /* \"No op handler is setup!\" */);\n\n        this.removeEarlyOpHandler();\n\n        if (this.queuedMessages.length > 0) {\n            // Some messages were queued.\n            // add them to the list of initialMessages to be processed\n            this.details.initialMessages.push(...this.queuedMessages);\n            this.details.initialMessages.sort((a, b) => a.sequenceNumber - b.sequenceNumber);\n            this.queuedMessages.length = 0;\n        }\n        return this.details.initialMessages;\n    }\n\n    /**\n     * Get signals sent during the connection\n     *\n     * @returns signals sent during the connection\n     */\n    public get initialSignals(): ISignalMessage[] {\n        this.checkNotClosed();\n        assert(this.listeners(\"signal\").length !== 0, 0x090 /* \"No signal handler is setup!\" */);\n\n        this.removeEarlySignalHandler();\n\n        if (this.queuedSignals.length > 0) {\n            // Some signals were queued.\n            // add them to the list of initialSignals to be processed\n            this.details.initialSignals.push(...this.queuedSignals);\n            this.queuedSignals.length = 0;\n        }\n        return this.details.initialSignals;\n    }\n\n    /**\n     * Get initial client list\n     *\n     * @returns initial client list sent during the connection\n     */\n    public get initialClients(): ISignalClient[] {\n        this.checkNotClosed();\n        return this.details.initialClients;\n    }\n\n    protected emitMessages(type: string, messages: IDocumentMessage[][]) {\n        // Although the implementation here disconnects the socket and does not reuse it, other subclasses\n        // (e.g. OdspDocumentDeltaConnection) may reuse the socket.  In these cases, we need to avoid emitting\n        // on the still-live socket.\n        if (!this.disposed) {\n            this.socket.emit(type, this.clientId, messages);\n        }\n    }\n\n    protected submitCore(type: string, messages: IDocumentMessage[]) {\n        this.emitMessages(type, [messages]);\n    }\n\n    /**\n     * Submits a new delta operation to the server\n     *\n     * @param message - delta operation to submit\n     */\n    public submit(messages: IDocumentMessage[]): void {\n        this.checkNotClosed();\n        this.submitCore(\"submitOp\", messages);\n    }\n\n    /**\n     * Submits a new signal to the server\n     *\n     * @param message - signal to submit\n     */\n    public submitSignal(message: IDocumentMessage): void {\n        this.checkNotClosed();\n        this.submitCore(\"submitSignal\", [message]);\n    }\n\n    /**\n     * Disconnect from the websocket and close the websocket too.\n     */\n    protected closeSocket(error: IAnyDriverError) {\n        this.disconnect(error);\n    }\n\n    /**\n     * Disconnect from the websocket, and permanently disable this DocumentDeltaConnection and close the socket.\n     * However the OdspDocumentDeltaConnection differ in dispose as in there we don't close the socket. There is no\n     * multiplexing here, so we need to close the socket here.\n     */\n    public dispose() {\n        this.logger.sendTelemetryEvent({\n            eventName: \"ClientClosingDeltaConnection\",\n            driverVersion,\n            details: JSON.stringify({ disposed: this._disposed, socketConnected: this.socket.connected }),\n        });\n        this.disconnect(createGenericNetworkError(\n            // pre-0.58 error message: clientClosingConnection\n            \"Client closing delta connection\", { canRetry: true }, { driverVersion }),\n        );\n    }\n\n    protected disconnect(err: IAnyDriverError) {\n        // Can't check this.disposed here, as we get here on socket closure,\n        // so _disposed & socket.connected might be not in sync while processing\n        // \"dispose\" event.\n        if (this._disposed) {\n            return;\n        }\n\n        // We set the disposed flag as a part of the contract for overriding the disconnect method. This is used by\n        // DocumentDeltaConnection to determine if emitting messages (ops) on the socket is allowed, which is\n        // important since OdspDocumentDeltaConnection reuses the socket rather than truly disconnecting it. Note that\n        // OdspDocumentDeltaConnection may still send disconnect_document which is allowed; this is only intended\n        // to prevent normal messages from being emitted.\n        this._disposed = true;\n\n        // Let user of connection object know about disconnect. This has to happen in between setting _disposed and\n        // removing all listeners!\n        this.emit(\"disconnect\", err);\n        this.logger.sendTelemetryEvent({\n            eventName: \"AfterDisconnectEvent\",\n            driverVersion,\n            details: JSON.stringify({\n                socketConnected: this.socket.connected,\n                disconnectListenerCount: this.listenerCount(\"disconnect\"),\n            }),\n        });\n        // user of DeltaConnection should have processed \"disconnect\" event and removed all listeners. Not clear\n        // if we want to enforce that, as some users (like LocalDocumentService) do not unregister any handlers\n        // assert(this.listenerCount(\"disconnect\") === 0, \"'disconnect` events should be processed synchronously\");\n\n        this.removeTrackedListeners();\n        this.disconnectCore();\n    }\n\n    /**\n     * Disconnect from the websocket.\n     * @param reason - reason for disconnect\n     */\n    protected disconnectCore() {\n        this.socket.disconnect();\n    }\n\n    protected async initialize(connectMessage: IConnect, timeout: number) {\n        this.socket.on(\"op\", this.earlyOpHandler);\n        this.socket.on(\"signal\", this.earlySignalHandler);\n        this.earlyOpHandlerAttached = true;\n\n        // Socket.io's reconnect_attempt event is unreliable, so we track connect_error count instead.\n        let internalSocketConnectionFailureCount: number = 0;\n        const isInternalSocketReconnectionEnabled = (): boolean => this.socket.io.reconnection();\n        const getMaxInternalSocketReconnectionAttempts = (): number => isInternalSocketReconnectionEnabled()\n            ? this.socket.io.reconnectionAttempts()\n            : 0;\n        const getMaxAllowedInternalSocketConnectionFailures = (): number =>\n            getMaxInternalSocketReconnectionAttempts() + 1;\n\n        this._details = await new Promise<IConnected>((resolve, reject) => {\n            const failAndCloseSocket = (err: IAnyDriverError) => {\n                this.closeSocket(err);\n                reject(err);\n            };\n\n            const failConnection = (err: IAnyDriverError) => {\n                this.disconnect(err);\n                reject(err);\n            };\n            // Listen for connection issues\n            this.addConnectionListener(\"connect_error\", (error) => {\n                internalSocketConnectionFailureCount++;\n                let isWebSocketTransportError = false;\n                try {\n                    const description = error?.description;\n                    if (description && typeof description === \"object\") {\n                        if (error.type === \"TransportError\") {\n                            isWebSocketTransportError = true;\n                        }\n                        // That's a WebSocket. Clear it as we can't log it.\n                        description.target = undefined;\n                    }\n                } catch (_e) { }\n\n                // Handle socket transport downgrading when not offline.\n                if (\n                    isWebSocketTransportError &&\n                    this.enableLongPollingDowngrades &&\n                    this.socket.io.opts.transports?.[0] !== \"polling\") {\n                    // Downgrade transports to polling upgrade mechanism.\n                    this.socket.io.opts.transports = [\"polling\", \"websocket\"];\n                    // Don't alter reconnection behavior if already enabled.\n                    if (!isInternalSocketReconnectionEnabled()) {\n                        // Allow single reconnection attempt using polling upgrade mechanism.\n                        this.socket.io.reconnection(true);\n                        this.socket.io.reconnectionAttempts(1);\n                    }\n                }\n\n                // Allow built-in socket.io reconnection handling.\n                if (isInternalSocketReconnectionEnabled() &&\n                    internalSocketConnectionFailureCount < getMaxAllowedInternalSocketConnectionFailures()) {\n                    // Reconnection is enabled and maximum reconnect attempts have not been reached.\n                    return;\n                }\n\n                failAndCloseSocket(this.createErrorObject(\"connect_error\", error));\n            });\n\n            // Listen for timeouts\n            this.addConnectionListener(\"connect_timeout\", () => {\n                failAndCloseSocket(this.createErrorObject(\"connect_timeout\"));\n            });\n\n            this.addConnectionListener(\"connect_document_success\", (response: IConnected) => {\n                // If we sent a nonce and the server supports nonces, check that the nonces match\n                if (connectMessage.nonce !== undefined &&\n                    response.nonce !== undefined &&\n                    response.nonce !== connectMessage.nonce) {\n                    return;\n                }\n\n                const requestedMode = connectMessage.mode;\n                const actualMode = response.mode;\n                const writingPermitted = response.claims.scopes.includes(ScopeType.DocWrite);\n\n                if (writingPermitted) {\n                    // The only time we expect a mismatch in requested/actual is if we lack write permissions\n                    // In this case we will get \"read\", even if we requested \"write\"\n                    if (actualMode !== requestedMode) {\n                        failConnection(this.createErrorObject(\n                            \"connect_document_success\",\n                            \"Connected in a different mode than was requested\",\n                            false,\n                        ));\n                        return;\n                    }\n                } else {\n                    if (actualMode === \"write\") {\n                        failConnection(this.createErrorObject(\n                            \"connect_document_success\",\n                            \"Connected in write mode without write permissions\",\n                            false,\n                        ));\n                        return;\n                    }\n                }\n\n                this.checkpointSequenceNumber = response.checkpointSequenceNumber;\n\n                this.removeConnectionListeners();\n                resolve(response);\n            });\n\n            // Socket can be disconnected while waiting for Fluid protocol messages\n            // (connect_document_error / connect_document_success), as well as before DeltaManager\n            // had a chance to register its handlers.\n            this.addTrackedListener(\"disconnect\", (reason) => {\n                const err = this.createErrorObject(\"disconnect\", reason);\n                failAndCloseSocket(err);\n            });\n\n            this.addTrackedListener(\"error\", ((error) => {\n                // This includes \"Invalid namespace\" error, which we consider critical (reconnecting will not help)\n                const err = this.createErrorObject(\"error\", error, error !== \"Invalid namespace\");\n                // Disconnect socket - required if happened before initial handshake\n                failAndCloseSocket(err);\n            }));\n\n            this.addConnectionListener(\"connect_document_error\", ((error) => {\n                // If we sent a nonce and the server supports nonces, check that the nonces match\n                if (connectMessage.nonce !== undefined &&\n                    error.nonce !== undefined &&\n                    error.nonce !== connectMessage.nonce) {\n                    return;\n                }\n\n                // This is not an socket.io error - it's Fluid protocol error.\n                // In this case fail connection and indicate that we were unable to create connection\n                failConnection(this.createErrorObject(\"connect_document_error\", error));\n            }));\n\n            this.socket.emit(\"connect_document\", connectMessage);\n\n            // Give extra 2 seconds for handshake on top of socket connection timeout\n            this.socketConnectionTimeout = setTimeout(() => {\n                failConnection(this.createErrorObject(\"orderingServiceHandshakeTimeout\"));\n            }, timeout + 2000);\n        });\n\n        assert(!this.disposed, 0x246 /* \"checking consistency of socket & _disposed flags\" */);\n    }\n\n    protected earlyOpHandler = (documentId: string, msgs: ISequencedDocumentMessage[]) => {\n        this.queuedMessages.push(...msgs);\n    };\n\n    protected earlySignalHandler = (msg: ISignalMessage) => {\n        this.queuedSignals.push(msg);\n    };\n\n    private removeEarlyOpHandler() {\n        this.socket.removeListener(\"op\", this.earlyOpHandler);\n        this.earlyOpHandlerAttached = false;\n    }\n\n    private removeEarlySignalHandler() {\n        this.socket.removeListener(\"signal\", this.earlySignalHandler);\n    }\n\n    private addConnectionListener(event: string, listener: (...args: any[]) => void) {\n        assert(!DocumentDeltaConnection.eventsAlwaysForwarded.includes(event),\n            0x247 /* \"Use addTrackedListener instead\" */);\n        assert(!DocumentDeltaConnection.eventsToForward.includes(event),\n            0x248 /* \"should not subscribe to forwarded events\" */);\n        this.socket.on(event, listener);\n        assert(!this.connectionListeners.has(event), 0x20d /* \"double connection listener\" */);\n        this.connectionListeners.set(event, listener);\n    }\n\n    protected addTrackedListener(event: string, listener: (...args: any[]) => void) {\n        this.socket.on(event, listener);\n        assert(!this.trackedListeners.has(event), 0x20e /* \"double tracked listener\" */);\n        this.trackedListeners.set(event, listener);\n    }\n\n    private removeTrackedListeners() {\n        for (const [event, listener] of this.trackedListeners.entries()) {\n            this.socket.off(event, listener);\n        }\n        // removeTrackedListeners removes all listeners, including connection listeners\n        this.removeConnectionListeners();\n\n        this.removeEarlyOpHandler();\n        this.removeEarlySignalHandler();\n\n        this.trackedListeners.clear();\n    }\n\n    private removeConnectionListeners() {\n        if (this.socketConnectionTimeout !== undefined) {\n            clearTimeout(this.socketConnectionTimeout);\n        }\n\n        for (const [event, listener] of this.connectionListeners.entries()) {\n            this.socket.off(event, listener);\n        }\n        this.connectionListeners.clear();\n    }\n\n    /**\n     * Error raising for socket.io issues\n     */\n    protected createErrorObject(handler: string, error?: any, canRetry = true): IAnyDriverError {\n        // Note: we suspect the incoming error object is either:\n        // - a string: log it in the message (if not a string, it may contain PII but will print as [object Object])\n        // - an Error object thrown by socket.io engine. Be careful with not recording PII!\n        let message: string;\n        if (error?.type === \"TransportError\") {\n            // JSON.stringify drops Error.message\n            const messagePrefix = (error?.message !== undefined)\n                ? `${error.message}: `\n                : \"\";\n\n            // Websocket errors reported by engine.io-client.\n            // They are Error objects with description containing WS error and description = \"TransportError\"\n            // Please see https://github.com/socketio/engine.io-client/blob/7245b80/lib/transport.ts#L44,\n            message = `${messagePrefix}${JSON.stringify(error, getCircularReplacer())}`;\n        } else {\n            message = extractLogSafeErrorProperties(error, true).message;\n        }\n\n        const errorObj = createGenericNetworkError(\n            `socket.io (${handler}): ${message}`,\n            { canRetry },\n            { driverVersion },\n        );\n\n        return errorObj;\n    }\n}\n"]}

package/lib/index.d.ts

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./documentDeltaConnection";
+export { DocumentDeltaConnection } from "./documentDeltaConnection";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC"}

package/lib/index.js

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./documentDeltaConnection";
+export { DocumentDeltaConnection } from "./documentDeltaConnection";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./documentDeltaConnection\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DocumentDeltaConnection } from \"./documentDeltaConnection\";\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/driver-base";
-export declare const pkgVersion = "2.0.0-dev.1.4.6.106135";
+export declare const pkgVersion = "2.0.0-dev.2.3.0.115467";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/driver-base";
-export const pkgVersion = "2.0.0-dev.1.4.6.106135";
+export const pkgVersion = "2.0.0-dev.2.3.0.115467";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-base\";\nexport const pkgVersion = \"2.0.0-dev.1.4.6.106135\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-base\";\nexport const pkgVersion = \"2.0.0-dev.2.3.0.115467\";\n"]}

package/lib/test/types/validateDriverBasePrevious.generated.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validateDriverBasePrevious.generated.d.ts.map

package/lib/test/types/validateDriverBasePrevious.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateDriverBasePrevious.generated.d.ts","sourceRoot":"","sources":["../../../src/test/types/validateDriverBasePrevious.generated.ts"],"names":[],"mappings":""}

package/lib/test/types/{validateDriverBasePrevious.js → validateDriverBasePrevious.generated.js}

@@ -1,4 +1,4 @@
 use_current_ClassDeclaration_DocumentDeltaConnection(get_old_ClassDeclaration_DocumentDeltaConnection());
 use_old_ClassDeclaration_DocumentDeltaConnection(get_current_ClassDeclaration_DocumentDeltaConnection());
 export {};
-//# sourceMappingURL=validateDriverBasePrevious.js.map
+//# sourceMappingURL=validateDriverBasePrevious.generated.js.map

package/lib/test/types/validateDriverBasePrevious.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateDriverBasePrevious.generated.js","sourceRoot":"","sources":["../../../src/test/types/validateDriverBasePrevious.generated.ts"],"names":[],"mappings":"AAwBA,oDAAoD,CAChD,gDAAgD,EAAE,CAAC,CAAC;AAWxD,gDAAgD,CAC5C,oDAAoD,EAAE,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/*\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.\n * Generated by fluid-type-validator in @fluidframework/build-tools.\n */\nimport * as old from \"@fluidframework/driver-base-previous\";\nimport * as current from \"../../index\";\n\ntype TypeOnly<T> = {\n    [P in keyof T]: TypeOnly<T[P]>;\n};\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DocumentDeltaConnection\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_DocumentDeltaConnection():\n    TypeOnly<old.DocumentDeltaConnection>;\ndeclare function use_current_ClassDeclaration_DocumentDeltaConnection(\n    use: TypeOnly<current.DocumentDeltaConnection>);\nuse_current_ClassDeclaration_DocumentDeltaConnection(\n    get_old_ClassDeclaration_DocumentDeltaConnection());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DocumentDeltaConnection\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_DocumentDeltaConnection():\n    TypeOnly<current.DocumentDeltaConnection>;\ndeclare function use_old_ClassDeclaration_DocumentDeltaConnection(\n    use: TypeOnly<old.DocumentDeltaConnection>);\nuse_old_ClassDeclaration_DocumentDeltaConnection(\n    get_current_ClassDeclaration_DocumentDeltaConnection());\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-base",
-  "version": "2.0.0-dev.1.4.6.106135",
+  "version": "2.0.0-dev.2.3.0.115467",
   "description": "Shared driver code for Fluid driver implementations",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -26,37 +26,41 @@
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
     "lint": "npm run eslint",
     "lint:fix": "npm run eslint:fix",
-    "tsc": "tsc",
-    "tsfmt": "tsfmt --verify",
-    "tsfmt:fix": "tsfmt --replace"
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "tsc": "tsc"
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/driver-definitions": "2.0.0-dev.1.4.6.106135",
-    "@fluidframework/driver-utils": "2.0.0-dev.1.4.6.106135",
-    "@fluidframework/protocol-definitions": "^1.0.0",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.1.4.6.106135"
+    "@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-definitions": "^1.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^1.0.0",
-    "@fluidframework/driver-base-previous": "npm:@fluidframework/driver-base@^1.1.0",
-    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluid-tools/build-cli": "^0.7.0",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/driver-base-previous": "npm:@fluidframework/driver-base@2.0.0-internal.2.2.0",
+    "@fluidframework/eslint-config-fluid": "^1.2.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/node": "^14.18.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.4.1",
     "eslint": "~8.6.0",
+    "prettier": "~2.6.2",
     "rimraf": "^2.6.2",
     "socket.io-client": "^4.4.1",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.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/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+    ...require("@fluidframework/build-common/prettier.config.cjs"),
+};