@fluidframework/odsp-driver 1.0.1 → 1.1.0

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,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;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;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,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,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,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;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 { 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    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 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                // 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        { 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 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\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,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"]}

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.0.1";
+export declare const pkgVersion = "1.1.0";
 //# sourceMappingURL=packageVersion.d.ts.map

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.0.1";
+export const pkgVersion = "1.1.0";
 //# 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.0.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,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.1.0\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,27 +62,27 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/core-interfaces": "^1.0.1",
-    "@fluidframework/driver-base": "^1.0.1",
-    "@fluidframework/driver-definitions": "^1.0.1",
-    "@fluidframework/driver-utils": "^1.0.1",
-    "@fluidframework/gitresources": "^0.1036.4000",
-    "@fluidframework/odsp-doclib-utils": "^1.0.1",
-    "@fluidframework/odsp-driver-definitions": "^1.0.1",
-    "@fluidframework/protocol-base": "^0.1036.4000",
+    "@fluidframework/core-interfaces": "^1.1.0",
+    "@fluidframework/driver-base": "^1.1.0",
+    "@fluidframework/driver-definitions": "^1.1.0",
+    "@fluidframework/driver-utils": "^1.1.0",
+    "@fluidframework/gitresources": "^0.1036.5000",
+    "@fluidframework/odsp-doclib-utils": "^1.1.0",
+    "@fluidframework/odsp-driver-definitions": "^1.1.0",
+    "@fluidframework/protocol-base": "^0.1036.5000",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/telemetry-utils": "^1.0.1",
+    "@fluidframework/telemetry-utils": "^1.1.0",
     "abort-controller": "^3.0.0",
     "node-fetch": "^2.6.1",
     "socket.io-client": "^4.4.1",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.71273",
+    "@fluidframework/build-common": "^0.24.0",
+    "@fluidframework/build-tools": "^0.2.74327",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^1.0.1",
-    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@^0.59.0",
+    "@fluidframework/mocha-test-setup": "^1.1.0",
+    "@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.0.0",
+    "version": "1.1.0",
     "broken": {}
   }
 }

package/src/compactSnapshotParser.ts

@@ -5,7 +5,7 @@
 
 import { assert } from "@fluidframework/common-utils";
 import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
-import { ISnapshotContents } from "./odspUtils";
+import { ISnapshotContents } from "./odspPublicUtils";
 import { ReadBuffer } from "./ReadBufferUtils";
 import { ISnapshotTreeEx } from "./contracts";
 import {
@@ -127,19 +127,25 @@ export function parseCompactSnapshotResponse(buffer: ReadBuffer): ISnapshotConte
     const root = builder.getNode(0);
 
     const records = getAndValidateNodeProps(root,
-        ["mrv", "cv", "snapshot", "blobs", "deltas"], false);
+        ["mrv", "cv", "lsn", "snapshot", "blobs", "deltas"], false);
 
     assertBlobCoreInstance(records.mrv, "minReadVersion should be of BlobCore type");
     assertBlobCoreInstance(records.cv, "createVersion should be of BlobCore type");
