@fluidframework/odsp-driver 1.2.2 → 2.0.0-internal.1.0.0.82159

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;AACnE,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,GAGd,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;AAc9D,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;YACvB,sDAAsD;YACtD,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;YACjB,gDAAgD;YAChD,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,MAAM,MAAM,GAAG,QAAQ,EAAE,CAAC;QAC1B,MAAM,SAAS,GAAG,GAAG,KAAK,EAAE,CAAC;QAE7B,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,QAAQ,CAAC,WAAW,CAAC,EAAE;YACjC,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;YACpB,yCAAyC;YACzC,iCAAiC,SAAS,EAAE,EAAE,eAAe,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;SACtG;aAAM;YACH,mGAAmG;YACnG,mGAAmG;YACnG,MAAM,IAAI,cAAc;YACpB,6CAA6C;YAC7C,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;QACjB,yDAAyD;QACzD,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;IACI,GAAG,EACH;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,gBAA+B,EAC/B,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,GACP,gBAAgB,EACrB,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;gBACvB,yDAAyD;gBACzD,+CAA+C,EAC/C,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,mDAAmD,YAAY,EAAE,EACjE,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;AAED,iGAAiG;AACjG,uFAAuF;AACvF,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,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 { 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    IOdspUrlParts,\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 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                // pre-0.58 error message: No response from fetch call\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                // pre-0.58 error message prefix: odspFetchError\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        const online = isOnline();\n        const errorText = `${error}`;\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.includes(\"ETIMEDOUT\")) {\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                // pre-0.58 error message prefix: Offline\n                `ODSP fetch failure (Offline): ${errorText}`, DriverErrorType.offlineError, { driverVersion });\n        } else {\n            // It is perhaps still possible that this is due to being offline, the error does not reveal enough\n            // information to conclude.  Could also be DNS errors, malformed fetch request, CSP violation, etc.\n            throw new RetryableError(\n                // pre-0.58 error message prefix: Fetch error\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            // pre-0.58 error message: errorWhileParsingFetchResponse\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        {\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    resolvedUrlParts: IOdspUrlParts,\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                ...resolvedUrlParts,\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                        // pre-0.58 error message: Token is null for ${name} call\n                        `The Host-provided token fetcher 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 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\n// 80KB is the max body size that we can put in ump post body for server to be able to accept it.\n// Keeping it 78KB to be a little cautious. As per the telemetry 99p is less than 78KB.\nexport const maxUmpPostBodySize = 79872;\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;AACnE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAC7G,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,oCAAoC,GACvC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAGH,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAKhB,WAAW,GAGd,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;AAc9D,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;YACvB,sDAAsD;YACtD,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;YACjB,gDAAgD;YAChD,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,MAAM,MAAM,GAAG,QAAQ,EAAE,CAAC;QAC1B,MAAM,SAAS,GAAG,GAAG,KAAK,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAC7C,MAAM,iBAAiB,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACtE,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,QAAQ,CAAC,WAAW,CAAC,EAAE;YACjC,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;YACpB,yCAAyC;YACzC,iCAAiC,iBAAiB,EAAE,EACpD,eAAe,CAAC,YAAY,EAC5B;gBACI,aAAa;gBACb,eAAe,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,gBAAgB,CAAC,QAAQ,EAAE;aACxE,CAAC,CAAC;SACV;aAAM;YACH,mGAAmG;YACnG,mGAAmG;YACnG,MAAM,IAAI,cAAc;YACpB,6CAA6C;YAC7C,uBAAuB,iBAAiB,EAAE,EAC1C,eAAe,CAAC,YAAY,EAC5B;gBACI,aAAa;gBACb,eAAe,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,gBAAgB,CAAC,QAAQ,EAAE;aACxE,CAAC,CAAC;SACV;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;QACjB,yDAAyD;QACzD,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;IACI,GAAG,EACH;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,gBAA+B,EAC/B,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,GACP,gBAAgB,EACrB,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;gBACvB,yDAAyD;gBACzD,+CAA+C,EAC/C,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,mDAAmD,YAAY,EAAE,EACjE,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;AAED,iGAAiG;AACjG,uFAAuF;AACvF,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,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 { ChildLogger, PerformanceEvent, TelemetryDataTag, 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    IOdspUrlParts,\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 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                // pre-0.58 error message: No response from fetch call\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                // pre-0.58 error message prefix: odspFetchError\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        const online = isOnline();\n        const errorText = `${error}`;\n        const urlRegex = /((http|https):\\/\\/(\\S*))/i;\n        const redactedErrorText = errorText.replace(urlRegex, \"REDACTED_URL\");\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.includes(\"ETIMEDOUT\")) {\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                // pre-0.58 error message prefix: Offline\n                `ODSP fetch failure (Offline): ${redactedErrorText}`,\n                DriverErrorType.offlineError,\n                {\n                    driverVersion,\n                    rawErrorMessage: { value: errorText, tag: TelemetryDataTag.UserData },\n                });\n        } else {\n            // It is perhaps still possible that this is due to being offline, the error does not reveal enough\n            // information to conclude.  Could also be DNS errors, malformed fetch request, CSP violation, etc.\n            throw new RetryableError(\n                // pre-0.58 error message prefix: Fetch error\n                `ODSP fetch failure: ${redactedErrorText}`,\n                DriverErrorType.fetchFailure,\n                {\n                    driverVersion,\n                    rawErrorMessage: { value: errorText, tag: TelemetryDataTag.UserData },\n                });\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            // pre-0.58 error message: errorWhileParsingFetchResponse\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        {\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    resolvedUrlParts: IOdspUrlParts,\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                ...resolvedUrlParts,\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                        // pre-0.58 error message: Token is null for ${name} call\n                        `The Host-provided token fetcher 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 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\n// 80KB is the max body size that we can put in ump post body for server to be able to accept it.\n// Keeping it 78KB to be a little cautious. As per the telemetry 99p is less than 78KB.\nexport const maxUmpPostBodySize = 79872;\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 = "1.2.2";
+export declare const pkgVersion = "2.0.0-internal.1.0.0.82159";
 //# 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,UAAU,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,+BAA+B,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 = "1.2.2";
+export const pkgVersion = "2.0.0-internal.1.0.0.82159";
 //# 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,OAAO,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 = \"1.2.2\";\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,4BAA4B,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 = \"2.0.0-internal.1.0.0.82159\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "1.2.2",
+  "version": "2.0.0-internal.1.0.0.82159",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,16 +62,16 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/core-interfaces": "^1.2.2",
-    "@fluidframework/driver-base": "^1.2.2",
-    "@fluidframework/driver-definitions": "^1.2.2",
-    "@fluidframework/driver-utils": "^1.2.2",
-    "@fluidframework/gitresources": "^0.1036.5000",
-    "@fluidframework/odsp-doclib-utils": "^1.2.2",
-    "@fluidframework/odsp-driver-definitions": "^1.2.2",
-    "@fluidframework/protocol-base": "^0.1036.5000",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/telemetry-utils": "^1.2.2",
+    "@fluidframework/core-interfaces": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/driver-base": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/driver-definitions": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/driver-utils": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/gitresources": "^0.1037.1000-0",
+    "@fluidframework/odsp-doclib-utils": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/odsp-driver-definitions": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/protocol-base": "^0.1037.1000-0",
+    "@fluidframework/protocol-definitions": "^0.1029.1000-0",
+    "@fluidframework/telemetry-utils": "2.0.0-internal.1.0.0.82159",
     "abort-controller": "^3.0.0",
     "node-fetch": "^2.6.1",
     "socket.io-client": "^4.4.1",
@@ -79,10 +79,10 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.2.74327",
+    "@fluidframework/build-tools": "^0.3.0-0",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^1.2.2",
-    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@1.2.1",
+    "@fluidframework/mocha-test-setup": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@^1.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -100,7 +100,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.2.2",
+    "version": "2.0.0",
     "broken": {}
   }
 }

