@fluidframework/runtime-utils 2.0.0-internal.2.1.1 → 2.0.0-internal.2.2.0

package/.eslintrc.js

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

package/dist/dataStoreHelpers.d.ts

@@ -2,10 +2,15 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { ITaggedTelemetryPropertyType } from "@fluidframework/common-definitions";
 import { FluidObject, IFluidRouter, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import { IFluidDataStoreFactory, IFluidDataStoreRegistry, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions";
 export declare function exceptionToResponse(err: any): IResponse;
 export declare function responseToException(response: IResponse, request: IRequest): Error;
+/**
+ * Takes a set of packages and joins them pkg1/pkg2... etc. Tags the field as a code artifact
+ */
+export declare function packagePathToTelemetryProperty(packagePath: readonly string[] | undefined): ITaggedTelemetryPropertyType | undefined;
 export declare function requestFluidObject<T = FluidObject>(router: IFluidRouter, url: string | IRequest): Promise<T>;
 export declare const create404Response: (request: IRequest) => IResponse;
 export declare function createResponseError(status: number, value: string, request: IRequest): IResponse;

package/dist/dataStoreHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreHelpers.d.ts","sourceRoot":"","sources":["../src/dataStoreHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,uBAAuB,EACvB,8BAA8B,EACjC,MAAM,qCAAqC,CAAC;AAU7C,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAqBvD;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,GAAG,KAAK,CAYjF;AAED,wBAAsB,kBAAkB,CAAC,CAAC,GAAG,WAAW,EACpD,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,CAU5D;AAED,eAAO,MAAM,iBAAiB,YAAa,QAAQ,cAAmD,CAAC;AAEvG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,CAc/F;AAED,oBAAY,OAAO,GAAG,sBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;AAEvF,wBAAgB,sBAAsB,CAClC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAChC,sBAAsB,GAAG,uBAAuB,CAQtD"}
+{"version":3,"file":"dataStoreHelpers.d.ts","sourceRoot":"","sources":["../src/dataStoreHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAElF,OAAO,EACH,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,uBAAuB,EACvB,8BAA8B,EACjC,MAAM,qCAAqC,CAAC;AAU7C,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAqBvD;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,GAAG,KAAK,CAYjF;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC1C,WAAW,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,GAC3C,4BAA4B,GAAG,SAAS,CAE1C;AAED,wBAAsB,kBAAkB,CAAC,CAAC,GAAG,WAAW,EACpD,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,CAU5D;AAED,eAAO,MAAM,iBAAiB,YAAa,QAAQ,cAAmD,CAAC;AAEvG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,CAc/F;AAED,oBAAY,OAAO,GAAG,sBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;AAEvF,wBAAgB,sBAAsB,CAClC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAChC,sBAAsB,GAAG,uBAAuB,CAQtD"}

package/dist/dataStoreHelpers.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDataStoreFactory = exports.createResponseError = exports.create404Response = exports.requestFluidObject = exports.responseToException = exports.exceptionToResponse = void 0;
+exports.createDataStoreFactory = exports.createResponseError = exports.create404Response = exports.requestFluidObject = exports.packagePathToTelemetryProperty = exports.responseToException = exports.exceptionToResponse = void 0;
 const common_utils_1 = require("@fluidframework/common-utils");
 const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 function exceptionToResponse(err) {
@@ -41,6 +41,13 @@ function responseToException(response, request) {
     return responseErr;
 }
 exports.responseToException = responseToException;
+/**
+ * Takes a set of packages and joins them pkg1/pkg2... etc. Tags the field as a code artifact
+ */
+function packagePathToTelemetryProperty(packagePath) {
+    return packagePath ? { value: packagePath.join("/"), tag: telemetry_utils_1.TelemetryDataTag.CodeArtifact } : undefined;
+}
+exports.packagePathToTelemetryProperty = packagePathToTelemetryProperty;
 async function requestFluidObject(router, url) {
     const request = typeof url === "string" ? { url } : url;
     const response = await router.request(request);

package/dist/dataStoreHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreHelpers.js","sourceRoot":"","sources":["../src/dataStoreHelpers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAYtD,qEAAyE;AASzE,SAAgB,mBAAmB,CAAC,GAAQ;IACxC,MAAM,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,2BAA2B,KAAK,IAAI,EAAE;QACrF,MAAM,WAAW,GAAuB,GAAG,CAAC;QAC5C,OAAO;YACH,QAAQ,EAAE,YAAY;YACtB,MAAM,EAAE,WAAW,CAAC,IAAI;YACxB,KAAK,EAAE,WAAW,CAAC,OAAO;YAC1B,IAAI,KAAK,KAAK,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;SAC5C,CAAC;KACL;IAED,0GAA0G;IAC1G,MAAM,YAAY,GAAG,IAAA,wCAAsB,GAAE,CAAC;IAE9C,OAAO;QACH,QAAQ,EAAE,YAAY;QACtB,MAAM;QACN,KAAK,EAAE,GAAG,GAAG,EAAE;QACf,IAAI,KAAK,aAAK,OAAO,MAAC,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAA0B,mCAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KACvF,CAAC;AACN,CAAC;AArBD,kDAqBC;AAED,SAAgB,mBAAmB,CAAC,QAAmB,EAAE,OAAiB;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC/B,MAAM,YAAY,GAAG,IAAA,wCAAsB,GAAE,CAAC;IAC9C,MAAM,WAAW,GAA+B;QAC5C,2BAA2B,EAAE,IAAI;QACjC,OAAO;QACP,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,QAAQ,CAAC,MAAM;QACrB,IAAI,KAAK,aAAK,OAAO,MAAA,QAAQ,CAAC,KAAK,mCAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KAC/D,CAAC;IAEF,OAAO,WAAW,CAAC;AACvB,CAAC;AAZD,kDAYC;AAEM,KAAK,UAAU,kBAAkB,CACpC,MAAoB,EAAE,GAAsB;IAC5C,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACxD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,QAAQ,KAAK,cAAc,EAAE;QACjE,MAAM,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KAChD;IAED,IAAA,qBAAM,EAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;IACtF,OAAO,QAAQ,CAAC,KAAU,CAAC;AAC/B,CAAC;AAXD,gDAWC;AAEM,MAAM,iBAAiB,GAAG,CAAC,OAAiB,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;AAA1F,QAAA,iBAAiB,qBAAyE;AAEvG,SAAgB,mBAAmB,CAAC,MAAc,EAAE,KAAa,EAAE,OAAiB;;IAChF,IAAA,qBAAM,EAAC,MAAM,KAAK,GAAG,EAAE,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACrF,kEAAkE;IAClE,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,GAAG,0CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAE9C,0GAA0G;IAC1G,MAAM,YAAY,GAAG,IAAA,wCAAsB,GAAE,CAAC;IAE9C,OAAO;QACH,QAAQ,EAAE,YAAY;QACtB,MAAM;QACN,KAAK,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,UAAU,EAAE;QACnE,IAAI,KAAK,KAAK,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KAC7C,CAAC;AACN,CAAC;AAdD,kDAcC;AAID,SAAgB,sBAAsB,CAClC,IAAY,EACZ,OAAmC;IAEnC,OAAO;QACH,IAAI;QACJ,IAAI,sBAAsB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC7C,IAAI,uBAAuB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC9C,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,OAAO,CAAC,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC1G,GAAG,EAAE,KAAK,EAAE,IAAY,EAAE,EAAE,WAAC,OAAA,MAAA,CAAC,MAAM,OAAO,CAAC,CAAC,uBAAuB,0CAAE,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA;KAClF,CAAC;AACN,CAAC;AAXD,wDAWC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    FluidObject,\n    IFluidRouter,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IFluidDataStoreFactory,\n    IFluidDataStoreRegistry,\n    IProvideFluidDataStoreRegistry,\n} from \"@fluidframework/runtime-definitions\";\nimport { generateErrorWithStack } from \"@fluidframework/telemetry-utils\";\n\ninterface IResponseException extends Error {\n    errorFromRequestFluidObject: true;\n    message: string;\n    code: number;\n    stack?: string;\n}\n\nexport function exceptionToResponse(err: any): IResponse {\n    const status = 500;\n    if (err !== null && typeof err === \"object\" && err.errorFromRequestFluidObject === true) {\n        const responseErr: IResponseException = err;\n        return {\n            mimeType: \"text/plain\",\n            status: responseErr.code,\n            value: responseErr.message,\n            get stack() { return responseErr.stack; },\n        };\n    }\n\n    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it\n    const errWithStack = generateErrorWithStack();\n\n    return {\n        mimeType: \"text/plain\",\n        status,\n        value: `${err}`,\n        get stack() { return ((err?.stack) as (string | undefined)) ?? errWithStack.stack; },\n    };\n}\n\nexport function responseToException(response: IResponse, request: IRequest): Error {\n    const message = response.value;\n    const errWithStack = generateErrorWithStack();\n    const responseErr: Error & IResponseException = {\n        errorFromRequestFluidObject: true,\n        message,\n        name: \"Error\",\n        code: response.status,\n        get stack() { return response.stack ?? errWithStack.stack; },\n    };\n\n    return responseErr;\n}\n\nexport async function requestFluidObject<T = FluidObject>(\n    router: IFluidRouter, url: string | IRequest): Promise<T> {\n    const request = typeof url === \"string\" ? { url } : url;\n    const response = await router.request(request);\n\n    if (response.status !== 200 || response.mimeType !== \"fluid/object\") {\n        throw responseToException(response, request);\n    }\n\n    assert(response.value, 0x19a /* \"Invalid response value for Fluid object request\" */);\n    return response.value as T;\n}\n\nexport const create404Response = (request: IRequest) => createResponseError(404, \"not found\", request);\n\nexport function createResponseError(status: number, value: string, request: IRequest): IResponse {\n    assert(status !== 200, 0x19b /* \"Cannot not create response error on 200 status\" */);\n    // Omit query string which could contain personal data (aka \"PII\")\n    const urlNoQuery = request.url?.split(\"?\")[0];\n\n    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it\n    const errWithStack = generateErrorWithStack();\n\n    return {\n        mimeType: \"text/plain\",\n        status,\n        value: urlNoQuery === undefined ? value : `${value}: ${urlNoQuery}`,\n        get stack() { return errWithStack.stack; },\n    };\n}\n\nexport type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;\n\nexport function createDataStoreFactory(\n    type: string,\n    factory: Factory | Promise<Factory>,\n    ): IFluidDataStoreFactory & IFluidDataStoreRegistry {\n    return {\n        type,\n        get IFluidDataStoreFactory() { return this; },\n        get IFluidDataStoreRegistry() { return this; },\n        instantiateDataStore: async (context, existing) => (await factory).instantiateDataStore(context, existing),\n        get: async (name: string) => (await factory).IFluidDataStoreRegistry?.get(name),\n    };\n}\n"]}
+{"version":3,"file":"dataStoreHelpers.js","sourceRoot":"","sources":["../src/dataStoreHelpers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAsD;AAYtD,qEAA2F;AAS3F,SAAgB,mBAAmB,CAAC,GAAQ;IACxC,MAAM,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,2BAA2B,KAAK,IAAI,EAAE;QACrF,MAAM,WAAW,GAAuB,GAAG,CAAC;QAC5C,OAAO;YACH,QAAQ,EAAE,YAAY;YACtB,MAAM,EAAE,WAAW,CAAC,IAAI;YACxB,KAAK,EAAE,WAAW,CAAC,OAAO;YAC1B,IAAI,KAAK,KAAK,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;SAC5C,CAAC;KACL;IAED,0GAA0G;IAC1G,MAAM,YAAY,GAAG,IAAA,wCAAsB,GAAE,CAAC;IAE9C,OAAO;QACH,QAAQ,EAAE,YAAY;QACtB,MAAM;QACN,KAAK,EAAE,GAAG,GAAG,EAAE;QACf,IAAI,KAAK,aAAK,OAAO,MAAC,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAA0B,mCAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KACvF,CAAC;AACN,CAAC;AArBD,kDAqBC;AAED,SAAgB,mBAAmB,CAAC,QAAmB,EAAE,OAAiB;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC/B,MAAM,YAAY,GAAG,IAAA,wCAAsB,GAAE,CAAC;IAC9C,MAAM,WAAW,GAA+B;QAC5C,2BAA2B,EAAE,IAAI;QACjC,OAAO;QACP,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,QAAQ,CAAC,MAAM;QACrB,IAAI,KAAK,aAAK,OAAO,MAAA,QAAQ,CAAC,KAAK,mCAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KAC/D,CAAC;IAEF,OAAO,WAAW,CAAC;AACvB,CAAC;AAZD,kDAYC;AAED;;GAEG;AACH,SAAgB,8BAA8B,CAC1C,WAA0C;IAE1C,OAAO,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,kCAAgB,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1G,CAAC;AAJD,wEAIC;AAEM,KAAK,UAAU,kBAAkB,CACpC,MAAoB,EAAE,GAAsB;IAC5C,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACxD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,QAAQ,KAAK,cAAc,EAAE;QACjE,MAAM,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KAChD;IAED,IAAA,qBAAM,EAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;IACtF,OAAO,QAAQ,CAAC,KAAU,CAAC;AAC/B,CAAC;AAXD,gDAWC;AAEM,MAAM,iBAAiB,GAAG,CAAC,OAAiB,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;AAA1F,QAAA,iBAAiB,qBAAyE;AAEvG,SAAgB,mBAAmB,CAAC,MAAc,EAAE,KAAa,EAAE,OAAiB;;IAChF,IAAA,qBAAM,EAAC,MAAM,KAAK,GAAG,EAAE,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACrF,kEAAkE;IAClE,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,GAAG,0CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAE9C,0GAA0G;IAC1G,MAAM,YAAY,GAAG,IAAA,wCAAsB,GAAE,CAAC;IAE9C,OAAO;QACH,QAAQ,EAAE,YAAY;QACtB,MAAM;QACN,KAAK,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,UAAU,EAAE;QACnE,IAAI,KAAK,KAAK,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KAC7C,CAAC;AACN,CAAC;AAdD,kDAcC;AAID,SAAgB,sBAAsB,CAClC,IAAY,EACZ,OAAmC;IAEnC,OAAO;QACH,IAAI;QACJ,IAAI,sBAAsB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC7C,IAAI,uBAAuB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC9C,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,OAAO,CAAC,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC1G,GAAG,EAAE,KAAK,EAAE,IAAY,EAAE,EAAE,WAAC,OAAA,MAAA,CAAC,MAAM,OAAO,CAAC,CAAC,uBAAuB,0CAAE,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA;KAClF,CAAC;AACN,CAAC;AAXD,wDAWC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITaggedTelemetryPropertyType } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    FluidObject,\n    IFluidRouter,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IFluidDataStoreFactory,\n    IFluidDataStoreRegistry,\n    IProvideFluidDataStoreRegistry,\n} from \"@fluidframework/runtime-definitions\";\nimport { generateErrorWithStack, TelemetryDataTag } from \"@fluidframework/telemetry-utils\";\n\ninterface IResponseException extends Error {\n    errorFromRequestFluidObject: true;\n    message: string;\n    code: number;\n    stack?: string;\n}\n\nexport function exceptionToResponse(err: any): IResponse {\n    const status = 500;\n    if (err !== null && typeof err === \"object\" && err.errorFromRequestFluidObject === true) {\n        const responseErr: IResponseException = err;\n        return {\n            mimeType: \"text/plain\",\n            status: responseErr.code,\n            value: responseErr.message,\n            get stack() { return responseErr.stack; },\n        };\n    }\n\n    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it\n    const errWithStack = generateErrorWithStack();\n\n    return {\n        mimeType: \"text/plain\",\n        status,\n        value: `${err}`,\n        get stack() { return ((err?.stack) as (string | undefined)) ?? errWithStack.stack; },\n    };\n}\n\nexport function responseToException(response: IResponse, request: IRequest): Error {\n    const message = response.value;\n    const errWithStack = generateErrorWithStack();\n    const responseErr: Error & IResponseException = {\n        errorFromRequestFluidObject: true,\n        message,\n        name: \"Error\",\n        code: response.status,\n        get stack() { return response.stack ?? errWithStack.stack; },\n    };\n\n    return responseErr;\n}\n\n/**\n * Takes a set of packages and joins them pkg1/pkg2... etc. Tags the field as a code artifact\n */\nexport function packagePathToTelemetryProperty(\n    packagePath: readonly string[] | undefined,\n): ITaggedTelemetryPropertyType | undefined {\n    return packagePath ? { value: packagePath.join(\"/\"), tag: TelemetryDataTag.CodeArtifact } : undefined;\n}\n\nexport async function requestFluidObject<T = FluidObject>(\n    router: IFluidRouter, url: string | IRequest): Promise<T> {\n    const request = typeof url === \"string\" ? { url } : url;\n    const response = await router.request(request);\n\n    if (response.status !== 200 || response.mimeType !== \"fluid/object\") {\n        throw responseToException(response, request);\n    }\n\n    assert(response.value, 0x19a /* \"Invalid response value for Fluid object request\" */);\n    return response.value as T;\n}\n\nexport const create404Response = (request: IRequest) => createResponseError(404, \"not found\", request);\n\nexport function createResponseError(status: number, value: string, request: IRequest): IResponse {\n    assert(status !== 200, 0x19b /* \"Cannot not create response error on 200 status\" */);\n    // Omit query string which could contain personal data (aka \"PII\")\n    const urlNoQuery = request.url?.split(\"?\")[0];\n\n    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it\n    const errWithStack = generateErrorWithStack();\n\n    return {\n        mimeType: \"text/plain\",\n        status,\n        value: urlNoQuery === undefined ? value : `${value}: ${urlNoQuery}`,\n        get stack() { return errWithStack.stack; },\n    };\n}\n\nexport type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;\n\nexport function createDataStoreFactory(\n    type: string,\n    factory: Factory | Promise<Factory>,\n    ): IFluidDataStoreFactory & IFluidDataStoreRegistry {\n    return {\n        type,\n        get IFluidDataStoreFactory() { return this; },\n        get IFluidDataStoreRegistry() { return this; },\n        instantiateDataStore: async (context, existing) => (await factory).instantiateDataStore(context, existing),\n        get: async (name: string) => (await factory).IFluidDataStoreRegistry?.get(name),\n    };\n}\n"]}

package/dist/index.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 export { generateHandleContextPath } from "./dataStoreHandleContextUtils";
-export { create404Response, createDataStoreFactory, createResponseError, exceptionToResponse, Factory, requestFluidObject, responseToException, } from "./dataStoreHelpers";
+export { create404Response, createDataStoreFactory, createResponseError, exceptionToResponse, Factory, packagePathToTelemetryProperty, requestFluidObject, responseToException, } from "./dataStoreHelpers";
 export { ObjectStoragePartition } from "./objectstoragepartition";
 export { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from "./objectstorageutils";
 export { RequestParser } from "./requestParser";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,OAAO,EACP,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACN,wBAAwB,EACxB,8BAA8B,EAC9B,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,EAC3B,oBAAoB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,gBAAgB,EAChB,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,OAAO,EACJ,8BAA8B,EACjC,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACN,wBAAwB,EACxB,8BAA8B,EAC9B,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,EAC3B,oBAAoB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,gBAAgB,EAChB,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.seqFromTree = exports.utf8ByteLength = exports.TelemetryContext = exports.SummaryTreeBuilder = exports.mergeStats = exports.getBlobSize = exports.convertToSummaryTreeWithStats = exports.convertToSummaryTree = exports.convertSummaryTreeToITree = exports.convertSnapshotTreeToSummaryTree = exports.calculateStats = exports.addTreeToSummary = exports.addSummarizeResultToSummary = exports.addBlobToSummary = exports.createRootSummarizerNodeWithGC = exports.createRootSummarizerNode = exports.RuntimeFactoryHelper = exports.RequestParser = exports.listBlobsAtTreePath = exports.getNormalizedObjectStoragePathParts = exports.ObjectStoragePartition = exports.responseToException = exports.requestFluidObject = exports.exceptionToResponse = exports.createResponseError = exports.createDataStoreFactory = exports.create404Response = exports.generateHandleContextPath = void 0;
+exports.seqFromTree = exports.utf8ByteLength = exports.TelemetryContext = exports.SummaryTreeBuilder = exports.mergeStats = exports.getBlobSize = exports.convertToSummaryTreeWithStats = exports.convertToSummaryTree = exports.convertSummaryTreeToITree = exports.convertSnapshotTreeToSummaryTree = exports.calculateStats = exports.addTreeToSummary = exports.addSummarizeResultToSummary = exports.addBlobToSummary = exports.createRootSummarizerNodeWithGC = exports.createRootSummarizerNode = exports.RuntimeFactoryHelper = exports.RequestParser = exports.listBlobsAtTreePath = exports.getNormalizedObjectStoragePathParts = exports.ObjectStoragePartition = exports.responseToException = exports.requestFluidObject = exports.packagePathToTelemetryProperty = exports.exceptionToResponse = exports.createResponseError = exports.createDataStoreFactory = exports.create404Response = exports.generateHandleContextPath = void 0;
 var dataStoreHandleContextUtils_1 = require("./dataStoreHandleContextUtils");
 Object.defineProperty(exports, "generateHandleContextPath", { enumerable: true, get: function () { return dataStoreHandleContextUtils_1.generateHandleContextPath; } });
 var dataStoreHelpers_1 = require("./dataStoreHelpers");
@@ -12,6 +12,7 @@ Object.defineProperty(exports, "create404Response", { enumerable: true, get: fun
 Object.defineProperty(exports, "createDataStoreFactory", { enumerable: true, get: function () { return dataStoreHelpers_1.createDataStoreFactory; } });
 Object.defineProperty(exports, "createResponseError", { enumerable: true, get: function () { return dataStoreHelpers_1.createResponseError; } });
 Object.defineProperty(exports, "exceptionToResponse", { enumerable: true, get: function () { return dataStoreHelpers_1.exceptionToResponse; } });
+Object.defineProperty(exports, "packagePathToTelemetryProperty", { enumerable: true, get: function () { return dataStoreHelpers_1.packagePathToTelemetryProperty; } });
 Object.defineProperty(exports, "requestFluidObject", { enumerable: true, get: function () { return dataStoreHelpers_1.requestFluidObject; } });
 Object.defineProperty(exports, "responseToException", { enumerable: true, get: function () { return dataStoreHelpers_1.responseToException; } });
 var objectstoragepartition_1 = require("./objectstoragepartition");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6EAA0E;AAAjE,wIAAA,yBAAyB,OAAA;AAClC,uDAQ4B;AAP3B,qHAAA,iBAAiB,OAAA;AACjB,0HAAA,sBAAsB,OAAA;AACtB,uHAAA,mBAAmB,OAAA;AACnB,uHAAA,mBAAmB,OAAA;AAEnB,sHAAA,kBAAkB,OAAA;AAClB,uHAAA,mBAAmB,OAAA;AAEpB,mEAAkE;AAAzD,gIAAA,sBAAsB,OAAA;AAC/B,2DAAgG;AAAvF,yIAAA,mCAAmC,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AACjE,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,+DAA8D;AAArD,4HAAA,oBAAoB,OAAA;AAC7B,mDAO0B;AANzB,0HAAA,wBAAwB,OAAA;AACxB,gIAAA,8BAA8B,OAAA;AAM/B,+CAcwB;AAbvB,gHAAA,gBAAgB,OAAA;AAChB,2HAAA,2BAA2B,OAAA;AAC3B,gHAAA,gBAAgB,OAAA;AAChB,8GAAA,cAAc,OAAA;AACd,gIAAA,gCAAgC,OAAA;AAChC,yHAAA,yBAAyB,OAAA;AACzB,oHAAA,oBAAoB,OAAA;AACpB,6HAAA,6BAA6B,OAAA;AAC7B,2GAAA,WAAW,OAAA;AACX,0GAAA,UAAU,OAAA;AACV,kHAAA,kBAAkB,OAAA;AAClB,gHAAA,gBAAgB,OAAA;AAChB,8GAAA,cAAc,OAAA;AAEf,iCAAwD;AAA7B,oGAAA,WAAW,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { generateHandleContextPath } from \"./dataStoreHandleContextUtils\";\nexport {\n\tcreate404Response,\n\tcreateDataStoreFactory,\n\tcreateResponseError,\n\texceptionToResponse,\n\tFactory,\n\trequestFluidObject,\n\tresponseToException,\n} from \"./dataStoreHelpers\";\nexport { ObjectStoragePartition } from \"./objectstoragepartition\";\nexport { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from \"./objectstorageutils\";\nexport { RequestParser } from \"./requestParser\";\nexport { RuntimeFactoryHelper } from \"./runtimeFactoryHelper\";\nexport {\n\tcreateRootSummarizerNode,\n\tcreateRootSummarizerNodeWithGC,\n\tIRootSummarizerNode,\n\tIRootSummarizerNodeWithGC,\n\tISummarizerNodeRootContract,\n\tRefreshSummaryResult,\n} from \"./summarizerNode\";\nexport {\n\taddBlobToSummary,\n\taddSummarizeResultToSummary,\n\taddTreeToSummary,\n\tcalculateStats,\n\tconvertSnapshotTreeToSummaryTree,\n\tconvertSummaryTreeToITree,\n\tconvertToSummaryTree,\n\tconvertToSummaryTreeWithStats,\n\tgetBlobSize,\n\tmergeStats,\n\tSummaryTreeBuilder,\n\tTelemetryContext,\n\tutf8ByteLength,\n} from \"./summaryUtils\";\nexport { ReadAndParseBlob, seqFromTree } from \"./utils\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6EAA0E;AAAjE,wIAAA,yBAAyB,OAAA;AAClC,uDAS4B;AAR3B,qHAAA,iBAAiB,OAAA;AACjB,0HAAA,sBAAsB,OAAA;AACtB,uHAAA,mBAAmB,OAAA;AACnB,uHAAA,mBAAmB,OAAA;AAEhB,kIAAA,8BAA8B,OAAA;AACjC,sHAAA,kBAAkB,OAAA;AAClB,uHAAA,mBAAmB,OAAA;AAEpB,mEAAkE;AAAzD,gIAAA,sBAAsB,OAAA;AAC/B,2DAAgG;AAAvF,yIAAA,mCAAmC,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AACjE,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,+DAA8D;AAArD,4HAAA,oBAAoB,OAAA;AAC7B,mDAO0B;AANzB,0HAAA,wBAAwB,OAAA;AACxB,gIAAA,8BAA8B,OAAA;AAM/B,+CAcwB;AAbvB,gHAAA,gBAAgB,OAAA;AAChB,2HAAA,2BAA2B,OAAA;AAC3B,gHAAA,gBAAgB,OAAA;AAChB,8GAAA,cAAc,OAAA;AACd,gIAAA,gCAAgC,OAAA;AAChC,yHAAA,yBAAyB,OAAA;AACzB,oHAAA,oBAAoB,OAAA;AACpB,6HAAA,6BAA6B,OAAA;AAC7B,2GAAA,WAAW,OAAA;AACX,0GAAA,UAAU,OAAA;AACV,kHAAA,kBAAkB,OAAA;AAClB,gHAAA,gBAAgB,OAAA;AAChB,8GAAA,cAAc,OAAA;AAEf,iCAAwD;AAA7B,oGAAA,WAAW,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { generateHandleContextPath } from \"./dataStoreHandleContextUtils\";\nexport {\n\tcreate404Response,\n\tcreateDataStoreFactory,\n\tcreateResponseError,\n\texceptionToResponse,\n\tFactory,\n    packagePathToTelemetryProperty,\n\trequestFluidObject,\n\tresponseToException,\n} from \"./dataStoreHelpers\";\nexport { ObjectStoragePartition } from \"./objectstoragepartition\";\nexport { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from \"./objectstorageutils\";\nexport { RequestParser } from \"./requestParser\";\nexport { RuntimeFactoryHelper } from \"./runtimeFactoryHelper\";\nexport {\n\tcreateRootSummarizerNode,\n\tcreateRootSummarizerNodeWithGC,\n\tIRootSummarizerNode,\n\tIRootSummarizerNodeWithGC,\n\tISummarizerNodeRootContract,\n\tRefreshSummaryResult,\n} from \"./summarizerNode\";\nexport {\n\taddBlobToSummary,\n\taddSummarizeResultToSummary,\n\taddTreeToSummary,\n\tcalculateStats,\n\tconvertSnapshotTreeToSummaryTree,\n\tconvertSummaryTreeToITree,\n\tconvertToSummaryTree,\n\tconvertToSummaryTreeWithStats,\n\tgetBlobSize,\n\tmergeStats,\n\tSummaryTreeBuilder,\n\tTelemetryContext,\n\tutf8ByteLength,\n} from \"./summaryUtils\";\nexport { ReadAndParseBlob, seqFromTree } from \"./utils\";\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/runtime-utils";
-export declare const pkgVersion = "2.0.0-internal.2.1.1";
+export declare const pkgVersion = "2.0.0-internal.2.2.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/runtime-utils";
-exports.pkgVersion = "2.0.0-internal.2.1.1";
+exports.pkgVersion = "2.0.0-internal.2.2.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,QAAA,UAAU,GAAG,sBAAsB,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/runtime-utils\";\nexport const pkgVersion = \"2.0.0-internal.2.1.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,QAAA,UAAU,GAAG,sBAAsB,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/runtime-utils\";\nexport const pkgVersion = \"2.0.0-internal.2.2.0\";\n"]}

package/dist/summarizerNode/summarizerNodeWithGc.js

@@ -156,7 +156,7 @@ class SummarizerNodeWithGC extends summarizerNode_1.SummarizerNode {
         // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.
         if (!this.gcDisabled) {
             const summaryNode = this.pendingSummaries.get(proposalHandle);
-            if (summaryNode !== undefined) {
+            if ((summaryNode === null || summaryNode === void 0 ? void 0 : summaryNode.serializedUsedRoutes) !== undefined) {
                 this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);
             }
         }

package/dist/summarizerNode/summarizerNodeWithGc.js.map

@@ -1 +1 @@
-{"version":3,"file":"summarizerNodeWithGc.js","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNodeWithGc.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAmE;AACnE,yEAAgE;AAEhE,6EAW6C;AAE7C,qDAAkD;AAClD,+DAM+B;AAI/B,wDAAwD;AACxD,MAAM,iBAAkB,SAAQ,iCAAW;IACvC,YACoB,oBAA4B,EAC5C,OAKC;QAED,KAAK,CAAC,OAAO,CAAC,CAAC;QARC,yBAAoB,GAApB,oBAAoB,CAAQ;IAShD,CAAC;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,oBAAqB,SAAQ,+BAAc;IAuBpD;;;OAGG;IACH,YACI,MAAwB,EACP,WAIqB,EACtC,MAAmC,EACnC,oBAA4B;IAC5B,8CAA8C;IAC9C,aAA2B,EAC3B,cAAgC,EAChC,gBAAmC,EAClB,WAAmE,EACpF,kBAAiE;QAEjE,KAAK,CACD,MAAM,EACN,KAAK,EAAE,QAAiB,EAAE,WAAoB,EAAE,gBAAoC,EAAE,EAAE,CACpF,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,EAClE,MAAM,EACN,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,gBAAgB,CACnB,CAAC;QAvBe,gBAAW,GAAX,WAAW,CAIU;QAOrB,gBAAW,GAAX,WAAW,CAAwD;QA9BxF,4FAA4F;QACpF,wBAAmB,GAAY,KAAK,CAAC;QAI7C,mHAAmH;QACnH,iHAAiH;QACjH,iHAAiH;QACzG,eAAU,GAAa,CAAC,EAAE,CAAC,CAAC;QAoChC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC;QAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,0BAAW,CAAC,KAAK,IAAI,EAAE;;YAC7C,OAAO,MAAA,CAAC,MAAM,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,EAAI,CAAA,CAAC,mCAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,iBAAiB;;QAC3B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;QAEhD,8GAA8G;QAC9G,6CAA6C;QAC7C,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC1B,OAAO;SACV;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEhC,iEAAiE;QACjE,IAAI,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,GAAG,IAAA,+BAAW,EAAC,aAAa,CAAC,MAAM,CAAC,CAAC;SACnD;QACD,6GAA6G;QAC7G,wEAAwE;QACxE,IAAI,CAAC,mBAAmB,GAAG,MAAA,aAAa,CAAC,UAAU,0CAAE,IAAI,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,SAAS,CAClB,QAAiB,EACjB,aAAsB,IAAI,EAC1B,gBAAoC;QAEpC,+GAA+G;QAC/G,0EAA0E;QAC1E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,IAAA,qBAAM,EAAC,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC7C,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QAED,2FAA2F;QAC3F,8DAA8D;QAC9D,OAAO,UAAU;YACb,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;YACpE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,SAAkB,KAAK;QAC1C,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;QAClG,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAEtG,8GAA8G;QAC9G,6GAA6G;QAC7G,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,8GAA8G;QAC9G,4GAA4G;QAC5G,uCAAuC;QACvC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAChE,OAAO,IAAA,+BAAW,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACnC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,IAAA,+BAAW,EAAC,MAAM,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,uBAA+B,EAAE,aAA+B;QAChF,sFAAsF;QACtF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,IAAA,qBAAM,EACF,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC1C,KAAK,CAAC,iFAAiF,CAAC,CAAC;SAChG;QACD,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACO,mBAAmB,CACzB,cAAsB,EACtB,UAAmC,EACnC,mBAA4B;QAE5B,IAAI,uBAA2C,CAAC;QAChD,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC;YACvD,IAAA,qBAAM,EAAC,uBAAuB,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACzG;QAED,KAAK,CAAC,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAE3E,iEAAiE;QACjE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC9D,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,oEAAoE;gBACpE,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,uBAAwB,EAAE,WAAW,CAAC,CAAC;gBACvF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;aAChE;SACJ;IACL,CAAC;IAED;;OAEG;IACI,YAAY;QACf,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzC,KAAK,CAAC,YAAY,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACO,+BAA+B,CACrC,cAAsB,EACtB,uBAA+B;QAE/B,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAsB,CAAC;YACnF,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;aAC3E;SACJ;QAED,OAAO,KAAK,CAAC,+BAA+B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,gCAAgC,CAC5C,uBAA+B,EAC/B,YAA2B,EAC3B,QAAiC,EACjC,SAAsB,EACtB,uBAAyC,EACzC,gBAAkC;QAElC,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,+BAAS,CAAC,CAAC;YACpD,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC7B,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAgC,aAAa,CAAC,CAAC;gBAEvF,0FAA0F;gBAC1F,IAAI,IAAI,CAAC,uBAAuB,IAAI,uBAAuB,EAAE;oBACzD,OAAO;iBACV;gBAED,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC,UAAU,CAAC;aACnD;SACJ;QAED,OAAO,KAAK,CAAC,gCAAgC,CACzC,uBAAuB,EACvB,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED;;OAEG;IACI,WAAW;IACd,yBAAyB;IACzB,mBAAwC;IACxC,2CAA2C;IAC3C,EAAU;IACV;;;;OAIG;IACH,WAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE;;QAEjE,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEzF,MAAM,aAAa,GAAwB,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC1F,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAClC,IAAI,CAAC,aAAa,EAClB,mBAAmB,kCAEZ,MAAM;YACT,gGAAgG;YAChG,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU,KAEpD,aAAa,CAAC,oBAAoB,EAClC,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,cAAc,EAC5B,IAAI,CAAC,gBAAgB,EACrB,WAAW,EACX,kBAAkB,CACrB,CAAC;QAEF,yGAAyG;QACzG,uEAAuE;QACvE,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,EAAU;QACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAyB,CAAC;IACzD,CAAC;IAEM,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IAEM,gBAAgB,CAAC,UAAoB;QACxC,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QAEpC,8GAA8G;QAC9G,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClE;IACL,CAAC;IAED;;OAEG;IACO,UAAU;QAChB,OAAO,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/D,CAAC;IAED;;OAEG;IACK,cAAc;QAClB,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,mBAAmB;QACvB,mEAAmE;QACnE,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC,mBAAmB,KAAK,SAAS;YACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrF,CAAC;CACJ;AAnVD,oDAmVC;AAED;;;;;;;;;;GAUG;AACI,MAAM,8BAA8B,GAAG,CAC1C,MAAwB,EACxB,mBAAwC,EACxC,oBAA4B,EAC5B,uBAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE,EACxC,EAAE,CAAC,IAAI,oBAAoB,CACpD,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,oBAAoB,EACpB,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iCAAW,CAAC,aAAa,CAAC,uBAAuB,CAAC,EACtG,SAAS,CAAC,oBAAoB,EAC9B,SAAS,CAAC,sBAAsB,EAChC,WAAW,EACX,kBAAkB,CACrB,CAAC;AAlBW,QAAA,8BAA8B,kCAkBzC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, LazyPromise } from \"@fluidframework/common-utils\";\nimport { cloneGCData } from \"@fluidframework/garbage-collector\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    CreateChildSummarizerNodeParam,\n    gcBlobKey,\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n    ISummarizeInternalResult,\n    ISummarizeResult,\n    ISummarizerNodeConfigWithGC,\n    ISummarizerNodeWithGC,\n    SummarizeInternalFn,\n    ITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { ReadAndParseBlob } from \"../utils\";\nimport { SummarizerNode } from \"./summarizerNode\";\nimport {\n    EscapedPath,\n    ICreateChildDetails,\n    IInitialSummary,\n    ISummarizerNodeRootContract,\n    SummaryNode,\n} from \"./summarizerNodeUtils\";\n\nexport interface IRootSummarizerNodeWithGC extends ISummarizerNodeWithGC, ISummarizerNodeRootContract {}\n\n// Extend SummaryNode to add used routes tracking to it.\nclass SummaryNodeWithGC extends SummaryNode {\n    constructor(\n        public readonly serializedUsedRoutes: string,\n        summary: {\n            readonly referenceSequenceNumber: number;\n            readonly basePath: EscapedPath | undefined;\n            readonly localPath: EscapedPath;\n            additionalPath?: EscapedPath;\n        },\n    ) {\n        super(summary);\n    }\n}\n\n/**\n * Extends the functionality of SummarizerNode to manage this node's garbage collection data:\n *\n * - Adds a new API `getGCData` to return GC data of this node.\n *\n * - Caches the result of `getGCData` to be used if nothing changes between summaries.\n *\n * - Manages the used routes of this node. These are used to identify if this node is referenced in the document\n * and to determine if the node's used state changed since last summary.\n *\n * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls\n * directly into summarizeInternal method.\n */\nexport class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNodeWithGC {\n    // Tracks the work-in-progress used routes during summary.\n    private wipSerializedUsedRoutes: string | undefined;\n\n    // This is the last known used routes of this node as seen by the server as part of a summary.\n    private referenceUsedRoutes: string[] | undefined;\n\n    // The base GC details of this node used to initialize the GC state.\n    private readonly baseGCDetailsP: LazyPromise<IGarbageCollectionDetailsBase>;\n\n    // Keeps track of whether we have loaded the base details to ensure that we on;y do it once.\n    private baseGCDetailsLoaded: boolean = false;\n\n    private gcData: IGarbageCollectionData | undefined;\n\n    // Set used routes to have self route by default. This makes the node referenced by default. This is done to ensure\n    // that this node is not marked as collected when running GC has been disabled. Once, the option to disable GC is\n    // removed (from runGC flag in IContainerRuntimeOptions), this should be changed to be have no routes by default.\n    private usedRoutes: string[] = [\"\"];\n\n    // True if GC is disabled for this node. If so, do not track GC specific state for a summary.\n    private readonly gcDisabled: boolean;\n\n    /**\n     * Do not call constructor directly.\n     * Use createRootSummarizerNodeWithGC to create root node, or createChild to create child nodes.\n     */\n    public constructor(\n        logger: ITelemetryLogger,\n        private readonly summarizeFn: (\n            fullTree: boolean,\n            trackState: boolean,\n            telemetryContext?: ITelemetryContext,\n        ) => Promise<ISummarizeInternalResult>,\n        config: ISummarizerNodeConfigWithGC,\n        changeSequenceNumber: number,\n        /** Undefined means created without summary */\n        latestSummary?: SummaryNode,\n        initialSummary?: IInitialSummary,\n        wipSummaryLogger?: ITelemetryLogger,\n        private readonly getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ) {\n        super(\n            logger,\n            async (fullTree: boolean, _trackState: boolean, telemetryContext?: ITelemetryContext) =>\n                summarizeFn(fullTree, true /* trackState */, telemetryContext),\n            config,\n            changeSequenceNumber,\n            latestSummary,\n            initialSummary,\n            wipSummaryLogger,\n        );\n\n        this.gcDisabled = config.gcDisabled === true;\n\n        this.baseGCDetailsP = new LazyPromise(async () => {\n            return (await getBaseGCDetailsFn?.()) ?? { usedRoutes: [] };\n        });\n    }\n\n    /**\n     * Loads state from this node's initial GC summary details. This contains the following data from the last summary\n     * seen by the server for this client:\n     * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.\n     * - gcData: The garbage collection data of this node that is required for running GC.\n     */\n    private async loadBaseGCDetails() {\n        const baseGCDetails = await this.baseGCDetailsP;\n\n        // Possible race - If there were parallel calls to loadBaseGCDetails, we want to make sure that we only update\n        // the state from the base details only once.\n        if (this.baseGCDetailsLoaded) {\n            return;\n        }\n        this.baseGCDetailsLoaded = true;\n\n        // If the GC details has GC data, initialize our GC data from it.\n        if (baseGCDetails.gcData !== undefined) {\n            this.gcData = cloneGCData(baseGCDetails.gcData);\n        }\n        // Sort the used routes because we compare them with the current used routes to check if they changed between\n        // summaries. Both are sorted so that the order of elements is the same.\n        this.referenceUsedRoutes = baseGCDetails.usedRoutes?.sort();\n    }\n\n    public async summarize(\n        fullTree: boolean,\n        trackState: boolean = true,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummarizeResult> {\n        // If GC is not disabled and we are tracking a summary, GC should have run and updated the used routes for this\n        // summary by calling updateUsedRoutes which sets wipSerializedUsedRoutes.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            assert(this.wipSerializedUsedRoutes !== undefined,\n                0x1b1 /* \"wip used routes should be set if tracking a summary\" */);\n        }\n\n        // If trackState is true, get summary from base summarizer node which tracks summary state.\n        // If trackState is false, get summary from summarizeInternal.\n        return trackState\n            ? super.summarize(fullTree, true /* trackState */, telemetryContext)\n            : this.summarizeFn(fullTree, trackState, telemetryContext);\n    }\n\n    /**\n     * Returns the GC data of this node. If nothing has changed since last summary, it tries to reuse the data from\n     * the previous summary. Else, it gets new GC data from the underlying Fluid object.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {\n        assert(!this.gcDisabled, 0x1b2 /* \"Getting GC data should not be called when GC is disabled!\" */);\n        assert(this.getGCDataFn !== undefined, 0x1b3 /* \"GC data cannot be retrieved without getGCDataFn\" */);\n\n        // Load GC details from the initial summary, if not already loaded. If this is the first time this function is\n        // called and the node's data has not changed since last summary, the GC data in initial details is returned.\n        await this.loadBaseGCDetails();\n\n        // If there is no new data since last summary and we have GC data from the previous run, return it. We may not\n        // have data from previous GC run for clients with older summary format before GC was added. They won't have\n        // GC details in their initial summary.\n        if (!fullGC && !this.hasDataChanged() && this.gcData !== undefined) {\n            return cloneGCData(this.gcData);\n        }\n\n        const gcData = await this.getGCDataFn(fullGC);\n        this.gcData = cloneGCData(gcData);\n        return gcData;\n    }\n\n    /**\n     * Called during the start of a summary. Updates the work-in-progress used routes.\n     */\n    public startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger) {\n        // If GC is disabled, skip setting wip used routes since we should not track GC state.\n        if (!this.gcDisabled) {\n            assert(\n                this.wipSerializedUsedRoutes === undefined,\n                0x1b4 /* \"We should not already be tracking used routes when to track a new summary\" */);\n        }\n        super.startSummary(referenceSequenceNumber, summaryLogger);\n    }\n\n    /**\n     * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending\n     * summary queue. We track this until we get an ack from the server for this summary.\n     */\n    protected completeSummaryCore(\n        proposalHandle: string,\n        parentPath: EscapedPath | undefined,\n        parentSkipRecursion: boolean,\n    ) {\n        let wipSerializedUsedRoutes: string | undefined;\n        // If GC is disabled, don't set wip used routes.\n        if (!this.gcDisabled) {\n            wipSerializedUsedRoutes = this.wipSerializedUsedRoutes;\n            assert(wipSerializedUsedRoutes !== undefined, 0x1b5 /* \"We should have been tracking used routes\" */);\n        }\n\n        super.completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion);\n\n        // If GC is disabled, skip setting pending summary with GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle);\n            if (summaryNode !== undefined) {\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const summaryNodeWithGC = new SummaryNodeWithGC(wipSerializedUsedRoutes!, summaryNode);\n                this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);\n            }\n        }\n    }\n\n    /**\n     * Clears the work-in-progress state.\n     */\n    public clearSummary() {\n        this.wipSerializedUsedRoutes = undefined;\n        super.clearSummary();\n    }\n\n    /**\n     * Called when we get an ack from the server for a summary we sent. Update the reference state of this node\n     * from the state in the pending summary queue.\n     */\n    protected refreshLatestSummaryFromPending(\n        proposalHandle: string,\n        referenceSequenceNumber: number,\n    ): void {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle) as SummaryNodeWithGC;\n            if (summaryNode !== undefined) {\n                this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);\n            }\n        }\n\n        return super.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);\n    }\n\n    /**\n     * Called when we need to upload the reference state from the given summary. Read the GC blob and get the state\n     * to upload from it.\n     */\n    protected async refreshLatestSummaryFromSnapshot(\n        referenceSequenceNumber: number,\n        snapshotTree: ISnapshotTree,\n        basePath: EscapedPath | undefined,\n        localPath: EscapedPath,\n        correlatedSummaryLogger: ITelemetryLogger,\n        readAndParseBlob: ReadAndParseBlob,\n    ): Promise<void> {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const gcDetailsBlob = snapshotTree.blobs[gcBlobKey];\n            if (gcDetailsBlob !== undefined) {\n                const gcDetails = await readAndParseBlob<IGarbageCollectionDetailsBase>(gcDetailsBlob);\n\n                // Possible re-entrancy. If we have already seen a summary later than this one, ignore it.\n                if (this.referenceSequenceNumber >= referenceSequenceNumber) {\n                    return;\n                }\n\n                this.referenceUsedRoutes = gcDetails.usedRoutes;\n            }\n        }\n\n        return super.refreshLatestSummaryFromSnapshot(\n            referenceSequenceNumber,\n            snapshotTree,\n            basePath,\n            localPath,\n            correlatedSummaryLogger,\n            readAndParseBlob,\n        );\n    }\n\n    /**\n     * Override the createChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public createChild(\n        /** Summarize function */\n        summarizeInternalFn: SummarizeInternalFn,\n        /** Initial id or path part of this node */\n        id: string,\n        /**\n         * Information needed to create the node.\n         * If it is from a base summary, it will assert that a summary has been seen.\n         * Attach information if it is created from an attach op.\n         */\n        createParam: CreateChildSummarizerNodeParam,\n        config: ISummarizerNodeConfigWithGC = {},\n        getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ): ISummarizerNodeWithGC {\n        assert(!this.children.has(id), 0x1b6 /* \"Create SummarizerNode child already exists\" */);\n\n        const createDetails: ICreateChildDetails = this.getCreateDetailsForChild(id, createParam);\n        const child = new SummarizerNodeWithGC(\n            this.defaultLogger,\n            summarizeInternalFn,\n            {\n                ...config,\n                // Propagate our gcDisabled state to the child if its not explicity specified in child's config.\n                gcDisabled: config.gcDisabled ?? this.gcDisabled,\n            },\n            createDetails.changeSequenceNumber,\n            createDetails.latestSummary,\n            createDetails.initialSummary,\n            this.wipSummaryLogger,\n            getGCDataFn,\n            getBaseGCDetailsFn,\n        );\n\n        // There may be additional state that has to be updated in this child. For example, if a summary is being\n        // tracked, the child's summary tracking state needs to be updated too.\n        this.maybeUpdateChildState(child);\n\n        this.children.set(id, child);\n        return child;\n    }\n\n    /**\n     * Deletes the child node with the given id.\n     */\n    public deleteChild(id: string): void {\n        this.children.delete(id);\n    }\n\n    /**\n     * Override the getChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public getChild(id: string): ISummarizerNodeWithGC | undefined {\n        return this.children.get(id) as SummarizerNodeWithGC;\n    }\n\n    public isReferenced(): boolean {\n        return this.usedRoutes.includes(\"\") || this.usedRoutes.includes(\"/\");\n    }\n\n    public updateUsedRoutes(usedRoutes: string[]) {\n        // Sort the given routes before updating. This will ensure that the routes compared in hasUsedStateChanged()\n        // are in the same order.\n        this.usedRoutes = usedRoutes.sort();\n\n        // If GC is not disabled and we are tracking a summary, update the work-in-progress used routes so that it can\n        // be tracked for this summary.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            this.wipSerializedUsedRoutes = JSON.stringify(this.usedRoutes);\n        }\n    }\n\n    /**\n     * Override the hasChanged method. If this node data or its used state changed, the node is considered changed.\n     */\n    protected hasChanged(): boolean {\n        return this.hasDataChanged() || this.hasUsedStateChanged();\n    }\n\n    /**\n     * This tells whether the data in this node has changed or not.\n     */\n    private hasDataChanged(): boolean {\n        return super.hasChanged();\n    }\n\n    /**\n     * This tells whether the used state of this node has changed since last successful summary. If the used routes\n     * of this node changed, its used state is considered changed. Basically, if this node or any of its child nodes\n     * was previously used and became unused (or vice versa), its used state has changed.\n     */\n    private hasUsedStateChanged(): boolean {\n        // If GC is disabled, we are not tracking used state, return false.\n        if (this.gcDisabled) {\n            return false;\n        }\n\n        return this.referenceUsedRoutes === undefined ||\n            JSON.stringify(this.usedRoutes) !== JSON.stringify(this.referenceUsedRoutes);\n    }\n}\n\n/**\n * Creates a root summarizer node with GC functionality built-in.\n * @param logger - Logger to use within SummarizerNode\n * @param summarizeInternalFn - Function to generate summary\n * @param changeSequenceNumber - Sequence number of latest change to new node/subtree\n * @param referenceSequenceNumber - Reference sequence number of last acked summary,\n * or undefined if not loaded from summary\n * @param config - Configure behavior of summarizer node\n * @param getGCDataFn - Function to get the GC data of this node\n * @param baseGCDetailsP - Function to get the initial GC details of this node\n */\nexport const createRootSummarizerNodeWithGC = (\n    logger: ITelemetryLogger,\n    summarizeInternalFn: SummarizeInternalFn,\n    changeSequenceNumber: number,\n    referenceSequenceNumber: number | undefined,\n    config: ISummarizerNodeConfigWithGC = {},\n    getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n): IRootSummarizerNodeWithGC => new SummarizerNodeWithGC(\n    logger,\n    summarizeInternalFn,\n    config,\n    changeSequenceNumber,\n    referenceSequenceNumber === undefined ? undefined : SummaryNode.createForRoot(referenceSequenceNumber),\n    undefined /* initialSummary */,\n    undefined /* wipSummaryLogger */,\n    getGCDataFn,\n    getBaseGCDetailsFn,\n);\n"]}
+{"version":3,"file":"summarizerNodeWithGc.js","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNodeWithGc.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAmE;AACnE,yEAAgE;AAEhE,6EAW6C;AAE7C,qDAAkD;AAClD,+DAM+B;AAI/B,wDAAwD;AACxD,MAAM,iBAAkB,SAAQ,iCAAW;IACvC,YACoB,oBAA4B,EAC5C,OAKC;QAED,KAAK,CAAC,OAAO,CAAC,CAAC;QARC,yBAAoB,GAApB,oBAAoB,CAAQ;IAShD,CAAC;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,oBAAqB,SAAQ,+BAAc;IAuBpD;;;OAGG;IACH,YACI,MAAwB,EACP,WAIqB,EACtC,MAAmC,EACnC,oBAA4B;IAC5B,8CAA8C;IAC9C,aAA2B,EAC3B,cAAgC,EAChC,gBAAmC,EAClB,WAAmE,EACpF,kBAAiE;QAEjE,KAAK,CACD,MAAM,EACN,KAAK,EAAE,QAAiB,EAAE,WAAoB,EAAE,gBAAoC,EAAE,EAAE,CACpF,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,EAClE,MAAM,EACN,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,gBAAgB,CACnB,CAAC;QAvBe,gBAAW,GAAX,WAAW,CAIU;QAOrB,gBAAW,GAAX,WAAW,CAAwD;QA9BxF,4FAA4F;QACpF,wBAAmB,GAAY,KAAK,CAAC;QAI7C,mHAAmH;QACnH,iHAAiH;QACjH,iHAAiH;QACzG,eAAU,GAAa,CAAC,EAAE,CAAC,CAAC;QAoChC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC;QAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,0BAAW,CAAC,KAAK,IAAI,EAAE;;YAC7C,OAAO,MAAA,CAAC,MAAM,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,EAAI,CAAA,CAAC,mCAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,iBAAiB;;QAC3B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;QAEhD,8GAA8G;QAC9G,6CAA6C;QAC7C,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC1B,OAAO;SACV;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEhC,iEAAiE;QACjE,IAAI,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,GAAG,IAAA,+BAAW,EAAC,aAAa,CAAC,MAAM,CAAC,CAAC;SACnD;QACD,6GAA6G;QAC7G,wEAAwE;QACxE,IAAI,CAAC,mBAAmB,GAAG,MAAA,aAAa,CAAC,UAAU,0CAAE,IAAI,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,SAAS,CAClB,QAAiB,EACjB,aAAsB,IAAI,EAC1B,gBAAoC;QAEpC,+GAA+G;QAC/G,0EAA0E;QAC1E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,IAAA,qBAAM,EAAC,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC7C,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QAED,2FAA2F;QAC3F,8DAA8D;QAC9D,OAAO,UAAU;YACb,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;YACpE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,SAAkB,KAAK;QAC1C,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;QAClG,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAEtG,8GAA8G;QAC9G,6GAA6G;QAC7G,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,8GAA8G;QAC9G,4GAA4G;QAC5G,uCAAuC;QACvC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAChE,OAAO,IAAA,+BAAW,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACnC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,IAAA,+BAAW,EAAC,MAAM,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,uBAA+B,EAAE,aAA+B;QAChF,sFAAsF;QACtF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,IAAA,qBAAM,EACF,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC1C,KAAK,CAAC,iFAAiF,CAAC,CAAC;SAChG;QACD,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACO,mBAAmB,CACzB,cAAsB,EACtB,UAAmC,EACnC,mBAA4B;QAE5B,IAAI,uBAA2C,CAAC;QAChD,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC;YACvD,IAAA,qBAAM,EAAC,uBAAuB,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACzG;QAED,KAAK,CAAC,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAE3E,iEAAiE;QACjE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC9D,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,oEAAoE;gBACpE,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,uBAAwB,EAAE,WAAW,CAAC,CAAC;gBACvF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;aAChE;SACJ;IACL,CAAC;IAED;;OAEG;IACI,YAAY;QACf,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzC,KAAK,CAAC,YAAY,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACO,+BAA+B,CACrC,cAAsB,EACtB,uBAA+B;QAE/B,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAsB,CAAC;YACnF,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,oBAAoB,MAAK,SAAS,EAAE;gBACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;aAC3E;SACJ;QAED,OAAO,KAAK,CAAC,+BAA+B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,gCAAgC,CAC5C,uBAA+B,EAC/B,YAA2B,EAC3B,QAAiC,EACjC,SAAsB,EACtB,uBAAyC,EACzC,gBAAkC;QAElC,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,+BAAS,CAAC,CAAC;YACpD,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC7B,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAgC,aAAa,CAAC,CAAC;gBAEvF,0FAA0F;gBAC1F,IAAI,IAAI,CAAC,uBAAuB,IAAI,uBAAuB,EAAE;oBACzD,OAAO;iBACV;gBAED,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC,UAAU,CAAC;aACnD;SACJ;QAED,OAAO,KAAK,CAAC,gCAAgC,CACzC,uBAAuB,EACvB,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED;;OAEG;IACI,WAAW;IACd,yBAAyB;IACzB,mBAAwC;IACxC,2CAA2C;IAC3C,EAAU;IACV;;;;OAIG;IACH,WAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE;;QAEjE,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEzF,MAAM,aAAa,GAAwB,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC1F,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAClC,IAAI,CAAC,aAAa,EAClB,mBAAmB,kCAEZ,MAAM;YACT,gGAAgG;YAChG,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU,KAEpD,aAAa,CAAC,oBAAoB,EAClC,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,cAAc,EAC5B,IAAI,CAAC,gBAAgB,EACrB,WAAW,EACX,kBAAkB,CACrB,CAAC;QAEF,yGAAyG;QACzG,uEAAuE;QACvE,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,EAAU;QACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAyB,CAAC;IACzD,CAAC;IAEM,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IAEM,gBAAgB,CAAC,UAAoB;QACxC,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QAEpC,8GAA8G;QAC9G,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClE;IACL,CAAC;IAED;;OAEG;IACO,UAAU;QAChB,OAAO,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/D,CAAC;IAED;;OAEG;IACK,cAAc;QAClB,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,mBAAmB;QACvB,mEAAmE;QACnE,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC,mBAAmB,KAAK,SAAS;YACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrF,CAAC;CACJ;AAnVD,oDAmVC;AAED;;;;;;;;;;GAUG;AACI,MAAM,8BAA8B,GAAG,CAC1C,MAAwB,EACxB,mBAAwC,EACxC,oBAA4B,EAC5B,uBAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE,EACxC,EAAE,CAAC,IAAI,oBAAoB,CACpD,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,oBAAoB,EACpB,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iCAAW,CAAC,aAAa,CAAC,uBAAuB,CAAC,EACtG,SAAS,CAAC,oBAAoB,EAC9B,SAAS,CAAC,sBAAsB,EAChC,WAAW,EACX,kBAAkB,CACrB,CAAC;AAlBW,QAAA,8BAA8B,kCAkBzC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, LazyPromise } from \"@fluidframework/common-utils\";\nimport { cloneGCData } from \"@fluidframework/garbage-collector\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    CreateChildSummarizerNodeParam,\n    gcBlobKey,\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n    ISummarizeInternalResult,\n    ISummarizeResult,\n    ISummarizerNodeConfigWithGC,\n    ISummarizerNodeWithGC,\n    SummarizeInternalFn,\n    ITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { ReadAndParseBlob } from \"../utils\";\nimport { SummarizerNode } from \"./summarizerNode\";\nimport {\n    EscapedPath,\n    ICreateChildDetails,\n    IInitialSummary,\n    ISummarizerNodeRootContract,\n    SummaryNode,\n} from \"./summarizerNodeUtils\";\n\nexport interface IRootSummarizerNodeWithGC extends ISummarizerNodeWithGC, ISummarizerNodeRootContract {}\n\n// Extend SummaryNode to add used routes tracking to it.\nclass SummaryNodeWithGC extends SummaryNode {\n    constructor(\n        public readonly serializedUsedRoutes: string,\n        summary: {\n            readonly referenceSequenceNumber: number;\n            readonly basePath: EscapedPath | undefined;\n            readonly localPath: EscapedPath;\n            additionalPath?: EscapedPath;\n        },\n    ) {\n        super(summary);\n    }\n}\n\n/**\n * Extends the functionality of SummarizerNode to manage this node's garbage collection data:\n *\n * - Adds a new API `getGCData` to return GC data of this node.\n *\n * - Caches the result of `getGCData` to be used if nothing changes between summaries.\n *\n * - Manages the used routes of this node. These are used to identify if this node is referenced in the document\n * and to determine if the node's used state changed since last summary.\n *\n * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls\n * directly into summarizeInternal method.\n */\nexport class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNodeWithGC {\n    // Tracks the work-in-progress used routes during summary.\n    private wipSerializedUsedRoutes: string | undefined;\n\n    // This is the last known used routes of this node as seen by the server as part of a summary.\n    private referenceUsedRoutes: string[] | undefined;\n\n    // The base GC details of this node used to initialize the GC state.\n    private readonly baseGCDetailsP: LazyPromise<IGarbageCollectionDetailsBase>;\n\n    // Keeps track of whether we have loaded the base details to ensure that we on;y do it once.\n    private baseGCDetailsLoaded: boolean = false;\n\n    private gcData: IGarbageCollectionData | undefined;\n\n    // Set used routes to have self route by default. This makes the node referenced by default. This is done to ensure\n    // that this node is not marked as collected when running GC has been disabled. Once, the option to disable GC is\n    // removed (from runGC flag in IContainerRuntimeOptions), this should be changed to be have no routes by default.\n    private usedRoutes: string[] = [\"\"];\n\n    // True if GC is disabled for this node. If so, do not track GC specific state for a summary.\n    private readonly gcDisabled: boolean;\n\n    /**\n     * Do not call constructor directly.\n     * Use createRootSummarizerNodeWithGC to create root node, or createChild to create child nodes.\n     */\n    public constructor(\n        logger: ITelemetryLogger,\n        private readonly summarizeFn: (\n            fullTree: boolean,\n            trackState: boolean,\n            telemetryContext?: ITelemetryContext,\n        ) => Promise<ISummarizeInternalResult>,\n        config: ISummarizerNodeConfigWithGC,\n        changeSequenceNumber: number,\n        /** Undefined means created without summary */\n        latestSummary?: SummaryNode,\n        initialSummary?: IInitialSummary,\n        wipSummaryLogger?: ITelemetryLogger,\n        private readonly getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ) {\n        super(\n            logger,\n            async (fullTree: boolean, _trackState: boolean, telemetryContext?: ITelemetryContext) =>\n                summarizeFn(fullTree, true /* trackState */, telemetryContext),\n            config,\n            changeSequenceNumber,\n            latestSummary,\n            initialSummary,\n            wipSummaryLogger,\n        );\n\n        this.gcDisabled = config.gcDisabled === true;\n\n        this.baseGCDetailsP = new LazyPromise(async () => {\n            return (await getBaseGCDetailsFn?.()) ?? { usedRoutes: [] };\n        });\n    }\n\n    /**\n     * Loads state from this node's initial GC summary details. This contains the following data from the last summary\n     * seen by the server for this client:\n     * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.\n     * - gcData: The garbage collection data of this node that is required for running GC.\n     */\n    private async loadBaseGCDetails() {\n        const baseGCDetails = await this.baseGCDetailsP;\n\n        // Possible race - If there were parallel calls to loadBaseGCDetails, we want to make sure that we only update\n        // the state from the base details only once.\n        if (this.baseGCDetailsLoaded) {\n            return;\n        }\n        this.baseGCDetailsLoaded = true;\n\n        // If the GC details has GC data, initialize our GC data from it.\n        if (baseGCDetails.gcData !== undefined) {\n            this.gcData = cloneGCData(baseGCDetails.gcData);\n        }\n        // Sort the used routes because we compare them with the current used routes to check if they changed between\n        // summaries. Both are sorted so that the order of elements is the same.\n        this.referenceUsedRoutes = baseGCDetails.usedRoutes?.sort();\n    }\n\n    public async summarize(\n        fullTree: boolean,\n        trackState: boolean = true,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummarizeResult> {\n        // If GC is not disabled and we are tracking a summary, GC should have run and updated the used routes for this\n        // summary by calling updateUsedRoutes which sets wipSerializedUsedRoutes.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            assert(this.wipSerializedUsedRoutes !== undefined,\n                0x1b1 /* \"wip used routes should be set if tracking a summary\" */);\n        }\n\n        // If trackState is true, get summary from base summarizer node which tracks summary state.\n        // If trackState is false, get summary from summarizeInternal.\n        return trackState\n            ? super.summarize(fullTree, true /* trackState */, telemetryContext)\n            : this.summarizeFn(fullTree, trackState, telemetryContext);\n    }\n\n    /**\n     * Returns the GC data of this node. If nothing has changed since last summary, it tries to reuse the data from\n     * the previous summary. Else, it gets new GC data from the underlying Fluid object.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {\n        assert(!this.gcDisabled, 0x1b2 /* \"Getting GC data should not be called when GC is disabled!\" */);\n        assert(this.getGCDataFn !== undefined, 0x1b3 /* \"GC data cannot be retrieved without getGCDataFn\" */);\n\n        // Load GC details from the initial summary, if not already loaded. If this is the first time this function is\n        // called and the node's data has not changed since last summary, the GC data in initial details is returned.\n        await this.loadBaseGCDetails();\n\n        // If there is no new data since last summary and we have GC data from the previous run, return it. We may not\n        // have data from previous GC run for clients with older summary format before GC was added. They won't have\n        // GC details in their initial summary.\n        if (!fullGC && !this.hasDataChanged() && this.gcData !== undefined) {\n            return cloneGCData(this.gcData);\n        }\n\n        const gcData = await this.getGCDataFn(fullGC);\n        this.gcData = cloneGCData(gcData);\n        return gcData;\n    }\n\n    /**\n     * Called during the start of a summary. Updates the work-in-progress used routes.\n     */\n    public startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger) {\n        // If GC is disabled, skip setting wip used routes since we should not track GC state.\n        if (!this.gcDisabled) {\n            assert(\n                this.wipSerializedUsedRoutes === undefined,\n                0x1b4 /* \"We should not already be tracking used routes when to track a new summary\" */);\n        }\n        super.startSummary(referenceSequenceNumber, summaryLogger);\n    }\n\n    /**\n     * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending\n     * summary queue. We track this until we get an ack from the server for this summary.\n     */\n    protected completeSummaryCore(\n        proposalHandle: string,\n        parentPath: EscapedPath | undefined,\n        parentSkipRecursion: boolean,\n    ) {\n        let wipSerializedUsedRoutes: string | undefined;\n        // If GC is disabled, don't set wip used routes.\n        if (!this.gcDisabled) {\n            wipSerializedUsedRoutes = this.wipSerializedUsedRoutes;\n            assert(wipSerializedUsedRoutes !== undefined, 0x1b5 /* \"We should have been tracking used routes\" */);\n        }\n\n        super.completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion);\n\n        // If GC is disabled, skip setting pending summary with GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle);\n            if (summaryNode !== undefined) {\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const summaryNodeWithGC = new SummaryNodeWithGC(wipSerializedUsedRoutes!, summaryNode);\n                this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);\n            }\n        }\n    }\n\n    /**\n     * Clears the work-in-progress state.\n     */\n    public clearSummary() {\n        this.wipSerializedUsedRoutes = undefined;\n        super.clearSummary();\n    }\n\n    /**\n     * Called when we get an ack from the server for a summary we sent. Update the reference state of this node\n     * from the state in the pending summary queue.\n     */\n    protected refreshLatestSummaryFromPending(\n        proposalHandle: string,\n        referenceSequenceNumber: number,\n    ): void {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle) as SummaryNodeWithGC;\n            if (summaryNode?.serializedUsedRoutes !== undefined) {\n                this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);\n            }\n        }\n\n        return super.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);\n    }\n\n    /**\n     * Called when we need to upload the reference state from the given summary. Read the GC blob and get the state\n     * to upload from it.\n     */\n    protected async refreshLatestSummaryFromSnapshot(\n        referenceSequenceNumber: number,\n        snapshotTree: ISnapshotTree,\n        basePath: EscapedPath | undefined,\n        localPath: EscapedPath,\n        correlatedSummaryLogger: ITelemetryLogger,\n        readAndParseBlob: ReadAndParseBlob,\n    ): Promise<void> {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const gcDetailsBlob = snapshotTree.blobs[gcBlobKey];\n            if (gcDetailsBlob !== undefined) {\n                const gcDetails = await readAndParseBlob<IGarbageCollectionDetailsBase>(gcDetailsBlob);\n\n                // Possible re-entrancy. If we have already seen a summary later than this one, ignore it.\n                if (this.referenceSequenceNumber >= referenceSequenceNumber) {\n                    return;\n                }\n\n                this.referenceUsedRoutes = gcDetails.usedRoutes;\n            }\n        }\n\n        return super.refreshLatestSummaryFromSnapshot(\n            referenceSequenceNumber,\n            snapshotTree,\n            basePath,\n            localPath,\n            correlatedSummaryLogger,\n            readAndParseBlob,\n        );\n    }\n\n    /**\n     * Override the createChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public createChild(\n        /** Summarize function */\n        summarizeInternalFn: SummarizeInternalFn,\n        /** Initial id or path part of this node */\n        id: string,\n        /**\n         * Information needed to create the node.\n         * If it is from a base summary, it will assert that a summary has been seen.\n         * Attach information if it is created from an attach op.\n         */\n        createParam: CreateChildSummarizerNodeParam,\n        config: ISummarizerNodeConfigWithGC = {},\n        getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ): ISummarizerNodeWithGC {\n        assert(!this.children.has(id), 0x1b6 /* \"Create SummarizerNode child already exists\" */);\n\n        const createDetails: ICreateChildDetails = this.getCreateDetailsForChild(id, createParam);\n        const child = new SummarizerNodeWithGC(\n            this.defaultLogger,\n            summarizeInternalFn,\n            {\n                ...config,\n                // Propagate our gcDisabled state to the child if its not explicity specified in child's config.\n                gcDisabled: config.gcDisabled ?? this.gcDisabled,\n            },\n            createDetails.changeSequenceNumber,\n            createDetails.latestSummary,\n            createDetails.initialSummary,\n            this.wipSummaryLogger,\n            getGCDataFn,\n            getBaseGCDetailsFn,\n        );\n\n        // There may be additional state that has to be updated in this child. For example, if a summary is being\n        // tracked, the child's summary tracking state needs to be updated too.\n        this.maybeUpdateChildState(child);\n\n        this.children.set(id, child);\n        return child;\n    }\n\n    /**\n     * Deletes the child node with the given id.\n     */\n    public deleteChild(id: string): void {\n        this.children.delete(id);\n    }\n\n    /**\n     * Override the getChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public getChild(id: string): ISummarizerNodeWithGC | undefined {\n        return this.children.get(id) as SummarizerNodeWithGC;\n    }\n\n    public isReferenced(): boolean {\n        return this.usedRoutes.includes(\"\") || this.usedRoutes.includes(\"/\");\n    }\n\n    public updateUsedRoutes(usedRoutes: string[]) {\n        // Sort the given routes before updating. This will ensure that the routes compared in hasUsedStateChanged()\n        // are in the same order.\n        this.usedRoutes = usedRoutes.sort();\n\n        // If GC is not disabled and we are tracking a summary, update the work-in-progress used routes so that it can\n        // be tracked for this summary.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            this.wipSerializedUsedRoutes = JSON.stringify(this.usedRoutes);\n        }\n    }\n\n    /**\n     * Override the hasChanged method. If this node data or its used state changed, the node is considered changed.\n     */\n    protected hasChanged(): boolean {\n        return this.hasDataChanged() || this.hasUsedStateChanged();\n    }\n\n    /**\n     * This tells whether the data in this node has changed or not.\n     */\n    private hasDataChanged(): boolean {\n        return super.hasChanged();\n    }\n\n    /**\n     * This tells whether the used state of this node has changed since last successful summary. If the used routes\n     * of this node changed, its used state is considered changed. Basically, if this node or any of its child nodes\n     * was previously used and became unused (or vice versa), its used state has changed.\n     */\n    private hasUsedStateChanged(): boolean {\n        // If GC is disabled, we are not tracking used state, return false.\n        if (this.gcDisabled) {\n            return false;\n        }\n\n        return this.referenceUsedRoutes === undefined ||\n            JSON.stringify(this.usedRoutes) !== JSON.stringify(this.referenceUsedRoutes);\n    }\n}\n\n/**\n * Creates a root summarizer node with GC functionality built-in.\n * @param logger - Logger to use within SummarizerNode\n * @param summarizeInternalFn - Function to generate summary\n * @param changeSequenceNumber - Sequence number of latest change to new node/subtree\n * @param referenceSequenceNumber - Reference sequence number of last acked summary,\n * or undefined if not loaded from summary\n * @param config - Configure behavior of summarizer node\n * @param getGCDataFn - Function to get the GC data of this node\n * @param baseGCDetailsP - Function to get the initial GC details of this node\n */\nexport const createRootSummarizerNodeWithGC = (\n    logger: ITelemetryLogger,\n    summarizeInternalFn: SummarizeInternalFn,\n    changeSequenceNumber: number,\n    referenceSequenceNumber: number | undefined,\n    config: ISummarizerNodeConfigWithGC = {},\n    getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n): IRootSummarizerNodeWithGC => new SummarizerNodeWithGC(\n    logger,\n    summarizeInternalFn,\n    config,\n    changeSequenceNumber,\n    referenceSequenceNumber === undefined ? undefined : SummaryNode.createForRoot(referenceSequenceNumber),\n    undefined /* initialSummary */,\n    undefined /* wipSummaryLogger */,\n    getGCDataFn,\n    getBaseGCDetailsFn,\n);\n"]}

package/lib/dataStoreHelpers.d.ts

@@ -2,10 +2,15 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { ITaggedTelemetryPropertyType } from "@fluidframework/common-definitions";
 import { FluidObject, IFluidRouter, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import { IFluidDataStoreFactory, IFluidDataStoreRegistry, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions";
 export declare function exceptionToResponse(err: any): IResponse;
 export declare function responseToException(response: IResponse, request: IRequest): Error;
+/**
+ * Takes a set of packages and joins them pkg1/pkg2... etc. Tags the field as a code artifact
+ */
+export declare function packagePathToTelemetryProperty(packagePath: readonly string[] | undefined): ITaggedTelemetryPropertyType | undefined;
 export declare function requestFluidObject<T = FluidObject>(router: IFluidRouter, url: string | IRequest): Promise<T>;
 export declare const create404Response: (request: IRequest) => IResponse;
 export declare function createResponseError(status: number, value: string, request: IRequest): IResponse;

package/lib/dataStoreHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreHelpers.d.ts","sourceRoot":"","sources":["../src/dataStoreHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,uBAAuB,EACvB,8BAA8B,EACjC,MAAM,qCAAqC,CAAC;AAU7C,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAqBvD;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,GAAG,KAAK,CAYjF;AAED,wBAAsB,kBAAkB,CAAC,CAAC,GAAG,WAAW,EACpD,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,CAU5D;AAED,eAAO,MAAM,iBAAiB,YAAa,QAAQ,cAAmD,CAAC;AAEvG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,CAc/F;AAED,oBAAY,OAAO,GAAG,sBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;AAEvF,wBAAgB,sBAAsB,CAClC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAChC,sBAAsB,GAAG,uBAAuB,CAQtD"}
+{"version":3,"file":"dataStoreHelpers.d.ts","sourceRoot":"","sources":["../src/dataStoreHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAElF,OAAO,EACH,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,uBAAuB,EACvB,8BAA8B,EACjC,MAAM,qCAAqC,CAAC;AAU7C,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAqBvD;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,GAAG,KAAK,CAYjF;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC1C,WAAW,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,GAC3C,4BAA4B,GAAG,SAAS,CAE1C;AAED,wBAAsB,kBAAkB,CAAC,CAAC,GAAG,WAAW,EACpD,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,CAU5D;AAED,eAAO,MAAM,iBAAiB,YAAa,QAAQ,cAAmD,CAAC;AAEvG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,CAc/F;AAED,oBAAY,OAAO,GAAG,sBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;AAEvF,wBAAgB,sBAAsB,CAClC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAChC,sBAAsB,GAAG,uBAAuB,CAQtD"}

package/lib/dataStoreHelpers.js

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { assert } from "@fluidframework/common-utils";
-import { generateErrorWithStack } from "@fluidframework/telemetry-utils";
+import { generateErrorWithStack, TelemetryDataTag } from "@fluidframework/telemetry-utils";
 export function exceptionToResponse(err) {
     const status = 500;
     if (err !== null && typeof err === "object" && err.errorFromRequestFluidObject === true) {
@@ -36,6 +36,12 @@ export function responseToException(response, request) {
     };
     return responseErr;
 }
+/**
+ * Takes a set of packages and joins them pkg1/pkg2... etc. Tags the field as a code artifact
+ */
+export function packagePathToTelemetryProperty(packagePath) {
+    return packagePath ? { value: packagePath.join("/"), tag: TelemetryDataTag.CodeArtifact } : undefined;
+}
 export async function requestFluidObject(router, url) {
     const request = typeof url === "string" ? { url } : url;
     const response = await router.request(request);

package/lib/dataStoreHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreHelpers.js","sourceRoot":"","sources":["../src/dataStoreHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAYtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AASzE,MAAM,UAAU,mBAAmB,CAAC,GAAQ;IACxC,MAAM,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,2BAA2B,KAAK,IAAI,EAAE;QACrF,MAAM,WAAW,GAAuB,GAAG,CAAC;QAC5C,OAAO;YACH,QAAQ,EAAE,YAAY;YACtB,MAAM,EAAE,WAAW,CAAC,IAAI;YACxB,KAAK,EAAE,WAAW,CAAC,OAAO;YAC1B,IAAI,KAAK,KAAK,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;SAC5C,CAAC;KACL;IAED,0GAA0G;IAC1G,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;IAE9C,OAAO;QACH,QAAQ,EAAE,YAAY;QACtB,MAAM;QACN,KAAK,EAAE,GAAG,GAAG,EAAE;QACf,IAAI,KAAK,aAAK,OAAO,MAAC,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAA0B,mCAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KACvF,CAAC;AACN,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,QAAmB,EAAE,OAAiB;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC/B,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;IAC9C,MAAM,WAAW,GAA+B;QAC5C,2BAA2B,EAAE,IAAI;QACjC,OAAO;QACP,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,QAAQ,CAAC,MAAM;QACrB,IAAI,KAAK,aAAK,OAAO,MAAA,QAAQ,CAAC,KAAK,mCAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KAC/D,CAAC;IAEF,OAAO,WAAW,CAAC;AACvB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACpC,MAAoB,EAAE,GAAsB;IAC5C,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACxD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,QAAQ,KAAK,cAAc,EAAE;QACjE,MAAM,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KAChD;IAED,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;IACtF,OAAO,QAAQ,CAAC,KAAU,CAAC;AAC/B,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,OAAiB,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;AAEvG,MAAM,UAAU,mBAAmB,CAAC,MAAc,EAAE,KAAa,EAAE,OAAiB;;IAChF,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACrF,kEAAkE;IAClE,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,GAAG,0CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAE9C,0GAA0G;IAC1G,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;IAE9C,OAAO;QACH,QAAQ,EAAE,YAAY;QACtB,MAAM;QACN,KAAK,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,UAAU,EAAE;QACnE,IAAI,KAAK,KAAK,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KAC7C,CAAC;AACN,CAAC;AAID,MAAM,UAAU,sBAAsB,CAClC,IAAY,EACZ,OAAmC;IAEnC,OAAO;QACH,IAAI;QACJ,IAAI,sBAAsB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC7C,IAAI,uBAAuB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC9C,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,OAAO,CAAC,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC1G,GAAG,EAAE,KAAK,EAAE,IAAY,EAAE,EAAE,WAAC,OAAA,MAAA,CAAC,MAAM,OAAO,CAAC,CAAC,uBAAuB,0CAAE,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA;KAClF,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    FluidObject,\n    IFluidRouter,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IFluidDataStoreFactory,\n    IFluidDataStoreRegistry,\n    IProvideFluidDataStoreRegistry,\n} from \"@fluidframework/runtime-definitions\";\nimport { generateErrorWithStack } from \"@fluidframework/telemetry-utils\";\n\ninterface IResponseException extends Error {\n    errorFromRequestFluidObject: true;\n    message: string;\n    code: number;\n    stack?: string;\n}\n\nexport function exceptionToResponse(err: any): IResponse {\n    const status = 500;\n    if (err !== null && typeof err === \"object\" && err.errorFromRequestFluidObject === true) {\n        const responseErr: IResponseException = err;\n        return {\n            mimeType: \"text/plain\",\n            status: responseErr.code,\n            value: responseErr.message,\n            get stack() { return responseErr.stack; },\n        };\n    }\n\n    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it\n    const errWithStack = generateErrorWithStack();\n\n    return {\n        mimeType: \"text/plain\",\n        status,\n        value: `${err}`,\n        get stack() { return ((err?.stack) as (string | undefined)) ?? errWithStack.stack; },\n    };\n}\n\nexport function responseToException(response: IResponse, request: IRequest): Error {\n    const message = response.value;\n    const errWithStack = generateErrorWithStack();\n    const responseErr: Error & IResponseException = {\n        errorFromRequestFluidObject: true,\n        message,\n        name: \"Error\",\n        code: response.status,\n        get stack() { return response.stack ?? errWithStack.stack; },\n    };\n\n    return responseErr;\n}\n\nexport async function requestFluidObject<T = FluidObject>(\n    router: IFluidRouter, url: string | IRequest): Promise<T> {\n    const request = typeof url === \"string\" ? { url } : url;\n    const response = await router.request(request);\n\n    if (response.status !== 200 || response.mimeType !== \"fluid/object\") {\n        throw responseToException(response, request);\n    }\n\n    assert(response.value, 0x19a /* \"Invalid response value for Fluid object request\" */);\n    return response.value as T;\n}\n\nexport const create404Response = (request: IRequest) => createResponseError(404, \"not found\", request);\n\nexport function createResponseError(status: number, value: string, request: IRequest): IResponse {\n    assert(status !== 200, 0x19b /* \"Cannot not create response error on 200 status\" */);\n    // Omit query string which could contain personal data (aka \"PII\")\n    const urlNoQuery = request.url?.split(\"?\")[0];\n\n    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it\n    const errWithStack = generateErrorWithStack();\n\n    return {\n        mimeType: \"text/plain\",\n        status,\n        value: urlNoQuery === undefined ? value : `${value}: ${urlNoQuery}`,\n        get stack() { return errWithStack.stack; },\n    };\n}\n\nexport type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;\n\nexport function createDataStoreFactory(\n    type: string,\n    factory: Factory | Promise<Factory>,\n    ): IFluidDataStoreFactory & IFluidDataStoreRegistry {\n    return {\n        type,\n        get IFluidDataStoreFactory() { return this; },\n        get IFluidDataStoreRegistry() { return this; },\n        instantiateDataStore: async (context, existing) => (await factory).instantiateDataStore(context, existing),\n        get: async (name: string) => (await factory).IFluidDataStoreRegistry?.get(name),\n    };\n}\n"]}
+{"version":3,"file":"dataStoreHelpers.js","sourceRoot":"","sources":["../src/dataStoreHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAYtD,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAS3F,MAAM,UAAU,mBAAmB,CAAC,GAAQ;IACxC,MAAM,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,2BAA2B,KAAK,IAAI,EAAE;QACrF,MAAM,WAAW,GAAuB,GAAG,CAAC;QAC5C,OAAO;YACH,QAAQ,EAAE,YAAY;YACtB,MAAM,EAAE,WAAW,CAAC,IAAI;YACxB,KAAK,EAAE,WAAW,CAAC,OAAO;YAC1B,IAAI,KAAK,KAAK,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;SAC5C,CAAC;KACL;IAED,0GAA0G;IAC1G,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;IAE9C,OAAO;QACH,QAAQ,EAAE,YAAY;QACtB,MAAM;QACN,KAAK,EAAE,GAAG,GAAG,EAAE;QACf,IAAI,KAAK,aAAK,OAAO,MAAC,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAA0B,mCAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KACvF,CAAC;AACN,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,QAAmB,EAAE,OAAiB;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC/B,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;IAC9C,MAAM,WAAW,GAA+B;QAC5C,2BAA2B,EAAE,IAAI;QACjC,OAAO;QACP,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,QAAQ,CAAC,MAAM;QACrB,IAAI,KAAK,aAAK,OAAO,MAAA,QAAQ,CAAC,KAAK,mCAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KAC/D,CAAC;IAEF,OAAO,WAAW,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC1C,WAA0C;IAE1C,OAAO,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1G,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACpC,MAAoB,EAAE,GAAsB;IAC5C,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACxD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,QAAQ,KAAK,cAAc,EAAE;QACjE,MAAM,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KAChD;IAED,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;IACtF,OAAO,QAAQ,CAAC,KAAU,CAAC;AAC/B,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,OAAiB,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;AAEvG,MAAM,UAAU,mBAAmB,CAAC,MAAc,EAAE,KAAa,EAAE,OAAiB;;IAChF,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACrF,kEAAkE;IAClE,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,GAAG,0CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAE9C,0GAA0G;IAC1G,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;IAE9C,OAAO;QACH,QAAQ,EAAE,YAAY;QACtB,MAAM;QACN,KAAK,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,UAAU,EAAE;QACnE,IAAI,KAAK,KAAK,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;KAC7C,CAAC;AACN,CAAC;AAID,MAAM,UAAU,sBAAsB,CAClC,IAAY,EACZ,OAAmC;IAEnC,OAAO;QACH,IAAI;QACJ,IAAI,sBAAsB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC7C,IAAI,uBAAuB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC9C,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,OAAO,CAAC,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC1G,GAAG,EAAE,KAAK,EAAE,IAAY,EAAE,EAAE,WAAC,OAAA,MAAA,CAAC,MAAM,OAAO,CAAC,CAAC,uBAAuB,0CAAE,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA;KAClF,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITaggedTelemetryPropertyType } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    FluidObject,\n    IFluidRouter,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IFluidDataStoreFactory,\n    IFluidDataStoreRegistry,\n    IProvideFluidDataStoreRegistry,\n} from \"@fluidframework/runtime-definitions\";\nimport { generateErrorWithStack, TelemetryDataTag } from \"@fluidframework/telemetry-utils\";\n\ninterface IResponseException extends Error {\n    errorFromRequestFluidObject: true;\n    message: string;\n    code: number;\n    stack?: string;\n}\n\nexport function exceptionToResponse(err: any): IResponse {\n    const status = 500;\n    if (err !== null && typeof err === \"object\" && err.errorFromRequestFluidObject === true) {\n        const responseErr: IResponseException = err;\n        return {\n            mimeType: \"text/plain\",\n            status: responseErr.code,\n            value: responseErr.message,\n            get stack() { return responseErr.stack; },\n        };\n    }\n\n    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it\n    const errWithStack = generateErrorWithStack();\n\n    return {\n        mimeType: \"text/plain\",\n        status,\n        value: `${err}`,\n        get stack() { return ((err?.stack) as (string | undefined)) ?? errWithStack.stack; },\n    };\n}\n\nexport function responseToException(response: IResponse, request: IRequest): Error {\n    const message = response.value;\n    const errWithStack = generateErrorWithStack();\n    const responseErr: Error & IResponseException = {\n        errorFromRequestFluidObject: true,\n        message,\n        name: \"Error\",\n        code: response.status,\n        get stack() { return response.stack ?? errWithStack.stack; },\n    };\n\n    return responseErr;\n}\n\n/**\n * Takes a set of packages and joins them pkg1/pkg2... etc. Tags the field as a code artifact\n */\nexport function packagePathToTelemetryProperty(\n    packagePath: readonly string[] | undefined,\n): ITaggedTelemetryPropertyType | undefined {\n    return packagePath ? { value: packagePath.join(\"/\"), tag: TelemetryDataTag.CodeArtifact } : undefined;\n}\n\nexport async function requestFluidObject<T = FluidObject>(\n    router: IFluidRouter, url: string | IRequest): Promise<T> {\n    const request = typeof url === \"string\" ? { url } : url;\n    const response = await router.request(request);\n\n    if (response.status !== 200 || response.mimeType !== \"fluid/object\") {\n        throw responseToException(response, request);\n    }\n\n    assert(response.value, 0x19a /* \"Invalid response value for Fluid object request\" */);\n    return response.value as T;\n}\n\nexport const create404Response = (request: IRequest) => createResponseError(404, \"not found\", request);\n\nexport function createResponseError(status: number, value: string, request: IRequest): IResponse {\n    assert(status !== 200, 0x19b /* \"Cannot not create response error on 200 status\" */);\n    // Omit query string which could contain personal data (aka \"PII\")\n    const urlNoQuery = request.url?.split(\"?\")[0];\n\n    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it\n    const errWithStack = generateErrorWithStack();\n\n    return {\n        mimeType: \"text/plain\",\n        status,\n        value: urlNoQuery === undefined ? value : `${value}: ${urlNoQuery}`,\n        get stack() { return errWithStack.stack; },\n    };\n}\n\nexport type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;\n\nexport function createDataStoreFactory(\n    type: string,\n    factory: Factory | Promise<Factory>,\n    ): IFluidDataStoreFactory & IFluidDataStoreRegistry {\n    return {\n        type,\n        get IFluidDataStoreFactory() { return this; },\n        get IFluidDataStoreRegistry() { return this; },\n        instantiateDataStore: async (context, existing) => (await factory).instantiateDataStore(context, existing),\n        get: async (name: string) => (await factory).IFluidDataStoreRegistry?.get(name),\n    };\n}\n"]}

package/lib/index.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 export { generateHandleContextPath } from "./dataStoreHandleContextUtils";
-export { create404Response, createDataStoreFactory, createResponseError, exceptionToResponse, Factory, requestFluidObject, responseToException, } from "./dataStoreHelpers";
+export { create404Response, createDataStoreFactory, createResponseError, exceptionToResponse, Factory, packagePathToTelemetryProperty, requestFluidObject, responseToException, } from "./dataStoreHelpers";
 export { ObjectStoragePartition } from "./objectstoragepartition";
 export { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from "./objectstorageutils";
 export { RequestParser } from "./requestParser";

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,OAAO,EACP,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACN,wBAAwB,EACxB,8BAA8B,EAC9B,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,EAC3B,oBAAoB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,gBAAgB,EAChB,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,OAAO,EACJ,8BAA8B,EACjC,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACN,wBAAwB,EACxB,8BAA8B,EAC9B,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,EAC3B,oBAAoB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,gBAAgB,EAChB,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC"}

package/lib/index.js

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 export { generateHandleContextPath } from "./dataStoreHandleContextUtils";
-export { create404Response, createDataStoreFactory, createResponseError, exceptionToResponse, requestFluidObject, responseToException, } from "./dataStoreHelpers";
+export { create404Response, createDataStoreFactory, createResponseError, exceptionToResponse, packagePathToTelemetryProperty, requestFluidObject, responseToException, } from "./dataStoreHelpers";
 export { ObjectStoragePartition } from "./objectstoragepartition";
 export { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from "./objectstorageutils";
 export { RequestParser } from "./requestParser";

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EAEnB,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACN,wBAAwB,EACxB,8BAA8B,GAK9B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,gBAAgB,EAChB,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAoB,WAAW,EAAE,MAAM,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { generateHandleContextPath } from \"./dataStoreHandleContextUtils\";\nexport {\n\tcreate404Response,\n\tcreateDataStoreFactory,\n\tcreateResponseError,\n\texceptionToResponse,\n\tFactory,\n\trequestFluidObject,\n\tresponseToException,\n} from \"./dataStoreHelpers\";\nexport { ObjectStoragePartition } from \"./objectstoragepartition\";\nexport { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from \"./objectstorageutils\";\nexport { RequestParser } from \"./requestParser\";\nexport { RuntimeFactoryHelper } from \"./runtimeFactoryHelper\";\nexport {\n\tcreateRootSummarizerNode,\n\tcreateRootSummarizerNodeWithGC,\n\tIRootSummarizerNode,\n\tIRootSummarizerNodeWithGC,\n\tISummarizerNodeRootContract,\n\tRefreshSummaryResult,\n} from \"./summarizerNode\";\nexport {\n\taddBlobToSummary,\n\taddSummarizeResultToSummary,\n\taddTreeToSummary,\n\tcalculateStats,\n\tconvertSnapshotTreeToSummaryTree,\n\tconvertSummaryTreeToITree,\n\tconvertToSummaryTree,\n\tconvertToSummaryTreeWithStats,\n\tgetBlobSize,\n\tmergeStats,\n\tSummaryTreeBuilder,\n\tTelemetryContext,\n\tutf8ByteLength,\n} from \"./summaryUtils\";\nexport { ReadAndParseBlob, seqFromTree } from \"./utils\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EAEhB,8BAA8B,EACjC,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACN,wBAAwB,EACxB,8BAA8B,GAK9B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,gBAAgB,EAChB,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAoB,WAAW,EAAE,MAAM,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { generateHandleContextPath } from \"./dataStoreHandleContextUtils\";\nexport {\n\tcreate404Response,\n\tcreateDataStoreFactory,\n\tcreateResponseError,\n\texceptionToResponse,\n\tFactory,\n    packagePathToTelemetryProperty,\n\trequestFluidObject,\n\tresponseToException,\n} from \"./dataStoreHelpers\";\nexport { ObjectStoragePartition } from \"./objectstoragepartition\";\nexport { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from \"./objectstorageutils\";\nexport { RequestParser } from \"./requestParser\";\nexport { RuntimeFactoryHelper } from \"./runtimeFactoryHelper\";\nexport {\n\tcreateRootSummarizerNode,\n\tcreateRootSummarizerNodeWithGC,\n\tIRootSummarizerNode,\n\tIRootSummarizerNodeWithGC,\n\tISummarizerNodeRootContract,\n\tRefreshSummaryResult,\n} from \"./summarizerNode\";\nexport {\n\taddBlobToSummary,\n\taddSummarizeResultToSummary,\n\taddTreeToSummary,\n\tcalculateStats,\n\tconvertSnapshotTreeToSummaryTree,\n\tconvertSummaryTreeToITree,\n\tconvertToSummaryTree,\n\tconvertToSummaryTreeWithStats,\n\tgetBlobSize,\n\tmergeStats,\n\tSummaryTreeBuilder,\n\tTelemetryContext,\n\tutf8ByteLength,\n} from \"./summaryUtils\";\nexport { ReadAndParseBlob, seqFromTree } from \"./utils\";\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/runtime-utils";
-export declare const pkgVersion = "2.0.0-internal.2.1.1";
+export declare const pkgVersion = "2.0.0-internal.2.2.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/runtime-utils";
-export const pkgVersion = "2.0.0-internal.2.1.1";
+export const pkgVersion = "2.0.0-internal.2.2.0";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,+BAA+B,CAAC;AACvD,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,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/runtime-utils\";\nexport const pkgVersion = \"2.0.0-internal.2.1.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,+BAA+B,CAAC;AACvD,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,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/runtime-utils\";\nexport const pkgVersion = \"2.0.0-internal.2.2.0\";\n"]}

package/lib/summarizerNode/summarizerNodeWithGc.js

@@ -153,7 +153,7 @@ export class SummarizerNodeWithGC extends SummarizerNode {
         // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.
         if (!this.gcDisabled) {
             const summaryNode = this.pendingSummaries.get(proposalHandle);
-            if (summaryNode !== undefined) {
+            if ((summaryNode === null || summaryNode === void 0 ? void 0 : summaryNode.serializedUsedRoutes) !== undefined) {
                 this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);
             }
         }

package/lib/summarizerNode/summarizerNodeWithGc.js.map

@@ -1 +1 @@
-{"version":3,"file":"summarizerNodeWithGc.js","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNodeWithGc.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE,OAAO,EAEH,SAAS,GASZ,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAKH,WAAW,GACd,MAAM,uBAAuB,CAAC;AAI/B,wDAAwD;AACxD,MAAM,iBAAkB,SAAQ,WAAW;IACvC,YACoB,oBAA4B,EAC5C,OAKC;QAED,KAAK,CAAC,OAAO,CAAC,CAAC;QARC,yBAAoB,GAApB,oBAAoB,CAAQ;IAShD,CAAC;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,oBAAqB,SAAQ,cAAc;IAuBpD;;;OAGG;IACH,YACI,MAAwB,EACP,WAIqB,EACtC,MAAmC,EACnC,oBAA4B;IAC5B,8CAA8C;IAC9C,aAA2B,EAC3B,cAAgC,EAChC,gBAAmC,EAClB,WAAmE,EACpF,kBAAiE;QAEjE,KAAK,CACD,MAAM,EACN,KAAK,EAAE,QAAiB,EAAE,WAAoB,EAAE,gBAAoC,EAAE,EAAE,CACpF,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,EAClE,MAAM,EACN,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,gBAAgB,CACnB,CAAC;QAvBe,gBAAW,GAAX,WAAW,CAIU;QAOrB,gBAAW,GAAX,WAAW,CAAwD;QA9BxF,4FAA4F;QACpF,wBAAmB,GAAY,KAAK,CAAC;QAI7C,mHAAmH;QACnH,iHAAiH;QACjH,iHAAiH;QACzG,eAAU,GAAa,CAAC,EAAE,CAAC,CAAC;QAoChC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC;QAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE;;YAC7C,OAAO,MAAA,CAAC,MAAM,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,EAAI,CAAA,CAAC,mCAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,iBAAiB;;QAC3B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;QAEhD,8GAA8G;QAC9G,6CAA6C;QAC7C,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC1B,OAAO;SACV;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEhC,iEAAiE;QACjE,IAAI,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;SACnD;QACD,6GAA6G;QAC7G,wEAAwE;QACxE,IAAI,CAAC,mBAAmB,GAAG,MAAA,aAAa,CAAC,UAAU,0CAAE,IAAI,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,SAAS,CAClB,QAAiB,EACjB,aAAsB,IAAI,EAC1B,gBAAoC;QAEpC,+GAA+G;QAC/G,0EAA0E;QAC1E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,MAAM,CAAC,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC7C,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QAED,2FAA2F;QAC3F,8DAA8D;QAC9D,OAAO,UAAU;YACb,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;YACpE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,SAAkB,KAAK;QAC1C,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;QAClG,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAEtG,8GAA8G;QAC9G,6GAA6G;QAC7G,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,8GAA8G;QAC9G,4GAA4G;QAC5G,uCAAuC;QACvC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAChE,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACnC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,uBAA+B,EAAE,aAA+B;QAChF,sFAAsF;QACtF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,CACF,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC1C,KAAK,CAAC,iFAAiF,CAAC,CAAC;SAChG;QACD,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACO,mBAAmB,CACzB,cAAsB,EACtB,UAAmC,EACnC,mBAA4B;QAE5B,IAAI,uBAA2C,CAAC;QAChD,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC;YACvD,MAAM,CAAC,uBAAuB,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACzG;QAED,KAAK,CAAC,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAE3E,iEAAiE;QACjE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC9D,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,oEAAoE;gBACpE,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,uBAAwB,EAAE,WAAW,CAAC,CAAC;gBACvF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;aAChE;SACJ;IACL,CAAC;IAED;;OAEG;IACI,YAAY;QACf,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzC,KAAK,CAAC,YAAY,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACO,+BAA+B,CACrC,cAAsB,EACtB,uBAA+B;QAE/B,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAsB,CAAC;YACnF,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;aAC3E;SACJ;QAED,OAAO,KAAK,CAAC,+BAA+B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,gCAAgC,CAC5C,uBAA+B,EAC/B,YAA2B,EAC3B,QAAiC,EACjC,SAAsB,EACtB,uBAAyC,EACzC,gBAAkC;QAElC,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACpD,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC7B,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAgC,aAAa,CAAC,CAAC;gBAEvF,0FAA0F;gBAC1F,IAAI,IAAI,CAAC,uBAAuB,IAAI,uBAAuB,EAAE;oBACzD,OAAO;iBACV;gBAED,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC,UAAU,CAAC;aACnD;SACJ;QAED,OAAO,KAAK,CAAC,gCAAgC,CACzC,uBAAuB,EACvB,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED;;OAEG;IACI,WAAW;IACd,yBAAyB;IACzB,mBAAwC;IACxC,2CAA2C;IAC3C,EAAU;IACV;;;;OAIG;IACH,WAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE;;QAEjE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEzF,MAAM,aAAa,GAAwB,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC1F,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAClC,IAAI,CAAC,aAAa,EAClB,mBAAmB,kCAEZ,MAAM;YACT,gGAAgG;YAChG,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU,KAEpD,aAAa,CAAC,oBAAoB,EAClC,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,cAAc,EAC5B,IAAI,CAAC,gBAAgB,EACrB,WAAW,EACX,kBAAkB,CACrB,CAAC;QAEF,yGAAyG;QACzG,uEAAuE;QACvE,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,EAAU;QACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAyB,CAAC;IACzD,CAAC;IAEM,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IAEM,gBAAgB,CAAC,UAAoB;QACxC,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QAEpC,8GAA8G;QAC9G,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClE;IACL,CAAC;IAED;;OAEG;IACO,UAAU;QAChB,OAAO,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/D,CAAC;IAED;;OAEG;IACK,cAAc;QAClB,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,mBAAmB;QACvB,mEAAmE;QACnE,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC,mBAAmB,KAAK,SAAS;YACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrF,CAAC;CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC1C,MAAwB,EACxB,mBAAwC,EACxC,oBAA4B,EAC5B,uBAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE,EACxC,EAAE,CAAC,IAAI,oBAAoB,CACpD,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,oBAAoB,EACpB,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,uBAAuB,CAAC,EACtG,SAAS,CAAC,oBAAoB,EAC9B,SAAS,CAAC,sBAAsB,EAChC,WAAW,EACX,kBAAkB,CACrB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, LazyPromise } from \"@fluidframework/common-utils\";\nimport { cloneGCData } from \"@fluidframework/garbage-collector\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    CreateChildSummarizerNodeParam,\n    gcBlobKey,\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n    ISummarizeInternalResult,\n    ISummarizeResult,\n    ISummarizerNodeConfigWithGC,\n    ISummarizerNodeWithGC,\n    SummarizeInternalFn,\n    ITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { ReadAndParseBlob } from \"../utils\";\nimport { SummarizerNode } from \"./summarizerNode\";\nimport {\n    EscapedPath,\n    ICreateChildDetails,\n    IInitialSummary,\n    ISummarizerNodeRootContract,\n    SummaryNode,\n} from \"./summarizerNodeUtils\";\n\nexport interface IRootSummarizerNodeWithGC extends ISummarizerNodeWithGC, ISummarizerNodeRootContract {}\n\n// Extend SummaryNode to add used routes tracking to it.\nclass SummaryNodeWithGC extends SummaryNode {\n    constructor(\n        public readonly serializedUsedRoutes: string,\n        summary: {\n            readonly referenceSequenceNumber: number;\n            readonly basePath: EscapedPath | undefined;\n            readonly localPath: EscapedPath;\n            additionalPath?: EscapedPath;\n        },\n    ) {\n        super(summary);\n    }\n}\n\n/**\n * Extends the functionality of SummarizerNode to manage this node's garbage collection data:\n *\n * - Adds a new API `getGCData` to return GC data of this node.\n *\n * - Caches the result of `getGCData` to be used if nothing changes between summaries.\n *\n * - Manages the used routes of this node. These are used to identify if this node is referenced in the document\n * and to determine if the node's used state changed since last summary.\n *\n * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls\n * directly into summarizeInternal method.\n */\nexport class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNodeWithGC {\n    // Tracks the work-in-progress used routes during summary.\n    private wipSerializedUsedRoutes: string | undefined;\n\n    // This is the last known used routes of this node as seen by the server as part of a summary.\n    private referenceUsedRoutes: string[] | undefined;\n\n    // The base GC details of this node used to initialize the GC state.\n    private readonly baseGCDetailsP: LazyPromise<IGarbageCollectionDetailsBase>;\n\n    // Keeps track of whether we have loaded the base details to ensure that we on;y do it once.\n    private baseGCDetailsLoaded: boolean = false;\n\n    private gcData: IGarbageCollectionData | undefined;\n\n    // Set used routes to have self route by default. This makes the node referenced by default. This is done to ensure\n    // that this node is not marked as collected when running GC has been disabled. Once, the option to disable GC is\n    // removed (from runGC flag in IContainerRuntimeOptions), this should be changed to be have no routes by default.\n    private usedRoutes: string[] = [\"\"];\n\n    // True if GC is disabled for this node. If so, do not track GC specific state for a summary.\n    private readonly gcDisabled: boolean;\n\n    /**\n     * Do not call constructor directly.\n     * Use createRootSummarizerNodeWithGC to create root node, or createChild to create child nodes.\n     */\n    public constructor(\n        logger: ITelemetryLogger,\n        private readonly summarizeFn: (\n            fullTree: boolean,\n            trackState: boolean,\n            telemetryContext?: ITelemetryContext,\n        ) => Promise<ISummarizeInternalResult>,\n        config: ISummarizerNodeConfigWithGC,\n        changeSequenceNumber: number,\n        /** Undefined means created without summary */\n        latestSummary?: SummaryNode,\n        initialSummary?: IInitialSummary,\n        wipSummaryLogger?: ITelemetryLogger,\n        private readonly getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ) {\n        super(\n            logger,\n            async (fullTree: boolean, _trackState: boolean, telemetryContext?: ITelemetryContext) =>\n                summarizeFn(fullTree, true /* trackState */, telemetryContext),\n            config,\n            changeSequenceNumber,\n            latestSummary,\n            initialSummary,\n            wipSummaryLogger,\n        );\n\n        this.gcDisabled = config.gcDisabled === true;\n\n        this.baseGCDetailsP = new LazyPromise(async () => {\n            return (await getBaseGCDetailsFn?.()) ?? { usedRoutes: [] };\n        });\n    }\n\n    /**\n     * Loads state from this node's initial GC summary details. This contains the following data from the last summary\n     * seen by the server for this client:\n     * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.\n     * - gcData: The garbage collection data of this node that is required for running GC.\n     */\n    private async loadBaseGCDetails() {\n        const baseGCDetails = await this.baseGCDetailsP;\n\n        // Possible race - If there were parallel calls to loadBaseGCDetails, we want to make sure that we only update\n        // the state from the base details only once.\n        if (this.baseGCDetailsLoaded) {\n            return;\n        }\n        this.baseGCDetailsLoaded = true;\n\n        // If the GC details has GC data, initialize our GC data from it.\n        if (baseGCDetails.gcData !== undefined) {\n            this.gcData = cloneGCData(baseGCDetails.gcData);\n        }\n        // Sort the used routes because we compare them with the current used routes to check if they changed between\n        // summaries. Both are sorted so that the order of elements is the same.\n        this.referenceUsedRoutes = baseGCDetails.usedRoutes?.sort();\n    }\n\n    public async summarize(\n        fullTree: boolean,\n        trackState: boolean = true,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummarizeResult> {\n        // If GC is not disabled and we are tracking a summary, GC should have run and updated the used routes for this\n        // summary by calling updateUsedRoutes which sets wipSerializedUsedRoutes.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            assert(this.wipSerializedUsedRoutes !== undefined,\n                0x1b1 /* \"wip used routes should be set if tracking a summary\" */);\n        }\n\n        // If trackState is true, get summary from base summarizer node which tracks summary state.\n        // If trackState is false, get summary from summarizeInternal.\n        return trackState\n            ? super.summarize(fullTree, true /* trackState */, telemetryContext)\n            : this.summarizeFn(fullTree, trackState, telemetryContext);\n    }\n\n    /**\n     * Returns the GC data of this node. If nothing has changed since last summary, it tries to reuse the data from\n     * the previous summary. Else, it gets new GC data from the underlying Fluid object.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {\n        assert(!this.gcDisabled, 0x1b2 /* \"Getting GC data should not be called when GC is disabled!\" */);\n        assert(this.getGCDataFn !== undefined, 0x1b3 /* \"GC data cannot be retrieved without getGCDataFn\" */);\n\n        // Load GC details from the initial summary, if not already loaded. If this is the first time this function is\n        // called and the node's data has not changed since last summary, the GC data in initial details is returned.\n        await this.loadBaseGCDetails();\n\n        // If there is no new data since last summary and we have GC data from the previous run, return it. We may not\n        // have data from previous GC run for clients with older summary format before GC was added. They won't have\n        // GC details in their initial summary.\n        if (!fullGC && !this.hasDataChanged() && this.gcData !== undefined) {\n            return cloneGCData(this.gcData);\n        }\n\n        const gcData = await this.getGCDataFn(fullGC);\n        this.gcData = cloneGCData(gcData);\n        return gcData;\n    }\n\n    /**\n     * Called during the start of a summary. Updates the work-in-progress used routes.\n     */\n    public startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger) {\n        // If GC is disabled, skip setting wip used routes since we should not track GC state.\n        if (!this.gcDisabled) {\n            assert(\n                this.wipSerializedUsedRoutes === undefined,\n                0x1b4 /* \"We should not already be tracking used routes when to track a new summary\" */);\n        }\n        super.startSummary(referenceSequenceNumber, summaryLogger);\n    }\n\n    /**\n     * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending\n     * summary queue. We track this until we get an ack from the server for this summary.\n     */\n    protected completeSummaryCore(\n        proposalHandle: string,\n        parentPath: EscapedPath | undefined,\n        parentSkipRecursion: boolean,\n    ) {\n        let wipSerializedUsedRoutes: string | undefined;\n        // If GC is disabled, don't set wip used routes.\n        if (!this.gcDisabled) {\n            wipSerializedUsedRoutes = this.wipSerializedUsedRoutes;\n            assert(wipSerializedUsedRoutes !== undefined, 0x1b5 /* \"We should have been tracking used routes\" */);\n        }\n\n        super.completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion);\n\n        // If GC is disabled, skip setting pending summary with GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle);\n            if (summaryNode !== undefined) {\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const summaryNodeWithGC = new SummaryNodeWithGC(wipSerializedUsedRoutes!, summaryNode);\n                this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);\n            }\n        }\n    }\n\n    /**\n     * Clears the work-in-progress state.\n     */\n    public clearSummary() {\n        this.wipSerializedUsedRoutes = undefined;\n        super.clearSummary();\n    }\n\n    /**\n     * Called when we get an ack from the server for a summary we sent. Update the reference state of this node\n     * from the state in the pending summary queue.\n     */\n    protected refreshLatestSummaryFromPending(\n        proposalHandle: string,\n        referenceSequenceNumber: number,\n    ): void {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle) as SummaryNodeWithGC;\n            if (summaryNode !== undefined) {\n                this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);\n            }\n        }\n\n        return super.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);\n    }\n\n    /**\n     * Called when we need to upload the reference state from the given summary. Read the GC blob and get the state\n     * to upload from it.\n     */\n    protected async refreshLatestSummaryFromSnapshot(\n        referenceSequenceNumber: number,\n        snapshotTree: ISnapshotTree,\n        basePath: EscapedPath | undefined,\n        localPath: EscapedPath,\n        correlatedSummaryLogger: ITelemetryLogger,\n        readAndParseBlob: ReadAndParseBlob,\n    ): Promise<void> {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const gcDetailsBlob = snapshotTree.blobs[gcBlobKey];\n            if (gcDetailsBlob !== undefined) {\n                const gcDetails = await readAndParseBlob<IGarbageCollectionDetailsBase>(gcDetailsBlob);\n\n                // Possible re-entrancy. If we have already seen a summary later than this one, ignore it.\n                if (this.referenceSequenceNumber >= referenceSequenceNumber) {\n                    return;\n                }\n\n                this.referenceUsedRoutes = gcDetails.usedRoutes;\n            }\n        }\n\n        return super.refreshLatestSummaryFromSnapshot(\n            referenceSequenceNumber,\n            snapshotTree,\n            basePath,\n            localPath,\n            correlatedSummaryLogger,\n            readAndParseBlob,\n        );\n    }\n\n    /**\n     * Override the createChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public createChild(\n        /** Summarize function */\n        summarizeInternalFn: SummarizeInternalFn,\n        /** Initial id or path part of this node */\n        id: string,\n        /**\n         * Information needed to create the node.\n         * If it is from a base summary, it will assert that a summary has been seen.\n         * Attach information if it is created from an attach op.\n         */\n        createParam: CreateChildSummarizerNodeParam,\n        config: ISummarizerNodeConfigWithGC = {},\n        getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ): ISummarizerNodeWithGC {\n        assert(!this.children.has(id), 0x1b6 /* \"Create SummarizerNode child already exists\" */);\n\n        const createDetails: ICreateChildDetails = this.getCreateDetailsForChild(id, createParam);\n        const child = new SummarizerNodeWithGC(\n            this.defaultLogger,\n            summarizeInternalFn,\n            {\n                ...config,\n                // Propagate our gcDisabled state to the child if its not explicity specified in child's config.\n                gcDisabled: config.gcDisabled ?? this.gcDisabled,\n            },\n            createDetails.changeSequenceNumber,\n            createDetails.latestSummary,\n            createDetails.initialSummary,\n            this.wipSummaryLogger,\n            getGCDataFn,\n            getBaseGCDetailsFn,\n        );\n\n        // There may be additional state that has to be updated in this child. For example, if a summary is being\n        // tracked, the child's summary tracking state needs to be updated too.\n        this.maybeUpdateChildState(child);\n\n        this.children.set(id, child);\n        return child;\n    }\n\n    /**\n     * Deletes the child node with the given id.\n     */\n    public deleteChild(id: string): void {\n        this.children.delete(id);\n    }\n\n    /**\n     * Override the getChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public getChild(id: string): ISummarizerNodeWithGC | undefined {\n        return this.children.get(id) as SummarizerNodeWithGC;\n    }\n\n    public isReferenced(): boolean {\n        return this.usedRoutes.includes(\"\") || this.usedRoutes.includes(\"/\");\n    }\n\n    public updateUsedRoutes(usedRoutes: string[]) {\n        // Sort the given routes before updating. This will ensure that the routes compared in hasUsedStateChanged()\n        // are in the same order.\n        this.usedRoutes = usedRoutes.sort();\n\n        // If GC is not disabled and we are tracking a summary, update the work-in-progress used routes so that it can\n        // be tracked for this summary.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            this.wipSerializedUsedRoutes = JSON.stringify(this.usedRoutes);\n        }\n    }\n\n    /**\n     * Override the hasChanged method. If this node data or its used state changed, the node is considered changed.\n     */\n    protected hasChanged(): boolean {\n        return this.hasDataChanged() || this.hasUsedStateChanged();\n    }\n\n    /**\n     * This tells whether the data in this node has changed or not.\n     */\n    private hasDataChanged(): boolean {\n        return super.hasChanged();\n    }\n\n    /**\n     * This tells whether the used state of this node has changed since last successful summary. If the used routes\n     * of this node changed, its used state is considered changed. Basically, if this node or any of its child nodes\n     * was previously used and became unused (or vice versa), its used state has changed.\n     */\n    private hasUsedStateChanged(): boolean {\n        // If GC is disabled, we are not tracking used state, return false.\n        if (this.gcDisabled) {\n            return false;\n        }\n\n        return this.referenceUsedRoutes === undefined ||\n            JSON.stringify(this.usedRoutes) !== JSON.stringify(this.referenceUsedRoutes);\n    }\n}\n\n/**\n * Creates a root summarizer node with GC functionality built-in.\n * @param logger - Logger to use within SummarizerNode\n * @param summarizeInternalFn - Function to generate summary\n * @param changeSequenceNumber - Sequence number of latest change to new node/subtree\n * @param referenceSequenceNumber - Reference sequence number of last acked summary,\n * or undefined if not loaded from summary\n * @param config - Configure behavior of summarizer node\n * @param getGCDataFn - Function to get the GC data of this node\n * @param baseGCDetailsP - Function to get the initial GC details of this node\n */\nexport const createRootSummarizerNodeWithGC = (\n    logger: ITelemetryLogger,\n    summarizeInternalFn: SummarizeInternalFn,\n    changeSequenceNumber: number,\n    referenceSequenceNumber: number | undefined,\n    config: ISummarizerNodeConfigWithGC = {},\n    getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n): IRootSummarizerNodeWithGC => new SummarizerNodeWithGC(\n    logger,\n    summarizeInternalFn,\n    config,\n    changeSequenceNumber,\n    referenceSequenceNumber === undefined ? undefined : SummaryNode.createForRoot(referenceSequenceNumber),\n    undefined /* initialSummary */,\n    undefined /* wipSummaryLogger */,\n    getGCDataFn,\n    getBaseGCDetailsFn,\n);\n"]}
+{"version":3,"file":"summarizerNodeWithGc.js","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNodeWithGc.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE,OAAO,EAEH,SAAS,GASZ,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAKH,WAAW,GACd,MAAM,uBAAuB,CAAC;AAI/B,wDAAwD;AACxD,MAAM,iBAAkB,SAAQ,WAAW;IACvC,YACoB,oBAA4B,EAC5C,OAKC;QAED,KAAK,CAAC,OAAO,CAAC,CAAC;QARC,yBAAoB,GAApB,oBAAoB,CAAQ;IAShD,CAAC;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,oBAAqB,SAAQ,cAAc;IAuBpD;;;OAGG;IACH,YACI,MAAwB,EACP,WAIqB,EACtC,MAAmC,EACnC,oBAA4B;IAC5B,8CAA8C;IAC9C,aAA2B,EAC3B,cAAgC,EAChC,gBAAmC,EAClB,WAAmE,EACpF,kBAAiE;QAEjE,KAAK,CACD,MAAM,EACN,KAAK,EAAE,QAAiB,EAAE,WAAoB,EAAE,gBAAoC,EAAE,EAAE,CACpF,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,EAClE,MAAM,EACN,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,gBAAgB,CACnB,CAAC;QAvBe,gBAAW,GAAX,WAAW,CAIU;QAOrB,gBAAW,GAAX,WAAW,CAAwD;QA9BxF,4FAA4F;QACpF,wBAAmB,GAAY,KAAK,CAAC;QAI7C,mHAAmH;QACnH,iHAAiH;QACjH,iHAAiH;QACzG,eAAU,GAAa,CAAC,EAAE,CAAC,CAAC;QAoChC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC;QAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE;;YAC7C,OAAO,MAAA,CAAC,MAAM,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,EAAI,CAAA,CAAC,mCAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,iBAAiB;;QAC3B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;QAEhD,8GAA8G;QAC9G,6CAA6C;QAC7C,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC1B,OAAO;SACV;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEhC,iEAAiE;QACjE,IAAI,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;SACnD;QACD,6GAA6G;QAC7G,wEAAwE;QACxE,IAAI,CAAC,mBAAmB,GAAG,MAAA,aAAa,CAAC,UAAU,0CAAE,IAAI,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,SAAS,CAClB,QAAiB,EACjB,aAAsB,IAAI,EAC1B,gBAAoC;QAEpC,+GAA+G;QAC/G,0EAA0E;QAC1E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,MAAM,CAAC,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC7C,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QAED,2FAA2F;QAC3F,8DAA8D;QAC9D,OAAO,UAAU;YACb,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;YACpE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,SAAkB,KAAK;QAC1C,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;QAClG,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAEtG,8GAA8G;QAC9G,6GAA6G;QAC7G,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,8GAA8G;QAC9G,4GAA4G;QAC5G,uCAAuC;QACvC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAChE,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACnC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,uBAA+B,EAAE,aAA+B;QAChF,sFAAsF;QACtF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,CACF,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC1C,KAAK,CAAC,iFAAiF,CAAC,CAAC;SAChG;QACD,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACO,mBAAmB,CACzB,cAAsB,EACtB,UAAmC,EACnC,mBAA4B;QAE5B,IAAI,uBAA2C,CAAC;QAChD,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC;YACvD,MAAM,CAAC,uBAAuB,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACzG;QAED,KAAK,CAAC,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAE3E,iEAAiE;QACjE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC9D,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,oEAAoE;gBACpE,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,uBAAwB,EAAE,WAAW,CAAC,CAAC;gBACvF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;aAChE;SACJ;IACL,CAAC;IAED;;OAEG;IACI,YAAY;QACf,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzC,KAAK,CAAC,YAAY,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACO,+BAA+B,CACrC,cAAsB,EACtB,uBAA+B;QAE/B,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAsB,CAAC;YACnF,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,oBAAoB,MAAK,SAAS,EAAE;gBACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;aAC3E;SACJ;QAED,OAAO,KAAK,CAAC,+BAA+B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,gCAAgC,CAC5C,uBAA+B,EAC/B,YAA2B,EAC3B,QAAiC,EACjC,SAAsB,EACtB,uBAAyC,EACzC,gBAAkC;QAElC,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACpD,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC7B,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAgC,aAAa,CAAC,CAAC;gBAEvF,0FAA0F;gBAC1F,IAAI,IAAI,CAAC,uBAAuB,IAAI,uBAAuB,EAAE;oBACzD,OAAO;iBACV;gBAED,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC,UAAU,CAAC;aACnD;SACJ;QAED,OAAO,KAAK,CAAC,gCAAgC,CACzC,uBAAuB,EACvB,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED;;OAEG;IACI,WAAW;IACd,yBAAyB;IACzB,mBAAwC;IACxC,2CAA2C;IAC3C,EAAU;IACV;;;;OAIG;IACH,WAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE;;QAEjE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEzF,MAAM,aAAa,GAAwB,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC1F,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAClC,IAAI,CAAC,aAAa,EAClB,mBAAmB,kCAEZ,MAAM;YACT,gGAAgG;YAChG,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU,KAEpD,aAAa,CAAC,oBAAoB,EAClC,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,cAAc,EAC5B,IAAI,CAAC,gBAAgB,EACrB,WAAW,EACX,kBAAkB,CACrB,CAAC;QAEF,yGAAyG;QACzG,uEAAuE;QACvE,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,EAAU;QACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAyB,CAAC;IACzD,CAAC;IAEM,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IAEM,gBAAgB,CAAC,UAAoB;QACxC,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QAEpC,8GAA8G;QAC9G,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClE;IACL,CAAC;IAED;;OAEG;IACO,UAAU;QAChB,OAAO,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/D,CAAC;IAED;;OAEG;IACK,cAAc;QAClB,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,mBAAmB;QACvB,mEAAmE;QACnE,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC,mBAAmB,KAAK,SAAS;YACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrF,CAAC;CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC1C,MAAwB,EACxB,mBAAwC,EACxC,oBAA4B,EAC5B,uBAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE,EACxC,EAAE,CAAC,IAAI,oBAAoB,CACpD,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,oBAAoB,EACpB,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,uBAAuB,CAAC,EACtG,SAAS,CAAC,oBAAoB,EAC9B,SAAS,CAAC,sBAAsB,EAChC,WAAW,EACX,kBAAkB,CACrB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, LazyPromise } from \"@fluidframework/common-utils\";\nimport { cloneGCData } from \"@fluidframework/garbage-collector\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    CreateChildSummarizerNodeParam,\n    gcBlobKey,\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n    ISummarizeInternalResult,\n    ISummarizeResult,\n    ISummarizerNodeConfigWithGC,\n    ISummarizerNodeWithGC,\n    SummarizeInternalFn,\n    ITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { ReadAndParseBlob } from \"../utils\";\nimport { SummarizerNode } from \"./summarizerNode\";\nimport {\n    EscapedPath,\n    ICreateChildDetails,\n    IInitialSummary,\n    ISummarizerNodeRootContract,\n    SummaryNode,\n} from \"./summarizerNodeUtils\";\n\nexport interface IRootSummarizerNodeWithGC extends ISummarizerNodeWithGC, ISummarizerNodeRootContract {}\n\n// Extend SummaryNode to add used routes tracking to it.\nclass SummaryNodeWithGC extends SummaryNode {\n    constructor(\n        public readonly serializedUsedRoutes: string,\n        summary: {\n            readonly referenceSequenceNumber: number;\n            readonly basePath: EscapedPath | undefined;\n            readonly localPath: EscapedPath;\n            additionalPath?: EscapedPath;\n        },\n    ) {\n        super(summary);\n    }\n}\n\n/**\n * Extends the functionality of SummarizerNode to manage this node's garbage collection data:\n *\n * - Adds a new API `getGCData` to return GC data of this node.\n *\n * - Caches the result of `getGCData` to be used if nothing changes between summaries.\n *\n * - Manages the used routes of this node. These are used to identify if this node is referenced in the document\n * and to determine if the node's used state changed since last summary.\n *\n * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls\n * directly into summarizeInternal method.\n */\nexport class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNodeWithGC {\n    // Tracks the work-in-progress used routes during summary.\n    private wipSerializedUsedRoutes: string | undefined;\n\n    // This is the last known used routes of this node as seen by the server as part of a summary.\n    private referenceUsedRoutes: string[] | undefined;\n\n    // The base GC details of this node used to initialize the GC state.\n    private readonly baseGCDetailsP: LazyPromise<IGarbageCollectionDetailsBase>;\n\n    // Keeps track of whether we have loaded the base details to ensure that we on;y do it once.\n    private baseGCDetailsLoaded: boolean = false;\n\n    private gcData: IGarbageCollectionData | undefined;\n\n    // Set used routes to have self route by default. This makes the node referenced by default. This is done to ensure\n    // that this node is not marked as collected when running GC has been disabled. Once, the option to disable GC is\n    // removed (from runGC flag in IContainerRuntimeOptions), this should be changed to be have no routes by default.\n    private usedRoutes: string[] = [\"\"];\n\n    // True if GC is disabled for this node. If so, do not track GC specific state for a summary.\n    private readonly gcDisabled: boolean;\n\n    /**\n     * Do not call constructor directly.\n     * Use createRootSummarizerNodeWithGC to create root node, or createChild to create child nodes.\n     */\n    public constructor(\n        logger: ITelemetryLogger,\n        private readonly summarizeFn: (\n            fullTree: boolean,\n            trackState: boolean,\n            telemetryContext?: ITelemetryContext,\n        ) => Promise<ISummarizeInternalResult>,\n        config: ISummarizerNodeConfigWithGC,\n        changeSequenceNumber: number,\n        /** Undefined means created without summary */\n        latestSummary?: SummaryNode,\n        initialSummary?: IInitialSummary,\n        wipSummaryLogger?: ITelemetryLogger,\n        private readonly getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ) {\n        super(\n            logger,\n            async (fullTree: boolean, _trackState: boolean, telemetryContext?: ITelemetryContext) =>\n                summarizeFn(fullTree, true /* trackState */, telemetryContext),\n            config,\n            changeSequenceNumber,\n            latestSummary,\n            initialSummary,\n            wipSummaryLogger,\n        );\n\n        this.gcDisabled = config.gcDisabled === true;\n\n        this.baseGCDetailsP = new LazyPromise(async () => {\n            return (await getBaseGCDetailsFn?.()) ?? { usedRoutes: [] };\n        });\n    }\n\n    /**\n     * Loads state from this node's initial GC summary details. This contains the following data from the last summary\n     * seen by the server for this client:\n     * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.\n     * - gcData: The garbage collection data of this node that is required for running GC.\n     */\n    private async loadBaseGCDetails() {\n        const baseGCDetails = await this.baseGCDetailsP;\n\n        // Possible race - If there were parallel calls to loadBaseGCDetails, we want to make sure that we only update\n        // the state from the base details only once.\n        if (this.baseGCDetailsLoaded) {\n            return;\n        }\n        this.baseGCDetailsLoaded = true;\n\n        // If the GC details has GC data, initialize our GC data from it.\n        if (baseGCDetails.gcData !== undefined) {\n            this.gcData = cloneGCData(baseGCDetails.gcData);\n        }\n        // Sort the used routes because we compare them with the current used routes to check if they changed between\n        // summaries. Both are sorted so that the order of elements is the same.\n        this.referenceUsedRoutes = baseGCDetails.usedRoutes?.sort();\n    }\n\n    public async summarize(\n        fullTree: boolean,\n        trackState: boolean = true,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummarizeResult> {\n        // If GC is not disabled and we are tracking a summary, GC should have run and updated the used routes for this\n        // summary by calling updateUsedRoutes which sets wipSerializedUsedRoutes.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            assert(this.wipSerializedUsedRoutes !== undefined,\n                0x1b1 /* \"wip used routes should be set if tracking a summary\" */);\n        }\n\n        // If trackState is true, get summary from base summarizer node which tracks summary state.\n        // If trackState is false, get summary from summarizeInternal.\n        return trackState\n            ? super.summarize(fullTree, true /* trackState */, telemetryContext)\n            : this.summarizeFn(fullTree, trackState, telemetryContext);\n    }\n\n    /**\n     * Returns the GC data of this node. If nothing has changed since last summary, it tries to reuse the data from\n     * the previous summary. Else, it gets new GC data from the underlying Fluid object.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {\n        assert(!this.gcDisabled, 0x1b2 /* \"Getting GC data should not be called when GC is disabled!\" */);\n        assert(this.getGCDataFn !== undefined, 0x1b3 /* \"GC data cannot be retrieved without getGCDataFn\" */);\n\n        // Load GC details from the initial summary, if not already loaded. If this is the first time this function is\n        // called and the node's data has not changed since last summary, the GC data in initial details is returned.\n        await this.loadBaseGCDetails();\n\n        // If there is no new data since last summary and we have GC data from the previous run, return it. We may not\n        // have data from previous GC run for clients with older summary format before GC was added. They won't have\n        // GC details in their initial summary.\n        if (!fullGC && !this.hasDataChanged() && this.gcData !== undefined) {\n            return cloneGCData(this.gcData);\n        }\n\n        const gcData = await this.getGCDataFn(fullGC);\n        this.gcData = cloneGCData(gcData);\n        return gcData;\n    }\n\n    /**\n     * Called during the start of a summary. Updates the work-in-progress used routes.\n     */\n    public startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger) {\n        // If GC is disabled, skip setting wip used routes since we should not track GC state.\n        if (!this.gcDisabled) {\n            assert(\n                this.wipSerializedUsedRoutes === undefined,\n                0x1b4 /* \"We should not already be tracking used routes when to track a new summary\" */);\n        }\n        super.startSummary(referenceSequenceNumber, summaryLogger);\n    }\n\n    /**\n     * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending\n     * summary queue. We track this until we get an ack from the server for this summary.\n     */\n    protected completeSummaryCore(\n        proposalHandle: string,\n        parentPath: EscapedPath | undefined,\n        parentSkipRecursion: boolean,\n    ) {\n        let wipSerializedUsedRoutes: string | undefined;\n        // If GC is disabled, don't set wip used routes.\n        if (!this.gcDisabled) {\n            wipSerializedUsedRoutes = this.wipSerializedUsedRoutes;\n            assert(wipSerializedUsedRoutes !== undefined, 0x1b5 /* \"We should have been tracking used routes\" */);\n        }\n\n        super.completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion);\n\n        // If GC is disabled, skip setting pending summary with GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle);\n            if (summaryNode !== undefined) {\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const summaryNodeWithGC = new SummaryNodeWithGC(wipSerializedUsedRoutes!, summaryNode);\n                this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);\n            }\n        }\n    }\n\n    /**\n     * Clears the work-in-progress state.\n     */\n    public clearSummary() {\n        this.wipSerializedUsedRoutes = undefined;\n        super.clearSummary();\n    }\n\n    /**\n     * Called when we get an ack from the server for a summary we sent. Update the reference state of this node\n     * from the state in the pending summary queue.\n     */\n    protected refreshLatestSummaryFromPending(\n        proposalHandle: string,\n        referenceSequenceNumber: number,\n    ): void {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle) as SummaryNodeWithGC;\n            if (summaryNode?.serializedUsedRoutes !== undefined) {\n                this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);\n            }\n        }\n\n        return super.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);\n    }\n\n    /**\n     * Called when we need to upload the reference state from the given summary. Read the GC blob and get the state\n     * to upload from it.\n     */\n    protected async refreshLatestSummaryFromSnapshot(\n        referenceSequenceNumber: number,\n        snapshotTree: ISnapshotTree,\n        basePath: EscapedPath | undefined,\n        localPath: EscapedPath,\n        correlatedSummaryLogger: ITelemetryLogger,\n        readAndParseBlob: ReadAndParseBlob,\n    ): Promise<void> {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const gcDetailsBlob = snapshotTree.blobs[gcBlobKey];\n            if (gcDetailsBlob !== undefined) {\n                const gcDetails = await readAndParseBlob<IGarbageCollectionDetailsBase>(gcDetailsBlob);\n\n                // Possible re-entrancy. If we have already seen a summary later than this one, ignore it.\n                if (this.referenceSequenceNumber >= referenceSequenceNumber) {\n                    return;\n                }\n\n                this.referenceUsedRoutes = gcDetails.usedRoutes;\n            }\n        }\n\n        return super.refreshLatestSummaryFromSnapshot(\n            referenceSequenceNumber,\n            snapshotTree,\n            basePath,\n            localPath,\n            correlatedSummaryLogger,\n            readAndParseBlob,\n        );\n    }\n\n    /**\n     * Override the createChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public createChild(\n        /** Summarize function */\n        summarizeInternalFn: SummarizeInternalFn,\n        /** Initial id or path part of this node */\n        id: string,\n        /**\n         * Information needed to create the node.\n         * If it is from a base summary, it will assert that a summary has been seen.\n         * Attach information if it is created from an attach op.\n         */\n        createParam: CreateChildSummarizerNodeParam,\n        config: ISummarizerNodeConfigWithGC = {},\n        getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ): ISummarizerNodeWithGC {\n        assert(!this.children.has(id), 0x1b6 /* \"Create SummarizerNode child already exists\" */);\n\n        const createDetails: ICreateChildDetails = this.getCreateDetailsForChild(id, createParam);\n        const child = new SummarizerNodeWithGC(\n            this.defaultLogger,\n            summarizeInternalFn,\n            {\n                ...config,\n                // Propagate our gcDisabled state to the child if its not explicity specified in child's config.\n                gcDisabled: config.gcDisabled ?? this.gcDisabled,\n            },\n            createDetails.changeSequenceNumber,\n            createDetails.latestSummary,\n            createDetails.initialSummary,\n            this.wipSummaryLogger,\n            getGCDataFn,\n            getBaseGCDetailsFn,\n        );\n\n        // There may be additional state that has to be updated in this child. For example, if a summary is being\n        // tracked, the child's summary tracking state needs to be updated too.\n        this.maybeUpdateChildState(child);\n\n        this.children.set(id, child);\n        return child;\n    }\n\n    /**\n     * Deletes the child node with the given id.\n     */\n    public deleteChild(id: string): void {\n        this.children.delete(id);\n    }\n\n    /**\n     * Override the getChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public getChild(id: string): ISummarizerNodeWithGC | undefined {\n        return this.children.get(id) as SummarizerNodeWithGC;\n    }\n\n    public isReferenced(): boolean {\n        return this.usedRoutes.includes(\"\") || this.usedRoutes.includes(\"/\");\n    }\n\n    public updateUsedRoutes(usedRoutes: string[]) {\n        // Sort the given routes before updating. This will ensure that the routes compared in hasUsedStateChanged()\n        // are in the same order.\n        this.usedRoutes = usedRoutes.sort();\n\n        // If GC is not disabled and we are tracking a summary, update the work-in-progress used routes so that it can\n        // be tracked for this summary.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            this.wipSerializedUsedRoutes = JSON.stringify(this.usedRoutes);\n        }\n    }\n\n    /**\n     * Override the hasChanged method. If this node data or its used state changed, the node is considered changed.\n     */\n    protected hasChanged(): boolean {\n        return this.hasDataChanged() || this.hasUsedStateChanged();\n    }\n\n    /**\n     * This tells whether the data in this node has changed or not.\n     */\n    private hasDataChanged(): boolean {\n        return super.hasChanged();\n    }\n\n    /**\n     * This tells whether the used state of this node has changed since last successful summary. If the used routes\n     * of this node changed, its used state is considered changed. Basically, if this node or any of its child nodes\n     * was previously used and became unused (or vice versa), its used state has changed.\n     */\n    private hasUsedStateChanged(): boolean {\n        // If GC is disabled, we are not tracking used state, return false.\n        if (this.gcDisabled) {\n            return false;\n        }\n\n        return this.referenceUsedRoutes === undefined ||\n            JSON.stringify(this.usedRoutes) !== JSON.stringify(this.referenceUsedRoutes);\n    }\n}\n\n/**\n * Creates a root summarizer node with GC functionality built-in.\n * @param logger - Logger to use within SummarizerNode\n * @param summarizeInternalFn - Function to generate summary\n * @param changeSequenceNumber - Sequence number of latest change to new node/subtree\n * @param referenceSequenceNumber - Reference sequence number of last acked summary,\n * or undefined if not loaded from summary\n * @param config - Configure behavior of summarizer node\n * @param getGCDataFn - Function to get the GC data of this node\n * @param baseGCDetailsP - Function to get the initial GC details of this node\n */\nexport const createRootSummarizerNodeWithGC = (\n    logger: ITelemetryLogger,\n    summarizeInternalFn: SummarizeInternalFn,\n    changeSequenceNumber: number,\n    referenceSequenceNumber: number | undefined,\n    config: ISummarizerNodeConfigWithGC = {},\n    getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n): IRootSummarizerNodeWithGC => new SummarizerNodeWithGC(\n    logger,\n    summarizeInternalFn,\n    config,\n    changeSequenceNumber,\n    referenceSequenceNumber === undefined ? undefined : SummaryNode.createForRoot(referenceSequenceNumber),\n    undefined /* initialSummary */,\n    undefined /* wipSummaryLogger */,\n    getGCDataFn,\n    getBaseGCDetailsFn,\n);\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.0.0-internal.2.1.1",
+  "version": "2.0.0-internal.2.2.0",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -28,14 +28,18 @@
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
     "lint": "npm run eslint",
     "lint:fix": "npm run eslint:fix",
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
     "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
     "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
-    "typetests:gen": "fluid-type-validator -g -d ."
+    "typetests:gen": "flub generate typetests --generate --dir .",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
   },
   "nyc": {
     "all": true,
@@ -60,23 +64,23 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/garbage-collector": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/garbage-collector": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
     "@fluidframework/protocol-base": "^0.1038.2000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0"
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.5.0",
+    "@fluid-tools/build-cli": "^0.7.0",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.5.0",
-    "@fluidframework/eslint-config-fluid": "^1.1.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0-internal.2.0.0",
+    "@fluidframework/build-tools": "^0.7.0",
+    "@fluidframework/eslint-config-fluid": "^1.2.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0-internal.2.1.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -87,13 +91,16 @@
     "eslint": "~8.6.0",
     "mocha": "^10.0.0",
     "nyc": "^15.0.0",
+    "prettier": "~2.6.2",
     "rimraf": "^2.6.2",
     "sinon": "^7.4.2",
     "ts-node": "^7.0.1",
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.1.0",
+    "version": "2.0.0-internal.2.2.0",
+    "baselineRange": ">=2.0.0-internal.2.1.0 <2.0.0-internal.2.2.0",
+    "baselineVersion": "2.0.0-internal.2.1.0",
     "broken": {}
   }
 }

package/prettier.config.cjs

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

package/src/dataStoreHelpers.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { ITaggedTelemetryPropertyType } from "@fluidframework/common-definitions";
 import { assert } from "@fluidframework/common-utils";
 import {
     FluidObject,
@@ -15,7 +16,7 @@ import {
     IFluidDataStoreRegistry,
     IProvideFluidDataStoreRegistry,
 } from "@fluidframework/runtime-definitions";
-import { generateErrorWithStack } from "@fluidframework/telemetry-utils";
+import { generateErrorWithStack, TelemetryDataTag } from "@fluidframework/telemetry-utils";
 
 interface IResponseException extends Error {
     errorFromRequestFluidObject: true;
@@ -61,6 +62,15 @@ export function responseToException(response: IResponse, request: IRequest): Err
     return responseErr;
 }
 
+/**
+ * Takes a set of packages and joins them pkg1/pkg2... etc. Tags the field as a code artifact
+ */
+export function packagePathToTelemetryProperty(
+    packagePath: readonly string[] | undefined,
+): ITaggedTelemetryPropertyType | undefined {
+    return packagePath ? { value: packagePath.join("/"), tag: TelemetryDataTag.CodeArtifact } : undefined;
+}
+
 export async function requestFluidObject<T = FluidObject>(
     router: IFluidRouter, url: string | IRequest): Promise<T> {
     const request = typeof url === "string" ? { url } : url;

package/src/index.ts

@@ -10,6 +10,7 @@ export {
 	createResponseError,
 	exceptionToResponse,
 	Factory,
+    packagePathToTelemetryProperty,
 	requestFluidObject,
 	responseToException,
 } from "./dataStoreHelpers";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/runtime-utils";
-export const pkgVersion = "2.0.0-internal.2.1.1";
+export const pkgVersion = "2.0.0-internal.2.2.0";

package/src/summarizerNode/summarizerNodeWithGc.ts

@@ -250,7 +250,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
         // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.
         if (!this.gcDisabled) {
             const summaryNode = this.pendingSummaries.get(proposalHandle) as SummaryNodeWithGC;
-            if (summaryNode !== undefined) {
+            if (summaryNode?.serializedUsedRoutes !== undefined) {
                 this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);
             }
         }