-    assert(snapshotMinReadVersion >= records.mrv.toString(),
+    if (records.lsn !== undefined) {
+        assertNumberInstance(records.lsn, "lsn should be a number");
+    }
+
+    assert(parseFloat(snapshotMinReadVersion) >= parseFloat(records.mrv.toString()),
         0x20f /* "Driver min read version should >= to server minReadVersion" */);
-    assert(records.cv.toString() >= snapshotMinReadVersion,
+    assert(parseFloat(records.cv.toString()) >= parseFloat(snapshotMinReadVersion),
         0x210 /* "Snapshot should be created with minReadVersion or above" */);
     assert(currentReadVersion === records.cv.toString(),
         0x2c2 /* "Create Version should be equal to currentReadVersion" */);
+
     return {
         ...readSnapshotSection(records.snapshot),
         blobs: readBlobSection(records.blobs),
         ops: records.deltas !== undefined ? readOpsSection(records.deltas) : [],
+        latestSequenceNumber: records.lsn,
     };
 }

package/src/compactSnapshotWriter.ts

@@ -6,7 +6,7 @@
 import { assert, stringToBuffer } from "@fluidframework/common-utils";
 import { IBlob, ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
 import { snapshotMinReadVersion } from "./compactSnapshotParser";
-import { ISnapshotContents } from "./odspUtils";
+import { ISnapshotContents } from "./odspPublicUtils";
 import { ReadBuffer } from "./ReadBufferUtils";
 import { TreeBuilderSerializer } from "./WriteBufferUtils";
 import { addBoolProperty, addNumberProperty, addStringProperty, NodeCore } from "./zipItDataRepresentationUtils";
@@ -131,8 +131,11 @@ export function convertToCompactSnapshot(snapshotContents: ISnapshotContents): R
     // Create the root node.
     const rootNode = builder.addNode();
     assert(snapshotContents.sequenceNumber !== undefined, 0x21c /* "Seq number should be provided" */);
-    const ops = snapshotContents.ops;
-    const latestSequenceNumber = ops.length > 0 ? ops[ops.length - 1].sequenceNumber : snapshotContents.sequenceNumber;
+
+    const latestSequenceNumber = snapshotContents.latestSequenceNumber ??
+        snapshotContents.ops.length > 0 ?
+        snapshotContents.ops[snapshotContents.ops.length - 1].sequenceNumber : snapshotContents.sequenceNumber;
+
     writeSnapshotProps(rootNode, latestSequenceNumber);
 
     writeSnapshotSection(
@@ -145,7 +148,7 @@ export function convertToCompactSnapshot(snapshotContents: ISnapshotContents): R
     writeBlobsSection(rootNode, snapshotContents.blobs);
 
     // Then write the ops node.
-    writeOpsSection(rootNode, ops);
+    writeOpsSection(rootNode, snapshotContents.ops);
 
     return builder.serialize();
 }

package/src/contracts.ts

@@ -5,7 +5,7 @@
 
 import * as api from "@fluidframework/protocol-definitions";
 import { HostStoragePolicy } from "@fluidframework/odsp-driver-definitions";
-import { ISnapshotContents } from "./odspUtils";
+import { ISnapshotContents } from "./odspPublicUtils";
 
 /** https://portal.microsofticm.com/imp/v3/incidents/details/308931013/home
  * The commits property was removed from protocol-definitions but in order to support back compat, we will

package/src/createFile.ts

@@ -30,9 +30,9 @@ import {
     getWithRetryForTokenRefresh,
     INewFileInfo,
     getOrigin,
-    ISnapshotContents,
     maxUmpPostBodySize,
 } from "./odspUtils";
+import { ISnapshotContents } from "./odspPublicUtils";
 import { createOdspUrl } from "./createOdspUrl";
 import { getApiRoot } from "./odspUrlHelper";
 import { EpochTracker } from "./epochTracker";
@@ -91,7 +91,7 @@ export async function createNewFluidFile(
         sharingLinkErrorReason = content.sharingLinkErrorReason;
     }
 
-    const odspUrl = createOdspUrl({ ... newFileInfo, itemId, dataStorePath: "/" });
+    const odspUrl = createOdspUrl({ ...newFileInfo, itemId, dataStorePath: "/" });
     const resolver = new OdspDriverUrlResolver();
     const odspResolvedUrl = await resolver.resolve({
         url: odspUrl,

package/src/createNewUtils.ts

@@ -7,7 +7,7 @@ import { v4 as uuid } from "uuid";
 import { ISummaryTree, SummaryType } from "@fluidframework/protocol-definitions";
 import { getDocAttributesFromProtocolSummary } from "@fluidframework/driver-utils";
 import { stringToBuffer, unreachableCase } from "@fluidframework/common-utils";
-import { ISnapshotContents } from "./odspUtils";
+import { ISnapshotContents } from "./odspPublicUtils";
 import { ISnapshotTreeEx } from "./contracts";
 
 /**
@@ -25,6 +25,7 @@ export function convertCreateNewSummaryTreeToTreeAndBlobs(summary: ISummaryTree,
         blobs,
         ops: [],
         sequenceNumber,
+        latestSequenceNumber: sequenceNumber,
     };
 
     return snapshotTreeValue;

package/src/fetchSnapshot.ts

@@ -8,7 +8,7 @@ import { v4 as uuid } from "uuid";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { assert, fromUtf8ToBase64, performance } from "@fluidframework/common-utils";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
-import { PerformanceEvent } from "@fluidframework/telemetry-utils";
+import { isFluidError, PerformanceEvent, wrapError } from "@fluidframework/telemetry-utils";
 import {
     IOdspResolvedUrl,
     ISnapshotOptions,
@@ -16,7 +16,7 @@ import {
     InstrumentedStorageTokenFetcher,
 } from "@fluidframework/odsp-driver-definitions";
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
-import { isRuntimeMessage } from "@fluidframework/driver-utils";
+import { isRuntimeMessage, NonRetryableError } from "@fluidframework/driver-utils";
 import { IOdspSnapshot, ISnapshotCachedEntry, IVersionedValueWithEpoch, persistedCacheValueVersion } from "./contracts";
 import { getQueryString } from "./getQueryString";
 import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth";
@@ -26,12 +26,13 @@ import {
     getWithRetryForTokenRefresh,
     getWithRetryForTokenRefreshRepeat,
     IOdspResponse,
-    ISnapshotContents,
 } from "./odspUtils";
-import { convertOdspSnapshotToSnapsohtTreeAndBlobs } from "./odspSnapshotParser";
+import { ISnapshotContents } from "./odspPublicUtils";
+import { convertOdspSnapshotToSnapshotTreeAndBlobs } from "./odspSnapshotParser";
 import { currentReadVersion, parseCompactSnapshotResponse } from "./compactSnapshotParser";
 import { ReadBuffer } from "./ReadBufferUtils";
 import { EpochTracker } from "./epochTracker";
+import { pkgVersion } from "./packageVersion";
 
 /**
  * Enum to support different types of snapshot formats.
@@ -83,7 +84,7 @@ export async function fetchSnapshot(
         },
         async () => snapshotDownloader(url, { headers }),
     ) as IOdspResponse<IOdspSnapshot>;
-    return convertOdspSnapshotToSnapsohtTreeAndBlobs(response.content);
+    return convertOdspSnapshotToSnapshotTreeAndBlobs(response.content);
 }
 
 export async function fetchSnapshotWithRedeem(
@@ -93,11 +94,11 @@ export async function fetchSnapshotWithRedeem(
     forceAccessTokenViaAuthorizationHeader: boolean,
     logger: ITelemetryLogger,
     snapshotDownloader: (
-            finalOdspResolvedUrl: IOdspResolvedUrl,
-            storageToken: string,
-            snapshotOptions: ISnapshotOptions | undefined,
-            controller?: AbortController,
-        ) => Promise<ISnapshotRequestAndResponseOptions>,
+        finalOdspResolvedUrl: IOdspResolvedUrl,
+        storageToken: string,
+        snapshotOptions: ISnapshotOptions | undefined,
+        controller?: AbortController,
+    ) => Promise<ISnapshotRequestAndResponseOptions>,
     putInCache: (valueWithEpoch: IVersionedValueWithEpoch) => Promise<void>,
     removeEntries: () => Promise<void>,
     enableRedeemFallback?: boolean,
@@ -126,12 +127,13 @@ export async function fetchSnapshotWithRedeem(
             await redeemSharingLink(
                 odspResolvedUrl, storageTokenFetcher, logger, forceAccessTokenViaAuthorizationHeader);
             const odspResolvedUrlWithoutShareLink: IOdspResolvedUrl =
-                { ...odspResolvedUrl,
-                    shareLinkInfo: {
-                        ...odspResolvedUrl.shareLinkInfo,
-                        sharingLinkToRedeem: undefined,
-                    },
-                };
+            {
+                ...odspResolvedUrl,
+                shareLinkInfo: {
+                    ...odspResolvedUrl.shareLinkInfo,
+                    sharingLinkToRedeem: undefined,
+                },
+            };
 
             return fetchLatestSnapshotCore(
                 odspResolvedUrlWithoutShareLink,
@@ -168,15 +170,15 @@ async function redeemSharingLink(
             eventName: "RedeemShareLink",
         },
         async () => getWithRetryForTokenRefresh(async (tokenFetchOptions) => {
-                assert(!!odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem,
-                    0x1ed /* "Share link should be present" */);
-                const storageToken = await storageTokenFetcher(tokenFetchOptions, "RedeemShareLink");
-                const encodedShareUrl = getEncodedShareUrl(odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem);
-                const redeemUrl = `${odspResolvedUrl.siteUrl}/_api/v2.0/shares/${encodedShareUrl}`;
-                const { url, headers } = getUrlAndHeadersWithAuth(
-                    redeemUrl, storageToken, forceAccessTokenViaAuthorizationHeader);
-                headers.prefer = "redeemSharingLink";
-                return fetchAndParseAsJSONHelper(url, { headers });
+            assert(!!odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem,
+                0x1ed /* "Share link should be present" */);
+            const storageToken = await storageTokenFetcher(tokenFetchOptions, "RedeemShareLink");
+            const encodedShareUrl = getEncodedShareUrl(odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem);
+            const redeemUrl = `${odspResolvedUrl.siteUrl}/_api/v2.0/shares/${encodedShareUrl}`;
+            const { url, headers } = getUrlAndHeadersWithAuth(
+                redeemUrl, storageToken, forceAccessTokenViaAuthorizationHeader);
+            headers.prefer = "redeemSharingLink";
+            return fetchAndParseAsJSONHelper(url, { headers });
         }),
     );
 }
