@fluidframework/shared-object-base 0.54.0-47413 → 0.55.0-48551

package/lib/sharedObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGtE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACxB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAe,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAI7F,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE7D;;GAEG;AACH,8BAAsB,YAAY,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvF,SAAQ,6BAA6B,CAAC,MAAM,CAAE,YAAW,aAAa,CAAC,MAAM,CAAC;IAgFnE,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IAjFlD;;;OAGG;WACW,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,YAAY;IAI/C,IAAW,aAAa,SAAmB;IAC3C,IAAW,QAAQ,SAAmB;IACtC,IAAW,cAAc,SAAmB;IAE5C;;OAEG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,cAAc,CAAkB;IAExC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAW3C;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C;;;;OAIG;gBAEQ,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IAuBlD;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAUjC,OAAO,CAAC,eAAe;IAWvB;;;;OAIG;IACU,IAAI,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D;;;OAGG;IACI,eAAe,IAAI,IAAI;IAI9B;;OAEG;IACI,aAAa,IAAI,IAAI;IAa5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;IACI,SAAS,CAAC,QAAQ,GAAE,OAAe,EAAE,UAAU,GAAE,OAAe,GAAG,qBAAqB;IAsB/F;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAiBjE;;;;OAIG;IACH,SAAS,CAAC,aAAa,IAAI,sBAAsB;IAiBjD;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,YAAY;IAOnD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,gBAAgB,GAAG,KAAK;IAEpE;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY;IAE/B;;;OAGG;IACH,SAAS,CAAC,SAAS;IAInB;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAE3G;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY;IAE/B;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,GAAE,OAAmB,GAAG,IAAI;IAQtF;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;IASvB;;;OAGG;IACH,SAAS,CAAC,SAAS;IAEnB;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAI7D;;;;;OAKG;cACa,kBAAkB,CAAC,CAAC,EAChC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,GACjG,OAAO,CAAC,CAAC,CAAC;IAmBb,OAAO,CAAC,kBAAkB;IA4B1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAOf;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;CAC3D"}
+{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGtE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAe,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAE7F,OAAO,EAAmB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE7D;;GAEG;AACH,8BAAsB,gBAAgB,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAC3F,SAAQ,6BAA6B,CAAC,MAAM,CAAE,YAAW,aAAa,CAAC,MAAM,CAAC;IAyDnE,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IA1DlD;;;OAGG;WACW,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,gBAAgB;IAInD,IAAW,aAAa,SAAmB;IAC3C,IAAW,QAAQ,SAAmB;IACtC,IAAW,cAAc,SAAmB;IAE5C;;OAEG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;gBAEQ,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IAkBlD;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAUjC,OAAO,CAAC,eAAe;IAWvB;;;;OAIG;IACU,IAAI,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D;;;OAGG;IACI,eAAe,IAAI,IAAI;IAI9B;;OAEG;IACI,aAAa,IAAI,IAAI;IAa5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,qBAAqB;IAEjG;;OAEG;aACa,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAEnG;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,YAAY;IAOnD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY;IAE/B;;;OAGG;IACH,SAAS,CAAC,SAAS;IAInB;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAE3G;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY;IAE/B;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,GAAE,OAAmB,GAAG,IAAI;IAQtF;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;IASvB;;;OAGG;IACH,SAAS,CAAC,SAAS;IAEnB;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAI7D;;;;;OAKG;cACa,kBAAkB,CAAC,CAAC,EAChC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,GACjG,OAAO,CAAC,CAAC,CAAC;IAmBb,OAAO,CAAC,kBAAkB;IA4B1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAOf;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;CAC3D;AAED;;GAEG;AACH,8BAAsB,YAAY,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvF,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAW3C;IAED;;;;OAIG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAUlC;;OAEG;IACI,gBAAgB,CAAC,QAAQ,GAAE,OAAe,EAAE,UAAU,GAAE,OAAe,GAAG,qBAAqB;IAItG;;OAEG;IACU,SAAS,CAAC,QAAQ,GAAE,OAAe,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI9G;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAwBjE;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,iBAAiB;IAOzD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,EAAE,QAAQ,EAAE,OAAO,GAAG,qBAAqB;CAC3G"}

package/lib/sharedObject.js

@@ -5,15 +5,15 @@
 import { v4 as uuid } from "uuid";
 import { assert } from "@fluidframework/common-utils";
 import { AttachState } from "@fluidframework/container-definitions";
-import { convertToSummaryTreeWithStats, FluidSerializer } from "@fluidframework/runtime-utils";
 import { ChildLogger, EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
 import { DataProcessingError } from "@fluidframework/container-utils";
+import { FluidSerializer } from "./serializer";
 import { SharedObjectHandle } from "./handle";
 import { SummarySerializer } from "./summarySerializer";
 /**
  *  Base class from which all shared objects derive
  */
-export class SharedObject extends EventEmitterWithErrorHandling {
+export class SharedObjectCore extends EventEmitterWithErrorHandling {
     /**
      * @param id - The id of the shared object
      * @param runtime - The IFluidDataStoreRuntime which contains the shared object
@@ -32,13 +32,8 @@ export class SharedObject extends EventEmitterWithErrorHandling {
          * True if the dds is bound to its parent.
          */
         this._isBoundToContext = false;
-        /**
-         * True while we are summarizing this object's data.
-         */
-        this._isSummarizing = false;
         this.handle = new SharedObjectHandle(this, id, runtime.IFluidHandleContext);
         this.logger = ChildLogger.create(runtime.logger, undefined, { all: { sharedObjectId: uuid() } });
-        this._serializer = new FluidSerializer(this.runtime.channelsRoutingContext, (handle) => this.handleDecoded(handle));
         this.attachListeners();
     }
     /**
@@ -58,17 +53,6 @@ export class SharedObject extends EventEmitterWithErrorHandling {
     get connected() {
         return this._connected;
     }
-    get serializer() {
-        /**
-         * During summarize, the SummarySerializer keeps track of IFluidHandles that are serialized. These handles
-         * represent references to other Fluid objects and are used for garbage collection.
-         *
-         * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content
-         * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.
-         */
-        assert(!this._isSummarizing, 0x075 /* "SummarySerializer should be used for serializing data during summary." */);
-        return this._serializer;
-    }
     /**
      * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)
      * would result in same error thrown. If called multiple times, only first error is remembered.
@@ -159,62 +143,6 @@ export class SharedObject extends EventEmitterWithErrorHandling {
     isAttached() {
         return this.services !== undefined && this.runtime.attachState !== AttachState.Detached;
     }
-    /**
-     * {@inheritDoc (ISharedObject:interface).summarize}
-     */
-    summarize(fullTree = false, trackState = false) {
-        // Set _isSummarizing to true. This flag is used to ensure that we only use SummarySerializer (created below)
-        // to serialize handles in this object's data. The routes of these serialized handles are outbound routes
-        // to other Fluid objects.
-        assert(!this._isSummarizing, 0x076 /* "Possible re-entrancy! Summary should not already be in progress." */);
-        this._isSummarizing = true;
-        let summaryTree;
-        try {
-            const serializer = new SummarySerializer(this.runtime.channelsRoutingContext, (handle) => this.handleDecoded(handle));
-            const snapshot = this.snapshotCore(serializer);
-            summaryTree = convertToSummaryTreeWithStats(snapshot, fullTree);
-            assert(this._isSummarizing, 0x077 /* "Possible re-entrancy! Summary should have been in progress." */);
-        }
-        finally {
-            this._isSummarizing = false;
-        }
-        return summaryTree;
-    }
-    /**
-     * {@inheritDoc (ISharedObject:interface).getGCData}
-     */
-    getGCData(fullGC = false) {
-        // Set _isSummarizing to true. This flag is used to ensure that we only use SummarySerializer (created in
-        // getGCDataCore) to serialize handles in this object's data.
-        assert(!this._isSummarizing, 0x078 /* "Possible re-entrancy! Summary should not already be in progress." */);
-        this._isSummarizing = true;
-        let gcData;
-        try {
-            gcData = this.getGCDataCore();
-            assert(this._isSummarizing, 0x079 /* "Possible re-entrancy! Summary should have been in progress." */);
-        }
-        finally {
-            this._isSummarizing = false;
-        }
-        return gcData;
-    }
-    /**
-     * Returns the GC data for this shared object. It contains a list of GC nodes that contains references to
-     * other GC nodes.
-     * Derived classes must override this to provide custom list of references to other GC nodes.
-     */
-    getGCDataCore() {
-        // We run the full summarize logic to get the list of outbound routes from this object. This is a little
-        // expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.
-        // See: https://github.com/microsoft/FluidFramework/issues/4547
-        const serializer = new SummarySerializer(this.runtime.channelsRoutingContext, (handle) => this.handleDecoded(handle));
-        this.snapshotCore(serializer);
-        // The GC data for this shared object contains a single GC node. The outbound routes of this node are the
-        // routes of handles serialized during snapshot.
-        return {
-            gcNodes: { "/": serializer.getSerializedRoutes() },
-        };
-    }
     /**
      * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference
      * to another object in the container.
@@ -376,4 +304,77 @@ export class SharedObject extends EventEmitterWithErrorHandling {
         this.reSubmitCore(content, localOpMetadata);
     }
 }
+/**
+ * SharedObject with simplified, synchronous summarization and GC
+ */
+export class SharedObject extends SharedObjectCore {
+    /**
+     * @param id - The id of the shared object
+     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
+     * @param attributes - Attributes of the shared object
+     */
+    constructor(id, runtime, attributes) {
+        super(id, runtime, attributes);
+        /**
+         * True while we are garbage collecting this object's data.
+         */
+        this._isGCing = false;
+        this._serializer = new FluidSerializer(this.runtime.channelsRoutingContext, (handle) => this.handleDecoded(handle));
+    }
+    get serializer() {
+        /**
+         * During garbage collection, the SummarySerializer keeps track of IFluidHandles that are serialized. These
+         * handles represent references to other Fluid objects.
+         *
+         * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content
+         * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.
+         */
+        assert(!this._isGCing, 0x075 /* "SummarySerializer should be used for serializing data during summary." */);
+        return this._serializer;
+    }
+    /**
+     * {@inheritDoc (ISharedObject:interface).getAttachSummary}
+     */
+    getAttachSummary(fullTree = false, trackState = false) {
+        return this.summarizeCore(this.serializer, fullTree);
+    }
+    /**
+     * {@inheritDoc (ISharedObject:interface).summarize}
+     */
+    async summarize(fullTree = false, trackState = false) {
+        return this.summarizeCore(this.serializer, fullTree);
+    }
+    /**
+     * {@inheritDoc (ISharedObject:interface).getGCData}
+     */
+    getGCData(fullGC = false) {
+        // Set _isGCing to true. This flag is used to ensure that we only use SummarySerializer to serialize handles
+        // in this object's data.
+        assert(!this._isGCing, 0x078 /* "Possible re-entrancy! Summary should not already be in progress." */);
+        this._isGCing = true;
+        let gcData;
+        try {
+            const serializer = new SummarySerializer(this.runtime.channelsRoutingContext, (handle) => this.handleDecoded(handle));
+            this.processGCDataCore(serializer);
+            // The GC data for this shared object contains a single GC node. The outbound routes of this node are the
+            // routes of handles serialized during summarization.
+            gcData = { gcNodes: { "/": serializer.getSerializedRoutes() } };
+            assert(this._isGCing, 0x079 /* "Possible re-entrancy! Summary should have been in progress." */);
+        }
+        finally {
+            this._isGCing = false;
+        }
+        return gcData;
+    }
+    /**
+     * Calls the serializer over all data in this object that reference other GC nodes.
+     * Derived classes must override this to provide custom list of references to other GC nodes.
+     */
+    processGCDataCore(serializer) {
+        // We run the full summarize logic to get the list of outbound routes from this object. This is a little
+        // expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.
+        // See: https://github.com/microsoft/FluidFramework/issues/4547
+        this.summarizeCore(serializer, false);
+    }
+}
 //# sourceMappingURL=sharedObject.js.map

package/lib/sharedObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedObject.js","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,MAAM,EAAyB,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAapE,OAAO,EAAE,6BAA6B,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,OAAgB,YAClB,SAAQ,6BAAqC;IA0E7C;;;;OAIG;IACH,YACW,EAAU,EACP,OAA+B,EACzB,UAA8B;QAE9C,KAAK,CAAC,CAAC,KAA4B,EAAE,CAAM,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAJnF,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QA3DlD;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QAE3C;;WAEG;QACK,mBAAc,GAAY,KAAK,CAAC;QA6CpC,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAChC,IAAI,EACJ,EAAE,EACF,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEjC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAC5B,OAAO,CAAC,MAAM,EACd,SAAS,EACT,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAI,eAAe,CAClC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;QAEF,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAtGD;;;OAGG;IACI,MAAM,CAAC,EAAE,CAAC,GAAQ;QACrB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,aAAa,MAAK,SAAS,CAAC;IAC5C,CAAC;IAED,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC3C,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IACtC,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAqC5C;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,IAAc,UAAU;QACpB;;;;;;WAMG;QACH,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,EACvB,KAAK,CAAC,6EAA6E,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAsCD;;;;OAIG;IACK,cAAc,CAAC,KAAU;QAC7B,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;SAC3B;IACL,CAAC;IAED;;OAEG;IACK,eAAe;QACnB,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YAC/B,MAAM,IAAI,CAAC,UAAU,CAAC;SACzB;IACL,CAAC;IAED;;;;;;;;;OASG;IACK,yBAAyB,CAAC,KAA4B,EAAE,CAAM;QAClE,MAAM,KAAK,GAAG,mBAAmB,CAAC,kBAAkB,CAChD,CAAC,EACD,oCAAoC,CAAC,CAAC;QAC1C,KAAK,CAAC,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAElE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,KAAK,CAAC;IAChB,CAAC;IAEO,eAAe;QACnB,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;gBAChC,8EAA8E;gBAC9E,gCAAgC;gBAChC,IAAI,CAAC,SAAS,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;SACN;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,QAA0B;QACxC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC7B;IACL,CAAC;IAED;;;OAGG;IACI,eAAe;QAClB,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,aAAa;QAChB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACxB,OAAO;SACV;QAED,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAE9B,sFAAsF;QACtF,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAA0B;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU;QACb,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QACnE,6GAA6G;QAC7G,yGAAyG;QACzG,0BAA0B;QAC1B,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,wEAAwE,CAAC,CAAC;QAC7G,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAE3B,IAAI,WAAkC,CAAC;QACvC,IAAI;YACA,MAAM,UAAU,GAAG,IAAI,iBAAiB,CACpC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;YACF,MAAM,QAAQ,GAAU,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACtD,WAAW,GAAG,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAChE,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,mEAAmE,CAAC,CAAC;SAC1G;gBAAS;YACN,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;SAC/B;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,yGAAyG;QACzG,6DAA6D;QAC7D,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,wEAAwE,CAAC,CAAC;QAC7G,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAE3B,IAAI,MAA8B,CAAC;QACnC,IAAI;YACA,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,mEAAmE,CAAC,CAAC;SAC1G;gBAAS;YACN,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;SAC/B;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACO,aAAa;QACnB,wGAAwG;QACxG,2GAA2G;QAC3G,+DAA+D;QAC/D,MAAM,UAAU,GAAG,IAAI,iBAAiB,CACpC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAE9B,yGAAyG;QACzG,gDAAgD;QAChD,OAAO;YACH,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,mBAAmB,EAAE,EAAE;SACrD,CAAC;IACN,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,aAA2B;;QAC/C,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACnB,mGAAmG;YACnG,YAAA,IAAI,CAAC,QAAQ,gDAAE,eAAe,EAAC,wBAAwB,mDAAG,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE;SACzF;IACL,CAAC;IAcD;;OAEG;IACO,mBAAmB;QACzB,OAAO;IACX,CAAC;IAOD;;;OAGG;IACO,SAAS;QACf,OAAO;IACX,CAAC;IAgBD;;;;;;OAMG;IACO,kBAAkB,CAAC,OAAY,EAAE,kBAA2B,SAAS;QAC3E,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACnB,oEAAoE;YACpE,IAAI,CAAC,QAAS,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;SACnE;IACL,CAAC;IAED;;;OAGG;IACO,KAAK;QACX,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,OAAO;SACV;QAED,oEAAoE;QACpE,IAAI,CAAC,QAAS,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACO,SAAS,KAAK,CAAC;IAEzB;;;;;;;OAOG;IACO,YAAY,CAAC,OAAY,EAAE,eAAwB;QACzD,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,kBAAkB,CAC9B,QAAgG;QAEhG,IAAI,oBAAgC,CAAC;QACrC,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtC,oBAAoB;gBAChB,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC,CAAC;YAEvG,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACvB,oBAAoB,EAAE,CAAC;gBACvB,OAAO;aACV;YAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;YACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YACZ,0DAA0D;YAC1D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,kBAAkB;QACtB,2EAA2E;QAC3E,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACpG,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,gEAAgE;QAChE,IAAI,CAAC,SAAS,EAAE,CAAC;QAEjB,+DAA+D;QAC/D,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC;YACjC,OAAO,EAAE,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB,EAAE,EAAE;gBACtF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;YAClD,CAAC;YACD,kBAAkB,EAAE,CAAC,SAAkB,EAAE,EAAE;gBACvC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,eAAwB,EAAE,EAAE;gBACjD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAC5C,CAAC;YACD,cAAc,EAAE,CAAC,OAAY,EAAW,EAAE;gBACtC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACxC,CAAC;SACJ,CAAC,CAAC;QAEH,wBAAwB;QACxB,+DAA+D;QAC/D,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC;IAED;;;OAGG;IACK,kBAAkB,CAAC,SAAkB;QACzC,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YAC/B,wCAAwC;YACxC,OAAO;SACV;QAED,8FAA8F;QAC9F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,CAAC,SAAS,EAAE;YACZ,8BAA8B;YAC9B,kEAAkE;YAClE,4FAA4F;YAC5F,EAAE;YACF,oEAAoE;YACpE,IAAI,CAAC,YAAY,EAAE,CAAC;SACvB;aAAM;YACH,kGAAkG;YAClG,sBAAsB;YACtB,IAAI,CAAC,SAAS,EAAE,CAAC;SACpB;IACL,CAAC;IAED;;;;;;OAMG;IACK,OAAO,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QACxF,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,yCAAyC;QACjE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACK,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACnD,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAChD,CAAC;CAGJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, EventEmitterEventType } from \"@fluidframework/common-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IFluidHandle, IFluidSerializer } from \"@fluidframework/core-interfaces\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage, ITree } from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    ISummaryTreeWithStats,\n} from \"@fluidframework/runtime-definitions\";\nimport { convertToSummaryTreeWithStats, FluidSerializer } from \"@fluidframework/runtime-utils\";\nimport { ChildLogger, EventEmitterWithErrorHandling } from \"@fluidframework/telemetry-utils\";\nimport { DataProcessingError } from \"@fluidframework/container-utils\";\nimport { SharedObjectHandle } from \"./handle\";\nimport { SummarySerializer } from \"./summarySerializer\";\nimport { ISharedObject, ISharedObjectEvents } from \"./types\";\n\n/**\n *  Base class from which all shared objects derive\n */\nexport abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {\n    /**\n     * @param obj - The thing to check if it is a SharedObject\n     * @returns Returns true if the thing is a SharedObject\n     */\n    public static is(obj: any): obj is SharedObject {\n        return obj?.ISharedObject !== undefined;\n    }\n\n    public get ISharedObject() { return this; }\n    public get IChannel() { return this; }\n    public get IFluidLoadable() { return this; }\n\n    /**\n     * The handle referring to this SharedObject\n     */\n    public readonly handle: IFluidHandle;\n\n    /**\n     * Telemetry logger for the shared object\n     */\n    protected readonly logger: ITelemetryLogger;\n\n    /**\n     * Connection state\n     */\n    private _connected = false;\n\n    /**\n     * Services used by the shared object\n     */\n    private services: IChannelServices | undefined;\n\n    /**\n     * True if the dds is bound to its parent.\n     */\n    private _isBoundToContext: boolean = false;\n\n    /**\n     * True while we are summarizing this object's data.\n     */\n    private _isSummarizing: boolean = false;\n\n    /**\n     * Tracks error that closed this object.\n     */\n    private closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;\n\n    /**\n     * Gets the connection state\n     * @returns The state of the connection\n     */\n    public get connected(): boolean {\n        return this._connected;\n    }\n\n    protected get serializer(): IFluidSerializer {\n        /**\n         * During summarize, the SummarySerializer keeps track of IFluidHandles that are serialized. These handles\n         * represent references to other Fluid objects and are used for garbage collection.\n         *\n         * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content\n         * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.\n         */\n        assert(!this._isSummarizing,\n            0x075 /* \"SummarySerializer should be used for serializing data during summary.\" */);\n        return this._serializer;\n    }\n\n    /**\n     * The serializer to use to serialize / parse handles, if any.\n     */\n    private readonly _serializer: IFluidSerializer;\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        public id: string,\n        protected runtime: IFluidDataStoreRuntime,\n        public readonly attributes: IChannelAttributes)\n    {\n        super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));\n\n        this.handle = new SharedObjectHandle(\n            this,\n            id,\n            runtime.IFluidHandleContext);\n\n        this.logger = ChildLogger.create(\n            runtime.logger,\n            undefined,\n            { all: { sharedObjectId: uuid() } },\n        );\n\n        this._serializer = new FluidSerializer(\n            this.runtime.channelsRoutingContext,\n            (handle: IFluidHandle) => this.handleDecoded(handle),\n        );\n\n        this.attachListeners();\n    }\n\n    /**\n     * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)\n     * would result in same error thrown. If called multiple times, only first error is remembered.\n     * @param error - error object that is thrown whenever an attempt is made to modify this object\n     */\n    private closeWithError(error: any) {\n        if (this.closeError === undefined) {\n            this.closeError = error;\n        }\n    }\n\n    /**\n     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.\n     */\n    private verifyNotClosed() {\n        if (this.closeError !== undefined) {\n            throw this.closeError;\n        }\n    }\n\n    /**\n     * Event listener handler helper that can be used to react to exceptions thrown from event listeners\n     * It wraps error with DataProcessingError, closes this object and throws resulting error.\n     * See closeWithError() for more details\n     * Ideally such situation never happens, as consumers of DDS should never throw exceptions\n     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).\n     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.\n     * DDS state does not match what user sees. Because of it DDS moves to \"corrupted state\" and does not\n     * allow processing of ops or local changes, which very quickly results in container closure.\n     */\n    private eventListenerErrorHandler(event: EventEmitterEventType, e: any) {\n        const error = DataProcessingError.wrapIfUnrecognized(\n            e,\n            \"SharedObjectEventListenerException\");\n        error.addTelemetryProperties({ emittedEventName: String(event) });\n\n        this.closeWithError(error);\n        throw error;\n    }\n\n    private attachListeners() {\n        // Only listen to these events if not attached.\n        if (!this.isAttached()) {\n            this.runtime.once(\"attaching\", () => {\n                // Calling this will let the dds to do any custom processing based on attached\n                // like starting generating ops.\n                this.didAttach();\n            });\n        }\n    }\n\n    /**\n     * A shared object, after construction, can either be loaded in the case that it is already part of\n     * a shared document. Or later attached if it is being newly added.\n     * @param services - Services used by the shared object\n     */\n    public async load(services: IChannelServices): Promise<void> {\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.services = services;\n        }\n        await this.loadCore(services.objectStorage);\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.attachDeltaHandler();\n        }\n    }\n\n    /**\n     * Initializes the object as a local, non-shared object. This object can become shared after\n     * it is attached to the document.\n     */\n    public initializeLocal(): void {\n        this.initializeLocalCore();\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).bindToContext}\n     */\n    public bindToContext(): void {\n        if (this._isBoundToContext) {\n            return;\n        }\n\n        this._isBoundToContext = true;\n\n        // Allow derived classes to perform custom processing prior to registering this object\n        this.registerCore();\n\n        this.runtime.bindChannel(this);\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).connect}\n     */\n    public connect(services: IChannelServices) {\n        this.services = services;\n        this.attachDeltaHandler();\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).isAttached}\n     */\n    public isAttached(): boolean {\n        return this.services !== undefined && this.runtime.attachState !== AttachState.Detached;\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).summarize}\n     */\n    public summarize(fullTree: boolean = false, trackState: boolean = false): ISummaryTreeWithStats {\n        // Set _isSummarizing to true. This flag is used to ensure that we only use SummarySerializer (created below)\n        // to serialize handles in this object's data. The routes of these serialized handles are outbound routes\n        // to other Fluid objects.\n        assert(!this._isSummarizing, 0x076 /* \"Possible re-entrancy! Summary should not already be in progress.\" */);\n        this._isSummarizing = true;\n\n        let summaryTree: ISummaryTreeWithStats;\n        try {\n            const serializer = new SummarySerializer(\n                this.runtime.channelsRoutingContext,\n                (handle: IFluidHandle) => this.handleDecoded(handle),\n            );\n            const snapshot: ITree = this.snapshotCore(serializer);\n            summaryTree = convertToSummaryTreeWithStats(snapshot, fullTree);\n            assert(this._isSummarizing, 0x077 /* \"Possible re-entrancy! Summary should have been in progress.\" */);\n        } finally {\n            this._isSummarizing = false;\n        }\n        return summaryTree;\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        // Set _isSummarizing to true. This flag is used to ensure that we only use SummarySerializer (created in\n        // getGCDataCore) to serialize handles in this object's data.\n        assert(!this._isSummarizing, 0x078 /* \"Possible re-entrancy! Summary should not already be in progress.\" */);\n        this._isSummarizing = true;\n\n        let gcData: IGarbageCollectionData;\n        try {\n            gcData = this.getGCDataCore();\n            assert(this._isSummarizing, 0x079 /* \"Possible re-entrancy! Summary should have been in progress.\" */);\n        } finally {\n            this._isSummarizing = false;\n        }\n\n        return gcData;\n    }\n\n    /**\n     * Returns the GC data for this shared object. It contains a list of GC nodes that contains references to\n     * other GC nodes.\n     * Derived classes must override this to provide custom list of references to other GC nodes.\n     */\n    protected getGCDataCore(): IGarbageCollectionData {\n        // We run the full summarize logic to get the list of outbound routes from this object. This is a little\n        // expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.\n        // See: https://github.com/microsoft/FluidFramework/issues/4547\n        const serializer = new SummarySerializer(\n            this.runtime.channelsRoutingContext,\n            (handle: IFluidHandle) => this.handleDecoded(handle),\n        );\n        this.snapshotCore(serializer);\n\n        // The GC data for this shared object contains a single GC node. The outbound routes of this node are the\n        // routes of handles serialized during snapshot.\n        return {\n            gcNodes: { \"/\": serializer.getSerializedRoutes() },\n        };\n    }\n\n    /**\n     * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference\n     * to another object in the container.\n     * @param decodedHandle - The handle of the Fluid object that is decoded.\n     */\n    protected handleDecoded(decodedHandle: IFluidHandle) {\n        if (this.isAttached()) {\n            // This represents an outbound reference from this object to the node represented by decodedHandle.\n            this.services?.deltaConnection.addedGCOutboundReference?.(this.handle, decodedHandle);\n        }\n    }\n\n    /**\n     * Gets a form of the object that can be serialized.\n     * @returns A tree representing the snapshot of the shared object.\n     */\n    protected abstract snapshotCore(serializer: IFluidSerializer): ITree;\n\n    /**\n     * Allows the distributed data type to perform custom loading\n     * @param services - Storage used by the shared object\n     */\n    protected abstract loadCore(services: IChannelStorageService): Promise<void>;\n\n    /**\n     * Allows the distributed data type to perform custom local loading.\n     */\n    protected initializeLocalCore() {\n        return;\n    }\n\n    /**\n     * Allows the distributed data type the ability to perform custom processing once an attach has happened.\n     */\n    protected abstract registerCore();\n\n    /**\n     * Allows the distributive data type the ability to perform custom processing once an attach has happened.\n     * Also called after non-local data type get loaded.\n     */\n    protected didAttach() {\n        return;\n    }\n\n    /**\n     * Derived classes must override this to do custom processing on a remote message.\n     * @param message - The message to process\n     * @param local - True if the shared object is local\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    protected abstract processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown);\n\n    /**\n     * Called when the object has disconnected from the delta stream.\n     */\n    protected abstract onDisconnect();\n\n    /**\n     * Submits a message by the local client to the runtime.\n     * @param content - Content of the message\n     * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime\n     * and not sent to the server. This will be sent back when this message is received back from the server. This is\n     * also sent if we are asked to resubmit the message.\n     */\n    protected submitLocalMessage(content: any, localOpMetadata: unknown = undefined): void {\n        this.verifyNotClosed();\n        if (this.isAttached()) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            this.services!.deltaConnection.submit(content, localOpMetadata);\n        }\n    }\n\n    /**\n     * Marks this object as dirty so that it is part of the next summary. It is called by a SharedSummaryBlock\n     * that want to be part of summary but does not generate ops.\n     */\n    protected dirty(): void {\n        if (!this.isAttached()) {\n            return;\n        }\n\n        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n        this.services!.deltaConnection.dirty();\n    }\n\n    /**\n     * Called when the object has fully connected to the delta stream\n     * Default implementation for DDS, override if different behavior is required.\n     */\n    protected onConnect() { }\n\n    /**\n     * Called when a message has to be resubmitted. This typically happens after a reconnection for unacked messages.\n     * The default implementation here is to resubmit the same message. The client can override if different behavior\n     * is required. It can choose to resubmit the same message, submit different / multiple messages or not submit\n     * anything at all.\n     * @param content - The content of the original message.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    protected reSubmitCore(content: any, localOpMetadata: unknown) {\n        this.submitLocalMessage(content, localOpMetadata);\n    }\n\n    /**\n     * Promises that are waiting for an ack from the server before resolving should use this instead of new Promise.\n     * It ensures that if something changes that will interrupt that ack (e.g. the FluidDataStoreRuntime disposes),\n     * the Promise will reject.\n     * If runtime is disposed when this call is made, executor is not run and promise is rejected right away.\n     */\n    protected async newAckBasedPromise<T>(\n        executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void,\n    ): Promise<T> {\n        let rejectBecauseDispose: () => void;\n        return new Promise<T>((resolve, reject) => {\n            rejectBecauseDispose =\n                () => reject(new Error(\"FluidDataStoreRuntime disposed while this ack-based Promise was pending\"));\n\n            if (this.runtime.disposed) {\n                rejectBecauseDispose();\n                return;\n            }\n\n            this.runtime.on(\"dispose\", rejectBecauseDispose);\n            executor(resolve, reject);\n        }).finally(() => {\n            // Note: rejectBecauseDispose will never be undefined here\n            this.runtime.off(\"dispose\", rejectBecauseDispose);\n        });\n    }\n\n    private attachDeltaHandler() {\n        // Services should already be there in case we are attaching delta handler.\n        assert(this.services !== undefined, 0x07a /* \"Services should be there to attach delta handler\" */);\n        this._isBoundToContext = true;\n        // Allows objects to do any custom processing if it is attached.\n        this.didAttach();\n\n        // attachDeltaHandler is only called after services is assigned\n        this.services.deltaConnection.attach({\n            process: (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => {\n                this.process(message, local, localOpMetadata);\n            },\n            setConnectionState: (connected: boolean) => {\n                this.setConnectionState(connected);\n            },\n            reSubmit: (content: any, localOpMetadata: unknown) => {\n                this.reSubmit(content, localOpMetadata);\n            },\n            applyStashedOp: (content: any): unknown => {\n                return this.applyStashedOp(content);\n            },\n        });\n\n        // Trigger initial state\n        // attachDeltaHandler is only called after services is assigned\n        this.setConnectionState(this.services.deltaConnection.connected);\n    }\n\n    /**\n     * Set the state of connection to services.\n     * @param connected - true if connected, false otherwise.\n     */\n    private setConnectionState(connected: boolean) {\n        if (this._connected === connected) {\n            // Not changing state, nothing the same.\n            return;\n        }\n\n        // Should I change the state at the end? So that we *can't* send new stuff before we send old?\n        this._connected = connected;\n\n        if (!connected) {\n            // Things that are true now...\n            // - if we had a connection we can no longer send messages over it\n            // - if we had outbound messages some may or may not be ACK'd. Won't know until next message\n            //\n            // - nack could get a new msn - but might as well do it in the join?\n            this.onDisconnect();\n        } else {\n            // Call this for now so that DDSes like ConsensesOrderedCollection that maintain their own pending\n            // messages will work.\n            this.onConnect();\n        }\n    }\n\n    /**\n     * Handles a message being received from the remote delta server.\n     * @param message - The message to process\n     * @param local - Whether the message originated from the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    private process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        this.verifyNotClosed(); // This will result in container closure.\n        this.emit(\"pre-op\", message, local, this);\n        this.processCore(message, local, localOpMetadata);\n        this.emit(\"op\", message, local, this);\n    }\n\n    /**\n     * Called when a message has to be resubmitted. This typically happens for unacked messages after a\n     * reconnection.\n     * @param content - The content of the original message.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    private reSubmit(content: any, localOpMetadata: unknown) {\n        this.reSubmitCore(content, localOpMetadata);\n    }\n\n    protected abstract applyStashedOp(content: any): unknown;\n}\n"]}
+{"version":3,"file":"sharedObject.js","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,MAAM,EAAyB,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAapE,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAoB,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,OAAgB,gBAClB,SAAQ,6BAAqC;IAmD7C;;;;OAIG;IACH,YACW,EAAU,EACP,OAA+B,EACzB,UAA8B;QAE9C,KAAK,CAAC,CAAC,KAA4B,EAAE,CAAM,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAJnF,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QApClD;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QA2BvC,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAChC,IAAI,EACJ,EAAE,EACF,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEjC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAC5B,OAAO,CAAC,MAAM,EACd,SAAS,EACT,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IA1ED;;;OAGG;IACI,MAAM,CAAC,EAAE,CAAC,GAAQ;QACrB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,aAAa,MAAK,SAAS,CAAC;IAC5C,CAAC;IAED,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC3C,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IACtC,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAgC5C;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IA4BD;;;;OAIG;IACK,cAAc,CAAC,KAAU;QAC7B,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;SAC3B;IACL,CAAC;IAED;;OAEG;IACK,eAAe;QACnB,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YAC/B,MAAM,IAAI,CAAC,UAAU,CAAC;SACzB;IACL,CAAC;IAED;;;;;;;;;OASG;IACK,yBAAyB,CAAC,KAA4B,EAAE,CAAM;QAClE,MAAM,KAAK,GAAG,mBAAmB,CAAC,kBAAkB,CAChD,CAAC,EACD,oCAAoC,CAAC,CAAC;QAC1C,KAAK,CAAC,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAElE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,KAAK,CAAC;IAChB,CAAC;IAEO,eAAe;QACnB,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;gBAChC,8EAA8E;gBAC9E,gCAAgC;gBAChC,IAAI,CAAC,SAAS,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;SACN;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,QAA0B;QACxC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC7B;IACL,CAAC;IAED;;;OAGG;IACI,eAAe;QAClB,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,aAAa;QAChB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACxB,OAAO;SACV;QAED,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAE9B,sFAAsF;QACtF,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAA0B;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU;QACb,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;IAC5F,CAAC;IAiBD;;;;OAIG;IACO,aAAa,CAAC,aAA2B;;QAC/C,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACnB,mGAAmG;YACnG,YAAA,IAAI,CAAC,QAAQ,gDAAE,eAAe,EAAC,wBAAwB,mDAAG,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE;SACzF;IACL,CAAC;IAQD;;OAEG;IACO,mBAAmB;QACzB,OAAO;IACX,CAAC;IAOD;;;OAGG;IACO,SAAS;QACf,OAAO;IACX,CAAC;IAgBD;;;;;;OAMG;IACO,kBAAkB,CAAC,OAAY,EAAE,kBAA2B,SAAS;QAC3E,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACnB,oEAAoE;YACpE,IAAI,CAAC,QAAS,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;SACnE;IACL,CAAC;IAED;;;OAGG;IACO,KAAK;QACX,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,OAAO;SACV;QAED,oEAAoE;QACpE,IAAI,CAAC,QAAS,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACO,SAAS,KAAK,CAAC;IAEzB;;;;;;;OAOG;IACO,YAAY,CAAC,OAAY,EAAE,eAAwB;QACzD,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,kBAAkB,CAC9B,QAAgG;QAEhG,IAAI,oBAAgC,CAAC;QACrC,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtC,oBAAoB;gBAChB,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC,CAAC;YAEvG,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACvB,oBAAoB,EAAE,CAAC;gBACvB,OAAO;aACV;YAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;YACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YACZ,0DAA0D;YAC1D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,kBAAkB;QACtB,2EAA2E;QAC3E,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACpG,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,gEAAgE;QAChE,IAAI,CAAC,SAAS,EAAE,CAAC;QAEjB,+DAA+D;QAC/D,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC;YACjC,OAAO,EAAE,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB,EAAE,EAAE;gBACtF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;YAClD,CAAC;YACD,kBAAkB,EAAE,CAAC,SAAkB,EAAE,EAAE;gBACvC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,eAAwB,EAAE,EAAE;gBACjD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAC5C,CAAC;YACD,cAAc,EAAE,CAAC,OAAY,EAAW,EAAE;gBACtC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACxC,CAAC;SACJ,CAAC,CAAC;QAEH,wBAAwB;QACxB,+DAA+D;QAC/D,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC;IAED;;;OAGG;IACK,kBAAkB,CAAC,SAAkB;QACzC,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YAC/B,wCAAwC;YACxC,OAAO;SACV;QAED,8FAA8F;QAC9F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,CAAC,SAAS,EAAE;YACZ,8BAA8B;YAC9B,kEAAkE;YAClE,4FAA4F;YAC5F,EAAE;YACF,oEAAoE;YACpE,IAAI,CAAC,YAAY,EAAE,CAAC;SACvB;aAAM;YACH,kGAAkG;YAClG,sBAAsB;YACtB,IAAI,CAAC,SAAS,EAAE,CAAC;SACpB;IACL,CAAC;IAED;;;;;;OAMG;IACK,OAAO,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QACxF,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,yCAAyC;QACjE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACK,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACnD,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAChD,CAAC;CAGJ;AAED;;GAEG;AACH,MAAM,OAAgB,YAClB,SAAQ,gBAAwB;IAwBhC;;;;OAIG;IACF,YACG,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAjCnC;;WAEG;QACK,aAAQ,GAAY,KAAK,CAAC;QAgC9B,IAAI,CAAC,WAAW,GAAG,IAAI,eAAe,CAClC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;IACN,CAAC;IA7BD,IAAc,UAAU;QACpB;;;;;;WAMG;QACH,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EACjB,KAAK,CAAC,6EAA6E,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAoBD;;OAEG;IACI,gBAAgB,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QAC1E,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QACzE,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,4GAA4G;QAC5G,yBAAyB;QACzB,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,wEAAwE,CAAC,CAAC;QACvG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,MAA8B,CAAC;QACnC,IAAI;YACA,MAAM,UAAU,GAAG,IAAI,iBAAiB,CACpC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;YACF,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACnC,yGAAyG;YACzG,qDAAqD;YACrD,MAAM,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,mBAAmB,EAAE,EAAE,EAAE,CAAC;YAChE,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACpG;gBAAS;YACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACzB;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,UAA6B;QACrD,wGAAwG;QACxG,2GAA2G;QAC3G,+DAA+D;QAC/D,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;CAOJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, EventEmitterEventType } from \"@fluidframework/common-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    ISummaryTreeWithStats,\n} from \"@fluidframework/runtime-definitions\";\nimport { ChildLogger, EventEmitterWithErrorHandling } from \"@fluidframework/telemetry-utils\";\nimport { DataProcessingError } from \"@fluidframework/container-utils\";\nimport { FluidSerializer, IFluidSerializer } from \"./serializer\";\nimport { SharedObjectHandle } from \"./handle\";\nimport { SummarySerializer } from \"./summarySerializer\";\nimport { ISharedObject, ISharedObjectEvents } from \"./types\";\n\n/**\n *  Base class from which all shared objects derive\n */\nexport abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {\n    /**\n     * @param obj - The thing to check if it is a SharedObject\n     * @returns Returns true if the thing is a SharedObject\n     */\n    public static is(obj: any): obj is SharedObjectCore {\n        return obj?.ISharedObject !== undefined;\n    }\n\n    public get ISharedObject() { return this; }\n    public get IChannel() { return this; }\n    public get IFluidLoadable() { return this; }\n\n    /**\n     * The handle referring to this SharedObject\n     */\n    public readonly handle: IFluidHandle;\n\n    /**\n     * Telemetry logger for the shared object\n     */\n    protected readonly logger: ITelemetryLogger;\n\n    /**\n     * Connection state\n     */\n    private _connected = false;\n\n    /**\n     * Services used by the shared object\n     */\n    private services: IChannelServices | undefined;\n\n    /**\n     * True if the dds is bound to its parent.\n     */\n    private _isBoundToContext: boolean = false;\n\n    /**\n     * Tracks error that closed this object.\n     */\n    private closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;\n\n    /**\n     * Gets the connection state\n     * @returns The state of the connection\n     */\n    public get connected(): boolean {\n        return this._connected;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        public id: string,\n        protected runtime: IFluidDataStoreRuntime,\n        public readonly attributes: IChannelAttributes)\n    {\n        super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));\n\n        this.handle = new SharedObjectHandle(\n            this,\n            id,\n            runtime.IFluidHandleContext);\n\n        this.logger = ChildLogger.create(\n            runtime.logger,\n            undefined,\n            { all: { sharedObjectId: uuid() } },\n        );\n\n        this.attachListeners();\n    }\n\n    /**\n     * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)\n     * would result in same error thrown. If called multiple times, only first error is remembered.\n     * @param error - error object that is thrown whenever an attempt is made to modify this object\n     */\n    private closeWithError(error: any) {\n        if (this.closeError === undefined) {\n            this.closeError = error;\n        }\n    }\n\n    /**\n     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.\n     */\n    private verifyNotClosed() {\n        if (this.closeError !== undefined) {\n            throw this.closeError;\n        }\n    }\n\n    /**\n     * Event listener handler helper that can be used to react to exceptions thrown from event listeners\n     * It wraps error with DataProcessingError, closes this object and throws resulting error.\n     * See closeWithError() for more details\n     * Ideally such situation never happens, as consumers of DDS should never throw exceptions\n     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).\n     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.\n     * DDS state does not match what user sees. Because of it DDS moves to \"corrupted state\" and does not\n     * allow processing of ops or local changes, which very quickly results in container closure.\n     */\n    private eventListenerErrorHandler(event: EventEmitterEventType, e: any) {\n        const error = DataProcessingError.wrapIfUnrecognized(\n            e,\n            \"SharedObjectEventListenerException\");\n        error.addTelemetryProperties({ emittedEventName: String(event) });\n\n        this.closeWithError(error);\n        throw error;\n    }\n\n    private attachListeners() {\n        // Only listen to these events if not attached.\n        if (!this.isAttached()) {\n            this.runtime.once(\"attaching\", () => {\n                // Calling this will let the dds to do any custom processing based on attached\n                // like starting generating ops.\n                this.didAttach();\n            });\n        }\n    }\n\n    /**\n     * A shared object, after construction, can either be loaded in the case that it is already part of\n     * a shared document. Or later attached if it is being newly added.\n     * @param services - Services used by the shared object\n     */\n    public async load(services: IChannelServices): Promise<void> {\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.services = services;\n        }\n        await this.loadCore(services.objectStorage);\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.attachDeltaHandler();\n        }\n    }\n\n    /**\n     * Initializes the object as a local, non-shared object. This object can become shared after\n     * it is attached to the document.\n     */\n    public initializeLocal(): void {\n        this.initializeLocalCore();\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).bindToContext}\n     */\n    public bindToContext(): void {\n        if (this._isBoundToContext) {\n            return;\n        }\n\n        this._isBoundToContext = true;\n\n        // Allow derived classes to perform custom processing prior to registering this object\n        this.registerCore();\n\n        this.runtime.bindChannel(this);\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).connect}\n     */\n    public connect(services: IChannelServices) {\n        this.services = services;\n        this.attachDeltaHandler();\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).isAttached}\n     */\n    public isAttached(): boolean {\n        return this.services !== undefined && this.runtime.attachState !== AttachState.Detached;\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getAttachSummary}\n     */\n    public abstract getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).summarize}\n     */\n    public abstract summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public abstract getGCData(fullGC?: boolean): IGarbageCollectionData;\n\n    /**\n     * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference\n     * to another object in the container.\n     * @param decodedHandle - The handle of the Fluid object that is decoded.\n     */\n    protected handleDecoded(decodedHandle: IFluidHandle) {\n        if (this.isAttached()) {\n            // This represents an outbound reference from this object to the node represented by decodedHandle.\n            this.services?.deltaConnection.addedGCOutboundReference?.(this.handle, decodedHandle);\n        }\n    }\n\n    /**\n     * Allows the distributed data type to perform custom loading\n     * @param services - Storage used by the shared object\n     */\n    protected abstract loadCore(services: IChannelStorageService): Promise<void>;\n\n    /**\n     * Allows the distributed data type to perform custom local loading.\n     */\n    protected initializeLocalCore() {\n        return;\n    }\n\n    /**\n     * Allows the distributed data type the ability to perform custom processing once an attach has happened.\n     */\n    protected abstract registerCore();\n\n    /**\n     * Allows the distributive data type the ability to perform custom processing once an attach has happened.\n     * Also called after non-local data type get loaded.\n     */\n    protected didAttach() {\n        return;\n    }\n\n    /**\n     * Derived classes must override this to do custom processing on a remote message.\n     * @param message - The message to process\n     * @param local - True if the shared object is local\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    protected abstract processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown);\n\n    /**\n     * Called when the object has disconnected from the delta stream.\n     */\n    protected abstract onDisconnect();\n\n    /**\n     * Submits a message by the local client to the runtime.\n     * @param content - Content of the message\n     * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime\n     * and not sent to the server. This will be sent back when this message is received back from the server. This is\n     * also sent if we are asked to resubmit the message.\n     */\n    protected submitLocalMessage(content: any, localOpMetadata: unknown = undefined): void {\n        this.verifyNotClosed();\n        if (this.isAttached()) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            this.services!.deltaConnection.submit(content, localOpMetadata);\n        }\n    }\n\n    /**\n     * Marks this object as dirty so that it is part of the next summary. It is called by a SharedSummaryBlock\n     * that want to be part of summary but does not generate ops.\n     */\n    protected dirty(): void {\n        if (!this.isAttached()) {\n            return;\n        }\n\n        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n        this.services!.deltaConnection.dirty();\n    }\n\n    /**\n     * Called when the object has fully connected to the delta stream\n     * Default implementation for DDS, override if different behavior is required.\n     */\n    protected onConnect() { }\n\n    /**\n     * Called when a message has to be resubmitted. This typically happens after a reconnection for unacked messages.\n     * The default implementation here is to resubmit the same message. The client can override if different behavior\n     * is required. It can choose to resubmit the same message, submit different / multiple messages or not submit\n     * anything at all.\n     * @param content - The content of the original message.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    protected reSubmitCore(content: any, localOpMetadata: unknown) {\n        this.submitLocalMessage(content, localOpMetadata);\n    }\n\n    /**\n     * Promises that are waiting for an ack from the server before resolving should use this instead of new Promise.\n     * It ensures that if something changes that will interrupt that ack (e.g. the FluidDataStoreRuntime disposes),\n     * the Promise will reject.\n     * If runtime is disposed when this call is made, executor is not run and promise is rejected right away.\n     */\n    protected async newAckBasedPromise<T>(\n        executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void,\n    ): Promise<T> {\n        let rejectBecauseDispose: () => void;\n        return new Promise<T>((resolve, reject) => {\n            rejectBecauseDispose =\n                () => reject(new Error(\"FluidDataStoreRuntime disposed while this ack-based Promise was pending\"));\n\n            if (this.runtime.disposed) {\n                rejectBecauseDispose();\n                return;\n            }\n\n            this.runtime.on(\"dispose\", rejectBecauseDispose);\n            executor(resolve, reject);\n        }).finally(() => {\n            // Note: rejectBecauseDispose will never be undefined here\n            this.runtime.off(\"dispose\", rejectBecauseDispose);\n        });\n    }\n\n    private attachDeltaHandler() {\n        // Services should already be there in case we are attaching delta handler.\n        assert(this.services !== undefined, 0x07a /* \"Services should be there to attach delta handler\" */);\n        this._isBoundToContext = true;\n        // Allows objects to do any custom processing if it is attached.\n        this.didAttach();\n\n        // attachDeltaHandler is only called after services is assigned\n        this.services.deltaConnection.attach({\n            process: (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => {\n                this.process(message, local, localOpMetadata);\n            },\n            setConnectionState: (connected: boolean) => {\n                this.setConnectionState(connected);\n            },\n            reSubmit: (content: any, localOpMetadata: unknown) => {\n                this.reSubmit(content, localOpMetadata);\n            },\n            applyStashedOp: (content: any): unknown => {\n                return this.applyStashedOp(content);\n            },\n        });\n\n        // Trigger initial state\n        // attachDeltaHandler is only called after services is assigned\n        this.setConnectionState(this.services.deltaConnection.connected);\n    }\n\n    /**\n     * Set the state of connection to services.\n     * @param connected - true if connected, false otherwise.\n     */\n    private setConnectionState(connected: boolean) {\n        if (this._connected === connected) {\n            // Not changing state, nothing the same.\n            return;\n        }\n\n        // Should I change the state at the end? So that we *can't* send new stuff before we send old?\n        this._connected = connected;\n\n        if (!connected) {\n            // Things that are true now...\n            // - if we had a connection we can no longer send messages over it\n            // - if we had outbound messages some may or may not be ACK'd. Won't know until next message\n            //\n            // - nack could get a new msn - but might as well do it in the join?\n            this.onDisconnect();\n        } else {\n            // Call this for now so that DDSes like ConsensesOrderedCollection that maintain their own pending\n            // messages will work.\n            this.onConnect();\n        }\n    }\n\n    /**\n     * Handles a message being received from the remote delta server.\n     * @param message - The message to process\n     * @param local - Whether the message originated from the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    private process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        this.verifyNotClosed(); // This will result in container closure.\n        this.emit(\"pre-op\", message, local, this);\n        this.processCore(message, local, localOpMetadata);\n        this.emit(\"op\", message, local, this);\n    }\n\n    /**\n     * Called when a message has to be resubmitted. This typically happens for unacked messages after a\n     * reconnection.\n     * @param content - The content of the original message.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    private reSubmit(content: any, localOpMetadata: unknown) {\n        this.reSubmitCore(content, localOpMetadata);\n    }\n\n    protected abstract applyStashedOp(content: any): unknown;\n}\n\n/**\n * SharedObject with simplified, synchronous summarization and GC\n */\nexport abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends SharedObjectCore<TEvent> {\n    /**\n     * True while we are garbage collecting this object's data.\n     */\n    private _isGCing: boolean = false;\n\n    /**\n     * The serializer to use to serialize / parse handles, if any.\n     */\n    private readonly _serializer: IFluidSerializer;\n\n    protected get serializer(): IFluidSerializer {\n        /**\n         * During garbage collection, the SummarySerializer keeps track of IFluidHandles that are serialized. These\n         * handles represent references to other Fluid objects.\n         *\n         * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content\n         * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.\n         */\n        assert(!this._isGCing,\n            0x075 /* \"SummarySerializer should be used for serializing data during summary.\" */);\n        return this._serializer;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n     constructor(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes)\n    {\n        super(id, runtime, attributes);\n\n        this._serializer = new FluidSerializer(\n            this.runtime.channelsRoutingContext,\n            (handle: IFluidHandle) => this.handleDecoded(handle),\n        );\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getAttachSummary}\n     */\n    public getAttachSummary(fullTree: boolean = false, trackState: boolean = false): ISummaryTreeWithStats {\n        return this.summarizeCore(this.serializer, fullTree);\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).summarize}\n     */\n    public async summarize(fullTree: boolean = false, trackState: boolean = false): Promise<ISummaryTreeWithStats> {\n        return this.summarizeCore(this.serializer, fullTree);\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        // Set _isGCing to true. This flag is used to ensure that we only use SummarySerializer to serialize handles\n        // in this object's data.\n        assert(!this._isGCing, 0x078 /* \"Possible re-entrancy! Summary should not already be in progress.\" */);\n        this._isGCing = true;\n\n        let gcData: IGarbageCollectionData;\n        try {\n            const serializer = new SummarySerializer(\n                this.runtime.channelsRoutingContext,\n                (handle: IFluidHandle) => this.handleDecoded(handle),\n            );\n            this.processGCDataCore(serializer);\n            // The GC data for this shared object contains a single GC node. The outbound routes of this node are the\n            // routes of handles serialized during summarization.\n            gcData = { gcNodes: { \"/\": serializer.getSerializedRoutes() } };\n            assert(this._isGCing, 0x079 /* \"Possible re-entrancy! Summary should have been in progress.\" */);\n        } finally {\n            this._isGCing = false;\n        }\n\n        return gcData;\n    }\n\n    /**\n     * Calls the serializer over all data in this object that reference other GC nodes.\n     * Derived classes must override this to provide custom list of references to other GC nodes.\n     */\n    protected processGCDataCore(serializer: SummarySerializer) {\n        // We run the full summarize logic to get the list of outbound routes from this object. This is a little\n        // expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.\n        // See: https://github.com/microsoft/FluidFramework/issues/4547\n        this.summarizeCore(serializer, false);\n    }\n\n    /**\n     * Gets a form of the object that can be serialized.\n     * @returns A tree representing the snapshot of the shared object.\n     */\n    protected abstract summarizeCore(serializer: IFluidSerializer, fullTree: boolean): ISummaryTreeWithStats;\n}\n"]}

