@fluidframework/odsp-driver 0.57.1 → 0.58.0-55561

package/lib/odspDriverUrlResolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDriverUrlResolver.js","sourceRoot":"","sources":["../src/odspDriverUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAA+B,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAE,YAAY,EAA8B,MAAM,oCAAoC,CAAC;AAC9F,OAAO,EAAoB,cAAc,EAAqB,MAAM,yCAAyC,CAAC;AAC9G,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,SAAS,UAAU,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IACtF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAC3C,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,YAAY,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,WAAW,OAAO,UAAU,MAAM,IAAI,OAAO,EAAE,CAAC;AACpF,CAAC;AAED,SAAS,cAAc,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC1F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,oBAAoB,CAAC;AAC1C,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAChG,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,qBAAqB,CAAC;AAC3C,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC/F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,sBAAsB,CAAC;AAC5C,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC9F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,UAAU,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,GAAW;IACrC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACrB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAC9B,gBAAgB,CAAC;IAEV,KAAK,CAAC,OAAO,CAAC,OAAiB;;QAClC,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE;YAC5D,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEtD,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;YACtD,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;YAClE,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAC7D,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YAC1D,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,CAAC,EAAE;gBAClF,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC/D;YACD,IAAI,aAA4C,CAAC;YACjD,IAAG,cAAc,IAAI,cAAc,IAAI,cAAc,EAAE;gBACnD,aAAa,GAAG;oBACZ,UAAU,EAAE;wBACR,IAAI,EAAE,cAAc,CAAC,cAAc,CAAC;qBACvC;iBACJ,CAAC;aACL;YACD,OAAO;gBACH,SAAS,EAAE;oBACP,kBAAkB,EAAE,EAAE;oBACtB,uBAAuB,EAAE,EAAE;oBAC3B,wBAAwB,EAAE,EAAE;oBAC5B,eAAe,EAAE,EAAE;iBACtB;gBACD,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,eAAe,EAAE,IAAI;gBACrB,EAAE,EAAE,eAAe;gBACnB,GAAG,EAAE,gBAAgB,OAAO,IAAI,WAAW,eAAe;gBAC1D,OAAO,EAAE,OAAO;gBAChB,gBAAgB,EAAE,EAAE;gBACpB,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,EAAE;gBACV,QAAQ;gBACR,UAAU,EAAE,KAAK;gBACjB,QAAQ,EAAE;oBACN,oBAAoB,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;iBAC9D;gBACD,WAAW,EAAE,SAAS;gBACtB,aAAa;gBACb,iBAAiB,QAAE,OAAO,CAAC,OAAO,0CAAG,qBAAqB,CAAC,iBAAiB,CAAC;aAChF,CAAC;SACL;QACD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzG,MAAM,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACpE,MAAM,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAE1F,IAAI,WAAW,GAAG,wCAAwC,gBAAgB,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;QAE3G,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,gEAAgE;YAChE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC;YACvC,IAAI,YAAY,EAAE;gBACd,WAAW,IAAI,YAAY,CAAC;aAC/B;SACJ;QAED,MAAM,UAAU,GAAG,CAAC,QAAC,OAAO,CAAC,OAAO,0CAAG,YAAY,CAAC,iBAAiB,EAAC,CAAC;QAEvE,OAAO;YACH,IAAI,EAAE,OAAO;YACb,eAAe,EAAE,IAAI;YACrB,SAAS,EAAE;gBACP,kBAAkB,EAAE,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACzE,wBAAwB,EAAE,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACrF,uBAAuB,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACnF,eAAe,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;aAC7E;YACD,EAAE,EAAE,gBAAgB;YACpB,MAAM,EAAE,EAAE;YACV,GAAG,EAAE,WAAW;YAChB,gBAAgB;YAChB,OAAO;YACP,OAAO;YACP,MAAM;YACN,QAAQ,EAAE,EAAE;YACZ,UAAU;YACV,QAAQ,EAAE;gBACN,oBAAoB;aACvB;YACD,WAAW;YACX,iBAAiB,QAAE,OAAO,CAAC,OAAO,0CAAG,qBAAqB,CAAC,iBAAiB,CAAC;SAChF,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,WAAmB,EACnB,WAA+B;;QAE/B,IAAI,aAAa,GAAG,WAAW,CAAC;QAChC,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/B,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC3C;QACD,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,oBAAoB,GACtB,cAAc,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,IAAI,CAAC,CAAC,OAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,yCACvF,eAAe,CAAC,QAAQ,0CAAE,oBAAoB,CAAC;QAEnD,OAAO,aAAa,iCACZ,eAAe,KACnB,oBAAoB;YACpB,aAAa,IACf,CAAC;IACP,CAAC;CACJ;AAED,SAAS,aAAa,CAAC,GAAW;IAQ9B,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE9C,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;IAEtD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,oBAAoB,GAAG,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpD,IAAI,OAAO,KAAK,IAAI,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KAC1D;IAED,IAAI,MAAM,KAAK,IAAI,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KAC1D;IAED,IAAI,IAAI,KAAK,IAAI,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACtD;IAED,OAAO;QACH,OAAO;QACP,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC;QACpC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;QAClC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;QAC9B,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS;QACjG,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;KACzE,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IFluidCodeDetails, IRequest, isFluidPackage } from \"@fluidframework/core-interfaces\";\nimport { DriverHeader, IResolvedUrl, IUrlResolver } from \"@fluidframework/driver-definitions\";\nimport { IOdspResolvedUrl, ShareLinkTypes, ShareLinkInfoType } from \"@fluidframework/odsp-driver-definitions\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { getOdspResolvedUrl } from \"./odspUtils\";\nimport { getHashedDocumentId } from \"./odspPublicUtils\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\n\nfunction getUrlBase(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const siteOrigin = new URL(siteUrl).origin;\n    const version = fileVersion ? `versions/${fileVersion}/` : \"\";\n    return `${getApiRoot(siteOrigin)}/drives/${driveId}/items/${itemId}/${version}`;\n}\n\nfunction getSnapshotUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/snapshots`;\n}\n\nfunction getAttachmentPOSTUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/attachment`;\n}\n\nfunction getAttachmentGETUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/attachments`;\n}\n\nfunction getDeltaStorageUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream`;\n}\n\n/**\n * Utility that enables us to handle paths provided with a beginning slash.\n * For example if a value of '/id1/id2' is provided, id1/id2 is returned.\n */\nfunction removeBeginningSlash(str: string): string {\n    if (str.startsWith(\"/\")) {\n        return str.substr(1);\n    }\n\n    return str;\n}\n\n/**\n * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner\n * url format. Ex: `${siteUrl}?driveId=${driveId}&itemId=${itemId}&path=${path}`\n */\nexport class OdspDriverUrlResolver implements IUrlResolver {\n    constructor() { }\n\n    public async resolve(request: IRequest): Promise<IOdspResolvedUrl> {\n        if (request.headers && request.headers[DriverHeader.createNew]) {\n            const [siteURL, queryString] = request.url.split(\"?\");\n\n            const searchParams = new URLSearchParams(queryString);\n            const fileName = request.headers[DriverHeader.createNew].fileName;\n            const driveID = searchParams.get(\"driveId\");\n            const filePath = searchParams.get(\"path\");\n            const packageName = searchParams.get(\"containerPackageName\");\n            const createLinkType = searchParams.get(\"createLinkType\");\n            if (!(fileName && siteURL && driveID && filePath !== null && filePath !== undefined)) {\n                throw new Error(\"Proper new file params should be there!!\");\n            }\n            let shareLinkInfo: ShareLinkInfoType | undefined;\n            if(createLinkType && createLinkType in ShareLinkTypes) {\n                shareLinkInfo = {\n                    createLink: {\n                        type: ShareLinkTypes[createLinkType],\n                    },\n                };\n            }\n            return {\n                endpoints: {\n                    snapshotStorageUrl: \"\",\n                    attachmentGETStorageUrl: \"\",\n                    attachmentPOSTStorageUrl: \"\",\n                    deltaStorageUrl: \"\",\n                },\n                tokens: {},\n                type: \"fluid\",\n                odspResolvedUrl: true,\n                id: \"odspCreateNew\",\n                url: `fluid-odsp://${siteURL}?${queryString}&version=null`,\n                siteUrl: siteURL,\n                hashedDocumentId: \"\",\n                driveId: driveID,\n                itemId: \"\",\n                fileName,\n                summarizer: false,\n                codeHint: {\n                    containerPackageName: packageName ? packageName : undefined,\n                },\n                fileVersion: undefined,\n                shareLinkInfo,\n                isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n            };\n        }\n        const { siteUrl, driveId, itemId, path, containerPackageName, fileVersion } = decodeOdspUrl(request.url);\n        const hashedDocumentId = await getHashedDocumentId(driveId, itemId);\n        assert(!hashedDocumentId.includes(\"/\"), 0x0a8 /* \"Docid should not contain slashes!!\" */);\n\n        let documentUrl = `fluid-odsp://placeholder/placeholder/${hashedDocumentId}/${removeBeginningSlash(path)}`;\n\n        if (request.url.length > 0) {\n            // In case of any additional parameters add them back to the url\n            const requestURL = new URL(request.url);\n            const searchParams = requestURL.search;\n            if (searchParams) {\n                documentUrl += searchParams;\n            }\n        }\n\n        const summarizer = !!request.headers?.[DriverHeader.summarizingClient];\n\n        return {\n            type: \"fluid\",\n            odspResolvedUrl: true,\n            endpoints: {\n                snapshotStorageUrl: getSnapshotUrl(siteUrl, driveId, itemId, fileVersion),\n                attachmentPOSTStorageUrl: getAttachmentPOSTUrl(siteUrl, driveId, itemId, fileVersion),\n                attachmentGETStorageUrl: getAttachmentGETUrl(siteUrl, driveId, itemId, fileVersion),\n                deltaStorageUrl: getDeltaStorageUrl(siteUrl, driveId, itemId, fileVersion),\n            },\n            id: hashedDocumentId,\n            tokens: {},\n            url: documentUrl,\n            hashedDocumentId,\n            siteUrl,\n            driveId,\n            itemId,\n            fileName: \"\",\n            summarizer,\n            codeHint: {\n                containerPackageName,\n            },\n            fileVersion,\n            isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n        };\n    }\n\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        relativeUrl: string,\n        codeDetails?: IFluidCodeDetails,\n    ): Promise<string> {\n        let dataStorePath = relativeUrl;\n        if (dataStorePath.startsWith(\"/\")) {\n            dataStorePath = dataStorePath.substr(1);\n        }\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n        const containerPackageName =\n            isFluidPackage(codeDetails?.package) ? codeDetails?.package.name : codeDetails?.package ??\n            odspResolvedUrl.codeHint?.containerPackageName;\n\n        return createOdspUrl({\n            ... odspResolvedUrl,\n            containerPackageName,\n            dataStorePath,\n        });\n    }\n}\n\nfunction decodeOdspUrl(url: string): {\n    siteUrl: string;\n    driveId: string;\n    itemId: string;\n    path: string;\n    containerPackageName?: string;\n    fileVersion?: string;\n} {\n    const [siteUrl, queryString] = url.split(\"?\");\n\n    const searchParams = new URLSearchParams(queryString);\n\n    const driveId = searchParams.get(\"driveId\");\n    const itemId = searchParams.get(\"itemId\");\n    const path = searchParams.get(\"path\");\n    const containerPackageName = searchParams.get(\"containerPackageName\");\n    const fileVersion = searchParams.get(\"fileVersion\");\n\n    if (driveId === null) {\n        throw new Error(\"ODSP URL did not contain a drive id\");\n    }\n\n    if (itemId === null) {\n        throw new Error(\"ODSP Url did not contain an item id\");\n    }\n\n    if (path === null) {\n        throw new Error(\"ODSP Url did not contain a path\");\n    }\n\n    return {\n        siteUrl,\n        driveId: decodeURIComponent(driveId),\n        itemId: decodeURIComponent(itemId),\n        path: decodeURIComponent(path),\n        containerPackageName: containerPackageName ? decodeURIComponent(containerPackageName) : undefined,\n        fileVersion: fileVersion ? decodeURIComponent(fileVersion) : undefined,\n    };\n}\n"]}
+{"version":3,"file":"odspDriverUrlResolver.js","sourceRoot":"","sources":["../src/odspDriverUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAA+B,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EACH,YAAY,GAIf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAoB,cAAc,EAAqB,MAAM,yCAAyC,CAAC;AAC9G,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,SAAS,UAAU,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IACtF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAC3C,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,YAAY,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,WAAW,OAAO,UAAU,MAAM,IAAI,OAAO,EAAE,CAAC;AACpF,CAAC;AAED,SAAS,cAAc,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC1F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,oBAAoB,CAAC;AAC1C,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAChG,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,qBAAqB,CAAC;AAC3C,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC/F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,sBAAsB,CAAC;AAC5C,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC9F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,UAAU,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,GAAW;IACrC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACrB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAC9B,gBAAgB,CAAC;IAEV,KAAK,CAAC,OAAO,CAAC,OAAiB;;QAClC,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE;YAC5D,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEtD,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;YACtD,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;YAClE,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAC7D,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YAC1D,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,CAAC,EAAE;gBAClF,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC/D;YACD,IAAI,aAA4C,CAAC;YACjD,IAAG,cAAc,IAAI,cAAc,IAAI,cAAc,EAAE;gBACnD,aAAa,GAAG;oBACZ,UAAU,EAAE;wBACR,IAAI,EAAE,cAAc,CAAC,cAAc,CAAC;qBACvC;iBACJ,CAAC;aACL;YACD,OAAO;gBACH,SAAS,EAAE;oBACP,kBAAkB,EAAE,EAAE;oBACtB,uBAAuB,EAAE,EAAE;oBAC3B,wBAAwB,EAAE,EAAE;oBAC5B,eAAe,EAAE,EAAE;iBACtB;gBACD,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,eAAe,EAAE,IAAI;gBACrB,EAAE,EAAE,eAAe;gBACnB,GAAG,EAAE,gBAAgB,OAAO,IAAI,WAAW,eAAe;gBAC1D,OAAO,EAAE,OAAO;gBAChB,gBAAgB,EAAE,EAAE;gBACpB,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,EAAE;gBACV,QAAQ;gBACR,UAAU,EAAE,KAAK;gBACjB,QAAQ,EAAE;oBACN,oBAAoB,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;iBAC9D;gBACD,WAAW,EAAE,SAAS;gBACtB,aAAa;gBACb,iBAAiB,QAAE,OAAO,CAAC,OAAO,0CAAG,qBAAqB,CAAC,iBAAiB,CAAC;aAChF,CAAC;SACL;QACD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzG,MAAM,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACpE,MAAM,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAE1F,IAAI,WAAW,GAAG,wCAAwC,gBAAgB,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;QAE3G,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,gEAAgE;YAChE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC;YACvC,IAAI,YAAY,EAAE;gBACd,WAAW,IAAI,YAAY,CAAC;aAC/B;SACJ;QAED,MAAM,UAAU,GAAG,CAAC,QAAC,OAAO,CAAC,OAAO,0CAAG,YAAY,CAAC,iBAAiB,EAAC,CAAC;QAEvE,OAAO;YACH,IAAI,EAAE,OAAO;YACb,eAAe,EAAE,IAAI;YACrB,SAAS,EAAE;gBACP,kBAAkB,EAAE,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACzE,wBAAwB,EAAE,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACrF,uBAAuB,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACnF,eAAe,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;aAC7E;YACD,EAAE,EAAE,gBAAgB;YACpB,MAAM,EAAE,EAAE;YACV,GAAG,EAAE,WAAW;YAChB,gBAAgB;YAChB,OAAO;YACP,OAAO;YACP,MAAM;YACN,QAAQ,EAAE,EAAE;YACZ,UAAU;YACV,QAAQ,EAAE;gBACN,oBAAoB;aACvB;YACD,WAAW;YACX,iBAAiB,QAAE,OAAO,CAAC,OAAO,0CAAG,qBAAqB,CAAC,iBAAiB,CAAC;SAChF,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,WAAmB,EACnB,iBAA6D;;QAE7D,IAAI,aAAa,GAAG,WAAW,CAAC;QAChC,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/B,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC3C;QACD,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAExD,+DAA+D;QAC/D,IAAI,oBAAoB,CAAC;QACzB,IAAI,iBAAiB,IAAI,MAAM,IAAI,iBAAiB,EAAE;YAClD,oBAAoB,GAAG,iBAAiB,CAAC,IAAI,CAAA;SAChD;aAAM,IAAI,cAAc,CAAC,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,CAAC,EAAE;YACnD,oBAAoB,GAAG,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,CAAC,IAAI,CAAA;SACzD;aAAM;YACH,oBAAoB,GAAG,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,CAAA;SACpD;QACD,oBAAoB,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,SAAI,eAAe,CAAC,QAAQ,0CAAE,oBAAoB,CAAA;QAE7F,OAAO,aAAa,iCACZ,eAAe,KACnB,oBAAoB;YACpB,aAAa,IACf,CAAC;IACP,CAAC;CACJ;AAED,SAAS,aAAa,CAAC,GAAW;IAQ9B,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE9C,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;IAEtD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,oBAAoB,GAAG,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpD,IAAI,OAAO,KAAK,IAAI,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KAC1D;IAED,IAAI,MAAM,KAAK,IAAI,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KAC1D;IAED,IAAI,IAAI,KAAK,IAAI,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACtD;IAED,OAAO;QACH,OAAO;QACP,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC;QACpC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;QAClC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;QAC9B,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS;QACjG,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;KACzE,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IFluidCodeDetails, IRequest, isFluidPackage } from \"@fluidframework/core-interfaces\";\nimport {\n    DriverHeader,\n    IContainerPackageInfo,\n    IResolvedUrl,\n    IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport { IOdspResolvedUrl, ShareLinkTypes, ShareLinkInfoType } from \"@fluidframework/odsp-driver-definitions\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { getOdspResolvedUrl } from \"./odspUtils\";\nimport { getHashedDocumentId } from \"./odspPublicUtils\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\n\nfunction getUrlBase(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const siteOrigin = new URL(siteUrl).origin;\n    const version = fileVersion ? `versions/${fileVersion}/` : \"\";\n    return `${getApiRoot(siteOrigin)}/drives/${driveId}/items/${itemId}/${version}`;\n}\n\nfunction getSnapshotUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/snapshots`;\n}\n\nfunction getAttachmentPOSTUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/attachment`;\n}\n\nfunction getAttachmentGETUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/attachments`;\n}\n\nfunction getDeltaStorageUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream`;\n}\n\n/**\n * Utility that enables us to handle paths provided with a beginning slash.\n * For example if a value of '/id1/id2' is provided, id1/id2 is returned.\n */\nfunction removeBeginningSlash(str: string): string {\n    if (str.startsWith(\"/\")) {\n        return str.substr(1);\n    }\n\n    return str;\n}\n\n/**\n * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner\n * url format. Ex: `${siteUrl}?driveId=${driveId}&itemId=${itemId}&path=${path}`\n */\nexport class OdspDriverUrlResolver implements IUrlResolver {\n    constructor() { }\n\n    public async resolve(request: IRequest): Promise<IOdspResolvedUrl> {\n        if (request.headers && request.headers[DriverHeader.createNew]) {\n            const [siteURL, queryString] = request.url.split(\"?\");\n\n            const searchParams = new URLSearchParams(queryString);\n            const fileName = request.headers[DriverHeader.createNew].fileName;\n            const driveID = searchParams.get(\"driveId\");\n            const filePath = searchParams.get(\"path\");\n            const packageName = searchParams.get(\"containerPackageName\");\n            const createLinkType = searchParams.get(\"createLinkType\");\n            if (!(fileName && siteURL && driveID && filePath !== null && filePath !== undefined)) {\n                throw new Error(\"Proper new file params should be there!!\");\n            }\n            let shareLinkInfo: ShareLinkInfoType | undefined;\n            if(createLinkType && createLinkType in ShareLinkTypes) {\n                shareLinkInfo = {\n                    createLink: {\n                        type: ShareLinkTypes[createLinkType],\n                    },\n                };\n            }\n            return {\n                endpoints: {\n                    snapshotStorageUrl: \"\",\n                    attachmentGETStorageUrl: \"\",\n                    attachmentPOSTStorageUrl: \"\",\n                    deltaStorageUrl: \"\",\n                },\n                tokens: {},\n                type: \"fluid\",\n                odspResolvedUrl: true,\n                id: \"odspCreateNew\",\n                url: `fluid-odsp://${siteURL}?${queryString}&version=null`,\n                siteUrl: siteURL,\n                hashedDocumentId: \"\",\n                driveId: driveID,\n                itemId: \"\",\n                fileName,\n                summarizer: false,\n                codeHint: {\n                    containerPackageName: packageName ? packageName : undefined,\n                },\n                fileVersion: undefined,\n                shareLinkInfo,\n                isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n            };\n        }\n        const { siteUrl, driveId, itemId, path, containerPackageName, fileVersion } = decodeOdspUrl(request.url);\n        const hashedDocumentId = await getHashedDocumentId(driveId, itemId);\n        assert(!hashedDocumentId.includes(\"/\"), 0x0a8 /* \"Docid should not contain slashes!!\" */);\n\n        let documentUrl = `fluid-odsp://placeholder/placeholder/${hashedDocumentId}/${removeBeginningSlash(path)}`;\n\n        if (request.url.length > 0) {\n            // In case of any additional parameters add them back to the url\n            const requestURL = new URL(request.url);\n            const searchParams = requestURL.search;\n            if (searchParams) {\n                documentUrl += searchParams;\n            }\n        }\n\n        const summarizer = !!request.headers?.[DriverHeader.summarizingClient];\n\n        return {\n            type: \"fluid\",\n            odspResolvedUrl: true,\n            endpoints: {\n                snapshotStorageUrl: getSnapshotUrl(siteUrl, driveId, itemId, fileVersion),\n                attachmentPOSTStorageUrl: getAttachmentPOSTUrl(siteUrl, driveId, itemId, fileVersion),\n                attachmentGETStorageUrl: getAttachmentGETUrl(siteUrl, driveId, itemId, fileVersion),\n                deltaStorageUrl: getDeltaStorageUrl(siteUrl, driveId, itemId, fileVersion),\n            },\n            id: hashedDocumentId,\n            tokens: {},\n            url: documentUrl,\n            hashedDocumentId,\n            siteUrl,\n            driveId,\n            itemId,\n            fileName: \"\",\n            summarizer,\n            codeHint: {\n                containerPackageName,\n            },\n            fileVersion,\n            isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n        };\n    }\n\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        relativeUrl: string,\n        packageInfoSource?: IContainerPackageInfo | IFluidCodeDetails,\n    ): Promise<string> {\n        let dataStorePath = relativeUrl;\n        if (dataStorePath.startsWith(\"/\")) {\n            dataStorePath = dataStorePath.substr(1);\n        }\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n\n        // back-compat: IFluidCodeDetails usage to be removed in 0.58.0\n        let containerPackageName;\n        if (packageInfoSource && \"name\" in packageInfoSource) {\n            containerPackageName = packageInfoSource.name\n        } else if (isFluidPackage(packageInfoSource?.package)) {\n            containerPackageName = packageInfoSource?.package.name\n        } else {\n            containerPackageName = packageInfoSource?.package\n        }\n        containerPackageName = containerPackageName ?? odspResolvedUrl.codeHint?.containerPackageName\n\n        return createOdspUrl({\n            ... odspResolvedUrl,\n            containerPackageName,\n            dataStorePath,\n        });\n    }\n}\n\nfunction decodeOdspUrl(url: string): {\n    siteUrl: string;\n    driveId: string;\n    itemId: string;\n    path: string;\n    containerPackageName?: string;\n    fileVersion?: string;\n} {\n    const [siteUrl, queryString] = url.split(\"?\");\n\n    const searchParams = new URLSearchParams(queryString);\n\n    const driveId = searchParams.get(\"driveId\");\n    const itemId = searchParams.get(\"itemId\");\n    const path = searchParams.get(\"path\");\n    const containerPackageName = searchParams.get(\"containerPackageName\");\n    const fileVersion = searchParams.get(\"fileVersion\");\n\n    if (driveId === null) {\n        throw new Error(\"ODSP URL did not contain a drive id\");\n    }\n\n    if (itemId === null) {\n        throw new Error(\"ODSP Url did not contain an item id\");\n    }\n\n    if (path === null) {\n        throw new Error(\"ODSP Url did not contain a path\");\n    }\n\n    return {\n        siteUrl,\n        driveId: decodeURIComponent(driveId),\n        itemId: decodeURIComponent(itemId),\n        path: decodeURIComponent(path),\n        containerPackageName: containerPackageName ? decodeURIComponent(containerPackageName) : undefined,\n        fileVersion: fileVersion ? decodeURIComponent(fileVersion) : undefined,\n    };\n}\n"]}

