@fluidframework/container-runtime 0.59.2001 → 0.59.3000-66610

package/dist/summaryGenerator.js.map

@@ -1 +1 @@
-{"version":3,"file":"summaryGenerator.js","sourceRoot":"","sources":["../src/summaryGenerator.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAMsC;AACtC,+EAAmE;AACnE,qEAA8F;AAC9F,+DAA6E;AAC7E,2EAAqE;AAsBrE,uEAAuE;AAChE,KAAK,UAAU,SAAS,CAC3B,OAAmB,EACnB,KAAmC,EACnC,iBAA6C;IAE7C,MAAM,QAAQ,GAAkC;QAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAY,CAAA,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAY,CAAA,CAAC;KACjE,CAAC;IACF,IAAI,iBAAiB,KAAK,SAAS,EAAE;QACjC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAY,CAAA,CAAC,CAAC,CAAC;KACjG;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAClC,CAAC;AAbD,8BAaC;AAED,yDAAyD;AACzD,MAAM,uBAAuB,GAAG,KAAK,CAAC,CAAC,SAAS;AAChD,MAAM,wBAAwB,GAAG,CAAC,CAAC,CAAC,4BAA4B;AAqChE,MAAM,eAAe,GAAG;IACpB;;;;OAIG;IACH,oBAAoB,EAAE,0DAA0D;IAChF;;;OAGG;IACH,oBAAoB,EAAE,kDAAkD;IACxE;;;;OAIG;IACH,qBAAqB,EAAE,qDAAqD;IAC5E;;;OAGG;IACH,WAAW,EAAE,4CAA4C;IAEzD,UAAU,EAAE,+DAA+D;CACrE,CAAC;AAEX,MAAa,sBAAsB;IAAnC;QACoB,qBAAgB,GAAG,IAAI,uBAAQ,EAA4C,CAAC;QAC5E,yBAAoB,GAAG,IAAI,uBAAQ,EAAgD,CAAC;QACpF,6BAAwB,GACpC,IAAI,uBAAQ,EAA8D,CAAC;IAmBnF,CAAC;IAjBU,IAAI,CAAC,OAAe,EAAE,KAAU,EAAE,iBAAsC,EAAE,iBAA0B;QACvG,qBAAM,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,WAAW,EAC7C,KAAK,CAAC,kEAAkE,CAAC,CAAC;QAE9E,MAAM,MAAM,GACR,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,iBAAiB,EAAW,CAAC;QACpF,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,wBAAwB,CAAC,OAAO,iCAAM,MAAM,KAAE,IAAI,EAAE,iBAAiB,IAAG,CAAC;IAClF,CAAC;IACM,KAAK;QACR,OAAO;YACH,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO;YAC/C,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,OAAO;YACvD,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,OAAO;SACzD,CAAC;IACf,CAAC;CACJ;AAvBD,wDAuBC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAEzB,YACqB,eAA8B,EAC9B,aAAsC,EACtC,qBAAuF,EACvF,qBAAqD,EACrD,yBAAqC,EACrC,cAA2D,EAC3D,MAAwB;QANxB,oBAAe,GAAf,eAAe,CAAe;QAC9B,kBAAa,GAAb,aAAa,CAAyB;QACtC,0BAAqB,GAArB,qBAAqB,CAAkE;QACvF,0BAAqB,GAArB,qBAAqB,CAAgC;QACrD,8BAAyB,GAAzB,yBAAyB,CAAY;QACrC,mBAAc,GAAd,cAAc,CAA6C;QAC3D,WAAM,GAAN,MAAM,CAAkB;QAEzC,IAAI,CAAC,cAAc,GAAG,IAAI,oBAAK,CAC3B,uBAAuB,EACvB,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAC/D,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CACZ,cAA6C,EAC7C,OAA0B,EAC1B,iBAA4C,EAC5C,cAAc,GAAG,IAAI,sBAAsB,EAAE;QAE7C,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,iBAAiB,CAAC;aAC7E,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,MAAM,OAAO,GAAG,0BAA0B,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,cAAc,iBAAG,SAAS,EAAE,OAAO,IAAK,cAAc,GAAI,KAAK,CAAC,CAAC;YAC7E,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,aAAa,CACvB,cAA6C,EAC7C,OAA0B,EAC1B,cAAsC,EACtC,iBAA4C;QAE5C,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAC/C,MAAM,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;QAEnF,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;QACrF,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,WAAW,CAAC;QAC/F,IAAI,uBAAuB,GAA8B;YACrD,QAAQ;YACR,oBAAoB;YACpB,oBAAoB;SACvB,CAAC;QAEF,MAAM,cAAc,GAAG,kCAAgB,CAAC,KAAK,CAAC,MAAM,kBAChD,SAAS,EAAE,WAAW,EACtB,gBAAgB,IACb,uBAAuB,EAC5B,CAAC;QAEH,kDAAkD;QAClD,MAAM,cAAc,GAChB,CAAC,SAAuC,EAAE,EAAE,CAAC,GAAG,SAAS,KAAK,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/F,MAAM,IAAI,GAAG,CACT,SAAuC,EACvC,KAAW,EACX,UAAsC,EACtC,iBAAsC,EACxC,EAAE;YACA,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;YACvD,gEAAgE;YAChE,oFAAoF;YACpF,MAAM,iBAAiB,GAAG,4CAA6B,CAAC,KAAK,CAAC,CAAC;YAE/D,+FAA+F;YAC/F,4FAA4F;YAC5F,oBAAoB;YACpB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,SAAS,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAK,oCAAe,CAAC,YAAY,CAAC,CAAC;gBAC/F,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;YAExB,cAAc,CAAC,MAAM,iCACb,UAAU,KACb,MAAM,EAAE,SAAS,EACjB,QAAQ;gBACR,iBAAiB,KACnB,KAAK,CAAC,CAAC;YACV,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;QAChG,CAAC,CAAC;QAEF,oCAAoC;QACpC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,oDAAoD;QACpD,IAAI,WAA4C,CAAC;QACjD,IAAI;YACA,WAAW,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC;gBAC3C,QAAQ;gBACR,gBAAgB;gBAChB,aAAa,EAAE,MAAM;gBACrB,iBAAiB;aACpB,CAAC,CAAC;YAEH,+EAA+E;YAC/E,MAAM,uBAAuB,GAAG,WAAW,CAAC,uBAAuB,CAAC;YACpE,MAAM,mBAAmB,GACrB,uBAAuB,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,iBAAiB,CAAC;YACzF,uBAAuB,mCAChB,uBAAuB,KAC1B,uBAAuB,EACvB,qBAAqB,EAAE,WAAW,CAAC,qBAAqB,EACxD,mBAAmB,EAAE,uBAAuB,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAC/F,mBAAmB,GACtB,CAAC;YACF,IAAI,WAAW,CAAC,KAAK,KAAK,MAAM,EAAE;gBAC9B,uBAAuB,iDAChB,uBAAuB,GACvB,WAAW,CAAC,YAAY,KAC3B,gBAAgB,EAAE,WAAW,CAAC,gBAAgB,GACjD,CAAC;gBAEF,IAAI,WAAW,CAAC,KAAK,KAAK,UAAU,EAAE;oBAClC,uBAAuB,mCAChB,uBAAuB,KAC1B,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,cAAc,EAAE,WAAW,CAAC,cAAc,GAC7C,CAAC;oBAEF,IAAI,WAAW,CAAC,KAAK,KAAK,QAAQ,EAAE;wBAChC,uBAAuB,mCAChB,uBAAuB,KAC1B,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,GACzD,CAAC;qBACL;iBACJ;aACJ;YAED,IAAI,WAAW,CAAC,KAAK,KAAK,QAAQ,EAAE;gBAChC,OAAO,IAAI,CAAC,sBAAsB,EAAE,WAAW,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;aACnF;YAED;;;;;;;;;eASG;YACH,IAAI,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE;gBAC1C,MAAM,EAAE,wBAAwB,EAAE,4BAA4B,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,YAAY,CAAC;gBAChG,IAAI,wBAAwB,GAAG,4BAA4B,GAAG,mBAAmB,EAAE;oBAC/E,MAAM,CAAC,cAAc,CAAC;wBAClB,SAAS,EAAE,6BAA6B;wBACxC,wBAAwB;wBACxB,4BAA4B;wBAC5B,mBAAmB;qBACtB,CAAC,CAAC;iBACN;aACJ;YAED,0FAA0F;YAC1F,cAAc,CAAC,WAAW,CAAC,UAAU,oBAAM,uBAAuB,EAAE,CAAC;YACrE,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;SACjF;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;SAC9C;gBAAS;YACN,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,uBAAuB,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;SAC/B;QAED,IAAI;YACA,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;YAEnF,qBAAqB;YACrB,MAAM,mBAAmB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;YACzG,IAAI,mBAAmB,CAAC,MAAM,KAAK,WAAW,EAAE;gBAC5C,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7B;YACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,MAAM,EAAE;gBACvC,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC;aACvC;YACD,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,CAAC;YAE9C,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;YAClF,cAAc,CAAC,oBAAoB,CAAC,OAAO,CAAC;gBACxC,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE;aAC3C,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB,GAAG,WAAW,CAAC,cAAc,CAAC;YAClF,MAAM,CAAC,kBAAkB,CAAC;gBACtB,SAAS,EAAE,cAAc;gBACzB,QAAQ,EAAE,iBAAiB;gBAC3B,uBAAuB,EAAE,WAAW,CAAC,uBAAuB;gBAC5D,qBAAqB,EAAE,WAAW,CAAC,cAAc;gBACjD,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,MAAM;aACtC,CAAC,CAAC;YAEH,oBAAoB;YACpB,MAAM,iBAAiB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;YACrG,IAAI,iBAAiB,CAAC,MAAM,KAAK,WAAW,EAAE;gBAC1C,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7B;YACD,IAAI,iBAAiB,CAAC,MAAM,KAAK,MAAM,EAAE;gBACrC,OAAO,IAAI,CAAC,uBAAuB,CAAC,CAAC;aACxC;YACD,MAAM,SAAS,GAAG,iBAAiB,CAAC,KAAK,CAAC;YAC1C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YAE7B,6BAA6B;YAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;YAEhF,wBAAwB;YACxB,uBAAuB,mBACnB,eAAe,EAAE,eAAe,EAChC,qBAAqB,EAAE,SAAS,CAAC,cAAc,EAC/C,qBAAqB,EAAE,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,IAC5E,uBAAuB,CAC7B,CAAC;YACF,IAAI,SAAS,CAAC,IAAI,KAAK,kCAAW,CAAC,UAAU,EAAE;gBAC3C,IAAI,CAAC,aAAa,CAAC,2BAA2B,EAAE,CAAC;gBACjD,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACjC,cAAc,CAAC,GAAG,iCACX,uBAAuB,KAC1B,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,IACnC,CAAC;gBACH,cAAc,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;wBACnE,YAAY,EAAE,SAAS;wBACvB,eAAe;qBAClB,EAAC,CAAC,CAAC;aACP;iBAAM;gBACH,gDAAgD;gBAChD,qBAAM,CAAC,SAAS,CAAC,IAAI,KAAK,kCAAW,CAAC,WAAW,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC7E,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC;gBACvC,MAAM,OAAO,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC;gBACrC,MAAM,iBAAiB,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,CAAC;gBAElD,6CAA6C;gBAC7C,MAAM,KAAK,GAAG,IAAI,8BAAY,CAAC,yBAAyB,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;gBAC1F,MAAM,CAAC,cAAc,+BACf,SAAS,EAAE,aAAa,IAAK,uBAAuB,KAAE,iBAAiB,KAAI,KAAK,CAAC,CAAC;gBAExF,qBAAM,CAAC,4CAA6B,CAAC,KAAK,CAAC,KAAK,iBAAiB,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;gBACpG,iGAAiG;gBACjG,OAAO,IAAI,CACP,aAAa,EACb,KAAK,kCACA,uBAAuB,KAAE,cAAc,EAAE,iBAAiB,KAC/D,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,CAChD,CAAC;aACL;SACJ;gBAAS;YACN,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;SAChC;IACL,CAAC;IAEO,qBAAqB,CAAC,IAAY,EAAE,KAAa;QACrD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;YAC7B,SAAS,EAAE,kBAAkB;YAC7B,WAAW,EAAE,IAAI;YACjB,YAAY,EAAE,KAAK;SACtB,CAAC,CAAC;QACH,IAAI,KAAK,GAAG,wBAAwB,EAAE;YAClC,+BAA+B;YAC/B,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC;YAC1B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;SAC9F;IACL,CAAC;IAEM,OAAO;QACV,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;CACJ;AAtRD,4CAsRC","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 {\n    assert,\n    Deferred,\n    IPromiseTimer,\n    IPromiseTimerResult,\n    Timer,\n} from \"@fluidframework/common-utils\";\nimport { MessageType } from \"@fluidframework/protocol-definitions\";\nimport { PerformanceEvent, LoggingError, ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { getRetryDelaySecondsFromError } from \"@fluidframework/driver-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IAckSummaryResult,\n    INackSummaryResult,\n    ISummarizeOptions,\n    IBroadcastSummaryResult,\n    ISummarizeResults,\n    ISummarizeHeuristicData,\n    ISubmitSummaryOptions,\n    SubmitSummaryResult,\n    SummarizeResultPart,\n    ISummaryCancellationToken,\n    ISummarizeTelemetryProperties,\n    SummaryGeneratorTelemetry,\n} from \"./summarizerTypes\";\nimport { IClientSummaryWatcher } from \"./summaryCollection\";\n\nexport type raceTimerResult<T> =\n    { result: \"done\"; value: T } |\n    { result: IPromiseTimerResult[\"timerResult\"] } |\n    { result: \"cancelled\" };\n\n/** Helper function to wait for a promise or PromiseTimer to elapse. */\nexport async function raceTimer<T>(\n    promise: Promise<T>,\n    timer: Promise<IPromiseTimerResult>,\n    cancellationToken?: ISummaryCancellationToken,\n): Promise<raceTimerResult<T>> {\n    const promises: Promise<raceTimerResult<T>>[] = [\n        promise.then((value) => ({ result: \"done\", value } as const)),\n        timer.then(({ timerResult: result }) => ({ result } as const)),\n    ];\n    if (cancellationToken !== undefined) {\n        promises.push(cancellationToken.waitCancelled.then(() => ({ result: \"cancelled\" } as const)));\n    }\n    return Promise.race(promises);\n}\n\n// Send some telemetry if generate summary takes too long\nconst maxSummarizeTimeoutTime = 20000; // 20 sec\nconst maxSummarizeTimeoutCount = 5; // Double and resend 5 times\n\nexport type SummarizeReason =\n    /**\n     * Attempt to summarize after idle timeout has elapsed.\n     * Idle timer restarts whenever an op is received. So this\n     * triggers only after some amount of time has passed with\n     * no ops being received.\n     */\n    | \"idle\"\n    /**\n     * Attempt to summarize after a maximum time since last\n     * successful summary has passed. This measures time since\n     * last summary ack op was processed.\n     */\n    | \"maxTime\"\n    /**\n     * Attempt to summarize after a maximum number of ops have\n     * passed since the last successful summary. This compares\n     * op sequence numbers with the reference sequence number\n     * of the summarize op corresponding to the last summary\n     * ack op.\n     */\n    | \"maxOps\"\n    /**\n     * Special case to attempt to summarize one last time before the\n     * summarizer client closes itself. This is to prevent cases where\n     * the summarizer client never gets a chance to summarize, because\n     * there are too many outstanding ops and/or parent client cannot\n     * stay connected long enough for summarizer client to catch up.\n     */\n    | \"lastSummary\"\n    /** On-demand summary requested with specified reason. */\n    | `onDemand;${string}`\n    /** Enqueue summarize attempt with specified reason. */\n    | `enqueue;${string}`;\n\nconst summarizeErrors = {\n    /**\n     * Error encountered while generating the summary tree, uploading\n     * it to storage, or submitting the op. It could be a result of\n     * the client becoming disconnected while generating or an actual error.\n     */\n    submitSummaryFailure: \"Error while generating, uploading, or submitting summary\",\n    /**\n     * The summaryAckWaitTimeout time has elapsed before receiving the summarize op\n     * sent by this summarize attempt. It is expected to be broadcast quickly.\n     */\n    summaryOpWaitTimeout: \"Timeout while waiting for summarize op broadcast\",\n    /**\n     * The summaryAckWaitTimeout time has elapsed before receiving either a\n     * summaryAck or summaryNack op from the server in response to this\n     * summarize attempt. It is expected that the server should respond.\n     */\n    summaryAckWaitTimeout: \"Timeout while waiting for summaryAck/summaryNack op\",\n    /**\n     * The server responded with a summaryNack op, thus rejecting this\n     * summarize attempt.\n     */\n    summaryNack: \"Server rejected summary via summaryNack op\",\n\n    disconnect: \"Summary cancelled due to summarizer or main client disconnect\",\n} as const;\n\nexport class SummarizeResultBuilder {\n    public readonly summarySubmitted = new Deferred<SummarizeResultPart<SubmitSummaryResult>>();\n    public readonly summaryOpBroadcasted = new Deferred<SummarizeResultPart<IBroadcastSummaryResult>>();\n    public readonly receivedSummaryAckOrNack =\n        new Deferred<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>();\n\n    public fail(message: string, error: any, nackSummaryResult?: INackSummaryResult, retryAfterSeconds?: number) {\n        assert(!this.receivedSummaryAckOrNack.isCompleted,\n            0x25e /* \"no reason to call fail if all promises have been completed\" */);\n\n        const result: SummarizeResultPart<undefined> =\n            { success: false, message, data: undefined, error, retryAfterSeconds } as const;\n        this.summarySubmitted.resolve(result);\n        this.summaryOpBroadcasted.resolve(result);\n        this.receivedSummaryAckOrNack.resolve({ ...result, data: nackSummaryResult });\n    }\n    public build(): ISummarizeResults {\n        return {\n            summarySubmitted: this.summarySubmitted.promise,\n            summaryOpBroadcasted: this.summaryOpBroadcasted.promise,\n            receivedSummaryAckOrNack: this.receivedSummaryAckOrNack.promise,\n        } as const;\n    }\n}\n\n/**\n * This class generates and tracks a summary attempt.\n */\nexport class SummaryGenerator {\n    private readonly summarizeTimer: Timer;\n    constructor(\n        private readonly pendingAckTimer: IPromiseTimer,\n        private readonly heuristicData: ISummarizeHeuristicData,\n        private readonly submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,\n        private readonly raiseSummarizingError: (errorMessage: string) => void,\n        private readonly successfulSummaryCallback: () => void,\n        private readonly summaryWatcher: Pick<IClientSummaryWatcher, \"watchSummary\">,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.summarizeTimer = new Timer(\n            maxSummarizeTimeoutTime,\n            () => this.summarizeTimerHandler(maxSummarizeTimeoutTime, 1),\n        );\n    }\n\n    /**\n     * Generates summary and listens for broadcast and ack/nack.\n     * Returns true for ack, false for nack, and undefined for failure or timeout.\n     * @param reason - reason for summarizing\n     * @param options - refreshLatestAck to fetch summary ack info from server,\n     * fullTree to generate tree without any summary handles even if unchanged\n     */\n    public summarize(\n        summarizeProps: ISummarizeTelemetryProperties,\n        options: ISummarizeOptions,\n        cancellationToken: ISummaryCancellationToken,\n        resultsBuilder = new SummarizeResultBuilder(),\n    ): ISummarizeResults {\n        this.summarizeCore(summarizeProps, options, resultsBuilder, cancellationToken)\n        .catch((error) => {\n            const message = \"UnexpectedSummarizeError\";\n            this.logger.sendErrorEvent({ eventName: message, ...summarizeProps }, error);\n            resultsBuilder.fail(message, error);\n        });\n\n        return resultsBuilder.build();\n    }\n\n    private async summarizeCore(\n        summarizeProps: ISummarizeTelemetryProperties,\n        options: ISummarizeOptions,\n        resultsBuilder: SummarizeResultBuilder,\n        cancellationToken: ISummaryCancellationToken,\n    ): Promise<void> {\n        const { refreshLatestAck, fullTree } = options;\n        const logger = ChildLogger.create(this.logger, undefined, { all: summarizeProps });\n\n        const timeSinceLastAttempt = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n        const timeSinceLastSummary = Date.now() - this.heuristicData.lastSuccessfulSummary.summaryTime;\n        let summarizeTelemetryProps: SummaryGeneratorTelemetry = {\n            fullTree,\n            timeSinceLastAttempt,\n            timeSinceLastSummary,\n        };\n\n        const summarizeEvent = PerformanceEvent.start(logger, {\n            eventName: \"Summarize\",\n            refreshLatestAck,\n            ...summarizeTelemetryProps,\n        });\n\n        // Helper functions to report failures and return.\n        const getFailMessage =\n            (errorCode: keyof typeof summarizeErrors) => `${errorCode}: ${summarizeErrors[errorCode]}`;\n        const fail = (\n            errorCode: keyof typeof summarizeErrors,\n            error?: any,\n            properties?: SummaryGeneratorTelemetry,\n            nackSummaryResult?: INackSummaryResult,\n        ) => {\n            this.raiseSummarizingError(summarizeErrors[errorCode]);\n            // UploadSummary may fail with 429 and retryAfter - respect that\n            // Summary Nack also can have retryAfter, it's parsed below and comes as a property.\n            const retryAfterSeconds = getRetryDelaySecondsFromError(error);\n\n            // Report any failure as an error unless it was due to cancellation (like \"disconnected\" error)\n            // If failure happened on upload, we may not yet realized that socket disconnected, so check\n            // offlineError too.\n            const category = cancellationToken.cancelled || error?.errorType === DriverErrorType.offlineError ?\n                \"generic\" : \"error\";\n\n            summarizeEvent.cancel({\n                 ...properties,\n                 reason: errorCode,\n                 category,\n                 retryAfterSeconds,\n            }, error);\n            resultsBuilder.fail(getFailMessage(errorCode), error, nackSummaryResult, retryAfterSeconds);\n        };\n\n        // Wait to generate and send summary\n        this.summarizeTimer.start();\n\n        // Use record type to prevent unexpected value types\n        let summaryData: SubmitSummaryResult | undefined;\n        try {\n            summaryData = await this.submitSummaryCallback({\n                fullTree,\n                refreshLatestAck,\n                summaryLogger: logger,\n                cancellationToken,\n            });\n\n            // Cumulatively add telemetry properties based on how far generateSummary went.\n            const referenceSequenceNumber = summaryData.referenceSequenceNumber;\n            const opsSinceLastSummary =\n                referenceSequenceNumber - this.heuristicData.lastSuccessfulSummary.refSequenceNumber;\n            summarizeTelemetryProps = {\n                ...summarizeTelemetryProps,\n                referenceSequenceNumber,\n                minimumSequenceNumber: summaryData.minimumSequenceNumber,\n                opsSinceLastAttempt: referenceSequenceNumber - this.heuristicData.lastAttempt.refSequenceNumber,\n                opsSinceLastSummary,\n            };\n            if (summaryData.stage !== \"base\") {\n                summarizeTelemetryProps = {\n                    ...summarizeTelemetryProps,\n                    ...summaryData.summaryStats,\n                    generateDuration: summaryData.generateDuration,\n                };\n\n                if (summaryData.stage !== \"generate\") {\n                    summarizeTelemetryProps = {\n                        ...summarizeTelemetryProps,\n                        handle: summaryData.handle,\n                        uploadDuration: summaryData.uploadDuration,\n                    };\n\n                    if (summaryData.stage !== \"upload\") {\n                        summarizeTelemetryProps = {\n                            ...summarizeTelemetryProps,\n                            clientSequenceNumber: summaryData.clientSequenceNumber,\n                        };\n                    }\n                }\n            }\n\n            if (summaryData.stage !== \"submit\") {\n                return fail(\"submitSummaryFailure\", summaryData.error, summarizeTelemetryProps);\n            }\n\n            /**\n             * With incremental summaries, if the full tree was not summarized, only data stores that changed should\n             * be summarized. A data store is considered changed if either or both of the following is true:\n             * - It has received an op.\n             * - Its reference state changed, i.e., it went from referenced to unreferenced or vice-versa.\n             *\n             * In the extreme case, every op can be for a different data store and each op can result in the reference\n             * state change of multiple data stores. So, the total number of data stores that are summarized should not\n             * exceed the number of ops since last summary + number of data store whose reference state changed.\n             */\n            if (!fullTree && !summaryData.forcedFullTree) {\n                const { summarizedDataStoreCount, gcStateUpdatedDataStoreCount = 0 } = summaryData.summaryStats;\n                if (summarizedDataStoreCount > gcStateUpdatedDataStoreCount + opsSinceLastSummary) {\n                    logger.sendErrorEvent({\n                        eventName: \"IncrementalSummaryViolation\",\n                        summarizedDataStoreCount,\n                        gcStateUpdatedDataStoreCount,\n                        opsSinceLastSummary,\n                    });\n                }\n            }\n\n            // Log event here on summary success only, as Summarize_cancel duplicates failure logging.\n            summarizeEvent.reportEvent(\"generate\", {...summarizeTelemetryProps});\n            resultsBuilder.summarySubmitted.resolve({ success: true, data: summaryData });\n        } catch (error) {\n            return fail(\"submitSummaryFailure\", error);\n        } finally {\n            this.heuristicData.recordAttempt(summaryData?.referenceSequenceNumber);\n            this.summarizeTimer.clear();\n        }\n\n        try {\n            const pendingTimeoutP = this.pendingAckTimer.start();\n            const summary = this.summaryWatcher.watchSummary(summaryData.clientSequenceNumber);\n\n            // Wait for broadcast\n            const waitBroadcastResult = await raceTimer(summary.waitBroadcast(), pendingTimeoutP, cancellationToken);\n            if (waitBroadcastResult.result === \"cancelled\") {\n                return fail(\"disconnect\");\n            }\n            if (waitBroadcastResult.result !== \"done\") {\n                return fail(\"summaryOpWaitTimeout\");\n            }\n            const summarizeOp = waitBroadcastResult.value;\n\n            const broadcastDuration = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n            resultsBuilder.summaryOpBroadcasted.resolve({\n                success: true,\n                data: { summarizeOp, broadcastDuration },\n            });\n\n            this.heuristicData.lastAttempt.summarySequenceNumber = summarizeOp.sequenceNumber;\n            logger.sendTelemetryEvent({\n                eventName: \"Summarize_Op\",\n                duration: broadcastDuration,\n                referenceSequenceNumber: summarizeOp.referenceSequenceNumber,\n                summarySequenceNumber: summarizeOp.sequenceNumber,\n                handle: summarizeOp.contents.handle,\n            });\n\n            // Wait for ack/nack\n            const waitAckNackResult = await raceTimer(summary.waitAckNack(), pendingTimeoutP, cancellationToken);\n            if (waitAckNackResult.result === \"cancelled\") {\n                return fail(\"disconnect\");\n            }\n            if (waitAckNackResult.result !== \"done\") {\n                return fail(\"summaryAckWaitTimeout\");\n            }\n            const ackNackOp = waitAckNackResult.value;\n            this.pendingAckTimer.clear();\n\n            // Update for success/failure\n            const ackNackDuration = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n\n            // adding new properties\n            summarizeTelemetryProps = {\n                ackWaitDuration: ackNackDuration,\n                ackNackSequenceNumber: ackNackOp.sequenceNumber,\n                summarySequenceNumber: ackNackOp.contents.summaryProposal.summarySequenceNumber,\n                ...summarizeTelemetryProps,\n            };\n            if (ackNackOp.type === MessageType.SummaryAck) {\n                this.heuristicData.markLastAttemptAsSuccessful();\n                this.successfulSummaryCallback();\n                summarizeEvent.end({\n                    ...summarizeTelemetryProps,\n                    handle: ackNackOp.contents.handle,\n                });\n                resultsBuilder.receivedSummaryAckOrNack.resolve({ success: true, data: {\n                    summaryAckOp: ackNackOp,\n                    ackNackDuration,\n                }});\n            } else {\n                // Check for retryDelay in summaryNack response.\n                assert(ackNackOp.type === MessageType.SummaryNack, 0x274 /* \"type check\" */);\n                const summaryNack = ackNackOp.contents;\n                const message = summaryNack?.message;\n                const retryAfterSeconds = summaryNack?.retryAfter;\n\n                // pre-0.58 error message prefix: summaryNack\n                const error = new LoggingError(`Received summaryNack: ${message}`, { retryAfterSeconds });\n                logger.sendErrorEvent(\n                    { eventName: \"SummaryNack\", ...summarizeTelemetryProps, retryAfterSeconds }, error);\n\n                assert(getRetryDelaySecondsFromError(error) === retryAfterSeconds, 0x25f /* \"retryAfterSeconds\" */);\n                // This will only set resultsBuilder.receivedSummaryAckOrNack, as other promises are already set.\n                return fail(\n                    \"summaryNack\",\n                    error,\n                    { ...summarizeTelemetryProps, nackRetryAfter: retryAfterSeconds },\n                    { summaryNackOp: ackNackOp, ackNackDuration },\n                );\n            }\n        } finally {\n            this.pendingAckTimer.clear();\n        }\n    }\n\n    private summarizeTimerHandler(time: number, count: number) {\n        this.logger.sendPerformanceEvent({\n            eventName: \"SummarizeTimeout\",\n            timeoutTime: time,\n            timeoutCount: count,\n        });\n        if (count < maxSummarizeTimeoutCount) {\n            // Double and start a new timer\n            const nextTime = time * 2;\n            this.summarizeTimer.start(nextTime, () => this.summarizeTimerHandler(nextTime, count + 1));\n        }\n    }\n\n    public dispose() {\n        this.summarizeTimer.clear();\n    }\n}\n"]}
+{"version":3,"file":"summaryGenerator.js","sourceRoot":"","sources":["../src/summaryGenerator.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAMsC;AACtC,+EAAmE;AACnE,qEAA8F;AAC9F,+DAA6E;AAC7E,2EAAqE;AAsBrE,uEAAuE;AAChE,KAAK,UAAU,SAAS,CAC3B,OAAmB,EACnB,KAAmC,EACnC,iBAA6C;IAE7C,MAAM,QAAQ,GAAkC;QAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAY,CAAA,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAY,CAAA,CAAC;KACjE,CAAC;IACF,IAAI,iBAAiB,KAAK,SAAS,EAAE;QACjC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAY,CAAA,CAAC,CAAC,CAAC;KACjG;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAClC,CAAC;AAbD,8BAaC;AAED,yDAAyD;AACzD,MAAM,uBAAuB,GAAG,KAAK,CAAC,CAAC,SAAS;AAChD,MAAM,wBAAwB,GAAG,CAAC,CAAC,CAAC,4BAA4B;AAqChE,MAAM,eAAe,GAAG;IACpB;;;;OAIG;IACH,oBAAoB,EAAE,0DAA0D;IAChF;;;OAGG;IACH,oBAAoB,EAAE,kDAAkD;IACxE;;;;OAIG;IACH,qBAAqB,EAAE,qDAAqD;IAC5E;;;OAGG;IACH,WAAW,EAAE,4CAA4C;IAEzD,UAAU,EAAE,+DAA+D;CACrE,CAAC;AAEX,MAAa,sBAAsB;IAAnC;QACoB,qBAAgB,GAAG,IAAI,uBAAQ,EAA4C,CAAC;QAC5E,yBAAoB,GAAG,IAAI,uBAAQ,EAAgD,CAAC;QACpF,6BAAwB,GACpC,IAAI,uBAAQ,EAA8D,CAAC;IAmBnF,CAAC;IAjBU,IAAI,CAAC,OAAe,EAAE,KAAU,EAAE,iBAAsC,EAAE,iBAA0B;QACvG,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,WAAW,EAC7C,KAAK,CAAC,kEAAkE,CAAC,CAAC;QAE9E,MAAM,MAAM,GACR,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,iBAAiB,EAAW,CAAC;QACpF,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,wBAAwB,CAAC,OAAO,iCAAM,MAAM,KAAE,IAAI,EAAE,iBAAiB,IAAG,CAAC;IAClF,CAAC;IACM,KAAK;QACR,OAAO;YACH,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO;YAC/C,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,OAAO;YACvD,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,OAAO;SACzD,CAAC;IACf,CAAC;CACJ;AAvBD,wDAuBC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAEzB,YACqB,eAA8B,EAC9B,aAAsC,EACtC,qBAAuF,EACvF,qBAAqD,EACrD,yBAAqC,EACrC,cAA2D,EAC3D,MAAwB;QANxB,oBAAe,GAAf,eAAe,CAAe;QAC9B,kBAAa,GAAb,aAAa,CAAyB;QACtC,0BAAqB,GAArB,qBAAqB,CAAkE;QACvF,0BAAqB,GAArB,qBAAqB,CAAgC;QACrD,8BAAyB,GAAzB,yBAAyB,CAAY;QACrC,mBAAc,GAAd,cAAc,CAA6C;QAC3D,WAAM,GAAN,MAAM,CAAkB;QAEzC,IAAI,CAAC,cAAc,GAAG,IAAI,oBAAK,CAC3B,uBAAuB,EACvB,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAC/D,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CACZ,cAA6C,EAC7C,OAA0B,EAC1B,iBAA4C,EAC5C,cAAc,GAAG,IAAI,sBAAsB,EAAE;QAE7C,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,iBAAiB,CAAC;aAC7E,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,MAAM,OAAO,GAAG,0BAA0B,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,cAAc,iBAAG,SAAS,EAAE,OAAO,IAAK,cAAc,GAAI,KAAK,CAAC,CAAC;YAC7E,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,aAAa,CACvB,cAA6C,EAC7C,OAA0B,EAC1B,cAAsC,EACtC,iBAA4C;QAE5C,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAC/C,MAAM,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;QAEnF,8DAA8D;QAC9D,wEAAwE;QACxE,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;QACrF,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,WAAW,CAAC;QAC/F,IAAI,uBAAuB,GAA8B;YACrD,QAAQ;YACR,oBAAoB;YACpB,oBAAoB;SACvB,CAAC;QAEF,MAAM,cAAc,GAAG,kCAAgB,CAAC,KAAK,CAAC,MAAM,kBAChD,SAAS,EAAE,WAAW,EACtB,gBAAgB,IACb,uBAAuB,EAC5B,CAAC;QAEH,kDAAkD;QAClD,MAAM,cAAc,GAChB,CAAC,SAAuC,EAAE,EAAE,CAAC,GAAG,SAAS,KAAK,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/F,MAAM,IAAI,GAAG,CACT,SAAuC,EACvC,KAAW,EACX,UAAsC,EACtC,iBAAsC,EACxC,EAAE;YACA,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;YACvD,gEAAgE;YAChE,oFAAoF;YACpF,MAAM,iBAAiB,GAAG,IAAA,4CAA6B,EAAC,KAAK,CAAC,CAAC;YAE/D,+FAA+F;YAC/F,4FAA4F;YAC5F,oBAAoB;YACpB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,SAAS,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAK,oCAAe,CAAC,YAAY,CAAC,CAAC;gBAC/F,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;YAExB,cAAc,CAAC,MAAM,iCACb,UAAU,KACb,MAAM,EAAE,SAAS,EACjB,QAAQ;gBACR,iBAAiB,KACnB,KAAK,CAAC,CAAC;YACV,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;QAChG,CAAC,CAAC;QAEF,oCAAoC;QACpC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,oDAAoD;QACpD,IAAI,WAA4C,CAAC;QACjD,IAAI;YACA,WAAW,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC;gBAC3C,QAAQ;gBACR,gBAAgB;gBAChB,aAAa,EAAE,MAAM;gBACrB,iBAAiB;aACpB,CAAC,CAAC;YAEH,+EAA+E;YAC/E,MAAM,uBAAuB,GAAG,WAAW,CAAC,uBAAuB,CAAC;YACpE,MAAM,mBAAmB,GACrB,uBAAuB,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,iBAAiB,CAAC;YACzF,uBAAuB,mCAChB,uBAAuB,KAC1B,uBAAuB,EACvB,qBAAqB,EAAE,WAAW,CAAC,qBAAqB,EACxD,mBAAmB,EAAE,uBAAuB,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAC/F,mBAAmB,GACtB,CAAC;YACF,IAAI,WAAW,CAAC,KAAK,KAAK,MAAM,EAAE;gBAC9B,uBAAuB,iDAChB,uBAAuB,GACvB,WAAW,CAAC,YAAY,KAC3B,gBAAgB,EAAE,WAAW,CAAC,gBAAgB,GACjD,CAAC;gBAEF,IAAI,WAAW,CAAC,KAAK,KAAK,UAAU,EAAE;oBAClC,uBAAuB,mCAChB,uBAAuB,KAC1B,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,cAAc,EAAE,WAAW,CAAC,cAAc,GAC7C,CAAC;oBAEF,IAAI,WAAW,CAAC,KAAK,KAAK,QAAQ,EAAE;wBAChC,uBAAuB,mCAChB,uBAAuB,KAC1B,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,GACzD,CAAC;qBACL;iBACJ;aACJ;YAED,IAAI,WAAW,CAAC,KAAK,KAAK,QAAQ,EAAE;gBAChC,OAAO,IAAI,CAAC,sBAAsB,EAAE,WAAW,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;aACnF;YAED;;;;;;;;;eASG;YACH,IAAI,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE;gBAC1C,MAAM,EAAE,wBAAwB,EAAE,4BAA4B,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,YAAY,CAAC;gBAChG,IAAI,wBAAwB,GAAG,4BAA4B,GAAG,mBAAmB,EAAE;oBAC/E,MAAM,CAAC,cAAc,CAAC;wBAClB,SAAS,EAAE,6BAA6B;wBACxC,wBAAwB;wBACxB,4BAA4B;wBAC5B,mBAAmB;qBACtB,CAAC,CAAC;iBACN;aACJ;YAED,0FAA0F;YAC1F,cAAc,CAAC,WAAW,CAAC,UAAU,oBAAO,uBAAuB,EAAG,CAAC;YACvE,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;SACjF;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;SAC9C;gBAAS;YACN,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,uBAAuB,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;SAC/B;QAED,IAAI;YACA,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;YAEnF,qBAAqB;YACrB,MAAM,mBAAmB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;YACzG,IAAI,mBAAmB,CAAC,MAAM,KAAK,WAAW,EAAE;gBAC5C,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7B;YACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,MAAM,EAAE;gBACvC,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC;aACvC;YACD,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,CAAC;YAE9C,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;YAClF,cAAc,CAAC,oBAAoB,CAAC,OAAO,CAAC;gBACxC,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE;aAC3C,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB,GAAG,WAAW,CAAC,cAAc,CAAC;YAClF,MAAM,CAAC,kBAAkB,CAAC;gBACtB,SAAS,EAAE,cAAc;gBACzB,QAAQ,EAAE,iBAAiB;gBAC3B,uBAAuB,EAAE,WAAW,CAAC,uBAAuB;gBAC5D,qBAAqB,EAAE,WAAW,CAAC,cAAc;gBACjD,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,MAAM;aACtC,CAAC,CAAC;YAEH,oBAAoB;YACpB,MAAM,iBAAiB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;YACrG,IAAI,iBAAiB,CAAC,MAAM,KAAK,WAAW,EAAE;gBAC1C,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7B;YACD,IAAI,iBAAiB,CAAC,MAAM,KAAK,MAAM,EAAE;gBACrC,OAAO,IAAI,CAAC,uBAAuB,CAAC,CAAC;aACxC;YACD,MAAM,SAAS,GAAG,iBAAiB,CAAC,KAAK,CAAC;YAC1C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YAE7B,6BAA6B;YAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;YAEhF,wBAAwB;YACxB,uBAAuB,mBACnB,eAAe,EAAE,eAAe,EAChC,qBAAqB,EAAE,SAAS,CAAC,cAAc,EAC/C,qBAAqB,EAAE,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,IAC5E,uBAAuB,CAC7B,CAAC;YACF,IAAI,SAAS,CAAC,IAAI,KAAK,kCAAW,CAAC,UAAU,EAAE;gBAC3C,IAAI,CAAC,aAAa,CAAC,2BAA2B,EAAE,CAAC;gBACjD,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACjC,cAAc,CAAC,GAAG,iCACX,uBAAuB,KAC1B,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,IACnC,CAAC;gBACH,cAAc,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;wBACnE,YAAY,EAAE,SAAS;wBACvB,eAAe;qBAClB,EAAE,CAAC,CAAC;aACR;iBAAM;gBACH,gDAAgD;gBAChD,IAAA,qBAAM,EAAC,SAAS,CAAC,IAAI,KAAK,kCAAW,CAAC,WAAW,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC7E,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC;gBACvC,MAAM,OAAO,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC;gBACrC,MAAM,iBAAiB,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,CAAC;gBAElD,6CAA6C;gBAC7C,MAAM,KAAK,GAAG,IAAI,8BAAY,CAAC,yBAAyB,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;gBAC1F,MAAM,CAAC,cAAc,+BACf,SAAS,EAAE,aAAa,IAAK,uBAAuB,KAAE,iBAAiB,KAAI,KAAK,CAAC,CAAC;gBAExF,IAAA,qBAAM,EAAC,IAAA,4CAA6B,EAAC,KAAK,CAAC,KAAK,iBAAiB,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;gBACpG,iGAAiG;gBACjG,OAAO,IAAI,CACP,aAAa,EACb,KAAK,kCACA,uBAAuB,KAAE,cAAc,EAAE,iBAAiB,KAC/D,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,CAChD,CAAC;aACL;SACJ;gBAAS;YACN,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;SAChC;IACL,CAAC;IAEO,qBAAqB,CAAC,IAAY,EAAE,KAAa;QACrD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;YAC7B,SAAS,EAAE,kBAAkB;YAC7B,WAAW,EAAE,IAAI;YACjB,YAAY,EAAE,KAAK;SACtB,CAAC,CAAC;QACH,IAAI,KAAK,GAAG,wBAAwB,EAAE;YAClC,+BAA+B;YAC/B,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC;YAC1B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;SAC9F;IACL,CAAC;IAEM,OAAO;QACV,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;CACJ;AAxRD,4CAwRC","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 {\n    assert,\n    Deferred,\n    IPromiseTimer,\n    IPromiseTimerResult,\n    Timer,\n} from \"@fluidframework/common-utils\";\nimport { MessageType } from \"@fluidframework/protocol-definitions\";\nimport { PerformanceEvent, LoggingError, ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { getRetryDelaySecondsFromError } from \"@fluidframework/driver-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IAckSummaryResult,\n    INackSummaryResult,\n    ISummarizeOptions,\n    IBroadcastSummaryResult,\n    ISummarizeResults,\n    ISummarizeHeuristicData,\n    ISubmitSummaryOptions,\n    SubmitSummaryResult,\n    SummarizeResultPart,\n    ISummaryCancellationToken,\n    ISummarizeTelemetryProperties,\n    SummaryGeneratorTelemetry,\n} from \"./summarizerTypes\";\nimport { IClientSummaryWatcher } from \"./summaryCollection\";\n\nexport type raceTimerResult<T> =\n    { result: \"done\"; value: T; } |\n    { result: IPromiseTimerResult[\"timerResult\"]; } |\n    { result: \"cancelled\"; };\n\n/** Helper function to wait for a promise or PromiseTimer to elapse. */\nexport async function raceTimer<T>(\n    promise: Promise<T>,\n    timer: Promise<IPromiseTimerResult>,\n    cancellationToken?: ISummaryCancellationToken,\n): Promise<raceTimerResult<T>> {\n    const promises: Promise<raceTimerResult<T>>[] = [\n        promise.then((value) => ({ result: \"done\", value } as const)),\n        timer.then(({ timerResult: result }) => ({ result } as const)),\n    ];\n    if (cancellationToken !== undefined) {\n        promises.push(cancellationToken.waitCancelled.then(() => ({ result: \"cancelled\" } as const)));\n    }\n    return Promise.race(promises);\n}\n\n// Send some telemetry if generate summary takes too long\nconst maxSummarizeTimeoutTime = 20000; // 20 sec\nconst maxSummarizeTimeoutCount = 5; // Double and resend 5 times\n\nexport type SummarizeReason =\n    /**\n     * Attempt to summarize after idle timeout has elapsed.\n     * Idle timer restarts whenever an op is received. So this\n     * triggers only after some amount of time has passed with\n     * no ops being received.\n     */\n    | \"idle\"\n    /**\n     * Attempt to summarize after a maximum time since last\n     * successful summary has passed. This measures time since\n     * last summary ack op was processed.\n     */\n    | \"maxTime\"\n    /**\n     * Attempt to summarize after a maximum number of ops have\n     * passed since the last successful summary. This compares\n     * op sequence numbers with the reference sequence number\n     * of the summarize op corresponding to the last summary\n     * ack op.\n     */\n    | \"maxOps\"\n    /**\n     * Special case to attempt to summarize one last time before the\n     * summarizer client closes itself. This is to prevent cases where\n     * the summarizer client never gets a chance to summarize, because\n     * there are too many outstanding ops and/or parent client cannot\n     * stay connected long enough for summarizer client to catch up.\n     */\n    | \"lastSummary\"\n    /** On-demand summary requested with specified reason. */\n    | `onDemand;${string}`\n    /** Enqueue summarize attempt with specified reason. */\n    | `enqueue;${string}`;\n\nconst summarizeErrors = {\n    /**\n     * Error encountered while generating the summary tree, uploading\n     * it to storage, or submitting the op. It could be a result of\n     * the client becoming disconnected while generating or an actual error.\n     */\n    submitSummaryFailure: \"Error while generating, uploading, or submitting summary\",\n    /**\n     * The summaryAckWaitTimeout time has elapsed before receiving the summarize op\n     * sent by this summarize attempt. It is expected to be broadcast quickly.\n     */\n    summaryOpWaitTimeout: \"Timeout while waiting for summarize op broadcast\",\n    /**\n     * The summaryAckWaitTimeout time has elapsed before receiving either a\n     * summaryAck or summaryNack op from the server in response to this\n     * summarize attempt. It is expected that the server should respond.\n     */\n    summaryAckWaitTimeout: \"Timeout while waiting for summaryAck/summaryNack op\",\n    /**\n     * The server responded with a summaryNack op, thus rejecting this\n     * summarize attempt.\n     */\n    summaryNack: \"Server rejected summary via summaryNack op\",\n\n    disconnect: \"Summary cancelled due to summarizer or main client disconnect\",\n} as const;\n\nexport class SummarizeResultBuilder {\n    public readonly summarySubmitted = new Deferred<SummarizeResultPart<SubmitSummaryResult>>();\n    public readonly summaryOpBroadcasted = new Deferred<SummarizeResultPart<IBroadcastSummaryResult>>();\n    public readonly receivedSummaryAckOrNack =\n        new Deferred<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>();\n\n    public fail(message: string, error: any, nackSummaryResult?: INackSummaryResult, retryAfterSeconds?: number) {\n        assert(!this.receivedSummaryAckOrNack.isCompleted,\n            0x25e /* \"no reason to call fail if all promises have been completed\" */);\n\n        const result: SummarizeResultPart<undefined> =\n            { success: false, message, data: undefined, error, retryAfterSeconds } as const;\n        this.summarySubmitted.resolve(result);\n        this.summaryOpBroadcasted.resolve(result);\n        this.receivedSummaryAckOrNack.resolve({ ...result, data: nackSummaryResult });\n    }\n    public build(): ISummarizeResults {\n        return {\n            summarySubmitted: this.summarySubmitted.promise,\n            summaryOpBroadcasted: this.summaryOpBroadcasted.promise,\n            receivedSummaryAckOrNack: this.receivedSummaryAckOrNack.promise,\n        } as const;\n    }\n}\n\n/**\n * This class generates and tracks a summary attempt.\n */\nexport class SummaryGenerator {\n    private readonly summarizeTimer: Timer;\n    constructor(\n        private readonly pendingAckTimer: IPromiseTimer,\n        private readonly heuristicData: ISummarizeHeuristicData,\n        private readonly submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,\n        private readonly raiseSummarizingError: (errorMessage: string) => void,\n        private readonly successfulSummaryCallback: () => void,\n        private readonly summaryWatcher: Pick<IClientSummaryWatcher, \"watchSummary\">,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.summarizeTimer = new Timer(\n            maxSummarizeTimeoutTime,\n            () => this.summarizeTimerHandler(maxSummarizeTimeoutTime, 1),\n        );\n    }\n\n    /**\n     * Generates summary and listens for broadcast and ack/nack.\n     * Returns true for ack, false for nack, and undefined for failure or timeout.\n     * @param reason - reason for summarizing\n     * @param options - refreshLatestAck to fetch summary ack info from server,\n     * fullTree to generate tree without any summary handles even if unchanged\n     */\n    public summarize(\n        summarizeProps: ISummarizeTelemetryProperties,\n        options: ISummarizeOptions,\n        cancellationToken: ISummaryCancellationToken,\n        resultsBuilder = new SummarizeResultBuilder(),\n    ): ISummarizeResults {\n        this.summarizeCore(summarizeProps, options, resultsBuilder, cancellationToken)\n        .catch((error) => {\n            const message = \"UnexpectedSummarizeError\";\n            this.logger.sendErrorEvent({ eventName: message, ...summarizeProps }, error);\n            resultsBuilder.fail(message, error);\n        });\n\n        return resultsBuilder.build();\n    }\n\n    private async summarizeCore(\n        summarizeProps: ISummarizeTelemetryProperties,\n        options: ISummarizeOptions,\n        resultsBuilder: SummarizeResultBuilder,\n        cancellationToken: ISummaryCancellationToken,\n    ): Promise<void> {\n        const { refreshLatestAck, fullTree } = options;\n        const logger = ChildLogger.create(this.logger, undefined, { all: summarizeProps });\n\n        // Note: timeSinceLastAttempt and timeSinceLastSummary for the\n        // first summary are basically the time since the summarizer was loaded.\n        const timeSinceLastAttempt = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n        const timeSinceLastSummary = Date.now() - this.heuristicData.lastSuccessfulSummary.summaryTime;\n        let summarizeTelemetryProps: SummaryGeneratorTelemetry = {\n            fullTree,\n            timeSinceLastAttempt,\n            timeSinceLastSummary,\n        };\n\n        const summarizeEvent = PerformanceEvent.start(logger, {\n            eventName: \"Summarize\",\n            refreshLatestAck,\n            ...summarizeTelemetryProps,\n        });\n\n        // Helper functions to report failures and return.\n        const getFailMessage =\n            (errorCode: keyof typeof summarizeErrors) => `${errorCode}: ${summarizeErrors[errorCode]}`;\n        const fail = (\n            errorCode: keyof typeof summarizeErrors,\n            error?: any,\n            properties?: SummaryGeneratorTelemetry,\n            nackSummaryResult?: INackSummaryResult,\n        ) => {\n            this.raiseSummarizingError(summarizeErrors[errorCode]);\n            // UploadSummary may fail with 429 and retryAfter - respect that\n            // Summary Nack also can have retryAfter, it's parsed below and comes as a property.\n            const retryAfterSeconds = getRetryDelaySecondsFromError(error);\n\n            // Report any failure as an error unless it was due to cancellation (like \"disconnected\" error)\n            // If failure happened on upload, we may not yet realized that socket disconnected, so check\n            // offlineError too.\n            const category = cancellationToken.cancelled || error?.errorType === DriverErrorType.offlineError ?\n                \"generic\" : \"error\";\n\n            summarizeEvent.cancel({\n                 ...properties,\n                 reason: errorCode,\n                 category,\n                 retryAfterSeconds,\n            }, error);\n            resultsBuilder.fail(getFailMessage(errorCode), error, nackSummaryResult, retryAfterSeconds);\n        };\n\n        // Wait to generate and send summary\n        this.summarizeTimer.start();\n\n        // Use record type to prevent unexpected value types\n        let summaryData: SubmitSummaryResult | undefined;\n        try {\n            summaryData = await this.submitSummaryCallback({\n                fullTree,\n                refreshLatestAck,\n                summaryLogger: logger,\n                cancellationToken,\n            });\n\n            // Cumulatively add telemetry properties based on how far generateSummary went.\n            const referenceSequenceNumber = summaryData.referenceSequenceNumber;\n            const opsSinceLastSummary =\n                referenceSequenceNumber - this.heuristicData.lastSuccessfulSummary.refSequenceNumber;\n            summarizeTelemetryProps = {\n                ...summarizeTelemetryProps,\n                referenceSequenceNumber,\n                minimumSequenceNumber: summaryData.minimumSequenceNumber,\n                opsSinceLastAttempt: referenceSequenceNumber - this.heuristicData.lastAttempt.refSequenceNumber,\n                opsSinceLastSummary,\n            };\n            if (summaryData.stage !== \"base\") {\n                summarizeTelemetryProps = {\n                    ...summarizeTelemetryProps,\n                    ...summaryData.summaryStats,\n                    generateDuration: summaryData.generateDuration,\n                };\n\n                if (summaryData.stage !== \"generate\") {\n                    summarizeTelemetryProps = {\n                        ...summarizeTelemetryProps,\n                        handle: summaryData.handle,\n                        uploadDuration: summaryData.uploadDuration,\n                    };\n\n                    if (summaryData.stage !== \"upload\") {\n                        summarizeTelemetryProps = {\n                            ...summarizeTelemetryProps,\n                            clientSequenceNumber: summaryData.clientSequenceNumber,\n                        };\n                    }\n                }\n            }\n\n            if (summaryData.stage !== \"submit\") {\n                return fail(\"submitSummaryFailure\", summaryData.error, summarizeTelemetryProps);\n            }\n\n            /**\n             * With incremental summaries, if the full tree was not summarized, only data stores that changed should\n             * be summarized. A data store is considered changed if either or both of the following is true:\n             * - It has received an op.\n             * - Its reference state changed, i.e., it went from referenced to unreferenced or vice-versa.\n             *\n             * In the extreme case, every op can be for a different data store and each op can result in the reference\n             * state change of multiple data stores. So, the total number of data stores that are summarized should not\n             * exceed the number of ops since last summary + number of data store whose reference state changed.\n             */\n            if (!fullTree && !summaryData.forcedFullTree) {\n                const { summarizedDataStoreCount, gcStateUpdatedDataStoreCount = 0 } = summaryData.summaryStats;\n                if (summarizedDataStoreCount > gcStateUpdatedDataStoreCount + opsSinceLastSummary) {\n                    logger.sendErrorEvent({\n                        eventName: \"IncrementalSummaryViolation\",\n                        summarizedDataStoreCount,\n                        gcStateUpdatedDataStoreCount,\n                        opsSinceLastSummary,\n                    });\n                }\n            }\n\n            // Log event here on summary success only, as Summarize_cancel duplicates failure logging.\n            summarizeEvent.reportEvent(\"generate\", { ...summarizeTelemetryProps });\n            resultsBuilder.summarySubmitted.resolve({ success: true, data: summaryData });\n        } catch (error) {\n            return fail(\"submitSummaryFailure\", error);\n        } finally {\n            this.heuristicData.recordAttempt(summaryData?.referenceSequenceNumber);\n            this.summarizeTimer.clear();\n        }\n\n        try {\n            const pendingTimeoutP = this.pendingAckTimer.start();\n            const summary = this.summaryWatcher.watchSummary(summaryData.clientSequenceNumber);\n\n            // Wait for broadcast\n            const waitBroadcastResult = await raceTimer(summary.waitBroadcast(), pendingTimeoutP, cancellationToken);\n            if (waitBroadcastResult.result === \"cancelled\") {\n                return fail(\"disconnect\");\n            }\n            if (waitBroadcastResult.result !== \"done\") {\n                return fail(\"summaryOpWaitTimeout\");\n            }\n            const summarizeOp = waitBroadcastResult.value;\n\n            const broadcastDuration = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n            resultsBuilder.summaryOpBroadcasted.resolve({\n                success: true,\n                data: { summarizeOp, broadcastDuration },\n            });\n\n            this.heuristicData.lastAttempt.summarySequenceNumber = summarizeOp.sequenceNumber;\n            logger.sendTelemetryEvent({\n                eventName: \"Summarize_Op\",\n                duration: broadcastDuration,\n                referenceSequenceNumber: summarizeOp.referenceSequenceNumber,\n                summarySequenceNumber: summarizeOp.sequenceNumber,\n                handle: summarizeOp.contents.handle,\n            });\n\n            // Wait for ack/nack\n            const waitAckNackResult = await raceTimer(summary.waitAckNack(), pendingTimeoutP, cancellationToken);\n            if (waitAckNackResult.result === \"cancelled\") {\n                return fail(\"disconnect\");\n            }\n            if (waitAckNackResult.result !== \"done\") {\n                return fail(\"summaryAckWaitTimeout\");\n            }\n            const ackNackOp = waitAckNackResult.value;\n            this.pendingAckTimer.clear();\n\n            // Update for success/failure\n            const ackNackDuration = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n\n            // adding new properties\n            summarizeTelemetryProps = {\n                ackWaitDuration: ackNackDuration,\n                ackNackSequenceNumber: ackNackOp.sequenceNumber,\n                summarySequenceNumber: ackNackOp.contents.summaryProposal.summarySequenceNumber,\n                ...summarizeTelemetryProps,\n            };\n            if (ackNackOp.type === MessageType.SummaryAck) {\n                this.heuristicData.markLastAttemptAsSuccessful();\n                this.successfulSummaryCallback();\n                summarizeEvent.end({\n                    ...summarizeTelemetryProps,\n                    handle: ackNackOp.contents.handle,\n                });\n                resultsBuilder.receivedSummaryAckOrNack.resolve({ success: true, data: {\n                    summaryAckOp: ackNackOp,\n                    ackNackDuration,\n                } });\n            } else {\n                // Check for retryDelay in summaryNack response.\n                assert(ackNackOp.type === MessageType.SummaryNack, 0x274 /* \"type check\" */);\n                const summaryNack = ackNackOp.contents;\n                const message = summaryNack?.message;\n                const retryAfterSeconds = summaryNack?.retryAfter;\n\n                // pre-0.58 error message prefix: summaryNack\n                const error = new LoggingError(`Received summaryNack: ${message}`, { retryAfterSeconds });\n                logger.sendErrorEvent(\n                    { eventName: \"SummaryNack\", ...summarizeTelemetryProps, retryAfterSeconds }, error);\n\n                assert(getRetryDelaySecondsFromError(error) === retryAfterSeconds, 0x25f /* \"retryAfterSeconds\" */);\n                // This will only set resultsBuilder.receivedSummaryAckOrNack, as other promises are already set.\n                return fail(\n                    \"summaryNack\",\n                    error,\n                    { ...summarizeTelemetryProps, nackRetryAfter: retryAfterSeconds },\n                    { summaryNackOp: ackNackOp, ackNackDuration },\n                );\n            }\n        } finally {\n            this.pendingAckTimer.clear();\n        }\n    }\n\n    private summarizeTimerHandler(time: number, count: number) {\n        this.logger.sendPerformanceEvent({\n            eventName: \"SummarizeTimeout\",\n            timeoutTime: time,\n            timeoutCount: count,\n        });\n        if (count < maxSummarizeTimeoutCount) {\n            // Double and start a new timer\n            const nextTime = time * 2;\n            this.summarizeTimer.start(nextTime, () => this.summarizeTimerHandler(nextTime, count + 1));\n        }\n    }\n\n    public dispose() {\n        this.summarizeTimer.clear();\n    }\n}\n"]}

