@fluidframework/routerlicious-driver 0.59.1001-62246 → 0.59.2000

package/lib/wholeSummaryDocumentStorageService.js.map

@@ -1 +1 @@
-{"version":3,"file":"wholeSummaryDocumentStorageService.js","sourceRoot":"","sources":["../src/wholeSummaryDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,MAAM,EACN,cAAc,EACd,kBAAkB,GACrB,MAAM,8BAA8B,CAAC;AActC,OAAO,EACH,6CAA6C,EAG7C,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAU,aAAa,EAAE,MAAM,SAAS,CAAC;AAGhD,MAAM,gBAAgB,GAAW,QAAQ,CAAC;AAE1C,MAAM,OAAO,kCAAkC;IAQ3C,YACuB,EAAU,EACV,OAAmB,EACnB,MAAwB,EAC3B,WAA4C,EAAE,EAC7C,YAAqC,IAAI,aAAa,EAAE,EACxD,oBAAkD,IAAI,aAAa,EAAE;QALnE,OAAE,GAAF,EAAE,CAAQ;QACV,YAAO,GAAP,OAAO,CAAY;QACnB,WAAM,GAAN,MAAM,CAAkB;QAC3B,aAAQ,GAAR,QAAQ,CAAsC;QAC7C,cAAS,GAAT,SAAS,CAA+C;QACxD,sBAAiB,GAAjB,iBAAiB,CAAoD;QAZlF,sBAAiB,GAAY,IAAI,CAAC;QAatC,IAAI,CAAC,oBAAoB,GAAG,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACvE,CAAC;IAZD,IAAW,aAAa;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IAYM,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa;QAC5D,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE,IAAI,SAAS,KAAK,IAAI,EAAE;YAC7C,4FAA4F;YAC5F,OAAO,CAAC;oBACJ,EAAE,EAAE,SAAS;oBACb,MAAM,EAAE,SAAU;iBACrB,CAAC,CAAC;SACN;QACD,gGAAgG;QAChG,qDAAqD;QACrD,IAAI,IAAI,CAAC,iBAAiB,IAAI,KAAK,KAAK,CAAC,EAAE;YACvC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;YACzF,OAAO,CAAC;oBACJ,EAAE,EAAE,GAAG;oBACP,MAAM,EAAE,YAAY,CAAC,EAAG;iBAC3B,CAAC,CAAC;SACN;QAED,+DAA+D;QAC/D,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,cAAc,CACjD,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,aAAa;YACxB,SAAS,EAAE,EAAE;YACb,KAAK;SACR,EACD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,CACjD,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI;YAC/B,EAAE,EAAE,MAAM,CAAC,GAAG;YACd,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG;SACjC,CAAC,CAAC,CAAC;IACR,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAkB;QAC3C,IAAI,cAAc,GAAG,OAAO,CAAC;QAC7B,IAAI,CAAC,cAAc,EAAE;YACjB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YACpD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvB,OAAO,IAAI,CAAC;aACf;YAED,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;SAChC;QAED,OAAO,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,MAAc;QAChC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,UAAU,KAAK,SAAS,EAAE;YAC1B,OAAO,UAAU,CAAC;SACrB;QAED,MAAM,IAAI,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAC9C,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,UAAU;YACrB,MAAM;SACT,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,KAAK,CAAC,GAAG,CAAC;gBACN,IAAI,EAAE,QAAQ,CAAC,IAAI;aACtB,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACpB,CAAC,CACJ,CAAC;QACF,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhE,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAEhD,OAAO,WAAW,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,OAAqB,EAAE,OAAwB;QACjF,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,cAAc,CACvD,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,0BAA0B;SACxC,EACD,KAAK,IAAI,EAAE,WAAC,OAAA,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,QAAE,OAAO,CAAC,SAAS,mCAAI,EAAE,EAAE,SAAS,CAAC,CAAA,EAAA,CACtG,CAAC;QACF,OAAO,aAAa,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAsB;QAC/C,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,IAAW,EAAE,OAAiB,EAAE,OAAe,EAAE,GAAW;QAC3E,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QACzC,MAAM,cAAc,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,gBAAgB,CAAC,cAAc,CAClC,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,YAAY;YACvB,IAAI,EAAE,cAAc,CAAC,MAAM;SAC9B,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAC1C,kBAAkB,CACd,cAAc,EAAE,QAAQ,CAAC,EAC7B,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACvD,KAAK,CAAC,GAAG,CAAC;gBACN,MAAM,EAAE,QAAQ,CAAC,EAAE;aACtB,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACpB,CAAC,CACJ,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,yBAAyB,CAAC,SAAiB;QACrD,MAAM,yBAAyB,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC9E,IAAI,yBAAyB,KAAK,SAAS,EAAE;YACzC,OAAO,EAAE,EAAE,EAAE,yBAAyB,CAAC,EAAE,EAAE,YAAY,EAAE,yBAAyB,CAAC,YAAY,EAAE,CAAC;SACrG;QAED,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAC1D,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,qBAAqB;YAChC,MAAM,EAAE,SAAS;SACpB,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;;YACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAC1D,KAAK,CAAC,GAAG,CAAC;gBACN,IAAI,QAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,MAAM;aAC1C,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACpB,CAAC,CACJ,CAAC;QACF,MAAM,sBAAsB,GAAG,6CAA6C,CAAC,gBAAgB,CAAC,CAAC;QAC/F,MAAM,kBAAkB,GAAW,gBAAgB,CAAC,EAAE,CAAC;QACvD,MAAM,cAAc,GAAG,sBAAsB,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9D,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACpF,MAAM,mBAAmB,GAAG,EAAE,EAAE,EAAE,kBAAkB,EAAG,YAAY,EAAE,sBAAsB,CAAC,YAAY,EAAE,CAAC;QAE3G,MAAM,OAAO,GAAmB;YAC5B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CACtB,cAAc,EACd,mBAAmB,CACtB;YACD,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,KAAK,CAAC;SACnD,CAAC;QACF,IAAI,cAAc,KAAK,SAAS,EAAE;YAC9B,sGAAsG;YACtG,4GAA4G;YAC5G,0GAA0G;YAC1G,wBAAwB;YACxB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CACnC,SAAS,EACT,mBAAmB,CACtB,CAAC,CAAC;SACN;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAE3B,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,KAA+B;QACvD,MAAM,cAAc,GAAoB,EAAE,CAAC;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACxB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    assert,\n    stringToBuffer,\n    Uint8ArrayToString,\n} from \"@fluidframework/common-utils\";\nimport {\n    IDocumentStorageService,\n    ISummaryContext,\n    IDocumentStorageServicePolicies,\n } from \"@fluidframework/driver-definitions\";\nimport {\n    ICreateBlobResponse,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    ITree,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    convertWholeFlatSummaryToSnapshotTreeAndBlobs,\n    GitManager,\n    ISummaryUploadManager,\n    WholeSummaryUploadManager,\n} from \"@fluidframework/server-services-client\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { ICache, InMemoryCache } from \"./cache\";\nimport { ISnapshotTreeVersion } from \"./definitions\";\n\nconst latestSnapshotId: string = \"latest\";\n\nexport class WholeSummaryDocumentStorageService implements IDocumentStorageService {\n    private readonly summaryUploadManager: ISummaryUploadManager;\n    private firstVersionsCall: boolean = true;\n\n    public get repositoryUrl(): string {\n        return \"\";\n    }\n\n    constructor(\n        protected readonly id: string,\n        protected readonly manager: GitManager,\n        protected readonly logger: ITelemetryLogger,\n        public readonly policies: IDocumentStorageServicePolicies = {},\n        private readonly blobCache: ICache<ArrayBufferLike> = new InMemoryCache(),\n        private readonly snapshotTreeCache: ICache<ISnapshotTreeVersion> = new InMemoryCache()) {\n        this.summaryUploadManager = new WholeSummaryUploadManager(manager);\n    }\n\n    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {\n        if (versionId !== this.id && versionId !== null) {\n            // Blobs/Trees in this scenario will never have multiple versions, so return versionId as is\n            return [{\n                id: versionId,\n                treeId: undefined!,\n            }];\n        }\n        // If this is the first versions call for the document, we know we will want the latest summary.\n        // Fetch latest summary, cache it, and return its id.\n        if (this.firstVersionsCall && count === 1) {\n            this.firstVersionsCall = false;\n            const { id: _id, snapshotTree } = await this.fetchAndCacheSnapshotTree(latestSnapshotId);\n            return [{\n                id: _id,\n                treeId: snapshotTree.id!,\n            }];\n        }\n\n        // Otherwise, get the latest version of the document as normal.\n        const id = versionId ? versionId : this.id;\n        const commits = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"getVersions\",\n                versionId: id,\n                count,\n            },\n            async () => this.manager.getCommits(id, count),\n        );\n        return commits.map((commit) => ({\n            date: commit.commit.author.date,\n            id: commit.sha,\n            treeId: commit.commit.tree.sha,\n        }));\n    }\n\n    public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {\n        let requestVersion = version;\n        if (!requestVersion) {\n            const versions = await this.getVersions(this.id, 1);\n            if (versions.length === 0) {\n                return null;\n            }\n\n            requestVersion = versions[0];\n        }\n\n        return (await this.fetchAndCacheSnapshotTree(requestVersion.id)).snapshotTree;\n    }\n\n    public async readBlob(blobId: string): Promise<ArrayBufferLike> {\n        const cachedBlob = await this.blobCache.get(blobId);\n        if (cachedBlob !== undefined) {\n            return cachedBlob;\n        }\n\n        const blob = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"readBlob\",\n                blobId,\n            },\n            async (event) => {\n                const response = await this.manager.getBlob(blobId);\n                event.end({\n                    size: response.size,\n                });\n                return response;\n            },\n        );\n        const bufferValue = stringToBuffer(blob.content, blob.encoding);\n\n        await this.blobCache.put(blob.sha, bufferValue);\n\n        return bufferValue;\n    }\n\n    public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {\n        const summaryHandle = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"uploadSummaryWithContext\",\n            },\n            async () => this.summaryUploadManager.writeSummaryTree(summary, context.ackHandle ?? \"\", \"channel\"),\n        );\n        return summaryHandle;\n    }\n\n    public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {\n        throw new Error(\"NOT IMPLEMENTED!\");\n    }\n\n    public async write(tree: ITree, parents: string[], message: string, ref: string): Promise<IVersion> {\n        throw new Error(\"NOT IMPLEMENTED!\");\n    }\n\n    public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {\n        const uint8ArrayFile = new Uint8Array(file);\n        return PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"createBlob\",\n                size: uint8ArrayFile.length,\n            },\n            async (event) => {\n                const response = await this.manager.createBlob(\n                    Uint8ArrayToString(\n                        uint8ArrayFile, \"base64\"),\n                    \"base64\").then((r) => ({ id: r.sha, url: r.url }));\n                event.end({\n                    blobId: response.id,\n                });\n                return response;\n            },\n        );\n    }\n\n    private async fetchAndCacheSnapshotTree(versionId: string): Promise<ISnapshotTreeVersion> {\n        const cachedSnapshotTreeVersion = await this.snapshotTreeCache.get(versionId);\n        if (cachedSnapshotTreeVersion !== undefined) {\n            return { id: cachedSnapshotTreeVersion.id, snapshotTree: cachedSnapshotTreeVersion.snapshotTree };\n        }\n\n        const wholeFlatSummary = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"getWholeFlatSummary\",\n                treeId: versionId,\n            },\n            async (event) => {\n                const response = await this.manager.getSummary(versionId);\n                event.end({\n                    size: response.trees[0]?.entries.length,\n                });\n                return response;\n            },\n        );\n        const normalizedWholeSummary = convertWholeFlatSummaryToSnapshotTreeAndBlobs(wholeFlatSummary);\n        const wholeFlatSummaryId: string = wholeFlatSummary.id;\n        const snapshotTreeId = normalizedWholeSummary.snapshotTree.id;\n        assert(snapshotTreeId !== undefined, 0x275 /* \"Root tree should contain the id\" */);\n        const snapshotTreeVersion = { id: wholeFlatSummaryId , snapshotTree: normalizedWholeSummary.snapshotTree };\n\n        const cachePs: Promise<any>[] = [\n            this.snapshotTreeCache.put(\n                snapshotTreeId,\n                snapshotTreeVersion,\n            ),\n            this.initBlobCache(normalizedWholeSummary.blobs),\n        ];\n        if (snapshotTreeId !== versionId) {\n            // versionId could be \"latest\". When summarizer checks cache for \"latest\", we want it to be available.\n            // TODO: For in-memory cache, <latest,snapshotTree> will be a shared pointer with <snapshotId,snapshotTree>,\n            // However, for something like Redis, this will cache the same value twice. Alternatively, could we simply\n            // cache with versionId?\n            cachePs.push(this.snapshotTreeCache.put(\n                versionId,\n                snapshotTreeVersion,\n            ));\n        }\n\n        await Promise.all(cachePs);\n\n        return snapshotTreeVersion;\n    }\n\n    private async initBlobCache(blobs: Map<string, ArrayBuffer>): Promise<void> {\n        const blobCachePutPs: Promise<void>[] = [];\n        blobs.forEach((value, id) => {\n            blobCachePutPs.push(this.blobCache.put(id, value));\n        });\n        await Promise.all(blobCachePutPs);\n    }\n}\n"]}
+{"version":3,"file":"wholeSummaryDocumentStorageService.js","sourceRoot":"","sources":["../src/wholeSummaryDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,MAAM,EACN,cAAc,EACd,kBAAkB,GACrB,MAAM,8BAA8B,CAAC;AActC,OAAO,EACH,6CAA6C,EAG7C,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAU,aAAa,EAAE,MAAM,SAAS,CAAC;AAIhD,MAAM,gBAAgB,GAAW,QAAQ,CAAC;AAE1C,MAAM,OAAO,kCAAkC;IAQ3C,YACuB,EAAU,EACV,OAAmB,EACnB,MAAwB,EAC3B,WAA4C,EAAE,EAC7C,cAA6C,EAC7C,YAAqC,IAAI,aAAa,EAAE,EACxD,oBAAkD,IAAI,aAAa,EAAE,EACnE,iBAA8B;QAP9B,OAAE,GAAF,EAAE,CAAQ;QACV,YAAO,GAAP,OAAO,CAAY;QACnB,WAAM,GAAN,MAAM,CAAkB;QAC3B,aAAQ,GAAR,QAAQ,CAAsC;QAC7C,mBAAc,GAAd,cAAc,CAA+B;QAC7C,cAAS,GAAT,SAAS,CAA+C;QACxD,sBAAiB,GAAjB,iBAAiB,CAAoD;QACnE,sBAAiB,GAAjB,iBAAiB,CAAa;QAd7C,sBAAiB,GAAY,IAAI,CAAC;QAetC,IAAI,CAAC,oBAAoB,GAAG,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACvE,CAAC;IAdD,IAAW,aAAa;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IAcM,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa;;QAC5D,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE,IAAI,SAAS,KAAK,IAAI,EAAE;YAC7C,4FAA4F;YAC5F,OAAO,CAAC;oBACJ,EAAE,EAAE,SAAS;oBACb,MAAM,EAAE,SAAU;iBACrB,CAAC,CAAC;SACN;QACD,gGAAgG;QAChG,qDAAqD;QACrD,IAAI,IAAI,CAAC,iBAAiB,IAAI,KAAK,KAAK,CAAC,EAAE;YACvC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,QAAC,IAAI,CAAC,cAAc,0CAAE,eAAe,CAAA,CAAC,CAAC;gBACrE,MAAM,IAAI,CAAC,yBAAyB,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC;gBAC/D,MAAM,IAAI,CAAC,yBAAyB,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;YACjE,OAAO,CAAC;oBACJ,EAAE,EAAE,GAAG;oBACP,MAAM,EAAE,YAAY,CAAC,EAAG;iBAC3B,CAAC,CAAC;SACN;QAED,+DAA+D;QAC/D,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,cAAc,CACjD,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,aAAa;YACxB,SAAS,EAAE,EAAE;YACb,KAAK;SACR,EACD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,CACjD,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI;YAC/B,EAAE,EAAE,MAAM,CAAC,GAAG;YACd,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG;SACjC,CAAC,CAAC,CAAC;IACR,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAkB;QAC3C,IAAI,cAAc,GAAG,OAAO,CAAC;QAC7B,IAAI,CAAC,cAAc,EAAE;YACjB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YACpD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvB,OAAO,IAAI,CAAC;aACf;YAED,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;SAChC;QAED,OAAO,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,MAAc;QAChC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,UAAU,KAAK,SAAS,EAAE;YAC1B,OAAO,UAAU,CAAC;SACrB;QAED,MAAM,IAAI,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAC9C,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,UAAU;YACrB,MAAM;SACT,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,KAAK,CAAC,GAAG,CAAC;gBACN,IAAI,EAAE,QAAQ,CAAC,IAAI;aACtB,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACpB,CAAC,CACJ,CAAC;QACF,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhE,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAEhD,OAAO,WAAW,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,OAAqB,EAAE,OAAwB;QACjF,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,cAAc,CACvD,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,0BAA0B;SACxC,EACD,KAAK,IAAI,EAAE,WAAC,OAAA,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,QAAE,OAAO,CAAC,SAAS,mCAAI,EAAE,EAAE,SAAS,CAAC,CAAA,EAAA,CACtG,CAAC;QACF,OAAO,aAAa,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAsB;QAC/C,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,IAAW,EAAE,OAAiB,EAAE,OAAe,EAAE,GAAW;QAC3E,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QACzC,MAAM,cAAc,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,gBAAgB,CAAC,cAAc,CAClC,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,YAAY;YACvB,IAAI,EAAE,cAAc,CAAC,MAAM;SAC9B,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAC1C,kBAAkB,CACd,cAAc,EAAE,QAAQ,CAAC,EAC7B,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACvD,KAAK,CAAC,GAAG,CAAC;gBACN,MAAM,EAAE,QAAQ,CAAC,EAAE;aACtB,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACpB,CAAC,CACJ,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,yBAAyB,CAAC,SAAiB,EAAE,YAAsB;QAC7E,MAAM,yBAAyB,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC9E,IAAI,yBAAyB,KAAK,SAAS,EAAE;YACzC,OAAO,EAAE,EAAE,EAAE,yBAAyB,CAAC,EAAE,EAAE,YAAY,EAAE,yBAAyB,CAAC,YAAY,EAAE,CAAC;SACrG;QAED,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAC1D,IAAI,CAAC,MAAM,EACX;YACI,SAAS,EAAE,qBAAqB;YAChC,MAAM,EAAE,SAAS;SACpB,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;;YACZ,MAAM,QAAQ,GAAG,YAAY,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC;gBACnE,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;gBACpD,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAC7C,KAAK,CAAC,GAAG,CAAC;gBACN,IAAI,QAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,MAAM;aAC1C,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACpB,CAAC,CACJ,CAAC;QACF,MAAM,sBAAsB,GAAG,6CAA6C,CAAC,gBAAgB,CAAC,CAAC;QAC/F,MAAM,kBAAkB,GAAW,gBAAgB,CAAC,EAAE,CAAC;QACvD,MAAM,cAAc,GAAG,sBAAsB,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9D,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACpF,MAAM,mBAAmB,GAAG,EAAE,EAAE,EAAE,kBAAkB,EAAE,YAAY,EAAE,sBAAsB,CAAC,YAAY,EAAE,CAAC;QAE1G,MAAM,OAAO,GAAmB;YAC5B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CACtB,cAAc,EACd,mBAAmB,CACtB;YACD,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,KAAK,CAAC;SACnD,CAAC;QACF,IAAI,cAAc,KAAK,SAAS,EAAE;YAC9B,sGAAsG;YACtG,4GAA4G;YAC5G,0GAA0G;YAC1G,wBAAwB;YACxB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CACnC,SAAS,EACT,mBAAmB,CACtB,CAAC,CAAC;SACN;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAE3B,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,KAA+B;QACvD,MAAM,cAAc,GAAoB,EAAE,CAAC;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACxB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    assert,\n    stringToBuffer,\n    Uint8ArrayToString,\n} from \"@fluidframework/common-utils\";\nimport {\n    IDocumentStorageService,\n    ISummaryContext,\n    IDocumentStorageServicePolicies,\n} from \"@fluidframework/driver-definitions\";\nimport {\n    ICreateBlobResponse,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    ITree,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    convertWholeFlatSummaryToSnapshotTreeAndBlobs,\n    GitManager,\n    ISummaryUploadManager,\n    WholeSummaryUploadManager,\n} from \"@fluidframework/server-services-client\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { ICache, InMemoryCache } from \"./cache\";\nimport { ISnapshotTreeVersion } from \"./definitions\";\nimport { IRouterliciousDriverPolicies } from \"./policies\";\n\nconst latestSnapshotId: string = \"latest\";\n\nexport class WholeSummaryDocumentStorageService implements IDocumentStorageService {\n    private readonly summaryUploadManager: ISummaryUploadManager;\n    private firstVersionsCall: boolean = true;\n\n    public get repositoryUrl(): string {\n        return \"\";\n    }\n\n    constructor(\n        protected readonly id: string,\n        protected readonly manager: GitManager,\n        protected readonly logger: ITelemetryLogger,\n        public readonly policies: IDocumentStorageServicePolicies = {},\n        private readonly driverPolicies?: IRouterliciousDriverPolicies,\n        private readonly blobCache: ICache<ArrayBufferLike> = new InMemoryCache(),\n        private readonly snapshotTreeCache: ICache<ISnapshotTreeVersion> = new InMemoryCache(),\n        protected readonly noCacheGitManager?: GitManager) {\n        this.summaryUploadManager = new WholeSummaryUploadManager(manager);\n    }\n\n    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {\n        if (versionId !== this.id && versionId !== null) {\n            // Blobs/Trees in this scenario will never have multiple versions, so return versionId as is\n            return [{\n                id: versionId,\n                treeId: undefined!,\n            }];\n        }\n        // If this is the first versions call for the document, we know we will want the latest summary.\n        // Fetch latest summary, cache it, and return its id.\n        if (this.firstVersionsCall && count === 1) {\n            this.firstVersionsCall = false;\n            const { id: _id, snapshotTree } = !this.driverPolicies?.enableDiscovery ?\n                await this.fetchAndCacheSnapshotTree(latestSnapshotId, false) :\n                await this.fetchAndCacheSnapshotTree(latestSnapshotId, true);\n            return [{\n                id: _id,\n                treeId: snapshotTree.id!,\n            }];\n        }\n\n        // Otherwise, get the latest version of the document as normal.\n        const id = versionId ? versionId : this.id;\n        const commits = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"getVersions\",\n                versionId: id,\n                count,\n            },\n            async () => this.manager.getCommits(id, count),\n        );\n        return commits.map((commit) => ({\n            date: commit.commit.author.date,\n            id: commit.sha,\n            treeId: commit.commit.tree.sha,\n        }));\n    }\n\n    public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {\n        let requestVersion = version;\n        if (!requestVersion) {\n            const versions = await this.getVersions(this.id, 1);\n            if (versions.length === 0) {\n                return null;\n            }\n\n            requestVersion = versions[0];\n        }\n\n        return (await this.fetchAndCacheSnapshotTree(requestVersion.id)).snapshotTree;\n    }\n\n    public async readBlob(blobId: string): Promise<ArrayBufferLike> {\n        const cachedBlob = await this.blobCache.get(blobId);\n        if (cachedBlob !== undefined) {\n            return cachedBlob;\n        }\n\n        const blob = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"readBlob\",\n                blobId,\n            },\n            async (event) => {\n                const response = await this.manager.getBlob(blobId);\n                event.end({\n                    size: response.size,\n                });\n                return response;\n            },\n        );\n        const bufferValue = stringToBuffer(blob.content, blob.encoding);\n\n        await this.blobCache.put(blob.sha, bufferValue);\n\n        return bufferValue;\n    }\n\n    public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {\n        const summaryHandle = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"uploadSummaryWithContext\",\n            },\n            async () => this.summaryUploadManager.writeSummaryTree(summary, context.ackHandle ?? \"\", \"channel\"),\n        );\n        return summaryHandle;\n    }\n\n    public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {\n        throw new Error(\"NOT IMPLEMENTED!\");\n    }\n\n    public async write(tree: ITree, parents: string[], message: string, ref: string): Promise<IVersion> {\n        throw new Error(\"NOT IMPLEMENTED!\");\n    }\n\n    public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {\n        const uint8ArrayFile = new Uint8Array(file);\n        return PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"createBlob\",\n                size: uint8ArrayFile.length,\n            },\n            async (event) => {\n                const response = await this.manager.createBlob(\n                    Uint8ArrayToString(\n                        uint8ArrayFile, \"base64\"),\n                    \"base64\").then((r) => ({ id: r.sha, url: r.url }));\n                event.end({\n                    blobId: response.id,\n                });\n                return response;\n            },\n        );\n    }\n\n    private async fetchAndCacheSnapshotTree(versionId: string, disableCache?: boolean): Promise<ISnapshotTreeVersion> {\n        const cachedSnapshotTreeVersion = await this.snapshotTreeCache.get(versionId);\n        if (cachedSnapshotTreeVersion !== undefined) {\n            return { id: cachedSnapshotTreeVersion.id, snapshotTree: cachedSnapshotTreeVersion.snapshotTree };\n        }\n\n        const wholeFlatSummary = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            {\n                eventName: \"getWholeFlatSummary\",\n                treeId: versionId,\n            },\n            async (event) => {\n                const response = disableCache && this.noCacheGitManager !== undefined ?\n                    await this.noCacheGitManager.getSummary(versionId) :\n                    await this.manager.getSummary(versionId);\n                event.end({\n                    size: response.trees[0]?.entries.length,\n                });\n                return response;\n            },\n        );\n        const normalizedWholeSummary = convertWholeFlatSummaryToSnapshotTreeAndBlobs(wholeFlatSummary);\n        const wholeFlatSummaryId: string = wholeFlatSummary.id;\n        const snapshotTreeId = normalizedWholeSummary.snapshotTree.id;\n        assert(snapshotTreeId !== undefined, 0x275 /* \"Root tree should contain the id\" */);\n        const snapshotTreeVersion = { id: wholeFlatSummaryId, snapshotTree: normalizedWholeSummary.snapshotTree };\n\n        const cachePs: Promise<any>[] = [\n            this.snapshotTreeCache.put(\n                snapshotTreeId,\n                snapshotTreeVersion,\n            ),\n            this.initBlobCache(normalizedWholeSummary.blobs),\n        ];\n        if (snapshotTreeId !== versionId) {\n            // versionId could be \"latest\". When summarizer checks cache for \"latest\", we want it to be available.\n            // TODO: For in-memory cache, <latest,snapshotTree> will be a shared pointer with <snapshotId,snapshotTree>,\n            // However, for something like Redis, this will cache the same value twice. Alternatively, could we simply\n            // cache with versionId?\n            cachePs.push(this.snapshotTreeCache.put(\n                versionId,\n                snapshotTreeVersion,\n            ));\n        }\n\n        await Promise.all(cachePs);\n\n        return snapshotTreeVersion;\n    }\n\n    private async initBlobCache(blobs: Map<string, ArrayBuffer>): Promise<void> {\n        const blobCachePutPs: Promise<void>[] = [];\n        blobs.forEach((value, id) => {\n            blobCachePutPs.push(this.blobCache.put(id, value));\n        });\n        await Promise.all(blobCachePutPs);\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/routerlicious-driver",
-  "version": "0.59.1001-62246",
+  "version": "0.59.2000",
   "description": "Socket.IO + Git implementation of Fluid service API",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -16,7 +16,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run tsc && npm run build:test",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
     "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
     "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
@@ -36,7 +36,8 @@
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
     "tsfmt": "tsfmt --verify",
-    "tsfmt:fix": "tsfmt --replace"
+    "tsfmt:fix": "tsfmt --replace",
+    "typetests:gen": "fluid-type-validator -g -d ."
   },
   "nyc": {
     "all": true,
@@ -61,14 +62,14 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/driver-base": "0.59.1001-62246",
+    "@fluidframework/driver-base": "^0.59.2000",
     "@fluidframework/driver-definitions": "^0.46.1000",
-    "@fluidframework/driver-utils": "0.59.1001-62246",
+    "@fluidframework/driver-utils": "^0.59.2000",
     "@fluidframework/gitresources": "^0.1036.1000",
     "@fluidframework/protocol-base": "^0.1036.1000",
     "@fluidframework/protocol-definitions": "^0.1028.1000",
     "@fluidframework/server-services-client": "^0.1036.1000",
-    "@fluidframework/telemetry-utils": "0.59.1001-62246",
+    "@fluidframework/telemetry-utils": "^0.59.2000",
     "cross-fetch": "^3.1.5",
     "json-stringify-safe": "5.0.1",
     "socket.io-client": "^4.4.1",
@@ -78,9 +79,9 @@
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
     "@fluidframework/eslint-config-fluid": "^0.28.1000",
-    "@fluidframework/mocha-test-setup": "0.59.1001-62246",
-    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@^0.58.0",
-    "@microsoft/api-extractor": "^7.16.1",
+    "@fluidframework/mocha-test-setup": "^0.59.2000",
+    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@0.59.1000",
+    "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",
     "@types/nock": "^9.3.0",
@@ -96,8 +97,11 @@
     "eslint-plugin-editorconfig": "~3.2.0",
     "eslint-plugin-eslint-comments": "~3.2.0",
     "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-no-null": "~1.0.2",
+    "eslint-plugin-jest": "~26.1.3",
+    "eslint-plugin-mocha": "~10.0.3",
+    "eslint-plugin-promise": "~6.0.0",
     "eslint-plugin-react": "~7.28.0",
+    "eslint-plugin-tsdoc": "~0.2.14",
     "eslint-plugin-unicorn": "~40.0.0",
     "mocha": "^8.4.0",
     "nock": "^10.0.1",
@@ -107,7 +111,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.1000",
+    "version": "0.59.2000",
     "broken": {}
   }
 }

