@fluidframework/odsp-driver 0.58.2002 → 0.58.3000-61081

package/lib/odspSummaryUploadManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspSummaryUploadManager.js","sourceRoot":"","sources":["../src/odspSummaryUploadManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE3F,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAE5D,OAAO,EAAE,yBAAyB,EAAqB,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAUjH,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE1D,4BAA4B;AAE5B;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAKjC,YACqB,WAAmB,EACnB,eAAgD,EACjE,MAAwB,EACP,YAA0B,EAC1B,sCAA+C;QAJ/C,gBAAW,GAAX,WAAW,CAAQ;QACnB,oBAAe,GAAf,eAAe,CAAiC;QAEhD,iBAAY,GAAZ,YAAY,CAAc;QAC1B,2CAAsC,GAAtC,sCAAsC,CAAS;QAEhE,IAAI,CAAC,EAAE,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,IAAsB,EAAE,OAAwB;QAC1E,8HAA8H;QAC9H,gIAAgI;QAChI,6GAA6G;QAC7G,IAAI,IAAI,CAAC,yBAAyB,KAAK,SAAS;YAC5C,IAAI,CAAC,yBAAyB,KAAK,OAAO,CAAC,cAAc,EAAE;YAC3D,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBAC9B,SAAS,EAAE,mCAAmC;gBAC9C,0BAA0B,EAAE,OAAO,CAAC,cAAc;gBAClD,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;aAC5D,CAAC,CAAC;SACN;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;QACzG,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1C,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,yBAAyB,GAAG,EAAE,CAAC;QACpC,OAAO,EAAE,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAC9B,YAAgC,EAChC,uBAA+B,EAC/B,IAAsB;QAEtB,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,4BAA4B,CACnE,YAAY,EACZ,IAAI,EACJ,MAAM,EACN,EAAE,CACL,CAAC;QACF,MAAM,QAAQ,GAAwB;YAClC,OAAO,EAAE,YAAY,CAAC,OAAQ;YAC9B,OAAO,EAAE,KAAK;YACd,cAAc,EAAE,uBAAuB;YACvC,2EAA2E;YAC3E,oEAAoE;YACpE,IAAI,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;SAC7D,CAAC;QAEF,OAAO,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;YAE7E,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,GAAG,IAAI,CAAC,WAAW,WAAW,EAC9B,YAAY,EACZ,IAAI,CAAC,sCAAsC,CAC9C,CAAC;YACF,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAC7C,IAAI,YAAY,EAAE;gBACd,OAAO,CAAC,UAAU,CAAC,GAAG,qBAAqB,YAAY,EAAE,CAAC;aAC7D;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAE1C,OAAO,gBAAgB,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EACjD;gBACI,SAAS,EAAE,eAAe;gBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM;gBAC3B,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ;gBAC/B,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;gBAC7D,KAAK;gBACL,IAAI,EAAE,QAAQ,CAAC,MAAM;gBACrB,uBAAuB;aAC1B,EACD,KAAK,IAAI,EAAE;gBACP,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,mBAAmB,CACxD,GAAG,EACH;oBACI,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,MAAM,EAAE,MAAM;iBACjB,EACD,eAAe,CAAC,CAAC;gBACrB,OAAO,QAAQ,CAAC,OAAO,CAAC;YAC5B,CAAC,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,4BAA4B,CACtC,YAAgC,EAChC,IAAsB,EACtB,YAAoB,EACpB,IAAiB,EACjB,qBAA6G;;6BAD7G,EAAA,SAAiB;8CACjB,EAAA,8BAAiC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,yCAAyC,CAAC,mCAAI,IAAI;QAE7G,MAAM,YAAY,GAAqB;YACnC,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,EAA4B;SACxC,CAAC;QAEF,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACpB,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAErC,IAAI,EAAsB,CAAC;YAC3B,IAAI,KAAuC,CAAC;YAE5C,yGAAyG;YACzG,sGAAsG;YACtG,yFAAyF;YACzF,IAAI,YAA8B,CAAC;YACnC,MAAM,WAAW,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC;YAC9E,QAAQ,aAAa,CAAC,IAAI,EAAE;gBACxB,KAAK,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAClD,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,WAAW,CAAC,CAAC;oBACjB,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC;oBAC5B,YAAY,GAAG,qBAAqB,CAAC,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC9E,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC;oBACtB,MAAM;iBACT;gBACD,KAAK,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBACvB,IAAI,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,EAAE;wBAC3C,KAAK,GAAG;4BACJ,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,aAAa,CAAC,OAAO;4BAC9B,QAAQ,EAAE,OAAO;yBACpB,CAAC;qBACL;yBAAM;wBACH,KAAK,GAAG;4BACJ,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,kBAAkB,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC;4BAC5D,QAAQ,EAAE,QAAQ;yBACrB,CAAC;qBACL;oBACD,KAAK,EAAE,CAAC;oBACR,MAAM;iBACT;gBACD,KAAK,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;oBACzB,IAAI,CAAC,YAAY,EAAE;wBACf,MAAM,KAAK,CAAC,uDAAuD,CAAC,CAAC;qBACxE;oBACD,IAAI,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;oBACtC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;wBACtD,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;qBACjC;oBACD,MAAM,OAAO,GAAG,GAAG,YAAY,GAAG,UAAU,EAAE,CAAC;oBAC/C,EAAE,GAAG,GAAG,YAAY,IAAI,OAAO,EAAE,CAAC;oBAClC,MAAM;iBACT;gBACD,KAAK,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;oBAC7B,EAAE,GAAG,aAAa,CAAC,EAAE,CAAC;oBACtB,MAAM;iBACT;gBACD,OAAO,CAAC,CAAC;oBACL,eAAe,CAAC,aAAa,EAAE,iBAAkB,aAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;iBAClF;aACJ;YAED,MAAM,SAAS,GAA8B;gBACzC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC;gBAC7B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC;aAClC,CAAC;YAEF,IAAI,KAA2B,CAAC;YAEhC,IAAI,KAAK,EAAE;gBACP,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;gBAClG,KAAK,iCACD,KAAK,IACF,SAAS,KACZ,YAAY,GACf,CAAC;aACL;iBAAM,IAAI,EAAE,EAAE;gBACX,KAAK,mCACE,SAAS,KACZ,EAAE,GACL,CAAC;aACL;iBAAM;gBACH,MAAM,IAAI,KAAK,CAAC,0BAA0B,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;aACnE;YAED,YAAY,CAAC,OAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACrC;QAED,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;IACnC,CAAC;CACJ;AAED,2BAA2B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, Uint8ArrayToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { ISummaryContext } from \"@fluidframework/driver-definitions\";\nimport { getGitType } from \"@fluidframework/protocol-base\";\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport { InstrumentedStorageTokenFetcher } from \"@fluidframework/odsp-driver-definitions\";\nimport { loggerToMonitoringContext, MonitoringContext, PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IOdspSummaryPayload,\n    IWriteSummaryResponse,\n    IOdspSummaryTree,\n    IOdspSummaryTreeBaseEntry,\n    OdspSummaryTreeEntry,\n    OdspSummaryTreeValue,\n} from \"./contracts\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport { getWithRetryForTokenRefresh } from \"./odspUtils\";\n\n/* eslint-disable max-len */\n\n/**\n * This class manages a summary upload. When it receives a call to upload summary, it converts the summary tree into\n * a snapshot tree and then uploads that to the server.\n */\nexport class OdspSummaryUploadManager {\n    // Last proposed handle of the uploaded app summary.\n    private lastSummaryProposalHandle: string | undefined;\n    private readonly mc: MonitoringContext;\n\n    constructor(\n        private readonly snapshotUrl: string,\n        private readonly getStorageToken: InstrumentedStorageTokenFetcher,\n        logger: ITelemetryLogger,\n        private readonly epochTracker: EpochTracker,\n        private readonly forceAccessTokenViaAuthorizationHeader: boolean,\n    ) {\n        this.mc = loggerToMonitoringContext(logger);\n    }\n\n    public async writeSummaryTree(tree: api.ISummaryTree, context: ISummaryContext) {\n        // If the last proposed handle is not the proposed handle of the acked summary(could happen when the last summary get nacked),\n        // then re-initialize the caches with the previous ones else just update the previous caches with the caches from acked summary.\n        // Don't bother logging if lastSummaryProposalHandle hasn't been set before; only log on a positive mismatch.\n        if (this.lastSummaryProposalHandle !== undefined &&\n            this.lastSummaryProposalHandle !== context.proposalHandle) {\n            this.mc.logger.sendTelemetryEvent({\n                eventName: \"LastSummaryProposedHandleMismatch\",\n                ackedSummaryProposedHandle: context.proposalHandle,\n                lastSummaryProposalHandle: this.lastSummaryProposalHandle,\n            });\n        }\n        const result = await this.writeSummaryTreeCore(context.ackHandle, context.referenceSequenceNumber, tree);\n        const id = result ? result.id : undefined;\n        if (!result || !id) {\n            throw new Error(`Failed to write summary tree`);\n        }\n        this.lastSummaryProposalHandle = id;\n        return id;\n    }\n\n    private async writeSummaryTreeCore(\n        parentHandle: string | undefined,\n        referenceSequenceNumber: number,\n        tree: api.ISummaryTree,\n    ): Promise<IWriteSummaryResponse> {\n        const { snapshotTree, blobs } = await this.convertSummaryToSnapshotTree(\n            parentHandle,\n            tree,\n            \".app\",\n            \"\",\n        );\n        const snapshot: IOdspSummaryPayload = {\n            entries: snapshotTree.entries!,\n            message: \"app\",\n            sequenceNumber: referenceSequenceNumber,\n            // no ack handle implies this is initial summary after empty file creation.\n            // send container payload so server will use it without a summary op\n            type: parentHandle === undefined ? \"container\" : \"channel\",\n        };\n\n        return getWithRetryForTokenRefresh(async (options) => {\n            const storageToken = await this.getStorageToken(options, \"WriteSummaryTree\");\n\n            const { url, headers } = getUrlAndHeadersWithAuth(\n                `${this.snapshotUrl}/snapshot`,\n                storageToken,\n                this.forceAccessTokenViaAuthorizationHeader,\n            );\n            headers[\"Content-Type\"] = \"application/json\";\n            if (parentHandle) {\n                headers[\"If-Match\"] = `fluid:containerid=${parentHandle}`;\n            }\n\n            const postBody = JSON.stringify(snapshot);\n\n            return PerformanceEvent.timedExecAsync(this.mc.logger,\n                {\n                    eventName: \"uploadSummary\",\n                    attempt: options.refresh ? 2 : 1,\n                    hasClaims: !!options.claims,\n                    hasTenantId: !!options.tenantId,\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    blobs,\n                    size: postBody.length,\n                    referenceSequenceNumber,\n                },\n                async () => {\n                    const response = await this.epochTracker.fetchAndParseAsJSON<IWriteSummaryResponse>(\n                        url,\n                        {\n                            body: postBody,\n                            headers,\n                            method: \"POST\",\n                        },\n                        \"uploadSummary\");\n                    return response.content;\n                });\n        });\n    }\n\n    /**\n     * Following are the goals of this function.\n     *  a.) Converts the summary tree to a snapshot/odsp tree to be uploaded. Always upload full snapshot tree.\n     * @param parentHandle - Handle of the last uploaded summary or detach new summary.\n     * @param tree - Summary Tree which will be converted to snapshot tree to be uploaded.\n     * @param rootNodeName - Root node name of the summary tree.\n     * @param path - Current path of node which is getting evaluated.\n     * @param markUnreferencedNodes - True if we should mark unreferenced nodes.\n     */\n    private async convertSummaryToSnapshotTree(\n        parentHandle: string | undefined,\n        tree: api.ISummaryTree,\n        rootNodeName: string,\n        path: string = \"\",\n        markUnreferencedNodes: boolean = this.mc.config.getBoolean(\"Fluid.Driver.Odsp.MarkUnreferencedNodes\") ?? true,\n    ) {\n        const snapshotTree: IOdspSummaryTree = {\n            type: \"tree\",\n            entries: [] as OdspSummaryTreeEntry[],\n        };\n\n        let blobs = 0;\n        const keys = Object.keys(tree.tree);\n        for (const key of keys) {\n            const summaryObject = tree.tree[key];\n\n            let id: string | undefined;\n            let value: OdspSummaryTreeValue | undefined;\n\n            // Tracks if an entry is unreferenced. Currently, only tree entries can be marked as unreferenced. If the\n            // property is not present, the tree entry is considered referenced. If the property is present and is\n            // true (which is the only value it can have), the tree entry is considered unreferenced.\n            let unreferenced: true | undefined;\n            const currentPath = path === \"\" ? `${rootNodeName}/${key}` : `${path}/${key}`;\n            switch (summaryObject.type) {\n                case api.SummaryType.Tree: {\n                    const result = await this.convertSummaryToSnapshotTree(\n                        parentHandle,\n                        summaryObject,\n                        rootNodeName,\n                        currentPath);\n                    value = result.snapshotTree;\n                    unreferenced = markUnreferencedNodes ? summaryObject.unreferenced : undefined;\n                    blobs += result.blobs;\n                    break;\n                }\n                case api.SummaryType.Blob: {\n                    if (typeof summaryObject.content === \"string\") {\n                        value = {\n                            type: \"blob\",\n                            content: summaryObject.content,\n                            encoding: \"utf-8\",\n                        };\n                    } else {\n                        value = {\n                            type: \"blob\",\n                            content: Uint8ArrayToString(summaryObject.content, \"base64\"),\n                            encoding: \"base64\",\n                        };\n                    }\n                    blobs++;\n                    break;\n                }\n                case api.SummaryType.Handle: {\n                    if (!parentHandle) {\n                        throw Error(\"Parent summary does not exist to reference by handle.\");\n                    }\n                    let handlePath = summaryObject.handle;\n                    if (handlePath.length > 0 && !handlePath.startsWith(\"/\")) {\n                        handlePath = `/${handlePath}`;\n                    }\n                    const pathKey = `${rootNodeName}${handlePath}`;\n                    id = `${parentHandle}/${pathKey}`;\n                    break;\n                }\n                case api.SummaryType.Attachment: {\n                    id = summaryObject.id;\n                    break;\n                }\n                default: {\n                    unreachableCase(summaryObject, `Unknown type: ${(summaryObject as any).type}`);\n                }\n            }\n\n            const baseEntry: IOdspSummaryTreeBaseEntry = {\n                path: encodeURIComponent(key),\n                type: getGitType(summaryObject),\n            };\n\n            let entry: OdspSummaryTreeEntry;\n\n            if (value) {\n                assert(id === undefined, 0x0ad /* \"Snapshot entry has both a tree value and a referenced id!\" */);\n                entry = {\n                    value,\n                    ...baseEntry,\n                    unreferenced,\n                };\n            } else if (id) {\n                entry = {\n                    ...baseEntry,\n                    id,\n                };\n            } else {\n                throw new Error(`Invalid tree entry for ${summaryObject.type}`);\n            }\n\n            snapshotTree.entries!.push(entry);\n        }\n\n        return { snapshotTree, blobs };\n    }\n}\n\n/* eslint-enable max-len */\n"]}
+{"version":3,"file":"odspSummaryUploadManager.js","sourceRoot":"","sources":["../src/odspSummaryUploadManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE3F,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAE5D,OAAO,EAAE,yBAAyB,EAAqB,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAUjH,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE1D,4BAA4B;AAE5B;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAKjC,YACqB,WAAmB,EACnB,eAAgD,EACjE,MAAwB,EACP,YAA0B,EAC1B,sCAA+C;QAJ/C,gBAAW,GAAX,WAAW,CAAQ;QACnB,oBAAe,GAAf,eAAe,CAAiC;QAEhD,iBAAY,GAAZ,YAAY,CAAc;QAC1B,2CAAsC,GAAtC,sCAAsC,CAAS;QAEhE,IAAI,CAAC,EAAE,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,IAAsB,EAAE,OAAwB;QAC1E,8HAA8H;QAC9H,gIAAgI;QAChI,6GAA6G;QAC7G,IAAI,IAAI,CAAC,yBAAyB,KAAK,SAAS;YAC5C,IAAI,CAAC,yBAAyB,KAAK,OAAO,CAAC,cAAc,EAAE;YAC3D,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBAC9B,SAAS,EAAE,mCAAmC;gBAC9C,0BAA0B,EAAE,OAAO,CAAC,cAAc;gBAClD,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;aAC5D,CAAC,CAAC;SACN;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;QACzG,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1C,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,yBAAyB,GAAG,EAAE,CAAC;QACpC,OAAO,EAAE,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAC9B,YAAgC,EAChC,uBAA+B,EAC/B,IAAsB;QAEtB,MAAM,gCAAgC,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,oDAAoD,CAAC,CAAC;QACzH,MAAM,oBAAoB,GAAG,gCAAgC;YACzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACjD,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,4BAA4B,CACnE,YAAY,EACZ,IAAI,EACJ,MAAM,CACT,CAAC;QACF,MAAM,QAAQ,GAAwB;YAClC,OAAO,EAAE,YAAY,CAAC,OAAQ;YAC9B,OAAO,EAAE,KAAK;YACd,cAAc,EAAE,uBAAuB;YACvC,2EAA2E;YAC3E,oEAAoE;YACpE,IAAI,EAAE,oBAAoB,IAAI,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;SACrF,CAAC;QAEF,OAAO,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;YAE7E,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,GAAG,IAAI,CAAC,WAAW,WAAW,EAC9B,YAAY,EACZ,IAAI,CAAC,sCAAsC,CAC9C,CAAC;YACF,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAC7C,IAAI,YAAY,EAAE;gBACd,OAAO,CAAC,UAAU,CAAC,GAAG,qBAAqB,YAAY,EAAE,CAAC;aAC7D;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAE1C,OAAO,gBAAgB,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EACjD;gBACI,SAAS,EAAE,eAAe;gBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM;gBAC3B,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ;gBAC/B,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;gBAC7D,KAAK;gBACL,IAAI,EAAE,QAAQ,CAAC,MAAM;gBACrB,uBAAuB;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,gCAAgC;aACnC,EACD,KAAK,IAAI,EAAE;gBACP,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,mBAAmB,CACxD,GAAG,EACH;oBACI,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,MAAM,EAAE,MAAM;iBACjB,EACD,eAAe,CAAC,CAAC;gBACrB,OAAO,QAAQ,CAAC,OAAO,CAAC;YAC5B,CAAC,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,4BAA4B,CACtC,YAAgC,EAChC,IAAsB,EACtB,YAAoB,EACpB,qBAA6G;;8CAA7G,EAAA,8BAAiC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,yCAAyC,CAAC,mCAAI,IAAI;QAE7G,MAAM,YAAY,GAAqB;YACnC,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,EAA4B;SACxC,CAAC;QAEF,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACpB,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAErC,IAAI,EAAsB,CAAC;YAC3B,IAAI,KAAuC,CAAC;YAE5C,yGAAyG;YACzG,sGAAsG;YACtG,yFAAyF;YACzF,IAAI,YAA8B,CAAC;YACnC,QAAQ,aAAa,CAAC,IAAI,EAAE;gBACxB,KAAK,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAClD,YAAY,EACZ,aAAa,EACb,YAAY,CAAC,CAAC;oBAClB,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC;oBAC5B,YAAY,GAAG,qBAAqB,CAAC,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC9E,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC;oBACtB,MAAM;iBACT;gBACD,KAAK,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBACvB,IAAI,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,EAAE;wBAC3C,KAAK,GAAG;4BACJ,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,aAAa,CAAC,OAAO;4BAC9B,QAAQ,EAAE,OAAO;yBACpB,CAAC;qBACL;yBAAM;wBACH,KAAK,GAAG;4BACJ,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,kBAAkB,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC;4BAC5D,QAAQ,EAAE,QAAQ;yBACrB,CAAC;qBACL;oBACD,KAAK,EAAE,CAAC;oBACR,MAAM;iBACT;gBACD,KAAK,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;oBACzB,IAAI,CAAC,YAAY,EAAE;wBACf,MAAM,KAAK,CAAC,uDAAuD,CAAC,CAAC;qBACxE;oBACD,IAAI,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;oBACtC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;wBACtD,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;qBACjC;oBACD,MAAM,OAAO,GAAG,GAAG,YAAY,GAAG,UAAU,EAAE,CAAC;oBAC/C,EAAE,GAAG,GAAG,YAAY,IAAI,OAAO,EAAE,CAAC;oBAClC,MAAM;iBACT;gBACD,KAAK,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;oBAC7B,EAAE,GAAG,aAAa,CAAC,EAAE,CAAC;oBACtB,MAAM;iBACT;gBACD,OAAO,CAAC,CAAC;oBACL,eAAe,CAAC,aAAa,EAAE,iBAAkB,aAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;iBAClF;aACJ;YAED,MAAM,SAAS,GAA8B;gBACzC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC;gBAC7B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC;aAClC,CAAC;YAEF,IAAI,KAA2B,CAAC;YAEhC,IAAI,KAAK,EAAE;gBACP,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;gBAClG,KAAK,iCACD,KAAK,IACF,SAAS,KACZ,YAAY,GACf,CAAC;aACL;iBAAM,IAAI,EAAE,EAAE;gBACX,KAAK,mCACE,SAAS,KACZ,EAAE,GACL,CAAC;aACL;iBAAM;gBACH,MAAM,IAAI,KAAK,CAAC,0BAA0B,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;aACnE;YAED,YAAY,CAAC,OAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACrC;QAED,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;IACnC,CAAC;CACJ;AAED,2BAA2B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, Uint8ArrayToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { ISummaryContext } from \"@fluidframework/driver-definitions\";\nimport { getGitType } from \"@fluidframework/protocol-base\";\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport { InstrumentedStorageTokenFetcher } from \"@fluidframework/odsp-driver-definitions\";\nimport { loggerToMonitoringContext, MonitoringContext, PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IOdspSummaryPayload,\n    IWriteSummaryResponse,\n    IOdspSummaryTree,\n    IOdspSummaryTreeBaseEntry,\n    OdspSummaryTreeEntry,\n    OdspSummaryTreeValue,\n} from \"./contracts\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport { getWithRetryForTokenRefresh } from \"./odspUtils\";\n\n/* eslint-disable max-len */\n\n/**\n * This class manages a summary upload. When it receives a call to upload summary, it converts the summary tree into\n * a snapshot tree and then uploads that to the server.\n */\nexport class OdspSummaryUploadManager {\n    // Last proposed handle of the uploaded app summary.\n    private lastSummaryProposalHandle: string | undefined;\n    private readonly mc: MonitoringContext;\n\n    constructor(\n        private readonly snapshotUrl: string,\n        private readonly getStorageToken: InstrumentedStorageTokenFetcher,\n        logger: ITelemetryLogger,\n        private readonly epochTracker: EpochTracker,\n        private readonly forceAccessTokenViaAuthorizationHeader: boolean,\n    ) {\n        this.mc = loggerToMonitoringContext(logger);\n    }\n\n    public async writeSummaryTree(tree: api.ISummaryTree, context: ISummaryContext) {\n        // If the last proposed handle is not the proposed handle of the acked summary(could happen when the last summary get nacked),\n        // then re-initialize the caches with the previous ones else just update the previous caches with the caches from acked summary.\n        // Don't bother logging if lastSummaryProposalHandle hasn't been set before; only log on a positive mismatch.\n        if (this.lastSummaryProposalHandle !== undefined &&\n            this.lastSummaryProposalHandle !== context.proposalHandle) {\n            this.mc.logger.sendTelemetryEvent({\n                eventName: \"LastSummaryProposedHandleMismatch\",\n                ackedSummaryProposedHandle: context.proposalHandle,\n                lastSummaryProposalHandle: this.lastSummaryProposalHandle,\n            });\n        }\n        const result = await this.writeSummaryTreeCore(context.ackHandle, context.referenceSequenceNumber, tree);\n        const id = result ? result.id : undefined;\n        if (!result || !id) {\n            throw new Error(`Failed to write summary tree`);\n        }\n        this.lastSummaryProposalHandle = id;\n        return id;\n    }\n\n    private async writeSummaryTreeCore(\n        parentHandle: string | undefined,\n        referenceSequenceNumber: number,\n        tree: api.ISummaryTree,\n    ): Promise<IWriteSummaryResponse> {\n        const enableContainerTypeSummaryUpload = this.mc.config.getBoolean(\"Fluid.Driver.Odsp.EnableContainerTypeSummaryUpload\");\n        const containsProtocolTree = enableContainerTypeSummaryUpload &&\n            Object.keys(tree.tree).includes(\".protocol\");\n        const { snapshotTree, blobs } = await this.convertSummaryToSnapshotTree(\n            parentHandle,\n            tree,\n            \".app\",\n        );\n        const snapshot: IOdspSummaryPayload = {\n            entries: snapshotTree.entries!,\n            message: \"app\",\n            sequenceNumber: referenceSequenceNumber,\n            // no ack handle implies this is initial summary after empty file creation.\n            // send container payload so server will use it without a summary op\n            type: containsProtocolTree || parentHandle === undefined ? \"container\" : \"channel\",\n        };\n\n        return getWithRetryForTokenRefresh(async (options) => {\n            const storageToken = await this.getStorageToken(options, \"WriteSummaryTree\");\n\n            const { url, headers } = getUrlAndHeadersWithAuth(\n                `${this.snapshotUrl}/snapshot`,\n                storageToken,\n                this.forceAccessTokenViaAuthorizationHeader,\n            );\n            headers[\"Content-Type\"] = \"application/json\";\n            if (parentHandle) {\n                headers[\"If-Match\"] = `fluid:containerid=${parentHandle}`;\n            }\n\n            const postBody = JSON.stringify(snapshot);\n\n            return PerformanceEvent.timedExecAsync(this.mc.logger,\n                {\n                    eventName: \"uploadSummary\",\n                    attempt: options.refresh ? 2 : 1,\n                    hasClaims: !!options.claims,\n                    hasTenantId: !!options.tenantId,\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    blobs,\n                    size: postBody.length,\n                    referenceSequenceNumber,\n                    type: snapshot.type,\n                    enableContainerTypeSummaryUpload,\n                },\n                async () => {\n                    const response = await this.epochTracker.fetchAndParseAsJSON<IWriteSummaryResponse>(\n                        url,\n                        {\n                            body: postBody,\n                            headers,\n                            method: \"POST\",\n                        },\n                        \"uploadSummary\");\n                    return response.content;\n                });\n        });\n    }\n\n    /**\n     * Following are the goals of this function.\n     *  a.) Converts the summary tree to a snapshot/odsp tree to be uploaded. Always upload full snapshot tree.\n     * @param parentHandle - Handle of the last uploaded summary or detach new summary.\n     * @param tree - Summary Tree which will be converted to snapshot tree to be uploaded.\n     * @param rootNodeName - Root node name of the summary tree.\n     * @param path - Current path of node which is getting evaluated.\n     * @param markUnreferencedNodes - True if we should mark unreferenced nodes.\n     */\n    private async convertSummaryToSnapshotTree(\n        parentHandle: string | undefined,\n        tree: api.ISummaryTree,\n        rootNodeName: string,\n        markUnreferencedNodes: boolean = this.mc.config.getBoolean(\"Fluid.Driver.Odsp.MarkUnreferencedNodes\") ?? true,\n    ) {\n        const snapshotTree: IOdspSummaryTree = {\n            type: \"tree\",\n            entries: [] as OdspSummaryTreeEntry[],\n        };\n\n        let blobs = 0;\n        const keys = Object.keys(tree.tree);\n        for (const key of keys) {\n            const summaryObject = tree.tree[key];\n\n            let id: string | undefined;\n            let value: OdspSummaryTreeValue | undefined;\n\n            // Tracks if an entry is unreferenced. Currently, only tree entries can be marked as unreferenced. If the\n            // property is not present, the tree entry is considered referenced. If the property is present and is\n            // true (which is the only value it can have), the tree entry is considered unreferenced.\n            let unreferenced: true | undefined;\n            switch (summaryObject.type) {\n                case api.SummaryType.Tree: {\n                    const result = await this.convertSummaryToSnapshotTree(\n                        parentHandle,\n                        summaryObject,\n                        rootNodeName);\n                    value = result.snapshotTree;\n                    unreferenced = markUnreferencedNodes ? summaryObject.unreferenced : undefined;\n                    blobs += result.blobs;\n                    break;\n                }\n                case api.SummaryType.Blob: {\n                    if (typeof summaryObject.content === \"string\") {\n                        value = {\n                            type: \"blob\",\n                            content: summaryObject.content,\n                            encoding: \"utf-8\",\n                        };\n                    } else {\n                        value = {\n                            type: \"blob\",\n                            content: Uint8ArrayToString(summaryObject.content, \"base64\"),\n                            encoding: \"base64\",\n                        };\n                    }\n                    blobs++;\n                    break;\n                }\n                case api.SummaryType.Handle: {\n                    if (!parentHandle) {\n                        throw Error(\"Parent summary does not exist to reference by handle.\");\n                    }\n                    let handlePath = summaryObject.handle;\n                    if (handlePath.length > 0 && !handlePath.startsWith(\"/\")) {\n                        handlePath = `/${handlePath}`;\n                    }\n                    const pathKey = `${rootNodeName}${handlePath}`;\n                    id = `${parentHandle}/${pathKey}`;\n                    break;\n                }\n                case api.SummaryType.Attachment: {\n                    id = summaryObject.id;\n                    break;\n                }\n                default: {\n                    unreachableCase(summaryObject, `Unknown type: ${(summaryObject as any).type}`);\n                }\n            }\n\n            const baseEntry: IOdspSummaryTreeBaseEntry = {\n                path: encodeURIComponent(key),\n                type: getGitType(summaryObject),\n            };\n\n            let entry: OdspSummaryTreeEntry;\n\n            if (value) {\n                assert(id === undefined, 0x0ad /* \"Snapshot entry has both a tree value and a referenced id!\" */);\n                entry = {\n                    value,\n                    ...baseEntry,\n                    unreferenced,\n                };\n            } else if (id) {\n                entry = {\n                    ...baseEntry,\n                    id,\n                };\n            } else {\n                throw new Error(`Invalid tree entry for ${summaryObject.type}`);\n            }\n\n            snapshotTree.entries!.push(entry);\n        }\n\n        return { snapshotTree, blobs };\n    }\n}\n\n/* eslint-enable max-len */\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/odsp-driver";
-export declare const pkgVersion = "0.58.2002";
+export declare const pkgVersion = "0.58.3000-61081";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

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

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "0.58.2002";
+export const pkgVersion = "0.58.3000-61081";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver\";\nexport const pkgVersion = \"0.58.2002\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver\";\nexport const pkgVersion = \"0.58.3000-61081\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "0.58.2002",
+  "version": "0.58.3000-61081",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -32,7 +32,7 @@
     "lint:fix": "npm run eslint:fix",
     "test": "npm run test:mocha",
     "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
     "tsfmt": "tsfmt --verify",
@@ -62,15 +62,15 @@
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
     "@fluidframework/core-interfaces": "^0.42.0",
-    "@fluidframework/driver-base": "^0.58.2002",
-    "@fluidframework/driver-definitions": "^0.45.1000",
-    "@fluidframework/driver-utils": "^0.58.2002",
+    "@fluidframework/driver-base": "0.58.3000-61081",
+    "@fluidframework/driver-definitions": "^0.45.2000-0",
+    "@fluidframework/driver-utils": "0.58.3000-61081",
     "@fluidframework/gitresources": "^0.1035.1000",
-    "@fluidframework/odsp-doclib-utils": "^0.58.2002",
-    "@fluidframework/odsp-driver-definitions": "^0.58.2002",
+    "@fluidframework/odsp-doclib-utils": "0.58.3000-61081",
+    "@fluidframework/odsp-driver-definitions": "0.58.3000-61081",
     "@fluidframework/protocol-base": "^0.1035.1000",
     "@fluidframework/protocol-definitions": "^0.1027.1000",
-    "@fluidframework/telemetry-utils": "^0.58.2002",
+    "@fluidframework/telemetry-utils": "0.58.3000-61081",
     "abort-controller": "^3.0.0",
     "node-fetch": "^2.6.1",
     "socket.io-client": "^4.4.1",
@@ -78,8 +78,9 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.27.0",
-    "@fluidframework/mocha-test-setup": "^0.58.2002",
+    "@fluidframework/eslint-config-fluid": "^0.27.2000-59622",
+    "@fluidframework/mocha-test-setup": "0.58.3000-61081",
+    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@0.58.2000",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",
@@ -103,5 +104,9 @@
     "sinon": "^7.4.2",
     "typescript": "~4.1.3",
     "typescript-formatter": "7.1.0"
+  },
+  "typeValidation": {
+    "version": "0.58.3000",
+    "broken": {}
   }
 }

