@fluidframework/shared-object-base 0.52.1 → 0.54.0

package/dist/handle.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IFluidHandleContext, IRequest, IResponse } from "@fluidframework/core-interfaces";
+import { IFluidHandleContext } from "@fluidframework/core-interfaces";
 import { FluidObjectHandle } from "@fluidframework/datastore";
 import { ISharedObject } from "./types";
 /**
@@ -30,11 +30,5 @@ export declare class SharedObjectHandle extends FluidObjectHandle<ISharedObject>
      * When attaching the handle, it registers the associated shared object.
      */
     attachGraph(): void;
-    /**
-     * Returns 404.
-     * @param request - The request to make
-     * @returns A 404 error
-     */
-    request(request: IRequest): Promise<IResponse>;
 }
 //# sourceMappingURL=handle.d.ts.map

package/dist/handle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handle.d.ts","sourceRoot":"","sources":["../src/handle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAE9D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB,CAAC,aAAa,CAAC;IACpE;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;;;;OAKG;gBAEC,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB;IAKrC;;;OAGG;IACI,WAAW,IAAI,IAAI;IAK1B;;;;OAIG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;CAG9D"}
+{"version":3,"file":"handle.d.ts","sourceRoot":"","sources":["../src/handle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB,CAAC,aAAa,CAAC;IACpE;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;;;;OAKG;gBAEC,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB;IAKrC;;;OAGG;IACI,WAAW,IAAI,IAAI;CAI7B"}

package/dist/handle.js

@@ -6,7 +6,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SharedObjectHandle = void 0;
 const datastore_1 = require("@fluidframework/datastore");
-const runtime_utils_1 = require("@fluidframework/runtime-utils");
 /**
  * Handle for shared object
  * This object is used for already loaded (in-memory) shared object
@@ -39,14 +38,6 @@ class SharedObjectHandle extends datastore_1.FluidObjectHandle {
         this.value.bindToContext();
         super.attachGraph();
     }
-    /**
-     * Returns 404.
-     * @param request - The request to make
-     * @returns A 404 error
-     */
-    async request(request) {
-        return runtime_utils_1.create404Response(request);
-    }
 }
 exports.SharedObjectHandle = SharedObjectHandle;
 //# sourceMappingURL=handle.js.map

package/dist/handle.js.map

@@ -1 +1 @@
-{"version":3,"file":"handle.js","sourceRoot":"","sources":["../src/handle.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,yDAA8D;AAC9D,iEAAkE;AAGlE;;;;;;;GAOG;AACH,MAAa,kBAAmB,SAAQ,6BAAgC;IACpE;;OAEG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,YACI,KAAoB,EACpB,IAAY,EACZ,YAAiC;QAEjC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,WAAW;QACd,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,WAAW,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,OAAO,iCAAiB,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;CACJ;AAvCD,gDAuCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidHandleContext,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { FluidObjectHandle } from \"@fluidframework/datastore\";\nimport { create404Response } from \"@fluidframework/runtime-utils\";\nimport { ISharedObject } from \"./types\";\n\n/**\n * Handle for shared object\n * This object is used for already loaded (in-memory) shared object\n * and is used only for serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * FluidDataStoreRuntime.request() recognizes requests in the form of '/<shared object id>'\n * and loads shared object.\n */\nexport class SharedObjectHandle extends FluidObjectHandle<ISharedObject> {\n    /**\n     * Whether services have been attached for the associated shared object.\n     */\n    public get isAttached(): boolean {\n        return this.value.isAttached();\n    }\n\n    /**\n     * Creates a new SharedObjectHandle.\n     * @param value - The shared object this handle is for.\n     * @param path - The id of the shared object. It is also the path to this object relative to the routeContext.\n     * @param routeContext - The parent IFluidHandleContext that has a route to this handle.\n     */\n    constructor(\n        value: ISharedObject,\n        path: string,\n        routeContext: IFluidHandleContext,\n    ) {\n        super(value, path, routeContext);\n    }\n\n    /**\n     * Attaches all bound handles first (which may in turn attach further handles), then attaches this handle.\n     * When attaching the handle, it registers the associated shared object.\n     */\n    public attachGraph(): void {\n        this.value.bindToContext();\n        super.attachGraph();\n    }\n\n    /**\n     * Returns 404.\n     * @param request - The request to make\n     * @returns A 404 error\n     */\n    public async request(request: IRequest): Promise<IResponse> {\n        return create404Response(request);\n    }\n}\n"]}
+{"version":3,"file":"handle.js","sourceRoot":"","sources":["../src/handle.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,yDAA8D;AAG9D;;;;;;;GAOG;AACH,MAAa,kBAAmB,SAAQ,6BAAgC;IACpE;;OAEG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,YACI,KAAoB,EACpB,IAAY,EACZ,YAAiC;QAEjC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,WAAW;QACd,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,WAAW,EAAE,CAAC;IACxB,CAAC;CACJ;AA9BD,gDA8BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidHandleContext,\n} from \"@fluidframework/core-interfaces\";\nimport { FluidObjectHandle } from \"@fluidframework/datastore\";\nimport { ISharedObject } from \"./types\";\n\n/**\n * Handle for shared object\n * This object is used for already loaded (in-memory) shared object\n * and is used only for serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * FluidDataStoreRuntime.request() recognizes requests in the form of '/<shared object id>'\n * and loads shared object.\n */\nexport class SharedObjectHandle extends FluidObjectHandle<ISharedObject> {\n    /**\n     * Whether services have been attached for the associated shared object.\n     */\n    public get isAttached(): boolean {\n        return this.value.isAttached();\n    }\n\n    /**\n     * Creates a new SharedObjectHandle.\n     * @param value - The shared object this handle is for.\n     * @param path - The id of the shared object. It is also the path to this object relative to the routeContext.\n     * @param routeContext - The parent IFluidHandleContext that has a route to this handle.\n     */\n    constructor(\n        value: ISharedObject,\n        path: string,\n        routeContext: IFluidHandleContext,\n    ) {\n        super(value, path, routeContext);\n    }\n\n    /**\n     * Attaches all bound handles first (which may in turn attach further handles), then attaches this handle.\n     * When attaching the handle, it registers the associated shared object.\n     */\n    public attachGraph(): void {\n        this.value.bindToContext();\n        super.attachGraph();\n    }\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/shared-object-base";
-export declare const pkgVersion = "0.52.1";
+export declare const pkgVersion = "0.54.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/shared-object-base";
-exports.pkgVersion = "0.52.1";
+exports.pkgVersion = "0.54.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,oCAAoC,CAAC;AAC/C,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/shared-object-base\";\nexport const pkgVersion = \"0.52.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,oCAAoC,CAAC;AAC/C,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/shared-object-base\";\nexport const pkgVersion = \"0.54.0\";\n"]}