package/lib/odspDriverUrlResolverForShareLink.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { IFluidCodeDetails, IRequest } from "@fluidframework/core-interfaces";
-import { IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
+import { IContainerPackageInfo, IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
 import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 import { IOdspResolvedUrl, IdentityType, OdspResourceTokenFetchOptions, TokenFetcher } from "@fluidframework/odsp-driver-definitions";
 import { OdspFluidDataStoreLocator } from "./contractsPublic";
@@ -60,7 +60,7 @@ export declare class OdspDriverUrlResolverForShareLink implements IUrlResolver {
      * @param resolvedUrl - The driver resolved URL
      * @param request - The relative data store path URL. For requesting a driver URL, this value should always be '/'
      */
-    getAbsoluteUrl(resolvedUrl: IResolvedUrl, dataStorePath: string, codeDetails?: IFluidCodeDetails): Promise<string>;
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, dataStorePath: string, packageInfoSource?: IContainerPackageInfo | IFluidCodeDetails): Promise<string>;
     /**
      * Crafts a supported document/driver URL
      */

package/lib/odspDriverUrlResolverForShareLink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDriverUrlResolverForShareLink.d.ts","sourceRoot":"","sources":["../src/odspDriverUrlResolverForShareLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAkB,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,oBAAoB,EAAoB,MAAM,oCAAoC,CAAC;AAG5F,OAAO,EACH,gBAAgB,EAChB,YAAY,EAEZ,6BAA6B,EAC7B,YAAY,EAEf,MAAM,yCAAyC,CAAC;AAOjD,OAAO,EAAE,yBAAyB,EAAqB,MAAM,mBAAmB,CAAC;AAOjF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAC1D;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED;;;;GAIG;AACH,qBAAa,iCAAkC,YAAW,YAAY;IAkB9D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAjB7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsC;IACvE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAoC;IAE1E;;;;;;;;;OASG;gBAEC,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,SAAS,EACzD,MAAM,CAAC,EAAE,oBAAoB,EACZ,OAAO,CAAC,oBAAQ;IAWrC;;;OAGG;IACI,mBAAmB,CAAC,UAAU,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAyBrF,OAAO,CAAC,MAAM;IAId;;OAEG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA+BlE,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,0BAA0B;YAsBpB,mBAAmB;IA8BjC;;;;;OAKG;IACU,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,aAAa,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,iBAAiB,GAChC,OAAO,CAAC,MAAM,CAAC;IAwBlB;;OAEG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,yBAAyB;IAQtF;;OAEG;WACW,cAAc,CAAC,OAAO,EAAE,yBAAyB;CAGlE"}
+{"version":3,"file":"odspDriverUrlResolverForShareLink.d.ts","sourceRoot":"","sources":["../src/odspDriverUrlResolverForShareLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAkB,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EACH,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAoB,MAAM,oCAAoC,CAAC;AAG5F,OAAO,EACH,gBAAgB,EAChB,YAAY,EAEZ,6BAA6B,EAC7B,YAAY,EAEf,MAAM,yCAAyC,CAAC;AAOjD,OAAO,EAAE,yBAAyB,EAAqB,MAAM,mBAAmB,CAAC;AAOjF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAC1D;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED;;;;GAIG;AACH,qBAAa,iCAAkC,YAAW,YAAY;IAkB9D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAjB7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsC;IACvE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAoC;IAE1E;;;;;;;;;OASG;gBAEC,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,SAAS,EACzD,MAAM,CAAC,EAAE,oBAAoB,EACZ,OAAO,CAAC,oBAAQ;IAWrC;;;OAGG;IACI,mBAAmB,CAAC,UAAU,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAyBrF,OAAO,CAAC,MAAM;IAId;;OAEG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA+BlE,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,0BAA0B;YAqBpB,mBAAmB;IA8BjC;;;;;OAKG;IACU,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,aAAa,EAAE,MAAM,EACrB,iBAAiB,CAAC,EAAE,qBAAqB,GAAG,iBAAiB,GAC9D,OAAO,CAAC,MAAM,CAAC;IA6BlB;;OAEG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,yBAAyB;IAQtF;;OAEG;WACW,cAAc,CAAC,OAAO,EAAE,yBAAyB;CAGlE"}

package/lib/odspDriverUrlResolverForShareLink.js

@@ -107,7 +107,7 @@ export class OdspDriverUrlResolverForShareLink {
         return async (options) => {
             return PerformanceEvent.timedExecAsync(logger, { eventName: "GetSharingLinkToken" }, async (event) => tokenFetcher(options).then((tokenResponse) => {
                 if (tokenResponse === null) {
-                    throw new NonRetryableError("shareLinkTokenIsNull", "Token callback returned null", OdspErrorType.fetchTokenError, { driverVersion });
+                    throw new NonRetryableError("Token callback returned null for share link", OdspErrorType.fetchTokenError, { driverVersion });
                 }
                 event.end({ fromCache: isTokenFromCache(tokenResponse) });
                 return tokenResponse;
@@ -142,12 +142,23 @@ export class OdspDriverUrlResolverForShareLink {
      * @param resolvedUrl - The driver resolved URL
      * @param request - The relative data store path URL. For requesting a driver URL, this value should always be '/'
      */
-    async getAbsoluteUrl(resolvedUrl, dataStorePath, codeDetails) {
-        var _a, _b;
+    async getAbsoluteUrl(resolvedUrl, dataStorePath, packageInfoSource) {
+        var _a;
         const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);
         const shareLink = await this.getShareLinkPromise(odspResolvedUrl);
         const shareLinkUrl = new URL(shareLink);
-        const containerPackageName = isFluidPackage(codeDetails === null || codeDetails === void 0 ? void 0 : codeDetails.package) ? codeDetails === null || codeDetails === void 0 ? void 0 : codeDetails.package.name : (_a = codeDetails === null || codeDetails === void 0 ? void 0 : codeDetails.package) !== null && _a !== void 0 ? _a : (_b = odspResolvedUrl.codeHint) === null || _b === void 0 ? void 0 : _b.containerPackageName;
+        // back-compat: IFluidCodeDetails usage to be removed in 0.58.0
+        let containerPackageName;
+        if (packageInfoSource && "name" in packageInfoSource) {
+            containerPackageName = packageInfoSource.name;
+        }
+        else if (isFluidPackage(packageInfoSource === null || packageInfoSource === void 0 ? void 0 : packageInfoSource.package)) {
+            containerPackageName = packageInfoSource === null || packageInfoSource === void 0 ? void 0 : packageInfoSource.package.name;
+        }
+        else {
+            containerPackageName = packageInfoSource === null || packageInfoSource === void 0 ? void 0 : packageInfoSource.package;
+        }
+        containerPackageName = containerPackageName !== null && containerPackageName !== void 0 ? containerPackageName : (_a = odspResolvedUrl.codeHint) === null || _a === void 0 ? void 0 : _a.containerPackageName;
         storeLocatorInOdspUrl(shareLinkUrl, {
             siteUrl: odspResolvedUrl.siteUrl,
             driveId: odspResolvedUrl.driveId,

package/lib/odspDriverUrlResolverForShareLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDriverUrlResolverForShareLink.js","sourceRoot":"","sources":["../src/odspDriverUrlResolverForShareLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAA+B,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAG9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAGH,gBAAgB,EAGhB,aAAa,GAChB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACH,qBAAqB,EACrB,qBAAqB,EACrB,+BAA+B,EAC/B,qBAAqB,GACxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAA6B,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAgB/D;;;;GAIG;AACH,MAAM,OAAO,iCAAiC;IAK1C;;;;;;;;;OASG;IACH,YACI,qBAAyD,EACzD,MAA6B,EACZ,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;QAhBpB,qBAAgB,GAAG,IAAI,YAAY,EAAkB,CAAC;QAkBnE,IAAI,CAAC,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,qBAAqB,EAAE;YACvB,IAAI,CAAC,qBAAqB,mCACnB,qBAAqB,KACxB,YAAY,EAAE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,EAAE,qBAAqB,CAAC,YAAY,CAAC,GACjG,CAAC;SACL;IACL,CAAC;IAED;;;OAGG;IACI,mBAAmB,CAAC,UAAe,EAAE,YAAoB;QAC5D,MAAM,SAAS,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,GAAG,UAAU,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtG,mGAAmG;QACnG,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/D,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC,CAAC;YACtD,WAAW,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;gBAC/C,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;YACH,SAAS,CAAC,aAAa,GAAG,GAAG,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1E;aAAM;YACH,SAAS,CAAC,aAAa,GAAG,GAAG,UAAU,CAAC,QAAQ,GAC5C,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC7E,GAAG,YAAY,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1C;QACD,qBAAqB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE7C,OAAO,UAAU,CAAC,IAAI,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,WAA6B;QACxC,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,OAAiB;;QAClC,MAAM,mBAAmB,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3E,MAAM,qBAAqB,SAAG,mBAAmB,CAAC,OAAO,0CAAG,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QACrG,IAAI;YACA,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAEjC,MAAM,aAAa,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;YACjD,IAAI,aAAa,EAAE;gBACf,mBAAmB,CAAC,GAAG,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;aAC1D;SACJ;QAAC,WAAM;YACJ,8EAA8E;SACjF;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,qBAAqB,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEvF,IAAI,qBAAqB,EAAE;YACvB,yGAAyG;YACzG,sGAAsG;YACtG,uBAAuB;YACvB,eAAe,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,aAAa,IAAI,EAAE,EAC7E,EAAC,mBAAmB,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC;SAChE;QACD,IAAI,eAAe,CAAC,MAAM,EAAE;YACxB,iGAAiG;YACjG,mGAAmG;YACnG,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SAC7D;QACD,OAAO,eAAe,CAAC;IAC3B,CAAC;IAEO,cAAc,CAAC,IAAY;QAC/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QACrC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC/B,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAEO,0BAA0B,CAC9B,MAAwB,EACxB,YAAyD;QAEzD,OAAO,KAAK,EAAE,OAAsC,EAAE,EAAE;YACpD,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,qBAAqB,EAAE,EACpC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;gBAC1D,IAAI,aAAa,KAAK,IAAI,EAAE;oBACxB,MAAM,IAAI,iBAAiB,CACvB,sBAAsB,EACtB,8BAA8B,EAC9B,aAAa,CAAC,eAAe,EAC7B,EAAE,aAAa,EAAE,CAAC,CAAC;iBAC1B;gBACD,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,gBAAgB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;gBAC1D,OAAO,aAAa,CAAC;YACzB,CAAC,CAAC,CAAC,CAAC;QACZ,CAAC,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,WAA6B;QAC3D,IAAI,IAAI,CAAC,qBAAqB,KAAK,SAAS,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;SAC5F;QAED,IAAI,CAAC,CAAC,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE;YACrE,MAAM,IAAI,KAAK,CAAC,oEAAoE;gBAChF,mCAAmC,CAAC,CAAC;SAC5C;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACrC,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,iBAAiB,EAAE;YACnB,OAAO,iBAAiB,CAAC;SAC5B;QACD,MAAM,cAAc,GAAG,WAAW,CAC9B,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACvC,WAAW,EACX,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACvC,IAAI,CAAC,MAAM,CACd,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,yDAAyD;YACzD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,EAAE,KAAK,CAAC,CAAC;YACtE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,CAAC;QAC3D,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,aAAqB,EACrB,WAA+B;;QAE/B,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAExD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAElE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QAExC,MAAM,oBAAoB,GACtB,cAAc,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,IAAI,CAAC,CAAC,OAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,yCACvF,eAAe,CAAC,QAAQ,0CAAE,oBAAoB,CAAC;QAEnD,qBAAqB,CAAC,YAAY,EAAE;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,aAAa;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,oBAAoB;YACpB,WAAW,EAAE,eAAe,CAAC,WAAW;SAC3C,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAqC;QAClF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;QAE7B,qBAAqB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAEvC,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,OAAkC;QAC3D,OAAO,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { PromiseCache } from \"@fluidframework/common-utils\";\nimport { IFluidCodeDetails, IRequest, isFluidPackage } from \"@fluidframework/core-interfaces\";\nimport { IResolvedUrl, IUrlResolver } from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IOdspResolvedUrl,\n    IdentityType,\n    isTokenFromCache,\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n    OdspErrorType,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport {\n    getLocatorFromOdspUrl,\n    storeLocatorInOdspUrl,\n    encodeOdspFluidDataStoreLocator,\n    locatorQueryParamName,\n} from \"./odspFluidFileLink\";\nimport { OdspFluidDataStoreLocator, SharingLinkHeader } from \"./contractsPublic\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { getOdspResolvedUrl, createOdspLogger } from \"./odspUtils\";\nimport { getFileLink } from \"./getFileLink\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n/**\n * Properties passed to the code responsible for fetching share link for a file.\n */\nexport interface ShareLinkFetcherProps {\n    /**\n     * Callback method that is used to fetch access token necessary to call API that produces share link\n     */\n    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>;\n    /**\n     * Identity type determining the shape of share link as it differs for Enterprise and Consumer users.\n     */\n    identityType: IdentityType;\n}\n\n/**\n * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner\n * url format and the ones which have things like driveId, siteId, itemId etc encoded in nav param.\n * This resolver also handles share links and try to generate one for the use by the app.\n */\nexport class OdspDriverUrlResolverForShareLink implements IUrlResolver {\n    private readonly logger: ITelemetryLogger;\n    private readonly sharingLinkCache = new PromiseCache<string, string>();\n    private readonly shareLinkFetcherProps: ShareLinkFetcherProps | undefined;\n\n    /**\n     * Creates url resolver instance\n     * @param shareLinkFetcherProps - properties used when fetching share link.\n     * Can be set as 'undefined' for cases where share link is not needed. Currently, only\n     * getAbsoluteUrl() method requires share link.\n     * @param logger - logger object that is used as telemetry sink\n     * @param appName - application name hint that is encoded with url produced by getAbsoluteUrl() method.\n     * This hint is used by link handling logic which determines which app to redirect to when user\n     * navigates directly to the link.\n     */\n    public constructor(\n        shareLinkFetcherProps?: ShareLinkFetcherProps | undefined,\n        logger?: ITelemetryBaseLogger,\n        private readonly appName?: string,\n    ) {\n        this.logger = createOdspLogger(logger);\n        if (shareLinkFetcherProps) {\n            this.shareLinkFetcherProps = {\n                ...shareLinkFetcherProps,\n                tokenFetcher: this.toInstrumentedTokenFetcher(this.logger, shareLinkFetcherProps.tokenFetcher),\n            };\n        }\n    }\n\n    /**\n     * Takes an already generated data store url (from requestUrl) and appends a path to the\n     * existing data store information.\n     */\n    public appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined {\n        const fluidInfo = getLocatorFromOdspUrl(requestUrl);\n\n        if (!fluidInfo) {\n            return undefined;\n        }\n\n        const parsingUrl = new URL(fluidInfo.dataStorePath, `${requestUrl.protocol}//${requestUrl.hostname}`);\n        // Determine if the caller is passing a query parameter or path since processing will be different.\n        if (pathToAppend.startsWith(\"/?\") || pathToAppend.startsWith(\"?\")) {\n            const queryParams = new URLSearchParams(pathToAppend);\n            queryParams.forEach((value: string, key: string) => {\n                parsingUrl.searchParams.append(key, value);\n            });\n            fluidInfo.dataStorePath = `${parsingUrl.pathname}${parsingUrl.search}`;\n        } else {\n            fluidInfo.dataStorePath = `${parsingUrl.pathname}${\n                parsingUrl.pathname.endsWith(\"/\") || pathToAppend.startsWith(\"/\") ? \"\" : \"/\"\n            }${pathToAppend}/${parsingUrl.search}`;\n        }\n        storeLocatorInOdspUrl(requestUrl, fluidInfo);\n\n        return requestUrl.href;\n    }\n\n    private getKey(resolvedUrl: IOdspResolvedUrl): string {\n        return `${resolvedUrl.siteUrl},${resolvedUrl.driveId},${resolvedUrl.itemId}`;\n    }\n\n    /**\n     * Resolves request URL into driver details\n     */\n    public async resolve(request: IRequest): Promise<IOdspResolvedUrl> {\n        const requestToBeResolved = { headers: request.headers, url: request.url };\n        const isSharingLinkToRedeem = requestToBeResolved.headers?.[SharingLinkHeader.isSharingLinkToRedeem];\n        try {\n            const url = new URL(request.url);\n\n            const odspFluidInfo = getLocatorFromOdspUrl(url);\n            if (odspFluidInfo) {\n                requestToBeResolved.url = createOdspUrl(odspFluidInfo);\n            }\n        } catch {\n            // If the locator throws some error, then try to resolve the request as it is.\n        }\n\n        const odspResolvedUrl = await new OdspDriverUrlResolver().resolve(requestToBeResolved);\n\n        if (isSharingLinkToRedeem) {\n            // We need to remove the nav param if set by host when setting the sharelink as otherwise the shareLinkId\n            // when redeeming the share link during the redeem fallback for trees latest call becomes greater than\n            // the eligible length.\n            odspResolvedUrl.shareLinkInfo = Object.assign(odspResolvedUrl.shareLinkInfo || {},\n                {sharingLinkToRedeem: this.removeNavParam(request.url)});\n        }\n        if (odspResolvedUrl.itemId) {\n            // Kick start the sharing link request if we don't have it already as a performance optimization.\n            // For detached create new, we don't have an item id yet and therefore cannot generate a share link\n            this.getShareLinkPromise(odspResolvedUrl).catch(() => {});\n        }\n        return odspResolvedUrl;\n    }\n\n    private removeNavParam(link: string): string {\n        const url = new URL(link);\n        const params = new URLSearchParams(url.search);\n        params.delete(locatorQueryParamName);\n        url.search = params.toString();\n        return url.href;\n    }\n\n    private toInstrumentedTokenFetcher(\n        logger: ITelemetryLogger,\n        tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>,\n    ): TokenFetcher<OdspResourceTokenFetchOptions> {\n        return async (options: OdspResourceTokenFetchOptions) => {\n            return PerformanceEvent.timedExecAsync(\n                logger,\n                { eventName: \"GetSharingLinkToken\" },\n                async (event) => tokenFetcher(options).then((tokenResponse) => {\n                    if (tokenResponse === null) {\n                        throw new NonRetryableError(\n                            \"shareLinkTokenIsNull\",\n                            \"Token callback returned null\",\n                            OdspErrorType.fetchTokenError,\n                            { driverVersion });\n                    }\n                    event.end({ fromCache: isTokenFromCache(tokenResponse) });\n                    return tokenResponse;\n                }));\n        };\n    }\n\n    private async getShareLinkPromise(resolvedUrl: IOdspResolvedUrl): Promise<string> {\n        if (this.shareLinkFetcherProps === undefined) {\n            throw new Error(\"Failed to get share link because share link fetcher props are missing\");\n        }\n\n        if (!(resolvedUrl.siteUrl && resolvedUrl.driveId && resolvedUrl.itemId)) {\n            throw new Error(\"Failed to get share link because necessary information is missing \" +\n                \"(e.g. siteUrl, driveId or itemId)\");\n        }\n\n        const key = this.getKey(resolvedUrl);\n        const cachedLinkPromise = this.sharingLinkCache.get(key);\n        if (cachedLinkPromise) {\n            return cachedLinkPromise;\n        }\n        const newLinkPromise = getFileLink(\n            this.shareLinkFetcherProps.tokenFetcher,\n            resolvedUrl,\n            this.shareLinkFetcherProps.identityType,\n            this.logger,\n        ).catch((error) => {\n            // This should imply that error is a non-retriable error.\n            this.logger.sendErrorEvent({ eventName: \"FluidFileUrlError\" }, error);\n            this.sharingLinkCache.remove(key);\n            throw error;\n        });\n        this.sharingLinkCache.add(key, async () => newLinkPromise);\n        return newLinkPromise;\n    }\n\n    /**\n     * Requests a driver + data store storage URL. Note that this method requires share link to be fetched\n     * and it will throw in case share link fetcher props were not specified when instance was created.\n     * @param resolvedUrl - The driver resolved URL\n     * @param request - The relative data store path URL. For requesting a driver URL, this value should always be '/'\n     */\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        dataStorePath: string,\n        codeDetails?: IFluidCodeDetails,\n    ): Promise<string> {\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n\n        const shareLink = await this.getShareLinkPromise(odspResolvedUrl);\n\n        const shareLinkUrl = new URL(shareLink);\n\n        const containerPackageName =\n            isFluidPackage(codeDetails?.package) ? codeDetails?.package.name : codeDetails?.package ??\n            odspResolvedUrl.codeHint?.containerPackageName;\n\n        storeLocatorInOdspUrl(shareLinkUrl, {\n            siteUrl: odspResolvedUrl.siteUrl,\n            driveId: odspResolvedUrl.driveId,\n            itemId: odspResolvedUrl.itemId,\n            dataStorePath,\n            appName: this.appName,\n            containerPackageName,\n            fileVersion: odspResolvedUrl.fileVersion,\n        });\n\n        return shareLinkUrl.href;\n    }\n\n    /**\n     * Crafts a supported document/driver URL\n     */\n    public static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator) {\n        const url = new URL(baseUrl);\n\n        storeLocatorInOdspUrl(url, driverInfo);\n\n        return url.href;\n    }\n\n    /**\n     * Crafts a supported data store nav param\n     */\n    public static createNavParam(locator: OdspFluidDataStoreLocator) {\n        return encodeOdspFluidDataStoreLocator(locator);\n    }\n}\n"]}
+{"version":3,"file":"odspDriverUrlResolverForShareLink.js","sourceRoot":"","sources":["../src/odspDriverUrlResolverForShareLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAA+B,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAO9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAGH,gBAAgB,EAGhB,aAAa,GAChB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACH,qBAAqB,EACrB,qBAAqB,EACrB,+BAA+B,EAC/B,qBAAqB,GACxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAA6B,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAgB/D;;;;GAIG;AACH,MAAM,OAAO,iCAAiC;IAK1C;;;;;;;;;OASG;IACH,YACI,qBAAyD,EACzD,MAA6B,EACZ,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;QAhBpB,qBAAgB,GAAG,IAAI,YAAY,EAAkB,CAAC;QAkBnE,IAAI,CAAC,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,qBAAqB,EAAE;YACvB,IAAI,CAAC,qBAAqB,mCACnB,qBAAqB,KACxB,YAAY,EAAE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,EAAE,qBAAqB,CAAC,YAAY,CAAC,GACjG,CAAC;SACL;IACL,CAAC;IAED;;;OAGG;IACI,mBAAmB,CAAC,UAAe,EAAE,YAAoB;QAC5D,MAAM,SAAS,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,GAAG,UAAU,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtG,mGAAmG;QACnG,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/D,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC,CAAC;YACtD,WAAW,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;gBAC/C,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;YACH,SAAS,CAAC,aAAa,GAAG,GAAG,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1E;aAAM;YACH,SAAS,CAAC,aAAa,GAAG,GAAG,UAAU,CAAC,QAAQ,GAC5C,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC7E,GAAG,YAAY,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1C;QACD,qBAAqB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE7C,OAAO,UAAU,CAAC,IAAI,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,WAA6B;QACxC,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,OAAiB;;QAClC,MAAM,mBAAmB,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3E,MAAM,qBAAqB,SAAG,mBAAmB,CAAC,OAAO,0CAAG,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QACrG,IAAI;YACA,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAEjC,MAAM,aAAa,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;YACjD,IAAI,aAAa,EAAE;gBACf,mBAAmB,CAAC,GAAG,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;aAC1D;SACJ;QAAC,WAAM;YACJ,8EAA8E;SACjF;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,qBAAqB,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEvF,IAAI,qBAAqB,EAAE;YACvB,yGAAyG;YACzG,sGAAsG;YACtG,uBAAuB;YACvB,eAAe,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,aAAa,IAAI,EAAE,EAC7E,EAAC,mBAAmB,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC;SAChE;QACD,IAAI,eAAe,CAAC,MAAM,EAAE;YACxB,iGAAiG;YACjG,mGAAmG;YACnG,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SAC7D;QACD,OAAO,eAAe,CAAC;IAC3B,CAAC;IAEO,cAAc,CAAC,IAAY;QAC/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QACrC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC/B,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAEO,0BAA0B,CAC9B,MAAwB,EACxB,YAAyD;QAEzD,OAAO,KAAK,EAAE,OAAsC,EAAE,EAAE;YACpD,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,qBAAqB,EAAE,EACpC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;gBAC1D,IAAI,aAAa,KAAK,IAAI,EAAE;oBACxB,MAAM,IAAI,iBAAiB,CACvB,6CAA6C,EAC7C,aAAa,CAAC,eAAe,EAC7B,EAAE,aAAa,EAAE,CAAC,CAAC;iBAC1B;gBACD,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,gBAAgB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;gBAC1D,OAAO,aAAa,CAAC;YACzB,CAAC,CAAC,CAAC,CAAC;QACZ,CAAC,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,WAA6B;QAC3D,IAAI,IAAI,CAAC,qBAAqB,KAAK,SAAS,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;SAC5F;QAED,IAAI,CAAC,CAAC,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE;YACrE,MAAM,IAAI,KAAK,CAAC,oEAAoE;gBAChF,mCAAmC,CAAC,CAAC;SAC5C;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACrC,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,iBAAiB,EAAE;YACnB,OAAO,iBAAiB,CAAC;SAC5B;QACD,MAAM,cAAc,GAAG,WAAW,CAC9B,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACvC,WAAW,EACX,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACvC,IAAI,CAAC,MAAM,CACd,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,yDAAyD;YACzD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,EAAE,KAAK,CAAC,CAAC;YACtE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,CAAC;QAC3D,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,aAAqB,EACrB,iBAA6D;;QAE7D,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAClE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QAExC,+DAA+D;QAC/D,IAAI,oBAAoB,CAAC;QACzB,IAAI,iBAAiB,IAAI,MAAM,IAAI,iBAAiB,EAAE;YAClD,oBAAoB,GAAG,iBAAiB,CAAC,IAAI,CAAA;SAChD;aAAM,IAAI,cAAc,CAAC,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,CAAC,EAAE;YACnD,oBAAoB,GAAG,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,CAAC,IAAI,CAAA;SACzD;aAAM;YACH,oBAAoB,GAAG,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,CAAA;SACpD;QACD,oBAAoB,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,SAAI,eAAe,CAAC,QAAQ,0CAAE,oBAAoB,CAAA;QAE7F,qBAAqB,CAAC,YAAY,EAAE;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,aAAa;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,oBAAoB;YACpB,WAAW,EAAE,eAAe,CAAC,WAAW;SAC3C,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAqC;QAClF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;QAE7B,qBAAqB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAEvC,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,OAAkC;QAC3D,OAAO,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { PromiseCache } from \"@fluidframework/common-utils\";\nimport { IFluidCodeDetails, IRequest, isFluidPackage } from \"@fluidframework/core-interfaces\";\nimport {\n    IContainerPackageInfo,\n    IResolvedUrl,\n    IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IOdspResolvedUrl,\n    IdentityType,\n    isTokenFromCache,\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n    OdspErrorType,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport {\n    getLocatorFromOdspUrl,\n    storeLocatorInOdspUrl,\n    encodeOdspFluidDataStoreLocator,\n    locatorQueryParamName,\n} from \"./odspFluidFileLink\";\nimport { OdspFluidDataStoreLocator, SharingLinkHeader } from \"./contractsPublic\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { getOdspResolvedUrl, createOdspLogger } from \"./odspUtils\";\nimport { getFileLink } from \"./getFileLink\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n/**\n * Properties passed to the code responsible for fetching share link for a file.\n */\nexport interface ShareLinkFetcherProps {\n    /**\n     * Callback method that is used to fetch access token necessary to call API that produces share link\n     */\n    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>;\n    /**\n     * Identity type determining the shape of share link as it differs for Enterprise and Consumer users.\n     */\n    identityType: IdentityType;\n}\n\n/**\n * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner\n * url format and the ones which have things like driveId, siteId, itemId etc encoded in nav param.\n * This resolver also handles share links and try to generate one for the use by the app.\n */\nexport class OdspDriverUrlResolverForShareLink implements IUrlResolver {\n    private readonly logger: ITelemetryLogger;\n    private readonly sharingLinkCache = new PromiseCache<string, string>();\n    private readonly shareLinkFetcherProps: ShareLinkFetcherProps | undefined;\n\n    /**\n     * Creates url resolver instance\n     * @param shareLinkFetcherProps - properties used when fetching share link.\n     * Can be set as 'undefined' for cases where share link is not needed. Currently, only\n     * getAbsoluteUrl() method requires share link.\n     * @param logger - logger object that is used as telemetry sink\n     * @param appName - application name hint that is encoded with url produced by getAbsoluteUrl() method.\n     * This hint is used by link handling logic which determines which app to redirect to when user\n     * navigates directly to the link.\n     */\n    public constructor(\n        shareLinkFetcherProps?: ShareLinkFetcherProps | undefined,\n        logger?: ITelemetryBaseLogger,\n        private readonly appName?: string,\n    ) {\n        this.logger = createOdspLogger(logger);\n        if (shareLinkFetcherProps) {\n            this.shareLinkFetcherProps = {\n                ...shareLinkFetcherProps,\n                tokenFetcher: this.toInstrumentedTokenFetcher(this.logger, shareLinkFetcherProps.tokenFetcher),\n            };\n        }\n    }\n\n    /**\n     * Takes an already generated data store url (from requestUrl) and appends a path to the\n     * existing data store information.\n     */\n    public appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined {\n        const fluidInfo = getLocatorFromOdspUrl(requestUrl);\n\n        if (!fluidInfo) {\n            return undefined;\n        }\n\n        const parsingUrl = new URL(fluidInfo.dataStorePath, `${requestUrl.protocol}//${requestUrl.hostname}`);\n        // Determine if the caller is passing a query parameter or path since processing will be different.\n        if (pathToAppend.startsWith(\"/?\") || pathToAppend.startsWith(\"?\")) {\n            const queryParams = new URLSearchParams(pathToAppend);\n            queryParams.forEach((value: string, key: string) => {\n                parsingUrl.searchParams.append(key, value);\n            });\n            fluidInfo.dataStorePath = `${parsingUrl.pathname}${parsingUrl.search}`;\n        } else {\n            fluidInfo.dataStorePath = `${parsingUrl.pathname}${\n                parsingUrl.pathname.endsWith(\"/\") || pathToAppend.startsWith(\"/\") ? \"\" : \"/\"\n            }${pathToAppend}/${parsingUrl.search}`;\n        }\n        storeLocatorInOdspUrl(requestUrl, fluidInfo);\n\n        return requestUrl.href;\n    }\n\n    private getKey(resolvedUrl: IOdspResolvedUrl): string {\n        return `${resolvedUrl.siteUrl},${resolvedUrl.driveId},${resolvedUrl.itemId}`;\n    }\n\n    /**\n     * Resolves request URL into driver details\n     */\n    public async resolve(request: IRequest): Promise<IOdspResolvedUrl> {\n        const requestToBeResolved = { headers: request.headers, url: request.url };\n        const isSharingLinkToRedeem = requestToBeResolved.headers?.[SharingLinkHeader.isSharingLinkToRedeem];\n        try {\n            const url = new URL(request.url);\n\n            const odspFluidInfo = getLocatorFromOdspUrl(url);\n            if (odspFluidInfo) {\n                requestToBeResolved.url = createOdspUrl(odspFluidInfo);\n            }\n        } catch {\n            // If the locator throws some error, then try to resolve the request as it is.\n        }\n\n        const odspResolvedUrl = await new OdspDriverUrlResolver().resolve(requestToBeResolved);\n\n        if (isSharingLinkToRedeem) {\n            // We need to remove the nav param if set by host when setting the sharelink as otherwise the shareLinkId\n            // when redeeming the share link during the redeem fallback for trees latest call becomes greater than\n            // the eligible length.\n            odspResolvedUrl.shareLinkInfo = Object.assign(odspResolvedUrl.shareLinkInfo || {},\n                {sharingLinkToRedeem: this.removeNavParam(request.url)});\n        }\n        if (odspResolvedUrl.itemId) {\n            // Kick start the sharing link request if we don't have it already as a performance optimization.\n            // For detached create new, we don't have an item id yet and therefore cannot generate a share link\n            this.getShareLinkPromise(odspResolvedUrl).catch(() => {});\n        }\n        return odspResolvedUrl;\n    }\n\n    private removeNavParam(link: string): string {\n        const url = new URL(link);\n        const params = new URLSearchParams(url.search);\n        params.delete(locatorQueryParamName);\n        url.search = params.toString();\n        return url.href;\n    }\n\n    private toInstrumentedTokenFetcher(\n        logger: ITelemetryLogger,\n        tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>,\n    ): TokenFetcher<OdspResourceTokenFetchOptions> {\n        return async (options: OdspResourceTokenFetchOptions) => {\n            return PerformanceEvent.timedExecAsync(\n                logger,\n                { eventName: \"GetSharingLinkToken\" },\n                async (event) => tokenFetcher(options).then((tokenResponse) => {\n                    if (tokenResponse === null) {\n                        throw new NonRetryableError(\n                            \"Token callback returned null for share link\",\n                            OdspErrorType.fetchTokenError,\n                            { driverVersion });\n                    }\n                    event.end({ fromCache: isTokenFromCache(tokenResponse) });\n                    return tokenResponse;\n                }));\n        };\n    }\n\n    private async getShareLinkPromise(resolvedUrl: IOdspResolvedUrl): Promise<string> {\n        if (this.shareLinkFetcherProps === undefined) {\n            throw new Error(\"Failed to get share link because share link fetcher props are missing\");\n        }\n\n        if (!(resolvedUrl.siteUrl && resolvedUrl.driveId && resolvedUrl.itemId)) {\n            throw new Error(\"Failed to get share link because necessary information is missing \" +\n                \"(e.g. siteUrl, driveId or itemId)\");\n        }\n\n        const key = this.getKey(resolvedUrl);\n        const cachedLinkPromise = this.sharingLinkCache.get(key);\n        if (cachedLinkPromise) {\n            return cachedLinkPromise;\n        }\n        const newLinkPromise = getFileLink(\n            this.shareLinkFetcherProps.tokenFetcher,\n            resolvedUrl,\n            this.shareLinkFetcherProps.identityType,\n            this.logger,\n        ).catch((error) => {\n            // This should imply that error is a non-retriable error.\n            this.logger.sendErrorEvent({ eventName: \"FluidFileUrlError\" }, error);\n            this.sharingLinkCache.remove(key);\n            throw error;\n        });\n        this.sharingLinkCache.add(key, async () => newLinkPromise);\n        return newLinkPromise;\n    }\n\n    /**\n     * Requests a driver + data store storage URL. Note that this method requires share link to be fetched\n     * and it will throw in case share link fetcher props were not specified when instance was created.\n     * @param resolvedUrl - The driver resolved URL\n     * @param request - The relative data store path URL. For requesting a driver URL, this value should always be '/'\n     */\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        dataStorePath: string,\n        packageInfoSource?: IContainerPackageInfo | IFluidCodeDetails,\n    ): Promise<string> {\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n        const shareLink = await this.getShareLinkPromise(odspResolvedUrl);\n        const shareLinkUrl = new URL(shareLink);\n\n        // back-compat: IFluidCodeDetails usage to be removed in 0.58.0\n        let containerPackageName;\n        if (packageInfoSource && \"name\" in packageInfoSource) {\n            containerPackageName = packageInfoSource.name\n        } else if (isFluidPackage(packageInfoSource?.package)) {\n            containerPackageName = packageInfoSource?.package.name\n        } else {\n            containerPackageName = packageInfoSource?.package\n        }\n        containerPackageName = containerPackageName ?? odspResolvedUrl.codeHint?.containerPackageName\n\n        storeLocatorInOdspUrl(shareLinkUrl, {\n            siteUrl: odspResolvedUrl.siteUrl,\n            driveId: odspResolvedUrl.driveId,\n            itemId: odspResolvedUrl.itemId,\n            dataStorePath,\n            appName: this.appName,\n            containerPackageName,\n            fileVersion: odspResolvedUrl.fileVersion,\n        });\n\n        return shareLinkUrl.href;\n    }\n\n    /**\n     * Crafts a supported document/driver URL\n     */\n    public static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator) {\n        const url = new URL(baseUrl);\n\n        storeLocatorInOdspUrl(url, driverInfo);\n\n        return url.href;\n    }\n\n    /**\n     * Crafts a supported data store nav param\n     */\n    public static createNavParam(locator: OdspFluidDataStoreLocator) {\n        return encodeOdspFluidDataStoreLocator(locator);\n    }\n}\n"]}

package/lib/odspError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspError.d.ts","sourceRoot":"","sources":["../src/odspError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,k6BAWxF"}
+{"version":3,"file":"odspError.d.ts","sourceRoot":"","sources":["../src/odspError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,k6BAUxF"}

package/lib/odspError.js

@@ -7,8 +7,8 @@ import { createOdspNetworkError } from "@fluidframework/odsp-doclib-utils";
  * Returns network error based on error object from ODSP socket (IOdspSocketError)
  */
 export function errorObjectFromSocketError(socketError, handler) {
-    const message = `OdspSocketError (${handler}): ${socketError.message}`;
-    const error = createOdspNetworkError(`odspSocketError [${handler}]`, message, socketError.code, socketError.retryAfter);
+    const message = `ODSP socket error (${handler}): ${socketError.message}`;
+    const error = createOdspNetworkError(message, socketError.code, socketError.retryAfter);
     error.addTelemetryProperties({ odspError: true, relayServiceError: true });
     return error;
 }

package/lib/odspError.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspError.js","sourceRoot":"","sources":["../src/odspError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAG3E;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAC,WAA6B,EAAE,OAAe;IACrF,MAAM,OAAO,GAAG,oBAAoB,OAAO,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;IACvE,MAAM,KAAK,GAAG,sBAAsB,CAChC,oBAAoB,OAAO,GAAG,EAC9B,OAAO,EACP,WAAW,CAAC,IAAI,EAChB,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5B,KAAK,CAAC,sBAAsB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAE3E,OAAO,KAAK,CAAC;AACjB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { createOdspNetworkError } from \"@fluidframework/odsp-doclib-utils\";\nimport { IOdspSocketError } from \"./contracts\";\n\n/**\n * Returns network error based on error object from ODSP socket (IOdspSocketError)\n */\nexport function errorObjectFromSocketError(socketError: IOdspSocketError, handler: string) {\n    const message = `OdspSocketError (${handler}): ${socketError.message}`;\n    const error = createOdspNetworkError(\n        `odspSocketError [${handler}]`,\n        message,\n        socketError.code,\n        socketError.retryAfter);\n\n    error.addTelemetryProperties({ odspError: true, relayServiceError: true });\n\n    return error;\n}\n"]}
+{"version":3,"file":"odspError.js","sourceRoot":"","sources":["../src/odspError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAG3E;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAC,WAA6B,EAAE,OAAe;IACrF,MAAM,OAAO,GAAG,sBAAsB,OAAO,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;IACzE,MAAM,KAAK,GAAG,sBAAsB,CAChC,OAAO,EACP,WAAW,CAAC,IAAI,EAChB,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5B,KAAK,CAAC,sBAAsB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAE3E,OAAO,KAAK,CAAC;AACjB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { createOdspNetworkError } from \"@fluidframework/odsp-doclib-utils\";\nimport { IOdspSocketError } from \"./contracts\";\n\n/**\n * Returns network error based on error object from ODSP socket (IOdspSocketError)\n */\nexport function errorObjectFromSocketError(socketError: IOdspSocketError, handler: string) {\n    const message = `ODSP socket error (${handler}): ${socketError.message}`;\n    const error = createOdspNetworkError(\n        message,\n        socketError.code,\n        socketError.retryAfter);\n\n    error.addTelemetryProperties({ odspError: true, relayServiceError: true });\n\n    return error;\n}\n"]}

package/lib/odspUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspUtils.d.ts","sourceRoot":"","sources":["../src/odspUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAClH,OAAO,EAAE,YAAY,EAAmB,MAAM,oCAAoC,CAAC;AASnF,OAAO,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAOhG,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EAIjB,6BAA6B,EAC7B,cAAc,EACd,YAAY,EACZ,WAAW,EAEX,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,eAAO,MAAM,iCAAiC,sCAAsC,CAAC;AAErF,4DAA4D;AAC5D,eAAO,MAAM,SAAS,QAAS,MAAM,WAAwB,CAAC;AAE9D,MAAM,WAAW,iBAAiB;IAC9B,YAAY,EAAE,aAAa,CAAC;IAC5B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAChC,GAAG,EAAE,yBAAyB,EAAE,CAAC;IACjC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC;IACX,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC1D,2DAA2D;IAC3D,aAAa,CAAC,EAAE,GAAG,CAAC;CACvB;AAUD;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,cAoBrG;AAED,wBAAsB,WAAW,CAC7B,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,WAAW,GAAG,SAAS,GACrC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CA2DlC;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAC5B,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,WAAW,GAAG,SAAS,GACrC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAWrC;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAAC,CAAC,EAC7C,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,WAAW,GAAG,SAAS,GACrC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CA2B3B;AAED,MAAM,WAAW,YAAY;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACnC;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,YAAY,GAAG,gBAAgB,CAG9E;AAED,eAAO,MAAM,gBAAgB,0GAQnB,CAAC;AAEX,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,aAAa;;;;;EAqBxD;AAED,wBAAgB,8BAA8B,CAC1C,MAAM,EAAE,gBAAgB,EACxB,WAAW,EAAE,gBAAgB,EAC7B,YAAY,EAAE,YAAY,CAAC,6BAA6B,CAAC,EACzD,gBAAgB,EAAE,OAAO,GAC1B,+BAA+B,CAqDjC;AAED,wBAAgB,sBAAsB,CAAC,eAAe,EAAE,gBAAgB,GAAG,WAAW,CAUrF"}
+{"version":3,"file":"odspUtils.d.ts","sourceRoot":"","sources":["../src/odspUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAClH,OAAO,EAAE,YAAY,EAAmB,MAAM,oCAAoC,CAAC;AASnF,OAAO,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAOhG,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EAIjB,6BAA6B,EAC7B,cAAc,EACd,YAAY,EACZ,WAAW,EAEX,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,eAAO,MAAM,iCAAiC,sCAAsC,CAAC;AAErF,4DAA4D;AAC5D,eAAO,MAAM,SAAS,QAAS,MAAM,WAAwB,CAAC;AAE9D,MAAM,WAAW,iBAAiB;IAC9B,YAAY,EAAE,aAAa,CAAC;IAC5B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAChC,GAAG,EAAE,yBAAyB,EAAE,CAAC;IACjC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC;IACX,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC1D,2DAA2D;IAC3D,aAAa,CAAC,EAAE,GAAG,CAAC;CACvB;AAUD;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,cAoBrG;AAED,wBAAsB,WAAW,CAC7B,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,WAAW,GAAG,SAAS,GACrC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CA0DlC;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAC5B,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,WAAW,GAAG,SAAS,GACrC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAWrC;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAAC,CAAC,EAC7C,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,WAAW,GAAG,SAAS,GACrC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CA2B3B;AAED,MAAM,WAAW,YAAY;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACnC;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,YAAY,GAAG,gBAAgB,CAG9E;AAED,eAAO,MAAM,gBAAgB,0GAQnB,CAAC;AAEX,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,aAAa;;;;;EAqBxD;AAED,wBAAgB,8BAA8B,CAC1C,MAAM,EAAE,gBAAgB,EACxB,WAAW,EAAE,gBAAgB,EAC7B,YAAY,EAAE,YAAY,CAAC,6BAA6B,CAAC,EACzD,gBAAgB,EAAE,OAAO,GAC1B,+BAA+B,CAmDjC;AAED,wBAAgB,sBAAsB,CAAC,eAAe,EAAE,gBAAgB,GAAG,WAAW,CAUrF"}

package/lib/odspUtils.js

@@ -52,10 +52,10 @@ export async function fetchHelper(requestInfo, requestInit) {
         const response = fetchResponse;
         // Let's assume we can retry.
         if (!response) {
-            throw new NonRetryableError("odspFetchErrorNoResponse", "No response from fetch call", DriverErrorType.incorrectServerResponse, { driverVersion });
+            throw new NonRetryableError("No response from ODSP fetch call", DriverErrorType.incorrectServerResponse, { driverVersion });
         }
         if (!response.ok || response.status < 200 || response.status >= 300) {
-            throwOdspNetworkError(`odspFetchError [${response.status}]`, response.status, response, await response.text());
+            throwOdspNetworkError(`ODSP fetch error [${response.status}]`, response.status, response, await response.text());
         }
         const headers = headersToMap(response.headers);
         return {
@@ -75,22 +75,22 @@ export async function fetchHelper(requestInfo, requestInit) {
         }
         // This error is thrown by fetch() when AbortSignal is provided and it gets cancelled
         if (error.name === "AbortError") {
-            throw new RetryableError("fetchAbort", "Fetch Timeout (AbortError)", OdspErrorType.fetchTimeout, { driverVersion });
+            throw new RetryableError("Fetch Timeout (AbortError)", OdspErrorType.fetchTimeout, { driverVersion });
         }
         // TCP/IP timeout
         if (errorText.indexOf("ETIMEDOUT") !== -1) {
-            throw new RetryableError("fetchETimedout", "Fetch Timeout (ETIMEDOUT)", OdspErrorType.fetchTimeout, { driverVersion });
+            throw new RetryableError("Fetch Timeout (ETIMEDOUT)", OdspErrorType.fetchTimeout, { driverVersion });
         }
         //
         // WARNING: Do not log error object itself or any of its properties!
-        // It could container PII, like URI in message itself, or token in properties.
+        // It could contain PII, like URI in message itself, or token in properties.
         // It is also non-serializable object due to circular references.
         //
         if (online === OnlineStatus.Offline) {
-            throw new RetryableError("OdspFetchOffline", `Offline: ${errorText}`, DriverErrorType.offlineError, { driverVersion });
+            throw new RetryableError(`ODSP fetch failure (Offline): ${errorText}`, DriverErrorType.offlineError, { driverVersion });
         }
         else {
-            throw new RetryableError("OdspFetchError", `Fetch error: ${errorText}`, DriverErrorType.fetchFailure, { driverVersion });
+            throw new RetryableError(`ODSP fetch failure: ${errorText}`, DriverErrorType.fetchFailure, { driverVersion });
         }
     });
 }
@@ -127,7 +127,7 @@ export async function fetchAndParseAsJSONHelper(requestInfo, requestInit) {
         // (many ops) almost always ends up with this error - I'd guess 1% of op request end up here... It always
         // succeeds on retry.
         // So do not log error object itself.
-        throwOdspNetworkError("errorWhileParsingFetchResponse", fetchIncorrectResponse, content, // response
+        throwOdspNetworkError("Error while parsing fetch response", fetchIncorrectResponse, content, // response
         text);
     }
     propsToLog.bodySize = text.length;
@@ -192,14 +192,14 @@ export function toInstrumentedOdspTokenFetcher(logger, resolvedUrl, tokenFetcher
                 event.end({ fromCache: isTokenFromCache(tokenResponse), isNull: token === null });
             }
             if (token === null && throwOnNullToken) {
-                throw new NonRetryableError("storageTokenIsNull", `Token is null for ${name} call`, OdspErrorType.fetchTokenError, { method: name, driverVersion });
+                throw new NonRetryableError(`The Host-provided token fetcher for ${name} call returned null`, OdspErrorType.fetchTokenError, { method: name, driverVersion });
             }
             return token;
         }, (error) => {
             // There is an important but unofficial contract here where token providers can set canRetry: true
             // to hook into the driver's retry logic (e.g. the retry loop when initiating a connection)
             const rawCanRetry = error === null || error === void 0 ? void 0 : error.canRetry;
-            const tokenError = wrapError(error, (errorMessage) => new NetworkErrorBasic("tokenFetcherFailed", errorMessage, OdspErrorType.fetchTokenError, typeof rawCanRetry === "boolean" ? rawCanRetry : false /* canRetry */, { method: name, driverVersion }));
+            const tokenError = wrapError(error, (errorMessage) => new NetworkErrorBasic(`The Host-provided token fetcher for ${name} call threw an error: ${errorMessage}`, OdspErrorType.fetchTokenError, typeof rawCanRetry === "boolean" ? rawCanRetry : false /* canRetry */, { method: name, driverVersion }));
             throw tokenError;
         }), { cancel: "generic" });
     };

package/lib/odspUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspUtils.js","sourceRoot":"","sources":["../src/odspUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAgB,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EACH,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAC3F,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,oCAAoC,GACvC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAGH,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAKhB,WAAW,GAEd,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG/D,MAAM,CAAC,MAAM,iCAAiC,GAAG,mCAAmC,CAAC;AAErF,4DAA4D;AAC5D,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AAqB9D,SAAS,YAAY,CAAC,OAAgB;IAClC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE;QAC1C,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;KAC9B;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAI,GAAiD;IAClG,OAAO,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC7C,MAAM,OAAO,GAAwB,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;QACzE,QAAQ,CAAC,CAAC,SAAS,EAAE;YACjB,kEAAkE;YAClE,KAAK,eAAe,CAAC,kBAAkB;gBACnC,OAAO,GAAG,iCAAM,OAAO,KAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAG,CAAC;YAEvE,KAAK,eAAe,CAAC,uBAAuB,CAAC,CAAC,qCAAqC;YACnF,KAAK,aAAa,CAAC,eAAe,EAAE,0CAA0C;gBAC1E,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;YAExB;gBACI,+CAA+C;gBAC/C,IAAI,CAAC,CAAC,iCAAiC,CAAC,KAAK,IAAI,EAAE;oBAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;iBACvB;gBACD,MAAM,CAAC,CAAC;SACf;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC7B,WAAwB,EACxB,WAAoC;IAEpC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAEhC,oFAAoF;IACpF,OAAO,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;QAChE,MAAM,QAAQ,GAAG,aAAgC,CAAC;QAClD,6BAA6B;QAC7B,IAAI,CAAC,QAAQ,EAAE;YACX,MAAM,IAAI,iBAAiB,CACvB,0BAA0B,EAC1B,6BAA6B,EAC7B,eAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAE,CAAC,CAAC;SAC1B;QACD,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;YACjE,qBAAqB,CACjB,mBAAmB,QAAQ,CAAC,MAAM,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;SAChG;QAED,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/C,OAAO;YACH,OAAO,EAAE,QAAQ;YACjB,OAAO;YACP,UAAU,EAAE,oCAAoC,CAAC,OAAO,CAAC;YACzD,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;SACtC,CAAC;IACN,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;QACT,8FAA8F;QAC9F,wFAAwF;QACxF,2CAA2C;QAC3C,IAAI,MAAM,GAAG,QAAQ,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,GAAG,KAAK,EAAE,CAAC;QAC7B,IAAI,SAAS,KAAK,4BAA4B,EAAE;YAC5C,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC;SACjC;QACD,qFAAqF;QACrF,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;YAC7B,MAAM,IAAI,cAAc,CACpB,YAAY,EAAE,4BAA4B,EAAE,aAAa,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SAClG;QACD,iBAAiB;QACjB,IAAI,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE;YACvC,MAAM,IAAI,cAAc,CACpB,gBAAgB,EAAE,2BAA2B,EAAE,aAAa,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SACrG;QAED,EAAE;QACF,oEAAoE;QACpE,8EAA8E;QAC9E,iEAAiE;QACjE,EAAE;QACF,IAAI,MAAM,KAAK,YAAY,CAAC,OAAO,EAAE;YACjC,MAAM,IAAI,cAAc,CACpB,kBAAkB,EAAE,YAAY,SAAS,EAAE,EAAE,eAAe,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SACrG;aAAM;YACH,MAAM,IAAI,cAAc,CACpB,gBAAgB,EAAE,gBAAgB,SAAS,EAAE,EAAE,eAAe,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SACvG;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC5B,WAAwB,EACxB,WAAoC;IAEpC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAE/F,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;IAChD,UAAU,CAAC,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC;IAC7C,OAAO;QACH,OAAO;QACP,OAAO,EAAE,WAAW;QACpB,UAAU;QACV,QAAQ;KACX,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC3C,WAAwB,EACxB,WAAoC;IAEpC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC/F,IAAI,IAAwB,CAAC;IAC7B,IAAI;QACA,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;KAC/B;IAAC,OAAO,CAAC,EAAE;QACR,gFAAgF;QAChF,8GAA8G;QAC9G,yGAAyG;QACzG,qBAAqB;QACrB,qCAAqC;QACrC,qBAAqB,CACjB,gCAAgC,EAChC,sBAAsB,EACtB,OAAO,EAAE,WAAW;QACpB,IAAI,CACP,CAAC;KACL;IAED,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,MAAM,GAAG,GAAG;QACR,OAAO;QACP,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACzB,UAAU;QACV,QAAQ;KACX,CAAC;IACF,OAAO,GAAG,CAAC;AACf,CAAC;AAeD,MAAM,UAAU,kBAAkB,CAAC,WAAyB;IACxD,MAAM,CAAE,WAAgC,CAAC,eAAe,KAAK,IAAI,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC3G,OAAO,WAA+B,CAAC;AAC3C,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAA6B,EAAE,EAAE,CAC9D,WAAW,CAAC,MAAM,CACd,MAAM,EACN,YAAY,EACZ,EAAE,GAAG,EACD;QACI,aAAa;KAChB;CACJ,CAAC,CAAC;AAEX,MAAM,UAAU,iBAAiB,CAAC,QAAuB;IACrD,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE;QAC/B,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE;YAClC,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE;gBAC3B,QAAQ,EAAE,CAAC;aACd;iBAAM,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE;gBAClC,QAAQ,EAAE,CAAC;aACd;SACJ;KACJ;IACD,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE;QAC9B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE;YAC/B,gBAAgB,IAAI,IAAI,CAAC,IAAI,CAAC;YAC9B,gBAAgB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;SAC3C;KACJ;IACD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC1C,MAAwB,EACxB,WAA6B,EAC7B,YAAyD,EACzD,gBAAyB;IAEzB,OAAO,KAAK,EAAE,OAA0B,EAAE,IAAY,EAAE,kCAA2C,KAAK,EAAE,EAAE;QACxG,+EAA+E;QAC/E,6EAA6E;QAC7E,yFAAyF;QACzF,kBAAkB;QAClB,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN;YACI,SAAS,EAAE,GAAG,IAAI,WAAW;YAC7B,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM;YAC3B,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ;SAClC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,iCACtB,OAAO,KACV,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,MAAM,EAAE,WAAW,CAAC,MAAM,IAC5B,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;YACtB,MAAM,KAAK,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC/C,yFAAyF;YACzF,2DAA2D;YAC3D,oFAAoF;YACpF,6FAA6F;YAC7F,oCAAoC;YACpC,IAAI,+BAA+B,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE;gBACzD,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,gBAAgB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC;aACrF;YACD,IAAI,KAAK,KAAK,IAAI,IAAI,gBAAgB,EAAE;gBACpC,MAAM,IAAI,iBAAiB,CACvB,oBAAoB,EACpB,qBAAqB,IAAI,OAAO,EAChC,aAAa,CAAC,eAAe,EAC7B,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;aACxC;YACD,OAAO,KAAK,CAAC;QACjB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;YACT,kGAAkG;YAClG,2FAA2F;YAC3F,MAAM,WAAW,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,CAAC;YACpC,MAAM,UAAU,GAAG,SAAS,CACxB,KAAK,EACL,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,iBAAiB,CACnC,oBAAoB,EACpB,YAAY,EACZ,aAAa,CAAC,eAAe,EAC7B,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,EACrE,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YAC1C,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,eAAiC;IACpE,MAAM,UAAU,GAAgB;QAC5B,IAAI,EAAE,WAAW;QACjB,GAAG,EAAE,EAAE;QACP,IAAI,EAAE;YACF,WAAW,EAAE,eAAe;YAC5B,KAAK,EAAE,eAAe,CAAC,gBAAgB;SAC1C;KACJ,CAAC;IACF,OAAO,UAAU,CAAC;AACtB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties, ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { IResolvedUrl, DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    isOnline,\n    OnlineStatus,\n    RetryableError,\n    NonRetryableError,\n    NetworkErrorBasic,\n} from \"@fluidframework/driver-utils\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger, PerformanceEvent, wrapError } from \"@fluidframework/telemetry-utils\";\nimport {\n    fetchIncorrectResponse,\n    throwOdspNetworkError,\n    getSPOAndGraphRequestIdsFromResponse,\n} from \"@fluidframework/odsp-doclib-utils\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    OdspErrorType,\n    tokenFromResponse,\n    isTokenFromCache,\n    OdspResourceTokenFetchOptions,\n    ShareLinkTypes,\n    TokenFetcher,\n    ICacheEntry,\n    snapshotKey,\n    InstrumentedStorageTokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { fetch } from \"./fetch\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { IOdspSnapshot } from \"./contracts\";\n\nexport const getWithRetryForTokenRefreshRepeat = \"getWithRetryForTokenRefreshRepeat\";\n\n/** Parse the given url and return the origin (host name) */\nexport const getOrigin = (url: string) => new URL(url).origin;\n\nexport interface ISnapshotContents {\n    snapshotTree: ISnapshotTree,\n    blobs: Map<string, ArrayBuffer>,\n    ops: ISequencedDocumentMessage[],\n    sequenceNumber: number | undefined,\n}\n\nexport interface IOdspResponse<T> {\n    content: T;\n    headers: Map<string, string>;\n    propsToLog: ITelemetryProperties;\n    duration: number,\n}\n\nexport interface TokenFetchOptionsEx extends TokenFetchOptions {\n    /** previous error we hit in getWithRetryForTokenRefresh */\n    previousError?: any;\n}\n\nfunction headersToMap(headers: Headers) {\n    const newHeaders = new Map<string, string>();\n    for (const [key, value] of headers.entries()) {\n        newHeaders.set(key, value);\n    }\n    return newHeaders;\n}\n\n/**\n * This API should be used with pretty much all network calls (fetch, webSocket connection) in order\n * to correctly handle expired tokens. It relies on callback fetching token, and be able to refetch\n * token on failure. Only specific cases get retry call with refresh = true, all other / unknown errors\n * simply propagate to caller\n */\nexport async function getWithRetryForTokenRefresh<T>(get: (options: TokenFetchOptionsEx) => Promise<T>) {\n    return get({ refresh: false }).catch(async (e) => {\n        const options: TokenFetchOptionsEx = { refresh: true, previousError: e };\n        switch (e.errorType) {\n            // If the error is 401 or 403 refresh the token and try once more.\n            case DriverErrorType.authorizationError:\n                return get({ ...options, claims: e.claims, tenantId: e.tenantId });\n\n            case DriverErrorType.incorrectServerResponse: // some error on the wire, retry once\n            case OdspErrorType.fetchTokenError: // If the token was null, then retry once.\n                return get(options);\n\n            default:\n                // Caller may determine that it wants one retry\n                if (e[getWithRetryForTokenRefreshRepeat] === true) {\n                    return get(options);\n                }\n                throw e;\n        }\n    });\n}\n\nexport async function fetchHelper(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<Response>> {\n    const start = performance.now();\n\n    // Node-fetch and dom have conflicting typing, force them to work by casting for now\n    return fetch(requestInfo, requestInit).then(async (fetchResponse) => {\n        const response = fetchResponse as any as Response;\n        // Let's assume we can retry.\n        if (!response) {\n            throw new NonRetryableError(\n                \"odspFetchErrorNoResponse\",\n                \"No response from fetch call\",\n                DriverErrorType.incorrectServerResponse,\n                { driverVersion });\n        }\n        if (!response.ok || response.status < 200 || response.status >= 300) {\n            throwOdspNetworkError(\n                `odspFetchError [${response.status}]`, response.status, response, await response.text());\n        }\n\n        const headers = headersToMap(response.headers);\n        return {\n            content: response,\n            headers,\n            propsToLog: getSPOAndGraphRequestIdsFromResponse(headers),\n            duration: performance.now() - start,\n        };\n    }, (error) => {\n        // While we do not know for sure whether computer is offline, this error is not actionable and\n        // is pretty good indicator we are offline. Treating it as offline scenario will make it\n        // easier to see other errors in telemetry.\n        let online = isOnline();\n        const errorText = `${error}`;\n        if (errorText === \"TypeError: Failed to fetch\") {\n            online = OnlineStatus.Offline;\n        }\n        // This error is thrown by fetch() when AbortSignal is provided and it gets cancelled\n        if (error.name === \"AbortError\") {\n            throw new RetryableError(\n                \"fetchAbort\", \"Fetch Timeout (AbortError)\", OdspErrorType.fetchTimeout, { driverVersion });\n        }\n        // TCP/IP timeout\n        if (errorText.indexOf(\"ETIMEDOUT\") !== -1) {\n            throw new RetryableError(\n                \"fetchETimedout\", \"Fetch Timeout (ETIMEDOUT)\", OdspErrorType.fetchTimeout, { driverVersion });\n        }\n\n        //\n        // WARNING: Do not log error object itself or any of its properties!\n        // It could container PII, like URI in message itself, or token in properties.\n        // It is also non-serializable object due to circular references.\n        //\n        if (online === OnlineStatus.Offline) {\n            throw new RetryableError(\n                \"OdspFetchOffline\", `Offline: ${errorText}`, DriverErrorType.offlineError, { driverVersion });\n        } else {\n            throw new RetryableError(\n                \"OdspFetchError\", `Fetch error: ${errorText}`, DriverErrorType.fetchFailure, { driverVersion });\n        }\n    });\n}\n\n/**\n * A utility function to fetch and parse as JSON with support for retries\n * @param requestInfo - fetch requestInfo, can be a string\n * @param requestInit - fetch requestInit\n */\nexport async function fetchArray(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<ArrayBuffer>> {\n    const { content, headers, propsToLog, duration } = await fetchHelper(requestInfo, requestInit);\n\n    const arrayBuffer = await content.arrayBuffer();\n    propsToLog.bodySize = arrayBuffer.byteLength;\n    return {\n        headers,\n        content: arrayBuffer,\n        propsToLog,\n        duration,\n    };\n}\n\n/**\n * A utility function to fetch and parse as JSON with support for retries\n * @param requestInfo - fetch requestInfo, can be a string\n * @param requestInit - fetch requestInit\n */\nexport async function fetchAndParseAsJSONHelper<T>(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<T>> {\n    const { content, headers, propsToLog, duration } = await fetchHelper(requestInfo, requestInit);\n    let text: string | undefined;\n    try {\n        text = await content.text();\n    } catch (e) {\n        // JSON.parse() can fail and message would container full request URI, including\n        // tokens... It fails for me with \"Unexpected end of JSON input\" quite often - an attempt to download big file\n        // (many ops) almost always ends up with this error - I'd guess 1% of op request end up here... It always\n        // succeeds on retry.\n        // So do not log error object itself.\n        throwOdspNetworkError(\n            \"errorWhileParsingFetchResponse\",\n            fetchIncorrectResponse,\n            content, // response\n            text,\n        );\n    }\n\n    propsToLog.bodySize = text.length;\n    const res = {\n        headers,\n        content: JSON.parse(text),\n        propsToLog,\n        duration,\n    };\n    return res;\n}\n\nexport interface INewFileInfo {\n    siteUrl: string;\n    driveId: string;\n    filename: string;\n    filePath: string;\n    /**\n     * application can request creation of a share link along with the creation of a new file\n     * by passing in an optional param to specify the kind of sharing link\n     * (at the time of adding this comment Sept/2021), odsp only supports csl\n     */\n    createLinkType?: ShareLinkTypes;\n}\n\nexport function getOdspResolvedUrl(resolvedUrl: IResolvedUrl): IOdspResolvedUrl {\n    assert((resolvedUrl as IOdspResolvedUrl).odspResolvedUrl === true, 0x1de /* \"Not an ODSP resolved url\" */);\n    return resolvedUrl as IOdspResolvedUrl;\n}\n\nexport const createOdspLogger = (logger?: ITelemetryBaseLogger) =>\n    ChildLogger.create(\n        logger,\n        \"OdspDriver\",\n        { all :\n            {\n                driverVersion,\n            },\n        });\n\nexport function evalBlobsAndTrees(snapshot: IOdspSnapshot) {\n    let numTrees = 0;\n    let numBlobs = 0;\n    let encodedBlobsSize = 0;\n    let decodedBlobsSize = 0;\n    for (const tree of snapshot.trees) {\n        for (const treeEntry of tree.entries) {\n            if (treeEntry.type === \"blob\") {\n                numBlobs++;\n            } else if (treeEntry.type === \"tree\") {\n                numTrees++;\n            }\n        }\n    }\n    if (snapshot.blobs !== undefined) {\n        for (const blob of snapshot.blobs) {\n            decodedBlobsSize += blob.size;\n            encodedBlobsSize += blob.content.length;\n        }\n    }\n    return { numTrees, numBlobs, encodedBlobsSize, decodedBlobsSize };\n}\n\nexport function toInstrumentedOdspTokenFetcher(\n    logger: ITelemetryLogger,\n    resolvedUrl: IOdspResolvedUrl,\n    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>,\n    throwOnNullToken: boolean,\n): InstrumentedStorageTokenFetcher {\n    return async (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry: boolean = false) => {\n        // Telemetry note: if options.refresh is true, there is a potential perf issue:\n        // Host should optimize and provide non-expired tokens on all critical paths.\n        // Exceptions: race conditions around expiration, revoked tokens, host that does not care\n        // (fluid-fetcher)\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            {\n                eventName: `${name}_GetToken`,\n                attempts: options.refresh ? 2 : 1,\n                hasClaims: !!options.claims,\n                hasTenantId: !!options.tenantId,\n            },\n            async (event) => tokenFetcher({\n                ...options,\n                siteUrl: resolvedUrl.siteUrl,\n                driveId: resolvedUrl.driveId,\n                itemId: resolvedUrl.itemId,\n            }).then((tokenResponse) => {\n                const token = tokenFromResponse(tokenResponse);\n                // This event alone generates so many events that is materially impacts cost of telemetry\n                // Thus do not report end event when it comes back quickly.\n                // Note that most of the hosts do not report if result is comming from cache or not,\n                // so we can't rely on that here. But always record if specified explicitly for cases such as\n                // calling trees/latest during load.\n                if (alwaysRecordTokenFetchTelemetry || event.duration >= 32) {\n                    event.end({ fromCache: isTokenFromCache(tokenResponse), isNull: token === null });\n                }\n                if (token === null && throwOnNullToken) {\n                    throw new NonRetryableError(\n                        \"storageTokenIsNull\",\n                        `Token is null for ${name} call`,\n                        OdspErrorType.fetchTokenError,\n                        { method: name, driverVersion });\n                }\n                return token;\n            }, (error) => {\n                // There is an important but unofficial contract here where token providers can set canRetry: true\n                // to hook into the driver's retry logic (e.g. the retry loop when initiating a connection)\n                const rawCanRetry = error?.canRetry;\n                const tokenError = wrapError(\n                    error,\n                    (errorMessage) => new NetworkErrorBasic(\n                        \"tokenFetcherFailed\",\n                        errorMessage,\n                        OdspErrorType.fetchTokenError,\n                        typeof rawCanRetry === \"boolean\" ? rawCanRetry : false /* canRetry */,\n                        { method: name, driverVersion }));\n                throw tokenError;\n            }),\n            { cancel: \"generic\" });\n    };\n}\n\nexport function createCacheSnapshotKey(odspResolvedUrl: IOdspResolvedUrl): ICacheEntry {\n    const cacheEntry: ICacheEntry = {\n        type: snapshotKey,\n        key: \"\",\n        file: {\n            resolvedUrl: odspResolvedUrl,\n            docId: odspResolvedUrl.hashedDocumentId,\n        },\n    };\n    return cacheEntry;\n}\n"]}
+{"version":3,"file":"odspUtils.js","sourceRoot":"","sources":["../src/odspUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAgB,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EACH,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAC3F,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,oCAAoC,GACvC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAGH,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAKhB,WAAW,GAEd,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG/D,MAAM,CAAC,MAAM,iCAAiC,GAAG,mCAAmC,CAAC;AAErF,4DAA4D;AAC5D,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AAqB9D,SAAS,YAAY,CAAC,OAAgB;IAClC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE;QAC1C,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;KAC9B;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAI,GAAiD;IAClG,OAAO,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC7C,MAAM,OAAO,GAAwB,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;QACzE,QAAQ,CAAC,CAAC,SAAS,EAAE;YACjB,kEAAkE;YAClE,KAAK,eAAe,CAAC,kBAAkB;gBACnC,OAAO,GAAG,iCAAM,OAAO,KAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAG,CAAC;YAEvE,KAAK,eAAe,CAAC,uBAAuB,CAAC,CAAC,qCAAqC;YACnF,KAAK,aAAa,CAAC,eAAe,EAAE,0CAA0C;gBAC1E,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;YAExB;gBACI,+CAA+C;gBAC/C,IAAI,CAAC,CAAC,iCAAiC,CAAC,KAAK,IAAI,EAAE;oBAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;iBACvB;gBACD,MAAM,CAAC,CAAC;SACf;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC7B,WAAwB,EACxB,WAAoC;IAEpC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAEhC,oFAAoF;IACpF,OAAO,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;QAChE,MAAM,QAAQ,GAAG,aAAgC,CAAC;QAClD,6BAA6B;QAC7B,IAAI,CAAC,QAAQ,EAAE;YACX,MAAM,IAAI,iBAAiB,CACvB,kCAAkC,EAClC,eAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAE,CAAC,CAAC;SAC1B;QACD,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;YACjE,qBAAqB,CACjB,qBAAqB,QAAQ,CAAC,MAAM,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;SAClG;QAED,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/C,OAAO;YACH,OAAO,EAAE,QAAQ;YACjB,OAAO;YACP,UAAU,EAAE,oCAAoC,CAAC,OAAO,CAAC;YACzD,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;SACtC,CAAC;IACN,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;QACT,8FAA8F;QAC9F,wFAAwF;QACxF,2CAA2C;QAC3C,IAAI,MAAM,GAAG,QAAQ,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,GAAG,KAAK,EAAE,CAAC;QAC7B,IAAI,SAAS,KAAK,4BAA4B,EAAE;YAC5C,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC;SACjC;QACD,qFAAqF;QACrF,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;YAC7B,MAAM,IAAI,cAAc,CACpB,4BAA4B,EAAE,aAAa,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SACpF;QACD,iBAAiB;QACjB,IAAI,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE;YACvC,MAAM,IAAI,cAAc,CACpB,2BAA2B,EAAE,aAAa,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SACnF;QAED,EAAE;QACF,oEAAoE;QACpE,4EAA4E;QAC5E,iEAAiE;QACjE,EAAE;QACF,IAAI,MAAM,KAAK,YAAY,CAAC,OAAO,EAAE;YACjC,MAAM,IAAI,cAAc,CACpB,iCAAiC,SAAS,EAAE,EAAE,eAAe,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SACtG;aAAM;YACH,MAAM,IAAI,cAAc,CACpB,uBAAuB,SAAS,EAAE,EAAE,eAAe,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SAC5F;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC5B,WAAwB,EACxB,WAAoC;IAEpC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAE/F,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;IAChD,UAAU,CAAC,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC;IAC7C,OAAO;QACH,OAAO;QACP,OAAO,EAAE,WAAW;QACpB,UAAU;QACV,QAAQ;KACX,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC3C,WAAwB,EACxB,WAAoC;IAEpC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC/F,IAAI,IAAwB,CAAC;IAC7B,IAAI;QACA,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;KAC/B;IAAC,OAAO,CAAC,EAAE;QACR,gFAAgF;QAChF,8GAA8G;QAC9G,yGAAyG;QACzG,qBAAqB;QACrB,qCAAqC;QACrC,qBAAqB,CACjB,oCAAoC,EACpC,sBAAsB,EACtB,OAAO,EAAE,WAAW;QACpB,IAAI,CACP,CAAC;KACL;IAED,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,MAAM,GAAG,GAAG;QACR,OAAO;QACP,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACzB,UAAU;QACV,QAAQ;KACX,CAAC;IACF,OAAO,GAAG,CAAC;AACf,CAAC;AAeD,MAAM,UAAU,kBAAkB,CAAC,WAAyB;IACxD,MAAM,CAAE,WAAgC,CAAC,eAAe,KAAK,IAAI,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC3G,OAAO,WAA+B,CAAC;AAC3C,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAA6B,EAAE,EAAE,CAC9D,WAAW,CAAC,MAAM,CACd,MAAM,EACN,YAAY,EACZ,EAAE,GAAG,EACD;QACI,aAAa;KAChB;CACJ,CAAC,CAAC;AAEX,MAAM,UAAU,iBAAiB,CAAC,QAAuB;IACrD,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE;QAC/B,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE;YAClC,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE;gBAC3B,QAAQ,EAAE,CAAC;aACd;iBAAM,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE;gBAClC,QAAQ,EAAE,CAAC;aACd;SACJ;KACJ;IACD,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE;QAC9B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE;YAC/B,gBAAgB,IAAI,IAAI,CAAC,IAAI,CAAC;YAC9B,gBAAgB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;SAC3C;KACJ;IACD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC1C,MAAwB,EACxB,WAA6B,EAC7B,YAAyD,EACzD,gBAAyB;IAEzB,OAAO,KAAK,EAAE,OAA0B,EAAE,IAAY,EAAE,kCAA2C,KAAK,EAAE,EAAE;QACxG,+EAA+E;QAC/E,6EAA6E;QAC7E,yFAAyF;QACzF,kBAAkB;QAClB,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN;YACI,SAAS,EAAE,GAAG,IAAI,WAAW;YAC7B,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM;YAC3B,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ;SAClC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,iCACtB,OAAO,KACV,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,MAAM,EAAE,WAAW,CAAC,MAAM,IAC5B,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;YACtB,MAAM,KAAK,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC/C,yFAAyF;YACzF,2DAA2D;YAC3D,oFAAoF;YACpF,6FAA6F;YAC7F,oCAAoC;YACpC,IAAI,+BAA+B,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE;gBACzD,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,gBAAgB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC;aACrF;YACD,IAAI,KAAK,KAAK,IAAI,IAAI,gBAAgB,EAAE;gBACpC,MAAM,IAAI,iBAAiB,CACvB,uCAAuC,IAAI,qBAAqB,EAChE,aAAa,CAAC,eAAe,EAC7B,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;aACxC;YACD,OAAO,KAAK,CAAC;QACjB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;YACT,kGAAkG;YAClG,2FAA2F;YAC3F,MAAM,WAAW,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,CAAC;YACpC,MAAM,UAAU,GAAG,SAAS,CACxB,KAAK,EACL,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,iBAAiB,CACnC,uCAAuC,IAAI,yBAAyB,YAAY,EAAE,EAClF,aAAa,CAAC,eAAe,EAC7B,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,EACrE,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YAC1C,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,eAAiC;IACpE,MAAM,UAAU,GAAgB;QAC5B,IAAI,EAAE,WAAW;QACjB,GAAG,EAAE,EAAE;QACP,IAAI,EAAE;YACF,WAAW,EAAE,eAAe;YAC5B,KAAK,EAAE,eAAe,CAAC,gBAAgB;SAC1C;KACJ,CAAC;IACF,OAAO,UAAU,CAAC;AACtB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties, ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { IResolvedUrl, DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    isOnline,\n    OnlineStatus,\n    RetryableError,\n    NonRetryableError,\n    NetworkErrorBasic,\n} from \"@fluidframework/driver-utils\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger, PerformanceEvent, wrapError } from \"@fluidframework/telemetry-utils\";\nimport {\n    fetchIncorrectResponse,\n    throwOdspNetworkError,\n    getSPOAndGraphRequestIdsFromResponse,\n} from \"@fluidframework/odsp-doclib-utils\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    OdspErrorType,\n    tokenFromResponse,\n    isTokenFromCache,\n    OdspResourceTokenFetchOptions,\n    ShareLinkTypes,\n    TokenFetcher,\n    ICacheEntry,\n    snapshotKey,\n    InstrumentedStorageTokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { fetch } from \"./fetch\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { IOdspSnapshot } from \"./contracts\";\n\nexport const getWithRetryForTokenRefreshRepeat = \"getWithRetryForTokenRefreshRepeat\";\n\n/** Parse the given url and return the origin (host name) */\nexport const getOrigin = (url: string) => new URL(url).origin;\n\nexport interface ISnapshotContents {\n    snapshotTree: ISnapshotTree,\n    blobs: Map<string, ArrayBuffer>,\n    ops: ISequencedDocumentMessage[],\n    sequenceNumber: number | undefined,\n}\n\nexport interface IOdspResponse<T> {\n    content: T;\n    headers: Map<string, string>;\n    propsToLog: ITelemetryProperties;\n    duration: number,\n}\n\nexport interface TokenFetchOptionsEx extends TokenFetchOptions {\n    /** previous error we hit in getWithRetryForTokenRefresh */\n    previousError?: any;\n}\n\nfunction headersToMap(headers: Headers) {\n    const newHeaders = new Map<string, string>();\n    for (const [key, value] of headers.entries()) {\n        newHeaders.set(key, value);\n    }\n    return newHeaders;\n}\n\n/**\n * This API should be used with pretty much all network calls (fetch, webSocket connection) in order\n * to correctly handle expired tokens. It relies on callback fetching token, and be able to refetch\n * token on failure. Only specific cases get retry call with refresh = true, all other / unknown errors\n * simply propagate to caller\n */\nexport async function getWithRetryForTokenRefresh<T>(get: (options: TokenFetchOptionsEx) => Promise<T>) {\n    return get({ refresh: false }).catch(async (e) => {\n        const options: TokenFetchOptionsEx = { refresh: true, previousError: e };\n        switch (e.errorType) {\n            // If the error is 401 or 403 refresh the token and try once more.\n            case DriverErrorType.authorizationError:\n                return get({ ...options, claims: e.claims, tenantId: e.tenantId });\n\n            case DriverErrorType.incorrectServerResponse: // some error on the wire, retry once\n            case OdspErrorType.fetchTokenError: // If the token was null, then retry once.\n                return get(options);\n\n            default:\n                // Caller may determine that it wants one retry\n                if (e[getWithRetryForTokenRefreshRepeat] === true) {\n                    return get(options);\n                }\n                throw e;\n        }\n    });\n}\n\nexport async function fetchHelper(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<Response>> {\n    const start = performance.now();\n\n    // Node-fetch and dom have conflicting typing, force them to work by casting for now\n    return fetch(requestInfo, requestInit).then(async (fetchResponse) => {\n        const response = fetchResponse as any as Response;\n        // Let's assume we can retry.\n        if (!response) {\n            throw new NonRetryableError(\n                \"No response from ODSP fetch call\",\n                DriverErrorType.incorrectServerResponse,\n                { driverVersion });\n        }\n        if (!response.ok || response.status < 200 || response.status >= 300) {\n            throwOdspNetworkError(\n                `ODSP fetch error [${response.status}]`, response.status, response, await response.text());\n        }\n\n        const headers = headersToMap(response.headers);\n        return {\n            content: response,\n            headers,\n            propsToLog: getSPOAndGraphRequestIdsFromResponse(headers),\n            duration: performance.now() - start,\n        };\n    }, (error) => {\n        // While we do not know for sure whether computer is offline, this error is not actionable and\n        // is pretty good indicator we are offline. Treating it as offline scenario will make it\n        // easier to see other errors in telemetry.\n        let online = isOnline();\n        const errorText = `${error}`;\n        if (errorText === \"TypeError: Failed to fetch\") {\n            online = OnlineStatus.Offline;\n        }\n        // This error is thrown by fetch() when AbortSignal is provided and it gets cancelled\n        if (error.name === \"AbortError\") {\n            throw new RetryableError(\n                \"Fetch Timeout (AbortError)\", OdspErrorType.fetchTimeout, { driverVersion });\n        }\n        // TCP/IP timeout\n        if (errorText.indexOf(\"ETIMEDOUT\") !== -1) {\n            throw new RetryableError(\n                \"Fetch Timeout (ETIMEDOUT)\", OdspErrorType.fetchTimeout, { driverVersion });\n        }\n\n        //\n        // WARNING: Do not log error object itself or any of its properties!\n        // It could contain PII, like URI in message itself, or token in properties.\n        // It is also non-serializable object due to circular references.\n        //\n        if (online === OnlineStatus.Offline) {\n            throw new RetryableError(\n                `ODSP fetch failure (Offline): ${errorText}`, DriverErrorType.offlineError, { driverVersion });\n        } else {\n            throw new RetryableError(\n                `ODSP fetch failure: ${errorText}`, DriverErrorType.fetchFailure, { driverVersion });\n        }\n    });\n}\n\n/**\n * A utility function to fetch and parse as JSON with support for retries\n * @param requestInfo - fetch requestInfo, can be a string\n * @param requestInit - fetch requestInit\n */\nexport async function fetchArray(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<ArrayBuffer>> {\n    const { content, headers, propsToLog, duration } = await fetchHelper(requestInfo, requestInit);\n\n    const arrayBuffer = await content.arrayBuffer();\n    propsToLog.bodySize = arrayBuffer.byteLength;\n    return {\n        headers,\n        content: arrayBuffer,\n        propsToLog,\n        duration,\n    };\n}\n\n/**\n * A utility function to fetch and parse as JSON with support for retries\n * @param requestInfo - fetch requestInfo, can be a string\n * @param requestInit - fetch requestInit\n */\nexport async function fetchAndParseAsJSONHelper<T>(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<T>> {\n    const { content, headers, propsToLog, duration } = await fetchHelper(requestInfo, requestInit);\n    let text: string | undefined;\n    try {\n        text = await content.text();\n    } catch (e) {\n        // JSON.parse() can fail and message would container full request URI, including\n        // tokens... It fails for me with \"Unexpected end of JSON input\" quite often - an attempt to download big file\n        // (many ops) almost always ends up with this error - I'd guess 1% of op request end up here... It always\n        // succeeds on retry.\n        // So do not log error object itself.\n        throwOdspNetworkError(\n            \"Error while parsing fetch response\",\n            fetchIncorrectResponse,\n            content, // response\n            text,\n        );\n    }\n\n    propsToLog.bodySize = text.length;\n    const res = {\n        headers,\n        content: JSON.parse(text),\n        propsToLog,\n        duration,\n    };\n    return res;\n}\n\nexport interface INewFileInfo {\n    siteUrl: string;\n    driveId: string;\n    filename: string;\n    filePath: string;\n    /**\n     * application can request creation of a share link along with the creation of a new file\n     * by passing in an optional param to specify the kind of sharing link\n     * (at the time of adding this comment Sept/2021), odsp only supports csl\n     */\n    createLinkType?: ShareLinkTypes;\n}\n\nexport function getOdspResolvedUrl(resolvedUrl: IResolvedUrl): IOdspResolvedUrl {\n    assert((resolvedUrl as IOdspResolvedUrl).odspResolvedUrl === true, 0x1de /* \"Not an ODSP resolved url\" */);\n    return resolvedUrl as IOdspResolvedUrl;\n}\n\nexport const createOdspLogger = (logger?: ITelemetryBaseLogger) =>\n    ChildLogger.create(\n        logger,\n        \"OdspDriver\",\n        { all :\n            {\n                driverVersion,\n            },\n        });\n\nexport function evalBlobsAndTrees(snapshot: IOdspSnapshot) {\n    let numTrees = 0;\n    let numBlobs = 0;\n    let encodedBlobsSize = 0;\n    let decodedBlobsSize = 0;\n    for (const tree of snapshot.trees) {\n        for (const treeEntry of tree.entries) {\n            if (treeEntry.type === \"blob\") {\n                numBlobs++;\n            } else if (treeEntry.type === \"tree\") {\n                numTrees++;\n            }\n        }\n    }\n    if (snapshot.blobs !== undefined) {\n        for (const blob of snapshot.blobs) {\n            decodedBlobsSize += blob.size;\n            encodedBlobsSize += blob.content.length;\n        }\n    }\n    return { numTrees, numBlobs, encodedBlobsSize, decodedBlobsSize };\n}\n\nexport function toInstrumentedOdspTokenFetcher(\n    logger: ITelemetryLogger,\n    resolvedUrl: IOdspResolvedUrl,\n    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>,\n    throwOnNullToken: boolean,\n): InstrumentedStorageTokenFetcher {\n    return async (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry: boolean = false) => {\n        // Telemetry note: if options.refresh is true, there is a potential perf issue:\n        // Host should optimize and provide non-expired tokens on all critical paths.\n        // Exceptions: race conditions around expiration, revoked tokens, host that does not care\n        // (fluid-fetcher)\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            {\n                eventName: `${name}_GetToken`,\n                attempts: options.refresh ? 2 : 1,\n                hasClaims: !!options.claims,\n                hasTenantId: !!options.tenantId,\n            },\n            async (event) => tokenFetcher({\n                ...options,\n                siteUrl: resolvedUrl.siteUrl,\n                driveId: resolvedUrl.driveId,\n                itemId: resolvedUrl.itemId,\n            }).then((tokenResponse) => {\n                const token = tokenFromResponse(tokenResponse);\n                // This event alone generates so many events that is materially impacts cost of telemetry\n                // Thus do not report end event when it comes back quickly.\n                // Note that most of the hosts do not report if result is comming from cache or not,\n                // so we can't rely on that here. But always record if specified explicitly for cases such as\n                // calling trees/latest during load.\n                if (alwaysRecordTokenFetchTelemetry || event.duration >= 32) {\n                    event.end({ fromCache: isTokenFromCache(tokenResponse), isNull: token === null });\n                }\n                if (token === null && throwOnNullToken) {\n                    throw new NonRetryableError(\n                        `The Host-provided token fetcher for ${name} call returned null`,\n                        OdspErrorType.fetchTokenError,\n                        { method: name, driverVersion });\n                }\n                return token;\n            }, (error) => {\n                // There is an important but unofficial contract here where token providers can set canRetry: true\n                // to hook into the driver's retry logic (e.g. the retry loop when initiating a connection)\n                const rawCanRetry = error?.canRetry;\n                const tokenError = wrapError(\n                    error,\n                    (errorMessage) => new NetworkErrorBasic(\n                        `The Host-provided token fetcher for ${name} call threw an error: ${errorMessage}`,\n                        OdspErrorType.fetchTokenError,\n                        typeof rawCanRetry === \"boolean\" ? rawCanRetry : false /* canRetry */,\n                        { method: name, driverVersion }));\n                throw tokenError;\n            }),\n            { cancel: \"generic\" });\n    };\n}\n\nexport function createCacheSnapshotKey(odspResolvedUrl: IOdspResolvedUrl): ICacheEntry {\n    const cacheEntry: ICacheEntry = {\n        type: snapshotKey,\n        key: \"\",\n        file: {\n            resolvedUrl: odspResolvedUrl,\n            docId: odspResolvedUrl.hashedDocumentId,\n        },\n    };\n    return cacheEntry;\n}\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.57.1";
+export declare const pkgVersion = "0.58.0-55561";
 //# 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,WAAW,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,iBAAiB,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.57.1";
+export const pkgVersion = "0.58.0-55561";
 //# 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,QAAQ,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.57.1\";\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,cAAc,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.0-55561\";\n"]}

package/lib/retryErrorsStorageAdapter.js

@@ -44,7 +44,7 @@ export class RetryErrorsStorageAdapter {
     }
     checkStorageDisposed() {
         if (this._disposed) {
-            throw new LoggingError("storageServiceDisposedCannotRetry", { canRetry: false });
+            throw new LoggingError("Storage Service is disposed. Cannot retry", { canRetry: false });
         }
     }
     async runWithRetry(api, callName) {

package/lib/retryErrorsStorageAdapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"retryErrorsStorageAdapter.js","sourceRoot":"","sources":["../src/retryErrorsStorageAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAe/D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,OAAO,yBAAyB;IAElC,YACqB,sBAA+C,EAC/C,MAAwB;QADxB,2BAAsB,GAAtB,sBAAsB,CAAyB;QAC/C,WAAM,GAAN,MAAM,CAAkB;QAHrC,cAAS,GAAG,KAAK,CAAC;IAK1B,CAAC;IAED,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;IAChD,CAAC;IACD,IAAW,QAAQ,KAAI,OAAO,IAAI,CAAC,SAAS,CAAC,CAAA,CAAC;IACvC,OAAO;QACV,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC;IACrD,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAkB;QAC3C,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,EAChE,yBAAyB,CAC5B,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,EACpD,kBAAkB,CACrB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa;QAC5D,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,EACrE,qBAAqB,CACxB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,IAAW,EAAE,OAAiB,EAAE,OAAe,EAAE,GAAW;QAC3E,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,EAC1E,eAAe,CAClB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,OAAqB,EAAE,OAAwB;QACjF,4DAA4D;QAC5D,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClF,kCAAkC,CACrC,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAsB;QAC/C,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,MAAM,CAAC,EAC/D,yBAAyB,CAC5B,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QACzC,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,EACxD,oBAAoB,CACvB,CAAC;IACN,CAAC;IAEO,oBAAoB;QACxB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,MAAM,IAAI,YAAY,CAAC,mCAAmC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;SACpF;IACL,CAAC;IAEO,KAAK,CAAC,YAAY,CAAI,GAAqB,EAAE,QAAgB;QACjE,OAAO,YAAY,CACf,GAAG,EACH,QAAQ,EACR,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,CACpC,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { LoggingError } from \"@fluidframework/telemetry-utils\";\nimport {\n    IDocumentStorageService,\n    IDocumentStorageServicePolicies,\n    ISummaryContext,\n} from \"@fluidframework/driver-definitions\";\nimport {\n    ICreateBlobResponse,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    ITree,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IDisposable, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { runWithRetry } from \"./retryUtils\";\n\nexport class RetryErrorsStorageAdapter implements IDocumentStorageService, IDisposable {\n    private _disposed = false;\n    constructor(\n        private readonly internalStorageService: IDocumentStorageService,\n        private readonly logger: ITelemetryLogger,\n    ) {\n    }\n\n    public get policies(): IDocumentStorageServicePolicies | undefined {\n        return this.internalStorageService.policies;\n    }\n    public get disposed() {return this._disposed;}\n    public dispose() {\n        this._disposed = true;\n    }\n\n    public get repositoryUrl(): string {\n        return this.internalStorageService.repositoryUrl;\n    }\n\n    public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.getSnapshotTree(version),\n            \"storage_getSnapshotTree\",\n        );\n    }\n\n    public async readBlob(id: string): Promise<ArrayBufferLike> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.readBlob(id),\n            \"storage_readBlob\",\n        );\n    }\n\n    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.getVersions(versionId, count),\n            \"storage_getVersions\",\n        );\n    }\n\n    public async write(tree: ITree, parents: string[], message: string, ref: string): Promise<IVersion> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.write(tree, parents, message, ref),\n            \"storage_write\",\n        );\n    }\n\n    public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {\n        // Creation flow with attachment blobs - need to do retries!\n        return this.runWithRetry(\n            async () => this.internalStorageService.uploadSummaryWithContext(summary, context),\n            \"storage_uploadSummaryWithContext\",\n        );\n    }\n\n    public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.downloadSummary(handle),\n            \"storage_downloadSummary\",\n        );\n    }\n\n    public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.createBlob(file),\n            \"storage_createBlob\",\n        );\n    }\n\n    private checkStorageDisposed() {\n        if (this._disposed) {\n            throw new LoggingError(\"storageServiceDisposedCannotRetry\", { canRetry: false });\n        }\n    }\n\n    private async runWithRetry<T>(api: () => Promise<T>, callName: string): Promise<T> {\n        return runWithRetry(\n            api,\n            callName,\n            this.logger,\n            () => this.checkStorageDisposed(),\n        );\n    }\n}\n"]}
+{"version":3,"file":"retryErrorsStorageAdapter.js","sourceRoot":"","sources":["../src/retryErrorsStorageAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAe/D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,OAAO,yBAAyB;IAElC,YACqB,sBAA+C,EAC/C,MAAwB;QADxB,2BAAsB,GAAtB,sBAAsB,CAAyB;QAC/C,WAAM,GAAN,MAAM,CAAkB;QAHrC,cAAS,GAAG,KAAK,CAAC;IAK1B,CAAC;IAED,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;IAChD,CAAC;IACD,IAAW,QAAQ,KAAI,OAAO,IAAI,CAAC,SAAS,CAAC,CAAA,CAAC;IACvC,OAAO;QACV,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC;IACrD,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAkB;QAC3C,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,EAChE,yBAAyB,CAC5B,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,EACpD,kBAAkB,CACrB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa;QAC5D,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,EACrE,qBAAqB,CACxB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,IAAW,EAAE,OAAiB,EAAE,OAAe,EAAE,GAAW;QAC3E,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,EAC1E,eAAe,CAClB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,OAAqB,EAAE,OAAwB;QACjF,4DAA4D;QAC5D,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClF,kCAAkC,CACrC,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAsB;QAC/C,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,MAAM,CAAC,EAC/D,yBAAyB,CAC5B,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QACzC,OAAO,IAAI,CAAC,YAAY,CACpB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,EACxD,oBAAoB,CACvB,CAAC;IACN,CAAC;IAEO,oBAAoB;QACxB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,MAAM,IAAI,YAAY,CAAC,2CAA2C,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;SAC5F;IACL,CAAC;IAEO,KAAK,CAAC,YAAY,CAAI,GAAqB,EAAE,QAAgB;QACjE,OAAO,YAAY,CACf,GAAG,EACH,QAAQ,EACR,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,CACpC,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { LoggingError } from \"@fluidframework/telemetry-utils\";\nimport {\n    IDocumentStorageService,\n    IDocumentStorageServicePolicies,\n    ISummaryContext,\n} from \"@fluidframework/driver-definitions\";\nimport {\n    ICreateBlobResponse,\n    ISnapshotTree,\n    ISummaryHandle,\n    ISummaryTree,\n    ITree,\n    IVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IDisposable, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { runWithRetry } from \"./retryUtils\";\n\nexport class RetryErrorsStorageAdapter implements IDocumentStorageService, IDisposable {\n    private _disposed = false;\n    constructor(\n        private readonly internalStorageService: IDocumentStorageService,\n        private readonly logger: ITelemetryLogger,\n    ) {\n    }\n\n    public get policies(): IDocumentStorageServicePolicies | undefined {\n        return this.internalStorageService.policies;\n    }\n    public get disposed() {return this._disposed;}\n    public dispose() {\n        this._disposed = true;\n    }\n\n    public get repositoryUrl(): string {\n        return this.internalStorageService.repositoryUrl;\n    }\n\n    public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.getSnapshotTree(version),\n            \"storage_getSnapshotTree\",\n        );\n    }\n\n    public async readBlob(id: string): Promise<ArrayBufferLike> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.readBlob(id),\n            \"storage_readBlob\",\n        );\n    }\n\n    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.getVersions(versionId, count),\n            \"storage_getVersions\",\n        );\n    }\n\n    public async write(tree: ITree, parents: string[], message: string, ref: string): Promise<IVersion> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.write(tree, parents, message, ref),\n            \"storage_write\",\n        );\n    }\n\n    public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {\n        // Creation flow with attachment blobs - need to do retries!\n        return this.runWithRetry(\n            async () => this.internalStorageService.uploadSummaryWithContext(summary, context),\n            \"storage_uploadSummaryWithContext\",\n        );\n    }\n\n    public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.downloadSummary(handle),\n            \"storage_downloadSummary\",\n        );\n    }\n\n    public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {\n        return this.runWithRetry(\n            async () => this.internalStorageService.createBlob(file),\n            \"storage_createBlob\",\n        );\n    }\n\n    private checkStorageDisposed() {\n        if (this._disposed) {\n            throw new LoggingError(\"Storage Service is disposed. Cannot retry\", { canRetry: false });\n        }\n    }\n\n    private async runWithRetry<T>(api: () => Promise<T>, callName: string): Promise<T> {\n        return runWithRetry(\n            api,\n            callName,\n            this.logger,\n            () => this.checkStorageDisposed(),\n        );\n    }\n}\n"]}

package/lib/zipItDataRepresentationUtils.js

@@ -401,7 +401,7 @@ export function assertBoolInstance(node, message) {
     throwBufferParseException(node, "Boolean", message);
 }
 function throwBufferParseException(node, expectedNodeType, message) {
-    throw new NonRetryableError("bufferParsingException", message, DriverErrorType.incorrectServerResponse, {
+    throw new NonRetryableError(`Buffer parsing exception: ${message}`, DriverErrorType.incorrectServerResponse, {
         nodeType: getNodeType(node),
         expectedNodeType,
         driverVersion,