@fluidframework/shared-object-base 0.59.4001 → 1.1.0-75972

package/.eslintrc.js

@@ -5,7 +5,7 @@
 
 module.exports = {
     "extends": [
-        "@fluidframework/eslint-config-fluid"
+        require.resolve("@fluidframework/eslint-config-fluid")
     ],
     "parserOptions": {
         "project": ["./tsconfig.json", "./src/test/tsconfig.json"]

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.59.4001";
+export declare const pkgVersion = "1.1.0-75972";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,cAAc,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,gBAAgB,CAAC"}

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.59.4001";
+exports.pkgVersion = "1.1.0-75972";
 //# 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,WAAW,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.59.4001\";\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,aAAa,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 = \"1.1.0-75972\";\n"]}

package/dist/serializer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAGpF;;GAEG;AACF,MAAM,WAAW,iBAAiB;IAE/B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,kBAAkB,UAAW,GAAG,+BACP,CAAC;AAEvC,MAAM,WAAW,gBAAgB;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,GAAG,CAAC;IAE5C;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,gBAAgB;IAIhD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAExB,OAAO,CAAC,QAAQ,CAAC,cAAc;IALnC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAsB;gBAGtB,OAAO,EAAE,mBAAmB,EAE5B,cAAc,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI;IAQnE,IAAW,gBAAgB,SAAmB;IAE9C;;;;;;;;OAQG;IACK,MAAM,CACV,KAAK,EAAE,GAAG,EACV,IAAI,EAAE,YAAY;IAUtB;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAK,EAAE,GAAG;IASlB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY;IAKxC,KAAK,CAAC,KAAK,EAAE,MAAM;IAM1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAQ1B;IAIF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAe1B;IAKF,OAAO,CAAC,kBAAkB;IAgD1B,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY;;;;CAOrE"}
+{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAGpF;;GAEG;AACF,MAAM,WAAW,iBAAiB;IAE/B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,kBAAkB,UAAW,GAAG,+BACP,CAAC;AAEvC,MAAM,WAAW,gBAAgB;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,GAAG,CAAC;IAE5C;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,gBAAgB;IAIhD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAExB,OAAO,CAAC,QAAQ,CAAC,cAAc;IALnC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAsB;gBAGtB,OAAO,EAAE,mBAAmB,EAE5B,cAAc,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI;IAQnE,IAAW,gBAAgB,SAAmB;IAE9C;;;;;;;;OAQG;IACK,MAAM,CACV,KAAK,EAAE,GAAG,EACV,IAAI,EAAE,YAAY;IAUtB;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAK,EAAE,GAAG;IASlB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY;IAKxC,KAAK,CAAC,KAAK,EAAE,MAAM;IAM1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAQ1B;IAIF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAe1B;IAKF,OAAO,CAAC,kBAAkB;IA+C1B,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY;;;;CAOrE"}

package/dist/serializer.js

@@ -110,7 +110,6 @@ class FluidSerializer {
             return maybeReplaced;
         }
         // Otherwise descend into the object graph looking for IFluidHandle instances.
-        // eslint-disable-next-line @typescript-eslint/ban-types
         let clone;
         for (const key of Object.keys(input)) {
             const value = input[key];

package/dist/serializer.js.map

@@ -1 +1 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iEAAiE;AACjE,wDAAwD;AAExD,iEAA0E;AAE1E,6DAA+D;AAaxD,MAAM,kBAAkB,GAAG,CAAC,KAAU,EAA8B,EAAE,CACzE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,kBAAkB,CAAC;AAD1B,QAAA,kBAAkB,sBACQ;AAmCvC;;GAEG;AACH,MAAa,eAAe;IAGxB,YACqB,OAA4B;IAC7C,+DAA+D;IAC9C,cAA8C;QAF9C,YAAO,GAAP,OAAO,CAAqB;QAE5B,mBAAc,GAAd,cAAc,CAAgC;QA0DnE,6EAA6E;QAC7E,iFAAiF;QAChE,gBAAW,GAAG,CAAC,KAAU,EAAE,IAAkB,EAAE,EAAE;YAC9D,wCAAwC;YACxC,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAC;YAEnC,yDAAyD;YACzD,OAAO,MAAM,KAAK,SAAS;gBACvB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;gBACpC,CAAC,CAAC,KAAK,CAAC;QAChB,CAAC,CAAC;QAEF,qFAAqF;QACrF,6EAA6E;QAC5D,gBAAW,GAAG,CAAC,KAAU,EAAE,EAAE;YAC1C,0EAA0E;YAC1E,IAAI,IAAA,0BAAkB,EAAC,KAAK,CAAC,EAAE;gBAC3B,kGAAkG;gBAClG,4FAA4F;gBAC5F,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;oBAC1C,CAAC,CAAC,KAAK,CAAC,GAAG;oBACX,CAAC,CAAC,IAAA,yCAAyB,EAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEzD,MAAM,YAAY,GAAG,IAAI,4CAAuB,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1E,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;gBAClC,OAAO,YAAY,CAAC;aACvB;iBAAM;gBACH,OAAO,KAAK,CAAC;aAChB;QACL,CAAC,CAAC;QArFE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;SACtC;IACL,CAAC;IAED,IAAW,gBAAgB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE9C;;;;;;;;OAQG;IACK,MAAM,CACV,KAAU,EACV,IAAkB;QAElB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC;YACxD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAU;QACrB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC;YAClD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,KAAU,EAAE,IAAkB;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,kGAAkG;IAC3F,KAAK,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,CAAC;IAiCD,mFAAmF;IACnF,0FAA0F;IAC1F,gCAAgC;IACxB,kBAAkB,CACtB,KAAU,EACV,QAA2C,EAC3C,OAAa;QAEb,+EAA+E;QAC/E,4CAA4C;QAE5C,yGAAyG;QACzG,wBAAwB;QACxB,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE/C,qGAAqG;QACrG,8BAA8B;QAC9B,IAAI,aAAa,KAAK,KAAK,EAAE;YACzB,OAAO,aAAa,CAAC;SACxB;QAED,8EAA8E;QAC9E,wDAAwD;QACxD,IAAI,KAAyB,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAClC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACzB,yEAAyE;YACzE,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACtC,8FAA8F;gBAC9F,+FAA+F;gBAC/F,8DAA8D;gBAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAEnE,kGAAkG;gBAClG,+FAA+F;gBAC/F,wDAAwD;gBACxD,IAAI,QAAQ,KAAK,KAAK,EAAE;oBACpB,qFAAqF;oBACrF,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;wBAClC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;wBACZ,CAAC,mBAAM,KAAK,CAAE,CAAC,CAAC;oBAEpB,+EAA+E;oBAC/E,oEAAoE;oBACpE,KAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBAC1B;aACJ;SACJ;QACD,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC;IAC1B,CAAC;IAES,eAAe,CAAC,MAAoB,EAAE,IAAkB;QAC9D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,OAAO;YACH,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,MAAM,CAAC,YAAY;SAC3B,CAAC;IACN,CAAC;CACJ;AAzJD,0CAyJC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// RATIONALE: Many methods consume and return 'any' by necessity.\n/* eslint-disable @typescript-eslint/no-unsafe-return */\n\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { RemoteFluidObjectHandle } from \"./remoteObjectHandle\";\n\n/**\n * JSON serialized form of an IFluidHandle\n */\n export interface ISerializedHandle {\n    // Marker to indicate to JSON.parse that the object is a Fluid handle\n    type: \"__fluid_handle__\";\n\n    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.\n    url: string;\n}\n\nexport const isSerializedHandle = (value: any): value is ISerializedHandle =>\n    value?.type === \"__fluid_handle__\";\n\nexport interface IFluidSerializer {\n    /**\n     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n     * where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     */\n    encode(value: any, bind: IFluidHandle): any;\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n    decode(input: any): any;\n\n    /**\n     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.\n     */\n    stringify(value: any, bind: IFluidHandle): string;\n\n    /**\n     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid\n     * handles will be realized as part of the parse\n     */\n    parse(value: string): any;\n}\n\n/**\n * Data Store serializer implementation\n */\nexport class FluidSerializer implements IFluidSerializer {\n    private readonly root: IFluidHandleContext;\n\n    public constructor(\n        private readonly context: IFluidHandleContext,\n        // To be called whenever a handle is parsed by this serializer.\n        private readonly handleParsedCb: (handle: IFluidHandle) => void,\n    ) {\n        this.root = this.context;\n        while (this.root.routeContext !== undefined) {\n            this.root = this.root.routeContext;\n        }\n    }\n\n    public get IFluidSerializer() { return this; }\n\n    /**\n     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a\n     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * Any unbound handles encountered are bound to the provided IFluidHandle.\n     */\n     public encode(\n        input: any,\n        bind: IFluidHandle,\n    ) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.encodeValue, bind)\n            : input;\n    }\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n     public decode(input: any) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.decodeValue)\n            : input;\n    }\n\n    public stringify(input: any, bind: IFluidHandle) {\n        return JSON.stringify(input, (key, value) => this.encodeValue(value, bind));\n    }\n\n    // Parses the serialized data - context must match the context with which the JSON was stringified\n    public parse(input: string) {\n        return JSON.parse(input, (key, value) => this.decodeValue(value));\n    }\n\n    // If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'encode()' and 'stringify()'.\n    private readonly encodeValue = (value: any, bind: IFluidHandle) => {\n        // Detect if 'value' is an IFluidHandle.\n        const handle = value?.IFluidHandle;\n\n        // If 'value' is an IFluidHandle return its encoded form.\n        return handle !== undefined\n            ? this.serializeHandle(handle, bind)\n            : value;\n    };\n\n    // If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.\n    private readonly decodeValue = (value: any) => {\n        // If 'value' is a serialized IFluidHandle return the deserialized result.\n        if (isSerializedHandle(value)) {\n            // Old documents may have handles with relative path in their summaries. Convert these to absolute\n            // paths. This will ensure that future summaries will have absolute paths for these handles.\n            const absolutePath = value.url.startsWith(\"/\")\n                ? value.url\n                : generateHandleContextPath(value.url, this.context);\n\n            const parsedHandle = new RemoteFluidObjectHandle(absolutePath, this.root);\n            this.handleParsedCb(parsedHandle);\n            return parsedHandle;\n        } else {\n            return value;\n        }\n    };\n\n    // Invoked for non-null objects to recursively replace references to IFluidHandles.\n    // Clones as-needed to avoid mutating the `input` object.  If no IFluidHandes are present,\n    // returns the original `input`.\n    private recursivelyReplace(\n        input: any,\n        replacer: (input: any, context: any) => any,\n        context?: any,\n    ) {\n        // Note: Caller is responsible for ensuring that `input` is defined / non-null.\n        //       (Required for Object.keys() below.)\n\n        // Execute the `replace` on the current input.  Note that Caller is responsible for ensuring that `input`\n        // is a non-null object.\n        const maybeReplaced = replacer(input, context);\n\n        // If the replacer made a substitution there is no need to decscend further. IFluidHandles are always\n        // leaves in the object graph.\n        if (maybeReplaced !== input) {\n            return maybeReplaced;\n        }\n\n        // Otherwise descend into the object graph looking for IFluidHandle instances.\n        // eslint-disable-next-line @typescript-eslint/ban-types\n        let clone: object | undefined;\n        for (const key of Object.keys(input)) {\n            const value = input[key];\n            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n            if (!!value && typeof value === \"object\") {\n                // Note: Except for IFluidHandle, `input` must not contain circular references (as object must\n                //       be JSON serializable.)  Therefore, guarding against infinite recursion here would only\n                //       lead to a later error when attempting to stringify().\n                const replaced = this.recursivelyReplace(value, replacer, context);\n\n                // If the `replaced` object is different than the original `value` then the subgraph contained one\n                // or more handles.  If this happens, we need to return a clone of the `input` object where the\n                // current property is replaced by the `replaced` value.\n                if (replaced !== value) {\n                    // Lazily create a shallow clone of the `input` object if we haven't done so already.\n                    clone = clone ?? (Array.isArray(input)\n                        ? [...input]\n                        : { ...input });\n\n                    // Overwrite the current property `key` in the clone with the `replaced` value.\n                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                    clone![key] = replaced;\n                }\n            }\n        }\n        return clone ?? input;\n    }\n\n    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {\n        bind.bind(handle);\n        return {\n            type: \"__fluid_handle__\",\n            url: handle.absolutePath,\n        };\n    }\n}\n"]}
+{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iEAAiE;AACjE,wDAAwD;AAExD,iEAA0E;AAE1E,6DAA+D;AAaxD,MAAM,kBAAkB,GAAG,CAAC,KAAU,EAA8B,EAAE,CACzE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,kBAAkB,CAAC;AAD1B,QAAA,kBAAkB,sBACQ;AAmCvC;;GAEG;AACH,MAAa,eAAe;IAGxB,YACqB,OAA4B;IAC7C,+DAA+D;IAC9C,cAA8C;QAF9C,YAAO,GAAP,OAAO,CAAqB;QAE5B,mBAAc,GAAd,cAAc,CAAgC;QA0DnE,6EAA6E;QAC7E,iFAAiF;QAChE,gBAAW,GAAG,CAAC,KAAU,EAAE,IAAkB,EAAE,EAAE;YAC9D,wCAAwC;YACxC,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAC;YAEnC,yDAAyD;YACzD,OAAO,MAAM,KAAK,SAAS;gBACvB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;gBACpC,CAAC,CAAC,KAAK,CAAC;QAChB,CAAC,CAAC;QAEF,qFAAqF;QACrF,6EAA6E;QAC5D,gBAAW,GAAG,CAAC,KAAU,EAAE,EAAE;YAC1C,0EAA0E;YAC1E,IAAI,IAAA,0BAAkB,EAAC,KAAK,CAAC,EAAE;gBAC3B,kGAAkG;gBAClG,4FAA4F;gBAC5F,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;oBAC1C,CAAC,CAAC,KAAK,CAAC,GAAG;oBACX,CAAC,CAAC,IAAA,yCAAyB,EAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEzD,MAAM,YAAY,GAAG,IAAI,4CAAuB,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1E,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;gBAClC,OAAO,YAAY,CAAC;aACvB;iBAAM;gBACH,OAAO,KAAK,CAAC;aAChB;QACL,CAAC,CAAC;QArFE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;SACtC;IACL,CAAC;IAED,IAAW,gBAAgB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE9C;;;;;;;;OAQG;IACK,MAAM,CACV,KAAU,EACV,IAAkB;QAElB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC;YACxD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAU;QACrB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC;YAClD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,KAAU,EAAE,IAAkB;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,kGAAkG;IAC3F,KAAK,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,CAAC;IAiCD,mFAAmF;IACnF,0FAA0F;IAC1F,gCAAgC;IACxB,kBAAkB,CACtB,KAAU,EACV,QAA2C,EAC3C,OAAa;QAEb,+EAA+E;QAC/E,4CAA4C;QAE5C,yGAAyG;QACzG,wBAAwB;QACxB,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE/C,qGAAqG;QACrG,8BAA8B;QAC9B,IAAI,aAAa,KAAK,KAAK,EAAE;YACzB,OAAO,aAAa,CAAC;SACxB;QAED,8EAA8E;QAC9E,IAAI,KAAyB,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAClC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACzB,yEAAyE;YACzE,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACtC,8FAA8F;gBAC9F,+FAA+F;gBAC/F,8DAA8D;gBAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAEnE,kGAAkG;gBAClG,+FAA+F;gBAC/F,wDAAwD;gBACxD,IAAI,QAAQ,KAAK,KAAK,EAAE;oBACpB,qFAAqF;oBACrF,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;wBAClC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;wBACZ,CAAC,mBAAM,KAAK,CAAE,CAAC,CAAC;oBAEpB,+EAA+E;oBAC/E,oEAAoE;oBACpE,KAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBAC1B;aACJ;SACJ;QACD,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC;IAC1B,CAAC;IAES,eAAe,CAAC,MAAoB,EAAE,IAAkB;QAC9D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,OAAO;YACH,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,MAAM,CAAC,YAAY;SAC3B,CAAC;IACN,CAAC;CACJ;AAxJD,0CAwJC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// RATIONALE: Many methods consume and return 'any' by necessity.\n/* eslint-disable @typescript-eslint/no-unsafe-return */\n\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { RemoteFluidObjectHandle } from \"./remoteObjectHandle\";\n\n/**\n * JSON serialized form of an IFluidHandle\n */\n export interface ISerializedHandle {\n    // Marker to indicate to JSON.parse that the object is a Fluid handle\n    type: \"__fluid_handle__\";\n\n    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.\n    url: string;\n}\n\nexport const isSerializedHandle = (value: any): value is ISerializedHandle =>\n    value?.type === \"__fluid_handle__\";\n\nexport interface IFluidSerializer {\n    /**\n     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n     * where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     */\n    encode(value: any, bind: IFluidHandle): any;\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n    decode(input: any): any;\n\n    /**\n     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.\n     */\n    stringify(value: any, bind: IFluidHandle): string;\n\n    /**\n     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid\n     * handles will be realized as part of the parse\n     */\n    parse(value: string): any;\n}\n\n/**\n * Data Store serializer implementation\n */\nexport class FluidSerializer implements IFluidSerializer {\n    private readonly root: IFluidHandleContext;\n\n    public constructor(\n        private readonly context: IFluidHandleContext,\n        // To be called whenever a handle is parsed by this serializer.\n        private readonly handleParsedCb: (handle: IFluidHandle) => void,\n    ) {\n        this.root = this.context;\n        while (this.root.routeContext !== undefined) {\n            this.root = this.root.routeContext;\n        }\n    }\n\n    public get IFluidSerializer() { return this; }\n\n    /**\n     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a\n     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * Any unbound handles encountered are bound to the provided IFluidHandle.\n     */\n     public encode(\n        input: any,\n        bind: IFluidHandle,\n    ) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.encodeValue, bind)\n            : input;\n    }\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n     public decode(input: any) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.decodeValue)\n            : input;\n    }\n\n    public stringify(input: any, bind: IFluidHandle) {\n        return JSON.stringify(input, (key, value) => this.encodeValue(value, bind));\n    }\n\n    // Parses the serialized data - context must match the context with which the JSON was stringified\n    public parse(input: string) {\n        return JSON.parse(input, (key, value) => this.decodeValue(value));\n    }\n\n    // If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'encode()' and 'stringify()'.\n    private readonly encodeValue = (value: any, bind: IFluidHandle) => {\n        // Detect if 'value' is an IFluidHandle.\n        const handle = value?.IFluidHandle;\n\n        // If 'value' is an IFluidHandle return its encoded form.\n        return handle !== undefined\n            ? this.serializeHandle(handle, bind)\n            : value;\n    };\n\n    // If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.\n    private readonly decodeValue = (value: any) => {\n        // If 'value' is a serialized IFluidHandle return the deserialized result.\n        if (isSerializedHandle(value)) {\n            // Old documents may have handles with relative path in their summaries. Convert these to absolute\n            // paths. This will ensure that future summaries will have absolute paths for these handles.\n            const absolutePath = value.url.startsWith(\"/\")\n                ? value.url\n                : generateHandleContextPath(value.url, this.context);\n\n            const parsedHandle = new RemoteFluidObjectHandle(absolutePath, this.root);\n            this.handleParsedCb(parsedHandle);\n            return parsedHandle;\n        } else {\n            return value;\n        }\n    };\n\n    // Invoked for non-null objects to recursively replace references to IFluidHandles.\n    // Clones as-needed to avoid mutating the `input` object.  If no IFluidHandes are present,\n    // returns the original `input`.\n    private recursivelyReplace(\n        input: any,\n        replacer: (input: any, context: any) => any,\n        context?: any,\n    ) {\n        // Note: Caller is responsible for ensuring that `input` is defined / non-null.\n        //       (Required for Object.keys() below.)\n\n        // Execute the `replace` on the current input.  Note that Caller is responsible for ensuring that `input`\n        // is a non-null object.\n        const maybeReplaced = replacer(input, context);\n\n        // If the replacer made a substitution there is no need to decscend further. IFluidHandles are always\n        // leaves in the object graph.\n        if (maybeReplaced !== input) {\n            return maybeReplaced;\n        }\n\n        // Otherwise descend into the object graph looking for IFluidHandle instances.\n        let clone: object | undefined;\n        for (const key of Object.keys(input)) {\n            const value = input[key];\n            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n            if (!!value && typeof value === \"object\") {\n                // Note: Except for IFluidHandle, `input` must not contain circular references (as object must\n                //       be JSON serializable.)  Therefore, guarding against infinite recursion here would only\n                //       lead to a later error when attempting to stringify().\n                const replaced = this.recursivelyReplace(value, replacer, context);\n\n                // If the `replaced` object is different than the original `value` then the subgraph contained one\n                // or more handles.  If this happens, we need to return a clone of the `input` object where the\n                // current property is replaced by the `replaced` value.\n                if (replaced !== value) {\n                    // Lazily create a shallow clone of the `input` object if we haven't done so already.\n                    clone = clone ?? (Array.isArray(input)\n                        ? [...input]\n                        : { ...input });\n\n                    // Overwrite the current property `key` in the clone with the `replaced` value.\n                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                    clone![key] = replaced;\n                }\n            }\n        }\n        return clone ?? input;\n    }\n\n    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {\n        bind.bind(handle);\n        return {\n            type: \"__fluid_handle__\",\n            url: handle.absolutePath,\n        };\n    }\n}\n"]}

package/dist/sharedObject.d.ts

@@ -6,7 +6,7 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService, IChannelServices } from "@fluidframework/datastore-definitions";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
-import { IGarbageCollectionData, ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
 import { EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
 import { IFluidSerializer } from "./serializer";
 import { SummarySerializer } from "./summarySerializer";
@@ -102,11 +102,11 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */
-    abstract getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;
+    abstract getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    abstract summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;
+    abstract summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
     /**
      * {@inheritDoc (ISharedObject:interface).getGCData}
      */
@@ -198,6 +198,10 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
      * @param localOpMetadata - The local metadata associated with the original message.
      */
     private reSubmit;
+    /**
+     * Revert an op
+     */
+    protected rollback(content: any, localOpMetadata: unknown): void;
     /**
      * Apply changes from an op. Used when rehydrating an attached container
      * with pending changes. This prepares the SharedObject for seeing an ACK
@@ -213,6 +217,7 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
  */
 export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
+    private readonly telemetryContextPrefix;
     /**
      * True while we are garbage collecting this object's data.
      */
@@ -227,15 +232,15 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * @param runtime - The IFluidDataStoreRuntime which contains the shared object
      * @param attributes - Attributes of the shared object
      */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */
-    getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;
+    getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
     /**
      * {@inheritDoc (ISharedObject:interface).getGCData}
      */
@@ -249,6 +254,7 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * Gets a form of the object that can be serialized.
      * @returns A tree representing the snapshot of the shared object.
      */
-    protected abstract summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    protected abstract summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    private incrementTelemetryMetric;
 }
 //# sourceMappingURL=sharedObject.d.ts.map

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,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAe,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAE7F,OAAO,EAAmB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE7D;;GAEG;AACH,8BAAsB,gBAAgB,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAC3F,SAAQ,6BAA6B,CAAC,MAAM,CAAE,YAAW,aAAa,CAAC,MAAM,CAAC;IA+CnE,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IAhDlD,IAAW,cAAc,SAAmB;IAE5C;;OAEG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;gBAEQ,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IAiBlD;;;;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;IAU5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,qBAAqB;IAEjG;;OAEG;aACa,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAEnG;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,YAAY;IAOnD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;;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;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;CAC3D;AAED;;;GAGG;AACH,8BAAsB,YAAY,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvF,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAW3C;IAED;;;;OAIG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IASlC;;OAEG;IACI,gBAAgB,CAAC,QAAQ,GAAE,OAAe,EAAE,UAAU,GAAE,OAAe,GAAG,qBAAqB;IAItG;;OAEG;IACU,SAAS,CAAC,QAAQ,GAAE,OAAe,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI9G;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAwBjE;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,iBAAiB;IAOzD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;CACxF"}
+{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGtE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EAGpB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAe,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAE7F,OAAO,EAAmB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE7D;;GAEG;AACH,8BAAsB,gBAAgB,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAC3F,SAAQ,6BAA6B,CAAC,MAAM,CAAE,YAAW,aAAa,CAAC,MAAM,CAAC;IA+CnE,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IAhDlD,IAAW,cAAc,SAAmB;IAE5C;;OAEG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;gBAEQ,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IAmBlD;;;;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;IAU5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAC5B,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB;IAExB;;OAEG;aACa,SAAS,CACrB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,qBAAqB,CAAC;IAEjC;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,YAAY;IAOnD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;;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;IA+B1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAOf;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAIzD;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;CAC3D;AAED;;;GAGG;AACH,8BAAsB,YAAY,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvF,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IAiC5B,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAhC3C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAW3C;IAED;;;;OAIG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EACb,sBAAsB,EAAE,MAAM;IAUnD;;OAEG;IACI,gBAAgB,CACnB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB;IAOxB;;OAEG;IACU,SAAS,CAClB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,qBAAqB,CAAC;IAOjC;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAwBjE;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,iBAAiB;IAOzD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAC5B,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB;IAExB,OAAO,CAAC,wBAAwB;CAInC"}

package/dist/sharedObject.js

@@ -8,6 +8,7 @@ exports.SharedObject = exports.SharedObjectCore = void 0;
 const uuid_1 = require("uuid");
 const common_utils_1 = require("@fluidframework/common-utils");
 const container_definitions_1 = require("@fluidframework/container-definitions");
+const runtime_definitions_1 = require("@fluidframework/runtime-definitions");
 const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 const container_utils_1 = require("@fluidframework/container-utils");
 const serializer_1 = require("./serializer");
@@ -35,6 +36,7 @@ class SharedObjectCore extends telemetry_utils_1.EventEmitterWithErrorHandling {
          * True if the dds is bound to its parent.
          */
         this._isBoundToContext = false;
+        (0, common_utils_1.assert)(!id.includes("/"), 0x304 /* Id cannot contain slashes */);
         this.handle = new handle_1.SharedObjectHandle(this, id, runtime.IFluidHandleContext);
         this.logger = telemetry_utils_1.ChildLogger.create(runtime.logger, undefined, { all: { sharedObjectId: (0, uuid_1.v4)() } });
         this.attachListeners();
@@ -243,6 +245,9 @@ class SharedObjectCore extends telemetry_utils_1.EventEmitterWithErrorHandling {
             applyStashedOp: (content) => {
                 return this.applyStashedOp(content);
             },
+            rollback: (content, localOpMetadata) => {
+                this.rollback(content, localOpMetadata);
+            },
         });
         // Trigger initial state
         // attachDeltaHandler is only called after services is assigned
@@ -268,7 +273,7 @@ class SharedObjectCore extends telemetry_utils_1.EventEmitterWithErrorHandling {
             this.onDisconnect();
         }
         else {
-            // Call this for now so that DDSes like ConsensesOrderedCollection that maintain their own pending
+            // Call this for now so that DDSes like ConsensusOrderedCollection that maintain their own pending
             // messages will work.
             this.onConnect();
         }
@@ -295,6 +300,12 @@ class SharedObjectCore extends telemetry_utils_1.EventEmitterWithErrorHandling {
     reSubmit(content, localOpMetadata) {
         this.reSubmitCore(content, localOpMetadata);
     }
+    /**
+     * Revert an op
+     */
+    rollback(content, localOpMetadata) {
+        throw new Error("rollback not supported");
+    }
 }
 exports.SharedObjectCore = SharedObjectCore;
 /**
@@ -307,8 +318,9 @@ class SharedObject extends SharedObjectCore {
      * @param runtime - The IFluidDataStoreRuntime which contains the shared object
      * @param attributes - Attributes of the shared object
      */
-    constructor(id, runtime, attributes) {
+    constructor(id, runtime, attributes, telemetryContextPrefix) {
         super(id, runtime, attributes);
+        this.telemetryContextPrefix = telemetryContextPrefix;
         /**
          * True while we are garbage collecting this object's data.
          */
@@ -329,14 +341,20 @@ class SharedObject extends SharedObjectCore {
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */
-    getAttachSummary(fullTree = false, trackState = false) {
-        return this.summarizeCore(this.serializer);
+    getAttachSummary(fullTree = false, trackState = false, telemetryContext) {
+        const result = this.summarizeCore(this.serializer, telemetryContext);
+        this.incrementTelemetryMetric(runtime_definitions_1.blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);
+        this.incrementTelemetryMetric(runtime_definitions_1.totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);
+        return result;
     }
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    async summarize(fullTree = false, trackState = false) {
-        return this.summarizeCore(this.serializer);
+    async summarize(fullTree = false, trackState = false, telemetryContext) {
+        const result = this.summarizeCore(this.serializer, telemetryContext);
+        this.incrementTelemetryMetric(runtime_definitions_1.blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);
+        this.incrementTelemetryMetric(runtime_definitions_1.totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);
+        return result;
     }
     /**
      * {@inheritDoc (ISharedObject:interface).getGCData}
@@ -370,6 +388,11 @@ class SharedObject extends SharedObjectCore {
         // See: https://github.com/microsoft/FluidFramework/issues/4547
         this.summarizeCore(serializer);
     }
+    incrementTelemetryMetric(propertyName, incrementBy, telemetryContext) {
+        var _a;
+        const prevTotal = ((_a = telemetryContext === null || telemetryContext === void 0 ? void 0 : telemetryContext.get(this.telemetryContextPrefix, propertyName)) !== null && _a !== void 0 ? _a : 0);
+        telemetryContext === null || telemetryContext === void 0 ? void 0 : telemetryContext.set(this.telemetryContextPrefix, propertyName, prevTotal + incrementBy);
+    }
 }
 exports.SharedObject = SharedObject;
 //# sourceMappingURL=sharedObject.js.map

package/dist/sharedObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedObject.js","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAElC,+DAA6E;AAC7E,iFAAoE;AAapE,qEAA6F;AAC7F,qEAAsE;AACtE,6CAAiE;AACjE,qCAA8C;AAC9C,2DAAwD;AAGxD;;GAEG;AACH,MAAsB,gBAClB,SAAQ,+CAAqC;IAyC7C;;;;OAIG;IACH,YACW,EAAU,EACP,OAA+B,EACzB,UAA8B;QAC9C,KAAK,CAAC,CAAC,KAA4B,EAAE,CAAM,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAHnF,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QApClD;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QA0BvC,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,IAAA,SAAI,GAAE,EAAE,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IA/DD,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAgC5C;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IA2BD;;;;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,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;IAiBD;;;;OAIG;IACO,aAAa,CAAC,aAA2B;;QAC/C,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACnB,mGAAmG;YACnG,MAAA,MAAA,IAAI,CAAC,QAAQ,gDAAE,eAAe,EAAC,wBAAwB,mDAAG,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SACzF;IACL,CAAC;IAQD;;OAEG;IACO,mBAAmB;QACzB,OAAO;IACX,CAAC;IAED;;;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,IAAA,qBAAM,EAAC,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;CAWJ;AAxYD,4CAwYC;AAED;;;GAGG;AACH,MAAsB,YAClB,SAAQ,gBAAwB;IAwBhC;;;;OAIG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAC9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAhCnC;;WAEG;QACK,aAAQ,GAAY,KAAK,CAAC;QA+B9B,IAAI,CAAC,WAAW,GAAG,IAAI,4BAAe,CAClC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;IACN,CAAC;IA5BD,IAAc,UAAU;QACpB;;;;;;WAMG;QACH,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,EACjB,KAAK,CAAC,6EAA6E,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAmBD;;OAEG;IACI,gBAAgB,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QAC1E,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QACzE,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,4GAA4G;QAC5G,yBAAyB;QACzB,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,wEAAwE,CAAC,CAAC;QACvG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,MAA8B,CAAC;QACnC,IAAI;YACA,MAAM,UAAU,GAAG,IAAI,qCAAiB,CACpC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;YACF,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACnC,yGAAyG;YACzG,qDAAqD;YACrD,MAAM,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,mBAAmB,EAAE,EAAE,EAAE,CAAC;YAChE,IAAA,qBAAM,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACpG;gBAAS;YACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACzB;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,UAA6B;QACrD,wGAAwG;QACxG,2GAA2G;QAC3G,+DAA+D;QAC/D,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;CAOJ;AAnGD,oCAmGC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, EventEmitterEventType } from \"@fluidframework/common-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    ISummaryTreeWithStats,\n} from \"@fluidframework/runtime-definitions\";\nimport { ChildLogger, EventEmitterWithErrorHandling } from \"@fluidframework/telemetry-utils\";\nimport { DataProcessingError } from \"@fluidframework/container-utils\";\nimport { FluidSerializer, IFluidSerializer } from \"./serializer\";\nimport { SharedObjectHandle } from \"./handle\";\nimport { SummarySerializer } from \"./summarySerializer\";\nimport { ISharedObject, ISharedObjectEvents } from \"./types\";\n\n/**\n *  Base class from which all shared objects derive\n */\nexport abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {\n    public get IFluidLoadable() { return this; }\n\n    /**\n     * The handle referring to this SharedObject\n     */\n    public readonly handle: IFluidHandle;\n\n    /**\n     * Telemetry logger for the shared object\n     */\n    protected readonly logger: ITelemetryLogger;\n\n    /**\n     * Connection state\n     */\n    private _connected = false;\n\n    /**\n     * Services used by the shared object\n     */\n    private services: IChannelServices | undefined;\n\n    /**\n     * True if the dds is bound to its parent.\n     */\n    private _isBoundToContext: boolean = false;\n\n    /**\n     * Tracks error that closed this object.\n     */\n    private closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;\n\n    /**\n     * Gets the connection state\n     * @returns The state of the connection\n     */\n    public get connected(): boolean {\n        return this._connected;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        public id: string,\n        protected runtime: IFluidDataStoreRuntime,\n        public readonly attributes: IChannelAttributes) {\n        super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));\n\n        this.handle = new SharedObjectHandle(\n            this,\n            id,\n            runtime.IFluidHandleContext);\n\n        this.logger = ChildLogger.create(\n            runtime.logger,\n            undefined,\n            { all: { sharedObjectId: uuid() } },\n        );\n\n        this.attachListeners();\n    }\n\n    /**\n     * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)\n     * would result in same error thrown. If called multiple times, only first error is remembered.\n     * @param error - error object that is thrown whenever an attempt is made to modify this object\n     */\n    private closeWithError(error: any) {\n        if (this.closeError === undefined) {\n            this.closeError = error;\n        }\n    }\n\n    /**\n     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.\n     */\n    private verifyNotClosed() {\n        if (this.closeError !== undefined) {\n            throw this.closeError;\n        }\n    }\n\n    /**\n     * Event listener handler helper that can be used to react to exceptions thrown from event listeners\n     * It wraps error with DataProcessingError, closes this object and throws resulting error.\n     * See closeWithError() for more details\n     * Ideally such situation never happens, as consumers of DDS should never throw exceptions\n     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).\n     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.\n     * DDS state does not match what user sees. Because of it DDS moves to \"corrupted state\" and does not\n     * allow processing of ops or local changes, which very quickly results in container closure.\n     */\n    private eventListenerErrorHandler(event: EventEmitterEventType, e: any) {\n        const error = DataProcessingError.wrapIfUnrecognized(\n            e,\n            \"SharedObjectEventListenerException\");\n        error.addTelemetryProperties({ emittedEventName: String(event) });\n\n        this.closeWithError(error);\n        throw error;\n    }\n\n    private attachListeners() {\n        // Only listen to these events if not attached.\n        if (!this.isAttached()) {\n            this.runtime.once(\"attaching\", () => {\n                // Calling this will let the dds to do any custom processing based on attached\n                // like starting generating ops.\n                this.didAttach();\n            });\n        }\n    }\n\n    /**\n     * A shared object, after construction, can either be loaded in the case that it is already part of\n     * a shared document. Or later attached if it is being newly added.\n     * @param services - Services used by the shared object\n     */\n    public async load(services: IChannelServices): Promise<void> {\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.services = services;\n        }\n        await this.loadCore(services.objectStorage);\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.attachDeltaHandler();\n        }\n    }\n\n    /**\n     * Initializes the object as a local, non-shared object. This object can become shared after\n     * it is attached to the document.\n     */\n    public initializeLocal(): void {\n        this.initializeLocalCore();\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).bindToContext}\n     */\n    public bindToContext(): void {\n        if (this._isBoundToContext) {\n            return;\n        }\n\n        this._isBoundToContext = true;\n\n        this.runtime.bindChannel(this);\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}\n     */\n    public connect(services: IChannelServices) {\n        this.services = services;\n        this.attachDeltaHandler();\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).isAttached}\n     */\n    public isAttached(): boolean {\n        return this.services !== undefined && this.runtime.attachState !== AttachState.Detached;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n     */\n    public abstract getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n     */\n    public abstract summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public abstract getGCData(fullGC?: boolean): IGarbageCollectionData;\n\n    /**\n     * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference\n     * to another object in the container.\n     * @param decodedHandle - The handle of the Fluid object that is decoded.\n     */\n    protected handleDecoded(decodedHandle: IFluidHandle) {\n        if (this.isAttached()) {\n            // This represents an outbound reference from this object to the node represented by decodedHandle.\n            this.services?.deltaConnection.addedGCOutboundReference?.(this.handle, decodedHandle);\n        }\n    }\n\n    /**\n     * Allows the distributed data type to perform custom loading\n     * @param services - Storage used by the shared object\n     */\n    protected abstract loadCore(services: IChannelStorageService): Promise<void>;\n\n    /**\n     * Allows the distributed data type to perform custom local loading.\n     */\n    protected initializeLocalCore() {\n        return;\n    }\n\n    /**\n     * Allows the 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    /**\n     * Apply changes from an op. Used when rehydrating an attached container\n     * with pending changes. This prepares the SharedObject for seeing an ACK\n     * for the op or resubmitting the op upon reconnection.\n     * @param content - Contents of a stashed op.\n     * @returns localMetadata of the op, to be passed to process() or resubmit()\n     * when the op is ACKed or resubmitted, respectively\n     */\n    protected abstract applyStashedOp(content: any): unknown;\n}\n\n/**\n * SharedObject with simplified, synchronous summarization and GC.\n * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.\n */\nexport abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends SharedObjectCore<TEvent> {\n    /**\n     * True while we are garbage collecting this object's data.\n     */\n    private _isGCing: boolean = false;\n\n    /**\n     * The serializer to use to serialize / parse handles, if any.\n     */\n    private readonly _serializer: IFluidSerializer;\n\n    protected get serializer(): IFluidSerializer {\n        /**\n         * During garbage collection, the SummarySerializer keeps track of IFluidHandles that are serialized. These\n         * handles represent references to other Fluid objects.\n         *\n         * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content\n         * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.\n         */\n        assert(!this._isGCing,\n            0x075 /* \"SummarySerializer should be used for serializing data during summary.\" */);\n        return this._serializer;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes) {\n        super(id, runtime, attributes);\n\n        this._serializer = new FluidSerializer(\n            this.runtime.channelsRoutingContext,\n            (handle: IFluidHandle) => this.handleDecoded(handle),\n        );\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n     */\n    public getAttachSummary(fullTree: boolean = false, trackState: boolean = false): ISummaryTreeWithStats {\n        return this.summarizeCore(this.serializer);\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n     */\n    public async summarize(fullTree: boolean = false, trackState: boolean = false): Promise<ISummaryTreeWithStats> {\n        return this.summarizeCore(this.serializer);\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        // Set _isGCing to true. This flag is used to ensure that we only use SummarySerializer to serialize handles\n        // in this object's data.\n        assert(!this._isGCing, 0x078 /* \"Possible re-entrancy! Summary should not already be in progress.\" */);\n        this._isGCing = true;\n\n        let gcData: IGarbageCollectionData;\n        try {\n            const serializer = new SummarySerializer(\n                this.runtime.channelsRoutingContext,\n                (handle: IFluidHandle) => this.handleDecoded(handle),\n            );\n            this.processGCDataCore(serializer);\n            // The GC data for this shared object contains a single GC node. The outbound routes of this node are the\n            // routes of handles serialized during summarization.\n            gcData = { gcNodes: { \"/\": serializer.getSerializedRoutes() } };\n            assert(this._isGCing, 0x079 /* \"Possible re-entrancy! Summary should have been in progress.\" */);\n        } finally {\n            this._isGCing = false;\n        }\n\n        return gcData;\n    }\n\n    /**\n     * Calls the serializer over all data in this object that reference other GC nodes.\n     * Derived classes must override this to provide custom list of references to other GC nodes.\n     */\n    protected processGCDataCore(serializer: SummarySerializer) {\n        // We run the full summarize logic to get the list of outbound routes from this object. This is a little\n        // expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.\n        // See: https://github.com/microsoft/FluidFramework/issues/4547\n        this.summarizeCore(serializer);\n    }\n\n    /**\n     * Gets a form of the object that can be serialized.\n     * @returns A tree representing the snapshot of the shared object.\n     */\n    protected abstract summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;\n}\n"]}
+{"version":3,"file":"sharedObject.js","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAElC,+DAA6E;AAC7E,iFAAoE;AASpE,6EAM6C;AAC7C,qEAA6F;AAC7F,qEAAsE;AACtE,6CAAiE;AACjE,qCAA8C;AAC9C,2DAAwD;AAGxD;;GAEG;AACH,MAAsB,gBAClB,SAAQ,+CAAqC;IAyC7C;;;;OAIG;IACH,YACW,EAAU,EACP,OAA+B,EACzB,UAA8B;QAC9C,KAAK,CAAC,CAAC,KAA4B,EAAE,CAAM,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAHnF,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QApClD;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QA0BvC,IAAA,qBAAM,EAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAEjE,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,IAAA,SAAI,GAAE,EAAE,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAjED,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAgC5C;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IA6BD;;;;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,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;IAyBD;;;;OAIG;IACO,aAAa,CAAC,aAA2B;;QAC/C,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACnB,mGAAmG;YACnG,MAAA,MAAA,IAAI,CAAC,QAAQ,gDAAE,eAAe,EAAC,wBAAwB,mDAAG,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SACzF;IACL,CAAC;IAQD;;OAEG;IACO,mBAAmB;QACzB,OAAO;IACX,CAAC;IAED;;;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,IAAA,qBAAM,EAAC,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;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,eAAwB,EAAE,EAAE;gBACjD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAC5C,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;IAED;;OAEG;IACO,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACrD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC9C,CAAC;CAWJ;AA5ZD,4CA4ZC;AAED;;;GAGG;AACH,MAAsB,YAClB,SAAQ,gBAAwB;IAwBhC;;;;OAIG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B,EACb,sBAA8B;QAE/C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAFd,2BAAsB,GAAtB,sBAAsB,CAAQ;QAhCnD;;WAEG;QACK,aAAQ,GAAY,KAAK,CAAC;QAiC9B,IAAI,CAAC,WAAW,GAAG,IAAI,4BAAe,CAClC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;IACN,CAAC;IA9BD,IAAc,UAAU;QACpB;;;;;;WAMG;QACH,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,EACjB,KAAK,CAAC,6EAA6E,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAqBD;;OAEG;IACI,gBAAgB,CACnB,WAAoB,KAAK,EACzB,aAAsB,KAAK,EAC3B,gBAAoC;QAEpC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACrE,IAAI,CAAC,wBAAwB,CAAC,2CAAqB,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACnG,IAAI,CAAC,wBAAwB,CAAC,+CAAyB,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACvG,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAClB,WAAoB,KAAK,EACzB,aAAsB,KAAK,EAC3B,gBAAoC;QAEpC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACrE,IAAI,CAAC,wBAAwB,CAAC,2CAAqB,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACnG,IAAI,CAAC,wBAAwB,CAAC,+CAAyB,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACvG,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,4GAA4G;QAC5G,yBAAyB;QACzB,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,wEAAwE,CAAC,CAAC;QACvG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,MAA8B,CAAC;QACnC,IAAI;YACA,MAAM,UAAU,GAAG,IAAI,qCAAiB,CACpC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;YACF,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACnC,yGAAyG;YACzG,qDAAqD;YACrD,MAAM,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,mBAAmB,EAAE,EAAE,EAAE,CAAC;YAChE,IAAA,qBAAM,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACpG;gBAAS;YACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACzB;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,UAA6B;QACrD,wGAAwG;QACxG,2GAA2G;QAC3G,+DAA+D;QAC/D,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;IAWO,wBAAwB,CAAC,YAAoB,EAAE,WAAmB,EAAE,gBAAoC;;QAC5G,MAAM,SAAS,GAAG,CAAC,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,CAAC,mCAAI,CAAC,CAAW,CAAC;QACpG,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,EAAE,SAAS,GAAG,WAAW,CAAC,CAAC;IAC9F,CAAC;CACJ;AA3HD,oCA2HC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, EventEmitterEventType } from \"@fluidframework/common-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    ISummaryTreeWithStats,\n    ITelemetryContext,\n    blobCountPropertyName,\n    totalBlobSizePropertyName,\n} from \"@fluidframework/runtime-definitions\";\nimport { ChildLogger, EventEmitterWithErrorHandling } from \"@fluidframework/telemetry-utils\";\nimport { DataProcessingError } from \"@fluidframework/container-utils\";\nimport { FluidSerializer, IFluidSerializer } from \"./serializer\";\nimport { SharedObjectHandle } from \"./handle\";\nimport { SummarySerializer } from \"./summarySerializer\";\nimport { ISharedObject, ISharedObjectEvents } from \"./types\";\n\n/**\n *  Base class from which all shared objects derive\n */\nexport abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {\n    public get IFluidLoadable() { return this; }\n\n    /**\n     * The handle referring to this SharedObject\n     */\n    public readonly handle: IFluidHandle;\n\n    /**\n     * Telemetry logger for the shared object\n     */\n    protected readonly logger: ITelemetryLogger;\n\n    /**\n     * Connection state\n     */\n    private _connected = false;\n\n    /**\n     * Services used by the shared object\n     */\n    private services: IChannelServices | undefined;\n\n    /**\n     * True if the dds is bound to its parent.\n     */\n    private _isBoundToContext: boolean = false;\n\n    /**\n     * Tracks error that closed this object.\n     */\n    private closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;\n\n    /**\n     * Gets the connection state\n     * @returns The state of the connection\n     */\n    public get connected(): boolean {\n        return this._connected;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        public id: string,\n        protected runtime: IFluidDataStoreRuntime,\n        public readonly attributes: IChannelAttributes) {\n        super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));\n\n        assert(!id.includes(\"/\"), 0x304 /* Id cannot contain slashes */);\n\n        this.handle = new SharedObjectHandle(\n            this,\n            id,\n            runtime.IFluidHandleContext);\n\n        this.logger = ChildLogger.create(\n            runtime.logger,\n            undefined,\n            { all: { sharedObjectId: uuid() } },\n        );\n\n        this.attachListeners();\n    }\n\n    /**\n     * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)\n     * would result in same error thrown. If called multiple times, only first error is remembered.\n     * @param error - error object that is thrown whenever an attempt is made to modify this object\n     */\n    private closeWithError(error: any) {\n        if (this.closeError === undefined) {\n            this.closeError = error;\n        }\n    }\n\n    /**\n     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.\n     */\n    private verifyNotClosed() {\n        if (this.closeError !== undefined) {\n            throw this.closeError;\n        }\n    }\n\n    /**\n     * Event listener handler helper that can be used to react to exceptions thrown from event listeners\n     * It wraps error with DataProcessingError, closes this object and throws resulting error.\n     * See closeWithError() for more details\n     * Ideally such situation never happens, as consumers of DDS should never throw exceptions\n     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).\n     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.\n     * DDS state does not match what user sees. Because of it DDS moves to \"corrupted state\" and does not\n     * allow processing of ops or local changes, which very quickly results in container closure.\n     */\n    private eventListenerErrorHandler(event: EventEmitterEventType, e: any) {\n        const error = DataProcessingError.wrapIfUnrecognized(\n            e,\n            \"SharedObjectEventListenerException\");\n        error.addTelemetryProperties({ emittedEventName: String(event) });\n\n        this.closeWithError(error);\n        throw error;\n    }\n\n    private attachListeners() {\n        // Only listen to these events if not attached.\n        if (!this.isAttached()) {\n            this.runtime.once(\"attaching\", () => {\n                // Calling this will let the dds to do any custom processing based on attached\n                // like starting generating ops.\n                this.didAttach();\n            });\n        }\n    }\n\n    /**\n     * A shared object, after construction, can either be loaded in the case that it is already part of\n     * a shared document. Or later attached if it is being newly added.\n     * @param services - Services used by the shared object\n     */\n    public async load(services: IChannelServices): Promise<void> {\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.services = services;\n        }\n        await this.loadCore(services.objectStorage);\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.attachDeltaHandler();\n        }\n    }\n\n    /**\n     * Initializes the object as a local, non-shared object. This object can become shared after\n     * it is attached to the document.\n     */\n    public initializeLocal(): void {\n        this.initializeLocalCore();\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).bindToContext}\n     */\n    public bindToContext(): void {\n        if (this._isBoundToContext) {\n            return;\n        }\n\n        this._isBoundToContext = true;\n\n        this.runtime.bindChannel(this);\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}\n     */\n    public connect(services: IChannelServices) {\n        this.services = services;\n        this.attachDeltaHandler();\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).isAttached}\n     */\n    public isAttached(): boolean {\n        return this.services !== undefined && this.runtime.attachState !== AttachState.Detached;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n     */\n    public abstract getAttachSummary(\n        fullTree?: boolean,\n        trackState?: boolean,\n        telemetryContext?: ITelemetryContext,\n    ): ISummaryTreeWithStats;\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n     */\n    public abstract summarize(\n        fullTree?: boolean,\n        trackState?: boolean,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public abstract getGCData(fullGC?: boolean): IGarbageCollectionData;\n\n    /**\n     * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference\n     * to another object in the container.\n     * @param decodedHandle - The handle of the Fluid object that is decoded.\n     */\n    protected handleDecoded(decodedHandle: IFluidHandle) {\n        if (this.isAttached()) {\n            // This represents an outbound reference from this object to the node represented by decodedHandle.\n            this.services?.deltaConnection.addedGCOutboundReference?.(this.handle, decodedHandle);\n        }\n    }\n\n    /**\n     * Allows the distributed data type to perform custom loading\n     * @param services - Storage used by the shared object\n     */\n    protected abstract loadCore(services: IChannelStorageService): Promise<void>;\n\n    /**\n     * Allows the distributed data type to perform custom local loading.\n     */\n    protected initializeLocalCore() {\n        return;\n    }\n\n    /**\n     * Allows the 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            rollback: (content: any, localOpMetadata: unknown) => {\n                this.rollback(content, localOpMetadata);\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 ConsensusOrderedCollection 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    /**\n     * Revert an op\n     */\n    protected rollback(content: any, localOpMetadata: unknown) {\n        throw new Error(\"rollback not supported\");\n    }\n\n    /**\n     * Apply changes from an op. Used when rehydrating an attached container\n     * with pending changes. This prepares the SharedObject for seeing an ACK\n     * for the op or resubmitting the op upon reconnection.\n     * @param content - Contents of a stashed op.\n     * @returns localMetadata of the op, to be passed to process() or resubmit()\n     * when the op is ACKed or resubmitted, respectively\n     */\n    protected abstract applyStashedOp(content: any): unknown;\n}\n\n/**\n * SharedObject with simplified, synchronous summarization and GC.\n * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.\n */\nexport abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends SharedObjectCore<TEvent> {\n    /**\n     * True while we are garbage collecting this object's data.\n     */\n    private _isGCing: boolean = false;\n\n    /**\n     * The serializer to use to serialize / parse handles, if any.\n     */\n    private readonly _serializer: IFluidSerializer;\n\n    protected get serializer(): IFluidSerializer {\n        /**\n         * During garbage collection, the SummarySerializer keeps track of IFluidHandles that are serialized. These\n         * handles represent references to other Fluid objects.\n         *\n         * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content\n         * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.\n         */\n        assert(!this._isGCing,\n            0x075 /* \"SummarySerializer should be used for serializing data during summary.\" */);\n        return this._serializer;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        private readonly telemetryContextPrefix: string,\n    ) {\n        super(id, runtime, attributes);\n\n        this._serializer = new FluidSerializer(\n            this.runtime.channelsRoutingContext,\n            (handle: IFluidHandle) => this.handleDecoded(handle),\n        );\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n     */\n    public getAttachSummary(\n        fullTree: boolean = false,\n        trackState: boolean = false,\n        telemetryContext?: ITelemetryContext,\n    ): ISummaryTreeWithStats {\n        const result = this.summarizeCore(this.serializer, telemetryContext);\n        this.incrementTelemetryMetric(blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);\n        this.incrementTelemetryMetric(totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);\n        return result;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n     */\n    public async summarize(\n        fullTree: boolean = false,\n        trackState: boolean = false,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummaryTreeWithStats> {\n        const result = this.summarizeCore(this.serializer, telemetryContext);\n        this.incrementTelemetryMetric(blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);\n        this.incrementTelemetryMetric(totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);\n        return result;\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        // Set _isGCing to true. This flag is used to ensure that we only use SummarySerializer to serialize handles\n        // in this object's data.\n        assert(!this._isGCing, 0x078 /* \"Possible re-entrancy! Summary should not already be in progress.\" */);\n        this._isGCing = true;\n\n        let gcData: IGarbageCollectionData;\n        try {\n            const serializer = new SummarySerializer(\n                this.runtime.channelsRoutingContext,\n                (handle: IFluidHandle) => this.handleDecoded(handle),\n            );\n            this.processGCDataCore(serializer);\n            // The GC data for this shared object contains a single GC node. The outbound routes of this node are the\n            // routes of handles serialized during summarization.\n            gcData = { gcNodes: { \"/\": serializer.getSerializedRoutes() } };\n            assert(this._isGCing, 0x079 /* \"Possible re-entrancy! Summary should have been in progress.\" */);\n        } finally {\n            this._isGCing = false;\n        }\n\n        return gcData;\n    }\n\n    /**\n     * Calls the serializer over all data in this object that reference other GC nodes.\n     * Derived classes must override this to provide custom list of references to other GC nodes.\n     */\n    protected processGCDataCore(serializer: SummarySerializer) {\n        // We run the full summarize logic to get the list of outbound routes from this object. This is a little\n        // expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.\n        // See: https://github.com/microsoft/FluidFramework/issues/4547\n        this.summarizeCore(serializer);\n    }\n\n    /**\n     * Gets a form of the object that can be serialized.\n     * @returns A tree representing the snapshot of the shared object.\n     */\n    protected abstract summarizeCore(\n        serializer: IFluidSerializer,\n        telemetryContext?: ITelemetryContext,\n    ): ISummaryTreeWithStats;\n\n    private incrementTelemetryMetric(propertyName: string, incrementBy: number, telemetryContext?: ITelemetryContext) {\n        const prevTotal = (telemetryContext?.get(this.telemetryContextPrefix, propertyName) ?? 0) as number;\n        telemetryContext?.set(this.telemetryContextPrefix, propertyName, prevTotal + incrementBy);\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.59.4001";
+export declare const pkgVersion = "1.1.0-75972";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,cAAc,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,gBAAgB,CAAC"}

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.59.4001";
+export const pkgVersion = "1.1.0-75972";
 //# 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,WAAW,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.59.4001\";\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,aAAa,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 = \"1.1.0-75972\";\n"]}

package/lib/serializer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAGpF;;GAEG;AACF,MAAM,WAAW,iBAAiB;IAE/B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,kBAAkB,UAAW,GAAG,+BACP,CAAC;AAEvC,MAAM,WAAW,gBAAgB;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,GAAG,CAAC;IAE5C;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,gBAAgB;IAIhD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAExB,OAAO,CAAC,QAAQ,CAAC,cAAc;IALnC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAsB;gBAGtB,OAAO,EAAE,mBAAmB,EAE5B,cAAc,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI;IAQnE,IAAW,gBAAgB,SAAmB;IAE9C;;;;;;;;OAQG;IACK,MAAM,CACV,KAAK,EAAE,GAAG,EACV,IAAI,EAAE,YAAY;IAUtB;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAK,EAAE,GAAG;IASlB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY;IAKxC,KAAK,CAAC,KAAK,EAAE,MAAM;IAM1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAQ1B;IAIF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAe1B;IAKF,OAAO,CAAC,kBAAkB;IAgD1B,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY;;;;CAOrE"}
+{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAGpF;;GAEG;AACF,MAAM,WAAW,iBAAiB;IAE/B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,kBAAkB,UAAW,GAAG,+BACP,CAAC;AAEvC,MAAM,WAAW,gBAAgB;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,GAAG,CAAC;IAE5C;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,gBAAgB;IAIhD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAExB,OAAO,CAAC,QAAQ,CAAC,cAAc;IALnC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAsB;gBAGtB,OAAO,EAAE,mBAAmB,EAE5B,cAAc,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI;IAQnE,IAAW,gBAAgB,SAAmB;IAE9C;;;;;;;;OAQG;IACK,MAAM,CACV,KAAK,EAAE,GAAG,EACV,IAAI,EAAE,YAAY;IAUtB;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAK,EAAE,GAAG;IASlB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY;IAKxC,KAAK,CAAC,KAAK,EAAE,MAAM;IAM1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAQ1B;IAIF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAe1B;IAKF,OAAO,CAAC,kBAAkB;IA+C1B,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY;;;;CAOrE"}

package/lib/serializer.js

@@ -106,7 +106,6 @@ export class FluidSerializer {
             return maybeReplaced;
         }
         // Otherwise descend into the object graph looking for IFluidHandle instances.
-        // eslint-disable-next-line @typescript-eslint/ban-types
         let clone;
         for (const key of Object.keys(input)) {
             const value = input[key];

package/lib/serializer.js.map

@@ -1 +1 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,iEAAiE;AACjE,wDAAwD;AAExD,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAa/D,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAU,EAA8B,EAAE,CACzE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,kBAAkB,CAAC;AAmCvC;;GAEG;AACH,MAAM,OAAO,eAAe;IAGxB,YACqB,OAA4B;IAC7C,+DAA+D;IAC9C,cAA8C;QAF9C,YAAO,GAAP,OAAO,CAAqB;QAE5B,mBAAc,GAAd,cAAc,CAAgC;QA0DnE,6EAA6E;QAC7E,iFAAiF;QAChE,gBAAW,GAAG,CAAC,KAAU,EAAE,IAAkB,EAAE,EAAE;YAC9D,wCAAwC;YACxC,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAC;YAEnC,yDAAyD;YACzD,OAAO,MAAM,KAAK,SAAS;gBACvB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;gBACpC,CAAC,CAAC,KAAK,CAAC;QAChB,CAAC,CAAC;QAEF,qFAAqF;QACrF,6EAA6E;QAC5D,gBAAW,GAAG,CAAC,KAAU,EAAE,EAAE;YAC1C,0EAA0E;YAC1E,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE;gBAC3B,kGAAkG;gBAClG,4FAA4F;gBAC5F,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;oBAC1C,CAAC,CAAC,KAAK,CAAC,GAAG;oBACX,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEzD,MAAM,YAAY,GAAG,IAAI,uBAAuB,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1E,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;gBAClC,OAAO,YAAY,CAAC;aACvB;iBAAM;gBACH,OAAO,KAAK,CAAC;aAChB;QACL,CAAC,CAAC;QArFE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;SACtC;IACL,CAAC;IAED,IAAW,gBAAgB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE9C;;;;;;;;OAQG;IACK,MAAM,CACV,KAAU,EACV,IAAkB;QAElB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC;YACxD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAU;QACrB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC;YAClD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,KAAU,EAAE,IAAkB;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,kGAAkG;IAC3F,KAAK,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,CAAC;IAiCD,mFAAmF;IACnF,0FAA0F;IAC1F,gCAAgC;IACxB,kBAAkB,CACtB,KAAU,EACV,QAA2C,EAC3C,OAAa;QAEb,+EAA+E;QAC/E,4CAA4C;QAE5C,yGAAyG;QACzG,wBAAwB;QACxB,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE/C,qGAAqG;QACrG,8BAA8B;QAC9B,IAAI,aAAa,KAAK,KAAK,EAAE;YACzB,OAAO,aAAa,CAAC;SACxB;QAED,8EAA8E;QAC9E,wDAAwD;QACxD,IAAI,KAAyB,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAClC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACzB,yEAAyE;YACzE,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACtC,8FAA8F;gBAC9F,+FAA+F;gBAC/F,8DAA8D;gBAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAEnE,kGAAkG;gBAClG,+FAA+F;gBAC/F,wDAAwD;gBACxD,IAAI,QAAQ,KAAK,KAAK,EAAE;oBACpB,qFAAqF;oBACrF,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;wBAClC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;wBACZ,CAAC,mBAAM,KAAK,CAAE,CAAC,CAAC;oBAEpB,+EAA+E;oBAC/E,oEAAoE;oBACpE,KAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBAC1B;aACJ;SACJ;QACD,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC;IAC1B,CAAC;IAES,eAAe,CAAC,MAAoB,EAAE,IAAkB;QAC9D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,OAAO;YACH,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,MAAM,CAAC,YAAY;SAC3B,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// RATIONALE: Many methods consume and return 'any' by necessity.\n/* eslint-disable @typescript-eslint/no-unsafe-return */\n\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { RemoteFluidObjectHandle } from \"./remoteObjectHandle\";\n\n/**\n * JSON serialized form of an IFluidHandle\n */\n export interface ISerializedHandle {\n    // Marker to indicate to JSON.parse that the object is a Fluid handle\n    type: \"__fluid_handle__\";\n\n    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.\n    url: string;\n}\n\nexport const isSerializedHandle = (value: any): value is ISerializedHandle =>\n    value?.type === \"__fluid_handle__\";\n\nexport interface IFluidSerializer {\n    /**\n     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n     * where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     */\n    encode(value: any, bind: IFluidHandle): any;\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n    decode(input: any): any;\n\n    /**\n     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.\n     */\n    stringify(value: any, bind: IFluidHandle): string;\n\n    /**\n     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid\n     * handles will be realized as part of the parse\n     */\n    parse(value: string): any;\n}\n\n/**\n * Data Store serializer implementation\n */\nexport class FluidSerializer implements IFluidSerializer {\n    private readonly root: IFluidHandleContext;\n\n    public constructor(\n        private readonly context: IFluidHandleContext,\n        // To be called whenever a handle is parsed by this serializer.\n        private readonly handleParsedCb: (handle: IFluidHandle) => void,\n    ) {\n        this.root = this.context;\n        while (this.root.routeContext !== undefined) {\n            this.root = this.root.routeContext;\n        }\n    }\n\n    public get IFluidSerializer() { return this; }\n\n    /**\n     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a\n     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * Any unbound handles encountered are bound to the provided IFluidHandle.\n     */\n     public encode(\n        input: any,\n        bind: IFluidHandle,\n    ) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.encodeValue, bind)\n            : input;\n    }\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n     public decode(input: any) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.decodeValue)\n            : input;\n    }\n\n    public stringify(input: any, bind: IFluidHandle) {\n        return JSON.stringify(input, (key, value) => this.encodeValue(value, bind));\n    }\n\n    // Parses the serialized data - context must match the context with which the JSON was stringified\n    public parse(input: string) {\n        return JSON.parse(input, (key, value) => this.decodeValue(value));\n    }\n\n    // If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'encode()' and 'stringify()'.\n    private readonly encodeValue = (value: any, bind: IFluidHandle) => {\n        // Detect if 'value' is an IFluidHandle.\n        const handle = value?.IFluidHandle;\n\n        // If 'value' is an IFluidHandle return its encoded form.\n        return handle !== undefined\n            ? this.serializeHandle(handle, bind)\n            : value;\n    };\n\n    // If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.\n    private readonly decodeValue = (value: any) => {\n        // If 'value' is a serialized IFluidHandle return the deserialized result.\n        if (isSerializedHandle(value)) {\n            // Old documents may have handles with relative path in their summaries. Convert these to absolute\n            // paths. This will ensure that future summaries will have absolute paths for these handles.\n            const absolutePath = value.url.startsWith(\"/\")\n                ? value.url\n                : generateHandleContextPath(value.url, this.context);\n\n            const parsedHandle = new RemoteFluidObjectHandle(absolutePath, this.root);\n            this.handleParsedCb(parsedHandle);\n            return parsedHandle;\n        } else {\n            return value;\n        }\n    };\n\n    // Invoked for non-null objects to recursively replace references to IFluidHandles.\n    // Clones as-needed to avoid mutating the `input` object.  If no IFluidHandes are present,\n    // returns the original `input`.\n    private recursivelyReplace(\n        input: any,\n        replacer: (input: any, context: any) => any,\n        context?: any,\n    ) {\n        // Note: Caller is responsible for ensuring that `input` is defined / non-null.\n        //       (Required for Object.keys() below.)\n\n        // Execute the `replace` on the current input.  Note that Caller is responsible for ensuring that `input`\n        // is a non-null object.\n        const maybeReplaced = replacer(input, context);\n\n        // If the replacer made a substitution there is no need to decscend further. IFluidHandles are always\n        // leaves in the object graph.\n        if (maybeReplaced !== input) {\n            return maybeReplaced;\n        }\n\n        // Otherwise descend into the object graph looking for IFluidHandle instances.\n        // eslint-disable-next-line @typescript-eslint/ban-types\n        let clone: object | undefined;\n        for (const key of Object.keys(input)) {\n            const value = input[key];\n            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n            if (!!value && typeof value === \"object\") {\n                // Note: Except for IFluidHandle, `input` must not contain circular references (as object must\n                //       be JSON serializable.)  Therefore, guarding against infinite recursion here would only\n                //       lead to a later error when attempting to stringify().\n                const replaced = this.recursivelyReplace(value, replacer, context);\n\n                // If the `replaced` object is different than the original `value` then the subgraph contained one\n                // or more handles.  If this happens, we need to return a clone of the `input` object where the\n                // current property is replaced by the `replaced` value.\n                if (replaced !== value) {\n                    // Lazily create a shallow clone of the `input` object if we haven't done so already.\n                    clone = clone ?? (Array.isArray(input)\n                        ? [...input]\n                        : { ...input });\n\n                    // Overwrite the current property `key` in the clone with the `replaced` value.\n                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                    clone![key] = replaced;\n                }\n            }\n        }\n        return clone ?? input;\n    }\n\n    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {\n        bind.bind(handle);\n        return {\n            type: \"__fluid_handle__\",\n            url: handle.absolutePath,\n        };\n    }\n}\n"]}
+{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,iEAAiE;AACjE,wDAAwD;AAExD,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAa/D,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAU,EAA8B,EAAE,CACzE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,kBAAkB,CAAC;AAmCvC;;GAEG;AACH,MAAM,OAAO,eAAe;IAGxB,YACqB,OAA4B;IAC7C,+DAA+D;IAC9C,cAA8C;QAF9C,YAAO,GAAP,OAAO,CAAqB;QAE5B,mBAAc,GAAd,cAAc,CAAgC;QA0DnE,6EAA6E;QAC7E,iFAAiF;QAChE,gBAAW,GAAG,CAAC,KAAU,EAAE,IAAkB,EAAE,EAAE;YAC9D,wCAAwC;YACxC,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAC;YAEnC,yDAAyD;YACzD,OAAO,MAAM,KAAK,SAAS;gBACvB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;gBACpC,CAAC,CAAC,KAAK,CAAC;QAChB,CAAC,CAAC;QAEF,qFAAqF;QACrF,6EAA6E;QAC5D,gBAAW,GAAG,CAAC,KAAU,EAAE,EAAE;YAC1C,0EAA0E;YAC1E,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE;gBAC3B,kGAAkG;gBAClG,4FAA4F;gBAC5F,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;oBAC1C,CAAC,CAAC,KAAK,CAAC,GAAG;oBACX,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEzD,MAAM,YAAY,GAAG,IAAI,uBAAuB,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1E,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;gBAClC,OAAO,YAAY,CAAC;aACvB;iBAAM;gBACH,OAAO,KAAK,CAAC;aAChB;QACL,CAAC,CAAC;QArFE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;SACtC;IACL,CAAC;IAED,IAAW,gBAAgB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE9C;;;;;;;;OAQG;IACK,MAAM,CACV,KAAU,EACV,IAAkB;QAElB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC;YACxD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAU;QACrB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC;YAClD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,KAAU,EAAE,IAAkB;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,kGAAkG;IAC3F,KAAK,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,CAAC;IAiCD,mFAAmF;IACnF,0FAA0F;IAC1F,gCAAgC;IACxB,kBAAkB,CACtB,KAAU,EACV,QAA2C,EAC3C,OAAa;QAEb,+EAA+E;QAC/E,4CAA4C;QAE5C,yGAAyG;QACzG,wBAAwB;QACxB,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE/C,qGAAqG;QACrG,8BAA8B;QAC9B,IAAI,aAAa,KAAK,KAAK,EAAE;YACzB,OAAO,aAAa,CAAC;SACxB;QAED,8EAA8E;QAC9E,IAAI,KAAyB,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAClC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACzB,yEAAyE;YACzE,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACtC,8FAA8F;gBAC9F,+FAA+F;gBAC/F,8DAA8D;gBAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAEnE,kGAAkG;gBAClG,+FAA+F;gBAC/F,wDAAwD;gBACxD,IAAI,QAAQ,KAAK,KAAK,EAAE;oBACpB,qFAAqF;oBACrF,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;wBAClC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;wBACZ,CAAC,mBAAM,KAAK,CAAE,CAAC,CAAC;oBAEpB,+EAA+E;oBAC/E,oEAAoE;oBACpE,KAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBAC1B;aACJ;SACJ;QACD,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC;IAC1B,CAAC;IAES,eAAe,CAAC,MAAoB,EAAE,IAAkB;QAC9D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,OAAO;YACH,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,MAAM,CAAC,YAAY;SAC3B,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// RATIONALE: Many methods consume and return 'any' by necessity.\n/* eslint-disable @typescript-eslint/no-unsafe-return */\n\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { RemoteFluidObjectHandle } from \"./remoteObjectHandle\";\n\n/**\n * JSON serialized form of an IFluidHandle\n */\n export interface ISerializedHandle {\n    // Marker to indicate to JSON.parse that the object is a Fluid handle\n    type: \"__fluid_handle__\";\n\n    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.\n    url: string;\n}\n\nexport const isSerializedHandle = (value: any): value is ISerializedHandle =>\n    value?.type === \"__fluid_handle__\";\n\nexport interface IFluidSerializer {\n    /**\n     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n     * where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     */\n    encode(value: any, bind: IFluidHandle): any;\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n    decode(input: any): any;\n\n    /**\n     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.\n     */\n    stringify(value: any, bind: IFluidHandle): string;\n\n    /**\n     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid\n     * handles will be realized as part of the parse\n     */\n    parse(value: string): any;\n}\n\n/**\n * Data Store serializer implementation\n */\nexport class FluidSerializer implements IFluidSerializer {\n    private readonly root: IFluidHandleContext;\n\n    public constructor(\n        private readonly context: IFluidHandleContext,\n        // To be called whenever a handle is parsed by this serializer.\n        private readonly handleParsedCb: (handle: IFluidHandle) => void,\n    ) {\n        this.root = this.context;\n        while (this.root.routeContext !== undefined) {\n            this.root = this.root.routeContext;\n        }\n    }\n\n    public get IFluidSerializer() { return this; }\n\n    /**\n     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a\n     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * Any unbound handles encountered are bound to the provided IFluidHandle.\n     */\n     public encode(\n        input: any,\n        bind: IFluidHandle,\n    ) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.encodeValue, bind)\n            : input;\n    }\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n     public decode(input: any) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.decodeValue)\n            : input;\n    }\n\n    public stringify(input: any, bind: IFluidHandle) {\n        return JSON.stringify(input, (key, value) => this.encodeValue(value, bind));\n    }\n\n    // Parses the serialized data - context must match the context with which the JSON was stringified\n    public parse(input: string) {\n        return JSON.parse(input, (key, value) => this.decodeValue(value));\n    }\n\n    // If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'encode()' and 'stringify()'.\n    private readonly encodeValue = (value: any, bind: IFluidHandle) => {\n        // Detect if 'value' is an IFluidHandle.\n        const handle = value?.IFluidHandle;\n\n        // If 'value' is an IFluidHandle return its encoded form.\n        return handle !== undefined\n            ? this.serializeHandle(handle, bind)\n            : value;\n    };\n\n    // If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.\n    private readonly decodeValue = (value: any) => {\n        // If 'value' is a serialized IFluidHandle return the deserialized result.\n        if (isSerializedHandle(value)) {\n            // Old documents may have handles with relative path in their summaries. Convert these to absolute\n            // paths. This will ensure that future summaries will have absolute paths for these handles.\n            const absolutePath = value.url.startsWith(\"/\")\n                ? value.url\n                : generateHandleContextPath(value.url, this.context);\n\n            const parsedHandle = new RemoteFluidObjectHandle(absolutePath, this.root);\n            this.handleParsedCb(parsedHandle);\n            return parsedHandle;\n        } else {\n            return value;\n        }\n    };\n\n    // Invoked for non-null objects to recursively replace references to IFluidHandles.\n    // Clones as-needed to avoid mutating the `input` object.  If no IFluidHandes are present,\n    // returns the original `input`.\n    private recursivelyReplace(\n        input: any,\n        replacer: (input: any, context: any) => any,\n        context?: any,\n    ) {\n        // Note: Caller is responsible for ensuring that `input` is defined / non-null.\n        //       (Required for Object.keys() below.)\n\n        // Execute the `replace` on the current input.  Note that Caller is responsible for ensuring that `input`\n        // is a non-null object.\n        const maybeReplaced = replacer(input, context);\n\n        // If the replacer made a substitution there is no need to decscend further. IFluidHandles are always\n        // leaves in the object graph.\n        if (maybeReplaced !== input) {\n            return maybeReplaced;\n        }\n\n        // Otherwise descend into the object graph looking for IFluidHandle instances.\n        let clone: object | undefined;\n        for (const key of Object.keys(input)) {\n            const value = input[key];\n            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n            if (!!value && typeof value === \"object\") {\n                // Note: Except for IFluidHandle, `input` must not contain circular references (as object must\n                //       be JSON serializable.)  Therefore, guarding against infinite recursion here would only\n                //       lead to a later error when attempting to stringify().\n                const replaced = this.recursivelyReplace(value, replacer, context);\n\n                // If the `replaced` object is different than the original `value` then the subgraph contained one\n                // or more handles.  If this happens, we need to return a clone of the `input` object where the\n                // current property is replaced by the `replaced` value.\n                if (replaced !== value) {\n                    // Lazily create a shallow clone of the `input` object if we haven't done so already.\n                    clone = clone ?? (Array.isArray(input)\n                        ? [...input]\n                        : { ...input });\n\n                    // Overwrite the current property `key` in the clone with the `replaced` value.\n                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                    clone![key] = replaced;\n                }\n            }\n        }\n        return clone ?? input;\n    }\n\n    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {\n        bind.bind(handle);\n        return {\n            type: \"__fluid_handle__\",\n            url: handle.absolutePath,\n        };\n    }\n}\n"]}

package/lib/sharedObject.d.ts

@@ -6,7 +6,7 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService, IChannelServices } from "@fluidframework/datastore-definitions";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
-import { IGarbageCollectionData, ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
 import { EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
 import { IFluidSerializer } from "./serializer";
 import { SummarySerializer } from "./summarySerializer";
@@ -102,11 +102,11 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */
-    abstract getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;
+    abstract getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    abstract summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;
+    abstract summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
     /**
      * {@inheritDoc (ISharedObject:interface).getGCData}
      */
@@ -198,6 +198,10 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
      * @param localOpMetadata - The local metadata associated with the original message.
      */
     private reSubmit;
+    /**
+     * Revert an op
+     */
+    protected rollback(content: any, localOpMetadata: unknown): void;
     /**
      * Apply changes from an op. Used when rehydrating an attached container
      * with pending changes. This prepares the SharedObject for seeing an ACK
@@ -213,6 +217,7 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
  */
 export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
+    private readonly telemetryContextPrefix;
     /**
      * True while we are garbage collecting this object's data.
      */
@@ -227,15 +232,15 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * @param runtime - The IFluidDataStoreRuntime which contains the shared object
      * @param attributes - Attributes of the shared object
      */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */
-    getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;
+    getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
     /**
      * {@inheritDoc (ISharedObject:interface).getGCData}
      */
@@ -249,6 +254,7 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * Gets a form of the object that can be serialized.
      * @returns A tree representing the snapshot of the shared object.
      */
-    protected abstract summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    protected abstract summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    private incrementTelemetryMetric;
 }
 //# sourceMappingURL=sharedObject.d.ts.map

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,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAe,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAE7F,OAAO,EAAmB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE7D;;GAEG;AACH,8BAAsB,gBAAgB,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAC3F,SAAQ,6BAA6B,CAAC,MAAM,CAAE,YAAW,aAAa,CAAC,MAAM,CAAC;IA+CnE,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IAhDlD,IAAW,cAAc,SAAmB;IAE5C;;OAEG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;gBAEQ,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IAiBlD;;;;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;IAU5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,qBAAqB;IAEjG;;OAEG;aACa,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAEnG;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,YAAY;IAOnD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;;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;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;CAC3D;AAED;;;GAGG;AACH,8BAAsB,YAAY,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvF,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAW3C;IAED;;;;OAIG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IASlC;;OAEG;IACI,gBAAgB,CAAC,QAAQ,GAAE,OAAe,EAAE,UAAU,GAAE,OAAe,GAAG,qBAAqB;IAItG;;OAEG;IACU,SAAS,CAAC,QAAQ,GAAE,OAAe,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI9G;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAwBjE;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,iBAAiB;IAOzD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;CACxF"}
+{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGtE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EAGpB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAe,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAE7F,OAAO,EAAmB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE7D;;GAEG;AACH,8BAAsB,gBAAgB,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAC3F,SAAQ,6BAA6B,CAAC,MAAM,CAAE,YAAW,aAAa,CAAC,MAAM,CAAC;IA+CnE,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IAhDlD,IAAW,cAAc,SAAmB;IAE5C;;OAEG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;gBAEQ,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IAmBlD;;;;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;IAU5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAC5B,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB;IAExB;;OAEG;aACa,SAAS,CACrB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,qBAAqB,CAAC;IAEjC;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,YAAY;IAOnD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;;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;IA+B1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAOf;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAIzD;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;CAC3D;AAED;;;GAGG;AACH,8BAAsB,YAAY,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvF,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IAiC5B,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAhC3C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAW3C;IAED;;;;OAIG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EACb,sBAAsB,EAAE,MAAM;IAUnD;;OAEG;IACI,gBAAgB,CACnB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB;IAOxB;;OAEG;IACU,SAAS,CAClB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,qBAAqB,CAAC;IAOjC;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAwBjE;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,iBAAiB;IAOzD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAC5B,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB;IAExB,OAAO,CAAC,wBAAwB;CAInC"}

package/lib/sharedObject.js

@@ -5,6 +5,7 @@
 import { v4 as uuid } from "uuid";
 import { assert } from "@fluidframework/common-utils";
 import { AttachState } from "@fluidframework/container-definitions";
+import { blobCountPropertyName, totalBlobSizePropertyName, } from "@fluidframework/runtime-definitions";
 import { ChildLogger, EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
 import { DataProcessingError } from "@fluidframework/container-utils";
 import { FluidSerializer } from "./serializer";
@@ -32,6 +33,7 @@ export class SharedObjectCore extends EventEmitterWithErrorHandling {
          * True if the dds is bound to its parent.
          */
         this._isBoundToContext = false;
+        assert(!id.includes("/"), 0x304 /* Id cannot contain slashes */);
         this.handle = new SharedObjectHandle(this, id, runtime.IFluidHandleContext);
         this.logger = ChildLogger.create(runtime.logger, undefined, { all: { sharedObjectId: uuid() } });
         this.attachListeners();
@@ -240,6 +242,9 @@ export class SharedObjectCore extends EventEmitterWithErrorHandling {
             applyStashedOp: (content) => {
                 return this.applyStashedOp(content);
             },
+            rollback: (content, localOpMetadata) => {
+                this.rollback(content, localOpMetadata);
+            },
         });
         // Trigger initial state
         // attachDeltaHandler is only called after services is assigned
@@ -265,7 +270,7 @@ export class SharedObjectCore extends EventEmitterWithErrorHandling {
             this.onDisconnect();
         }
         else {
-            // Call this for now so that DDSes like ConsensesOrderedCollection that maintain their own pending
+            // Call this for now so that DDSes like ConsensusOrderedCollection that maintain their own pending
             // messages will work.
             this.onConnect();
         }
@@ -292,6 +297,12 @@ export class SharedObjectCore extends EventEmitterWithErrorHandling {
     reSubmit(content, localOpMetadata) {
         this.reSubmitCore(content, localOpMetadata);
     }
+    /**
+     * Revert an op
+     */
+    rollback(content, localOpMetadata) {
+        throw new Error("rollback not supported");
+    }
 }
 /**
  * SharedObject with simplified, synchronous summarization and GC.
@@ -303,8 +314,9 @@ export class SharedObject extends SharedObjectCore {
      * @param runtime - The IFluidDataStoreRuntime which contains the shared object
      * @param attributes - Attributes of the shared object
      */
-    constructor(id, runtime, attributes) {
+    constructor(id, runtime, attributes, telemetryContextPrefix) {
         super(id, runtime, attributes);
+        this.telemetryContextPrefix = telemetryContextPrefix;
         /**
          * True while we are garbage collecting this object's data.
          */
@@ -325,14 +337,20 @@ export class SharedObject extends SharedObjectCore {
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */
-    getAttachSummary(fullTree = false, trackState = false) {
-        return this.summarizeCore(this.serializer);
+    getAttachSummary(fullTree = false, trackState = false, telemetryContext) {
+        const result = this.summarizeCore(this.serializer, telemetryContext);
+        this.incrementTelemetryMetric(blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);
+        this.incrementTelemetryMetric(totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);
+        return result;
     }
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    async summarize(fullTree = false, trackState = false) {
-        return this.summarizeCore(this.serializer);
+    async summarize(fullTree = false, trackState = false, telemetryContext) {
+        const result = this.summarizeCore(this.serializer, telemetryContext);
+        this.incrementTelemetryMetric(blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);
+        this.incrementTelemetryMetric(totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);
+        return result;
     }
     /**
      * {@inheritDoc (ISharedObject:interface).getGCData}
@@ -366,5 +384,10 @@ export class SharedObject extends SharedObjectCore {
         // See: https://github.com/microsoft/FluidFramework/issues/4547
         this.summarizeCore(serializer);
     }
+    incrementTelemetryMetric(propertyName, incrementBy, telemetryContext) {
+        var _a;
+        const prevTotal = ((_a = telemetryContext === null || telemetryContext === void 0 ? void 0 : telemetryContext.get(this.telemetryContextPrefix, propertyName)) !== null && _a !== void 0 ? _a : 0);
+        telemetryContext === null || telemetryContext === void 0 ? void 0 : telemetryContext.set(this.telemetryContextPrefix, propertyName, prevTotal + incrementBy);
+    }
 }
 //# sourceMappingURL=sharedObject.js.map

package/lib/sharedObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedObject.js","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,MAAM,EAAyB,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAapE,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAoB,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,OAAgB,gBAClB,SAAQ,6BAAqC;IAyC7C;;;;OAIG;IACH,YACW,EAAU,EACP,OAA+B,EACzB,UAA8B;QAC9C,KAAK,CAAC,CAAC,KAA4B,EAAE,CAAM,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAHnF,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QApClD;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QA0BvC,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAChC,IAAI,EACJ,EAAE,EACF,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEjC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAC5B,OAAO,CAAC,MAAM,EACd,SAAS,EACT,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IA/DD,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAgC5C;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IA2BD;;;;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,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAA0B;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU;QACb,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;IAC5F,CAAC;IAiBD;;;;OAIG;IACO,aAAa,CAAC,aAA2B;;QAC/C,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACnB,mGAAmG;YACnG,MAAA,MAAA,IAAI,CAAC,QAAQ,gDAAE,eAAe,EAAC,wBAAwB,mDAAG,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SACzF;IACL,CAAC;IAQD;;OAEG;IACO,mBAAmB;QACzB,OAAO;IACX,CAAC;IAED;;;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;CAWJ;AAED;;;GAGG;AACH,MAAM,OAAgB,YAClB,SAAQ,gBAAwB;IAwBhC;;;;OAIG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAC9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAhCnC;;WAEG;QACK,aAAQ,GAAY,KAAK,CAAC;QA+B9B,IAAI,CAAC,WAAW,GAAG,IAAI,eAAe,CAClC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;IACN,CAAC;IA5BD,IAAc,UAAU;QACpB;;;;;;WAMG;QACH,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EACjB,KAAK,CAAC,6EAA6E,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAmBD;;OAEG;IACI,gBAAgB,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QAC1E,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,WAAoB,KAAK,EAAE,aAAsB,KAAK;QACzE,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,4GAA4G;QAC5G,yBAAyB;QACzB,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,wEAAwE,CAAC,CAAC;QACvG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,MAA8B,CAAC;QACnC,IAAI;YACA,MAAM,UAAU,GAAG,IAAI,iBAAiB,CACpC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;YACF,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACnC,yGAAyG;YACzG,qDAAqD;YACrD,MAAM,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,mBAAmB,EAAE,EAAE,EAAE,CAAC;YAChE,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACpG;gBAAS;YACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACzB;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,UAA6B;QACrD,wGAAwG;QACxG,2GAA2G;QAC3G,+DAA+D;QAC/D,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;CAOJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, EventEmitterEventType } from \"@fluidframework/common-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    ISummaryTreeWithStats,\n} from \"@fluidframework/runtime-definitions\";\nimport { ChildLogger, EventEmitterWithErrorHandling } from \"@fluidframework/telemetry-utils\";\nimport { DataProcessingError } from \"@fluidframework/container-utils\";\nimport { FluidSerializer, IFluidSerializer } from \"./serializer\";\nimport { SharedObjectHandle } from \"./handle\";\nimport { SummarySerializer } from \"./summarySerializer\";\nimport { ISharedObject, ISharedObjectEvents } from \"./types\";\n\n/**\n *  Base class from which all shared objects derive\n */\nexport abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {\n    public get IFluidLoadable() { return this; }\n\n    /**\n     * The handle referring to this SharedObject\n     */\n    public readonly handle: IFluidHandle;\n\n    /**\n     * Telemetry logger for the shared object\n     */\n    protected readonly logger: ITelemetryLogger;\n\n    /**\n     * Connection state\n     */\n    private _connected = false;\n\n    /**\n     * Services used by the shared object\n     */\n    private services: IChannelServices | undefined;\n\n    /**\n     * True if the dds is bound to its parent.\n     */\n    private _isBoundToContext: boolean = false;\n\n    /**\n     * Tracks error that closed this object.\n     */\n    private closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;\n\n    /**\n     * Gets the connection state\n     * @returns The state of the connection\n     */\n    public get connected(): boolean {\n        return this._connected;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        public id: string,\n        protected runtime: IFluidDataStoreRuntime,\n        public readonly attributes: IChannelAttributes) {\n        super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));\n\n        this.handle = new SharedObjectHandle(\n            this,\n            id,\n            runtime.IFluidHandleContext);\n\n        this.logger = ChildLogger.create(\n            runtime.logger,\n            undefined,\n            { all: { sharedObjectId: uuid() } },\n        );\n\n        this.attachListeners();\n    }\n\n    /**\n     * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)\n     * would result in same error thrown. If called multiple times, only first error is remembered.\n     * @param error - error object that is thrown whenever an attempt is made to modify this object\n     */\n    private closeWithError(error: any) {\n        if (this.closeError === undefined) {\n            this.closeError = error;\n        }\n    }\n\n    /**\n     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.\n     */\n    private verifyNotClosed() {\n        if (this.closeError !== undefined) {\n            throw this.closeError;\n        }\n    }\n\n    /**\n     * Event listener handler helper that can be used to react to exceptions thrown from event listeners\n     * It wraps error with DataProcessingError, closes this object and throws resulting error.\n     * See closeWithError() for more details\n     * Ideally such situation never happens, as consumers of DDS should never throw exceptions\n     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).\n     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.\n     * DDS state does not match what user sees. Because of it DDS moves to \"corrupted state\" and does not\n     * allow processing of ops or local changes, which very quickly results in container closure.\n     */\n    private eventListenerErrorHandler(event: EventEmitterEventType, e: any) {\n        const error = DataProcessingError.wrapIfUnrecognized(\n            e,\n            \"SharedObjectEventListenerException\");\n        error.addTelemetryProperties({ emittedEventName: String(event) });\n\n        this.closeWithError(error);\n        throw error;\n    }\n\n    private attachListeners() {\n        // Only listen to these events if not attached.\n        if (!this.isAttached()) {\n            this.runtime.once(\"attaching\", () => {\n                // Calling this will let the dds to do any custom processing based on attached\n                // like starting generating ops.\n                this.didAttach();\n            });\n        }\n    }\n\n    /**\n     * A shared object, after construction, can either be loaded in the case that it is already part of\n     * a shared document. Or later attached if it is being newly added.\n     * @param services - Services used by the shared object\n     */\n    public async load(services: IChannelServices): Promise<void> {\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.services = services;\n        }\n        await this.loadCore(services.objectStorage);\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.attachDeltaHandler();\n        }\n    }\n\n    /**\n     * Initializes the object as a local, non-shared object. This object can become shared after\n     * it is attached to the document.\n     */\n    public initializeLocal(): void {\n        this.initializeLocalCore();\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).bindToContext}\n     */\n    public bindToContext(): void {\n        if (this._isBoundToContext) {\n            return;\n        }\n\n        this._isBoundToContext = true;\n\n        this.runtime.bindChannel(this);\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}\n     */\n    public connect(services: IChannelServices) {\n        this.services = services;\n        this.attachDeltaHandler();\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).isAttached}\n     */\n    public isAttached(): boolean {\n        return this.services !== undefined && this.runtime.attachState !== AttachState.Detached;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n     */\n    public abstract getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n     */\n    public abstract summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public abstract getGCData(fullGC?: boolean): IGarbageCollectionData;\n\n    /**\n     * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference\n     * to another object in the container.\n     * @param decodedHandle - The handle of the Fluid object that is decoded.\n     */\n    protected handleDecoded(decodedHandle: IFluidHandle) {\n        if (this.isAttached()) {\n            // This represents an outbound reference from this object to the node represented by decodedHandle.\n            this.services?.deltaConnection.addedGCOutboundReference?.(this.handle, decodedHandle);\n        }\n    }\n\n    /**\n     * Allows the distributed data type to perform custom loading\n     * @param services - Storage used by the shared object\n     */\n    protected abstract loadCore(services: IChannelStorageService): Promise<void>;\n\n    /**\n     * Allows the distributed data type to perform custom local loading.\n     */\n    protected initializeLocalCore() {\n        return;\n    }\n\n    /**\n     * Allows the 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    /**\n     * Apply changes from an op. Used when rehydrating an attached container\n     * with pending changes. This prepares the SharedObject for seeing an ACK\n     * for the op or resubmitting the op upon reconnection.\n     * @param content - Contents of a stashed op.\n     * @returns localMetadata of the op, to be passed to process() or resubmit()\n     * when the op is ACKed or resubmitted, respectively\n     */\n    protected abstract applyStashedOp(content: any): unknown;\n}\n\n/**\n * SharedObject with simplified, synchronous summarization and GC.\n * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.\n */\nexport abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends SharedObjectCore<TEvent> {\n    /**\n     * True while we are garbage collecting this object's data.\n     */\n    private _isGCing: boolean = false;\n\n    /**\n     * The serializer to use to serialize / parse handles, if any.\n     */\n    private readonly _serializer: IFluidSerializer;\n\n    protected get serializer(): IFluidSerializer {\n        /**\n         * During garbage collection, the SummarySerializer keeps track of IFluidHandles that are serialized. These\n         * handles represent references to other Fluid objects.\n         *\n         * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content\n         * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.\n         */\n        assert(!this._isGCing,\n            0x075 /* \"SummarySerializer should be used for serializing data during summary.\" */);\n        return this._serializer;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes) {\n        super(id, runtime, attributes);\n\n        this._serializer = new FluidSerializer(\n            this.runtime.channelsRoutingContext,\n            (handle: IFluidHandle) => this.handleDecoded(handle),\n        );\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n     */\n    public getAttachSummary(fullTree: boolean = false, trackState: boolean = false): ISummaryTreeWithStats {\n        return this.summarizeCore(this.serializer);\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n     */\n    public async summarize(fullTree: boolean = false, trackState: boolean = false): Promise<ISummaryTreeWithStats> {\n        return this.summarizeCore(this.serializer);\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        // Set _isGCing to true. This flag is used to ensure that we only use SummarySerializer to serialize handles\n        // in this object's data.\n        assert(!this._isGCing, 0x078 /* \"Possible re-entrancy! Summary should not already be in progress.\" */);\n        this._isGCing = true;\n\n        let gcData: IGarbageCollectionData;\n        try {\n            const serializer = new SummarySerializer(\n                this.runtime.channelsRoutingContext,\n                (handle: IFluidHandle) => this.handleDecoded(handle),\n            );\n            this.processGCDataCore(serializer);\n            // The GC data for this shared object contains a single GC node. The outbound routes of this node are the\n            // routes of handles serialized during summarization.\n            gcData = { gcNodes: { \"/\": serializer.getSerializedRoutes() } };\n            assert(this._isGCing, 0x079 /* \"Possible re-entrancy! Summary should have been in progress.\" */);\n        } finally {\n            this._isGCing = false;\n        }\n\n        return gcData;\n    }\n\n    /**\n     * Calls the serializer over all data in this object that reference other GC nodes.\n     * Derived classes must override this to provide custom list of references to other GC nodes.\n     */\n    protected processGCDataCore(serializer: SummarySerializer) {\n        // We run the full summarize logic to get the list of outbound routes from this object. This is a little\n        // expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.\n        // See: https://github.com/microsoft/FluidFramework/issues/4547\n        this.summarizeCore(serializer);\n    }\n\n    /**\n     * Gets a form of the object that can be serialized.\n     * @returns A tree representing the snapshot of the shared object.\n     */\n    protected abstract summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;\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;AASpE,OAAO,EAIH,qBAAqB,EACrB,yBAAyB,GAC5B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAoB,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,OAAgB,gBAClB,SAAQ,6BAAqC;IAyC7C;;;;OAIG;IACH,YACW,EAAU,EACP,OAA+B,EACzB,UAA8B;QAC9C,KAAK,CAAC,CAAC,KAA4B,EAAE,CAAM,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAHnF,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QApClD;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QA0BvC,MAAM,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAEjE,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAChC,IAAI,EACJ,EAAE,EACF,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEjC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAC5B,OAAO,CAAC,MAAM,EACd,SAAS,EACT,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAjED,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAgC5C;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IA6BD;;;;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,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;IAyBD;;;;OAIG;IACO,aAAa,CAAC,aAA2B;;QAC/C,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACnB,mGAAmG;YACnG,MAAA,MAAA,IAAI,CAAC,QAAQ,gDAAE,eAAe,EAAC,wBAAwB,mDAAG,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SACzF;IACL,CAAC;IAQD;;OAEG;IACO,mBAAmB;QACzB,OAAO;IACX,CAAC;IAED;;;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;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,eAAwB,EAAE,EAAE;gBACjD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAC5C,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;IAED;;OAEG;IACO,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACrD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC9C,CAAC;CAWJ;AAED;;;GAGG;AACH,MAAM,OAAgB,YAClB,SAAQ,gBAAwB;IAwBhC;;;;OAIG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B,EACb,sBAA8B;QAE/C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAFd,2BAAsB,GAAtB,sBAAsB,CAAQ;QAhCnD;;WAEG;QACK,aAAQ,GAAY,KAAK,CAAC;QAiC9B,IAAI,CAAC,WAAW,GAAG,IAAI,eAAe,CAClC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;IACN,CAAC;IA9BD,IAAc,UAAU;QACpB;;;;;;WAMG;QACH,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EACjB,KAAK,CAAC,6EAA6E,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAqBD;;OAEG;IACI,gBAAgB,CACnB,WAAoB,KAAK,EACzB,aAAsB,KAAK,EAC3B,gBAAoC;QAEpC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACrE,IAAI,CAAC,wBAAwB,CAAC,qBAAqB,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACnG,IAAI,CAAC,wBAAwB,CAAC,yBAAyB,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACvG,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAClB,WAAoB,KAAK,EACzB,aAAsB,KAAK,EAC3B,gBAAoC;QAEpC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACrE,IAAI,CAAC,wBAAwB,CAAC,qBAAqB,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACnG,IAAI,CAAC,wBAAwB,CAAC,yBAAyB,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACvG,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,4GAA4G;QAC5G,yBAAyB;QACzB,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,wEAAwE,CAAC,CAAC;QACvG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,MAA8B,CAAC;QACnC,IAAI;YACA,MAAM,UAAU,GAAG,IAAI,iBAAiB,CACpC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnC,CAAC,MAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CACvD,CAAC;YACF,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACnC,yGAAyG;YACzG,qDAAqD;YACrD,MAAM,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,mBAAmB,EAAE,EAAE,EAAE,CAAC;YAChE,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACpG;gBAAS;YACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACzB;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,UAA6B;QACrD,wGAAwG;QACxG,2GAA2G;QAC3G,+DAA+D;QAC/D,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;IAWO,wBAAwB,CAAC,YAAoB,EAAE,WAAmB,EAAE,gBAAoC;;QAC5G,MAAM,SAAS,GAAG,CAAC,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,CAAC,mCAAI,CAAC,CAAW,CAAC;QACpG,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,EAAE,SAAS,GAAG,WAAW,CAAC,CAAC;IAC9F,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, EventEmitterEventType } from \"@fluidframework/common-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    ISummaryTreeWithStats,\n    ITelemetryContext,\n    blobCountPropertyName,\n    totalBlobSizePropertyName,\n} from \"@fluidframework/runtime-definitions\";\nimport { ChildLogger, EventEmitterWithErrorHandling } from \"@fluidframework/telemetry-utils\";\nimport { DataProcessingError } from \"@fluidframework/container-utils\";\nimport { FluidSerializer, IFluidSerializer } from \"./serializer\";\nimport { SharedObjectHandle } from \"./handle\";\nimport { SummarySerializer } from \"./summarySerializer\";\nimport { ISharedObject, ISharedObjectEvents } from \"./types\";\n\n/**\n *  Base class from which all shared objects derive\n */\nexport abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {\n    public get IFluidLoadable() { return this; }\n\n    /**\n     * The handle referring to this SharedObject\n     */\n    public readonly handle: IFluidHandle;\n\n    /**\n     * Telemetry logger for the shared object\n     */\n    protected readonly logger: ITelemetryLogger;\n\n    /**\n     * Connection state\n     */\n    private _connected = false;\n\n    /**\n     * Services used by the shared object\n     */\n    private services: IChannelServices | undefined;\n\n    /**\n     * True if the dds is bound to its parent.\n     */\n    private _isBoundToContext: boolean = false;\n\n    /**\n     * Tracks error that closed this object.\n     */\n    private closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;\n\n    /**\n     * Gets the connection state\n     * @returns The state of the connection\n     */\n    public get connected(): boolean {\n        return this._connected;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        public id: string,\n        protected runtime: IFluidDataStoreRuntime,\n        public readonly attributes: IChannelAttributes) {\n        super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));\n\n        assert(!id.includes(\"/\"), 0x304 /* Id cannot contain slashes */);\n\n        this.handle = new SharedObjectHandle(\n            this,\n            id,\n            runtime.IFluidHandleContext);\n\n        this.logger = ChildLogger.create(\n            runtime.logger,\n            undefined,\n            { all: { sharedObjectId: uuid() } },\n        );\n\n        this.attachListeners();\n    }\n\n    /**\n     * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)\n     * would result in same error thrown. If called multiple times, only first error is remembered.\n     * @param error - error object that is thrown whenever an attempt is made to modify this object\n     */\n    private closeWithError(error: any) {\n        if (this.closeError === undefined) {\n            this.closeError = error;\n        }\n    }\n\n    /**\n     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.\n     */\n    private verifyNotClosed() {\n        if (this.closeError !== undefined) {\n            throw this.closeError;\n        }\n    }\n\n    /**\n     * Event listener handler helper that can be used to react to exceptions thrown from event listeners\n     * It wraps error with DataProcessingError, closes this object and throws resulting error.\n     * See closeWithError() for more details\n     * Ideally such situation never happens, as consumers of DDS should never throw exceptions\n     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).\n     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.\n     * DDS state does not match what user sees. Because of it DDS moves to \"corrupted state\" and does not\n     * allow processing of ops or local changes, which very quickly results in container closure.\n     */\n    private eventListenerErrorHandler(event: EventEmitterEventType, e: any) {\n        const error = DataProcessingError.wrapIfUnrecognized(\n            e,\n            \"SharedObjectEventListenerException\");\n        error.addTelemetryProperties({ emittedEventName: String(event) });\n\n        this.closeWithError(error);\n        throw error;\n    }\n\n    private attachListeners() {\n        // Only listen to these events if not attached.\n        if (!this.isAttached()) {\n            this.runtime.once(\"attaching\", () => {\n                // Calling this will let the dds to do any custom processing based on attached\n                // like starting generating ops.\n                this.didAttach();\n            });\n        }\n    }\n\n    /**\n     * A shared object, after construction, can either be loaded in the case that it is already part of\n     * a shared document. Or later attached if it is being newly added.\n     * @param services - Services used by the shared object\n     */\n    public async load(services: IChannelServices): Promise<void> {\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.services = services;\n        }\n        await this.loadCore(services.objectStorage);\n        if (this.runtime.attachState !== AttachState.Detached) {\n            this.attachDeltaHandler();\n        }\n    }\n\n    /**\n     * Initializes the object as a local, non-shared object. This object can become shared after\n     * it is attached to the document.\n     */\n    public initializeLocal(): void {\n        this.initializeLocalCore();\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).bindToContext}\n     */\n    public bindToContext(): void {\n        if (this._isBoundToContext) {\n            return;\n        }\n\n        this._isBoundToContext = true;\n\n        this.runtime.bindChannel(this);\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}\n     */\n    public connect(services: IChannelServices) {\n        this.services = services;\n        this.attachDeltaHandler();\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).isAttached}\n     */\n    public isAttached(): boolean {\n        return this.services !== undefined && this.runtime.attachState !== AttachState.Detached;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n     */\n    public abstract getAttachSummary(\n        fullTree?: boolean,\n        trackState?: boolean,\n        telemetryContext?: ITelemetryContext,\n    ): ISummaryTreeWithStats;\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n     */\n    public abstract summarize(\n        fullTree?: boolean,\n        trackState?: boolean,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public abstract getGCData(fullGC?: boolean): IGarbageCollectionData;\n\n    /**\n     * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference\n     * to another object in the container.\n     * @param decodedHandle - The handle of the Fluid object that is decoded.\n     */\n    protected handleDecoded(decodedHandle: IFluidHandle) {\n        if (this.isAttached()) {\n            // This represents an outbound reference from this object to the node represented by decodedHandle.\n            this.services?.deltaConnection.addedGCOutboundReference?.(this.handle, decodedHandle);\n        }\n    }\n\n    /**\n     * Allows the distributed data type to perform custom loading\n     * @param services - Storage used by the shared object\n     */\n    protected abstract loadCore(services: IChannelStorageService): Promise<void>;\n\n    /**\n     * Allows the distributed data type to perform custom local loading.\n     */\n    protected initializeLocalCore() {\n        return;\n    }\n\n    /**\n     * Allows the 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            rollback: (content: any, localOpMetadata: unknown) => {\n                this.rollback(content, localOpMetadata);\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 ConsensusOrderedCollection 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    /**\n     * Revert an op\n     */\n    protected rollback(content: any, localOpMetadata: unknown) {\n        throw new Error(\"rollback not supported\");\n    }\n\n    /**\n     * Apply changes from an op. Used when rehydrating an attached container\n     * with pending changes. This prepares the SharedObject for seeing an ACK\n     * for the op or resubmitting the op upon reconnection.\n     * @param content - Contents of a stashed op.\n     * @returns localMetadata of the op, to be passed to process() or resubmit()\n     * when the op is ACKed or resubmitted, respectively\n     */\n    protected abstract applyStashedOp(content: any): unknown;\n}\n\n/**\n * SharedObject with simplified, synchronous summarization and GC.\n * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.\n */\nexport abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n    extends SharedObjectCore<TEvent> {\n    /**\n     * True while we are garbage collecting this object's data.\n     */\n    private _isGCing: boolean = false;\n\n    /**\n     * The serializer to use to serialize / parse handles, if any.\n     */\n    private readonly _serializer: IFluidSerializer;\n\n    protected get serializer(): IFluidSerializer {\n        /**\n         * During garbage collection, the SummarySerializer keeps track of IFluidHandles that are serialized. These\n         * handles represent references to other Fluid objects.\n         *\n         * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content\n         * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.\n         */\n        assert(!this._isGCing,\n            0x075 /* \"SummarySerializer should be used for serializing data during summary.\" */);\n        return this._serializer;\n    }\n\n    /**\n     * @param id - The id of the shared object\n     * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n     * @param attributes - Attributes of the shared object\n     */\n    constructor(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        private readonly telemetryContextPrefix: string,\n    ) {\n        super(id, runtime, attributes);\n\n        this._serializer = new FluidSerializer(\n            this.runtime.channelsRoutingContext,\n            (handle: IFluidHandle) => this.handleDecoded(handle),\n        );\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n     */\n    public getAttachSummary(\n        fullTree: boolean = false,\n        trackState: boolean = false,\n        telemetryContext?: ITelemetryContext,\n    ): ISummaryTreeWithStats {\n        const result = this.summarizeCore(this.serializer, telemetryContext);\n        this.incrementTelemetryMetric(blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);\n        this.incrementTelemetryMetric(totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);\n        return result;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n     */\n    public async summarize(\n        fullTree: boolean = false,\n        trackState: boolean = false,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummaryTreeWithStats> {\n        const result = this.summarizeCore(this.serializer, telemetryContext);\n        this.incrementTelemetryMetric(blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);\n        this.incrementTelemetryMetric(totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);\n        return result;\n    }\n\n    /**\n     * {@inheritDoc (ISharedObject:interface).getGCData}\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        // Set _isGCing to true. This flag is used to ensure that we only use SummarySerializer to serialize handles\n        // in this object's data.\n        assert(!this._isGCing, 0x078 /* \"Possible re-entrancy! Summary should not already be in progress.\" */);\n        this._isGCing = true;\n\n        let gcData: IGarbageCollectionData;\n        try {\n            const serializer = new SummarySerializer(\n                this.runtime.channelsRoutingContext,\n                (handle: IFluidHandle) => this.handleDecoded(handle),\n            );\n            this.processGCDataCore(serializer);\n            // The GC data for this shared object contains a single GC node. The outbound routes of this node are the\n            // routes of handles serialized during summarization.\n            gcData = { gcNodes: { \"/\": serializer.getSerializedRoutes() } };\n            assert(this._isGCing, 0x079 /* \"Possible re-entrancy! Summary should have been in progress.\" */);\n        } finally {\n            this._isGCing = false;\n        }\n\n        return gcData;\n    }\n\n    /**\n     * Calls the serializer over all data in this object that reference other GC nodes.\n     * Derived classes must override this to provide custom list of references to other GC nodes.\n     */\n    protected processGCDataCore(serializer: SummarySerializer) {\n        // We run the full summarize logic to get the list of outbound routes from this object. This is a little\n        // expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.\n        // See: https://github.com/microsoft/FluidFramework/issues/4547\n        this.summarizeCore(serializer);\n    }\n\n    /**\n     * Gets a form of the object that can be serialized.\n     * @returns A tree representing the snapshot of the shared object.\n     */\n    protected abstract summarizeCore(\n        serializer: IFluidSerializer,\n        telemetryContext?: ITelemetryContext,\n    ): ISummaryTreeWithStats;\n\n    private incrementTelemetryMetric(propertyName: string, incrementBy: number, telemetryContext?: ITelemetryContext) {\n        const prevTotal = (telemetryContext?.get(this.telemetryContextPrefix, propertyName) ?? 0) as number;\n        telemetryContext?.set(this.telemetryContextPrefix, propertyName, prevTotal + incrementBy);\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/shared-object-base",
-  "version": "0.59.4001",
+  "version": "1.1.0-75972",
   "description": "Fluid base class for shared distributed data structures",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -63,47 +63,35 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^0.48.2000",
-    "@fluidframework/container-runtime": "^0.59.4001",
-    "@fluidframework/container-utils": "^0.59.4001",
-    "@fluidframework/core-interfaces": "^0.43.1000",
-    "@fluidframework/datastore": "^0.59.4001",
-    "@fluidframework/datastore-definitions": "^0.59.4001",
+    "@fluidframework/container-definitions": "1.1.0-75972",
+    "@fluidframework/container-runtime": "1.1.0-75972",
+    "@fluidframework/container-utils": "1.1.0-75972",
+    "@fluidframework/core-interfaces": "1.1.0-75972",
+    "@fluidframework/datastore": "1.1.0-75972",
+    "@fluidframework/datastore-definitions": "1.1.0-75972",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "^0.59.4001",
-    "@fluidframework/runtime-utils": "^0.59.4001",
-    "@fluidframework/telemetry-utils": "^0.59.4001",
+    "@fluidframework/runtime-definitions": "1.1.0-75972",
+    "@fluidframework/runtime-utils": "1.1.0-75972",
+    "@fluidframework/telemetry-utils": "1.1.0-75972",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.70857",
+    "@fluidframework/build-common": "^0.24.0-0",
+    "@fluidframework/build-tools": "^0.2.71273",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^0.59.4001",
-    "@fluidframework/shared-object-base-previous": "npm:@fluidframework/shared-object-base@0.59.4000",
+    "@fluidframework/mocha-test-setup": "1.1.0-75972",
+    "@fluidframework/shared-object-base-previous": "npm:@fluidframework/shared-object-base@^1.0.0",
+    "@fluidframework/test-runtime-utils": "1.1.0-75972",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/benchmark": "^2.1.0",
     "@types/mocha": "^9.1.1",
     "@types/node": "^14.18.0",
-    "@typescript-eslint/eslint-plugin": "~5.9.0",
-    "@typescript-eslint/parser": "~5.9.0",
     "benchmark": "^2.1.4",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "cross-env": "^7.0.2",
     "eslint": "~8.6.0",
-    "eslint-plugin-editorconfig": "~3.2.0",
-    "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-jest": "~26.1.3",
-    "eslint-plugin-jsdoc": "~39.3.0",
-    "eslint-plugin-mocha": "~10.0.3",
-    "eslint-plugin-promise": "~6.0.0",
-    "eslint-plugin-react": "~7.28.0",
-    "eslint-plugin-tsdoc": "~0.2.14",
-    "eslint-plugin-unicorn": "~40.0.0",
-    "eslint-plugin-unused-imports": "~2.0.0",
     "mocha": "^10.0.0",
     "nyc": "^15.0.0",
     "rimraf": "^2.6.2",
@@ -112,7 +100,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.4001",
+    "version": "1.1.0",
     "broken": {}
   }
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/shared-object-base";
-export const pkgVersion = "0.59.4001";
+export const pkgVersion = "1.1.0-75972";

package/src/serializer.ts

@@ -177,7 +177,6 @@ export class FluidSerializer implements IFluidSerializer {
         }
 
         // Otherwise descend into the object graph looking for IFluidHandle instances.
-        // eslint-disable-next-line @typescript-eslint/ban-types
         let clone: object | undefined;
         for (const key of Object.keys(input)) {
             const value = input[key];

package/src/sharedObject.ts

@@ -18,6 +18,9 @@ import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions"
 import {
     IGarbageCollectionData,
     ISummaryTreeWithStats,
+    ITelemetryContext,
+    blobCountPropertyName,
+    totalBlobSizePropertyName,
 } from "@fluidframework/runtime-definitions";
 import { ChildLogger, EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
 import { DataProcessingError } from "@fluidframework/container-utils";
@@ -82,6 +85,8 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
         public readonly attributes: IChannelAttributes) {
         super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));
 
+        assert(!id.includes("/"), 0x304 /* Id cannot contain slashes */);
+
         this.handle = new SharedObjectHandle(
             this,
             id,
@@ -201,12 +206,20 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */
-    public abstract getAttachSummary(fullTree?: boolean, trackState?: boolean): ISummaryTreeWithStats;
+    public abstract getAttachSummary(
+        fullTree?: boolean,
+        trackState?: boolean,
+        telemetryContext?: ITelemetryContext,
+    ): ISummaryTreeWithStats;
 
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    public abstract summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;
+    public abstract summarize(
+        fullTree?: boolean,
+        trackState?: boolean,
+        telemetryContext?: ITelemetryContext,
+    ): Promise<ISummaryTreeWithStats>;
 
     /**
      * {@inheritDoc (ISharedObject:interface).getGCData}
@@ -354,6 +367,9 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
             applyStashedOp: (content: any): unknown => {
                 return this.applyStashedOp(content);
             },
+            rollback: (content: any, localOpMetadata: unknown) => {
+                this.rollback(content, localOpMetadata);
+            },
         });
 
         // Trigger initial state
@@ -382,7 +398,7 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
             // - nack could get a new msn - but might as well do it in the join?
             this.onDisconnect();
         } else {
-            // Call this for now so that DDSes like ConsensesOrderedCollection that maintain their own pending
+            // Call this for now so that DDSes like ConsensusOrderedCollection that maintain their own pending
             // messages will work.
             this.onConnect();
         }
@@ -412,6 +428,13 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
         this.reSubmitCore(content, localOpMetadata);
     }
 
+    /**
+     * Revert an op
+     */
+    protected rollback(content: any, localOpMetadata: unknown) {
+        throw new Error("rollback not supported");
+    }
+
     /**
      * Apply changes from an op. Used when rehydrating an attached container
      * with pending changes. This prepares the SharedObject for seeing an ACK
@@ -460,7 +483,9 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
     constructor(
         id: string,
         runtime: IFluidDataStoreRuntime,
-        attributes: IChannelAttributes) {
+        attributes: IChannelAttributes,
+        private readonly telemetryContextPrefix: string,
+    ) {
         super(id, runtime, attributes);
 
         this._serializer = new FluidSerializer(
@@ -472,15 +497,29 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */
-    public getAttachSummary(fullTree: boolean = false, trackState: boolean = false): ISummaryTreeWithStats {
-        return this.summarizeCore(this.serializer);
+    public getAttachSummary(
+        fullTree: boolean = false,
+        trackState: boolean = false,
+        telemetryContext?: ITelemetryContext,
+    ): ISummaryTreeWithStats {
+        const result = this.summarizeCore(this.serializer, telemetryContext);
+        this.incrementTelemetryMetric(blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);
+        this.incrementTelemetryMetric(totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);
+        return result;
     }
 
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    public async summarize(fullTree: boolean = false, trackState: boolean = false): Promise<ISummaryTreeWithStats> {
-        return this.summarizeCore(this.serializer);
+    public async summarize(
+        fullTree: boolean = false,
+        trackState: boolean = false,
+        telemetryContext?: ITelemetryContext,
+    ): Promise<ISummaryTreeWithStats> {
+        const result = this.summarizeCore(this.serializer, telemetryContext);
+        this.incrementTelemetryMetric(blobCountPropertyName, result.stats.blobNodeCount, telemetryContext);
+        this.incrementTelemetryMetric(totalBlobSizePropertyName, result.stats.totalBlobSize, telemetryContext);
+        return result;
     }
 
     /**
@@ -525,5 +564,13 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
      * Gets a form of the object that can be serialized.
      * @returns A tree representing the snapshot of the shared object.
      */
-    protected abstract summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    protected abstract summarizeCore(
+        serializer: IFluidSerializer,
+        telemetryContext?: ITelemetryContext,
+    ): ISummaryTreeWithStats;
+
+    private incrementTelemetryMetric(propertyName: string, incrementBy: number, telemetryContext?: ITelemetryContext) {
+        const prevTotal = (telemetryContext?.get(this.telemetryContextPrefix, propertyName) ?? 0) as number;
+        telemetryContext?.set(this.telemetryContextPrefix, propertyName, prevTotal + incrementBy);
+    }
 }