package/lib/summarySerializer.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { IFluidHandle } from "@fluidframework/core-interfaces";
-import { FluidSerializer } from "@fluidframework/runtime-utils";
+import { FluidSerializer } from "./serializer";
 /**
  * Serializer implementation for serializing handles during summary.
  */

package/lib/summarySerializer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summarySerializer.d.ts","sourceRoot":"","sources":["../src/summarySerializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IAClD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA0B;IACpD,mBAAmB,IAAI,MAAM,EAAE;IAItC,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY;;;;CAIrE"}
+{"version":3,"file":"summarySerializer.d.ts","sourceRoot":"","sources":["../src/summarySerializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IAClD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA0B;IACpD,mBAAmB,IAAI,MAAM,EAAE;IAItC,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY;;;;CAIrE"}

package/lib/summarySerializer.js

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { FluidSerializer } from "@fluidframework/runtime-utils";
+import { FluidSerializer } from "./serializer";
 /**
  * Serializer implementation for serializing handles during summary.
  */

package/lib/summarySerializer.js.map

@@ -1 +1 @@
-{"version":3,"file":"summarySerializer.js","sourceRoot":"","sources":["../src/summarySerializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IAAtD;;QACqB,qBAAgB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAS/D,CAAC;IARU,mBAAmB;QACtB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7C,CAAC;IAES,eAAe,CAAC,MAAoB,EAAE,IAAkB;QAC9D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { FluidSerializer } from \"@fluidframework/runtime-utils\";\n\n/**\n * Serializer implementation for serializing handles during summary.\n */\nexport class SummarySerializer extends FluidSerializer {\n    private readonly serializedRoutes: Set<string> = new Set();\n    public getSerializedRoutes(): string[] {\n        return Array.from(this.serializedRoutes);\n    }\n\n    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {\n        this.serializedRoutes.add(handle.absolutePath);\n        return super.serializeHandle(handle, bind);\n    }\n}\n"]}
+{"version":3,"file":"summarySerializer.js","sourceRoot":"","sources":["../src/summarySerializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IAAtD;;QACqB,qBAAgB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAS/D,CAAC;IARU,mBAAmB;QACtB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7C,CAAC;IAES,eAAe,CAAC,MAAoB,EAAE,IAAkB;QAC9D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { FluidSerializer } from \"./serializer\";\n\n/**\n * Serializer implementation for serializing handles during summary.\n */\nexport class SummarySerializer extends FluidSerializer {\n    private readonly serializedRoutes: Set<string> = new Set();\n    public getSerializedRoutes(): string[] {\n        return Array.from(this.serializedRoutes);\n    }\n\n    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {\n        this.serializedRoutes.add(handle.absolutePath);\n        return super.serializeHandle(handle, bind);\n    }\n}\n"]}

package/lib/types.d.ts

@@ -24,10 +24,16 @@ export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjec
      */
     isAttached(): boolean;
     /**
-     * Generates summary of the shared object.
+     * Generates summary of the channel synchronously.
      * @returns A tree representing the summary of the shared object.
      */
-    summarize(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;
+    getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;
+    /**
+     * Generates summary of the shared object asynchronously.
+     * This should not be called where the object can be modified while summarization is in progress.
+     * @returns A tree representing the summary of the channel.
+     */
+    summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;
     /**
      * Enables the channel to send and receive ops.
      * @param services - Services to connect to

package/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AACxG,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEpG,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACpD,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,EACnB,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CACzG;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACnF,SAAQ,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC;IACxC;;;OAGG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,qBAAqB,CAAC;IAE3E;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CACvD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AACxG,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEpG,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACpD,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,EACnB,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CACzG;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACnF,SAAQ,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC;IACxC;;;OAGG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC;IAEtB;;;OAGG;IACH,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,qBAAqB,CAAC;IAElF;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAEpF;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CACvD"}

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IErrorEvent, IEventProvider, IEventThisPlaceHolder } from \"@fluidframework/common-definitions\";\nimport { IChannel, IChannelServices } from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { IGarbageCollectionData, ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\n\nexport interface ISharedObjectEvents extends IErrorEvent {\n    (event: \"pre-op\" | \"op\",\n        listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void);\n}\n\n/**\n * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject\n */\nexport interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends IChannel, IEventProvider<TEvent> {\n    /**\n     * Binds the given shared object to its containing data store runtime, causing it to attach once\n     * the runtime attaches.\n     */\n    bindToContext(): void;\n\n    /**\n     * Returns whether the given shared object is attached to storage.\n     * @returns True if the given shared object is attached\n     */\n    isAttached(): boolean;\n\n    /**\n     * Generates summary of the shared object.\n     * @returns A tree representing the summary of the shared object.\n     */\n    summarize(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;\n\n    /**\n     * Enables the channel to send and receive ops.\n     * @param services - Services to connect to\n     */\n    connect(services: IChannelServices): void;\n\n    /**\n     * Returns the GC data for this shared object. It contains a list of GC nodes that contains references to\n     * other GC nodes.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    getGCData(fullGC?: boolean): IGarbageCollectionData;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IErrorEvent, IEventProvider, IEventThisPlaceHolder } from \"@fluidframework/common-definitions\";\nimport { IChannel, IChannelServices } from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { IGarbageCollectionData, ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\n\nexport interface ISharedObjectEvents extends IErrorEvent {\n    (event: \"pre-op\" | \"op\",\n        listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void);\n}\n\n/**\n * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject\n */\nexport interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends IChannel, IEventProvider<TEvent> {\n    /**\n     * Binds the given shared object to its containing data store runtime, causing it to attach once\n     * the runtime attaches.\n     */\n    bindToContext(): void;\n\n    /**\n     * Returns whether the given shared object is attached to storage.\n     * @returns True if the given shared object is attached\n     */\n    isAttached(): boolean;\n\n    /**\n     * Generates summary of the channel synchronously.\n     * @returns A tree representing the summary of the shared object.\n     */\n    getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;\n\n    /**\n     * Generates summary of the shared object asynchronously.\n     * This should not be called where the object can be modified while summarization is in progress.\n     * @returns A tree representing the summary of the channel.\n     */\n    summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * Enables the channel to send and receive ops.\n     * @param services - Services to connect to\n     */\n    connect(services: IChannelServices): void;\n\n    /**\n     * Returns the GC data for this shared object. It contains a list of GC nodes that contains references to\n     * other GC nodes.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    getGCData(fullGC?: boolean): IGarbageCollectionData;\n}\n"]}

package/lib/utils.d.ts

@@ -2,7 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IFluidHandle, IFluidSerializer } from "@fluidframework/core-interfaces";
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { IFluidSerializer } from "./serializer";
 /**
  * Given a mostly-plain object that may have handle objects embedded within, return a string representation of an object
  * where the handle objects have been replaced with a serializable form.
@@ -35,4 +37,11 @@ export declare function makeHandlesSerializable(value: any, serializer: IFluidSe
  * @returns The mostly-plain object with handle objects within
  */
 export declare function parseHandles(value: any, serializer: IFluidSerializer): any;
+/**
+ * Create a new summary containing one blob
+ * @param key - the key for the blob in the summary
+ * @param content - blob content
+ * @returns The summary containing the blob
+ */
+export declare function createSingleBlobSummary(key: string, content: string | Uint8Array): ISummaryTreeWithStats;
 //# sourceMappingURL=utils.d.ts.map

package/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,YAAY,EACZ,gBAAgB,EACnB,MAAM,iCAAiC,CAAC;AAEzC;;;;;;;;GAQG;AAEH,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,GAAG,EACV,UAAU,EAAE,gBAAgB,EAC5B,IAAI,EAAE,YAAY,GACnB,MAAM,GAAG,SAAS,CAOpB;AAED;;;;;;;;;;;GAWG;AAEH,wBAAgB,uBAAuB,CACnC,KAAK,EAAE,GAAG,EACV,UAAU,EAAE,gBAAgB,EAC5B,IAAI,EAAE,YAAY,OAMrB;AAED;;;;;;;GAOG;AAEH,wBAAgB,YAAY,CACxB,KAAK,EAAE,GAAG,EACV,UAAU,EAAE,gBAAgB,OAI/B"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,GAAG,EACV,UAAU,EAAE,gBAAgB,EAC5B,IAAI,EAAE,YAAY,GACnB,MAAM,GAAG,SAAS,CAOpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CACnC,KAAK,EAAE,GAAG,EACV,UAAU,EAAE,gBAAgB,EAC5B,IAAI,EAAE,YAAY,OAMrB;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CACxB,KAAK,EAAE,GAAG,EACV,UAAU,EAAE,gBAAgB,OAI/B;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,qBAAqB,CAIxG"}

package/lib/utils.js

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 /**
  * Given a mostly-plain object that may have handle objects embedded within, return a string representation of an object
  * where the handle objects have been replaced with a serializable form.
@@ -11,7 +12,6 @@
  * @param bind - Bind any other handles we find in the object against this given handle.
  * @returns Result of strigifying an object
  */
-// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
 export function serializeHandles(value, serializer, bind) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return value !== undefined
@@ -30,10 +30,9 @@ export function serializeHandles(value, serializer, bind) {
  * @param bind - Bind any other handles we find in the object against this given handle.
  * @returns The fully-plain object
  */
-// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
 export function makeHandlesSerializable(value, serializer, bind) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    return serializer.replaceHandles(value, bind);
+    return serializer.encode(value, bind);
 }
 /**
  * Given a fully-plain object that may have serializable-form handles within, will return the mostly-plain object
@@ -43,9 +42,19 @@ export function makeHandlesSerializable(value, serializer, bind) {
  * @param context - The handle context for the container
  * @returns The mostly-plain object with handle objects within
  */
-// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
 export function parseHandles(value, serializer) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return value !== undefined ? serializer.parse(JSON.stringify(value)) : value;
 }
+/**
+ * Create a new summary containing one blob
+ * @param key - the key for the blob in the summary
+ * @param content - blob content
+ * @returns The summary containing the blob
+ */
+export function createSingleBlobSummary(key, content) {
+    const builder = new SummaryTreeBuilder();
+    builder.addBlob(key, content);
+    return builder.getSummaryTree();
+}
 //# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH;;;;;;;;GAQG;AACH,+DAA+D;AAC/D,MAAM,UAAU,gBAAgB,CAC5B,KAAU,EACV,UAA4B,EAC5B,IAAkB;IAElB,+DAA+D;IAC/D,OAAO,KAAK,KAAK,SAAS;QACtB,CAAC,CAAC,UAAU,CAAC,SAAS,CAClB,KAAK,EACL,IAAI,CAAC;QACT,CAAC,CAAC,KAAK,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,+DAA+D;AAC/D,MAAM,UAAU,uBAAuB,CACnC,KAAU,EACV,UAA4B,EAC5B,IAAkB;IAElB,+DAA+D;IAC/D,OAAO,UAAU,CAAC,cAAc,CAC5B,KAAK,EACL,IAAI,CAAC,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,+DAA+D;AAC/D,MAAM,UAAU,YAAY,CACxB,KAAU,EACV,UAA4B;IAE5B,+DAA+D;IAC/D,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACjF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidHandle,\n    IFluidSerializer,\n} from \"@fluidframework/core-interfaces\";\n\n/**\n * Given a mostly-plain object that may have handle objects embedded within, return a string representation of an object\n * where the handle objects have been replaced with a serializable form.\n * @param value - The mostly-plain object\n * @param serializer - The serializer that knows how to convert handles into serializable format\n * @param context - The handle context for the container\n * @param bind - Bind any other handles we find in the object against this given handle.\n * @returns Result of strigifying an object\n */\n// eslint-disable-next-line prefer-arrow/prefer-arrow-functions\nexport function serializeHandles(\n    value: any,\n    serializer: IFluidSerializer,\n    bind: IFluidHandle,\n): string | undefined {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return value !== undefined\n        ? serializer.stringify(\n            value,\n            bind)\n        : value;\n}\n\n/**\n * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n * where any embedded IFluidHandles have been replaced with a serializable form.\n *\n * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n * the root to any replaced handles.  (If no handles are found, returns the original object.)\n *\n * @param input - The mostly-plain object\n * @param context - The handle context for the container\n * @param bind - Bind any other handles we find in the object against this given handle.\n * @returns The fully-plain object\n */\n// eslint-disable-next-line prefer-arrow/prefer-arrow-functions\nexport function makeHandlesSerializable(\n    value: any,\n    serializer: IFluidSerializer,\n    bind: IFluidHandle,\n) {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return serializer.replaceHandles(\n        value,\n        bind);\n}\n\n/**\n * Given a fully-plain object that may have serializable-form handles within, will return the mostly-plain object\n * with handle objects created instead.\n * @param value - The fully-plain object\n * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects\n * @param context - The handle context for the container\n * @returns The mostly-plain object with handle objects within\n */\n// eslint-disable-next-line prefer-arrow/prefer-arrow-functions\nexport function parseHandles(\n    value: any,\n    serializer: IFluidSerializer,\n) {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return value !== undefined ? serializer.parse(JSON.stringify(value)) : value;\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAGnE;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC5B,KAAU,EACV,UAA4B,EAC5B,IAAkB;IAElB,+DAA+D;IAC/D,OAAO,KAAK,KAAK,SAAS;QACtB,CAAC,CAAC,UAAU,CAAC,SAAS,CAClB,KAAK,EACL,IAAI,CAAC;QACT,CAAC,CAAC,KAAK,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,uBAAuB,CACnC,KAAU,EACV,UAA4B,EAC5B,IAAkB;IAElB,+DAA+D;IAC/D,OAAO,UAAU,CAAC,MAAM,CACpB,KAAK,EACL,IAAI,CAAC,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CACxB,KAAU,EACV,UAA4B;IAE5B,+DAA+D;IAC/D,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACjF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,GAAW,EAAE,OAA4B;IAC7E,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACzC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;AACpC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { IFluidSerializer } from \"./serializer\";\n\n/**\n * Given a mostly-plain object that may have handle objects embedded within, return a string representation of an object\n * where the handle objects have been replaced with a serializable form.\n * @param value - The mostly-plain object\n * @param serializer - The serializer that knows how to convert handles into serializable format\n * @param context - The handle context for the container\n * @param bind - Bind any other handles we find in the object against this given handle.\n * @returns Result of strigifying an object\n */\nexport function serializeHandles(\n    value: any,\n    serializer: IFluidSerializer,\n    bind: IFluidHandle,\n): string | undefined {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return value !== undefined\n        ? serializer.stringify(\n            value,\n            bind)\n        : value;\n}\n\n/**\n * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n * where any embedded IFluidHandles have been replaced with a serializable form.\n *\n * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n * the root to any replaced handles.  (If no handles are found, returns the original object.)\n *\n * @param input - The mostly-plain object\n * @param context - The handle context for the container\n * @param bind - Bind any other handles we find in the object against this given handle.\n * @returns The fully-plain object\n */\nexport function makeHandlesSerializable(\n    value: any,\n    serializer: IFluidSerializer,\n    bind: IFluidHandle,\n) {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return serializer.encode(\n        value,\n        bind);\n}\n\n/**\n * Given a fully-plain object that may have serializable-form handles within, will return the mostly-plain object\n * with handle objects created instead.\n * @param value - The fully-plain object\n * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects\n * @param context - The handle context for the container\n * @returns The mostly-plain object with handle objects within\n */\nexport function parseHandles(\n    value: any,\n    serializer: IFluidSerializer,\n) {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return value !== undefined ? serializer.parse(JSON.stringify(value)) : value;\n}\n\n/**\n * Create a new summary containing one blob\n * @param key - the key for the blob in the summary\n * @param content - blob content\n * @returns The summary containing the blob\n */\nexport function createSingleBlobSummary(key: string, content: string | Uint8Array): ISummaryTreeWithStats {\n    const builder = new SummaryTreeBuilder();\n    builder.addBlob(key, content);\n    return builder.getSummaryTree();\n}\n"]}