package/src/compactSnapshotParser.ts

@@ -14,10 +14,12 @@ import {
     assertNumberInstance,
     getAndValidateNodeProps,
     NodeCore,
+    NodeTypes,
     TreeBuilder,
 } from "./zipItDataRepresentationUtils";
 
 export const snapshotMinReadVersion = "1.0";
+export const currentReadVersion = "1.0";
 
 interface ISnapshotSection {
     snapshotTree: ISnapshotTree,
@@ -28,7 +30,8 @@ interface ISnapshotSection {
  * Recreates blobs section of the tree.
  * @param node - tree node to read blob section from
  */
-function readBlobSection(node: NodeCore) {
+function readBlobSection(node: NodeTypes) {
+    assertNodeCoreInstance(node, "TreeBlobs should be of type NodeCore");
     const blobs: Map<string, ArrayBuffer> = new Map();
     for (let count = 0; count < node.length; ++count) {
         const blob = node.getNode(count);
@@ -44,7 +47,8 @@ function readBlobSection(node: NodeCore) {
  * Recreates ops section of the tree.
  * @param node - tree node to read ops section from
  */
-function readOpsSection(node: NodeCore) {
+function readOpsSection(node: NodeTypes) {
+    assertNodeCoreInstance(node, "Deltas should be of type NodeCore");
     const ops: ISequencedDocumentMessage[] = [];
     const records = getAndValidateNodeProps(node, ["firstSequenceNumber", "deltas"]);
     assertNumberInstance(records.firstSequenceNumber, "Seq number should be a number");
@@ -93,7 +97,8 @@ function readTreeSection(node: NodeCore) {
  * Recreates snapshot tree out of tree representation.
  * @param node - tree node to de-serialize from
  */
-function readSnapshotSection(node: NodeCore): ISnapshotSection {
+function readSnapshotSection(node: NodeTypes): ISnapshotSection {
+    assertNodeCoreInstance(node, "Snapshot should be of type NodeCore");
     const records = getAndValidateNodeProps(node,
         ["id", "sequenceNumber", "treeNodes"]);
 
@@ -120,7 +125,7 @@ export function parseCompactSnapshotResponse(buffer: ReadBuffer): ISnapshotConte
     const root = builder.getNode(0);
 
     const records = getAndValidateNodeProps(root,
-        ["mrv", "cv", "snapshot", "blobs", "deltas"]);
+        ["mrv", "cv", "snapshot", "blobs", "deltas"], false);
 
     assertBlobCoreInstance(records.mrv, "minReadVersion should be of BlobCore type");
     assertBlobCoreInstance(records.cv, "createVersion should be of BlobCore type");
@@ -128,14 +133,10 @@ export function parseCompactSnapshotResponse(buffer: ReadBuffer): ISnapshotConte
         0x20f /* "Driver min read version should >= to server minReadVersion" */);
     assert(records.cv.toString() >= snapshotMinReadVersion,
         0x210 /* "Snapshot should be created with minReadVersion or above" */);
-
-    assertNodeCoreInstance(records.snapshot, "Snapshot should be of type NodeCore");
-    assertNodeCoreInstance(records.blobs, "TreeBlobs should be of type NodeCore");
-    assertNodeCoreInstance(records.deltas, "Deltas should be of type NodeCore");
-
+    assert(currentReadVersion === records.cv.toString(), "Create Version should be equal to currentReadVersion");
     return {
         ...readSnapshotSection(records.snapshot),
         blobs: readBlobSection(records.blobs),
-        ops: readOpsSection(records.deltas),
+        ops: records.deltas !== undefined ? readOpsSection(records.deltas) : [],
     };
 }

package/src/epochTracker.ts

@@ -18,7 +18,7 @@ import {
 } from "@fluidframework/odsp-driver-definitions";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
 import { PerformanceEvent, isFluidError, normalizeError } from "@fluidframework/telemetry-utils";
-import { fetchAndParseAsJSONHelper, fetchArray, getOdspResolvedUrl, IOdspResponse } from "./odspUtils";
+import { fetchAndParseAsJSONHelper, fetchArray, fetchHelper, getOdspResolvedUrl, IOdspResponse } from "./odspUtils";
 import {
     IOdspCache,
     INonPersistentCache,
@@ -166,6 +166,7 @@ export class EpochTracker implements IPersistedFileCache {
      * @param fetchOptions - fetch options for request containing body, headers etc.
      * @param fetchType - method for which fetch is called.
      * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
      */
     public async fetchAndParseAsJSON<T>(
         url: string,
@@ -174,12 +175,41 @@ export class EpochTracker implements IPersistedFileCache {
         addInBody: boolean = false,
         fetchReason?: string,
     ): Promise<IOdspResponse<T>> {
+        return this.fetchCore<T>(url, fetchOptions, fetchAndParseAsJSONHelper, fetchType, addInBody, fetchReason);
+    }
+
+    /**
+     * Api to fetch the response for given request and parse it as json.
+     * @param url - url of the request
+     * @param fetchOptions - fetch options for request containing body, headers etc.
+     * @param fetchType - method for which fetch is called.
+     * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
+     */
+    public async fetch(
+        url: string,
+        fetchOptions: RequestInit,
+        fetchType: FetchType,
+        addInBody: boolean = false,
+        fetchReason?: string,
+    ) {
+        return this.fetchCore<Response>(url, fetchOptions, fetchHelper, fetchType, addInBody, fetchReason);
+    }
+
+    private async fetchCore<T>(
+        url: string,
+        fetchOptions: {[index: string]: any},
+        fetcher: (url: string, fetchOptions: {[index: string]: any}) => Promise<IOdspResponse<T>>,
+        fetchType: FetchType,
+        addInBody: boolean = false,
+        fetchReason?: string,
+    ) {
         const clientCorrelationId = this.formatClientCorrelationId(fetchReason);
         // Add epoch in fetch request.
         this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);
         let epochFromResponse: string | undefined;
         return this.rateLimiter.schedule(
-            async () => fetchAndParseAsJSONHelper<T>(url, fetchOptions),
+            async () => fetcher(url, fetchOptions),
         ).then((response) => {
             epochFromResponse = response.headers.get("x-fluid-epoch");
             this.validateEpochFromResponse(epochFromResponse, fetchType);
@@ -205,6 +235,7 @@ export class EpochTracker implements IPersistedFileCache {
      * @param fetchOptions - fetch options for request containing body, headers etc.
      * @param fetchType - method for which fetch is called.
      * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
      */
     public async fetchArray(
         url: string,
@@ -213,29 +244,7 @@ export class EpochTracker implements IPersistedFileCache {
         addInBody: boolean = false,
         fetchReason?: string,
     ) {
-        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);
-        // Add epoch in fetch request.
-        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);
-        let epochFromResponse: string | undefined;
-        return this.rateLimiter.schedule(
-            async () => fetchArray(url, fetchOptions),
-        ).then((response) => {
-            epochFromResponse = response.headers.get("x-fluid-epoch");
-            this.validateEpochFromResponse(epochFromResponse, fetchType);
-            response.propsToLog.XRequestStatsHeader = clientCorrelationId;
-            return response;
-        }).catch(async (error) => {
-            // Get the server epoch from error in case we don't have it as if undefined we won't be able
-            // to mark it as epoch error.
-            if (epochFromResponse === undefined) {
-                epochFromResponse = (error as IOdspError).serverEpoch;
-            }
-            await this.checkForEpochError(error, epochFromResponse, fetchType);
-            throw error;
-        }).catch((error) => {
-            const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId }});
-            throw fluidError;
-        });
+        return this.fetchCore<ArrayBuffer>(url, fetchOptions, fetchArray, fetchType, addInBody, fetchReason);
     }
 
     private addEpochInRequest(

package/src/fetchSnapshot.ts

@@ -22,14 +22,14 @@ import { getQueryString } from "./getQueryString";
 import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth";
 import {
     fetchAndParseAsJSONHelper,
-    fetchArray,
+    fetchHelper,
     getWithRetryForTokenRefresh,
     getWithRetryForTokenRefreshRepeat,
     IOdspResponse,
     ISnapshotContents,
 } from "./odspUtils";
 import { convertOdspSnapshotToSnapsohtTreeAndBlobs } from "./odspSnapshotParser";
-import { parseCompactSnapshotResponse } from "./compactSnapshotParser";
+import { currentReadVersion, parseCompactSnapshotResponse } from "./compactSnapshotParser";
 import { ReadBuffer } from "./ReadBufferUtils";
 import { EpochTracker } from "./epochTracker";
 
@@ -362,89 +362,6 @@ interface ISnapshotRequestAndResponseOptions {
     requestHeaders: {[index: string]: any},
 }
 
-/**
- * This function fetches the older snapshot format which is the json format(IOdspSnapshot).
- * @param odspResolvedUrl - resolved odsp url.
- * @param storageToken - token to do the auth for network request.
- * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
- * @param controller - abort controller if caller needs to abort the network call.
- * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
- * @returns fetched snapshot.
- */
-async function fetchSnapshotContentsCoreV1(
-    odspResolvedUrl: IOdspResolvedUrl,
-    storageToken: string,
-    snapshotOptions: ISnapshotOptions | undefined,
-    controller?: AbortController,
-    epochTracker?: EpochTracker,
-): Promise<ISnapshotRequestAndResponseOptions> {
-    const snapshotUrl = odspResolvedUrl.endpoints.snapshotStorageUrl;
-    const url = `${snapshotUrl}/trees/latest?ump=1`;
-    // The location of file can move on Spo in which case server returns 308(Permanent Redirect) error.
-    // Adding below header will make VROOM API return 404 instead of 308 and browser can intercept it.
-    // This error thrown by server will contain the new redirect location. Look at the 404 error parsing
-    // for futher reference here: \packages\utils\odsp-doclib-utils\src\odspErrorUtils.ts
-    const header = { prefer: "manualredirect" };
-    const { body, headers } = getFormBodyAndHeaders(
-        odspResolvedUrl, storageToken, snapshotOptions, header);
-    headers.accept = "application/json";
-    const fetchOptions = {
-        body,
-        headers,
-        signal: controller?.signal,
-        method: "POST",
-    };
-    const response = await (epochTracker?.fetchAndParseAsJSON<IOdspSnapshot>(url, fetchOptions, "treesLatest", true) ??
-        fetchAndParseAsJSONHelper<IOdspSnapshot>(url, fetchOptions));
-    const snapshotContents: ISnapshotContents = convertOdspSnapshotToSnapsohtTreeAndBlobs(response.content);
-    const finalSnapshotContents: IOdspResponse<ISnapshotContents> = { ...response, content: snapshotContents };
-    return {
-        odspSnapshotResponse: finalSnapshotContents,
-        requestHeaders: headers,
-        requestUrl: url,
-    };
-}
-
-/**
- * This function fetches the binary compact snapshot format. This is an experimental feature
- * and is behind a feature flag.
- * @param odspResolvedUrl - resolved odsp url.
- * @param storageToken - token to do the auth for network request.
- * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
- * @param controller - abort controller if caller needs to abort the network call.
- * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
- * @returns fetched snapshot.
- */
-async function fetchSnapshotContentsCoreV2(
-    odspResolvedUrl: IOdspResolvedUrl,
-    storageToken: string,
-    snapshotOptions: ISnapshotOptions | undefined,
-    controller?: AbortController,
-    epochTracker?: EpochTracker,
-): Promise<ISnapshotRequestAndResponseOptions> {
-    const fullUrl = `${odspResolvedUrl.siteUrl}/_api/v2.1/drives/${odspResolvedUrl.driveId}/items/${
-        odspResolvedUrl.itemId}/opStream/attachments/latest/content?ump=1`;
-
-    const { body, headers } = getFormBodyAndHeaders(odspResolvedUrl, storageToken, snapshotOptions);
-    const fetchOptions = {
-        body,
-        headers,
-        signal: controller?.signal,
-        method: "POST",
-    };
-
-    const response = await (epochTracker?.fetchArray(fullUrl, fetchOptions, "treesLatest", true) ??
-        fetchArray(fullUrl, fetchOptions));
-    const snapshotContents: ISnapshotContents = parseCompactSnapshotResponse(
-        new ReadBuffer(new Uint8Array(response.content)));
-    const finalSnapshotContents: IOdspResponse<ISnapshotContents> = { ...response, content: snapshotContents };
-    return {
-        odspSnapshotResponse: finalSnapshotContents,
-        requestHeaders: headers,
-        requestUrl: fullUrl,
-    };
-}
-
 function getFormBodyAndHeaders(
     odspResolvedUrl: IOdspResolvedUrl,
     storageToken: string,
@@ -505,6 +422,17 @@ function countTreesInSnapshotTree(snapshotTree: ISnapshotTree): number {
     return numTrees;
 }
 
+/**
+ * This function fetches the snapshot and parse it according to what is mentioned in response headers.
+ * @param odspResolvedUrl - resolved odsp url.
+ * @param storageToken - token to do the auth for network request.
+ * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
+ * @param logger - logger
+ * @param fetchBinarySnapshotFormat - whether to fetch binary snapshot or not.
+ * @param controller - abort controller if caller needs to abort the network call.
+ * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
+ * @returns fetched snapshot.
+ */
 export async function downloadSnapshot(
     odspResolvedUrl: IOdspResolvedUrl,
     storageToken: string,
@@ -520,13 +448,53 @@ export async function downloadSnapshot(
         odspResolvedUrl.shareLinkInfo = { ...odspResolvedUrl.shareLinkInfo, sharingLinkToRedeem };
     }
 
+    const snapshotUrl = odspResolvedUrl.endpoints.snapshotStorageUrl;
+    const url = `${snapshotUrl}/trees/latest?ump=1`;
+    // The location of file can move on Spo in which case server returns 308(Permanent Redirect) error.
+    // Adding below header will make VROOM API return 404 instead of 308 and browser can intercept it.
+    // This error thrown by server will contain the new redirect location. Look at the 404 error parsing
+    // for futher reference here: \packages\utils\odsp-doclib-utils\src\odspErrorUtils.ts
+    const header = {prefer: "manualredirect"};
+    const { body, headers } = getFormBodyAndHeaders(
+        odspResolvedUrl, storageToken, snapshotOptions, header);
+    const fetchOptions = {
+        body,
+        headers,
+        signal: controller?.signal,
+        method: "POST",
+    };
+    // For now we are keeping both json and ms-fluid values in accept header while fetching as we want to let
+    // the server decide what format it wants to send to the client as we roll it out slowly.
     if (fetchBinarySnapshotFormat) {
-        // Logging an event here as it is not supposed to be used in production yet and only in experimental mode.
-        logger.sendTelemetryEvent({ eventName: "BinarySnapshotFetched" });
-        return fetchSnapshotContentsCoreV2(odspResolvedUrl, storageToken, snapshotOptions, controller, epochTracker);
+        headers.accept = `application/json, application/ms-fluid; v=${currentReadVersion}`;
+    } else {
+        headers.accept = "application/json";
+    }
+    const response = await (epochTracker?.fetch(url, fetchOptions, "treesLatest", true) ??
+        fetchHelper(url, fetchOptions));
+
+    let finalSnapshotContents: IOdspResponse<ISnapshotContents>;
+    const contentType = response.headers.get("content-type");
+    if (contentType === "application/json") {
+        const text = await response.content.text();
+        const content: IOdspSnapshot = JSON.parse(text);
+        response.propsToLog.bodySize = text.length;
+        const snapshotContents: ISnapshotContents = convertOdspSnapshotToSnapsohtTreeAndBlobs(content);
+        finalSnapshotContents = { ...response, content: snapshotContents };
     } else {
-        return fetchSnapshotContentsCoreV1(odspResolvedUrl, storageToken, snapshotOptions, controller, epochTracker);
+        assert(contentType === "application/ms-fluid", "Content type should be application/ms-fluid");
+        const content = await response.content.arrayBuffer();
+        response.propsToLog.bodySize = content.byteLength;
+        const snapshotContents: ISnapshotContents = parseCompactSnapshotResponse(
+            new ReadBuffer(new Uint8Array(content)));
+        finalSnapshotContents = { ...response, content: snapshotContents };
     }
+    response.propsToLog.contentType = contentType;
+    return {
+        odspSnapshotResponse: finalSnapshotContents,
+        requestHeaders: headers,
+        requestUrl: url,
+    };
 }
 
 function isRedeemSharingLinkError(odspResolvedUrl: IOdspResolvedUrl, error: any) {

package/src/odspDocumentService.ts

@@ -81,6 +81,7 @@ export class OdspDocumentService implements IDocumentService {
         hostPolicy: HostStoragePolicy,
         epochTracker: EpochTracker,
         socketReferenceKeyPrefix?: string,
+        clientIsSummarizer?: boolean,
     ): Promise<IDocumentService> {
         return new OdspDocumentService(
             getOdspResolvedUrl(resolvedUrl),
@@ -92,6 +93,7 @@ export class OdspDocumentService implements IDocumentService {
             hostPolicy,
             epochTracker,
             socketReferenceKeyPrefix,
+            clientIsSummarizer,
         );
     }
 
@@ -131,6 +133,7 @@ export class OdspDocumentService implements IDocumentService {
         hostPolicy: HostStoragePolicy,
         private readonly epochTracker: EpochTracker,
         private readonly socketReferenceKeyPrefix?: string,
+        private readonly clientIsSummarizer?: boolean,
     ) {
         this._policies = {
             // load in storage-only mode if a file version is specified
@@ -150,7 +153,7 @@ export class OdspDocumentService implements IDocumentService {
         this.hostPolicy = hostPolicy;
         this.hostPolicy.fetchBinarySnapshotFormat ??=
             this.mc.config.getBoolean("Fluid.Driver.Odsp.binaryFormatSnapshot");
-        if (this.odspResolvedUrl.summarizer) {
+        if (this.clientIsSummarizer) {
             this.hostPolicy = { ...this.hostPolicy, summarizerClient: true };
         }
     }
@@ -385,7 +388,7 @@ export class OdspDocumentService implements IDocumentService {
         };
 
         const getResponseAndRefreshAfterDeltaMs = async () => {
-            let _response = await this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);
+            const _response = await this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);
             // If the response does not contain refreshSessionDurationSeconds, then treat it as old flow and let the
             // cache entry to be treated as expired after 1 hour.
             _response.joinSessionResponse.refreshSessionDurationSeconds =
@@ -415,16 +418,16 @@ export class OdspDocumentService implements IDocumentService {
                     .catch((error) => {
                         this.mc.logger.sendErrorEvent({
                                 eventName: "JoinSessionRefreshError",
-                                ...props,
+                                details: JSON.stringify(props),
                             },
                             error,
                         );
                     });
             } else {
                 // Logging just for informational purposes to help with debugging as this is a new feature.
-                this.mc.logger.sendErrorEvent({
+                this.mc.logger.sendTelemetryEvent({
                     eventName: "JoinSessionRefreshNotScheduled",
-                    ...props,
+                    details: JSON.stringify(props),
                 });
             }
         }

package/src/odspDocumentServiceFactoryCore.ts

@@ -55,6 +55,7 @@ export class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
         createNewSummary: ISummaryTree | undefined,
         createNewResolvedUrl: IResolvedUrl,
         logger?: ITelemetryBaseLogger,
+        clientIsSummarizer?: boolean,
     ): Promise<IDocumentService> {
         ensureFluidResolvedUrl(createNewResolvedUrl);
 
@@ -113,7 +114,8 @@ export class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
                     this.hostPolicy.cacheCreateNewSummary ?? true,
                     !!this.hostPolicy.sessionOptions?.forceAccessTokenViaAuthorizationHeader,
                 );
-                const docService = this.createDocumentServiceCore(odspResolvedUrl, odspLogger, cacheAndTracker);
+                const docService = this.createDocumentServiceCore(odspResolvedUrl, odspLogger,
+                    cacheAndTracker, clientIsSummarizer);
                 event.end({
                     docId: odspResolvedUrl.hashedDocumentId,
                 });
@@ -147,14 +149,16 @@ export class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
     public async createDocumentService(
         resolvedUrl: IResolvedUrl,
         logger?: ITelemetryBaseLogger,
+        clientIsSummarizer?: boolean,
     ): Promise<IDocumentService> {
-        return this.createDocumentServiceCore(resolvedUrl, createOdspLogger(logger));
+        return this.createDocumentServiceCore(resolvedUrl, createOdspLogger(logger), undefined, clientIsSummarizer);
     }
 
     private async createDocumentServiceCore(
         resolvedUrl: IResolvedUrl,
         odspLogger: TelemetryLogger,
         cacheAndTrackerArg?: ICacheAndTracker,
+        clientIsSummarizer?: boolean,
     ): Promise<IDocumentService> {
         const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);
         const resolvedUrlData: IOdspUrlParts = {
@@ -194,6 +198,7 @@ export class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
             this.hostPolicy,
             cacheAndTracker.epochTracker,
             this.socketReferenceKeyPrefix,
+            clientIsSummarizer,
         );
     }
 }