package/src/epochTracker.ts

@@ -6,7 +6,12 @@
 import { v4 as uuid } from "uuid";
 import { assert, Deferred } from "@fluidframework/common-utils";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { ThrottlingError, RateLimiter, NonRetryableError } from "@fluidframework/driver-utils";
+import {
+    ThrottlingError,
+    RateLimiter,
+    NonRetryableError,
+    LocationRedirectionError,
+} from "@fluidframework/driver-utils";
 import { IConnected } from "@fluidframework/protocol-definitions";
 import {
     snapshotKey,
@@ -15,9 +20,16 @@ import {
     IFileEntry,
     IPersistedCache,
     IOdspError,
+    IOdspErrorAugmentations,
+    IOdspResolvedUrl,
 } from "@fluidframework/odsp-driver-definitions";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
-import { PerformanceEvent, isFluidError, normalizeError } from "@fluidframework/telemetry-utils";
+import {
+    PerformanceEvent,
+    isFluidError,
+    normalizeError,
+    loggerToMonitoringContext,
+} from "@fluidframework/telemetry-utils";
 import { fetchAndParseAsJSONHelper, fetchArray, fetchHelper, getOdspResolvedUrl, IOdspResponse } from "./odspUtils";
 import {
     IOdspCache,
@@ -27,6 +39,7 @@ import {
 import { IVersionedValueWithEpoch, persistedCacheValueVersion } from "./contracts";
 import { ClpCompliantAppHeader } from "./contractsPublic";
 import { pkgVersion as driverVersion } from "./packageVersion";
+import { patchOdspResolvedUrl } from "./odspLocationRedirection";
 
 export type FetchType = "blob" | "createBlob" | "createFile" | "joinSession" | "ops" | "test" | "snapshotTree" |
     "treesLatest" | "uploadSummary" | "push" | "versions";
@@ -47,6 +60,7 @@ export const defaultCacheExpiryTimeoutMs: number = 2 * 24 * 60 * 60 * 1000;
 export class EpochTracker implements IPersistedFileCache {
     private _fluidEpoch: string | undefined;
 
+    private readonly snapshotCacheExpiryTimeoutMs: number;
     public readonly rateLimiter: RateLimiter;
     private readonly driverId = uuid();
     // This tracks the request number made by the driver instance.
@@ -59,6 +73,12 @@ export class EpochTracker implements IPersistedFileCache {
     ) {
         // Limits the max number of concurrent requests to 24.
         this.rateLimiter = new RateLimiter(24);
+
+        // We need this for GC testing until we properly plumb through the snapshot expiration policy (see PR #11168)
+        this.snapshotCacheExpiryTimeoutMs =
+            loggerToMonitoringContext(logger).config.getBoolean("Fluid.Driver.Odsp.TestOverride.DisableSnapshotCache")
+                ? 0
+                : defaultCacheExpiryTimeoutMs;
     }
 
     // public for UT purposes only!
@@ -95,17 +115,17 @@ export class EpochTracker implements IPersistedFileCache {
             } else if (this._fluidEpoch !== value.fluidEpoch) {
                 return undefined;
             }
-            // Expire the cached snapshot if it's older than the defaultCacheExpiryTimeoutMs and immediately
+            // Expire the cached snapshot if it's older than snapshotCacheExpiryTimeoutMs and immediately
             // expire all old caches that do not have cacheEntryTime
             if (entry.type === snapshotKey) {
                 const cacheTime = value.value?.cacheEntryTime;
                 const currentTime = Date.now();
-                if (cacheTime === undefined || currentTime - cacheTime >= defaultCacheExpiryTimeoutMs) {
+                if (cacheTime === undefined || currentTime - cacheTime >= this.snapshotCacheExpiryTimeoutMs) {
                     this.logger.sendTelemetryEvent(
                         {
                             eventName: "odspVersionsCacheExpired",
                             duration: currentTime - cacheTime,
-                            maxCacheAgeMs: defaultCacheExpiryTimeoutMs,
+                            maxCacheAgeMs: this.snapshotCacheExpiryTimeoutMs,
                         });
                     await this.removeEntries();
                     return undefined;
@@ -121,8 +141,8 @@ export class EpochTracker implements IPersistedFileCache {
 
     public async put(entry: IEntry, value: any) {
         assert(this._fluidEpoch !== undefined, 0x1dd /* "no epoch" */);
-        // For snapshots, the value should have the cacheEntryTime. This will be used to expire snapshots older
-        // than the defaultCacheExpiryTimeoutMs.
+        // For snapshots, the value should have the cacheEntryTime.
+        // This will be used to expire snapshots older than snapshotCacheExpiryTimeoutMs.
         if (entry.type === snapshotKey) {
             value.cacheEntryTime = value.cacheEntryTime ?? Date.now();
         }
@@ -224,6 +244,26 @@ export class EpochTracker implements IPersistedFileCache {
             }
             await this.checkForEpochError(error, epochFromResponse, fetchType);
             throw error;
+        }).catch((error) => {
+            // If the error is about location redirection, then we need to generate new resolved url with correct
+            // location info.
+            if (isFluidError(error) && error.errorType === DriverErrorType.fileNotFoundOrAccessDeniedError) {
+                const redirectLocation = (error as IOdspErrorAugmentations).redirectLocation;
+                if (redirectLocation !== undefined) {
+                    const redirectUrl: IOdspResolvedUrl = patchOdspResolvedUrl(
+                        this.fileEntry.resolvedUrl,
+                        redirectLocation,
+                    );
+                    const locationRedirectionError = new LocationRedirectionError(
+                        error.message,
+                        redirectUrl,
+                        { driverVersion, redirectLocation },
+                    );
+                    locationRedirectionError.addTelemetryProperties(error.getTelemetryProperties());
+                    throw locationRedirectionError;
+                }
+            }
+            throw error;
         }).catch((error) => {
             const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId } });
             throw fluidError;

package/src/fetchSnapshot.ts

@@ -16,7 +16,7 @@ import {
     InstrumentedStorageTokenFetcher,
 } from "@fluidframework/odsp-driver-definitions";
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
-import { isRuntimeMessage, NonRetryableError } from "@fluidframework/driver-utils";
+import { DriverErrorTelemetryProps, isRuntimeMessage, NonRetryableError } from "@fluidframework/driver-utils";
 import { IOdspSnapshot, ISnapshotCachedEntry, IVersionedValueWithEpoch, persistedCacheValueVersion } from "./contracts";
 import { getQueryString } from "./getQueryString";
 import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth";
@@ -234,19 +234,30 @@ async function fetchLatestSnapshotCore(
                     snapshotOptions,
                     controller,
                 );
+
                 const odspResponse = response.odspResponse;
                 const contentType = odspResponse.headers.get("content-type");
-                odspResponse.propsToLog = {
+
+                // Measure how much time we spend processing payload
+                const snapshotParseEvent = PerformanceEvent.start(logger, {
+                    eventName: "SnapshotParse",
+                    driverVersion: pkgVersion,
+                    contentType,
+                });
+
+                const propsToLog: DriverErrorTelemetryProps = {
                     ...odspResponse.propsToLog,
                     contentType,
                     accept: response.requestHeaders.accept,
+                    driverVersion: pkgVersion,
                 };
                 let parsedSnapshotContents: IOdspResponse<ISnapshotContents> | undefined;
+
                 try {
                     switch (contentType) {
                         case "application/json": {
                             const text = await odspResponse.content.text();
-                            odspResponse.propsToLog.bodySize = text.length;
+                            propsToLog.bodySize = text.length;
                             const content: IOdspSnapshot = JSON.parse(text);
                             validateBlobsAndTrees(content);
                             const snapshotContents: ISnapshotContents =
@@ -256,7 +267,7 @@ async function fetchLatestSnapshotCore(
                         }
                         case "application/ms-fluid": {
                             const content = await odspResponse.content.arrayBuffer();
-                            odspResponse.propsToLog.bodySize = content.byteLength;
+                            propsToLog.bodySize = content.byteLength;
                             const snapshotContents: ISnapshotContents = parseCompactSnapshotResponse(
                                 new ReadBuffer(new Uint8Array(content)));
                             if (snapshotContents.snapshotTree.trees === undefined ||
@@ -264,7 +275,7 @@ async function fetchLatestSnapshotCore(
                                     throw new NonRetryableError(
                                         "Returned odsp snapshot is malformed. No trees or blobs!",
                                         DriverErrorType.incorrectServerResponse,
-                                        { driverVersion: pkgVersion, ...odspResponse.propsToLog },
+                                        propsToLog,
                                     );
                                 }
                             parsedSnapshotContents = { ...odspResponse, content: snapshotContents };
@@ -274,12 +285,12 @@ async function fetchLatestSnapshotCore(
                             throw new NonRetryableError(
                                 "Unknown snapshot content type",
                                 DriverErrorType.incorrectServerResponse,
-                                { driverVersion: pkgVersion, ...odspResponse.propsToLog },
+                                propsToLog,
                             );
                     }
                 } catch (error) {
                     if (isFluidError(error)) {
-                        error.addTelemetryProperties({ driverVersion: pkgVersion, ...odspResponse.propsToLog });
+                        error.addTelemetryProperties(propsToLog);
                         throw error;
                     }
                     const enhancedError = wrapError(
@@ -287,11 +298,14 @@ async function fetchLatestSnapshotCore(
                         (errorMessage) => new NonRetryableError(
                             `Error parsing snapshot response: ${errorMessage}`,
                             DriverErrorType.genericError,
-                            { driverVersion: pkgVersion, ...odspResponse.propsToLog }));
+                            propsToLog));
                     throw enhancedError;
                 }
+
                 assert(parsedSnapshotContents !== undefined, 0x312 /* snapshot should be parsed */);
                 const snapshot = parsedSnapshotContents.content;
+                const { trees, numBlobs, encodedBlobsSize } = evalBlobsAndTrees(snapshot);
+
                 // From: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
                 // fetchStart: immediately before the browser starts to fetch the resource.
                 // requestStart: immediately before the browser starts requesting the resource from the server
@@ -344,9 +358,6 @@ async function fetchLatestSnapshotCore(
                     }
                 }
 
-                const { numTrees, numBlobs, encodedBlobsSize } =
-                    evalBlobsAndTrees(parsedSnapshotContents.content);
-
                 // There are some scenarios in ODSP where we cannot cache, trees/latest will explicitly tell us when we
                 // cannot cache using an HTTP response header.
                 const canCache =
@@ -375,8 +386,11 @@ async function fetchLatestSnapshotCore(
                     // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     putInCache(valueWithEpoch);
                 }
+
+                snapshotParseEvent.end();
+
                 event.end({
-                    trees: numTrees,
+                    trees,
                     blobs: snapshot.blobs?.size ?? 0,
                     leafNodes: numBlobs,
                     encodedBlobsSize,
@@ -406,7 +420,7 @@ async function fetchLatestSnapshotCore(
                     // Azure Fluid Relay service is the redeem status (S means success), and FRP is a flag to indicate
                     // if the permission has changed.
                     sltelemetry: odspResponse.headers.get("x-fluid-sltelemetry"),
-                    ...odspResponse.propsToLog,
+                    ...propsToLog,
                 });
                 return snapshot;
             },
@@ -466,13 +480,13 @@ function getFormBodyAndHeaders(
 }
 
 function evalBlobsAndTrees(snapshot: ISnapshotContents) {
-    const numTrees = countTreesInSnapshotTree(snapshot.snapshotTree);
+    const trees = countTreesInSnapshotTree(snapshot.snapshotTree);
     const numBlobs = snapshot.blobs.size;
     let encodedBlobsSize = 0;
     for (const [_, blobContent] of snapshot.blobs) {
         encodedBlobsSize += blobContent.byteLength;
     }
-    return { numTrees, numBlobs, encodedBlobsSize };
+    return { trees, numBlobs, encodedBlobsSize };
 }
 
 export function validateBlobsAndTrees(snapshot: IOdspSnapshot) {

package/src/getFileLink.ts

@@ -4,8 +4,8 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { assert, delay } from "@fluidframework/common-utils";
-import { canRetryOnError, getRetryDelayFromError, NonRetryableError } from "@fluidframework/driver-utils";
+import { assert } from "@fluidframework/common-utils";
+import { canRetryOnError, NonRetryableError } from "@fluidframework/driver-utils";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
 import {
@@ -17,6 +17,7 @@ import {
 import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth";
 import { fetchHelper, getWithRetryForTokenRefresh, toInstrumentedOdspTokenFetcher } from "./odspUtils";
 import { pkgVersion as driverVersion } from "./packageVersion";
+import { runWithRetry } from "./retryUtils";
 
 // Store cached responses for the lifetime of web session as file link remains the same for given file item
 const fileLinkCache = new Map<string, Promise<string>>();
@@ -47,33 +48,29 @@ export async function getFileLink(
         return maybeFileLinkCacheEntry;
     }
 
-    const valueGenerator = async function() {
-        let result: string | undefined;
-        let success = false;
-        let retryAfterMs = 1000;
-        do {
-            try {
-                result = await getFileLinkCore(getToken, odspUrlParts, identityType, logger);
-                success = true;
-            } catch (err) {
-                // If it is not retriable, then just throw
-                if (!canRetryOnError(err)) {
-                    // Delete from the cache to permit retrying later.
-                    fileLinkCache.delete(cacheKey);
-                    throw err;
-                }
-                // If the error is throttling error, then wait for the specified time before retrying.
-                // If the waitTime is not specified, then we start with retrying immediately to max of 8s.
-                retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);
-                await delay(retryAfterMs);
+    const fileLinkGenerator = async function() {
+        let fileLinkCore: string;
+        try {
+            fileLinkCore = await runWithRetry(
+                async () => getFileLinkCore(getToken, odspUrlParts, identityType, logger),
+                "getFileLinkCore",
+                logger,
+            );
+        } catch (err) {
+            // runWithRetry throws a non retriable error after it hits the max # of attempts
+            // or encounters an unexpected error type
+            if (!canRetryOnError(err)) {
+                // Delete from the cache to permit retrying later.
+                fileLinkCache.delete(cacheKey);
             }
-        } while (!success);
+            throw err;
+        }
 
         // We are guaranteed to run the getFileLinkCore at least once with successful result (which must be a string)
-        assert(result !== undefined, 0x292 /* "Unexpected undefined result from getFileLinkCore" */);
-        return result;
+        assert(fileLinkCore !== undefined, 0x292 /* "Unexpected undefined result from getFileLinkCore" */);
+        return fileLinkCore;
     };
-    const fileLink = valueGenerator();
+    const fileLink = fileLinkGenerator();
     fileLinkCache.set(cacheKey, fileLink);
     return fileLink;
 }

package/src/odspDeltaStorageService.ts

@@ -35,13 +35,14 @@ export class OdspDeltaStorageService {
      * @param from - inclusive
      * @param to - exclusive
      * @param telemetryProps - properties to add when issuing telemetry events
+     * @param scenarioName - reason for fetching ops
      * @returns ops retrieved & info if result was partial (i.e. more is available)
      */
      public async get(
         from: number,
         to: number,
         telemetryProps: ITelemetryProperties,
-        fetchReason?: string,
+        scenarioName?: string,
     ): Promise<IDeltasFetchResult> {
         return getWithRetryForTokenRefresh(async (options) => {
             // Note - this call ends up in getSocketStorageDiscovery() and can refresh token
@@ -78,7 +79,7 @@ export class OdspDeltaStorageService {
                 },
                 "ops",
                 true,
-                fetchReason,
+                scenarioName,
             );
             clearTimeout(timer);
             const deltaStorageResponse = response.content;
@@ -99,6 +100,7 @@ export class OdspDeltaStorageService {
                 from,
                 to,
                 ...telemetryProps,
+                reason: scenarioName,
             });
 
             // It is assumed that server always returns all the ops that it has in the range that was requested.

package/src/odspDocumentService.ts

@@ -4,7 +4,7 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { performance } from "@fluidframework/common-utils";
+import { assert, performance } from "@fluidframework/common-utils";
 import {
     ChildLogger,
     IFluidErrorBase,
@@ -21,12 +21,7 @@ import {
     IDocumentServicePolicies,
     DriverErrorType,
 } from "@fluidframework/driver-definitions";
-import {
-    canRetryOnError,
-    DeltaStreamConnectionForbiddenError,
-    NonRetryableError,
-} from "@fluidframework/driver-utils";
-import { IFacetCodes } from "@fluidframework/odsp-doclib-utils";
+import { canRetryOnError, DeltaStreamConnectionForbiddenError, NonRetryableError } from "@fluidframework/driver-utils";
 import {
     IClient,
     ISequencedDocumentMessage,
@@ -39,6 +34,7 @@ import {
     InstrumentedStorageTokenFetcher,
     OdspErrorType,
 } from "@fluidframework/odsp-driver-definitions";
+import { hasFacetCodes } from "@fluidframework/odsp-doclib-utils";
 import type { io as SocketIOClientStatic } from "socket.io-client";
 import { HostStoragePolicyInternal, ISocketStorageDiscovery } from "./contracts";
 import { IOdspCache } from "./odspCache";
@@ -113,6 +109,8 @@ export class OdspDocumentService implements IDocumentService {
 
     private currentConnection?: OdspDocumentDeltaConnection;
 
+    private relayServiceTenantAndSessionId: string | undefined;
+
     /**
      * @param odspResolvedUrl - resolved url identifying document that will be managed by this service instance.
      * @param getStorageToken - function that can provide the storage token. This is is also referred to as
@@ -189,6 +187,11 @@ export class OdspDocumentService implements IDocumentService {
                     }
                     throw new Error("Disconnected while uploading summary (attempt to perform flush())");
                 },
+                () => {
+                    assert(this.relayServiceTenantAndSessionId !== undefined,
+                        "relayServiceTenantAndSessionId should be present");
+                    return this.relayServiceTenantAndSessionId;
+                },
                 this.mc.config.getNumber("Fluid.Driver.Odsp.snapshotFormatFetchType"),
             );
         }
@@ -271,7 +274,7 @@ export class OdspDocumentService implements IDocumentService {
                     this.socketIoClientFactory().catch(annotateAndRethrowConnectionError("socketIoClientFactory")),
                 ]);
 
-            const finalWebsocketToken = websocketToken ?? (websocketEndpoint.socketToken || null);
+            const finalWebsocketToken = websocketToken ?? (websocketEndpoint.socketToken ?? null);
             if (finalWebsocketToken === null) {
                 throw this.annotateConnectionError(
                     new NonRetryableError(
@@ -344,10 +347,9 @@ export class OdspDocumentService implements IDocumentService {
         requestSocketToken: boolean,
         options: TokenFetchOptionsEx,
     ) {
-        return this.joinSessionCore(requestSocketToken, options).catch((e) => {
-            const likelyFacetCodes = e as IFacetCodes;
-            if (Array.isArray(likelyFacetCodes.facetCodes)) {
-                for (const code of likelyFacetCodes.facetCodes) {
+        const response = await this.joinSessionCore(requestSocketToken, options).catch((e) => {
+            if (hasFacetCodes(e) && e.facetCodes !== undefined) {
+                for (const code of e.facetCodes) {
                     switch (code) {
                         case "sessionForbiddenOnPreservedFiles":
                         case "sessionForbiddenOnModerationEnabledLibrary":
@@ -364,6 +366,8 @@ export class OdspDocumentService implements IDocumentService {
             }
             throw e;
         });
+        this.relayServiceTenantAndSessionId = `${response.tenantId}/${response.id}`;
+        return response;
     }
 
     private async joinSessionCore(