package/dist/summaryManager.js

@@ -124,16 +124,16 @@ class SummaryManager {
             return { shouldSummarize: false, stopReason: "parentShouldNotSummarize" };
         }
         else if (this.disposed) {
-            common_utils_1.assert(false, 0x260 /* "Disposed should mean disconnected!" */);
+            (0, common_utils_1.assert)(false, 0x260 /* "Disposed should mean disconnected!" */);
         }
         else {
             return { shouldSummarize: true };
         }
     }
     startSummarization() {
-        common_utils_1.assert(this.state === SummaryManagerState.Off, 0x261 /* "Expected: off" */);
+        (0, common_utils_1.assert)(this.state === SummaryManagerState.Off, 0x261 /* "Expected: off" */);
         this.state = SummaryManagerState.Starting;
-        common_utils_1.assert(this.summarizer === undefined, 0x262 /* "Old summarizer is still working!" */);
+        (0, common_utils_1.assert)(this.summarizer === undefined, 0x262 /* "Old summarizer is still working!" */);
         this.delayBeforeCreatingSummarizer().then(async (startWithInitialDelay) => {
             // Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore
             // but only if creation was delayed. If it was not, then we want to ensure we always create
@@ -147,7 +147,7 @@ class SummaryManager {
             // when the electedClient will be replaced with the new summarizer client.
             // The alternative would be to let connectedState.clientId !== clientElection.electedClientId when
             // state === Starting || state === Running.
-            common_utils_1.assert(this.state === SummaryManagerState.Starting, 0x263 /* "Expected: starting" */);
+            (0, common_utils_1.assert)(this.state === SummaryManagerState.Starting, 0x263 /* "Expected: starting" */);
             this.state = SummaryManagerState.Running;
             const summarizer = await this.requestSummarizerFn();
             this.summarizer = summarizer;
@@ -191,7 +191,7 @@ class SummaryManager {
             }
         }).finally(() => {
             var _a;
-            common_utils_1.assert(this.state !== SummaryManagerState.Off, 0x264 /* "Expected: Not Off" */);
+            (0, common_utils_1.assert)(this.state !== SummaryManagerState.Off, 0x264 /* "Expected: Not Off" */);
             this.state = SummaryManagerState.Off;
             (_a = this.summarizer) === null || _a === void 0 ? void 0 : _a.close();
             this.summarizer = undefined;

package/dist/summaryManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"summaryManager.js","sourceRoot":"","sources":["../src/summaryManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAsD;AACtD,qEAAgF;AAChF,2EAAqE;AAUrE,MAAM,qBAAqB,GAAG,IAAI,CAAC;AACnC,MAAM,8BAA8B,GAAG,IAAI,CAAC;AAE5C,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC3B,2DAAO,CAAA;IACP,qEAAY,CAAA;IACZ,mEAAW,CAAA;IACX,qEAAY,CAAA;AAChB,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B;AAuCD;;;;GAIG;AACH,MAAa,cAAc;IAevB,YACqB,cAAyC,EACzC,cAA+B,EAC/B,iBACoE,EACrF,YAA8B;IAC9B;2CACuC;IACtB,mBAA+C,EAC/C,cAA0B,EAC3C,EACI,cAAc,GAAG,qBAAqB,EACtC,uBAAuB,GAAG,8BAA8B,MACd,EAAE,EAC/B,iBAAyD;QAbzD,mBAAc,GAAd,cAAc,CAA2B;QACzC,mBAAc,GAAd,cAAc,CAAiB;QAC/B,sBAAiB,GAAjB,iBAAiB,CACmD;QAIpE,wBAAmB,GAAnB,mBAAmB,CAA4B;QAC/C,mBAAc,GAAd,cAAc,CAAY;QAK1B,sBAAiB,GAAjB,iBAAiB,CAAwC;QAxBtE,UAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC;QAEhC,cAAS,GAAG,KAAK,CAAC;QA8CT,oBAAe,GAAG,CAAC,QAAgB,EAAE,EAAE;YACpD,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC;YAC/B,wFAAwF;YACxF,4FAA4F;YAC5F,mBAAmB;YACnB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC;QAEe,uBAAkB,GAAG,GAAG,EAAE;YACvC,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC;QAuBe,sBAAiB,GAAG,GAAG,EAAE;YACtC,iFAAiF;YACjF,+EAA+E;YAC/E,MAAM,oBAAoB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC5D,QAAQ,IAAI,CAAC,KAAK,EAAE;gBAChB,KAAK,mBAAmB,CAAC,GAAG,CAAC,CAAC;oBAC1B,IAAI,oBAAoB,CAAC,eAAe,EAAE;wBACtC,IAAI,CAAC,kBAAkB,EAAE,CAAC;qBAC7B;oBACD,OAAO;iBACV;gBACD,KAAK,mBAAmB,CAAC,QAAQ,CAAC,CAAC;oBAC/B,qDAAqD;oBACrD,6CAA6C;oBAC7C,OAAO;iBACV;gBACD,KAAK,mBAAmB,CAAC,OAAO,CAAC,CAAC;oBAC9B,IAAI,oBAAoB,CAAC,eAAe,KAAK,KAAK,EAAE;wBAChD,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;qBAC9C;oBACD,OAAO;iBACV;gBACD,KAAK,mBAAmB,CAAC,QAAQ,CAAC,CAAC;oBAC/B,2DAA2D;oBAC3D,6CAA6C;oBAC7C,OAAO;iBACV;gBACD,OAAO,CAAC,CAAC;oBACL,OAAO;iBACV;aACJ;QACL,CAAC,CAAC;QA+Jc,sBAAiB,GAAqC,CAAC,GAAG,IAAI,EAAE,EAAE;YAC9E,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,MAAM,KAAK,CAAC,8BAA8B,CAAC,CAAC;gBAC5C,qDAAqD;aACxD;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC;QAEc,qBAAgB,GAAoC,CAAC,GAAG,IAAI,EAAE,EAAE;YAC5E,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,MAAM,KAAK,CAAC,8BAA8B,CAAC,CAAC;gBAC5C,qDAAqD;aACxD;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC;QAnQE,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAC5B,YAAY,EACZ,gBAAgB,EAChB,EAAC,GAAG,EAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAAC,CAAC,CAAC;QAEnD,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC1D,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAChE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;QAEnD,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC;IAjCD,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IA+BhD;;;OAGG;IACI,KAAK;QACR,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,0BAA0B,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC3E,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IAiBO,uBAAuB;QAC3B,qGAAqG;QACrG,wGAAwG;QACxG,gGAAgG;QAChG,iFAAiF;QACjF,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE;YAChC,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAE,CAAC;SACvE;aAAM,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,KAAK,IAAI,CAAC,cAAc,CAAC,eAAe;YAC3E,CAAC,IAAI,CAAC,KAAK,KAAK,mBAAmB,CAAC,OAAO;gBACvC,IAAI,CAAC,cAAc,CAAC,QAAQ,KAAK,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;YAC3E,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,0BAA0B,EAAE,CAAC;SAC7E;aAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;YACtB,qBAAM,CAAC,KAAK,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;SACnE;aAAM;YACH,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;SACpC;IACL,CAAC;IAmCO,kBAAkB;QACtB,qBAAM,CAAC,IAAI,CAAC,KAAK,KAAK,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC5E,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,QAAQ,CAAC;QAE1C,qBAAM,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAEtF,IAAI,CAAC,6BAA6B,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,qBAA8B,EAAE,EAAE;YAC/E,4FAA4F;YAC5F,2FAA2F;YAC3F,gGAAgG;YAChG,8FAA8F;YAC9F,wDAAwD;YACxD,IAAI,qBAAqB,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC,eAAe,KAAK,KAAK,EAAE;gBACnF,OAAO,YAAY,CAAC;aACvB;YAED,uGAAuG;YACvG,0EAA0E;YAC1E,kGAAkG;YAClG,2CAA2C;YAC3C,qBAAM,CAAC,IAAI,CAAC,KAAK,KAAK,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;YACtF,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC;YAEzC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAE7B,4FAA4F;YAC5F,MAAM,oBAAoB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC5D,IAAI,oBAAoB,CAAC,eAAe,KAAK,KAAK,EAAE;gBAChD,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,QAAQ,CAAC;gBAC1C,UAAU,CAAC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;gBACjD,OAAO,sCAAsC,CAAC;aACjD;YAED,oEAAoE;YACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAe,CAAC;YAEtC,OAAO,kCAAgB,CAAC,cAAc,CAClC,IAAI,CAAC,MAAM,EACX,EAAE,SAAS,EAAE,mBAAmB,EAAE,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,EAC5E,KAAK,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAC/D,CAAC;QACN,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAc,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBAC3B,SAAS,EAAE,kBAAkB;gBAC7B,MAAM;aACT,CAAC,CAAC;QACP,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;gBACI,SAAS,EAAE,kBAAkB;gBAC7B,MAAM,EAAE,WAAW;aACtB,EACD,KAAK,CAAC,CAAC;YAEX,mFAAmF;YACnF,sDAAsD;YACtD,0FAA0F;YAC1F,kFAAkF;YAClF,gFAAgF;YAChF,0FAA0F;YAC1F,4GAA4G;YAC5G,wEAAwE;YACxE,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC,eAAe,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBACjF,+FAA+F;gBAC/F,oGAAoG;gBACpG,gBAAgB;gBAChB,MAAM,QAAQ,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAK,oCAAe,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;gBACzF,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;oBACI,SAAS,EAAE,qBAAqB;oBAChC,QAAQ;iBACX,EACD,KAAK,CAAC,CAAC;aACd;QACL,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;;YACZ,qBAAM,CAAC,IAAI,CAAC,KAAK,KAAK,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAChF,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC;YAErC,MAAA,IAAI,CAAC,UAAU,0CAAE,KAAK,GAAG;YACzB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAE5B,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC,eAAe,EAAE;gBAChD,IAAI,CAAC,kBAAkB,EAAE,CAAC;aAC7B;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,IAAI,CAAC,MAA4B;;QACrC,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACjD,OAAO;SACV;QACD,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,QAAQ,CAAC;QAE1C,iEAAiE;QACjE,+CAA+C;QAC/C,MAAA,IAAI,CAAC,UAAU,0CAAE,IAAI,CAAC,MAAM,EAAE;IAClC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,6BAA6B;QACvC,2GAA2G;QAC3G,IAAI,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;QAE7C,yGAAyG;QACzG,gDAAgD;QAChD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,oBAAoB;YAC/B,cAAc,EAAE,OAAO;YACvB,YAAY,EAAE,IAAI,CAAC,cAAc;YACjC,wBAAwB,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU;YACxD,eAAe,EAAE,IAAI,CAAC,iBAAiB,CAAC,eAAe;YACvD,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;SACxD,CAAC,CAAC;QAEH,uFAAuF;QACvF,uGAAuG;QACvG,mGAAmG;QACnG,oEAAoE;QACpE,gGAAgG;QAChG,sGAAsG;QACtG,2DAA2D;QAC3D,gGAAgG;QAChG,0BAA0B;QAC1B,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAClC,IAAI,IAAI,CAAC,iBAAiB,CAAC,eAAe,GAAG,IAAI,CAAC,uBAAuB,EAAE;YACvE,qBAAqB,GAAG,IAAI,CAAC;YAC7B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACpD;QAED,IAAI,OAAO,GAAG,CAAC,EAAE;YACb,IAAI,KAAK,CAAC;YACV,IAAI,kBAAkB,CAAC;YACvB,6FAA6F;YAC7F,MAAM,aAAa,GAAG,GAAG,EAAE;gBACvB,IAAI,IAAI,CAAC,iBAAiB,CAAC,eAAe,IAAI,IAAI,CAAC,uBAAuB,EAAE;oBACxE,YAAY,CAAC,KAAK,CAAC,CAAC;oBACpB,kBAAkB,EAAE,CAAC;iBACxB;YACL,CAAC,CAAC;YACF,6DAA6D;YAC7D,MAAM,YAAY,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAC/C,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YACH,4EAA4E;YAC5E,MAAM,SAAS,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,GAAG,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YACpF,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YACpD,MAAM,OAAO,CAAC,IAAI,CAAC,CAAE,YAAY,EAAE,SAAS,CAAE,CAAC,CAAC;YAChD,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;SAC1D;QACD,OAAO,qBAAqB,CAAC;IACjC,CAAC;IAkBM,OAAO;QACV,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC5E,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;;AAzSL,wCA0SC;AAzO2B,kCAAmB,GAAG,CAAC,KAA0B,EAAE,EAAE,CACzE,KAAK,KAAK,mBAAmB,CAAC,QAAQ,IAAI,KAAK,KAAK,mBAAmB,CAAC,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport { ChildLogger, PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { ISummarizerClientElection } from \"./summarizerClientElection\";\nimport { IThrottler } from \"./throttler\";\nimport {\n    ISummarizer,\n    ISummarizerOptions,\n    SummarizerStopReason,\n} from \"./summarizerTypes\";\nimport { SummaryCollection } from \"./summaryCollection\";\n\nconst defaultInitialDelayMs = 5000;\nconst defaultOpsToBypassInitialDelay = 4000;\n\nexport enum SummaryManagerState {\n    Off = 0,\n    Starting = 1,\n    Running = 2,\n    Stopping = 3,\n}\n\n// Please note that all reasons in this list are not errors,\n// and thus they are not raised today to parent container as error.\n// If this needs to be changed in future, we should re-evaluate what and how we raise to summarizer\ntype StopReason = Extract<SummarizerStopReason, \"parentNotConnected\" | \"parentShouldNotSummarize\">;\ntype ShouldSummarizeState =\n    | { shouldSummarize: true; }\n    | { shouldSummarize: false; stopReason: StopReason; };\n\nexport interface IConnectedEvents extends IEvent {\n    (event: \"connected\", listener: (clientId: string) => void);\n    (event: \"disconnected\", listener: () => void);\n}\n\n/**\n * IConnectedState describes an object that SummaryManager can watch to observe connection/disconnection.\n *\n * Under current implementation, its role will be fulfilled by the ContainerRuntime, but this could be replaced\n * with anything else that fulfills the contract if we want to shift the layer that the SummaryManager lives at.\n */\nexport interface IConnectedState extends IEventProvider<IConnectedEvents> {\n    readonly connected: boolean;\n\n    /**\n     * Under current implementation this is undefined if we've never connected, otherwise it's the clientId from our\n     * latest connection (even if we've since disconnected!).  Although this happens to be the behavior we want in\n     * SummaryManager, I suspect that globally we may eventually want to modify this behavior (e.g. make clientId\n     * undefined while disconnected).  To protect against this, let's assume this field can't be trusted while\n     * disconnected and instead separately track \"latest clientId\" in SummaryManager.\n     */\n    readonly clientId: string | undefined;\n}\n\nexport interface ISummaryManagerConfig {\n    initialDelayMs: number;\n    opsToBypassInitialDelay: number;\n}\n\n/**\n * SummaryManager is created by parent container (i.e. interactive container with clientType !== \"summarizer\") only.\n * It observes changes in calculated summarizer and reacts to changes by either creating summarizer client or\n * stopping existing summarizer client.\n */\nexport class SummaryManager implements IDisposable {\n    private readonly logger: ITelemetryLogger;\n    private readonly opsToBypassInitialDelay: number;\n    private readonly initialDelayMs: number;\n    private latestClientId: string | undefined;\n    private state = SummaryManagerState.Off;\n    private summarizer?: ISummarizer;\n    private _disposed = false;\n\n    public get disposed() {\n        return this._disposed;\n    }\n\n    public get currentState() { return this.state; }\n\n    constructor(\n        private readonly clientElection: ISummarizerClientElection,\n        private readonly connectedState: IConnectedState,\n        private readonly summaryCollection:\n            Pick<SummaryCollection, \"opsSinceLastAck\" | \"addOpListener\" | \"removeOpListener\">,\n        parentLogger: ITelemetryLogger,\n        /** Creates summarizer by asking interactive container to spawn summarizing container and\n         * get back its Summarizer instance. */\n        private readonly requestSummarizerFn: () => Promise<ISummarizer>,\n        private readonly startThrottler: IThrottler,\n        {\n            initialDelayMs = defaultInitialDelayMs,\n            opsToBypassInitialDelay = defaultOpsToBypassInitialDelay,\n        }: Readonly<Partial<ISummaryManagerConfig>> = {},\n        private readonly summarizerOptions?: Readonly<Partial<ISummarizerOptions>>,\n    ) {\n        this.logger = ChildLogger.create(\n            parentLogger,\n            \"SummaryManager\",\n            {all:{ clientId: () => this.latestClientId }});\n\n        this.connectedState.on(\"connected\", this.handleConnected);\n        this.connectedState.on(\"disconnected\", this.handleDisconnected);\n        this.latestClientId = this.connectedState.clientId;\n\n        this.opsToBypassInitialDelay = opsToBypassInitialDelay;\n        this.initialDelayMs = initialDelayMs;\n    }\n\n    /**\n     * Until start is called, the SummaryManager won't begin attempting to start summarization.  This ensures there's\n     * a window between construction and starting where the caller can attach listeners.\n     */\n    public start(): void {\n        this.clientElection.on(\"electedSummarizerChanged\", this.refreshSummarizer);\n        this.refreshSummarizer();\n    }\n\n    private readonly handleConnected = (clientId: string) => {\n        this.latestClientId = clientId;\n        // If we have a summarizer, it should have been either cancelled on disconnected by now.\n        // But because of lastSummary process, it can still hang around, so there is not much we can\n        // check or assert.\n        this.refreshSummarizer();\n    };\n\n    private readonly handleDisconnected = () => {\n        this.refreshSummarizer();\n    };\n\n    private static readonly isStartingOrRunning = (state: SummaryManagerState) =>\n        state === SummaryManagerState.Starting || state === SummaryManagerState.Running;\n\n    private getShouldSummarizeState(): ShouldSummarizeState {\n        // Note that if we're in the Running state, the electedClient may be a summarizer client, so we can't\n        // enforce connectedState.clientId === clientElection.electedClientId. But once we're Running, we should\n        // only transition to Stopping when the electedParentId changes. Stopping the summarizer without\n        // changing the electedParent will just cause us to transition to Starting again.\n        if (!this.connectedState.connected) {\n            return { shouldSummarize: false, stopReason: \"parentNotConnected\" };\n        } else if (this.connectedState.clientId !== this.clientElection.electedParentId ||\n            (this.state !== SummaryManagerState.Running &&\n                this.connectedState.clientId !== this.clientElection.electedClientId)) {\n            return { shouldSummarize: false, stopReason: \"parentShouldNotSummarize\" };\n        } else if (this.disposed) {\n            assert(false, 0x260 /* \"Disposed should mean disconnected!\" */);\n        } else {\n            return { shouldSummarize: true };\n        }\n    }\n\n    private readonly refreshSummarizer = () => {\n        // Transition states depending on shouldSummarize, which is a calculated property\n        // that is only true if this client is connected and is the elected summarizer.\n        const shouldSummarizeState = this.getShouldSummarizeState();\n        switch (this.state) {\n            case SummaryManagerState.Off: {\n                if (shouldSummarizeState.shouldSummarize) {\n                    this.startSummarization();\n                }\n                return;\n            }\n            case SummaryManagerState.Starting: {\n                // Cannot take any action until summarizer is created\n                // state transition will occur after creation\n                return;\n            }\n            case SummaryManagerState.Running: {\n                if (shouldSummarizeState.shouldSummarize === false) {\n                    this.stop(shouldSummarizeState.stopReason);\n                }\n                return;\n            }\n            case SummaryManagerState.Stopping: {\n                // Cannot take any action until running summarizer finishes\n                // state transition will occur after it stops\n                return;\n            }\n            default: {\n                return;\n            }\n        }\n    };\n\n    private startSummarization() {\n        assert(this.state === SummaryManagerState.Off, 0x261 /* \"Expected: off\" */);\n        this.state = SummaryManagerState.Starting;\n\n        assert(this.summarizer === undefined, 0x262 /* \"Old summarizer is still working!\" */);\n\n        this.delayBeforeCreatingSummarizer().then(async (startWithInitialDelay: boolean) => {\n            // Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore\n            // but only if creation was delayed. If it was not, then we want to ensure we always create\n            // a summarizer to kick off lastSummary. Without that, we would not be able to summarize and get\n            // document out of broken state if it has too many ops and ordering service keeps nacking main\n            // container (and thus it goes into cycle of reconnects)\n            if (startWithInitialDelay && this.getShouldSummarizeState().shouldSummarize === false) {\n                return \"early exit\";\n            }\n\n            // We transition to Running before requesting the summarizer, because after requesting we can't predict\n            // when the electedClient will be replaced with the new summarizer client.\n            // The alternative would be to let connectedState.clientId !== clientElection.electedClientId when\n            // state === Starting || state === Running.\n            assert(this.state === SummaryManagerState.Starting, 0x263 /* \"Expected: starting\" */);\n            this.state = SummaryManagerState.Running;\n\n            const summarizer = await this.requestSummarizerFn();\n            this.summarizer = summarizer;\n\n            // Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore\n            const shouldSummarizeState = this.getShouldSummarizeState();\n            if (shouldSummarizeState.shouldSummarize === false) {\n                this.state = SummaryManagerState.Starting;\n                summarizer.stop(shouldSummarizeState.stopReason);\n                return \"early exit after starting summarizer\";\n            }\n\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            const clientId = this.latestClientId!;\n\n            return PerformanceEvent.timedExecAsync(\n                this.logger,\n                { eventName: \"RunningSummarizer\", attempt: this.startThrottler.numAttempts },\n                async () => summarizer.run(clientId, this.summarizerOptions),\n            );\n        }).then((reason: string) => {\n            this.logger.sendTelemetryEvent({\n                eventName: \"EndingSummarizer\",\n                reason,\n            });\n        }).catch((error) => {\n            this.logger.sendTelemetryEvent(\n                {\n                    eventName: \"EndingSummarizer\",\n                    reason: \"exception\",\n                },\n                error);\n\n            // Most of exceptions happen due to container being closed while loading it, due to\n            // summarizer container loosing connection while load.\n            // Not worth reporting such errors as errors. That said, we might miss some real errors if\n            // we ignore blindly, so try to narrow signature we are looking for - skip logging\n            // error only if this client should no longer be a summarizer (which in practice\n            // means it also lost connection), and error happened on load (we do not have summarizer).\n            // We could annotate the error raised in Container.load where the container closed during load with no error\n            // and check for that case here, but that does not seem to be necessary.\n            if (this.getShouldSummarizeState().shouldSummarize || this.summarizer !== undefined) {\n                // Report any failure as an error unless it was due to cancellation (like \"disconnected\" error)\n                // If failure happened on container load, we may not yet realized that socket disconnected, so check\n                // offlineError.\n                const category = error?.errorType === DriverErrorType.offlineError ? \"generic\" : \"error\";\n                this.logger.sendTelemetryEvent(\n                    {\n                        eventName: \"SummarizerException\",\n                        category,\n                    },\n                    error);\n            }\n        }).finally(() => {\n            assert(this.state !== SummaryManagerState.Off, 0x264 /* \"Expected: Not Off\" */);\n            this.state = SummaryManagerState.Off;\n\n            this.summarizer?.close();\n            this.summarizer = undefined;\n\n            if (this.getShouldSummarizeState().shouldSummarize) {\n                this.startSummarization();\n            }\n        });\n    }\n\n    private stop(reason: SummarizerStopReason) {\n        if (!SummaryManager.isStartingOrRunning(this.state)) {\n            return;\n        }\n        this.state = SummaryManagerState.Stopping;\n\n        // Stopping the running summarizer client should trigger a change\n        // in states when the running summarizer closes\n        this.summarizer?.stop(reason);\n    }\n\n    /**\n     * Implements initial delay before creating summarizer\n     * @returns true, if creation is delayed due to heuristics (not many ops to summarize).\n     *          False if summarizer should start immediately due to too many unsummarized ops.\n     */\n    private async delayBeforeCreatingSummarizer(): Promise<boolean> {\n        // throttle creation of new summarizer containers to prevent spamming the server with websocket connections\n        let delayMs = this.startThrottler.getDelay();\n\n        // We have been elected the summarizer. Some day we may be able to summarize with a live document but for\n        // now we play it safe and launch a second copy.\n        this.logger.sendTelemetryEvent({\n            eventName: \"CreatingSummarizer\",\n            throttlerDelay: delayMs,\n            initialDelay: this.initialDelayMs,\n            startThrottlerMaxDelayMs: this.startThrottler.maxDelayMs,\n            opsSinceLastAck: this.summaryCollection.opsSinceLastAck,\n            opsToBypassInitialDelay: this.opsToBypassInitialDelay,\n        });\n\n        // This delay helps ensure that last summarizer that might be left from previous client\n        // has enough time to complete its last summary and thus new summarizer not conflict with previous one.\n        // If, however, there are too many unsummarized ops, try to resolve it as quickly as possible, with\n        // understanding that we may see nacks because of such quick action.\n        // A better design would be for summarizer election logic to always select current summarizer as\n        // summarizing client (i.e. clientType === \"summarizer\" can be elected) to ensure that nobody else can\n        // summarizer while it finishes its work and moves to exit.\n        // It also helps with pure boot scenario (single client) to offset expensive work a bit out from\n        // critical boot sequence.\n        let startWithInitialDelay = false;\n        if (this.summaryCollection.opsSinceLastAck < this.opsToBypassInitialDelay) {\n            startWithInitialDelay = true;\n            delayMs = Math.max(delayMs, this.initialDelayMs);\n        }\n\n        if (delayMs > 0) {\n            let timer;\n            let resolveOpPromiseFn;\n            // Create a listener that will break the delay if we've exceeded the initial delay ops count.\n            const opsListenerFn = () => {\n                if (this.summaryCollection.opsSinceLastAck >= this.opsToBypassInitialDelay) {\n                    clearTimeout(timer);\n                    resolveOpPromiseFn();\n                }\n            };\n            // Create a Promise that will resolve when the delay expires.\n            const delayPromise = new Promise<void>((resolve) => {\n                timer = setTimeout(() => resolve(), delayMs);\n            });\n            // Create a Promise that will resolve if the ops count passes the threshold.\n            const opPromise = new Promise<void>((resolve) => { resolveOpPromiseFn = resolve; });\n            this.summaryCollection.addOpListener(opsListenerFn);\n            await Promise.race([ delayPromise, opPromise ]);\n            this.summaryCollection.removeOpListener(opsListenerFn);\n        }\n        return startWithInitialDelay;\n    }\n\n    public readonly summarizeOnDemand: ISummarizer[\"summarizeOnDemand\"] = (...args) => {\n        if (this.summarizer === undefined) {\n            throw Error(\"No running summarizer client\");\n            // TODO: could spawn a summarizer client temporarily.\n        }\n        return this.summarizer.summarizeOnDemand(...args);\n    };\n\n    public readonly enqueueSummarize: ISummarizer[\"enqueueSummarize\"] = (...args) => {\n        if (this.summarizer === undefined) {\n            throw Error(\"No running summarizer client\");\n            // TODO: could spawn a summarizer client temporarily.\n        }\n        return this.summarizer.enqueueSummarize(...args);\n    };\n\n    public dispose() {\n        this.clientElection.off(\"electedSummarizerChanged\", this.refreshSummarizer);\n        this.connectedState.off(\"connected\", this.handleConnected);\n        this.connectedState.off(\"disconnected\", this.handleDisconnected);\n        this._disposed = true;\n    }\n}\n"]}
+{"version":3,"file":"summaryManager.js","sourceRoot":"","sources":["../src/summaryManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAsD;AACtD,qEAAgF;AAChF,2EAAqE;AAUrE,MAAM,qBAAqB,GAAG,IAAI,CAAC;AACnC,MAAM,8BAA8B,GAAG,IAAI,CAAC;AAE5C,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC3B,2DAAO,CAAA;IACP,qEAAY,CAAA;IACZ,mEAAW,CAAA;IACX,qEAAY,CAAA;AAChB,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B;AAuCD;;;;GAIG;AACH,MAAa,cAAc;IAevB,YACqB,cAAyC,EACzC,cAA+B,EAC/B,iBACoE,EACrF,YAA8B;IAC9B;2CACuC;IACtB,mBAA+C,EAC/C,cAA0B,EAC3C,EACI,cAAc,GAAG,qBAAqB,EACtC,uBAAuB,GAAG,8BAA8B,MACd,EAAE,EAC/B,iBAAyD;QAbzD,mBAAc,GAAd,cAAc,CAA2B;QACzC,mBAAc,GAAd,cAAc,CAAiB;QAC/B,sBAAiB,GAAjB,iBAAiB,CACmD;QAIpE,wBAAmB,GAAnB,mBAAmB,CAA4B;QAC/C,mBAAc,GAAd,cAAc,CAAY;QAK1B,sBAAiB,GAAjB,iBAAiB,CAAwC;QAxBtE,UAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC;QAEhC,cAAS,GAAG,KAAK,CAAC;QA8CT,oBAAe,GAAG,CAAC,QAAgB,EAAE,EAAE;YACpD,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC;YAC/B,wFAAwF;YACxF,4FAA4F;YAC5F,mBAAmB;YACnB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC;QAEe,uBAAkB,GAAG,GAAG,EAAE;YACvC,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC;QAuBe,sBAAiB,GAAG,GAAG,EAAE;YACtC,iFAAiF;YACjF,+EAA+E;YAC/E,MAAM,oBAAoB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC5D,QAAQ,IAAI,CAAC,KAAK,EAAE;gBAChB,KAAK,mBAAmB,CAAC,GAAG,CAAC,CAAC;oBAC1B,IAAI,oBAAoB,CAAC,eAAe,EAAE;wBACtC,IAAI,CAAC,kBAAkB,EAAE,CAAC;qBAC7B;oBACD,OAAO;iBACV;gBACD,KAAK,mBAAmB,CAAC,QAAQ,CAAC,CAAC;oBAC/B,qDAAqD;oBACrD,6CAA6C;oBAC7C,OAAO;iBACV;gBACD,KAAK,mBAAmB,CAAC,OAAO,CAAC,CAAC;oBAC9B,IAAI,oBAAoB,CAAC,eAAe,KAAK,KAAK,EAAE;wBAChD,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;qBAC9C;oBACD,OAAO;iBACV;gBACD,KAAK,mBAAmB,CAAC,QAAQ,CAAC,CAAC;oBAC/B,2DAA2D;oBAC3D,6CAA6C;oBAC7C,OAAO;iBACV;gBACD,OAAO,CAAC,CAAC;oBACL,OAAO;iBACV;aACJ;QACL,CAAC,CAAC;QA+Jc,sBAAiB,GAAqC,CAAC,GAAG,IAAI,EAAE,EAAE;YAC9E,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,MAAM,KAAK,CAAC,8BAA8B,CAAC,CAAC;gBAC5C,qDAAqD;aACxD;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC;QAEc,qBAAgB,GAAoC,CAAC,GAAG,IAAI,EAAE,EAAE;YAC5E,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,MAAM,KAAK,CAAC,8BAA8B,CAAC,CAAC;gBAC5C,qDAAqD;aACxD;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC;QAnQE,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAC5B,YAAY,EACZ,gBAAgB,EAChB,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAEtD,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC1D,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAChE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;QAEnD,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC;IAjCD,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IA+BhD;;;OAGG;IACI,KAAK;QACR,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,0BAA0B,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC3E,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IAiBO,uBAAuB;QAC3B,qGAAqG;QACrG,wGAAwG;QACxG,gGAAgG;QAChG,iFAAiF;QACjF,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE;YAChC,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAE,CAAC;SACvE;aAAM,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,KAAK,IAAI,CAAC,cAAc,CAAC,eAAe;YAC3E,CAAC,IAAI,CAAC,KAAK,KAAK,mBAAmB,CAAC,OAAO;gBACvC,IAAI,CAAC,cAAc,CAAC,QAAQ,KAAK,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;YAC3E,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,0BAA0B,EAAE,CAAC;SAC7E;aAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;YACtB,IAAA,qBAAM,EAAC,KAAK,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;SACnE;aAAM;YACH,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;SACpC;IACL,CAAC;IAmCO,kBAAkB;QACtB,IAAA,qBAAM,EAAC,IAAI,CAAC,KAAK,KAAK,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC5E,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,QAAQ,CAAC;QAE1C,IAAA,qBAAM,EAAC,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAEtF,IAAI,CAAC,6BAA6B,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,qBAA8B,EAAE,EAAE;YAC/E,4FAA4F;YAC5F,2FAA2F;YAC3F,gGAAgG;YAChG,8FAA8F;YAC9F,wDAAwD;YACxD,IAAI,qBAAqB,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC,eAAe,KAAK,KAAK,EAAE;gBACnF,OAAO,YAAY,CAAC;aACvB;YAED,uGAAuG;YACvG,0EAA0E;YAC1E,kGAAkG;YAClG,2CAA2C;YAC3C,IAAA,qBAAM,EAAC,IAAI,CAAC,KAAK,KAAK,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;YACtF,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC;YAEzC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAE7B,4FAA4F;YAC5F,MAAM,oBAAoB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC5D,IAAI,oBAAoB,CAAC,eAAe,KAAK,KAAK,EAAE;gBAChD,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,QAAQ,CAAC;gBAC1C,UAAU,CAAC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;gBACjD,OAAO,sCAAsC,CAAC;aACjD;YAED,oEAAoE;YACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAe,CAAC;YAEtC,OAAO,kCAAgB,CAAC,cAAc,CAClC,IAAI,CAAC,MAAM,EACX,EAAE,SAAS,EAAE,mBAAmB,EAAE,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,EAC5E,KAAK,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAC/D,CAAC;QACN,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAc,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBAC3B,SAAS,EAAE,kBAAkB;gBAC7B,MAAM;aACT,CAAC,CAAC;QACP,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;gBACI,SAAS,EAAE,kBAAkB;gBAC7B,MAAM,EAAE,WAAW;aACtB,EACD,KAAK,CAAC,CAAC;YAEX,mFAAmF;YACnF,sDAAsD;YACtD,0FAA0F;YAC1F,kFAAkF;YAClF,gFAAgF;YAChF,0FAA0F;YAC1F,4GAA4G;YAC5G,wEAAwE;YACxE,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC,eAAe,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBACjF,+FAA+F;gBAC/F,oGAAoG;gBACpG,gBAAgB;gBAChB,MAAM,QAAQ,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAK,oCAAe,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;gBACzF,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;oBACI,SAAS,EAAE,qBAAqB;oBAChC,QAAQ;iBACX,EACD,KAAK,CAAC,CAAC;aACd;QACL,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;;YACZ,IAAA,qBAAM,EAAC,IAAI,CAAC,KAAK,KAAK,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAChF,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC;YAErC,MAAA,IAAI,CAAC,UAAU,0CAAE,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAE5B,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC,eAAe,EAAE;gBAChD,IAAI,CAAC,kBAAkB,EAAE,CAAC;aAC7B;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,IAAI,CAAC,MAA4B;;QACrC,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACjD,OAAO;SACV;QACD,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,QAAQ,CAAC;QAE1C,iEAAiE;QACjE,+CAA+C;QAC/C,MAAA,IAAI,CAAC,UAAU,0CAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,6BAA6B;QACvC,2GAA2G;QAC3G,IAAI,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;QAE7C,yGAAyG;QACzG,gDAAgD;QAChD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,oBAAoB;YAC/B,cAAc,EAAE,OAAO;YACvB,YAAY,EAAE,IAAI,CAAC,cAAc;YACjC,wBAAwB,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU;YACxD,eAAe,EAAE,IAAI,CAAC,iBAAiB,CAAC,eAAe;YACvD,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;SACxD,CAAC,CAAC;QAEH,uFAAuF;QACvF,uGAAuG;QACvG,mGAAmG;QACnG,oEAAoE;QACpE,gGAAgG;QAChG,sGAAsG;QACtG,2DAA2D;QAC3D,gGAAgG;QAChG,0BAA0B;QAC1B,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAClC,IAAI,IAAI,CAAC,iBAAiB,CAAC,eAAe,GAAG,IAAI,CAAC,uBAAuB,EAAE;YACvE,qBAAqB,GAAG,IAAI,CAAC;YAC7B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACpD;QAED,IAAI,OAAO,GAAG,CAAC,EAAE;YACb,IAAI,KAAK,CAAC;YACV,IAAI,kBAAkB,CAAC;YACvB,6FAA6F;YAC7F,MAAM,aAAa,GAAG,GAAG,EAAE;gBACvB,IAAI,IAAI,CAAC,iBAAiB,CAAC,eAAe,IAAI,IAAI,CAAC,uBAAuB,EAAE;oBACxE,YAAY,CAAC,KAAK,CAAC,CAAC;oBACpB,kBAAkB,EAAE,CAAC;iBACxB;YACL,CAAC,CAAC;YACF,6DAA6D;YAC7D,MAAM,YAAY,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAC/C,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YACH,4EAA4E;YAC5E,MAAM,SAAS,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,GAAG,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YACpF,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YACpD,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;SAC1D;QACD,OAAO,qBAAqB,CAAC;IACjC,CAAC;IAkBM,OAAO;QACV,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC5E,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;;AAzSL,wCA0SC;AAzO2B,kCAAmB,GAAG,CAAC,KAA0B,EAAE,EAAE,CACzE,KAAK,KAAK,mBAAmB,CAAC,QAAQ,IAAI,KAAK,KAAK,mBAAmB,CAAC,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport { ChildLogger, PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { ISummarizerClientElection } from \"./summarizerClientElection\";\nimport { IThrottler } from \"./throttler\";\nimport {\n    ISummarizer,\n    ISummarizerOptions,\n    SummarizerStopReason,\n} from \"./summarizerTypes\";\nimport { SummaryCollection } from \"./summaryCollection\";\n\nconst defaultInitialDelayMs = 5000;\nconst defaultOpsToBypassInitialDelay = 4000;\n\nexport enum SummaryManagerState {\n    Off = 0,\n    Starting = 1,\n    Running = 2,\n    Stopping = 3,\n}\n\n// Please note that all reasons in this list are not errors,\n// and thus they are not raised today to parent container as error.\n// If this needs to be changed in future, we should re-evaluate what and how we raise to summarizer\ntype StopReason = Extract<SummarizerStopReason, \"parentNotConnected\" | \"parentShouldNotSummarize\">;\ntype ShouldSummarizeState =\n    | { shouldSummarize: true; }\n    | { shouldSummarize: false; stopReason: StopReason; };\n\nexport interface IConnectedEvents extends IEvent {\n    (event: \"connected\", listener: (clientId: string) => void);\n    (event: \"disconnected\", listener: () => void);\n}\n\n/**\n * IConnectedState describes an object that SummaryManager can watch to observe connection/disconnection.\n *\n * Under current implementation, its role will be fulfilled by the ContainerRuntime, but this could be replaced\n * with anything else that fulfills the contract if we want to shift the layer that the SummaryManager lives at.\n */\nexport interface IConnectedState extends IEventProvider<IConnectedEvents> {\n    readonly connected: boolean;\n\n    /**\n     * Under current implementation this is undefined if we've never connected, otherwise it's the clientId from our\n     * latest connection (even if we've since disconnected!).  Although this happens to be the behavior we want in\n     * SummaryManager, I suspect that globally we may eventually want to modify this behavior (e.g. make clientId\n     * undefined while disconnected).  To protect against this, let's assume this field can't be trusted while\n     * disconnected and instead separately track \"latest clientId\" in SummaryManager.\n     */\n    readonly clientId: string | undefined;\n}\n\nexport interface ISummaryManagerConfig {\n    initialDelayMs: number;\n    opsToBypassInitialDelay: number;\n}\n\n/**\n * SummaryManager is created by parent container (i.e. interactive container with clientType !== \"summarizer\") only.\n * It observes changes in calculated summarizer and reacts to changes by either creating summarizer client or\n * stopping existing summarizer client.\n */\nexport class SummaryManager implements IDisposable {\n    private readonly logger: ITelemetryLogger;\n    private readonly opsToBypassInitialDelay: number;\n    private readonly initialDelayMs: number;\n    private latestClientId: string | undefined;\n    private state = SummaryManagerState.Off;\n    private summarizer?: ISummarizer;\n    private _disposed = false;\n\n    public get disposed() {\n        return this._disposed;\n    }\n\n    public get currentState() { return this.state; }\n\n    constructor(\n        private readonly clientElection: ISummarizerClientElection,\n        private readonly connectedState: IConnectedState,\n        private readonly summaryCollection:\n            Pick<SummaryCollection, \"opsSinceLastAck\" | \"addOpListener\" | \"removeOpListener\">,\n        parentLogger: ITelemetryLogger,\n        /** Creates summarizer by asking interactive container to spawn summarizing container and\n         * get back its Summarizer instance. */\n        private readonly requestSummarizerFn: () => Promise<ISummarizer>,\n        private readonly startThrottler: IThrottler,\n        {\n            initialDelayMs = defaultInitialDelayMs,\n            opsToBypassInitialDelay = defaultOpsToBypassInitialDelay,\n        }: Readonly<Partial<ISummaryManagerConfig>> = {},\n        private readonly summarizerOptions?: Readonly<Partial<ISummarizerOptions>>,\n    ) {\n        this.logger = ChildLogger.create(\n            parentLogger,\n            \"SummaryManager\",\n            { all: { clientId: () => this.latestClientId } });\n\n        this.connectedState.on(\"connected\", this.handleConnected);\n        this.connectedState.on(\"disconnected\", this.handleDisconnected);\n        this.latestClientId = this.connectedState.clientId;\n\n        this.opsToBypassInitialDelay = opsToBypassInitialDelay;\n        this.initialDelayMs = initialDelayMs;\n    }\n\n    /**\n     * Until start is called, the SummaryManager won't begin attempting to start summarization.  This ensures there's\n     * a window between construction and starting where the caller can attach listeners.\n     */\n    public start(): void {\n        this.clientElection.on(\"electedSummarizerChanged\", this.refreshSummarizer);\n        this.refreshSummarizer();\n    }\n\n    private readonly handleConnected = (clientId: string) => {\n        this.latestClientId = clientId;\n        // If we have a summarizer, it should have been either cancelled on disconnected by now.\n        // But because of lastSummary process, it can still hang around, so there is not much we can\n        // check or assert.\n        this.refreshSummarizer();\n    };\n\n    private readonly handleDisconnected = () => {\n        this.refreshSummarizer();\n    };\n\n    private static readonly isStartingOrRunning = (state: SummaryManagerState) =>\n        state === SummaryManagerState.Starting || state === SummaryManagerState.Running;\n\n    private getShouldSummarizeState(): ShouldSummarizeState {\n        // Note that if we're in the Running state, the electedClient may be a summarizer client, so we can't\n        // enforce connectedState.clientId === clientElection.electedClientId. But once we're Running, we should\n        // only transition to Stopping when the electedParentId changes. Stopping the summarizer without\n        // changing the electedParent will just cause us to transition to Starting again.\n        if (!this.connectedState.connected) {\n            return { shouldSummarize: false, stopReason: \"parentNotConnected\" };\n        } else if (this.connectedState.clientId !== this.clientElection.electedParentId ||\n            (this.state !== SummaryManagerState.Running &&\n                this.connectedState.clientId !== this.clientElection.electedClientId)) {\n            return { shouldSummarize: false, stopReason: \"parentShouldNotSummarize\" };\n        } else if (this.disposed) {\n            assert(false, 0x260 /* \"Disposed should mean disconnected!\" */);\n        } else {\n            return { shouldSummarize: true };\n        }\n    }\n\n    private readonly refreshSummarizer = () => {\n        // Transition states depending on shouldSummarize, which is a calculated property\n        // that is only true if this client is connected and is the elected summarizer.\n        const shouldSummarizeState = this.getShouldSummarizeState();\n        switch (this.state) {\n            case SummaryManagerState.Off: {\n                if (shouldSummarizeState.shouldSummarize) {\n                    this.startSummarization();\n                }\n                return;\n            }\n            case SummaryManagerState.Starting: {\n                // Cannot take any action until summarizer is created\n                // state transition will occur after creation\n                return;\n            }\n            case SummaryManagerState.Running: {\n                if (shouldSummarizeState.shouldSummarize === false) {\n                    this.stop(shouldSummarizeState.stopReason);\n                }\n                return;\n            }\n            case SummaryManagerState.Stopping: {\n                // Cannot take any action until running summarizer finishes\n                // state transition will occur after it stops\n                return;\n            }\n            default: {\n                return;\n            }\n        }\n    };\n\n    private startSummarization() {\n        assert(this.state === SummaryManagerState.Off, 0x261 /* \"Expected: off\" */);\n        this.state = SummaryManagerState.Starting;\n\n        assert(this.summarizer === undefined, 0x262 /* \"Old summarizer is still working!\" */);\n\n        this.delayBeforeCreatingSummarizer().then(async (startWithInitialDelay: boolean) => {\n            // Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore\n            // but only if creation was delayed. If it was not, then we want to ensure we always create\n            // a summarizer to kick off lastSummary. Without that, we would not be able to summarize and get\n            // document out of broken state if it has too many ops and ordering service keeps nacking main\n            // container (and thus it goes into cycle of reconnects)\n            if (startWithInitialDelay && this.getShouldSummarizeState().shouldSummarize === false) {\n                return \"early exit\";\n            }\n\n            // We transition to Running before requesting the summarizer, because after requesting we can't predict\n            // when the electedClient will be replaced with the new summarizer client.\n            // The alternative would be to let connectedState.clientId !== clientElection.electedClientId when\n            // state === Starting || state === Running.\n            assert(this.state === SummaryManagerState.Starting, 0x263 /* \"Expected: starting\" */);\n            this.state = SummaryManagerState.Running;\n\n            const summarizer = await this.requestSummarizerFn();\n            this.summarizer = summarizer;\n\n            // Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore\n            const shouldSummarizeState = this.getShouldSummarizeState();\n            if (shouldSummarizeState.shouldSummarize === false) {\n                this.state = SummaryManagerState.Starting;\n                summarizer.stop(shouldSummarizeState.stopReason);\n                return \"early exit after starting summarizer\";\n            }\n\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            const clientId = this.latestClientId!;\n\n            return PerformanceEvent.timedExecAsync(\n                this.logger,\n                { eventName: \"RunningSummarizer\", attempt: this.startThrottler.numAttempts },\n                async () => summarizer.run(clientId, this.summarizerOptions),\n            );\n        }).then((reason: string) => {\n            this.logger.sendTelemetryEvent({\n                eventName: \"EndingSummarizer\",\n                reason,\n            });\n        }).catch((error) => {\n            this.logger.sendTelemetryEvent(\n                {\n                    eventName: \"EndingSummarizer\",\n                    reason: \"exception\",\n                },\n                error);\n\n            // Most of exceptions happen due to container being closed while loading it, due to\n            // summarizer container loosing connection while load.\n            // Not worth reporting such errors as errors. That said, we might miss some real errors if\n            // we ignore blindly, so try to narrow signature we are looking for - skip logging\n            // error only if this client should no longer be a summarizer (which in practice\n            // means it also lost connection), and error happened on load (we do not have summarizer).\n            // We could annotate the error raised in Container.load where the container closed during load with no error\n            // and check for that case here, but that does not seem to be necessary.\n            if (this.getShouldSummarizeState().shouldSummarize || this.summarizer !== undefined) {\n                // Report any failure as an error unless it was due to cancellation (like \"disconnected\" error)\n                // If failure happened on container load, we may not yet realized that socket disconnected, so check\n                // offlineError.\n                const category = error?.errorType === DriverErrorType.offlineError ? \"generic\" : \"error\";\n                this.logger.sendTelemetryEvent(\n                    {\n                        eventName: \"SummarizerException\",\n                        category,\n                    },\n                    error);\n            }\n        }).finally(() => {\n            assert(this.state !== SummaryManagerState.Off, 0x264 /* \"Expected: Not Off\" */);\n            this.state = SummaryManagerState.Off;\n\n            this.summarizer?.close();\n            this.summarizer = undefined;\n\n            if (this.getShouldSummarizeState().shouldSummarize) {\n                this.startSummarization();\n            }\n        });\n    }\n\n    private stop(reason: SummarizerStopReason) {\n        if (!SummaryManager.isStartingOrRunning(this.state)) {\n            return;\n        }\n        this.state = SummaryManagerState.Stopping;\n\n        // Stopping the running summarizer client should trigger a change\n        // in states when the running summarizer closes\n        this.summarizer?.stop(reason);\n    }\n\n    /**\n     * Implements initial delay before creating summarizer\n     * @returns true, if creation is delayed due to heuristics (not many ops to summarize).\n     *          False if summarizer should start immediately due to too many unsummarized ops.\n     */\n    private async delayBeforeCreatingSummarizer(): Promise<boolean> {\n        // throttle creation of new summarizer containers to prevent spamming the server with websocket connections\n        let delayMs = this.startThrottler.getDelay();\n\n        // We have been elected the summarizer. Some day we may be able to summarize with a live document but for\n        // now we play it safe and launch a second copy.\n        this.logger.sendTelemetryEvent({\n            eventName: \"CreatingSummarizer\",\n            throttlerDelay: delayMs,\n            initialDelay: this.initialDelayMs,\n            startThrottlerMaxDelayMs: this.startThrottler.maxDelayMs,\n            opsSinceLastAck: this.summaryCollection.opsSinceLastAck,\n            opsToBypassInitialDelay: this.opsToBypassInitialDelay,\n        });\n\n        // This delay helps ensure that last summarizer that might be left from previous client\n        // has enough time to complete its last summary and thus new summarizer not conflict with previous one.\n        // If, however, there are too many unsummarized ops, try to resolve it as quickly as possible, with\n        // understanding that we may see nacks because of such quick action.\n        // A better design would be for summarizer election logic to always select current summarizer as\n        // summarizing client (i.e. clientType === \"summarizer\" can be elected) to ensure that nobody else can\n        // summarizer while it finishes its work and moves to exit.\n        // It also helps with pure boot scenario (single client) to offset expensive work a bit out from\n        // critical boot sequence.\n        let startWithInitialDelay = false;\n        if (this.summaryCollection.opsSinceLastAck < this.opsToBypassInitialDelay) {\n            startWithInitialDelay = true;\n            delayMs = Math.max(delayMs, this.initialDelayMs);\n        }\n\n        if (delayMs > 0) {\n            let timer;\n            let resolveOpPromiseFn;\n            // Create a listener that will break the delay if we've exceeded the initial delay ops count.\n            const opsListenerFn = () => {\n                if (this.summaryCollection.opsSinceLastAck >= this.opsToBypassInitialDelay) {\n                    clearTimeout(timer);\n                    resolveOpPromiseFn();\n                }\n            };\n            // Create a Promise that will resolve when the delay expires.\n            const delayPromise = new Promise<void>((resolve) => {\n                timer = setTimeout(() => resolve(), delayMs);\n            });\n            // Create a Promise that will resolve if the ops count passes the threshold.\n            const opPromise = new Promise<void>((resolve) => { resolveOpPromiseFn = resolve; });\n            this.summaryCollection.addOpListener(opsListenerFn);\n            await Promise.race([delayPromise, opPromise]);\n            this.summaryCollection.removeOpListener(opsListenerFn);\n        }\n        return startWithInitialDelay;\n    }\n\n    public readonly summarizeOnDemand: ISummarizer[\"summarizeOnDemand\"] = (...args) => {\n        if (this.summarizer === undefined) {\n            throw Error(\"No running summarizer client\");\n            // TODO: could spawn a summarizer client temporarily.\n        }\n        return this.summarizer.summarizeOnDemand(...args);\n    };\n\n    public readonly enqueueSummarize: ISummarizer[\"enqueueSummarize\"] = (...args) => {\n        if (this.summarizer === undefined) {\n            throw Error(\"No running summarizer client\");\n            // TODO: could spawn a summarizer client temporarily.\n        }\n        return this.summarizer.enqueueSummarize(...args);\n    };\n\n    public dispose() {\n        this.clientElection.off(\"electedSummarizerChanged\", this.refreshSummarizer);\n        this.connectedState.off(\"connected\", this.handleConnected);\n        this.connectedState.off(\"disconnected\", this.handleDisconnected);\n        this._disposed = true;\n    }\n}\n"]}

package/dist/throttler.js

@@ -87,7 +87,7 @@ const formExponentialFn = ({ multiplier = 2, coefficient = 1, offset = 0, initia
     : coefficient * (Math.pow(multiplier, numAttempts)) + offset);
 exports.formExponentialFn = formExponentialFn;
 /** f(n) = C x (B^(n+A)) + F = (C x B^A) x B^n + F */
-const formExponentialFnWithAttemptOffset = (attemptOffset, { multiplier = 2, coefficient = 1, offset = 0, initialDelay = undefined, } = {}) => exports.formExponentialFn({
+const formExponentialFnWithAttemptOffset = (attemptOffset, { multiplier = 2, coefficient = 1, offset = 0, initialDelay = undefined, } = {}) => (0, exports.formExponentialFn)({
     multiplier,
     coefficient: coefficient * Math.pow(multiplier, attemptOffset),
     offset,
@@ -104,7 +104,7 @@ exports.formExponentialFnWithAttemptOffset = formExponentialFnWithAttemptOffset;
 const formLinearFn = ({ coefficient = 1, offset = 0, } = {}) => (numAttempts) => Math.max(0, coefficient * numAttempts + offset);
 exports.formLinearFn = formLinearFn;
 /** f(n) = C x (n+A) + F = C x n + (C x A + F) */
-const formLinearFnWithAttemptOffset = (attemptOffset, { coefficient = 1, offset = 0, } = {}) => exports.formLinearFn({
+const formLinearFnWithAttemptOffset = (attemptOffset, { coefficient = 1, offset = 0, } = {}) => (0, exports.formLinearFn)({
     coefficient,
     offset: coefficient * attemptOffset + offset,
 });

package/dist/throttler.js.map

@@ -1 +1 @@
-{"version":3,"file":"throttler.js","sourceRoot":"","sources":["../src/throttler.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA2BH;;;GAGG;AACH,MAAa,SAAS;IAuBlB;IACI,qDAAqD;IACrC,aAAqB;IACrC,6CAA6C;IAC7B,UAAkB;IAClC;;;;OAIG;IACa,OAAwC;QARxC,kBAAa,GAAb,aAAa,CAAQ;QAErB,eAAU,GAAV,UAAU,CAAQ;QAMlB,YAAO,GAAP,OAAO,CAAiC;QAhCpD,eAAU,GAAa,EAAE,CAAC;IAiC9B,CAAC;IA/BL,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,WAAW;QACd,OAAO,CAAE,GAAG,IAAI,CAAC,UAAU,CAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,IAAW,iBAAiB;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,CAAC;IAeM,QAAQ;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACjD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,4DAA4D;YAC5D,6DAA6D;YAC7D,MAAM,OAAO,GAAG,iBAAiB,GAAG,GAAG,CAAC;YACxC,IAAI,OAAO,GAAG,CAAC,EAAE;gBACb,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;aAC7D;SACJ;QAED,kEAAkE;QAClE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;QAEhF,4DAA4D;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEhF,kCAAkC;QAClC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE1B,gFAAgF;QAChF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;QAE1D,IAAI,OAAO,KAAK,IAAI,CAAC,UAAU,EAAE;YAC7B,0DAA0D;YAC1D,iEAAiE;YACjE,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;SAC3B;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AArED,8BAqEC;AAED;;;;;;;;;;GAUG;AACK,MAAM,iBAAiB,GAAG,CAAC,EAC/B,UAAU,GAAG,CAAC,EACd,WAAW,GAAG,CAAC,EACf,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,SAA+B,MAC9C,EAAE,EAAyB,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EACzD,WAAW,IAAI,CAAC,IAAI,YAAY,KAAK,SAAS;IAC9C,CAAC,CAAC,YAAY;IACd,CAAC,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AARpD,QAAA,iBAAiB,qBAQmC;AAElE,qDAAqD;AAC9C,MAAM,kCAAkC,GAAG,CAAC,aAAqB,EAAE,EACtE,UAAU,GAAG,CAAC,EACd,WAAW,GAAG,CAAC,EACf,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,SAA+B,MAC9C,EAAE,EAAE,EAAE,CAAC,yBAAiB,CAAC;IACzB,UAAU;IACV,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC;IAC9D,MAAM;IACN,YAAY;CACf,CAAC,CAAC;AAVU,QAAA,kCAAkC,sCAU5C;AAEH;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAAC,EACzB,WAAW,GAAG,CAAC,EACf,MAAM,GAAG,CAAC,GACb,GAAG,EAAE,EAAyB,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EACzD,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC,CAAC;AAJ3B,QAAA,YAAY,gBAIe;AAExC,iDAAiD;AAC1C,MAAM,6BAA6B,GAAG,CAAC,aAAqB,EAAE,EACjE,WAAW,GAAG,CAAC,EACf,MAAM,GAAG,CAAC,GACb,GAAG,EAAE,EAAE,EAAE,CAAC,oBAAY,CAAC;IACpB,WAAW;IACX,MAAM,EAAE,WAAW,GAAG,aAAa,GAAG,MAAM;CAC/C,CAAC,CAAC;AANU,QAAA,6BAA6B,iCAMvC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface IThrottler {\n    /**\n     * Computes what the throttle delay should be, and records an attempt\n     * which will be used for calculating future attempt delays.\n     */\n    getDelay(): number;\n\n    /**\n     * Number of attempts that occurred within the sliding window as of\n     * the most recent delay computation.\n     */\n    readonly numAttempts: number;\n\n    /** Width of sliding delay window in milliseconds. */\n    readonly delayWindowMs: number;\n    /** Maximum delay allowed in milliseconds. */\n    readonly maxDelayMs: number;\n    /**\n     * Delay function used to calculate what the delay should be.\n     * The input is the number of attempts that occurred within the sliding window.\n     * The result is the calculated delay in milliseconds.\n     */\n    readonly delayFn: (numAttempts: number) => number;\n}\n\n/**\n * Used to give increasing delay times for throttling a single functionality.\n * Delay is based on previous attempts within specified time window, subtracting delay time.\n */\nexport class Throttler implements IThrottler {\n    private startTimes: number[] = [];\n\n    public get numAttempts() {\n        return this.startTimes.length;\n    }\n\n    /**\n     * Gets all attempt start times after compensating for the delay times\n     * by adding the delay times to the actual times.\n     */\n    public getAttempts(): readonly number[] {\n        return [ ...this.startTimes ];\n    }\n\n    /**\n     * Latest attempt time after compensating for the delay time itself\n     * by adding the delay time to the actual time.\n     */\n    public get latestAttemptTime() {\n        return this.startTimes.length > 0 ? this.startTimes[this.startTimes.length - 1] : undefined;\n    }\n\n    constructor(\n        /** Width of sliding delay window in milliseconds. */\n        public readonly delayWindowMs: number,\n        /** Maximum delay allowed in milliseconds. */\n        public readonly maxDelayMs: number,\n        /**\n         * Delay function used to calculate what the delay should be.\n         * The input is the number of attempts that occurred within the sliding window.\n         * The result is the calculated delay in milliseconds.\n         */\n        public readonly delayFn: (numAttempts: number) => number,\n    ) { }\n\n    public getDelay() {\n        const now = Date.now();\n\n        const latestAttemptTime = this.latestAttemptTime;\n        if (latestAttemptTime !== undefined) {\n            // If getDelay was called sooner than the most recent delay,\n            // subtract the remaining time, since we previously added it.\n            const earlyMs = latestAttemptTime - now;\n            if (earlyMs > 0) {\n                this.startTimes = this.startTimes.map((t) => t - earlyMs);\n            }\n        }\n\n        // Remove all attempts that have already fallen out of the window.\n        this.startTimes = this.startTimes.filter((t) => (now - t) < this.delayWindowMs);\n\n        // Compute delay, but do not exceed the specified max delay.\n        const delayMs = Math.min(this.delayFn(this.startTimes.length), this.maxDelayMs);\n\n        // Record this attempt start time.\n        this.startTimes.push(now);\n\n        // Account for the delay time, by effectively removing it from the delay window.\n        this.startTimes = this.startTimes.map((t) => t + delayMs);\n\n        if (delayMs === this.maxDelayMs) {\n            // We hit max delay, so adding more won't affect anything.\n            // Shift off oldest time to stop this array from growing forever.\n            this.startTimes.shift();\n        }\n\n        return delayMs;\n    }\n}\n\n/**\n * Helper function to generate simple exponential throttle functions.\n * f(n) = [coefficient] x ([multiplier]^n) + [flatOffset]\n * where n = number of attempts, and f(n) = delay time in milliseconds.\n * If not provided, coefficient will default to 1, multiplier to 2,\n * minimum delay to 0, and the offset to 0, yielding:\n * 0 ms, 2 ms, 4 ms, 8 ms, ..., 2^n ms\n * where M = multiplier; an exponential back-off.\n * Use initialDelay to decide what should happen when numAttempts is 0,\n * leave it undefined to not special case.\n */\n export const formExponentialFn = ({\n    multiplier = 2,\n    coefficient = 1,\n    offset = 0,\n    initialDelay = undefined as number | undefined,\n} = {}): IThrottler[\"delayFn\"] => (numAttempts) => Math.max(0,\n    numAttempts <= 0 && initialDelay !== undefined\n    ? initialDelay\n    : coefficient * (Math.pow(multiplier, numAttempts)) + offset);\n\n/** f(n) = C x (B^(n+A)) + F = (C x B^A) x B^n + F */\nexport const formExponentialFnWithAttemptOffset = (attemptOffset: number, {\n    multiplier = 2,\n    coefficient = 1,\n    offset = 0,\n    initialDelay = undefined as number | undefined,\n} = {}) => formExponentialFn({\n    multiplier,\n    coefficient: coefficient * Math.pow(multiplier, attemptOffset),\n    offset,\n    initialDelay,\n});\n\n/**\n * Helper function to generate simple linear throttle functions.\n * f(n) = [coefficient] x n + [flatOffset]\n * where n = number of attempts, and f(n) = delay time in milliseconds.\n * If not provided, coefficient will default to 1, and offset to 0, yielding:\n * 0 ms, 1 ms, 2 ms, 3 ms, ..., n ms delays; a linear back-off.\n */\nexport const formLinearFn = ({\n    coefficient = 1,\n    offset = 0,\n} = {}): IThrottler[\"delayFn\"] => (numAttempts) => Math.max(0,\n    coefficient * numAttempts + offset);\n\n/** f(n) = C x (n+A) + F = C x n + (C x A + F) */\nexport const formLinearFnWithAttemptOffset = (attemptOffset: number, {\n    coefficient = 1,\n    offset = 0,\n} = {}) => formLinearFn({\n    coefficient,\n    offset: coefficient * attemptOffset + offset,\n});\n"]}
+{"version":3,"file":"throttler.js","sourceRoot":"","sources":["../src/throttler.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA2BH;;;GAGG;AACH,MAAa,SAAS;IAuBlB;IACI,qDAAqD;IACrC,aAAqB;IACrC,6CAA6C;IAC7B,UAAkB;IAClC;;;;OAIG;IACa,OAAwC;QARxC,kBAAa,GAAb,aAAa,CAAQ;QAErB,eAAU,GAAV,UAAU,CAAQ;QAMlB,YAAO,GAAP,OAAO,CAAiC;QAhCpD,eAAU,GAAa,EAAE,CAAC;IAiC9B,CAAC;IA/BL,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,WAAW;QACd,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAW,iBAAiB;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,CAAC;IAeM,QAAQ;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACjD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,4DAA4D;YAC5D,6DAA6D;YAC7D,MAAM,OAAO,GAAG,iBAAiB,GAAG,GAAG,CAAC;YACxC,IAAI,OAAO,GAAG,CAAC,EAAE;gBACb,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;aAC7D;SACJ;QAED,kEAAkE;QAClE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;QAEhF,4DAA4D;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEhF,kCAAkC;QAClC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE1B,gFAAgF;QAChF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;QAE1D,IAAI,OAAO,KAAK,IAAI,CAAC,UAAU,EAAE;YAC7B,0DAA0D;YAC1D,iEAAiE;YACjE,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;SAC3B;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AArED,8BAqEC;AAED;;;;;;;;;;GAUG;AACK,MAAM,iBAAiB,GAAG,CAAC,EAC/B,UAAU,GAAG,CAAC,EACd,WAAW,GAAG,CAAC,EACf,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,SAA+B,MAC9C,EAAE,EAAyB,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EACzD,WAAW,IAAI,CAAC,IAAI,YAAY,KAAK,SAAS;IAC9C,CAAC,CAAC,YAAY;IACd,CAAC,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AARpD,QAAA,iBAAiB,qBAQmC;AAElE,qDAAqD;AAC9C,MAAM,kCAAkC,GAAG,CAAC,aAAqB,EAAE,EACtE,UAAU,GAAG,CAAC,EACd,WAAW,GAAG,CAAC,EACf,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,SAA+B,MAC9C,EAAE,EAAE,EAAE,CAAC,IAAA,yBAAiB,EAAC;IACzB,UAAU;IACV,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC;IAC9D,MAAM;IACN,YAAY;CACf,CAAC,CAAC;AAVU,QAAA,kCAAkC,sCAU5C;AAEH;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAAC,EACzB,WAAW,GAAG,CAAC,EACf,MAAM,GAAG,CAAC,GACb,GAAG,EAAE,EAAyB,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EACzD,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC,CAAC;AAJ3B,QAAA,YAAY,gBAIe;AAExC,iDAAiD;AAC1C,MAAM,6BAA6B,GAAG,CAAC,aAAqB,EAAE,EACjE,WAAW,GAAG,CAAC,EACf,MAAM,GAAG,CAAC,GACb,GAAG,EAAE,EAAE,EAAE,CAAC,IAAA,oBAAY,EAAC;IACpB,WAAW;IACX,MAAM,EAAE,WAAW,GAAG,aAAa,GAAG,MAAM;CAC/C,CAAC,CAAC;AANU,QAAA,6BAA6B,iCAMvC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface IThrottler {\n    /**\n     * Computes what the throttle delay should be, and records an attempt\n     * which will be used for calculating future attempt delays.\n     */\n    getDelay(): number;\n\n    /**\n     * Number of attempts that occurred within the sliding window as of\n     * the most recent delay computation.\n     */\n    readonly numAttempts: number;\n\n    /** Width of sliding delay window in milliseconds. */\n    readonly delayWindowMs: number;\n    /** Maximum delay allowed in milliseconds. */\n    readonly maxDelayMs: number;\n    /**\n     * Delay function used to calculate what the delay should be.\n     * The input is the number of attempts that occurred within the sliding window.\n     * The result is the calculated delay in milliseconds.\n     */\n    readonly delayFn: (numAttempts: number) => number;\n}\n\n/**\n * Used to give increasing delay times for throttling a single functionality.\n * Delay is based on previous attempts within specified time window, subtracting delay time.\n */\nexport class Throttler implements IThrottler {\n    private startTimes: number[] = [];\n\n    public get numAttempts() {\n        return this.startTimes.length;\n    }\n\n    /**\n     * Gets all attempt start times after compensating for the delay times\n     * by adding the delay times to the actual times.\n     */\n    public getAttempts(): readonly number[] {\n        return [...this.startTimes];\n    }\n\n    /**\n     * Latest attempt time after compensating for the delay time itself\n     * by adding the delay time to the actual time.\n     */\n    public get latestAttemptTime() {\n        return this.startTimes.length > 0 ? this.startTimes[this.startTimes.length - 1] : undefined;\n    }\n\n    constructor(\n        /** Width of sliding delay window in milliseconds. */\n        public readonly delayWindowMs: number,\n        /** Maximum delay allowed in milliseconds. */\n        public readonly maxDelayMs: number,\n        /**\n         * Delay function used to calculate what the delay should be.\n         * The input is the number of attempts that occurred within the sliding window.\n         * The result is the calculated delay in milliseconds.\n         */\n        public readonly delayFn: (numAttempts: number) => number,\n    ) { }\n\n    public getDelay() {\n        const now = Date.now();\n\n        const latestAttemptTime = this.latestAttemptTime;\n        if (latestAttemptTime !== undefined) {\n            // If getDelay was called sooner than the most recent delay,\n            // subtract the remaining time, since we previously added it.\n            const earlyMs = latestAttemptTime - now;\n            if (earlyMs > 0) {\n                this.startTimes = this.startTimes.map((t) => t - earlyMs);\n            }\n        }\n\n        // Remove all attempts that have already fallen out of the window.\n        this.startTimes = this.startTimes.filter((t) => (now - t) < this.delayWindowMs);\n\n        // Compute delay, but do not exceed the specified max delay.\n        const delayMs = Math.min(this.delayFn(this.startTimes.length), this.maxDelayMs);\n\n        // Record this attempt start time.\n        this.startTimes.push(now);\n\n        // Account for the delay time, by effectively removing it from the delay window.\n        this.startTimes = this.startTimes.map((t) => t + delayMs);\n\n        if (delayMs === this.maxDelayMs) {\n            // We hit max delay, so adding more won't affect anything.\n            // Shift off oldest time to stop this array from growing forever.\n            this.startTimes.shift();\n        }\n\n        return delayMs;\n    }\n}\n\n/**\n * Helper function to generate simple exponential throttle functions.\n * f(n) = [coefficient] x ([multiplier]^n) + [flatOffset]\n * where n = number of attempts, and f(n) = delay time in milliseconds.\n * If not provided, coefficient will default to 1, multiplier to 2,\n * minimum delay to 0, and the offset to 0, yielding:\n * 0 ms, 2 ms, 4 ms, 8 ms, ..., 2^n ms\n * where M = multiplier; an exponential back-off.\n * Use initialDelay to decide what should happen when numAttempts is 0,\n * leave it undefined to not special case.\n */\n export const formExponentialFn = ({\n    multiplier = 2,\n    coefficient = 1,\n    offset = 0,\n    initialDelay = undefined as number | undefined,\n} = {}): IThrottler[\"delayFn\"] => (numAttempts) => Math.max(0,\n    numAttempts <= 0 && initialDelay !== undefined\n    ? initialDelay\n    : coefficient * (Math.pow(multiplier, numAttempts)) + offset);\n\n/** f(n) = C x (B^(n+A)) + F = (C x B^A) x B^n + F */\nexport const formExponentialFnWithAttemptOffset = (attemptOffset: number, {\n    multiplier = 2,\n    coefficient = 1,\n    offset = 0,\n    initialDelay = undefined as number | undefined,\n} = {}) => formExponentialFn({\n    multiplier,\n    coefficient: coefficient * Math.pow(multiplier, attemptOffset),\n    offset,\n    initialDelay,\n});\n\n/**\n * Helper function to generate simple linear throttle functions.\n * f(n) = [coefficient] x n + [flatOffset]\n * where n = number of attempts, and f(n) = delay time in milliseconds.\n * If not provided, coefficient will default to 1, and offset to 0, yielding:\n * 0 ms, 1 ms, 2 ms, 3 ms, ..., n ms delays; a linear back-off.\n */\nexport const formLinearFn = ({\n    coefficient = 1,\n    offset = 0,\n} = {}): IThrottler[\"delayFn\"] => (numAttempts) => Math.max(0,\n    coefficient * numAttempts + offset);\n\n/** f(n) = C x (n+A) + F = C x n + (C x A + F) */\nexport const formLinearFnWithAttemptOffset = (attemptOffset: number, {\n    coefficient = 1,\n    offset = 0,\n} = {}) => formLinearFn({\n    coefficient,\n    offset: coefficient * attemptOffset + offset,\n});\n"]}

package/lib/blobManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"blobManager.js","sourceRoot":"","sources":["../src/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAE9F,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAGpE;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IAWnB,YACoB,IAAY,EACZ,YAAiC,EAC1C,GAAuB;QAFd,SAAI,GAAJ,IAAI,CAAQ;QACZ,iBAAY,GAAZ,YAAY,CAAqB;QAC1C,QAAG,GAAH,GAAG,CAAoB;QAb1B,aAAQ,GAAY,KAAK,CAAC;QAe9B,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,CAAC;IAdD,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,CAAC,CAAC;IAExD,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAYM,WAAW;QACd,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAEM,IAAI,CAAC,MAAoB;QAC5B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAClD,CAAC;CACJ;AAUD,MAAM,OAAO,WAAW;IAapB,YACqB,YAAiC,EAClD,QAA8B,EACb,UAAyC,EACzC,kBAA4C,EAC5C,OAA0B,EAC1B,MAAwB;QALxB,iBAAY,GAAZ,YAAY,CAAqB;QAEjC,eAAU,GAAV,UAAU,CAA+B;QACzC,uBAAkB,GAAlB,kBAAkB,CAA0B;QAC5C,YAAO,GAAP,OAAO,CAAmB;QAC1B,WAAM,GAAN,MAAM,CAAkB;QAhB7C,oBAAoB;QACH,YAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;QAClD,+GAA+G;QAC/G,mCAAmC;QAClB,mBAAc,GAAgC,IAAI,GAAG,EAAE,CAAC;QACzE,qDAAqD;QACpC,oBAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;QAYtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YAC9B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE;gBAChD,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC,CAAC;aAC/E;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAc;;QAC/B,MAAM,SAAS,eAAG,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,oCAAK,MAAM,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAExE,OAAO,IAAI,UAAU,CACjB,GAAG,WAAW,CAAC,QAAQ,IAAI,SAAS,EAAE,EACtC,IAAI,CAAC,YAAY,EACjB,KAAK,IAAI,EAAE;YACP,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzD,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB;oBACI,SAAS,EAAC,yBAAyB;oBACnC,EAAE,EAAE,SAAS;iBAChB,EACD,KAAK,CACR,CAAC;gBACF,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,SAAS,EAAE;YACpD,oDAAoD;YACpD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAC1E,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;SAChF;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,IAAI,UAAU,CACzB,GAAG,WAAW,CAAC,QAAQ,IAAI,QAAQ,CAAC,EAAE,EAAE,EACxC,IAAI,CAAC,YAAY;QACjB,oGAAoG;QACpG,oDAAoD;QACpD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CACnE,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;SACjB;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACtC,aAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;aAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,QAAQ,EAAQ,CAAC,CAAC;YAE3D,oEAAoE;YACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrC,aAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,mBAAmB,CAAC,MAAc,EAAE,KAAc;QACrD,IAAI,KAAK,EAAE;YACP,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;YAC3F,YAAY,CAAC,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACtC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACpB,SAAoC,EACpC,YAAyD;QAEzD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,EAAE,CAAC;SACb;QACD,IAAI,aAAa,CAAC;QAClB,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC5D,IAAI,OAAO,EAAE;YACT,aAAa,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;SAC/C;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC;aACtC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7E,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,IAAI,CAAC,QAA8B;;QACvC,IAAI,QAAQ,CAAC,GAAG,EAAE;YACd,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;YACnE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;SACrG;QACD,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,uBAAuB;YAClC,KAAK,cAAE,QAAQ,CAAC,GAAG,0CAAE,MAAM,mCAAI,CAAC;YAChC,aAAa,QAAE,QAAQ,CAAC,aAAa,0CAAE,MAAM;SAChD,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,EAAE,GAAG,OAAO,IAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3F,MAAM,MAAM,GAA2B,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QACvD;;;YAGI;QACJ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACpC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH;;;;;;WAMG;QACH,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;YAClC,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE;gBACnD,oGAAoG;gBACpG,kDAAkD;gBAClD,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;aACvE;SACJ;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,YAAsB;;QAC5C,oGAAoG;QACpG,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;YAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnC,MAAM,CACF,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,QAAQ,EAC/D,KAAK,CAAC,8CAA8C,CACvD,CAAC;YACF,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAE5B,mGAAmG;YACnG,mFAAmF;YACnF,UAAI,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,GAAG;gBACjC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAClC,SAAS;aACZ;YACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC/B;IACL,CAAC;IAEM,SAAS;QACZ,6GAA6G;QAC7G,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;QACtG,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAC1E,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACvB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE;YACnD,OAAO,CAAC,OAAO,CACX,WAAW,CAAC,qBAAqB,EACjC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAC3D,CAAC;SACL;QAED,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAEM,gBAAgB,CAAC,KAA0B;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EACpD,KAAK,CAAC,4DAA4D,CAAC,CAAC;QACxE,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzE,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,KAAK,EAAE;YACtC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;YAC9F,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC/B;QACD,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjG,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC/B,CAAC;;AA7OsB,oBAAQ,GAAG,QAAQ,CAAC;AACnB,iCAAqB,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { generateHandleContextPath, SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IGarbageCollectionData, ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\n\n/**\n * This class represents blob (long string)\n * This object is used only when creating (writing) new blob and serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * DataObject.request() recognizes requests in the form of `/blobs/<id>`\n * and loads blob.\n */\nexport class BlobHandle implements IFluidHandle<ArrayBufferLike> {\n    private attached: boolean = false;\n\n    public get IFluidHandle(): IFluidHandle { return this; }\n\n    public get isAttached(): boolean {\n        return this.attached;\n    }\n\n    public readonly absolutePath: string;\n\n    constructor(\n        public readonly path: string,\n        public readonly routeContext: IFluidHandleContext,\n        public get: () => Promise<any>,\n    ) {\n        this.absolutePath = generateHandleContextPath(path, this.routeContext);\n    }\n\n    public attachGraph() {\n        this.attached = true;\n    }\n\n    public bind(handle: IFluidHandle) {\n        throw new Error(\"Cannot bind to blob handle\");\n    }\n}\n\n/**\n * Information from a snapshot needed to load BlobManager\n */\nexport interface IBlobManagerLoadInfo {\n    ids?: string[],\n    redirectTable?: [string, string][],\n}\n\nexport class BlobManager {\n    public static readonly basePath = \"_blobs\";\n    private static readonly redirectTableBlobName = \".redirectTable\";\n    // uploaded blob IDs\n    private readonly blobIds: Set<string> = new Set();\n    // blobs for which upload is pending. maps to a promise that will resolve once the blob has been uploaded and a\n    // BlobAttach op has round-tripped.\n    private readonly pendingBlobIds: Map<string, Deferred<void>> = new Map();\n    // blobs uploaded while detached; cleared upon attach\n    private readonly detachedBlobIds: Set<string> = new Set();\n    // map of detached blob IDs to IDs used by storage. used to support blob handles given out while detached\n    private redirectTable: Map<string, string> | undefined;\n\n    constructor(\n        private readonly routeContext: IFluidHandleContext,\n        snapshot: IBlobManagerLoadInfo,\n        private readonly getStorage: () => IDocumentStorageService,\n        private readonly attachBlobCallback: (blobId: string) => void,\n        private readonly runtime: IContainerRuntime,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.runtime.once(\"dispose\", () => {\n            for (const promise of this.pendingBlobIds.values()) {\n                promise.reject(new Error(\"runtime disposed while blobAttach op in flight\"));\n            }\n        });\n        this.load(snapshot);\n    }\n\n    private hasBlob(id: string): boolean {\n        return this.blobIds.has(id) || this.detachedBlobIds.has(id);\n    }\n\n    public async getBlob(blobId: string): Promise<IFluidHandle<ArrayBufferLike>> {\n        const storageId = this.redirectTable?.get(blobId) ?? blobId;\n        assert(this.hasBlob(storageId), 0x11f /* \"requesting unknown blobs\" */);\n\n        return new BlobHandle(\n            `${BlobManager.basePath}/${storageId}`,\n            this.routeContext,\n            async () => {\n                return this.getStorage().readBlob(storageId).catch((error) => {\n                    this.logger.sendErrorEvent(\n                        {\n                            eventName:\"AttachmentReadBlobError\",\n                            id: storageId,\n                        },\n                        error,\n                    );\n                    throw error;\n                });\n            },\n        );\n    }\n\n    public async createBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n        if (this.runtime.attachState === AttachState.Attaching) {\n            // blob upload is not supported in \"Attaching\" state\n            this.logger.sendTelemetryEvent({ eventName: \"CreateBlobWhileAttaching\" });\n            await new Promise<void>((resolve) => this.runtime.once(\"attached\", resolve));\n        }\n\n        const response = await this.getStorage().createBlob(blob);\n        const handle = new BlobHandle(\n            `${BlobManager.basePath}/${response.id}`,\n            this.routeContext,\n            // get() should go through BlobManager.getBlob() so handles created while detached can be redirected\n            // to the correct storage id after they are uploaded\n            async () => this.getBlob(response.id).then(async (h) => h.get()),\n        );\n\n        if (this.runtime.attachState === AttachState.Detached) {\n            this.detachedBlobIds.add(response.id);\n            return handle;\n        }\n\n        // Note - server will de-dup blobs, so we might get existing blobId!\n        if (this.pendingBlobIds.has(response.id)) {\n            await this.pendingBlobIds.get(response.id)?.promise;\n        } else if (!this.blobIds.has(response.id)) {\n            this.pendingBlobIds.set(response.id, new Deferred<void>());\n\n            // send blob attach op and wait until we see it to return the handle\n            this.attachBlobCallback(response.id);\n            await this.pendingBlobIds.get(response.id)?.promise;\n        }\n\n        return handle;\n    }\n\n    public processBlobAttachOp(blobId: string, local: boolean) {\n        if (local) {\n            const pendingBlobP = this.pendingBlobIds.get(blobId);\n            assert(pendingBlobP !== undefined, 0x1f8 /* \"local BlobAttach op with no pending blob\" */);\n            pendingBlobP.resolve();\n            this.pendingBlobIds.delete(blobId);\n        }\n        this.blobIds.add(blobId);\n    }\n\n    /**\n     * Reads blobs needed to load BlobManager from storage.\n     */\n    public static async load(\n        blobsTree: ISnapshotTree | undefined,\n        tryFetchBlob: (id: string) => Promise<[string, string][]>,\n    ): Promise<IBlobManagerLoadInfo> {\n        if (!blobsTree) {\n            return {};\n        }\n        let redirectTable;\n        const tableId = blobsTree.blobs[this.redirectTableBlobName];\n        if (tableId) {\n            redirectTable = await tryFetchBlob(tableId);\n        }\n        const ids = Object.entries(blobsTree.blobs)\n            .filter(([k, _]) => k !== this.redirectTableBlobName).map(([_, v]) => v);\n        return { ids, redirectTable };\n    }\n\n    /**\n     * Load a set of previously attached blob IDs from a previous snapshot. Note\n     * that BlobManager tracking and reporting attached blobs is a temporary\n     * solution since storage expects attached blobs to be reported and any that\n     * are not reported as attached may be GCed. In the future attached blob\n     * IDs will be collected at summarization time, and runtime will not care\n     * about the existence or specific formatting of this tree in returned\n     * snapshots.\n     *\n     * @param blobsTree - Tree containing IDs of previously attached blobs. This\n     * corresponds to snapshot() below. We look for the IDs in the blob entries\n     * of the tree since the both the r11s and SPO drivers replace the\n     * attachment types returned in snapshot() with blobs.\n     */\n    private load(snapshot: IBlobManagerLoadInfo): void {\n        if (snapshot.ids) {\n            const detached = this.runtime.attachState === AttachState.Detached;\n            snapshot.ids.map((entry) => detached ? this.detachedBlobIds.add(entry) : this.blobIds.add(entry));\n        }\n        if (snapshot.redirectTable) {\n            this.redirectTable = new Map(snapshot.redirectTable);\n        }\n        this.logger.sendTelemetryEvent({\n            eventName: \"AttachmentBlobsLoaded\",\n            count: snapshot.ids?.length ?? 0,\n            redirectTable: snapshot.redirectTable?.length,\n        });\n    }\n\n    /**\n     * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be\n     * individually referenced by storing its handle in a referenced DDS. Returns the list of blob ids as GC nodes.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data. BlobManager doesn't care\n     * about this for now because the data is a simple list of blob ids.\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        const getGCNodePath = (blobId: string) => { return `/${BlobManager.basePath}/${blobId}`; };\n        const gcData: IGarbageCollectionData = { gcNodes: {} };\n        /**\n          * The node path is of the format `/_blobs/blobId`. This path must match the path of the blob handle returned\n          * by the createBlob API because blobs are marked referenced by storing these handles in a referenced DDS.\n          */\n        this.blobIds.forEach((blobId: string) => {\n            gcData.gcNodes[getGCNodePath(blobId)] = [];\n        });\n\n        /**\n         * For all blobs in the redirect table, the handle returned on creation is based off of the localId. So, these\n         * nodes can be referenced by storing the localId handle. When that happens, the corresponding storageId node\n         * must also be marked referenced. So, we add a route from the localId node to the storageId node.\n         * Note that because of de-duping, there can be multiple localIds that all redirect to the same storageId or\n         * a blob may be referenced via its storageId handle.\n         */\n        if (this.redirectTable !== undefined) {\n            for (const [localId, storageId] of this.redirectTable) {\n                // Add node for the localId and add a route to the storageId node. The storageId node will have been\n                // added above when adding nodes for this.blobIds.\n                gcData.gcNodes[getGCNodePath(localId)] = [getGCNodePath(storageId)];\n            }\n        }\n\n        return gcData;\n    }\n\n    /**\n     * When running GC in test mode, this is called to delete blobs that are unused.\n     * @param unusedRoutes - These are the blob node ids that are unused and should be deleted.\n     */\n    public deleteUnusedRoutes(unusedRoutes: string[]): void {\n        // The routes or blob node paths are in the same format as returned in getGCData - `/_blobs/blobId`.\n        for (const route of unusedRoutes) {\n            const pathParts = route.split(\"/\");\n            assert(\n                pathParts.length === 3 && pathParts[1] === BlobManager.basePath,\n                0x2d5 /* \"Invalid blob node id in unused routes.\" */,\n            );\n            const blobId = pathParts[2];\n\n            // The unused blobId could be a localId. If so, remove it from the redirect table and continue. The\n            // corresponding storageId may still be used either directly or via other localIds.\n            if (this.redirectTable?.has(blobId)) {\n                this.redirectTable.delete(blobId);\n                continue;\n            }\n            this.blobIds.delete(blobId);\n        }\n    }\n\n    public summarize(): ISummaryTreeWithStats {\n        // If we have a redirect table it means the container is about to transition to \"Attaching\" state, so we need\n        // to return an actual snapshot containing all the real storage IDs we know about.\n        const attachingOrAttached = !!this.redirectTable || this.runtime.attachState !== AttachState.Detached;\n        const blobIds = attachingOrAttached ? this.blobIds : this.detachedBlobIds;\n        const builder = new SummaryTreeBuilder();\n        blobIds.forEach((blobId) => {\n            builder.addAttachment(blobId);\n        });\n\n        if (this.redirectTable && this.redirectTable.size > 0) {\n            builder.addBlob(\n                BlobManager.redirectTableBlobName,\n                JSON.stringify(Array.from(this.redirectTable.entries())),\n            );\n        }\n\n        return builder.getSummaryTree();\n    }\n\n    public setRedirectTable(table: Map<string, string>) {\n        assert(this.runtime.attachState === AttachState.Detached,\n            0x252 /* \"redirect table can only be set in detached container\" */);\n        assert(!this.redirectTable, 0x253 /* \"redirect table already exists\" */);\n        for (const [localId, storageId] of table) {\n            assert(this.detachedBlobIds.delete(localId), 0x254 /* \"unrecognized id in redirect table\" */);\n            this.blobIds.add(storageId);\n        }\n        assert(this.detachedBlobIds.size === 0, 0x255 /* \"detached blob id absent in redirect table\" */);\n        this.redirectTable = table;\n    }\n}\n"]}
+{"version":3,"file":"blobManager.js","sourceRoot":"","sources":["../src/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAE9F,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAGpE;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IAWnB,YACoB,IAAY,EACZ,YAAiC,EAC1C,GAAuB;QAFd,SAAI,GAAJ,IAAI,CAAQ;QACZ,iBAAY,GAAZ,YAAY,CAAqB;QAC1C,QAAG,GAAH,GAAG,CAAoB;QAb1B,aAAQ,GAAY,KAAK,CAAC;QAe9B,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,CAAC;IAdD,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,CAAC,CAAC;IAExD,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAYM,WAAW;QACd,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAEM,IAAI,CAAC,MAAoB;QAC5B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAClD,CAAC;CACJ;AAUD,MAAM,OAAO,WAAW;IAapB,YACqB,YAAiC,EAClD,QAA8B,EACb,UAAyC,EACzC,kBAA4C,EAC5C,OAA0B,EAC1B,MAAwB;QALxB,iBAAY,GAAZ,YAAY,CAAqB;QAEjC,eAAU,GAAV,UAAU,CAA+B;QACzC,uBAAkB,GAAlB,kBAAkB,CAA0B;QAC5C,YAAO,GAAP,OAAO,CAAmB;QAC1B,WAAM,GAAN,MAAM,CAAkB;QAhB7C,oBAAoB;QACH,YAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;QAClD,+GAA+G;QAC/G,mCAAmC;QAClB,mBAAc,GAAgC,IAAI,GAAG,EAAE,CAAC;QACzE,qDAAqD;QACpC,oBAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;QAYtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YAC9B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE;gBAChD,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC,CAAC;aAC/E;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAc;;QAC/B,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,CAAC,mCAAI,MAAM,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAExE,OAAO,IAAI,UAAU,CACjB,GAAG,WAAW,CAAC,QAAQ,IAAI,SAAS,EAAE,EACtC,IAAI,CAAC,YAAY,EACjB,KAAK,IAAI,EAAE;YACP,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzD,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB;oBACI,SAAS,EAAE,yBAAyB;oBACpC,EAAE,EAAE,SAAS;iBAChB,EACD,KAAK,CACR,CAAC;gBACF,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,SAAS,EAAE;YACpD,oDAAoD;YACpD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAC1E,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;SAChF;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,IAAI,UAAU,CACzB,GAAG,WAAW,CAAC,QAAQ,IAAI,QAAQ,CAAC,EAAE,EAAE,EACxC,IAAI,CAAC,YAAY;QACjB,oGAAoG;QACpG,oDAAoD;QACpD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CACnE,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;SACjB;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACtC,MAAM,CAAA,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;aAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,QAAQ,EAAQ,CAAC,CAAC;YAE3D,oEAAoE;YACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrC,MAAM,CAAA,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,mBAAmB,CAAC,MAAc,EAAE,KAAc;QACrD,IAAI,KAAK,EAAE;YACP,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;YAC3F,YAAY,CAAC,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACtC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACpB,SAAoC,EACpC,YAAyD;QAEzD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,EAAE,CAAC;SACb;QACD,IAAI,aAAa,CAAC;QAClB,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC5D,IAAI,OAAO,EAAE;YACT,aAAa,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;SAC/C;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC;aACtC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7E,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,IAAI,CAAC,QAA8B;;QACvC,IAAI,QAAQ,CAAC,GAAG,EAAE;YACd,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;YACnE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;SACrG;QACD,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,uBAAuB;YAClC,KAAK,EAAE,MAAA,MAAA,QAAQ,CAAC,GAAG,0CAAE,MAAM,mCAAI,CAAC;YAChC,aAAa,EAAE,MAAA,QAAQ,CAAC,aAAa,0CAAE,MAAM;SAChD,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,EAAE,GAAG,OAAO,IAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3F,MAAM,MAAM,GAA2B,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QACvD;;;YAGI;QACJ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACpC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH;;;;;;WAMG;QACH,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;YAClC,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE;gBACnD,oGAAoG;gBACpG,kDAAkD;gBAClD,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;aACvE;SACJ;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,YAAsB;;QAC5C,oGAAoG;QACpG,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;YAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnC,MAAM,CACF,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,QAAQ,EAC/D,KAAK,CAAC,8CAA8C,CACvD,CAAC;YACF,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAE5B,mGAAmG;YACnG,mFAAmF;YACnF,IAAI,MAAA,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,CAAC,EAAE;gBACjC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAClC,SAAS;aACZ;YACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC/B;IACL,CAAC;IAEM,SAAS;QACZ,6GAA6G;QAC7G,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;QACtG,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAC1E,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACvB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE;YACnD,OAAO,CAAC,OAAO,CACX,WAAW,CAAC,qBAAqB,EACjC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAC3D,CAAC;SACL;QAED,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAEM,gBAAgB,CAAC,KAA0B;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EACpD,KAAK,CAAC,4DAA4D,CAAC,CAAC;QACxE,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzE,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,KAAK,EAAE;YACtC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;YAC9F,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC/B;QACD,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjG,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC/B,CAAC;;AA7OsB,oBAAQ,GAAG,QAAQ,CAAC;AACnB,iCAAqB,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { generateHandleContextPath, SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IGarbageCollectionData, ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\n\n/**\n * This class represents blob (long string)\n * This object is used only when creating (writing) new blob and serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * DataObject.request() recognizes requests in the form of `/blobs/<id>`\n * and loads blob.\n */\nexport class BlobHandle implements IFluidHandle<ArrayBufferLike> {\n    private attached: boolean = false;\n\n    public get IFluidHandle(): IFluidHandle { return this; }\n\n    public get isAttached(): boolean {\n        return this.attached;\n    }\n\n    public readonly absolutePath: string;\n\n    constructor(\n        public readonly path: string,\n        public readonly routeContext: IFluidHandleContext,\n        public get: () => Promise<any>,\n    ) {\n        this.absolutePath = generateHandleContextPath(path, this.routeContext);\n    }\n\n    public attachGraph() {\n        this.attached = true;\n    }\n\n    public bind(handle: IFluidHandle) {\n        throw new Error(\"Cannot bind to blob handle\");\n    }\n}\n\n/**\n * Information from a snapshot needed to load BlobManager\n */\nexport interface IBlobManagerLoadInfo {\n    ids?: string[];\n    redirectTable?: [string, string][];\n}\n\nexport class BlobManager {\n    public static readonly basePath = \"_blobs\";\n    private static readonly redirectTableBlobName = \".redirectTable\";\n    // uploaded blob IDs\n    private readonly blobIds: Set<string> = new Set();\n    // blobs for which upload is pending. maps to a promise that will resolve once the blob has been uploaded and a\n    // BlobAttach op has round-tripped.\n    private readonly pendingBlobIds: Map<string, Deferred<void>> = new Map();\n    // blobs uploaded while detached; cleared upon attach\n    private readonly detachedBlobIds: Set<string> = new Set();\n    // map of detached blob IDs to IDs used by storage. used to support blob handles given out while detached\n    private redirectTable: Map<string, string> | undefined;\n\n    constructor(\n        private readonly routeContext: IFluidHandleContext,\n        snapshot: IBlobManagerLoadInfo,\n        private readonly getStorage: () => IDocumentStorageService,\n        private readonly attachBlobCallback: (blobId: string) => void,\n        private readonly runtime: IContainerRuntime,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.runtime.once(\"dispose\", () => {\n            for (const promise of this.pendingBlobIds.values()) {\n                promise.reject(new Error(\"runtime disposed while blobAttach op in flight\"));\n            }\n        });\n        this.load(snapshot);\n    }\n\n    private hasBlob(id: string): boolean {\n        return this.blobIds.has(id) || this.detachedBlobIds.has(id);\n    }\n\n    public async getBlob(blobId: string): Promise<IFluidHandle<ArrayBufferLike>> {\n        const storageId = this.redirectTable?.get(blobId) ?? blobId;\n        assert(this.hasBlob(storageId), 0x11f /* \"requesting unknown blobs\" */);\n\n        return new BlobHandle(\n            `${BlobManager.basePath}/${storageId}`,\n            this.routeContext,\n            async () => {\n                return this.getStorage().readBlob(storageId).catch((error) => {\n                    this.logger.sendErrorEvent(\n                        {\n                            eventName: \"AttachmentReadBlobError\",\n                            id: storageId,\n                        },\n                        error,\n                    );\n                    throw error;\n                });\n            },\n        );\n    }\n\n    public async createBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n        if (this.runtime.attachState === AttachState.Attaching) {\n            // blob upload is not supported in \"Attaching\" state\n            this.logger.sendTelemetryEvent({ eventName: \"CreateBlobWhileAttaching\" });\n            await new Promise<void>((resolve) => this.runtime.once(\"attached\", resolve));\n        }\n\n        const response = await this.getStorage().createBlob(blob);\n        const handle = new BlobHandle(\n            `${BlobManager.basePath}/${response.id}`,\n            this.routeContext,\n            // get() should go through BlobManager.getBlob() so handles created while detached can be redirected\n            // to the correct storage id after they are uploaded\n            async () => this.getBlob(response.id).then(async (h) => h.get()),\n        );\n\n        if (this.runtime.attachState === AttachState.Detached) {\n            this.detachedBlobIds.add(response.id);\n            return handle;\n        }\n\n        // Note - server will de-dup blobs, so we might get existing blobId!\n        if (this.pendingBlobIds.has(response.id)) {\n            await this.pendingBlobIds.get(response.id)?.promise;\n        } else if (!this.blobIds.has(response.id)) {\n            this.pendingBlobIds.set(response.id, new Deferred<void>());\n\n            // send blob attach op and wait until we see it to return the handle\n            this.attachBlobCallback(response.id);\n            await this.pendingBlobIds.get(response.id)?.promise;\n        }\n\n        return handle;\n    }\n\n    public processBlobAttachOp(blobId: string, local: boolean) {\n        if (local) {\n            const pendingBlobP = this.pendingBlobIds.get(blobId);\n            assert(pendingBlobP !== undefined, 0x1f8 /* \"local BlobAttach op with no pending blob\" */);\n            pendingBlobP.resolve();\n            this.pendingBlobIds.delete(blobId);\n        }\n        this.blobIds.add(blobId);\n    }\n\n    /**\n     * Reads blobs needed to load BlobManager from storage.\n     */\n    public static async load(\n        blobsTree: ISnapshotTree | undefined,\n        tryFetchBlob: (id: string) => Promise<[string, string][]>,\n    ): Promise<IBlobManagerLoadInfo> {\n        if (!blobsTree) {\n            return {};\n        }\n        let redirectTable;\n        const tableId = blobsTree.blobs[this.redirectTableBlobName];\n        if (tableId) {\n            redirectTable = await tryFetchBlob(tableId);\n        }\n        const ids = Object.entries(blobsTree.blobs)\n            .filter(([k, _]) => k !== this.redirectTableBlobName).map(([_, v]) => v);\n        return { ids, redirectTable };\n    }\n\n    /**\n     * Load a set of previously attached blob IDs from a previous snapshot. Note\n     * that BlobManager tracking and reporting attached blobs is a temporary\n     * solution since storage expects attached blobs to be reported and any that\n     * are not reported as attached may be GCed. In the future attached blob\n     * IDs will be collected at summarization time, and runtime will not care\n     * about the existence or specific formatting of this tree in returned\n     * snapshots.\n     *\n     * @param blobsTree - Tree containing IDs of previously attached blobs. This\n     * corresponds to snapshot() below. We look for the IDs in the blob entries\n     * of the tree since the both the r11s and SPO drivers replace the\n     * attachment types returned in snapshot() with blobs.\n     */\n    private load(snapshot: IBlobManagerLoadInfo): void {\n        if (snapshot.ids) {\n            const detached = this.runtime.attachState === AttachState.Detached;\n            snapshot.ids.map((entry) => detached ? this.detachedBlobIds.add(entry) : this.blobIds.add(entry));\n        }\n        if (snapshot.redirectTable) {\n            this.redirectTable = new Map(snapshot.redirectTable);\n        }\n        this.logger.sendTelemetryEvent({\n            eventName: \"AttachmentBlobsLoaded\",\n            count: snapshot.ids?.length ?? 0,\n            redirectTable: snapshot.redirectTable?.length,\n        });\n    }\n\n    /**\n     * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be\n     * individually referenced by storing its handle in a referenced DDS. Returns the list of blob ids as GC nodes.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data. BlobManager doesn't care\n     * about this for now because the data is a simple list of blob ids.\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        const getGCNodePath = (blobId: string) => { return `/${BlobManager.basePath}/${blobId}`; };\n        const gcData: IGarbageCollectionData = { gcNodes: {} };\n        /**\n          * The node path is of the format `/_blobs/blobId`. This path must match the path of the blob handle returned\n          * by the createBlob API because blobs are marked referenced by storing these handles in a referenced DDS.\n          */\n        this.blobIds.forEach((blobId: string) => {\n            gcData.gcNodes[getGCNodePath(blobId)] = [];\n        });\n\n        /**\n         * For all blobs in the redirect table, the handle returned on creation is based off of the localId. So, these\n         * nodes can be referenced by storing the localId handle. When that happens, the corresponding storageId node\n         * must also be marked referenced. So, we add a route from the localId node to the storageId node.\n         * Note that because of de-duping, there can be multiple localIds that all redirect to the same storageId or\n         * a blob may be referenced via its storageId handle.\n         */\n        if (this.redirectTable !== undefined) {\n            for (const [localId, storageId] of this.redirectTable) {\n                // Add node for the localId and add a route to the storageId node. The storageId node will have been\n                // added above when adding nodes for this.blobIds.\n                gcData.gcNodes[getGCNodePath(localId)] = [getGCNodePath(storageId)];\n            }\n        }\n\n        return gcData;\n    }\n\n    /**\n     * When running GC in test mode, this is called to delete blobs that are unused.\n     * @param unusedRoutes - These are the blob node ids that are unused and should be deleted.\n     */\n    public deleteUnusedRoutes(unusedRoutes: string[]): void {\n        // The routes or blob node paths are in the same format as returned in getGCData - `/_blobs/blobId`.\n        for (const route of unusedRoutes) {\n            const pathParts = route.split(\"/\");\n            assert(\n                pathParts.length === 3 && pathParts[1] === BlobManager.basePath,\n                0x2d5 /* \"Invalid blob node id in unused routes.\" */,\n            );\n            const blobId = pathParts[2];\n\n            // The unused blobId could be a localId. If so, remove it from the redirect table and continue. The\n            // corresponding storageId may still be used either directly or via other localIds.\n            if (this.redirectTable?.has(blobId)) {\n                this.redirectTable.delete(blobId);\n                continue;\n            }\n            this.blobIds.delete(blobId);\n        }\n    }\n\n    public summarize(): ISummaryTreeWithStats {\n        // If we have a redirect table it means the container is about to transition to \"Attaching\" state, so we need\n        // to return an actual snapshot containing all the real storage IDs we know about.\n        const attachingOrAttached = !!this.redirectTable || this.runtime.attachState !== AttachState.Detached;\n        const blobIds = attachingOrAttached ? this.blobIds : this.detachedBlobIds;\n        const builder = new SummaryTreeBuilder();\n        blobIds.forEach((blobId) => {\n            builder.addAttachment(blobId);\n        });\n\n        if (this.redirectTable && this.redirectTable.size > 0) {\n            builder.addBlob(\n                BlobManager.redirectTableBlobName,\n                JSON.stringify(Array.from(this.redirectTable.entries())),\n            );\n        }\n\n        return builder.getSummaryTree();\n    }\n\n    public setRedirectTable(table: Map<string, string>) {\n        assert(this.runtime.attachState === AttachState.Detached,\n            0x252 /* \"redirect table can only be set in detached container\" */);\n        assert(!this.redirectTable, 0x253 /* \"redirect table already exists\" */);\n        for (const [localId, storageId] of table) {\n            assert(this.detachedBlobIds.delete(localId), 0x254 /* \"unrecognized id in redirect table\" */);\n            this.blobIds.add(storageId);\n        }\n        assert(this.detachedBlobIds.size === 0, 0x255 /* \"detached blob id absent in redirect table\" */);\n        this.redirectTable = table;\n    }\n}\n"]}

package/lib/containerRuntime.d.ts

@@ -34,25 +34,31 @@ export interface ContainerRuntimeMessage {
     type: ContainerMessageType;
 }
 export interface IGCRuntimeOptions {
-    disableGC?: boolean;
     /**
-     * Flag representing the summary's preference for allowing garbage collection.
-     * This is stored in the summary and unchangeable (for now). So this runtime option
-     * only takes affect on new containers.
-     * Currently if this is set to false, it will take priority and any container will
-     * never run GC.
+     * Flag that if true, will enable running garbage collection (GC) in a container. GC has mark phase and sweep phase.
+     * In mark phase, unreferenced objects are identified and marked as such in the summary. This option enables the
+     * mark phase.
+     * In sweep phase, unreferenced objects are eventually deleted from the container if they meet certain conditions.
+     * Sweep phase can be enabled via the "sweepAllowed" option.
+     * Note: This setting becomes part of the container's summary and cannot be changed.
      */
     gcAllowed?: boolean;
     /**
-     * Flag that will bypass optimizations and generate GC data for all nodes irrespective of whether the node
-     * changed or not.
+     * Flag that if true, enables GC's sweep phase which will eventually delete unreferenced objects from the container.
+     * This flag should only be set to true if "gcAllowed" is true.
+     * Note: This setting becomes part of the container's summary and cannot be changed.
      */
-    runFullGC?: boolean;
+    sweepAllowed?: boolean;
+    /**
+     * Flag that will disable garbage collection if set to true. Can be used to disable running GC on container where
+     * is allowed via the gcAllowed option.
+     */
+    disableGC?: boolean;
     /**
-     * Flag that if true, will run sweep which may delete unused objects that meet certain criteria. Only takes
-     * effect if GC is enabled.
+     * Flag that will bypass optimizations and generate GC data for all nodes irrespective of whether a node
+     * changed or not.
      */
-    runSweep?: boolean;
+    runFullGC?: boolean;
     /**
      * Allows additional GC options to be passed.
      */
@@ -185,7 +191,6 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     private readonly containerScope;
     readonly logger: ITelemetryLogger;
     private readonly requestHandler?;
-    private _storage?;
     get IContainerRuntime(): this;
     get IFluidRouter(): this;
     /**
@@ -263,7 +268,11 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     private get summarizer();
     private get summariesDisabled();
     private readonly createContainerMetadata;
-    private summaryCount;
+    /**
+     * The summary number of the next summary that will be generated for this container. This is incremented every time
+     * a summary is generated.
+     */
+    private nextSummaryNumber;
     private readonly opTracker;
     private constructor();
     dispose(error?: Error): void;
@@ -279,7 +288,8 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      */
     resolveHandle(request: IRequest): Promise<IResponse>;
     private getDataStoreFromRequest;
-    private formMetadata;
+    /** Adds the container's metadata to the given summary tree. */
+    private addMetadataToSummary;
     private addContainerStateToSummary;
     private shouldContinueReconnecting;
     private resetReconnectCount;
@@ -411,8 +421,8 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      */
     getCurrentReferenceTimestampMs(): number | undefined;
     /**
-     * Returns the type of the GC node. Currently, there are nodes that belong to data store and nodes that belong
-     * to the blob manager.
+     * Returns the type of the GC node. Currently, there are nodes that belong to the root ("/"), data stores or
+     * blob manager.
      */
     getNodeType(nodePath: string): GCNodeType;
     /**