package/dist/sharedObject.d.ts

@@ -48,6 +48,10 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * True while we are summarizing this object's data.
      */
     private _isSummarizing;
+    /**
+     * Tracks error that closed this object.
+     */
+    private closeError?;
     /**
      * Gets the connection state
      * @returns The state of the connection
@@ -64,6 +68,27 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * @param attributes - Attributes of the shared object
      */
     constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * 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.
+     * @param error - error object that is thrown whenever an attempt is made to modify this object
+     */
+    private closeWithError;
+    /**
+     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.
+     */
+    private verifyNotClosed;
+    /**
+     * Event listener handler helper that can be used to react to exceptions thrown from event listeners
+     * It wraps error with DataProcessingError, closes this object and throws resulting error.
+     * See closeWithError() for more details
+     * Ideally such situation never happens, as consumers of DDS should never throw exceptions
+     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).
+     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.
+     * DDS state does not match what user sees. Because of it DDS moves to "corrupted state" and does not
+     * allow processing of ops or local changes, which very quickly results in container closure.
+     */
+    private eventListenerErrorHandler;
     private attachListeners;
     /**
      * A shared object, after construction, can either be loaded in the case that it is already part of
@@ -102,6 +127,12 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * Derived classes must override this to provide custom list of references to other GC nodes.
      */
     protected getGCDataCore(): IGarbageCollectionData;