@@ -187,11 +189,11 @@ async function fetchLatestSnapshotCore(
     snapshotOptions: ISnapshotOptions | undefined,
     logger: ITelemetryLogger,
     snapshotDownloader: (
-            finalOdspResolvedUrl: IOdspResolvedUrl,
-            storageToken: string,
-            snapshotOptions: ISnapshotOptions | undefined,
-            controller?: AbortController,
-        ) => Promise<ISnapshotRequestAndResponseOptions>,
+        finalOdspResolvedUrl: IOdspResolvedUrl,
+        storageToken: string,
+        snapshotOptions: ISnapshotOptions | undefined,
+        controller?: AbortController,
+    ) => Promise<ISnapshotRequestAndResponseOptions>,
     putInCache: (valueWithEpoch: IVersionedValueWithEpoch) => Promise<void>,
     enableRedeemFallback?: boolean,
 ): Promise<ISnapshotContents> {
@@ -232,7 +234,64 @@ async function fetchLatestSnapshotCore(
                     snapshotOptions,
                     controller,
                 );
-                const snapshot = response.odspSnapshotResponse.content;
+                const odspResponse = response.odspResponse;
+                const contentType = odspResponse.headers.get("content-type");
+                odspResponse.propsToLog = {
+                    ...odspResponse.propsToLog,
+                    contentType,
+                    accept: response.requestHeaders.accept,
+                };
+                let parsedSnapshotContents: IOdspResponse<ISnapshotContents> | undefined;
+                try {
+                    switch (contentType) {
+                        case "application/json": {
+                            const text = await odspResponse.content.text();
+                            odspResponse.propsToLog.bodySize = text.length;
+                            const content: IOdspSnapshot = JSON.parse(text);
+                            validateBlobsAndTrees(content);
+                            const snapshotContents: ISnapshotContents =
+                                convertOdspSnapshotToSnapshotTreeAndBlobs(content);
+                            parsedSnapshotContents = { ...odspResponse, content: snapshotContents };
+                            break;
+                        }
+                        case "application/ms-fluid": {
+                            const content = await odspResponse.content.arrayBuffer();
+                            odspResponse.propsToLog.bodySize = content.byteLength;
+                            const snapshotContents: ISnapshotContents = parseCompactSnapshotResponse(
+                                new ReadBuffer(new Uint8Array(content)));
+                            if (snapshotContents.snapshotTree.trees === undefined ||
+                                snapshotContents.snapshotTree.blobs === undefined) {
+                                    throw new NonRetryableError(
+                                        "Returned odsp snapshot is malformed. No trees or blobs!",
+                                        DriverErrorType.incorrectServerResponse,
+                                        { driverVersion: pkgVersion, ...odspResponse.propsToLog },
+                                    );
+                                }
+                            parsedSnapshotContents = { ...odspResponse, content: snapshotContents };
+                            break;
+                        }
+                        default:
+                            throw new NonRetryableError(
+                                "Unknown snapshot content type",
+                                DriverErrorType.incorrectServerResponse,
+                                { driverVersion: pkgVersion, ...odspResponse.propsToLog },
+                            );
+                    }
+                } catch (error) {
+                    if (isFluidError(error)) {
+                        error.addTelemetryProperties({ driverVersion: pkgVersion, ...odspResponse.propsToLog });
+                        throw error;
+                    }
+                    const enhancedError = wrapError(
+                        error,
+                        (errorMessage) => new NonRetryableError(
+                            `Error parsing snapshot response: ${errorMessage}`,
+                            DriverErrorType.genericError,
+                            { driverVersion: pkgVersion, ...odspResponse.propsToLog }));
+                    throw enhancedError;
+                }
+                assert(parsedSnapshotContents !== undefined, 0x312 /* snapshot should be parsed */);
+                const snapshot = parsedSnapshotContents.content;
                 // 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
@@ -254,7 +313,7 @@ async function fetchLatestSnapshotCore(
                 let fetchStartToResponseEndTime: number | undefined; // responseEnd  - fetchStart
                 let reqStartToResponseEndTime: number | undefined; // responseEnd - requestStart
                 let networkTime: number | undefined; // responseEnd - startTime
-                const spReqDuration = response.odspSnapshotResponse.headers.get("sprequestduration");
+                const spReqDuration = odspResponse.headers.get("sprequestduration");
 
                 // getEntriesByType is only available in browser performance object
                 const resources1 = performance.getEntriesByType?.("resource") ?? [];
@@ -286,12 +345,12 @@ async function fetchLatestSnapshotCore(
                 }
 
                 const { numTrees, numBlobs, encodedBlobsSize } =
-                    validateAndEvalBlobsAndTrees(response.odspSnapshotResponse.content);
+                    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 =
-                    response.odspSnapshotResponse.headers.get("disablebrowsercachingofusercontent") !== "true";
+                    odspResponse.headers.get("disablebrowsercachingofusercontent") !== "true";
                 const sequenceNumber: number = snapshot.sequenceNumber ?? 0;
                 const seqNumberFromOps = snapshot.ops && snapshot.ops.length > 0 ?
                     snapshot.ops[0].sequenceNumber - 1 :
@@ -302,7 +361,7 @@ async function fetchLatestSnapshotCore(
                     logger.sendErrorEvent({ eventName: "fetchSnapshotError", sequenceNumber, seqNumberFromOps });
                     snapshot.sequenceNumber = undefined;
                 } else if (canCache) {
-                    const fluidEpoch = response.odspSnapshotResponse.headers.get("x-fluid-epoch");
+                    const fluidEpoch = odspResponse.headers.get("x-fluid-epoch");
                     assert(fluidEpoch !== undefined, 0x1e6 /* "Epoch  should be present in response" */);
                     const value: ISnapshotCachedEntry = {
                         ...snapshot,
@@ -346,8 +405,8 @@ async function fetchLatestSnapshotCore(
                     // Azure Fluid Relay service; desc=S, FRP; desc=False. Here, FRL is the duration taken for redeem,
                     // Azure Fluid Relay service is the redeem status (S means success), and FRP is a flag to indicate
                     // if the permission has changed.
-                    sltelemetry: response.odspSnapshotResponse.headers.get("x-fluid-sltelemetry"),
-                    ...response.odspSnapshotResponse.propsToLog,
+                    sltelemetry: odspResponse.headers.get("x-fluid-sltelemetry"),
+                    ...odspResponse.propsToLog,
                 });
                 return snapshot;
             },
@@ -363,8 +422,8 @@ async function fetchLatestSnapshotCore(
     });
 }
 
