@fluidframework/container-loader 1.0.0 → 1.1.0-76254

package/lib/protocolTreeDocumentStorageService.d.ts

@@ -12,8 +12,8 @@ export declare class ProtocolTreeStorageService implements IDocumentStorageServi
     get policies(): import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined;
     get repositoryUrl(): string;
     get disposed(): boolean;
-    getSnapshotTree: (version?: import("@fluidframework/protocol-definitions").IVersion | undefined) => Promise<import("@fluidframework/protocol-definitions").ISnapshotTree | null>;
-    getVersions: (versionId: string | null, count: number) => Promise<import("@fluidframework/protocol-definitions").IVersion[]>;
+    getSnapshotTree: (version?: import("@fluidframework/protocol-definitions").IVersion | undefined, scenarioName?: string | undefined) => Promise<import("@fluidframework/protocol-definitions").ISnapshotTree | null>;
+    getVersions: (versionId: string | null, count: number, scenarioName?: string | undefined) => Promise<import("@fluidframework/protocol-definitions").IVersion[]>;
     createBlob: (file: ArrayBufferLike) => Promise<import("@fluidframework/protocol-definitions").ICreateBlobResponse>;
     readBlob: (id: string) => Promise<ArrayBufferLike>;
     downloadSummary: (handle: import("@fluidframework/protocol-definitions").ISummaryHandle) => Promise<ISummaryTree>;

package/lib/protocolTreeDocumentStorageService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocolTreeDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/protocolTreeDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EACH,uBAAuB,EACvB,eAAe,EAClB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C,qBAAa,0BAA2B,YAAW,uBAAuB,EAAE,WAAW;IAE/E,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;gBADpB,sBAAsB,EAAE,uBAAuB,GAAG,WAAW,EAC7D,oBAAoB,EAAE,MAAM,YAAY;IAG7D,IAAW,QAAQ,6FAElB;IACD,IAAW,aAAa,WAEvB;IACD,IAAW,QAAQ,YAElB;IAED,eAAe,kKAAiF;IAChG,WAAW,kHAA6E;IACxF,UAAU,yGAA4E;IACtF,QAAQ,2CAA0E;IAClF,eAAe,mGAAiF;IAChG,OAAO,sCAAyE;IAE1E,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;CAMnG"}
+{"version":3,"file":"protocolTreeDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/protocolTreeDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EACH,uBAAuB,EACvB,eAAe,EAClB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C,qBAAa,0BAA2B,YAAW,uBAAuB,EAAE,WAAW;IAE/E,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;gBADpB,sBAAsB,EAAE,uBAAuB,GAAG,WAAW,EAC7D,oBAAoB,EAAE,MAAM,YAAY;IAG7D,IAAW,QAAQ,6FAElB;IACD,IAAW,aAAa,WAEvB;IACD,IAAW,QAAQ,YAElB;IAED,eAAe,qMAAiF;IAChG,WAAW,qJAA6E;IACxF,UAAU,yGAA4E;IACtF,QAAQ,2CAA0E;IAClF,eAAe,mGAAiF;IAChG,OAAO,sCAAyE;IAE1E,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;CAMnG"}

package/lib/retriableDocumentStorageService.d.ts

@@ -14,9 +14,9 @@ export declare class RetriableDocumentStorageService implements IDocumentStorage
     get disposed(): boolean;
     dispose(): void;
     get repositoryUrl(): string;
-    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
+    getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
     readBlob(id: string): Promise<ArrayBufferLike>;
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getVersions(versionId: string | null, count: number, scenarioName?: string): Promise<IVersion[]>;
     uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
     downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
     createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;

package/lib/retriableDocumentStorageService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"retriableDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/retriableDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACH,uBAAuB,EACvB,+BAA+B,EAC/B,eAAe,EAClB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACH,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,QAAQ,EACX,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGnF,qBAAa,+BAAgC,YAAW,uBAAuB,EAAE,WAAW;IAGpF,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM;IAH3B,OAAO,CAAC,SAAS,CAAS;gBAEL,sBAAsB,EAAE,uBAAuB,EAC/C,MAAM,EAAE,gBAAgB;IAI7C,IAAW,QAAQ,IAAI,+BAA+B,GAAG,SAAS,CAEjE;IACD,IAAW,QAAQ,YAA6B;IACzC,OAAO;IAId,IAAW,aAAa,IAAI,MAAM,CAEjC;IAEY,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAOlE,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAO9C,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOzE,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuB1F,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAO9D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAO5E,OAAO,CAAC,oBAAoB;YAQd,YAAY;CAU7B"}
+{"version":3,"file":"retriableDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/retriableDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACH,uBAAuB,EACvB,+BAA+B,EAC/B,eAAe,EAClB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACH,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,QAAQ,EACX,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGnF,qBAAa,+BAAgC,YAAW,uBAAuB,EAAE,WAAW;IAGpF,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM;IAH3B,OAAO,CAAC,SAAS,CAAS;gBAEL,sBAAsB,EAAE,uBAAuB,EAC/C,MAAM,EAAE,gBAAgB;IAI7C,IAAW,QAAQ,IAAI,+BAA+B,GAAG,SAAS,CAEjE;IACD,IAAW,QAAQ,YAA6B;IACzC,OAAO;IAId,IAAW,aAAa,IAAI,MAAM,CAEjC;IAEY,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAOzF,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAO9C,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOhG,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuB1F,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAO9D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAO5E,OAAO,CAAC,oBAAoB;YAQd,YAAY;CAU7B"}

package/lib/retriableDocumentStorageService.js