+    /**
+     * 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.
+     * @param decodedHandle - The handle of the Fluid object that is decoded.
+     */
+    protected handleDecoded(decodedHandle: IFluidHandle): void;
     /**
      * Gets a form of the object that can be serialized.
      * @returns A tree representing the snapshot of the shared object.

package/dist/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;AAG7F,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;IA2EnE,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IA5ElD;;;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;;;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;IAoBlD,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;IAmB/F;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAiBjE;;;;OAIG;IACH,SAAS,CAAC,aAAa,IAAI,sBAAsB;IAcjD;;;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;IAOtF;;;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;IAMf;;;;;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,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"}

package/dist/sharedObject.js

@@ -10,6 +10,7 @@ const common_utils_1 = require("@fluidframework/common-utils");
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const runtime_utils_1 = require("@fluidframework/runtime-utils");
 const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const container_utils_1 = require("@fluidframework/container-utils");
 const handle_1 = require("./handle");
 const summarySerializer_1 = require("./summarySerializer");
 /**
@@ -22,7 +23,7 @@ class SharedObject extends telemetry_utils_1.EventEmitterWithErrorHandling {
      * @param attributes - Attributes of the shared object
      */
     constructor(id, runtime, attributes) {
-        super((eventName, error) => this.runtime.raiseContainerWarning(error));
+        super((event, e) => this.eventListenerErrorHandler(event, e));
         this.id = id;
         this.runtime = runtime;
         this.attributes = attributes;
@@ -40,7 +41,7 @@ class SharedObject extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this._isSummarizing = false;
         this.handle = new handle_1.SharedObjectHandle(this, id, runtime.IFluidHandleContext);
         this.logger = telemetry_utils_1.ChildLogger.create(runtime.logger, undefined, { all: { sharedObjectId: uuid_1.v4() } });
-        this._serializer = new runtime_utils_1.FluidSerializer(this.runtime.channelsRoutingContext);
+        this._serializer = new runtime_utils_1.FluidSerializer(this.runtime.channelsRoutingContext, (handle) => this.handleDecoded(handle));
         this.attachListeners();
     }
     /**
@@ -71,6 +72,40 @@ class SharedObject extends telemetry_utils_1.EventEmitterWithErrorHandling {
         common_utils_1.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.
+     * @param error - error object that is thrown whenever an attempt is made to modify this object
+     */
+    closeWithError(error) {
+        if (this.closeError === undefined) {
+            this.closeError = error;
+        }
+    }
+    /**
+     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.
+     */
+    verifyNotClosed() {
+        if (this.closeError !== undefined) {
+            throw this.closeError;
+        }
+    }
+    /**
+     * Event listener handler helper that can be used to react to exceptions thrown from event listeners
+     * It wraps error with DataProcessingError, closes this object and throws resulting error.
+     * See closeWithError() for more details
+     * Ideally such situation never happens, as consumers of DDS should never throw exceptions
+     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).
+     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.
+     * DDS state does not match what user sees. Because of it DDS moves to "corrupted state" and does not
+     * allow processing of ops or local changes, which very quickly results in container closure.
+     */
+    eventListenerErrorHandler(event, e) {
+        const error = container_utils_1.DataProcessingError.wrapIfUnrecognized(e, "SharedObjectEventListenerException");
+        error.addTelemetryProperties({ emittedEventName: String(event) });
+        this.closeWithError(error);
+        throw error;
+    }
     attachListeners() {
         // Only listen to these events if not attached.
         if (!this.isAttached()) {
@@ -138,7 +173,7 @@ class SharedObject extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this._isSummarizing = true;
         let summaryTree;
         try {
-            const serializer = new summarySerializer_1.SummarySerializer(this.runtime.channelsRoutingContext);
+            const serializer = new summarySerializer_1.SummarySerializer(this.runtime.channelsRoutingContext, (handle) => this.handleDecoded(handle));
             const snapshot = this.snapshotCore(serializer);
             summaryTree = runtime_utils_1.convertToSummaryTreeWithStats(snapshot, fullTree);
             common_utils_1.assert(this._isSummarizing, 0x077 /* "Possible re-entrancy! Summary should have been in progress." */);
@@ -175,7 +210,7 @@ class SharedObject extends telemetry_utils_1.EventEmitterWithErrorHandling {
         // 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_1.SummarySerializer(this.runtime.channelsRoutingContext);
+        const serializer = new summarySerializer_1.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.
@@ -183,6 +218,18 @@ class SharedObject extends telemetry_utils_1.EventEmitterWithErrorHandling {
             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.
+     * @param decodedHandle - The handle of the Fluid object that is decoded.
+     */
+    handleDecoded(decodedHandle) {
+        var _a, _b, _c;
+        if (this.isAttached()) {
+            // This represents an outbound reference from this object to the node represented by decodedHandle.
+            (_c = (_a = this.services) === null || _a === void 0 ? void 0 : (_b = _a.deltaConnection).addedGCOutboundReference) === null || _c === void 0 ? void 0 : _c.call(_b, this.handle, decodedHandle);
+        }
+    }
     /**
      * Allows the distributed data type to perform custom local loading.
      */
@@ -204,6 +251,7 @@ class SharedObject extends telemetry_utils_1.EventEmitterWithErrorHandling {
      * also sent if we are asked to resubmit the message.
      */
     submitLocalMessage(content, localOpMetadata = undefined) {
+        this.verifyNotClosed();
         if (this.isAttached()) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             this.services.deltaConnection.submit(content, localOpMetadata);
@@ -316,6 +364,7 @@ class SharedObject extends telemetry_utils_1.EventEmitterWithErrorHandling {
      * For messages from a remote client, this will be undefined.
      */
     process(message, local, localOpMetadata) {
+        this.verifyNotClosed(); // This will result in container closure.
         this.emit("pre-op", message, local, this);
         this.processCore(message, local, localOpMetadata);
         this.emit("op", message, local, this);

package/dist/sharedObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedObject.js","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAElC,+DAAsD;AACtD,iFAAoE;AAapE,iEAA+F;AAC/F,qEAA6F;AAC7F,qCAA8C;AAC9C,2DAAwD;AAGxD;;GAEG;AACH,MAAsB,YAClB,SAAQ,+CAAqC;IAqE7C;;;;OAIG;IACH,YACW,EAAU,EACP,OAA+B,EACzB,UAA8B;QAE9C,KAAK,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;QAJhE,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QAtDlD;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QAE3C;;WAEG;QACK,mBAAc,GAAY,KAAK,CAAC;QAwCpC,IAAI,CAAC,MAAM,GAAG,IAAI,2BAAkB,CAChC,IAAI,EACJ,EAAE,EACF,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEjC,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAC5B,OAAO,CAAC,MAAM,EACd,SAAS,EACT,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,SAAI,EAAE,EAAE,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAI,+BAAe,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAE5E,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IA9FD;;;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;IAED,IAAc,UAAU;QACpB;;;;;;WAMG;QACH,qBAAM,CAAC,CAAC,IAAI,CAAC,cAAc,EACvB,KAAK,CAAC,6EAA6E,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAmCO,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,mCAAW,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,mCAAW,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,mCAAW,CAAC,QAAQ,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QACnE,6GAA6G;QAC7G,yGAAyG;QACzG,0BAA0B;QAC1B,qBAAM,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,qCAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;YAC9E,MAAM,QAAQ,GAAU,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACtD,WAAW,GAAG,6CAA6B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAChE,qBAAM,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,qBAAM,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,qBAAM,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,qCAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC9E,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;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,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,qBAAM,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,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;AAraD,oCAqaC","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 } 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 { 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     * 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((eventName, error) => this.runtime.raiseContainerWarning(error));\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(this.runtime.channelsRoutingContext);\n\n        this.attachListeners();\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(this.runtime.channelsRoutingContext);\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(this.runtime.channelsRoutingContext);\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     * 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        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.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,+BAAkC;AAElC,+DAA6E;AAC7E,iFAAoE;AAapE,iEAA+F;AAC/F,qEAA6F;AAC7F,qEAAsE;AACtE,qCAA8C;AAC9C,2DAAwD;AAGxD;;GAEG;AACH,MAAsB,YAClB,SAAQ,+CAAqC;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,2BAAkB,CAChC,IAAI,EACJ,EAAE,EACF,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEjC,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAC5B,OAAO,CAAC,MAAM,EACd,SAAS,EACT,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,SAAI,EAAE,EAAE,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAI,+BAAe,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,qBAAM,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,qCAAmB,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,mCAAW,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,mCAAW,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,mCAAW,CAAC,QAAQ,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QACnE,6GAA6G;QAC7G,yGAAyG;QACzG,0BAA0B;QAC1B,qBAAM,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,qCAAiB,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,6CAA6B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAChE,qBAAM,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,qBAAM,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,qBAAM,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,qCAAiB,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,qBAAM,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;AAzeD,oCAyeC","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"]}

package/lib/handle.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IFluidHandleContext, IRequest, IResponse } from "@fluidframework/core-interfaces";
+import { IFluidHandleContext } from "@fluidframework/core-interfaces";
 import { FluidObjectHandle } from "@fluidframework/datastore";
 import { ISharedObject } from "./types";
 /**
@@ -30,11 +30,5 @@ export declare class SharedObjectHandle extends FluidObjectHandle<ISharedObject>
      * When attaching the handle, it registers the associated shared object.
      */
     attachGraph(): void;
-    /**
-     * Returns 404.
-     * @param request - The request to make
-     * @returns A 404 error
-     */
-    request(request: IRequest): Promise<IResponse>;
 }
 //# sourceMappingURL=handle.d.ts.map

package/lib/handle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handle.d.ts","sourceRoot":"","sources":["../src/handle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAE9D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB,CAAC,aAAa,CAAC;IACpE;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;;;;OAKG;gBAEC,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB;IAKrC;;;OAGG;IACI,WAAW,IAAI,IAAI;IAK1B;;;;OAIG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;CAG9D"}
+{"version":3,"file":"handle.d.ts","sourceRoot":"","sources":["../src/handle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB,CAAC,aAAa,CAAC;IACpE;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;;;;OAKG;gBAEC,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB;IAKrC;;;OAGG;IACI,WAAW,IAAI,IAAI;CAI7B"}

package/lib/handle.js

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 import { FluidObjectHandle } from "@fluidframework/datastore";
-import { create404Response } from "@fluidframework/runtime-utils";
 /**
  * Handle for shared object
  * This object is used for already loaded (in-memory) shared object
@@ -36,13 +35,5 @@ export class SharedObjectHandle extends FluidObjectHandle {
         this.value.bindToContext();
         super.attachGraph();
     }
-    /**
-     * Returns 404.
-     * @param request - The request to make
-     * @returns A 404 error
-     */
-    async request(request) {
-        return create404Response(request);
-    }
 }
 //# sourceMappingURL=handle.js.map

package/lib/handle.js.map

@@ -1 +1 @@
-{"version":3,"file":"handle.js","sourceRoot":"","sources":["../src/handle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAGlE;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAmB,SAAQ,iBAAgC;IACpE;;OAEG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,YACI,KAAoB,EACpB,IAAY,EACZ,YAAiC;QAEjC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,WAAW;QACd,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,WAAW,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidHandleContext,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { FluidObjectHandle } from \"@fluidframework/datastore\";\nimport { create404Response } from \"@fluidframework/runtime-utils\";\nimport { ISharedObject } from \"./types\";\n\n/**\n * Handle for shared object\n * This object is used for already loaded (in-memory) shared object\n * and is used only for serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * FluidDataStoreRuntime.request() recognizes requests in the form of '/<shared object id>'\n * and loads shared object.\n */\nexport class SharedObjectHandle extends FluidObjectHandle<ISharedObject> {\n    /**\n     * Whether services have been attached for the associated shared object.\n     */\n    public get isAttached(): boolean {\n        return this.value.isAttached();\n    }\n\n    /**\n     * Creates a new SharedObjectHandle.\n     * @param value - The shared object this handle is for.\n     * @param path - The id of the shared object. It is also the path to this object relative to the routeContext.\n     * @param routeContext - The parent IFluidHandleContext that has a route to this handle.\n     */\n    constructor(\n        value: ISharedObject,\n        path: string,\n        routeContext: IFluidHandleContext,\n    ) {\n        super(value, path, routeContext);\n    }\n\n    /**\n     * Attaches all bound handles first (which may in turn attach further handles), then attaches this handle.\n     * When attaching the handle, it registers the associated shared object.\n     */\n    public attachGraph(): void {\n        this.value.bindToContext();\n        super.attachGraph();\n    }\n\n    /**\n     * Returns 404.\n     * @param request - The request to make\n     * @returns A 404 error\n     */\n    public async request(request: IRequest): Promise<IResponse> {\n        return create404Response(request);\n    }\n}\n"]}
+{"version":3,"file":"handle.js","sourceRoot":"","sources":["../src/handle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAG9D;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAmB,SAAQ,iBAAgC;IACpE;;OAEG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,YACI,KAAoB,EACpB,IAAY,EACZ,YAAiC;QAEjC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,WAAW;QACd,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,WAAW,EAAE,CAAC;IACxB,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidHandleContext,\n} from \"@fluidframework/core-interfaces\";\nimport { FluidObjectHandle } from \"@fluidframework/datastore\";\nimport { ISharedObject } from \"./types\";\n\n/**\n * Handle for shared object\n * This object is used for already loaded (in-memory) shared object\n * and is used only for serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * FluidDataStoreRuntime.request() recognizes requests in the form of '/<shared object id>'\n * and loads shared object.\n */\nexport class SharedObjectHandle extends FluidObjectHandle<ISharedObject> {\n    /**\n     * Whether services have been attached for the associated shared object.\n     */\n    public get isAttached(): boolean {\n        return this.value.isAttached();\n    }\n\n    /**\n     * Creates a new SharedObjectHandle.\n     * @param value - The shared object this handle is for.\n     * @param path - The id of the shared object. It is also the path to this object relative to the routeContext.\n     * @param routeContext - The parent IFluidHandleContext that has a route to this handle.\n     */\n    constructor(\n        value: ISharedObject,\n        path: string,\n        routeContext: IFluidHandleContext,\n    ) {\n        super(value, path, routeContext);\n    }\n\n    /**\n     * Attaches all bound handles first (which may in turn attach further handles), then attaches this handle.\n     * When attaching the handle, it registers the associated shared object.\n     */\n    public attachGraph(): void {\n        this.value.bindToContext();\n        super.attachGraph();\n    }\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/shared-object-base";
-export declare const pkgVersion = "0.52.1";
+export declare const pkgVersion = "0.54.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/shared-object-base";
-export const pkgVersion = "0.52.1";
+export const pkgVersion = "0.54.0";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

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

package/lib/sharedObject.d.ts

@@ -48,6 +48,10 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * True while we are summarizing this object's data.
      */
     private _isSummarizing;
+    /**
+     * Tracks error that closed this object.
+     */
+    private closeError?;
     /**
      * Gets the connection state
      * @returns The state of the connection
@@ -64,6 +68,27 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * @param attributes - Attributes of the shared object
      */
     constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * 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.
+     * @param error - error object that is thrown whenever an attempt is made to modify this object
+     */
+    private closeWithError;
+    /**
+     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.
+     */
+    private verifyNotClosed;
+    /**
+     * Event listener handler helper that can be used to react to exceptions thrown from event listeners
+     * It wraps error with DataProcessingError, closes this object and throws resulting error.
+     * See closeWithError() for more details
+     * Ideally such situation never happens, as consumers of DDS should never throw exceptions
+     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).
+     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.
+     * DDS state does not match what user sees. Because of it DDS moves to "corrupted state" and does not
+     * allow processing of ops or local changes, which very quickly results in container closure.
+     */
+    private eventListenerErrorHandler;
     private attachListeners;
     /**
      * A shared object, after construction, can either be loaded in the case that it is already part of
@@ -102,6 +127,12 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * Derived classes must override this to provide custom list of references to other GC nodes.
      */
     protected getGCDataCore(): IGarbageCollectionData;
+    /**
+     * 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.
+     * @param decodedHandle - The handle of the Fluid object that is decoded.
+     */
+    protected handleDecoded(decodedHandle: IFluidHandle): void;
     /**
      * Gets a form of the object that can be serialized.
      * @returns A tree representing the snapshot of the shared object.

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;AAG7F,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;IA2EnE,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IA5ElD;;;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;;;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;IAoBlD,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;IAmB/F;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAiBjE;;;;OAIG;IACH,SAAS,CAAC,aAAa,IAAI,sBAAsB;IAcjD;;;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;IAOtF;;;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;IAMf;;;;;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,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"}

package/lib/sharedObject.js

@@ -7,6 +7,7 @@ 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 { SharedObjectHandle } from "./handle";
 import { SummarySerializer } from "./summarySerializer";
 /**
@@ -19,7 +20,7 @@ export class SharedObject extends EventEmitterWithErrorHandling {
      * @param attributes - Attributes of the shared object
      */
     constructor(id, runtime, attributes) {
-        super((eventName, error) => this.runtime.raiseContainerWarning(error));
+        super((event, e) => this.eventListenerErrorHandler(event, e));
         this.id = id;
         this.runtime = runtime;
         this.attributes = attributes;
@@ -37,7 +38,7 @@ export class SharedObject extends EventEmitterWithErrorHandling {
         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);
+        this._serializer = new FluidSerializer(this.runtime.channelsRoutingContext, (handle) => this.handleDecoded(handle));
         this.attachListeners();
     }
     /**
@@ -68,6 +69,40 @@ export class SharedObject extends EventEmitterWithErrorHandling {
         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.
+     * @param error - error object that is thrown whenever an attempt is made to modify this object
+     */
+    closeWithError(error) {
+        if (this.closeError === undefined) {
+            this.closeError = error;
+        }
+    }
+    /**
+     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.
+     */
+    verifyNotClosed() {
+        if (this.closeError !== undefined) {
+            throw this.closeError;
+        }
+    }
+    /**
+     * Event listener handler helper that can be used to react to exceptions thrown from event listeners
+     * It wraps error with DataProcessingError, closes this object and throws resulting error.
+     * See closeWithError() for more details
+     * Ideally such situation never happens, as consumers of DDS should never throw exceptions
+     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).
+     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.
+     * DDS state does not match what user sees. Because of it DDS moves to "corrupted state" and does not
+     * allow processing of ops or local changes, which very quickly results in container closure.
+     */
+    eventListenerErrorHandler(event, e) {
+        const error = DataProcessingError.wrapIfUnrecognized(e, "SharedObjectEventListenerException");
+        error.addTelemetryProperties({ emittedEventName: String(event) });
+        this.closeWithError(error);
+        throw error;
+    }
     attachListeners() {
         // Only listen to these events if not attached.
         if (!this.isAttached()) {
@@ -135,7 +170,7 @@ export class SharedObject extends EventEmitterWithErrorHandling {
         this._isSummarizing = true;
         let summaryTree;
         try {
-            const serializer = new SummarySerializer(this.runtime.channelsRoutingContext);
+            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." */);
@@ -172,7 +207,7 @@ export class SharedObject extends EventEmitterWithErrorHandling {
         // 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);
+        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.
@@ -180,6 +215,18 @@ export class SharedObject extends EventEmitterWithErrorHandling {
             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.
+     * @param decodedHandle - The handle of the Fluid object that is decoded.
+     */
+    handleDecoded(decodedHandle) {
+        var _a, _b, _c;
+        if (this.isAttached()) {
+            // This represents an outbound reference from this object to the node represented by decodedHandle.
+            (_c = (_a = this.services) === null || _a === void 0 ? void 0 : (_b = _a.deltaConnection).addedGCOutboundReference) === null || _c === void 0 ? void 0 : _c.call(_b, this.handle, decodedHandle);
+        }
+    }
     /**
      * Allows the distributed data type to perform custom local loading.
      */
@@ -201,6 +248,7 @@ export class SharedObject extends EventEmitterWithErrorHandling {
      * also sent if we are asked to resubmit the message.
      */
     submitLocalMessage(content, localOpMetadata = undefined) {
+        this.verifyNotClosed();
         if (this.isAttached()) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             this.services.deltaConnection.submit(content, localOpMetadata);
@@ -313,6 +361,7 @@ export class SharedObject extends EventEmitterWithErrorHandling {
      * For messages from a remote client, this will be undefined.
      */
     process(message, local, localOpMetadata) {
+        this.verifyNotClosed(); // This will result in container closure.
         this.emit("pre-op", message, local, this);
         this.processCore(message, local, localOpMetadata);
         this.emit("op", message, local, this);

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,EAAE,MAAM,8BAA8B,CAAC;AACtD,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,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,OAAgB,YAClB,SAAQ,6BAAqC;IAqE7C;;;;OAIG;IACH,YACW,EAAU,EACP,OAA+B,EACzB,UAA8B;QAE9C,KAAK,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;QAJhE,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QAtDlD;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QAE3C;;WAEG;QACK,mBAAc,GAAY,KAAK,CAAC;QAwCpC,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,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAE5E,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IA9FD;;;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;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;IAmCO,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,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;YAC9E,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,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC9E,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;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,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,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 } 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 { 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     * 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((eventName, error) => this.runtime.raiseContainerWarning(error));\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(this.runtime.channelsRoutingContext);\n\n        this.attachListeners();\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(this.runtime.channelsRoutingContext);\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(this.runtime.channelsRoutingContext);\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     * 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        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.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,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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/shared-object-base",
-  "version": "0.52.1",
+  "version": "0.54.0",
   "description": "Fluid base class for shared distributed data structures",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -31,21 +31,22 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^0.42.0",
+    "@fluidframework/container-definitions": "^0.44.0",
+    "@fluidframework/container-utils": "^0.54.0",
     "@fluidframework/core-interfaces": "^0.41.0",
-    "@fluidframework/datastore": "^0.52.1",
-    "@fluidframework/datastore-definitions": "^0.52.1",
+    "@fluidframework/datastore": "^0.54.0",
+    "@fluidframework/datastore-definitions": "^0.54.0",
     "@fluidframework/protocol-definitions": "^0.1026.0",
-    "@fluidframework/runtime-definitions": "^0.52.1",
-    "@fluidframework/runtime-utils": "^0.52.1",
-    "@fluidframework/telemetry-utils": "^0.52.1",
+    "@fluidframework/runtime-definitions": "^0.54.0",
+    "@fluidframework/runtime-utils": "^0.54.0",
+    "@fluidframework/telemetry-utils": "^0.54.0",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
     "@fluidframework/eslint-config-fluid": "^0.24.0",
     "@microsoft/api-extractor": "^7.16.1",
-    "@types/node": "^12.19.0",
+    "@types/node": "^14.18.0",
     "@typescript-eslint/eslint-plugin": "~4.14.0",
     "@typescript-eslint/parser": "~4.14.0",
     "concurrently": "^6.2.0",

package/src/handle.ts

@@ -5,11 +5,8 @@
 
 import {
     IFluidHandleContext,
-    IRequest,
-    IResponse,
 } from "@fluidframework/core-interfaces";
 import { FluidObjectHandle } from "@fluidframework/datastore";
-import { create404Response } from "@fluidframework/runtime-utils";
 import { ISharedObject } from "./types";
 
 /**
@@ -50,13 +47,4 @@ export class SharedObjectHandle extends FluidObjectHandle<ISharedObject> {
         this.value.bindToContext();
         super.attachGraph();
     }
-
-    /**
-     * Returns 404.
-     * @param request - The request to make
-     * @returns A 404 error
-     */
-    public async request(request: IRequest): Promise<IResponse> {
-        return create404Response(request);
-    }
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/shared-object-base";
-export const pkgVersion = "0.52.1";
+export const pkgVersion = "0.54.0";

package/src/sharedObject.ts

@@ -5,7 +5,7 @@
 
 import { v4 as uuid } from "uuid";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { assert } from "@fluidframework/common-utils";
+import { assert, EventEmitterEventType } from "@fluidframework/common-utils";
 import { AttachState } from "@fluidframework/container-definitions";
 import { IFluidHandle, IFluidSerializer } from "@fluidframework/core-interfaces";
 import {
@@ -21,6 +21,7 @@ import {
 } from "@fluidframework/runtime-definitions";
 import { convertToSummaryTreeWithStats, FluidSerializer } from "@fluidframework/runtime-utils";
 import { ChildLogger, EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
+import { DataProcessingError } from "@fluidframework/container-utils";
 import { SharedObjectHandle } from "./handle";
 import { SummarySerializer } from "./summarySerializer";
 import { ISharedObject, ISharedObjectEvents } from "./types";
@@ -72,6 +73,11 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
      */
     private _isSummarizing: boolean = false;
 
+    /**
+     * Tracks error that closed this object.
+     */
+    private closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;
+
     /**
      * Gets the connection state
      * @returns The state of the connection
@@ -108,7 +114,7 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
         protected runtime: IFluidDataStoreRuntime,
         public readonly attributes: IChannelAttributes)
     {
-        super((eventName, error) => this.runtime.raiseContainerWarning(error));
+        super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));
 
         this.handle = new SharedObjectHandle(
             this,
@@ -121,11 +127,54 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
             { all: { sharedObjectId: uuid() } },
         );
 
-        this._serializer = new FluidSerializer(this.runtime.channelsRoutingContext);
+        this._serializer = new FluidSerializer(
+            this.runtime.channelsRoutingContext,
+            (handle: IFluidHandle) => this.handleDecoded(handle),
+        );
 
         this.attachListeners();
     }
 
+    /**
+     * 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.
+     * @param error - error object that is thrown whenever an attempt is made to modify this object
+     */
+    private closeWithError(error: any) {
+        if (this.closeError === undefined) {
+            this.closeError = error;
+        }
+    }
+
+    /**
+     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.
+     */
+    private verifyNotClosed() {
+        if (this.closeError !== undefined) {
+            throw this.closeError;
+        }
+    }
+
+    /**
+     * Event listener handler helper that can be used to react to exceptions thrown from event listeners
+     * It wraps error with DataProcessingError, closes this object and throws resulting error.
+     * See closeWithError() for more details
+     * Ideally such situation never happens, as consumers of DDS should never throw exceptions
+     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).
+     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.
+     * DDS state does not match what user sees. Because of it DDS moves to "corrupted state" and does not
+     * allow processing of ops or local changes, which very quickly results in container closure.
+     */
+    private eventListenerErrorHandler(event: EventEmitterEventType, e: any) {
+        const error = DataProcessingError.wrapIfUnrecognized(
+            e,
+            "SharedObjectEventListenerException");
+        error.addTelemetryProperties({ emittedEventName: String(event) });
+
+        this.closeWithError(error);
+        throw error;
+    }
+
     private attachListeners() {
         // Only listen to these events if not attached.
         if (!this.isAttached()) {
@@ -203,7 +252,10 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
 
         let summaryTree: ISummaryTreeWithStats;
         try {
-            const serializer = new SummarySerializer(this.runtime.channelsRoutingContext);
+            const serializer = new SummarySerializer(
+                this.runtime.channelsRoutingContext,
+                (handle: IFluidHandle) => this.handleDecoded(handle),
+            );
             const snapshot: ITree = this.snapshotCore(serializer);
             summaryTree = convertToSummaryTreeWithStats(snapshot, fullTree);
             assert(this._isSummarizing, 0x077 /* "Possible re-entrancy! Summary should have been in progress." */);
@@ -242,7 +294,10 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
         // 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);
+        const serializer = new SummarySerializer(
+            this.runtime.channelsRoutingContext,
+            (handle: IFluidHandle) => 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
@@ -252,6 +307,18 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
         };
     }
 
+    /**
+     * 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.
+     * @param decodedHandle - The handle of the Fluid object that is decoded.
+     */
+    protected handleDecoded(decodedHandle: IFluidHandle) {
+        if (this.isAttached()) {
+            // This represents an outbound reference from this object to the node represented by decodedHandle.
+            this.services?.deltaConnection.addedGCOutboundReference?.(this.handle, decodedHandle);
+        }
+    }
+
     /**
      * Gets a form of the object that can be serialized.
      * @returns A tree representing the snapshot of the shared object.
@@ -306,6 +373,7 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
      * also sent if we are asked to resubmit the message.
      */
     protected submitLocalMessage(content: any, localOpMetadata: unknown = undefined): void {
+        this.verifyNotClosed();
         if (this.isAttached()) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             this.services!.deltaConnection.submit(content, localOpMetadata);
@@ -433,6 +501,7 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
      * For messages from a remote client, this will be undefined.
      */
     private process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {
+        this.verifyNotClosed(); // This will result in container closure.
         this.emit("pre-op", message, local, this);
         this.processCore(message, local, localOpMetadata);
         this.emit("op", message, local, this);