-interface ISnapshotRequestAndResponseOptions {
-    odspSnapshotResponse: IOdspResponse<ISnapshotContents>;
+export interface ISnapshotRequestAndResponseOptions {
+    odspResponse: IOdspResponse<Response>;
     requestUrl: string;
     requestHeaders: { [index: string]: any; };
 }
@@ -406,11 +465,7 @@ function getFormBodyAndHeaders(
     return { body: postBody, headers: header };
 }
 
-function validateAndEvalBlobsAndTrees(snapshot: ISnapshotContents) {
-    assert(snapshot.snapshotTree !== undefined,
-        0x200 /* "Returned odsp snapshot is malformed. No trees!" */);
-    assert(snapshot.blobs !== undefined,
-        0x201 /* "Returned odsp snapshot is malformed. No blobs!" */);
+function evalBlobsAndTrees(snapshot: ISnapshotContents) {
     const numTrees = countTreesInSnapshotTree(snapshot.snapshotTree);
     const numBlobs = snapshot.blobs.size;
     let encodedBlobsSize = 0;
@@ -420,6 +475,13 @@ function validateAndEvalBlobsAndTrees(snapshot: ISnapshotContents) {
     return { numTrees, numBlobs, encodedBlobsSize };
 }
 
+export function validateBlobsAndTrees(snapshot: IOdspSnapshot) {
+    assert(snapshot.trees !== undefined,
+        0x200 /* "Returned odsp snapshot is malformed. No trees!" */);
+    assert(snapshot.blobs !== undefined,
+        0x201 /* "Returned odsp snapshot is malformed. No blobs!" */);
+}
+
 function countTreesInSnapshotTree(snapshotTree: ISnapshotTree): number {
     let numTrees = 0;
     for (const [_, tree] of Object.entries(snapshotTree.trees)) {
@@ -448,6 +510,7 @@ export async function downloadSnapshot(
     snapshotFormatFetchType?: SnapshotFormatSupportType,
     controller?: AbortController,
     epochTracker?: EpochTracker,
+    scenarioName?: string,
 ): Promise<ISnapshotRequestAndResponseOptions> {
     // back-compat: This block to be removed with #8784 when we only consume/consider odsp resolvers that are >= 0.51
     const sharingLinkToRedeem = (odspResolvedUrl as any).sharingLinkToRedeem;
@@ -482,28 +545,11 @@ export async function downloadSnapshot(
             headers.accept = "application/json";
     }
 
-    const response = await (epochTracker?.fetch(url, fetchOptions, "treesLatest", true) ??
+    const odspResponse = await (epochTracker?.fetch(url, fetchOptions, "treesLatest", true, scenarioName) ??
         fetchHelper(url, fetchOptions));
 
-    let finalSnapshotContents: IOdspResponse<ISnapshotContents>;
-    const contentType = response.headers.get("content-type");
-    if (contentType === "application/json") {
-        const text = await response.content.text();
-        const content: IOdspSnapshot = JSON.parse(text);
-        response.propsToLog.bodySize = text.length;
-        const snapshotContents: ISnapshotContents = convertOdspSnapshotToSnapsohtTreeAndBlobs(content);
-        finalSnapshotContents = { ...response, content: snapshotContents };
-    } else {
-        assert(contentType === "application/ms-fluid", 0x2c3 /* "Content type should be application/ms-fluid" */);
-        const content = await response.content.arrayBuffer();
-        response.propsToLog.bodySize = content.byteLength;
-        const snapshotContents: ISnapshotContents = parseCompactSnapshotResponse(
-            new ReadBuffer(new Uint8Array(content)));
-        finalSnapshotContents = { ...response, content: snapshotContents };
-    }
-    response.propsToLog.contentType = contentType;
     return {
-        odspSnapshotResponse: finalSnapshotContents,
+        odspResponse,
         requestHeaders: headers,
         requestUrl: url,
     };
@@ -513,7 +559,7 @@ function isRedeemSharingLinkError(odspResolvedUrl: IOdspResolvedUrl, error: any)
     if (odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem !== undefined
         && (typeof error === "object" && error !== null)
         && (error.errorType === DriverErrorType.authorizationError
-        || error.errorType === DriverErrorType.fileNotFoundOrAccessDeniedError)) {
+            || error.errorType === DriverErrorType.fileNotFoundOrAccessDeniedError)) {
         return true;
     }
     return false;
@@ -526,9 +572,9 @@ function getEncodedShareUrl(url: string): string {
      */
     let encodedUrl = fromUtf8ToBase64(encodeURI(url));
     encodedUrl = encodedUrl
-      .replace(/=+$/g, "")
-      .replace(/\//g, "_")
-      .replace(/\+/g, "-");
+        .replace(/=+$/g, "")
+        .replace(/\//g, "_")
+        .replace(/\+/g, "-");
     encodedUrl = "u!".concat(encodedUrl);
     return encodedUrl;
 }

package/src/index.ts

@@ -31,3 +31,7 @@ export * from "./odspDriverUrlResolver";
 
 // It's used by URL resolve code, but also has some public functions
 export * from "./odspFluidFileLink";
+
+// Wire format related
+export * from "./compactSnapshotParser";
+export * from "./ReadBufferUtils";