@@ -21,14 +21,14 @@ export class RetriableDocumentStorageService {
     get repositoryUrl() {
         return this.internalStorageService.repositoryUrl;
     }
-    async getSnapshotTree(version) {
-        return this.runWithRetry(async () => this.internalStorageService.getSnapshotTree(version), "storage_getSnapshotTree");
+    async getSnapshotTree(version, scenarioName) {
+        return this.runWithRetry(async () => this.internalStorageService.getSnapshotTree(version, scenarioName), "storage_getSnapshotTree");
     }
     async readBlob(id) {
         return this.runWithRetry(async () => this.internalStorageService.readBlob(id), "storage_readBlob");
     }
-    async getVersions(versionId, count) {
-        return this.runWithRetry(async () => this.internalStorageService.getVersions(versionId, count), "storage_getVersions");
+    async getVersions(versionId, count, scenarioName) {
+        return this.runWithRetry(async () => this.internalStorageService.getVersions(versionId, count, scenarioName), "storage_getVersions");
     }
     async uploadSummaryWithContext(summary, context) {
         // Not using retry loop here. Couple reasons:

package/lib/retriableDocumentStorageService.js.map

@@ -1 +1 @@
-{"version":3,"file":"retriableDocumentStorageService.js","sourceRoot":"","sources":["../src/retriableDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAc/D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,MAAM,OAAO,+BAA+B;IAExC,YACqB,sBAA+C,EAC/C,MAAwB;QADxB,2BAAsB,GAAtB,sBAAsB,CAAyB;QAC/C,WAAM,GAAN,MAAM,CAAkB;QAHrC,cAAS,GAAG,KAAK,CAAC;IAK1B,CAAC;IAED,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;IAChD,CAAC;IACD,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACzC,OAAO;QACV,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC;IACrD,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAkB;QAC3C,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,EAChE,yBAAyB,CAC5B,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,EACpD,kBAAkB,CACrB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa;QAC5D,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,EACrE,qBAAqB,CACxB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,OAAqB,EAAE,OAAwB;QACjF,6CAA6C;QAC7C,yFAAyF;QACzF,uGAAuG;QACvG,4GAA4G;QAC5G,mGAAmG;QACnG,0GAA0G;QAC1G,4GAA4G;QAC5G,8BAA8B;QAC9B,kEAAkE;QAClE,MAAM,CAAC,CAAC,OAAO,CAAC,uBAAuB,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,EAChF,KAAK,CAAC,kEAAkE,CAAC,CAAC;QAC9E,IAAI,OAAO,CAAC,uBAAuB,KAAK,CAAC,EAAE;YACvC,OAAO,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACjF;QAED,4DAA4D;QAC5D,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClF,kCAAkC,CACrC,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAsB;QAC/C,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,MAAM,CAAC,EAC/D,yBAAyB,CAC5B,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QACzC,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,EACxD,oBAAoB,CACvB,CAAC;IACN,CAAC;IAEO,oBAAoB;QACxB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,4DAA4D;YAC5D,MAAM,IAAI,YAAY,CAAC,2CAA2C,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;SAC5F;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,YAAY,CAAI,GAAqB,EAAE,QAAgB;QACjE,OAAO,YAAY,CACf,GAAG,EACH,QAAQ,EACR,IAAI,CAAC,MAAM,EACX;YACI,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE;SAC7C,CACJ,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { GenericError } from \"@fluidframework/container-utils\";\nimport {\n    IDocumentStorageService,\n    IDocumentStorageServicePolicies,\n    ISummaryContext,\n} from \"@fluidframework/driver-definitions\";\nimport {\n    ICreateBlobResponse,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IDisposable, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { runWithRetry } from \"@fluidframework/driver-utils\";\n\nexport class RetriableDocumentStorageService implements IDocumentStorageService, IDisposable {\n    private _disposed = false;\n    constructor(\n        private readonly internalStorageService: IDocumentStorageService,\n        private readonly logger: ITelemetryLogger,\n    ) {\n    }\n\n    public get policies(): IDocumentStorageServicePolicies | undefined {\n        return this.internalStorageService.policies;\n    }\n    public get disposed() { return this._disposed; }\n    public dispose() {\n        this._disposed = true;\n    }\n\n    public get repositoryUrl(): string {\n        return this.internalStorageService.repositoryUrl;\n    }\n\n    public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.getSnapshotTree(version),\n            \"storage_getSnapshotTree\",\n        );\n    }\n\n    public async readBlob(id: string): Promise<ArrayBufferLike> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.readBlob(id),\n            \"storage_readBlob\",\n        );\n    }\n\n    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.getVersions(versionId, count),\n            \"storage_getVersions\",\n        );\n    }\n\n    public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {\n        // Not using retry loop here. Couple reasons:\n        // 1. If client lost connectivity, then retry loop will result in uploading stale summary\n        //    by stale summarizer after connectivity comes back. It will cause failures for this client and for\n        //    real (new) summarizer. This problem in particular should be solved in future by supplying abort handle\n        //    on all APIs and caller (ContainerRuntime.submitSummary) aborting call on loss of connectivity\n        // 2. Similar, if we get 429 with retryAfter = 10 minutes, it's likely not the right call to retry summary\n        //    upload in 10 minutes - it's better to keep processing ops and retry later. Though caller needs to take\n        //    retryAfter into account!\n        // But retry loop is required for creation flow (Container.attach)\n        assert((context.referenceSequenceNumber === 0) === (context.ackHandle === undefined),\n            0x251 /* \"creation summary has to have seq=0 && handle === undefined\" */);\n        if (context.referenceSequenceNumber !== 0) {\n            return this.internalStorageService.uploadSummaryWithContext(summary, context);\n        }\n\n        // Creation flow with attachment blobs - need to do retries!\n        return this.runWithRetry(\n            async () => this.internalStorageService.uploadSummaryWithContext(summary, context),\n            \"storage_uploadSummaryWithContext\",\n        );\n    }\n\n    public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.downloadSummary(handle),\n            \"storage_downloadSummary\",\n        );\n    }\n\n    public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.createBlob(file),\n            \"storage_createBlob\",\n        );\n    }\n\n    private checkStorageDisposed() {\n        if (this._disposed) {\n            // pre-0.58 error message: storageServiceDisposedCannotRetry\n            throw new GenericError(\"Storage Service is disposed. Cannot retry\", { canRetry: false });\n        }\n        return undefined;\n    }\n\n    private async runWithRetry<T>(api: () => Promise<T>, callName: string): Promise<T> {\n        return runWithRetry(\n            api,\n            callName,\n            this.logger,\n            {\n                onRetry: () => this.checkStorageDisposed(),\n            },\n        );\n    }\n}\n"]}
+{"version":3,"file":"retriableDocumentStorageService.js","sourceRoot":"","sources":["../src/retriableDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAc/D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,MAAM,OAAO,+BAA+B;IAExC,YACqB,sBAA+C,EAC/C,MAAwB;QADxB,2BAAsB,GAAtB,sBAAsB,CAAyB;QAC/C,WAAM,GAAN,MAAM,CAAkB;QAHrC,cAAS,GAAG,KAAK,CAAC;IAK1B,CAAC;IAED,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;IAChD,CAAC;IACD,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACzC,OAAO;QACV,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC;IACrD,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAkB,EAAE,YAAqB;QAClE,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,YAAY,CAAC,EAC9E,yBAAyB,CAC5B,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,EACpD,kBAAkB,CACrB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa,EAAE,YAAqB;QACnF,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,EAAE,YAAY,CAAC,EACnF,qBAAqB,CACxB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,OAAqB,EAAE,OAAwB;QACjF,6CAA6C;QAC7C,yFAAyF;QACzF,uGAAuG;QACvG,4GAA4G;QAC5G,mGAAmG;QACnG,0GAA0G;QAC1G,4GAA4G;QAC5G,8BAA8B;QAC9B,kEAAkE;QAClE,MAAM,CAAC,CAAC,OAAO,CAAC,uBAAuB,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,EAChF,KAAK,CAAC,kEAAkE,CAAC,CAAC;QAC9E,IAAI,OAAO,CAAC,uBAAuB,KAAK,CAAC,EAAE;YACvC,OAAO,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACjF;QAED,4DAA4D;QAC5D,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClF,kCAAkC,CACrC,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAsB;QAC/C,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,MAAM,CAAC,EAC/D,yBAAyB,CAC5B,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QACzC,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,EACxD,oBAAoB,CACvB,CAAC;IACN,CAAC;IAEO,oBAAoB;QACxB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,4DAA4D;YAC5D,MAAM,IAAI,YAAY,CAAC,2CAA2C,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;SAC5F;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,YAAY,CAAI,GAAqB,EAAE,QAAgB;QACjE,OAAO,YAAY,CACf,GAAG,EACH,QAAQ,EACR,IAAI,CAAC,MAAM,EACX;YACI,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE;SAC7C,CACJ,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { GenericError } from \"@fluidframework/container-utils\";\nimport {\n    IDocumentStorageService,\n    IDocumentStorageServicePolicies,\n    ISummaryContext,\n} from \"@fluidframework/driver-definitions\";\nimport {\n    ICreateBlobResponse,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IDisposable, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { runWithRetry } from \"@fluidframework/driver-utils\";\n\nexport class RetriableDocumentStorageService implements IDocumentStorageService, IDisposable {\n    private _disposed = false;\n    constructor(\n        private readonly internalStorageService: IDocumentStorageService,\n        private readonly logger: ITelemetryLogger,\n    ) {\n    }\n\n    public get policies(): IDocumentStorageServicePolicies | undefined {\n        return this.internalStorageService.policies;\n    }\n    public get disposed() { return this._disposed; }\n    public dispose() {\n        this._disposed = true;\n    }\n\n    public get repositoryUrl(): string {\n        return this.internalStorageService.repositoryUrl;\n    }\n\n    public async getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.getSnapshotTree(version, scenarioName),\n            \"storage_getSnapshotTree\",\n        );\n    }\n\n    public async readBlob(id: string): Promise<ArrayBufferLike> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.readBlob(id),\n            \"storage_readBlob\",\n        );\n    }\n\n    public async getVersions(versionId: string | null, count: number, scenarioName?: string): Promise<IVersion[]> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.getVersions(versionId, count, scenarioName),\n            \"storage_getVersions\",\n        );\n    }\n\n    public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {\n        // Not using retry loop here. Couple reasons:\n        // 1. If client lost connectivity, then retry loop will result in uploading stale summary\n        //    by stale summarizer after connectivity comes back. It will cause failures for this client and for\n        //    real (new) summarizer. This problem in particular should be solved in future by supplying abort handle\n        //    on all APIs and caller (ContainerRuntime.submitSummary) aborting call on loss of connectivity\n        // 2. Similar, if we get 429 with retryAfter = 10 minutes, it's likely not the right call to retry summary\n        //    upload in 10 minutes - it's better to keep processing ops and retry later. Though caller needs to take\n        //    retryAfter into account!\n        // But retry loop is required for creation flow (Container.attach)\n        assert((context.referenceSequenceNumber === 0) === (context.ackHandle === undefined),\n            0x251 /* \"creation summary has to have seq=0 && handle === undefined\" */);\n        if (context.referenceSequenceNumber !== 0) {\n            return this.internalStorageService.uploadSummaryWithContext(summary, context);\n        }\n\n        // Creation flow with attachment blobs - need to do retries!\n        return this.runWithRetry(\n            async () => this.internalStorageService.uploadSummaryWithContext(summary, context),\n            \"storage_uploadSummaryWithContext\",\n        );\n    }\n\n    public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.downloadSummary(handle),\n            \"storage_downloadSummary\",\n        );\n    }\n\n    public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.createBlob(file),\n            \"storage_createBlob\",\n        );\n    }\n\n    private checkStorageDisposed() {\n        if (this._disposed) {\n            // pre-0.58 error message: storageServiceDisposedCannotRetry\n            throw new GenericError(\"Storage Service is disposed. Cannot retry\", { canRetry: false });\n        }\n        return undefined;\n    }\n\n    private async runWithRetry<T>(api: () => Promise<T>, callName: string): Promise<T> {\n        return runWithRetry(\n            api,\n            callName,\n            this.logger,\n            {\n                onRetry: () => this.checkStorageDisposed(),\n            },\n        );\n    }\n}\n"]}

package/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAe,MAAM,sCAAsC,CAAC;AAIhG,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAChE,aAAa,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC;KAAE,CAAC;IACpD,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,6BAA6B,CAAC;KAAE,CAAC;CAC7D;AAED,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACtC;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAW5D;AAqDD;;;;GAIG;AACH,wBAAgB,0CAA0C,CACtD,mBAAmB,EAAE,YAAY,EACjC,cAAc,EAAE,YAAY,GAC7B,6BAA6B,CAW/B;AAID,eAAO,MAAM,sCAAsC,8BAA+B,YAAY,kCAU7F,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,aAAa,GAAG,aAAa,CAE9E"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAe,MAAM,sCAAsC,CAAC;AAKhG,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAChE,aAAa,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC;KAAE,CAAC;IACpD,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,6BAA6B,CAAC;KAAE,CAAC;CAC7D;AAED,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACtC;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAW5D;AAqDD;;;;GAIG;AACH,wBAAgB,0CAA0C,CACtD,mBAAmB,EAAE,YAAY,EACjC,cAAc,EAAE,YAAY,GAC7B,6BAA6B,CAW/B;AAID,eAAO,MAAM,sCAAsC,8BAA+B,YAAY,kCAU7F,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,aAAa,GAAG,aAAa,CAE9E"}

package/lib/utils.js

@@ -6,11 +6,12 @@ import { parse } from "url";
 import { v4 as uuid } from "uuid";
 import { assert, stringToBuffer, Uint8ArrayToArrayBuffer, unreachableCase, } from "@fluidframework/common-utils";
 import { SummaryType } from "@fluidframework/protocol-definitions";
+import { LoggingError } from "@fluidframework/telemetry-utils";
 export function parseUrl(url) {
     var _a;
     const parsed = parse(url, true);
     if (typeof parsed.pathname !== "string") {
-        throw new Error("Failed to parse pathname");
+        throw new LoggingError("Failed to parse pathname");
     }
     const query = (_a = parsed.search) !== null && _a !== void 0 ? _a : "";
     const regex = /^\/([^/]*\/[^/]*)(\/?.*)$/;
@@ -57,7 +58,7 @@ function convertSummaryToSnapshotWithEmbeddedBlobContents(summary) {
                 break;
             }
             case SummaryType.Handle:
-                throw new Error("No handles should be there in summary in detached container!!");
+                throw new LoggingError("No handles should be there in summary in detached container!!");
                 break;
             default: {
                 unreachableCase(summaryObject, `Unknown tree type ${summaryObject.type}`);

package/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,KAAK,CAAC;AAC5B,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EACH,MAAM,EACN,cAAc,EACd,uBAAuB,EACvB,eAAe,GAClB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAA+B,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAqBhG,MAAM,UAAU,QAAQ,CAAC,GAAW;;IAChC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;KAC/C;IACD,MAAM,KAAK,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC;IAClC,MAAM,KAAK,GAAG,2BAA2B,CAAC;IAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,MAAK,CAAC,CAAC;QACxB,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAiB,EAAE;QAClF,CAAC,CAAC,SAAS,CAAC;AACpB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,gDAAgD,CACrD,OAAqB;IAErB,MAAM,QAAQ,GAAkC;QAC5C,KAAK,EAAE,EAAE;QACT,aAAa,EAAE,EAAE;QACjB,KAAK,EAAE,EAAE;QACT,EAAE,EAAE,IAAI,EAAE;QACV,YAAY,EAAE,OAAO,CAAC,YAAY;KACrC,CAAC;IACF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExC,QAAQ,aAAa,CAAC,IAAI,EAAE;YACxB,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,gDAAgD,CAAC,aAAa,CAAC,CAAC;gBACtF,MAAM;aACT;YACD,KAAK,WAAW,CAAC,UAAU;gBACvB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC;gBACvC,MAAM;YACV,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC;gBACtB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;gBAC7B,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;oBAC7D,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACnG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC;gBAC/C,MAAM;aACT;YACD,KAAK,WAAW,CAAC,MAAM;gBACnB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;gBACjF,MAAM;YACV,OAAO,CAAC,CAAC;gBACL,eAAe,CAAC,aAAa,EAAE,qBAAsB,aAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;aACtF;SACJ;KACJ;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0CAA0C,CACtD,mBAAiC,EACjC,cAA4B;IAE5B,+DAA+D;IAC/D,MAAM,eAAe,GAAiB;QAClC,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,oBAAO,cAAc,CAAC,IAAI,CAAE;KACnC,CAAC;IAEF,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,mBAAmB,CAAC;IACxD,MAAM,4BAA4B,GAC9B,gDAAgD,CAAC,eAAe,CAAC,CAAC;IACtE,OAAO,4BAA4B,CAAC;AACxC,CAAC;AAED,+GAA+G;AAC/G,0CAA0C;AAC1C,MAAM,CAAC,MAAM,sCAAsC,GAAG,CAAC,yBAAuC,EAAE,EAAE;IAC9F,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;IACxF,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;IAC9E,MAAM,CAAC,mBAAmB,KAAK,SAAS,IAAI,cAAc,KAAK,SAAS,EACpE,KAAK,CAAC,wDAAwD,CAAC,CAAC;IACpE,MAAM,4BAA4B,GAAG,0CAA0C,CAC3E,mBAAmB,EACnB,cAAc,CACjB,CAAC;IACF,OAAO,4BAA4B,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,UAAU,uBAAuB,CAAC,QAAuB;IAC3D,OAAO,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AAClF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { parse } from \"url\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    assert,\n    stringToBuffer,\n    Uint8ArrayToArrayBuffer,\n    unreachableCase,\n} from \"@fluidframework/common-utils\";\nimport { ISummaryTree, ISnapshotTree, SummaryType } from \"@fluidframework/protocol-definitions\";\n\n// This is used when we rehydrate a container from the snapshot. Here we put the blob contents\n// in separate property: blobContents.\nexport interface ISnapshotTreeWithBlobContents extends ISnapshotTree {\n    blobsContents: { [path: string]: ArrayBufferLike; };\n    trees: { [path: string]: ISnapshotTreeWithBlobContents; };\n}\n\nexport interface IParsedUrl {\n    id: string;\n    path: string;\n    query: string;\n    /**\n     * Null means do not use snapshots, undefined means load latest snapshot\n     * otherwise it's version ID passed to IDocumentStorageService.getVersions() to figure out what snapshot to use.\n     * If needed, can add undefined which is treated by Container.load() as load latest snapshot.\n     */\n    version: string | null | undefined;\n}\n\nexport function parseUrl(url: string): IParsedUrl | undefined {\n    const parsed = parse(url, true);\n    if (typeof parsed.pathname !== \"string\") {\n        throw new Error(\"Failed to parse pathname\");\n    }\n    const query = parsed.search ?? \"\";\n    const regex = /^\\/([^/]*\\/[^/]*)(\\/?.*)$/;\n    const match = regex.exec(parsed.pathname);\n    return (match?.length === 3)\n        ? { id: match[1], path: match[2], query, version: parsed.query.version as string }\n        : undefined;\n}\n\n/**\n * Converts summary tree (for upload) to snapshot tree (for download).\n * Summary tree blobs contain contents, but snapshot tree blobs normally\n * contain IDs pointing to storage. This will create 2 blob entries in the\n * snapshot tree for each blob in the summary tree. One will be the regular\n * path pointing to a uniquely generated ID. Then there will be another\n * entry with the path as that uniquely generated ID, and value as the\n * blob contents as a base-64 string.\n * @param summary - summary to convert\n */\nfunction convertSummaryToSnapshotWithEmbeddedBlobContents(\n    summary: ISummaryTree,\n): ISnapshotTreeWithBlobContents {\n    const treeNode: ISnapshotTreeWithBlobContents = {\n        blobs: {},\n        blobsContents: {},\n        trees: {},\n        id: uuid(),\n        unreferenced: summary.unreferenced,\n    };\n    const keys = Object.keys(summary.tree);\n    for (const key of keys) {\n        const summaryObject = summary.tree[key];\n\n        switch (summaryObject.type) {\n            case SummaryType.Tree: {\n                treeNode.trees[key] = convertSummaryToSnapshotWithEmbeddedBlobContents(summaryObject);\n                break;\n            }\n            case SummaryType.Attachment:\n                treeNode.blobs[key] = summaryObject.id;\n                break;\n            case SummaryType.Blob: {\n                const blobId = uuid();\n                treeNode.blobs[key] = blobId;\n                const contentBuffer = typeof summaryObject.content === \"string\" ?\n                    stringToBuffer(summaryObject.content, \"utf8\") : Uint8ArrayToArrayBuffer(summaryObject.content);\n                treeNode.blobsContents[blobId] = contentBuffer;\n                break;\n            }\n            case SummaryType.Handle:\n                throw new Error(\"No handles should be there in summary in detached container!!\");\n                break;\n            default: {\n                unreachableCase(summaryObject, `Unknown tree type ${(summaryObject as any).type}`);\n            }\n        }\n    }\n    return treeNode;\n}\n\n/**\n * Combine and convert protocol and app summary tree to format which is readable by container while rehydrating.\n * @param protocolSummaryTree - Protocol Summary Tree\n * @param appSummaryTree - App Summary Tree\n */\nexport function convertProtocolAndAppSummaryToSnapshotTree(\n    protocolSummaryTree: ISummaryTree,\n    appSummaryTree: ISummaryTree,\n): ISnapshotTreeWithBlobContents {\n    // Shallow copy is fine, since we are doing a deep clone below.\n    const combinedSummary: ISummaryTree = {\n        type: SummaryType.Tree,\n        tree: { ...appSummaryTree.tree },\n    };\n\n    combinedSummary.tree[\".protocol\"] = protocolSummaryTree;\n    const snapshotTreeWithBlobContents =\n        convertSummaryToSnapshotWithEmbeddedBlobContents(combinedSummary);\n    return snapshotTreeWithBlobContents;\n}\n\n// This function converts the snapshot taken in detached container(by serialize api) to snapshotTree with which\n// a detached container can be rehydrated.\nexport const getSnapshotTreeFromSerializedContainer = (detachedContainerSnapshot: ISummaryTree) => {\n    const protocolSummaryTree = detachedContainerSnapshot.tree[\".protocol\"] as ISummaryTree;\n    const appSummaryTree = detachedContainerSnapshot.tree[\".app\"] as ISummaryTree;\n    assert(protocolSummaryTree !== undefined && appSummaryTree !== undefined,\n        0x1e0 /* \"Protocol and App summary trees should be present\" */);\n    const snapshotTreeWithBlobContents = convertProtocolAndAppSummaryToSnapshotTree(\n        protocolSummaryTree,\n        appSummaryTree,\n    );\n    return snapshotTreeWithBlobContents;\n};\n\nexport function getProtocolSnapshotTree(snapshot: ISnapshotTree): ISnapshotTree {\n    return \".protocol\" in snapshot.trees ? snapshot.trees[\".protocol\"] : snapshot;\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,KAAK,CAAC;AAC5B,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EACH,MAAM,EACN,cAAc,EACd,uBAAuB,EACvB,eAAe,GAClB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAA+B,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAChG,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAqB/D,MAAM,UAAU,QAAQ,CAAC,GAAW;;IAChC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;QACrC,MAAM,IAAI,YAAY,CAAC,0BAA0B,CAAC,CAAC;KACtD;IACD,MAAM,KAAK,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC;IAClC,MAAM,KAAK,GAAG,2BAA2B,CAAC;IAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,MAAK,CAAC,CAAC;QACxB,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAiB,EAAE;QAClF,CAAC,CAAC,SAAS,CAAC;AACpB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,gDAAgD,CACrD,OAAqB;IAErB,MAAM,QAAQ,GAAkC;QAC5C,KAAK,EAAE,EAAE;QACT,aAAa,EAAE,EAAE;QACjB,KAAK,EAAE,EAAE;QACT,EAAE,EAAE,IAAI,EAAE;QACV,YAAY,EAAE,OAAO,CAAC,YAAY;KACrC,CAAC;IACF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExC,QAAQ,aAAa,CAAC,IAAI,EAAE;YACxB,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,gDAAgD,CAAC,aAAa,CAAC,CAAC;gBACtF,MAAM;aACT;YACD,KAAK,WAAW,CAAC,UAAU;gBACvB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC;gBACvC,MAAM;YACV,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC;gBACtB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;gBAC7B,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;oBAC7D,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACnG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC;gBAC/C,MAAM;aACT;YACD,KAAK,WAAW,CAAC,MAAM;gBACnB,MAAM,IAAI,YAAY,CAAC,+DAA+D,CAAC,CAAC;gBACxF,MAAM;YACV,OAAO,CAAC,CAAC;gBACL,eAAe,CAAC,aAAa,EAAE,qBAAsB,aAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;aACtF;SACJ;KACJ;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0CAA0C,CACtD,mBAAiC,EACjC,cAA4B;IAE5B,+DAA+D;IAC/D,MAAM,eAAe,GAAiB;QAClC,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,oBAAO,cAAc,CAAC,IAAI,CAAE;KACnC,CAAC;IAEF,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,mBAAmB,CAAC;IACxD,MAAM,4BAA4B,GAC9B,gDAAgD,CAAC,eAAe,CAAC,CAAC;IACtE,OAAO,4BAA4B,CAAC;AACxC,CAAC;AAED,+GAA+G;AAC/G,0CAA0C;AAC1C,MAAM,CAAC,MAAM,sCAAsC,GAAG,CAAC,yBAAuC,EAAE,EAAE;IAC9F,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;IACxF,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;IAC9E,MAAM,CAAC,mBAAmB,KAAK,SAAS,IAAI,cAAc,KAAK,SAAS,EACpE,KAAK,CAAC,wDAAwD,CAAC,CAAC;IACpE,MAAM,4BAA4B,GAAG,0CAA0C,CAC3E,mBAAmB,EACnB,cAAc,CACjB,CAAC;IACF,OAAO,4BAA4B,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,UAAU,uBAAuB,CAAC,QAAuB;IAC3D,OAAO,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AAClF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { parse } from \"url\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    assert,\n    stringToBuffer,\n    Uint8ArrayToArrayBuffer,\n    unreachableCase,\n} from \"@fluidframework/common-utils\";\nimport { ISummaryTree, ISnapshotTree, SummaryType } from \"@fluidframework/protocol-definitions\";\nimport { LoggingError } from \"@fluidframework/telemetry-utils\";\n\n// This is used when we rehydrate a container from the snapshot. Here we put the blob contents\n// in separate property: blobContents.\nexport interface ISnapshotTreeWithBlobContents extends ISnapshotTree {\n    blobsContents: { [path: string]: ArrayBufferLike; };\n    trees: { [path: string]: ISnapshotTreeWithBlobContents; };\n}\n\nexport interface IParsedUrl {\n    id: string;\n    path: string;\n    query: string;\n    /**\n     * Null means do not use snapshots, undefined means load latest snapshot\n     * otherwise it's version ID passed to IDocumentStorageService.getVersions() to figure out what snapshot to use.\n     * If needed, can add undefined which is treated by Container.load() as load latest snapshot.\n     */\n    version: string | null | undefined;\n}\n\nexport function parseUrl(url: string): IParsedUrl | undefined {\n    const parsed = parse(url, true);\n    if (typeof parsed.pathname !== \"string\") {\n        throw new LoggingError(\"Failed to parse pathname\");\n    }\n    const query = parsed.search ?? \"\";\n    const regex = /^\\/([^/]*\\/[^/]*)(\\/?.*)$/;\n    const match = regex.exec(parsed.pathname);\n    return (match?.length === 3)\n        ? { id: match[1], path: match[2], query, version: parsed.query.version as string }\n        : undefined;\n}\n\n/**\n * Converts summary tree (for upload) to snapshot tree (for download).\n * Summary tree blobs contain contents, but snapshot tree blobs normally\n * contain IDs pointing to storage. This will create 2 blob entries in the\n * snapshot tree for each blob in the summary tree. One will be the regular\n * path pointing to a uniquely generated ID. Then there will be another\n * entry with the path as that uniquely generated ID, and value as the\n * blob contents as a base-64 string.\n * @param summary - summary to convert\n */\nfunction convertSummaryToSnapshotWithEmbeddedBlobContents(\n    summary: ISummaryTree,\n): ISnapshotTreeWithBlobContents {\n    const treeNode: ISnapshotTreeWithBlobContents = {\n        blobs: {},\n        blobsContents: {},\n        trees: {},\n        id: uuid(),\n        unreferenced: summary.unreferenced,\n    };\n    const keys = Object.keys(summary.tree);\n    for (const key of keys) {\n        const summaryObject = summary.tree[key];\n\n        switch (summaryObject.type) {\n            case SummaryType.Tree: {\n                treeNode.trees[key] = convertSummaryToSnapshotWithEmbeddedBlobContents(summaryObject);\n                break;\n            }\n            case SummaryType.Attachment:\n                treeNode.blobs[key] = summaryObject.id;\n                break;\n            case SummaryType.Blob: {\n                const blobId = uuid();\n                treeNode.blobs[key] = blobId;\n                const contentBuffer = typeof summaryObject.content === \"string\" ?\n                    stringToBuffer(summaryObject.content, \"utf8\") : Uint8ArrayToArrayBuffer(summaryObject.content);\n                treeNode.blobsContents[blobId] = contentBuffer;\n                break;\n            }\n            case SummaryType.Handle:\n                throw new LoggingError(\"No handles should be there in summary in detached container!!\");\n                break;\n            default: {\n                unreachableCase(summaryObject, `Unknown tree type ${(summaryObject as any).type}`);\n            }\n        }\n    }\n    return treeNode;\n}\n\n/**\n * Combine and convert protocol and app summary tree to format which is readable by container while rehydrating.\n * @param protocolSummaryTree - Protocol Summary Tree\n * @param appSummaryTree - App Summary Tree\n */\nexport function convertProtocolAndAppSummaryToSnapshotTree(\n    protocolSummaryTree: ISummaryTree,\n    appSummaryTree: ISummaryTree,\n): ISnapshotTreeWithBlobContents {\n    // Shallow copy is fine, since we are doing a deep clone below.\n    const combinedSummary: ISummaryTree = {\n        type: SummaryType.Tree,\n        tree: { ...appSummaryTree.tree },\n    };\n\n    combinedSummary.tree[\".protocol\"] = protocolSummaryTree;\n    const snapshotTreeWithBlobContents =\n        convertSummaryToSnapshotWithEmbeddedBlobContents(combinedSummary);\n    return snapshotTreeWithBlobContents;\n}\n\n// This function converts the snapshot taken in detached container(by serialize api) to snapshotTree with which\n// a detached container can be rehydrated.\nexport const getSnapshotTreeFromSerializedContainer = (detachedContainerSnapshot: ISummaryTree) => {\n    const protocolSummaryTree = detachedContainerSnapshot.tree[\".protocol\"] as ISummaryTree;\n    const appSummaryTree = detachedContainerSnapshot.tree[\".app\"] as ISummaryTree;\n    assert(protocolSummaryTree !== undefined && appSummaryTree !== undefined,\n        0x1e0 /* \"Protocol and App summary trees should be present\" */);\n    const snapshotTreeWithBlobContents = convertProtocolAndAppSummaryToSnapshotTree(\n        protocolSummaryTree,\n        appSummaryTree,\n    );\n    return snapshotTreeWithBlobContents;\n};\n\nexport function getProtocolSnapshotTree(snapshot: ISnapshotTree): ISnapshotTree {\n    return \".protocol\" in snapshot.trees ? snapshot.trees[\".protocol\"] : snapshot;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "1.0.0",
+  "version": "1.1.0-76254",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -63,26 +63,26 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^1.0.0",
-    "@fluidframework/container-utils": "^1.0.0",
-    "@fluidframework/core-interfaces": "^1.0.0",
-    "@fluidframework/driver-definitions": "^1.0.0",
-    "@fluidframework/driver-utils": "^1.0.0",
-    "@fluidframework/protocol-base": "^0.1036.4000",
+    "@fluidframework/container-definitions": "1.1.0-76254",
+    "@fluidframework/container-utils": "1.1.0-76254",
+    "@fluidframework/core-interfaces": "1.1.0-76254",
+    "@fluidframework/driver-definitions": "1.1.0-76254",
+    "@fluidframework/driver-utils": "1.1.0-76254",
+    "@fluidframework/protocol-base": "^0.1036.5000-0",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/telemetry-utils": "^1.0.0",
+    "@fluidframework/telemetry-utils": "1.1.0-76254",
     "abort-controller": "^3.0.0",
     "double-ended-queue": "^2.1.0-0",
     "lodash": "^4.17.21",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.71273",
-    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@0.59.3000",
+    "@fluidframework/build-common": "^0.24.0-0",
+    "@fluidframework/build-tools": "^0.2.74327",
+    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@^1.0.0",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^1.0.0",
-    "@fluidframework/test-loader-utils": "^1.0.0",
+    "@fluidframework/mocha-test-setup": "1.1.0-76254",
+    "@fluidframework/test-loader-utils": "1.1.0-76254",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/double-ended-queue": "^2.1.0",
@@ -102,20 +102,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.0.0",
-    "broken": {
-      "ClassDeclaration_Container": {
-        "backCompat": false
-      },
-      "EnumDeclaration_ConnectionState": {
-        "backCompat": false
-      },
-      "InterfaceDeclaration_ILoaderServices": {
-        "backCompat": false
-      },
-      "ClassDeclaration_Loader": {
-        "backCompat": false
-      }
-    }
+    "version": "1.1.0",
+    "broken": {}
   }
 }

package/src/connectionManager.ts

@@ -15,9 +15,7 @@ import {
     IConnectionDetails,
     ICriticalContainerError,
 } from "@fluidframework/container-definitions";
-import {
-    GenericError,
-} from "@fluidframework/container-utils";
+import { GenericError, UsageError } from "@fluidframework/container-utils";
 import {
     IDocumentService,
     IDocumentDeltaConnection,
@@ -370,9 +368,9 @@ export class ConnectionManager implements IConnectionManager {
         this._forceReadonly = readonly;
 
         if (oldValue !== this.readonly) {
-            assert(this._reconnectMode !== ReconnectMode.Never,
-                0x279 /* "API is not supported for non-connecting or closed container" */);
-
+            if (this._reconnectMode === ReconnectMode.Never) {
+                throw new UsageError("API is not supported for non-connecting or closed container");
+            }
             let reconnect = false;
             if (this.readonly === true) {
                 // If we switch to readonly while connected, we should disconnect first

package/src/connectionStateHandler.ts

@@ -3,33 +3,55 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLogger, ITelemetryProperties } from "@fluidframework/common-definitions";
 import { assert, Timer } from "@fluidframework/common-utils";
 import { IConnectionDetails } from "@fluidframework/container-definitions";
-import { ProtocolOpHandler } from "@fluidframework/protocol-base";
-import { ConnectionMode, IQuorumClients, ISequencedClient } from "@fluidframework/protocol-definitions";
+import { ILocalSequencedClient, IProtocolHandler } from "@fluidframework/protocol-base";
+import { ConnectionMode, IQuorumClients } from "@fluidframework/protocol-definitions";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { ConnectionState } from "./connectionState";
 
-export interface IConnectionStateHandler {
+/** Constructor parameter type for passing in dependencies needed by the ConnectionStateHandler */
+export interface IConnectionStateHandlerInputs {
+    /** Provides access to the clients currently in the quorum */
     quorumClients: () => IQuorumClients | undefined;
-    logConnectionStateChangeTelemetry: (
-        value: ConnectionState,
-        oldState: ConnectionState,
-        reason?: string | undefined
-    ) => void;
+    /** Log to telemetry any change in state, included to Connecting */
+    logConnectionStateChangeTelemetry:
+        (value: ConnectionState, oldState: ConnectionState, reason?: string | undefined) => void;
+    /** Whether to expect the client to join in write mode on next connection */
     shouldClientJoinWrite: () => boolean;
+    /** (Optional) How long should we wait on our previous client's Leave op before transitioning to Connected again */
     maxClientLeaveWaitTime: number | undefined;
-    logConnectionIssue: (eventName: string) => void;
+    /** Log an issue encountered while in the Connecting state. details will be logged as a JSON string */
+    logConnectionIssue: (eventName: string, details?: ITelemetryProperties) => void;
+    /** Callback whenever the ConnectionState changes between Disconnected and Connected */
     connectionStateChanged: () => void;
 }
 
-export interface ILocalSequencedClient extends ISequencedClient {
-    shouldHaveLeft?: boolean;
-}
-
-const JoinOpTimer = 45000;
-
+const JoinOpTimeoutMs = 45000;
+
+/**
+ * In the lifetime of a container, the connection will likely disconnect and reconnect periodically.
+ * This class ensures that any ops sent by this container instance on previous connection are either
+ * sequenced or blocked by the server before emitting the new "connected" event and allowing runtime to resubmit ops.
+ *
+ * Each connection is assigned a clientId by the service, and the connection is book-ended by a Join and a Leave op
+ * generated by the service. Due to the distributed nature of the ordering service, in the case of reconnect we cannot
+ * make any assumptions about ordering of operations between the old and new connections - i.e. new Join op could
+ * be sequenced before old Leave op (and some acks from pending ops that were in flight when we disconnected).
+ *
+ * The job of this class is to encapsulate the transition period during reconnect, which is identified by
+ * ConnectionState.CatchingUp. Specifically, before moving to Connected state with the new clientId, it ensures that:
+ * (A) We process the Leave op for the previous clientId. This allows us to properly handle any acks from in-flight ops
+ *     that got sequenced with the old clientId (we'll recognize them as local ops). After the Leave op, any other
+ *     pending ops can safely be submitted with the new clientId without fear of duplication in the sequenced op stream.
+ * (B) We process the Join op for the new clientId (identified when the underlying connection was first established),
+ *     indicating the service is ready to sequence ops sent with the new clientId.
+ *
+ * For (A) we give up waiting after some time (same timeout as server uses), and go ahead and transition to Connected.
+ * For (B) we log telemetry if it takes too long, but still only transition to Connected when the Join op is processed
+ * and we are added to the Quorum.
+ */
 export class ConnectionStateHandler {
     private _connectionState = ConnectionState.Disconnected;
     private _pendingClientId: string | undefined;
@@ -55,7 +77,7 @@ export class ConnectionStateHandler {
     }
 
     constructor(
-        private readonly handler: IConnectionStateHandler,
+        private readonly handler: IConnectionStateHandlerInputs,
         private readonly logger: ITelemetryLogger,
         private _clientId?: string,
     ) {
@@ -74,13 +96,21 @@ export class ConnectionStateHandler {
         // timing out ops fetches. So attempt recovery infrequently. Also fetch uses 30 second timeout, so
         // if retrying fixes the problem, we should not see these events.
         this.joinOpTimer = new Timer(
-            JoinOpTimer,
+            JoinOpTimeoutMs,
             () => {
                 // I've observed timer firing within couple ms from disconnect event, looks like
                 // queued timer callback is not cancelled if timer is cancelled while callback sits in the queue.
-                if (this.connectionState === ConnectionState.CatchingUp) {
-                    this.handler.logConnectionIssue("NoJoinOp");
+                if (this.connectionState !== ConnectionState.CatchingUp) {
+                    return;
                 }
+                const quorumClients = this.handler.quorumClients();
+                const details = {
+                    quorumInitialized: quorumClients !== undefined,
+                    hasPendingClientId: this.pendingClientId !== undefined,
+                    inQuorum: quorumClients?.getMember(this.pendingClientId ?? "") !== undefined,
+                    waitingForLeaveOp: this.waitingForLeaveOp,
+                };
+                this.handler.logConnectionIssue("NoJoinOp", details);
             },
         );
     }
@@ -95,6 +125,10 @@ export class ConnectionStateHandler {
         this.joinOpTimer.clear();
     }
 
+    private get waitingForLeaveOp() {
+        return this.prevClientLeftTimer.hasTimer;
+    }
+
     public dispose() {
         assert(!this.joinOpTimer.hasTimer, 0x2a5 /* "join timer" */);
         this.prevClientLeftTimer.clear();
@@ -103,7 +137,7 @@ export class ConnectionStateHandler {
     public containerSaved() {
         // If we were waiting for moving to Connected state, then only apply for state change. Since the container
         // is now saved and we don't have any ops to roundtrip, we can clear the timer and apply for connected state.
-        if (this.prevClientLeftTimer.hasTimer) {
+        if (this.waitingForLeaveOp) {
             this.prevClientLeftTimer.clear();
             this.applyForConnectedState("containerSaved");
         }
@@ -120,11 +154,13 @@ export class ConnectionStateHandler {
                 this.handler.logConnectionIssue("ReceivedJoinOp");
             }
             // Start the event in case we are waiting for leave or timeout.
-            if (this.prevClientLeftTimer.hasTimer) {
+            if (this.waitingForLeaveOp) {
                 this.waitEvent = PerformanceEvent.start(this.logger, {
                     eventName: "WaitBeforeClientLeave",
-                    waitOnClientId: this._clientId,
-                    hadOutstandingOps: this.handler.shouldClientJoinWrite(),
+                    details: JSON.stringify({
+                        waitOnClientId: this._clientId,
+                        hadOutstandingOps: this.handler.shouldClientJoinWrite(),
+                    }),
                 });
             }
             this.applyForConnectedState("addMemberEvent");
@@ -135,17 +171,17 @@ export class ConnectionStateHandler {
         const quorumClients = this.handler.quorumClients();
         assert(quorumClients !== undefined, 0x236 /* "In all cases it should be already installed" */);
 
-        assert(this.prevClientLeftTimer.hasTimer === false ||
+        assert(this.waitingForLeaveOp === false ||
             (this.clientId !== undefined && quorumClients.getMember(this.clientId) !== undefined),
             0x2e2 /* "Must only wait for leave message when clientId in quorum" */);
 
         // Move to connected state only if we are in Connecting state, we have seen our join op
         // and there is no timer running which means we are not waiting for previous client to leave
-        // or timeout has occured while doing so.
+        // or timeout has occurred while doing so.
         if (this.pendingClientId !== this.clientId
             && this.pendingClientId !== undefined
             && quorumClients.getMember(this.pendingClientId) !== undefined
-            && !this.prevClientLeftTimer.hasTimer
+            && !this.waitingForLeaveOp
         ) {
             this.waitEvent?.end({ source });
             this.setConnectionState(ConnectionState.Connected);
@@ -154,12 +190,13 @@ export class ConnectionStateHandler {
             this.logger.sendTelemetryEvent({
                 eventName: "connectedStateRejected",
                 category: source === "timeout" ? "error" : "generic",
-                source,
-                pendingClientId: this.pendingClientId,
-                clientId: this.clientId,
-                hasTimer: this.prevClientLeftTimer.hasTimer,
-                inQuorum: quorumClients !== undefined && this.pendingClientId !== undefined
-                    && quorumClients.getMember(this.pendingClientId) !== undefined,
+                details: JSON.stringify({
+                    source,
+                    pendingClientId: this.pendingClientId,
+                    clientId: this.clientId,
+                    waitingForLeaveOp: this.waitingForLeaveOp,
+                    inQuorum: quorumClients?.getMember(this.pendingClientId ?? "") !== undefined,
+                }),
             });
         }
     }
@@ -179,6 +216,13 @@ export class ConnectionStateHandler {
         this.setConnectionState(ConnectionState.Disconnected, reason);
     }
 
+    /**
+     * The "connect" event indicates the connection to the Relay Service is live.
+     * However, some additional conditions must be met before we can fully transition to
+     * "Connected" state. This function handles that interim period, known as "Connecting" state.
+     * @param connectionMode - Read or Write connection
+     * @param details - Connection details returned from the ordering service
+     */
     public receivedConnectEvent(
         connectionMode: ConnectionMode,
         details: IConnectionDetails,
@@ -186,36 +230,49 @@ export class ConnectionStateHandler {
         const oldState = this._connectionState;
         this._connectionState = ConnectionState.CatchingUp;
 
+        const writeConnection = connectionMode === "write";
+        assert(writeConnection || !this.handler.shouldClientJoinWrite(),
+            0x30a /* shouldClientJoinWrite should imply this is a writeConnection */);
+        assert(writeConnection || !this.waitingForLeaveOp,
+            0x2a6 /* "waitingForLeaveOp should imply writeConnection (we need to be ready to flush pending ops)" */);
+
+        // Note that this may be undefined since the connection is established proactively on load
+        // and the quorum may still be under initialization.
+        const quorumClients: IQuorumClients | undefined = this.handler.quorumClients();
+
         // Stash the clientID to detect when transitioning from connecting (socket.io channel open) to connected
         // (have received the join message for the client ID)
         // This is especially important in the reconnect case. It's possible there could be outstanding
         // ops sent by this client, so we should keep the old client id until we see our own client's
-        // join message. after we see the join message for out new connection with our new client id,
+        // join message. after we see the join message for our new connection with our new client id,
         // we know there can no longer be outstanding ops that we sent with the previous client id.
         this._pendingClientId = details.clientId;
 
-        // Report telemetry after we set client id, but before transitioning to Connected state below!
+        // IMPORTANT: Report telemetry after we set _pendingClientId, but before transitioning to Connected state
         this.handler.logConnectionStateChangeTelemetry(ConnectionState.CatchingUp, oldState);
 
-        const quorumClients = this.handler.quorumClients();
-        // Check if we already processed our own join op through delta storage!
-        // we are fetching ops from storage in parallel to connecting to ordering service
-        // Given async processes, it's possible that we have already processed our own join message before
+        // For write connections, this pending clientId could be in the quorum already (i.e. join op already processed).
+        // We are fetching ops from storage in parallel to connecting to Relay Service,
+        // and given async processes, it's possible that we have already processed our own join message before
         // connection was fully established.
-        // Note that we might be still initializing quorum - connection is established proactively on load!
-        if (quorumClients?.getMember(details.clientId) !== undefined
-            || connectionMode === "read"
-        ) {
-            assert(!this.prevClientLeftTimer.hasTimer, 0x2a6 /* "there should be no timer for 'read' connections" */);
-            this.setConnectionState(ConnectionState.Connected);
-        } else if (connectionMode === "write") {
+        // If quorumClients itself is undefined, we expect it will process the join op after it's initialized.
+        const waitingForJoinOp = writeConnection && quorumClients?.getMember(this._pendingClientId) === undefined;
+
+        if (waitingForJoinOp) {
+            // Previous client left, and we are waiting for our own join op. When it is processed we'll join the quorum
+            // and attempt to transition to Connected state via receivedAddMemberEvent.
             this.startJoinOpTimer();
+        } else if (!this.waitingForLeaveOp) {
+            // We're not waiting for Join or Leave op (if read-only connection those don't even apply),
+            // go ahead and declare the state to be Connected!
+            // If we are waiting for Leave op still, do nothing for now, we will transition to Connected later.
+            this.setConnectionState(ConnectionState.Connected);
         }
     }
 
-    private setConnectionState(value: ConnectionState.Disconnected, reason: string);
-    private setConnectionState(value: ConnectionState.Connected);
-    private setConnectionState(value: ConnectionState, reason?: string) {
+    private setConnectionState(value: ConnectionState.Disconnected, reason: string): void;
+    private setConnectionState(value: ConnectionState.Connected): void;
+    private setConnectionState(value: ConnectionState, reason?: string): void {
         if (this.connectionState === value) {
             // Already in the desired state - exit early
             this.logger.sendErrorEvent({ eventName: "setConnectionStateSame", value });
@@ -255,9 +312,11 @@ export class ConnectionStateHandler {
                 // Adding this event temporarily so that we can get help debugging if something goes wrong.
                 this.logger.sendTelemetryEvent({
                     eventName: "noWaitOnDisconnected",
-                    inQuorum: client !== undefined,
-                    hasTimer: this.prevClientLeftTimer.hasTimer,
-                    shouldClientJoinWrite: this.handler.shouldClientJoinWrite(),
+                    details: JSON.stringify({
+                        inQuorum: client !== undefined,
+                        waitingForLeaveOp: this.waitingForLeaveOp,
+                        hadOutstandingOps: this.handler.shouldClientJoinWrite(),
+                    }),
                 });
             }
         }
@@ -269,8 +328,8 @@ export class ConnectionStateHandler {
         this.handler.connectionStateChanged();
     }
 
-    public initProtocol(protocol: ProtocolOpHandler) {
-        protocol.quorum.on("addMember", (clientId, details) => {
+    public initProtocol(protocol: IProtocolHandler) {
+        protocol.quorum.on("addMember", (clientId, _details) => {
             this.receivedAddMemberEvent(clientId);
         });