package/src/documentDeltaConnection.ts

@@ -10,6 +10,7 @@ import { IAnyDriverError } from "@fluidframework/driver-utils";
 import { IClient, IConnect } from "@fluidframework/protocol-definitions";
 import type { io as SocketIOClientStatic } from "socket.io-client";
 import { errorObjectFromSocketError, IR11sSocketError } from "./errorUtils";
+import { pkgVersion as driverVersion } from "./packageVersion";
 
 const protocolVersions = ["^0.4.0", "^0.3.0", "^0.2.0", "^0.1.0"];
 
@@ -47,6 +48,7 @@ export class R11sDocumentDeltaConnection extends DocumentDeltaConnection
             tenantId,
             token,  // Token is going to indicate tenant level information, etc...
             versions: protocolVersions,
+            relayUserAgent: [client.details.environment, ` driverVersion:${driverVersion}`].join(";"),
         };
 
         // TODO: expose to host at factory level
@@ -62,7 +64,7 @@ export class R11sDocumentDeltaConnection extends DocumentDeltaConnection
      */
     protected createErrorObject(handler: string, error?: any, canRetry = true): IAnyDriverError {
         // Note: we suspect the incoming error object is either:
-        // - a socketError: add it to the OdspError object for driver to be able to parse it and reason over it.
+        // - a socketError: add it to the R11sError object for driver to be able to parse it and reason over it.
         // - anything else: let base class handle it
         if (canRetry && Number.isInteger(error?.code) && typeof error?.message === "string") {
             return errorObjectFromSocketError(error as IR11sSocketError, handler);

package/src/documentService.ts

@@ -74,6 +74,12 @@ export class DocumentService implements api.IDocumentService {
             false,
             storageRestWrapper);
         const gitManager = new GitManager(historian);
+        const noCacheHistorian = new Historian(
+            this.gitUrl,
+            true,
+            true,
+            storageRestWrapper);
+        const noCacheGitManager = new GitManager(noCacheHistorian);
         const documentStorageServicePolicies: api.IDocumentStorageServicePolicies = {
             caching: this.driverPolicies.enablePrefetch
                 ? api.LoaderCachingPolicy.Prefetch
@@ -88,7 +94,8 @@ export class DocumentService implements api.IDocumentService {
             documentStorageServicePolicies,
             this.driverPolicies,
             this.blobCache,
-            this.snapshotTreeCache);
+            this.snapshotTreeCache,
+            noCacheGitManager);
         return this.documentStorageService;
     }
 
@@ -142,7 +149,7 @@ export class DocumentService implements api.IDocumentService {
         try {
             const connection = await connect();
             return connection;
-        } catch (error) {
+        } catch (error: any) {
             if (error?.statusCode === 401) {
                 // Fetch new token and retry once,
                 // otherwise 401 will be bubbled up as non-retriable AuthorizationError.

package/src/documentServiceFactory.ts

@@ -18,12 +18,13 @@ import {
     RateLimiter,
 } from "@fluidframework/driver-utils";
 import { ChildLogger } from "@fluidframework/telemetry-utils";
+import { ISession } from "@fluidframework/server-services-client";
 import { DocumentService } from "./documentService";
 import { IRouterliciousDriverPolicies } from "./policies";
 import { ITokenProvider } from "./tokens";
 import { RouterliciousOrdererRestWrapper } from "./restWrapper";
 import { convertSummaryToCreateNewSummary } from "./createNewUtils";
-import { parseFluidUrl, replaceDocumentIdInPath } from "./urlUtils";
+import { parseFluidUrl, replaceDocumentIdInPath, getDiscoveredFluidResolvedUrl } from "./urlUtils";
 import { InMemoryCache } from "./cache";
 import { pkgVersion as driverVersion } from "./packageVersion";
 import { ISnapshotTreeVersion } from "./definitions";
@@ -33,6 +34,7 @@ const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
     maxConcurrentStorageRequests: 100,
     maxConcurrentOrdererRequests: 100,
     aggregateBlobsSmallerThanBytes: undefined,
+    enableDiscovery: false,
     enableWholeSummaryUpload: false,
     enableRestLess: true,
 };
@@ -66,7 +68,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         ensureFluidResolvedUrl(resolvedUrl);
         assert(!!createNewSummary, 0x204 /* "create empty file not supported" */);
         assert(!!resolvedUrl.endpoints.ordererUrl, 0x0b2 /* "Missing orderer URL!" */);
-        const parsedUrl = parseFluidUrl(resolvedUrl.url);
+        let parsedUrl = parseFluidUrl(resolvedUrl.url);
         if (!parsedUrl.pathname) {
             throw new Error("Parsed url should contain tenant and doc Id!!");
         }
@@ -92,15 +94,14 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
             resolvedUrl.endpoints.ordererUrl,
         );
 
-        // the backend responds with the actual document ID associated with the new container.
-
         // @TODO: Remove returned "string" type when removing back-compat code
-        const res = await ordererRestWrapper.post<{ id: string, token?: string } | string>(
+        const res = await ordererRestWrapper.post<{ id: string, token?: string, session?: ISession } | string>(
             `/documents/${tenantId}`,
             {
                 summary: convertSummaryToCreateNewSummary(appSummary),
                 sequenceNumber: documentAttributes.sequenceNumber,
                 values: quorumValues,
+                enableDiscovery: this.driverPolicies.enableDiscovery,
                 generateToken: this.tokenProvider.documentPostCreateCallback !== undefined,
             },
         );
@@ -111,13 +112,21 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 
         let documentId: string;
         let token: string | undefined;
-
+        let session: ISession | undefined;
+        let fluidResolvedUrl: IResolvedUrl;
         if (typeof res === "string") {
             documentId = res;
         } else {
             documentId = res.id;
             token = res.token;
+            session = res.session;
         }
+        if (session && this.driverPolicies.enableDiscovery) {
+            fluidResolvedUrl = getDiscoveredFluidResolvedUrl(resolvedUrl, session);
+        } else {
+            fluidResolvedUrl = resolvedUrl;
+        }
+        parsedUrl = parseFluidUrl(fluidResolvedUrl.url);
 
         // @TODO: Remove token from the condition, checking the documentPostCreateCallback !== undefined
         // is sufficient to determine if the token will be undefined or not.
@@ -126,7 +135,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         }
 
         parsedUrl.set("pathname", replaceDocumentIdInPath(parsedUrl.pathname, documentId));
-        const deltaStorageUrl = resolvedUrl.endpoints.deltaStorageUrl;
+        const deltaStorageUrl = fluidResolvedUrl.endpoints.deltaStorageUrl;
         if (!deltaStorageUrl) {
             throw new Error(
                 `All endpoints urls must be provided. [deltaStorageUrl:${deltaStorageUrl}]`);
@@ -136,16 +145,17 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 
         return this.createDocumentService(
             {
-                ...resolvedUrl,
+                ...fluidResolvedUrl,
                 url: parsedUrl.toString(),
                 id: documentId,
                 endpoints: {
-                    ...resolvedUrl.endpoints,
+                    ...fluidResolvedUrl.endpoints,
                     deltaStorageUrl: parsedDeltaStorageUrl.toString(),
                 },
             },
             logger,
             clientIsSummarizer,
+            true,
         );
     }
 
@@ -159,10 +169,40 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         resolvedUrl: IResolvedUrl,
         logger?: ITelemetryBaseLogger,
         clientIsSummarizer?: boolean,
+        isCreateContainer?: boolean,
     ): Promise<IDocumentService> {
         ensureFluidResolvedUrl(resolvedUrl);
 
-        const fluidResolvedUrl = resolvedUrl;
+        const parsedUrl = parseFluidUrl(resolvedUrl.url);
+        const [, tenantId, documentId] = parsedUrl.pathname.split("/");
+        if (!documentId || !tenantId) {
+            throw new Error(
+                `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);
+        }
+        const logger2 = ChildLogger.create(logger, "RouterliciousDriver", { all: { driverVersion }});
+
+        let fluidResolvedUrl: IResolvedUrl;
+        if (!isCreateContainer && this.driverPolicies.enableDiscovery) {
+            const rateLimiter = new RateLimiter(this.driverPolicies.maxConcurrentOrdererRequests);
+            const ordererRestWrapper = await RouterliciousOrdererRestWrapper.load(
+                tenantId,
+                documentId,
+                this.tokenProvider,
+                logger2,
+                rateLimiter,
+                this.driverPolicies.enableRestLess,
+                resolvedUrl.endpoints.ordererUrl,
+            );
+
+            // the backend responds with the actual document session associated with the container.
+            const session: ISession = await ordererRestWrapper.get<ISession>(
+                `/documents/${tenantId}/session/${documentId}`,
+            );
+            fluidResolvedUrl = getDiscoveredFluidResolvedUrl(resolvedUrl, session);
+        } else {
+            fluidResolvedUrl = resolvedUrl;
+        }
+
         const storageUrl = fluidResolvedUrl.endpoints.storageUrl;
         const ordererUrl = fluidResolvedUrl.endpoints.ordererUrl;
         const deltaStorageUrl = fluidResolvedUrl.endpoints.deltaStorageUrl;
@@ -171,15 +211,6 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
                 `All endpoints urls must be provided. [ordererUrl:${ordererUrl}][deltaStorageUrl:${deltaStorageUrl}]`);
         }
 
-        const parsedUrl = parseFluidUrl(fluidResolvedUrl.url);
-        const [, tenantId, documentId] = parsedUrl.pathname.split("/");
-        if (!documentId || !tenantId) {
-            throw new Error(
-                `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);
-        }
-
-        const logger2 = ChildLogger.create(logger, "RouterliciousDriver", { all: { driverVersion }});
-
         return new DocumentService(
             fluidResolvedUrl,
             ordererUrl,

package/src/documentStorageService.ts

@@ -37,15 +37,18 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
         policies: IDocumentStorageServicePolicies,
         driverPolicies?: IRouterliciousDriverPolicies,
         blobCache?: ICache<ArrayBufferLike>,
-        snapshotTreeCache?: ICache<ISnapshotTreeVersion>): IDocumentStorageService {
+        snapshotTreeCache?: ICache<ISnapshotTreeVersion>,
+        noCacheGitManager?: GitManager): IDocumentStorageService {
         const storageService = driverPolicies?.enableWholeSummaryUpload ?
             new WholeSummaryDocumentStorageService(
                 id,
                 manager,
                 logger,
                 policies,
+                driverPolicies,
                 blobCache,
                 snapshotTreeCache,
+                noCacheGitManager,
             ) :
             new ShreddedSummaryDocumentStorageService(
                 id,
@@ -70,7 +73,8 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
         policies: IDocumentStorageServicePolicies = {},
         driverPolicies?: IRouterliciousDriverPolicies,
         blobCache?: ICache<ArrayBufferLike>,
-        snapshotTreeCache?: ICache<ISnapshotTreeVersion>) {
+        snapshotTreeCache?: ICache<ISnapshotTreeVersion>,
+        public noCacheGitManager?: GitManager) {
         super(DocumentStorageService.loadInternalDocumentStorageService(
             id,
             manager,
@@ -79,6 +83,7 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
             driverPolicies,
             blobCache,
             snapshotTreeCache,
+            noCacheGitManager,
         ));
     }
 

package/src/errorUtils.ts

@@ -18,6 +18,7 @@ export enum R11sErrorType {
 
 /**
  * Interface for error responses for the WebSocket connection
+ * Intended to be compatible with output from {@link NetworkError.toJSON}
  */
 export interface IR11sSocketError {
     /**
@@ -36,6 +37,12 @@ export interface IR11sSocketError {
      * Optional Retry-After time in seconds.
      * The client should wait this many seconds before retrying its request.
      */
+    retryAfter?: number;
+
+    /**
+     * Optional Retry-After time in milliseconds.
+     * The client should wait this many milliseconds before retrying its request.
+     */
     retryAfterMs?: number;
 }
 
@@ -61,6 +68,8 @@ export function createR11sNetworkError(
             return new GenericNetworkError(
                 errorMessage, errorMessage.startsWith("NetworkError"), props);
         case 401:
+            // The first 401 is manually retried in RouterliciousRestWrapper with a refreshed token,
+            // so we treat repeat 401s the same as 403.
         case 403:
             return new AuthorizationError(
                 errorMessage, undefined, undefined, props);

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "0.59.1001-62246";
+export const pkgVersion = "0.59.2000";

package/src/policies.ts

@@ -32,6 +32,11 @@ export interface IRouterliciousDriverPolicies {
      * Default: false
      */
     enableWholeSummaryUpload: boolean;
+    /**
+     * Enable service endpoint discovery when creating or joining a session.
+     * Default: false
+     */
+    enableDiscovery?: boolean;
     /**
      * Enable using RestLess which avoids CORS preflight requests.
      * Default: true

package/src/restWrapper.ts

@@ -17,6 +17,7 @@ import safeStringify from "json-stringify-safe";
 import { v4 as uuid } from "uuid";
 import { throwR11sNetworkError } from "./errorUtils";
 import { ITokenProvider } from "./tokens";
+import { pkgVersion as driverVersion } from "./packageVersion";
 
 type AuthorizationHeaderGetter = (refresh?: boolean) => Promise<string | undefined>;
 
@@ -107,8 +108,10 @@ export class RouterliciousRestWrapper extends RestWrapper {
 
         return {
             ...requestHeaders,
+            // TODO: replace header names with CorrelationIdHeaderName and DriverVersionHeaderName from services-client
             // NOTE: Can correlationId actually be number | true?
             "x-correlation-id": correlationId as string,
+            "x-driver-version": driverVersion,
             // NOTE: If this.authorizationHeader is undefined, should "Authorization" be removed entirely?
             "Authorization": this.authorizationHeader!,
         };

package/src/urlUtils.ts

@@ -3,7 +3,9 @@
  * Licensed under the MIT License.
  */
 
+import { IFluidResolvedUrl } from "@fluidframework/driver-definitions";
 import URLParse from "url-parse";
+import { ISession } from "@fluidframework/server-services-client";
 
 export const parseFluidUrl = (fluidUrl: string): URLParse => {
     return new URLParse(fluidUrl, true);
@@ -17,3 +19,32 @@ export const parseFluidUrl = (fluidUrl: string): URLParse => {
  */
 export const replaceDocumentIdInPath = (urlPath: string, documentId: string): string =>
     urlPath.split("/").slice(0, -1).concat([documentId]).join("/");
+
+export const getDiscoveredFluidResolvedUrl = (resolvedUrl: IFluidResolvedUrl, session: ISession): IFluidResolvedUrl => {
+    if (session) {
+        const discoveredOrdererUrl = new URLParse(session.ordererUrl);
+        const deltaStorageUrl = new URLParse(resolvedUrl.endpoints.deltaStorageUrl);
+        deltaStorageUrl.set("host", discoveredOrdererUrl.host);
+
+        const discoveredStorageUrl = new URLParse(session.historianUrl);
+        const storageUrl = new URLParse(resolvedUrl.endpoints.storageUrl);
+        storageUrl.set("host", discoveredStorageUrl.host);
+
+        const parsedUrl = parseFluidUrl(resolvedUrl.url);
+        const discoveredResolvedUrl: IFluidResolvedUrl = {
+            endpoints: {
+                deltaStorageUrl: deltaStorageUrl.toString(),
+                ordererUrl: session.ordererUrl,
+                storageUrl: storageUrl.toString(),
+            },
+            id: resolvedUrl.id,
+            tokens: resolvedUrl.tokens,
+            type: resolvedUrl.type,
+            url: new URLParse(`fluid://${discoveredOrdererUrl.host}${parsedUrl.pathname}`).toString(),
+        };
+
+        return discoveredResolvedUrl;
+    } else {
+        return resolvedUrl;
+    }
+};

package/src/wholeSummaryDocumentStorageService.ts

@@ -13,7 +13,7 @@ import {
     IDocumentStorageService,
     ISummaryContext,
     IDocumentStorageServicePolicies,
- } from "@fluidframework/driver-definitions";
+} from "@fluidframework/driver-definitions";
 import {
     ICreateBlobResponse,
     ISnapshotTree,
@@ -31,6 +31,7 @@ import {
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { ICache, InMemoryCache } from "./cache";
 import { ISnapshotTreeVersion } from "./definitions";
+import { IRouterliciousDriverPolicies } from "./policies";
 
 const latestSnapshotId: string = "latest";
 
@@ -47,8 +48,10 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         protected readonly manager: GitManager,
         protected readonly logger: ITelemetryLogger,
         public readonly policies: IDocumentStorageServicePolicies = {},
+        private readonly driverPolicies?: IRouterliciousDriverPolicies,
         private readonly blobCache: ICache<ArrayBufferLike> = new InMemoryCache(),
-        private readonly snapshotTreeCache: ICache<ISnapshotTreeVersion> = new InMemoryCache()) {
+        private readonly snapshotTreeCache: ICache<ISnapshotTreeVersion> = new InMemoryCache(),
+        protected readonly noCacheGitManager?: GitManager) {
         this.summaryUploadManager = new WholeSummaryUploadManager(manager);
     }
 
@@ -64,7 +67,9 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         // Fetch latest summary, cache it, and return its id.
         if (this.firstVersionsCall && count === 1) {
             this.firstVersionsCall = false;
-            const { id: _id, snapshotTree } = await this.fetchAndCacheSnapshotTree(latestSnapshotId);
+            const { id: _id, snapshotTree } = !this.driverPolicies?.enableDiscovery ?
+                await this.fetchAndCacheSnapshotTree(latestSnapshotId, false) :
+                await this.fetchAndCacheSnapshotTree(latestSnapshotId, true);
             return [{
                 id: _id,
                 treeId: snapshotTree.id!,
@@ -170,7 +175,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         );
     }
 
-    private async fetchAndCacheSnapshotTree(versionId: string): Promise<ISnapshotTreeVersion> {
+    private async fetchAndCacheSnapshotTree(versionId: string, disableCache?: boolean): Promise<ISnapshotTreeVersion> {
         const cachedSnapshotTreeVersion = await this.snapshotTreeCache.get(versionId);
         if (cachedSnapshotTreeVersion !== undefined) {
             return { id: cachedSnapshotTreeVersion.id, snapshotTree: cachedSnapshotTreeVersion.snapshotTree };
@@ -183,7 +188,9 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
                 treeId: versionId,
             },
             async (event) => {
-                const response = await this.manager.getSummary(versionId);
+                const response = disableCache && this.noCacheGitManager !== undefined ?
+                    await this.noCacheGitManager.getSummary(versionId) :
+                    await this.manager.getSummary(versionId);
                 event.end({
                     size: response.trees[0]?.entries.length,
                 });
@@ -194,7 +201,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         const wholeFlatSummaryId: string = wholeFlatSummary.id;
         const snapshotTreeId = normalizedWholeSummary.snapshotTree.id;
         assert(snapshotTreeId !== undefined, 0x275 /* "Root tree should contain the id" */);
-        const snapshotTreeVersion = { id: wholeFlatSummaryId , snapshotTree: normalizedWholeSummary.snapshotTree };
+        const snapshotTreeVersion = { id: wholeFlatSummaryId, snapshotTree: normalizedWholeSummary.snapshotTree };
 
         const cachePs: Promise<any>[] = [
             this.snapshotTreeCache.put(