@fluidframework/odsp-driver 0.56.0 → 0.56.4

package/dist/odspUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspUtils.js","sourceRoot":"","sources":["../src/odspUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2EAAmF;AACnF,+DAAyG;AACzG,+DAAmE;AAEnE,qEAA2F;AAC3F,yEAI2C;AAC3C,qFAYiD;AACjD,mCAAgC;AAChC,qDAA8C;AAGjC,QAAA,iCAAiC,GAAG,mCAAmC,CAAC;AAErF,4DAA4D;AACrD,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AAAjD,QAAA,SAAS,aAAwC;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;AACI,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,oCAAe,CAAC,kBAAkB;gBACnC,OAAO,GAAG,iCAAM,OAAO,KAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAG,CAAC;YAEvE,KAAK,oCAAe,CAAC,uBAAuB,CAAC,CAAC,qCAAqC;YACnF,KAAK,uCAAa,CAAC,eAAe,EAAE,0CAA0C;gBAC1E,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;YAExB;gBACI,+CAA+C;gBAC/C,IAAI,CAAC,CAAC,yCAAiC,CAAC,KAAK,IAAI,EAAE;oBAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;iBACvB;gBACD,MAAM,CAAC,CAAC;SACf;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AApBD,kEAoBC;AAEM,KAAK,UAAU,WAAW,CAC7B,WAAwB,EACxB,WAAoC;IAEpC,MAAM,KAAK,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;IAEhC,oFAAoF;IACpF,OAAO,aAAK,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,gCAAiB,CACvB,0BAA0B,EAC1B,6BAA6B,EAC7B,oCAAe,CAAC,uBAAuB,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;YACjE,yCAAqB,CACjB,mBAAmB,QAAQ,CAAC,MAAM,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;SAChG;QAED,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/C,OAAO;YACH,OAAO,EAAE,QAAQ;YACjB,OAAO;YACP,gBAAgB,EAAE,wDAAoC,CAAC,OAAO,CAAC;YAC/D,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,KAAK;SACtC,CAAC;IACN,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;QACT,8FAA8F;QAC9F,wFAAwF;QACxF,2CAA2C;QAC3C,IAAI,MAAM,GAAG,uBAAQ,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,GAAG,KAAK,EAAE,CAAC;QAC7B,IAAI,SAAS,KAAK,4BAA4B,EAAE;YAC5C,MAAM,GAAG,2BAAY,CAAC,OAAO,CAAC;SACjC;QACD,qFAAqF;QACrF,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;YAC7B,MAAM,IAAI,6BAAc,CAAC,YAAY,EAAE,4BAA4B,EAAE,uCAAa,CAAC,YAAY,CAAC,CAAC;SACpG;QACD,iBAAiB;QACjB,IAAI,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE;YACvC,MAAM,IAAI,6BAAc,CAAC,gBAAgB,EAAE,2BAA2B,EAAE,uCAAa,CAAC,YAAY,CAAC,CAAC;SACvG;QAED,EAAE;QACF,oEAAoE;QACpE,8EAA8E;QAC9E,iEAAiE;QACjE,EAAE;QACF,IAAI,MAAM,KAAK,2BAAY,CAAC,OAAO,EAAE;YACjC,MAAM,IAAI,6BAAc,CAAC,kBAAkB,EAAE,YAAY,SAAS,EAAE,EAAE,oCAAe,CAAC,YAAY,CAAC,CAAC;SACvG;aAAM;YACH,MAAM,IAAI,6BAAc,CAAC,gBAAgB,EAAE,gBAAgB,SAAS,EAAE,EAAE,oCAAe,CAAC,YAAY,CAAC,CAAC;SACzG;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAzDD,kCAyDC;AAED;;;;GAIG;AACI,KAAK,UAAU,UAAU,CAC5B,WAAwB,EACxB,WAAoC;IAEpC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAErG,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;IAChD,gBAAgB,CAAC,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC;IACnD,OAAO;QACH,OAAO;QACP,OAAO,EAAE,WAAW;QACpB,gBAAgB;QAChB,QAAQ;KACX,CAAC;AACN,CAAC;AAdD,gCAcC;AAED;;;;GAIG;AACI,KAAK,UAAU,yBAAyB,CAC3C,WAAwB,EACxB,WAAoC;IAEpC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACrG,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,yCAAqB,CACjB,gCAAgC,EAChC,0CAAsB,EACtB,OAAO,EAAE,WAAW;QACpB,IAAI,CACP,CAAC;KACL;IAED,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC;IACxC,MAAM,GAAG,GAAG;QACR,OAAO;QACP,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACzB,gBAAgB;QAChB,QAAQ;KACX,CAAC;IACF,OAAO,GAAG,CAAC;AACf,CAAC;AA9BD,8DA8BC;AAeD,SAAgB,kBAAkB,CAAC,WAAyB;IACxD,qBAAM,CAAE,WAAgC,CAAC,eAAe,KAAK,IAAI,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC3G,OAAO,WAA+B,CAAC;AAC3C,CAAC;AAHD,gDAGC;AAEM,MAAM,gBAAgB,GAAG,CAAC,MAA6B,EAAE,EAAE,CAC9D,6BAAW,CAAC,MAAM,CACd,MAAM,EACN,YAAY,EACZ,EAAE,GAAG,EACD;QACI,aAAa,EAAE,2BAAU;KAC5B;CACJ,CAAC,CAAC;AARE,QAAA,gBAAgB,oBAQlB;AAEX,SAAgB,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;AArBD,8CAqBC;AAED,SAAgB,8BAA8B,CAC1C,MAAwB,EACxB,WAA6B,EAC7B,YAAyD,EACzD,gBAAyB;IAEzB,OAAO,KAAK,EAAE,OAA0B,EAAE,IAAY,EAAE,kCAA2C,KAAK,EAAE,EAAE;QACxG,+EAA+E;QAC/E,6EAA6E;QAC7E,yFAAyF;QACzF,kBAAkB;QAClB,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,EACN;YACI,SAAS,EAAE,GAAG,IAAI,WAAW;YAC7B,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM;YAC3B,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ;SAClC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,iCACtB,OAAO,KACV,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,MAAM,EAAE,WAAW,CAAC,MAAM,IAC5B,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;YACtB,MAAM,KAAK,GAAG,2CAAiB,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,0CAAgB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC;aACrF;YACD,IAAI,KAAK,KAAK,IAAI,IAAI,gBAAgB,EAAE;gBACpC,MAAM,IAAI,gCAAiB,CACvB,oBAAoB,EACpB,qBAAqB,IAAI,OAAO,EAChC,uCAAa,CAAC,eAAe,EAC7B,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;aACzB;YACD,OAAO,KAAK,CAAC;QACjB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;YACT,MAAM,UAAU,GAAG,2BAAS,CACxB,KAAK,EACL,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,gCAAiB,CACnC,oBAAoB,EACpB,YAAY,EACZ,uCAAa,CAAC,eAAe,EAC7B,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC3B,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC;AACN,CAAC;AAtDD,wEAsDC;AAED,SAAgB,sBAAsB,CAAC,eAAiC;IACpE,MAAM,UAAU,GAAgB;QAC5B,IAAI,EAAE,qCAAW;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;AAVD,wDAUC","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 { isOnline, OnlineStatus, RetryableError, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger, PerformanceEvent, wrapError } from \"@fluidframework/telemetry-utils\";\nimport {\n    fetchIncorrectResponse,\n    throwOdspNetworkError,\n    getSPOAndGraphRequestIdsFromResponse,\n} from \"@fluidframework/odsp-doclib-utils\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    OdspErrorType,\n    tokenFromResponse,\n    isTokenFromCache,\n    OdspResourceTokenFetchOptions,\n    ShareLinkTypes,\n    TokenFetcher,\n    ICacheEntry,\n    snapshotKey,\n    InstrumentedStorageTokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { fetch } from \"./fetch\";\nimport { pkgVersion } 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    commonSpoHeaders: ITelemetryProperties;\n    duration: number,\n}\n\nexport interface TokenFetchOptionsEx extends TokenFetchOptions {\n    /** previous error we hit in getWithRetryForTokenRefresh */\n    previousError?: any;\n}\n\nfunction headersToMap(headers: Headers) {\n    const newHeaders = new Map<string, string>();\n    for (const [key, value] of headers.entries()) {\n        newHeaders.set(key, value);\n    }\n    return newHeaders;\n}\n\n/**\n * This API should be used with pretty much all network calls (fetch, webSocket connection) in order\n * to correctly handle expired tokens. It relies on callback fetching token, and be able to refetch\n * token on failure. Only specific cases get retry call with refresh = true, all other / unknown errors\n * simply propagate to caller\n */\nexport async function getWithRetryForTokenRefresh<T>(get: (options: TokenFetchOptionsEx) => Promise<T>) {\n    return get({ refresh: false }).catch(async (e) => {\n        const options: TokenFetchOptionsEx = { refresh: true, previousError: e };\n        switch (e.errorType) {\n            // If the error is 401 or 403 refresh the token and try once more.\n            case DriverErrorType.authorizationError:\n                return get({ ...options, claims: e.claims, tenantId: e.tenantId });\n\n            case DriverErrorType.incorrectServerResponse: // some error on the wire, retry once\n            case OdspErrorType.fetchTokenError: // If the token was null, then retry once.\n                return get(options);\n\n            default:\n                // Caller may determine that it wants one retry\n                if (e[getWithRetryForTokenRefreshRepeat] === true) {\n                    return get(options);\n                }\n                throw e;\n        }\n    });\n}\n\nexport async function fetchHelper(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<Response>> {\n    const start = performance.now();\n\n    // Node-fetch and dom have conflicting typing, force them to work by casting for now\n    return fetch(requestInfo, requestInit).then(async (fetchResponse) => {\n        const response = fetchResponse as any as Response;\n        // Let's assume we can retry.\n        if (!response) {\n            throw new NonRetryableError(\n                \"odspFetchErrorNoResponse\",\n                \"No response from fetch call\",\n                DriverErrorType.incorrectServerResponse);\n        }\n        if (!response.ok || response.status < 200 || response.status >= 300) {\n            throwOdspNetworkError(\n                `odspFetchError [${response.status}]`, response.status, response, await response.text());\n        }\n\n        const headers = headersToMap(response.headers);\n        return {\n            content: response,\n            headers,\n            commonSpoHeaders: getSPOAndGraphRequestIdsFromResponse(headers),\n            duration: performance.now() - start,\n        };\n    }, (error) => {\n        // While we do not know for sure whether computer is offline, this error is not actionable and\n        // is pretty good indicator we are offline. Treating it as offline scenario will make it\n        // easier to see other errors in telemetry.\n        let online = isOnline();\n        const errorText = `${error}`;\n        if (errorText === \"TypeError: Failed to fetch\") {\n            online = OnlineStatus.Offline;\n        }\n        // This error is thrown by fetch() when AbortSignal is provided and it gets cancelled\n        if (error.name === \"AbortError\") {\n            throw new RetryableError(\"fetchAbort\", \"Fetch Timeout (AbortError)\", OdspErrorType.fetchTimeout);\n        }\n        // TCP/IP timeout\n        if (errorText.indexOf(\"ETIMEDOUT\") !== -1) {\n            throw new RetryableError(\"fetchETimedout\", \"Fetch Timeout (ETIMEDOUT)\", OdspErrorType.fetchTimeout);\n        }\n\n        //\n        // WARNING: Do not log error object itself or any of its properties!\n        // It could container PII, like URI in message itself, or token in properties.\n        // It is also non-serializable object due to circular references.\n        //\n        if (online === OnlineStatus.Offline) {\n            throw new RetryableError(\"OdspFetchOffline\", `Offline: ${errorText}`, DriverErrorType.offlineError);\n        } else {\n            throw new RetryableError(\"OdspFetchError\", `Fetch error: ${errorText}`, DriverErrorType.fetchFailure);\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, commonSpoHeaders, duration } = await fetchHelper(requestInfo, requestInit);\n\n    const arrayBuffer = await content.arrayBuffer();\n    commonSpoHeaders.bodySize = arrayBuffer.byteLength;\n    return {\n        headers,\n        content: arrayBuffer,\n        commonSpoHeaders,\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, commonSpoHeaders, duration } = await fetchHelper(requestInfo, requestInit);\n    let text: string | undefined;\n    try {\n        text = await content.text();\n    } catch (e) {\n        // JSON.parse() can fail and message would container full request URI, including\n        // tokens... It fails for me with \"Unexpected end of JSON input\" quite often - an attempt to download big file\n        // (many ops) almost always ends up with this error - I'd guess 1% of op request end up here... It always\n        // succeeds on retry.\n        // So do not log error object itself.\n        throwOdspNetworkError(\n            \"errorWhileParsingFetchResponse\",\n            fetchIncorrectResponse,\n            content, // response\n            text,\n        );\n    }\n\n    commonSpoHeaders.bodySize = text.length;\n    const res = {\n        headers,\n        content: JSON.parse(text),\n        commonSpoHeaders,\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: pkgVersion,\n            },\n        });\n\nexport function evalBlobsAndTrees(snapshot: IOdspSnapshot) {\n    let numTrees = 0;\n    let numBlobs = 0;\n    let encodedBlobsSize = 0;\n    let decodedBlobsSize = 0;\n    for (const tree of snapshot.trees) {\n        for (const treeEntry of tree.entries) {\n            if (treeEntry.type === \"blob\") {\n                numBlobs++;\n            } else if (treeEntry.type === \"tree\") {\n                numTrees++;\n            }\n        }\n    }\n    if (snapshot.blobs !== undefined) {\n        for (const blob of snapshot.blobs) {\n            decodedBlobsSize += blob.size;\n            encodedBlobsSize += blob.content.length;\n        }\n    }\n    return { numTrees, numBlobs, encodedBlobsSize, decodedBlobsSize };\n}\n\nexport function toInstrumentedOdspTokenFetcher(\n    logger: ITelemetryLogger,\n    resolvedUrl: IOdspResolvedUrl,\n    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>,\n    throwOnNullToken: boolean,\n): InstrumentedStorageTokenFetcher {\n    return async (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry: boolean = false) => {\n        // Telemetry note: if options.refresh is true, there is a potential perf issue:\n        // Host should optimize and provide non-expired tokens on all critical paths.\n        // Exceptions: race conditions around expiration, revoked tokens, host that does not care\n        // (fluid-fetcher)\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            {\n                eventName: `${name}_GetToken`,\n                attempts: options.refresh ? 2 : 1,\n                hasClaims: !!options.claims,\n                hasTenantId: !!options.tenantId,\n            },\n            async (event) => tokenFetcher({\n                ...options,\n                siteUrl: resolvedUrl.siteUrl,\n                driveId: resolvedUrl.driveId,\n                itemId: resolvedUrl.itemId,\n            }).then((tokenResponse) => {\n                const token = tokenFromResponse(tokenResponse);\n                // This event alone generates so many events that is materially impacts cost of telemetry\n                // Thus do not report end event when it comes back quickly.\n                // Note that most of the hosts do not report if result is comming from cache or not,\n                // so we can't rely on that here. But always record if specified explicitly for cases such as\n                // calling trees/latest during load.\n                if (alwaysRecordTokenFetchTelemetry || event.duration >= 32) {\n                    event.end({ fromCache: isTokenFromCache(tokenResponse), isNull: token === null });\n                }\n                if (token === null && throwOnNullToken) {\n                    throw new NonRetryableError(\n                        \"storageTokenIsNull\",\n                        `Token is null for ${name} call`,\n                        OdspErrorType.fetchTokenError,\n                        { method: name });\n                }\n                return token;\n            }, (error) => {\n                const tokenError = wrapError(\n                    error,\n                    (errorMessage) => new NonRetryableError(\n                        \"tokenFetcherFailed\",\n                        errorMessage,\n                        OdspErrorType.fetchTokenError,\n                        { method: name }));\n                throw tokenError;\n            }),\n            { cancel: \"generic\" });\n    };\n}\n\nexport function createCacheSnapshotKey(odspResolvedUrl: IOdspResolvedUrl): ICacheEntry {\n    const cacheEntry: ICacheEntry = {\n        type: snapshotKey,\n        key: \"\",\n        file: {\n            resolvedUrl: odspResolvedUrl,\n            docId: odspResolvedUrl.hashedDocumentId,\n        },\n    };\n    return cacheEntry;\n}\n"]}
+{"version":3,"file":"odspUtils.js","sourceRoot":"","sources":["../src/odspUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2EAAmF;AACnF,+DAMsC;AACtC,+DAAmE;AAEnE,qEAA2F;AAC3F,yEAI2C;AAC3C,qFAYiD;AACjD,mCAAgC;AAChC,qDAA8C;AAGjC,QAAA,iCAAiC,GAAG,mCAAmC,CAAC;AAErF,4DAA4D;AACrD,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AAAjD,QAAA,SAAS,aAAwC;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;AACI,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,oCAAe,CAAC,kBAAkB;gBACnC,OAAO,GAAG,iCAAM,OAAO,KAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAG,CAAC;YAEvE,KAAK,oCAAe,CAAC,uBAAuB,CAAC,CAAC,qCAAqC;YACnF,KAAK,uCAAa,CAAC,eAAe,EAAE,0CAA0C;gBAC1E,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;YAExB;gBACI,+CAA+C;gBAC/C,IAAI,CAAC,CAAC,yCAAiC,CAAC,KAAK,IAAI,EAAE;oBAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;iBACvB;gBACD,MAAM,CAAC,CAAC;SACf;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AApBD,kEAoBC;AAEM,KAAK,UAAU,WAAW,CAC7B,WAAwB,EACxB,WAAoC;IAEpC,MAAM,KAAK,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;IAEhC,oFAAoF;IACpF,OAAO,aAAK,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,gCAAiB,CACvB,0BAA0B,EAC1B,6BAA6B,EAC7B,oCAAe,CAAC,uBAAuB,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;YACjE,yCAAqB,CACjB,mBAAmB,QAAQ,CAAC,MAAM,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;SAChG;QAED,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/C,OAAO;YACH,OAAO,EAAE,QAAQ;YACjB,OAAO;YACP,UAAU,EAAE,wDAAoC,CAAC,OAAO,CAAC;YACzD,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,KAAK;SACtC,CAAC;IACN,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;QACT,8FAA8F;QAC9F,wFAAwF;QACxF,2CAA2C;QAC3C,IAAI,MAAM,GAAG,uBAAQ,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,GAAG,KAAK,EAAE,CAAC;QAC7B,IAAI,SAAS,KAAK,4BAA4B,EAAE;YAC5C,MAAM,GAAG,2BAAY,CAAC,OAAO,CAAC;SACjC;QACD,qFAAqF;QACrF,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;YAC7B,MAAM,IAAI,6BAAc,CAAC,YAAY,EAAE,4BAA4B,EAAE,uCAAa,CAAC,YAAY,CAAC,CAAC;SACpG;QACD,iBAAiB;QACjB,IAAI,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE;YACvC,MAAM,IAAI,6BAAc,CAAC,gBAAgB,EAAE,2BAA2B,EAAE,uCAAa,CAAC,YAAY,CAAC,CAAC;SACvG;QAED,EAAE;QACF,oEAAoE;QACpE,8EAA8E;QAC9E,iEAAiE;QACjE,EAAE;QACF,IAAI,MAAM,KAAK,2BAAY,CAAC,OAAO,EAAE;YACjC,MAAM,IAAI,6BAAc,CAAC,kBAAkB,EAAE,YAAY,SAAS,EAAE,EAAE,oCAAe,CAAC,YAAY,CAAC,CAAC;SACvG;aAAM;YACH,MAAM,IAAI,6BAAc,CAAC,gBAAgB,EAAE,gBAAgB,SAAS,EAAE,EAAE,oCAAe,CAAC,YAAY,CAAC,CAAC;SACzG;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAzDD,kCAyDC;AAED;;;;GAIG;AACI,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;AAdD,gCAcC;AAED;;;;GAIG;AACI,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,yCAAqB,CACjB,gCAAgC,EAChC,0CAAsB,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;AA9BD,8DA8BC;AAeD,SAAgB,kBAAkB,CAAC,WAAyB;IACxD,qBAAM,CAAE,WAAgC,CAAC,eAAe,KAAK,IAAI,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC3G,OAAO,WAA+B,CAAC;AAC3C,CAAC;AAHD,gDAGC;AAEM,MAAM,gBAAgB,GAAG,CAAC,MAA6B,EAAE,EAAE,CAC9D,6BAAW,CAAC,MAAM,CACd,MAAM,EACN,YAAY,EACZ,EAAE,GAAG,EACD;QACI,aAAa,EAAE,2BAAU;KAC5B;CACJ,CAAC,CAAC;AARE,QAAA,gBAAgB,oBAQlB;AAEX,SAAgB,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;AArBD,8CAqBC;AAED,SAAgB,8BAA8B,CAC1C,MAAwB,EACxB,WAA6B,EAC7B,YAAyD,EACzD,gBAAyB;IAEzB,OAAO,KAAK,EAAE,OAA0B,EAAE,IAAY,EAAE,kCAA2C,KAAK,EAAE,EAAE;QACxG,+EAA+E;QAC/E,6EAA6E;QAC7E,yFAAyF;QACzF,kBAAkB;QAClB,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,EACN;YACI,SAAS,EAAE,GAAG,IAAI,WAAW;YAC7B,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM;YAC3B,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ;SAClC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,iCACtB,OAAO,KACV,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,MAAM,EAAE,WAAW,CAAC,MAAM,IAC5B,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;YACtB,MAAM,KAAK,GAAG,2CAAiB,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,0CAAgB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC;aACrF;YACD,IAAI,KAAK,KAAK,IAAI,IAAI,gBAAgB,EAAE;gBACpC,MAAM,IAAI,gCAAiB,CACvB,oBAAoB,EACpB,qBAAqB,IAAI,OAAO,EAChC,uCAAa,CAAC,eAAe,EAC7B,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;aACzB;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,2BAAS,CACxB,KAAK,EACL,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,gCAAiB,CACnC,oBAAoB,EACpB,YAAY,EACZ,uCAAa,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,2BAAU,EAAE,CAAC,CAAC,CAAC;YACtD,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC;AACN,CAAC;AA1DD,wEA0DC;AAED,SAAgB,sBAAsB,CAAC,eAAiC;IACpE,MAAM,UAAU,GAAgB;QAC5B,IAAI,EAAE,qCAAW;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;AAVD,wDAUC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties, ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { IResolvedUrl, DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    isOnline,\n    OnlineStatus,\n    RetryableError,\n    NonRetryableError,\n    NetworkErrorBasic,\n} from \"@fluidframework/driver-utils\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger, PerformanceEvent, wrapError } from \"@fluidframework/telemetry-utils\";\nimport {\n    fetchIncorrectResponse,\n    throwOdspNetworkError,\n    getSPOAndGraphRequestIdsFromResponse,\n} from \"@fluidframework/odsp-doclib-utils\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    OdspErrorType,\n    tokenFromResponse,\n    isTokenFromCache,\n    OdspResourceTokenFetchOptions,\n    ShareLinkTypes,\n    TokenFetcher,\n    ICacheEntry,\n    snapshotKey,\n    InstrumentedStorageTokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { fetch } from \"./fetch\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { IOdspSnapshot } from \"./contracts\";\n\nexport const getWithRetryForTokenRefreshRepeat = \"getWithRetryForTokenRefreshRepeat\";\n\n/** Parse the given url and return the origin (host name) */\nexport const getOrigin = (url: string) => new URL(url).origin;\n\nexport interface ISnapshotContents {\n    snapshotTree: ISnapshotTree,\n    blobs: Map<string, ArrayBuffer>,\n    ops: ISequencedDocumentMessage[],\n    sequenceNumber: number | undefined,\n}\n\nexport interface IOdspResponse<T> {\n    content: T;\n    headers: Map<string, string>;\n    propsToLog: ITelemetryProperties;\n    duration: number,\n}\n\nexport interface TokenFetchOptionsEx extends TokenFetchOptions {\n    /** previous error we hit in getWithRetryForTokenRefresh */\n    previousError?: any;\n}\n\nfunction headersToMap(headers: Headers) {\n    const newHeaders = new Map<string, string>();\n    for (const [key, value] of headers.entries()) {\n        newHeaders.set(key, value);\n    }\n    return newHeaders;\n}\n\n/**\n * This API should be used with pretty much all network calls (fetch, webSocket connection) in order\n * to correctly handle expired tokens. It relies on callback fetching token, and be able to refetch\n * token on failure. Only specific cases get retry call with refresh = true, all other / unknown errors\n * simply propagate to caller\n */\nexport async function getWithRetryForTokenRefresh<T>(get: (options: TokenFetchOptionsEx) => Promise<T>) {\n    return get({ refresh: false }).catch(async (e) => {\n        const options: TokenFetchOptionsEx = { refresh: true, previousError: e };\n        switch (e.errorType) {\n            // If the error is 401 or 403 refresh the token and try once more.\n            case DriverErrorType.authorizationError:\n                return get({ ...options, claims: e.claims, tenantId: e.tenantId });\n\n            case DriverErrorType.incorrectServerResponse: // some error on the wire, retry once\n            case OdspErrorType.fetchTokenError: // If the token was null, then retry once.\n                return get(options);\n\n            default:\n                // Caller may determine that it wants one retry\n                if (e[getWithRetryForTokenRefreshRepeat] === true) {\n                    return get(options);\n                }\n                throw e;\n        }\n    });\n}\n\nexport async function fetchHelper(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<Response>> {\n    const start = performance.now();\n\n    // Node-fetch and dom have conflicting typing, force them to work by casting for now\n    return fetch(requestInfo, requestInit).then(async (fetchResponse) => {\n        const response = fetchResponse as any as Response;\n        // Let's assume we can retry.\n        if (!response) {\n            throw new NonRetryableError(\n                \"odspFetchErrorNoResponse\",\n                \"No response from fetch call\",\n                DriverErrorType.incorrectServerResponse);\n        }\n        if (!response.ok || response.status < 200 || response.status >= 300) {\n            throwOdspNetworkError(\n                `odspFetchError [${response.status}]`, response.status, response, await response.text());\n        }\n\n        const headers = headersToMap(response.headers);\n        return {\n            content: response,\n            headers,\n            propsToLog: getSPOAndGraphRequestIdsFromResponse(headers),\n            duration: performance.now() - start,\n        };\n    }, (error) => {\n        // While we do not know for sure whether computer is offline, this error is not actionable and\n        // is pretty good indicator we are offline. Treating it as offline scenario will make it\n        // easier to see other errors in telemetry.\n        let online = isOnline();\n        const errorText = `${error}`;\n        if (errorText === \"TypeError: Failed to fetch\") {\n            online = OnlineStatus.Offline;\n        }\n        // This error is thrown by fetch() when AbortSignal is provided and it gets cancelled\n        if (error.name === \"AbortError\") {\n            throw new RetryableError(\"fetchAbort\", \"Fetch Timeout (AbortError)\", OdspErrorType.fetchTimeout);\n        }\n        // TCP/IP timeout\n        if (errorText.indexOf(\"ETIMEDOUT\") !== -1) {\n            throw new RetryableError(\"fetchETimedout\", \"Fetch Timeout (ETIMEDOUT)\", OdspErrorType.fetchTimeout);\n        }\n\n        //\n        // WARNING: Do not log error object itself or any of its properties!\n        // It could container PII, like URI in message itself, or token in properties.\n        // It is also non-serializable object due to circular references.\n        //\n        if (online === OnlineStatus.Offline) {\n            throw new RetryableError(\"OdspFetchOffline\", `Offline: ${errorText}`, DriverErrorType.offlineError);\n        } else {\n            throw new RetryableError(\"OdspFetchError\", `Fetch error: ${errorText}`, DriverErrorType.fetchFailure);\n        }\n    });\n}\n\n/**\n * A utility function to fetch and parse as JSON with support for retries\n * @param requestInfo - fetch requestInfo, can be a string\n * @param requestInit - fetch requestInit\n */\nexport async function fetchArray(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<ArrayBuffer>> {\n    const { content, headers, propsToLog, duration } = await fetchHelper(requestInfo, requestInit);\n\n    const arrayBuffer = await content.arrayBuffer();\n    propsToLog.bodySize = arrayBuffer.byteLength;\n    return {\n        headers,\n        content: arrayBuffer,\n        propsToLog,\n        duration,\n    };\n}\n\n/**\n * A utility function to fetch and parse as JSON with support for retries\n * @param requestInfo - fetch requestInfo, can be a string\n * @param requestInit - fetch requestInit\n */\nexport async function fetchAndParseAsJSONHelper<T>(\n    requestInfo: RequestInfo,\n    requestInit: RequestInit | undefined,\n): Promise<IOdspResponse<T>> {\n    const { content, headers, propsToLog, duration } = await fetchHelper(requestInfo, requestInit);\n    let text: string | undefined;\n    try {\n        text = await content.text();\n    } catch (e) {\n        // JSON.parse() can fail and message would container full request URI, including\n        // tokens... It fails for me with \"Unexpected end of JSON input\" quite often - an attempt to download big file\n        // (many ops) almost always ends up with this error - I'd guess 1% of op request end up here... It always\n        // succeeds on retry.\n        // So do not log error object itself.\n        throwOdspNetworkError(\n            \"errorWhileParsingFetchResponse\",\n            fetchIncorrectResponse,\n            content, // response\n            text,\n        );\n    }\n\n    propsToLog.bodySize = text.length;\n    const res = {\n        headers,\n        content: JSON.parse(text),\n        propsToLog,\n        duration,\n    };\n    return res;\n}\n\nexport interface INewFileInfo {\n    siteUrl: string;\n    driveId: string;\n    filename: string;\n    filePath: string;\n    /**\n     * application can request creation of a share link along with the creation of a new file\n     * by passing in an optional param to specify the kind of sharing link\n     * (at the time of adding this comment Sept/2021), odsp only supports csl\n     */\n    createLinkType?: ShareLinkTypes;\n}\n\nexport function getOdspResolvedUrl(resolvedUrl: IResolvedUrl): IOdspResolvedUrl {\n    assert((resolvedUrl as IOdspResolvedUrl).odspResolvedUrl === true, 0x1de /* \"Not an ODSP resolved url\" */);\n    return resolvedUrl as IOdspResolvedUrl;\n}\n\nexport const createOdspLogger = (logger?: ITelemetryBaseLogger) =>\n    ChildLogger.create(\n        logger,\n        \"OdspDriver\",\n        { all :\n            {\n                driverVersion: pkgVersion,\n            },\n        });\n\nexport function evalBlobsAndTrees(snapshot: IOdspSnapshot) {\n    let numTrees = 0;\n    let numBlobs = 0;\n    let encodedBlobsSize = 0;\n    let decodedBlobsSize = 0;\n    for (const tree of snapshot.trees) {\n        for (const treeEntry of tree.entries) {\n            if (treeEntry.type === \"blob\") {\n                numBlobs++;\n            } else if (treeEntry.type === \"tree\") {\n                numTrees++;\n            }\n        }\n    }\n    if (snapshot.blobs !== undefined) {\n        for (const blob of snapshot.blobs) {\n            decodedBlobsSize += blob.size;\n            encodedBlobsSize += blob.content.length;\n        }\n    }\n    return { numTrees, numBlobs, encodedBlobsSize, decodedBlobsSize };\n}\n\nexport function toInstrumentedOdspTokenFetcher(\n    logger: ITelemetryLogger,\n    resolvedUrl: IOdspResolvedUrl,\n    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>,\n    throwOnNullToken: boolean,\n): InstrumentedStorageTokenFetcher {\n    return async (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry: boolean = false) => {\n        // Telemetry note: if options.refresh is true, there is a potential perf issue:\n        // Host should optimize and provide non-expired tokens on all critical paths.\n        // Exceptions: race conditions around expiration, revoked tokens, host that does not care\n        // (fluid-fetcher)\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            {\n                eventName: `${name}_GetToken`,\n                attempts: options.refresh ? 2 : 1,\n                hasClaims: !!options.claims,\n                hasTenantId: !!options.tenantId,\n            },\n            async (event) => tokenFetcher({\n                ...options,\n                siteUrl: resolvedUrl.siteUrl,\n                driveId: resolvedUrl.driveId,\n                itemId: resolvedUrl.itemId,\n            }).then((tokenResponse) => {\n                const token = tokenFromResponse(tokenResponse);\n                // This event alone generates so many events that is materially impacts cost of telemetry\n                // Thus do not report end event when it comes back quickly.\n                // Note that most of the hosts do not report if result is comming from cache or not,\n                // so we can't rely on that here. But always record if specified explicitly for cases such as\n                // calling trees/latest during load.\n                if (alwaysRecordTokenFetchTelemetry || event.duration >= 32) {\n                    event.end({ fromCache: isTokenFromCache(tokenResponse), isNull: token === null });\n                }\n                if (token === null && throwOnNullToken) {\n                    throw new NonRetryableError(\n                        \"storageTokenIsNull\",\n                        `Token is null for ${name} call`,\n                        OdspErrorType.fetchTokenError,\n                        { method: name });\n                }\n                return token;\n            }, (error) => {\n                // There is an important but unofficial contract here where token providers can set canRetry: true\n                // to hook into the driver's retry logic (e.g. the retry loop when initiating a connection)\n                const rawCanRetry = error?.canRetry;\n                const tokenError = wrapError(\n                    error,\n                    (errorMessage) => new NetworkErrorBasic(\n                        \"tokenFetcherFailed\",\n                        errorMessage,\n                        OdspErrorType.fetchTokenError,\n                        typeof rawCanRetry === \"boolean\" ? rawCanRetry : false /* canRetry */,\n                        { method: name, driverVersion: pkgVersion }));\n                throw tokenError;\n            }),\n            { cancel: \"generic\" });\n    };\n}\n\nexport function createCacheSnapshotKey(odspResolvedUrl: IOdspResolvedUrl): ICacheEntry {\n    const cacheEntry: ICacheEntry = {\n        type: snapshotKey,\n        key: \"\",\n        file: {\n            resolvedUrl: odspResolvedUrl,\n            docId: odspResolvedUrl.hashedDocumentId,\n        },\n    };\n    return cacheEntry;\n}\n"]}

package/dist/packageVersion.d.ts

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

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/odsp-driver";
-exports.pkgVersion = "0.56.0";
+exports.pkgVersion = "0.56.4";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

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

package/dist/vroom.js

@@ -54,7 +54,7 @@ async function fetchJoinSession(urlParts, path, method, logger, getStorageToken,
         // expecting socketUrl to be something like https://{hostName}/...
         const webSocketHostName = socketUrl.split("/")[2];
         // TODO SPO-specific telemetry
-        event.end(Object.assign(Object.assign({}, response.commonSpoHeaders), { 
+        event.end(Object.assign(Object.assign({}, response.propsToLog), { 
             // pushV2 websocket urls will contain pushf
             pushv2: socketUrl.includes("pushf"), webSocketHostName }));
         if (response.content.runtimeTenantId && !response.content.tenantId) {

package/dist/vroom.js.map

@@ -1 +1 @@
-{"version":3,"file":"vroom.js","sourceRoot":"","sources":["../src/vroom.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAElC,qEAAmE;AAGnE,2CAA6D;AAC7D,mDAA6C;AAE7C,6CAA4C;AAO5C;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,gBAAgB,CAClC,QAAuB,EACvB,IAAY,EACZ,MAAc,EACd,MAAwB,EACxB,eAAgD,EAChD,YAA0B,EAC1B,kBAA2B,EAC3B,OAA4B,EAC5B,gBAAyB;IAEzB,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAE5D,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO;QAC9B,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;QAClE,CAAC,CAAC,EAAE,CAAC;IACT,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,kBACF,SAAS,EAAE,aAAa,EACxB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAC9B,UAAU,GAEjB,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,MAAM,UAAU,GAAG,qBAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,SAAI,EAAE,CAAC;QAC5B,IAAI,QAAQ,GAAG,KAAK,YAAY,MAAM,CAAC;QACvC,QAAQ,IAAI,yBAAyB,KAAK,MAAM,CAAC;QACjD,QAAQ,IAAI,kCAAkC,CAAC;QAC/C,QAAQ,IAAI,oCAAoC,CAAC;QACjD,QAAQ,IAAI,cAAc,CAAC;QAC3B,sEAAsE;QACtE,IAAI,kBAAkB,IAAI,gBAAgB,KAAK,SAAS,EAAE;YACtD,MAAM,IAAI,GAAqB;gBAC3B,kBAAkB,EAAE,IAAI;gBACxB,gBAAgB;aACnB,CAAC;YACF,QAAQ,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;SACjD;QACD,QAAQ,IAAI,SAAS,YAAY,IAAI,CAAC;QACtC,MAAM,OAAO,GAA8B;YACvC,cAAc,EAAE,gCAAgC,YAAY,EAAE;SACjE,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,yBAAY,CAC/B,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,0BAAU,CAAC,UAAU,CAAC,WACrB,QAAQ,CAAC,OACb,UAAU,QAAQ,CAAC,MAAM,IAAI,IAAI,QAAQ,EACzC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,EACnC,aAAa,EACb,IAAI,CACP,EACD,aAAa,EACb,MAAM,CACT,CAAC;QAEF,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC;QACxD,kEAAkE;QAClE,MAAM,iBAAiB,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,8BAA8B;QAC9B,KAAK,CAAC,GAAG,iCACF,QAAQ,CAAC,gBAAgB;YAC5B,2CAA2C;YAC3C,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EACnC,iBAAiB,IACnB,CAAC;QAEH,IAAI,QAAQ,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE;YAChE,QAAQ,CAAC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC;SAChE;QAED,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC5B,CAAC,CAAC,CAAC;AACX,CAAC;AA1ED,4CA0EC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { InstrumentedStorageTokenFetcher, IOdspUrlParts } from \"@fluidframework/odsp-driver-definitions\";\nimport { ISocketStorageDiscovery } from \"./contracts\";\nimport { getOrigin, TokenFetchOptionsEx } from \"./odspUtils\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { runWithRetry } from \"./retryUtils\";\n\ninterface IJoinSessionBody {\n    requestSocketToken: boolean;\n    guestDisplayName: string;\n}\n\n/**\n * Makes join session call on SPO to get information about the web socket for a document\n * @param urlParts - The SPO drive id, itemId, siteUrl that this request should be made against\n * @param path - The API path that is relevant to this request\n * @param method - The type of request, such as GET or POST\n * @param logger - A logger to use for this request\n * @param getStorageToken - A function that is able to provide the access token for this request\n * @param epochTracker - fetch wrapper which incorporates epoch logic around joinSession call\n * @param requestSocketToken - flag indicating whether joinSession is expected to return access token\n * which is used when establishing websocket connection with collab session backend service.\n * @param options - Options to fetch the token.\n * @param guestDisplayName - display name used to identify guest user joining a session.\n * This is optional and used only when collab session is being joined via invite.\n */\nexport async function fetchJoinSession(\n    urlParts: IOdspUrlParts,\n    path: string,\n    method: string,\n    logger: ITelemetryLogger,\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    epochTracker: EpochTracker,\n    requestSocketToken: boolean,\n    options: TokenFetchOptionsEx,\n    guestDisplayName?: string,\n): Promise<ISocketStorageDiscovery> {\n    const token = await getStorageToken(options, \"JoinSession\");\n\n    const extraProps = options.refresh\n        ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }\n        : {};\n    return PerformanceEvent.timedExecAsync(\n        logger, {\n            eventName: \"JoinSession\",\n            attempts: options.refresh ? 2 : 1,\n            ...extraProps,\n        },\n        async (event) => {\n            const siteOrigin = getOrigin(urlParts.siteUrl);\n            const formBoundary = uuid();\n            let postBody = `--${formBoundary}\\r\\n`;\n            postBody += `Authorization: Bearer ${token}\\r\\n`;\n            postBody += `X-HTTP-Method-Override: POST\\r\\n`;\n            postBody += `Content-Type: application/json\\r\\n`;\n            postBody += `_post: 1\\r\\n`;\n            // Name should be there when socket token is requested and vice-versa.\n            if (requestSocketToken && guestDisplayName !== undefined) {\n                const body: IJoinSessionBody = {\n                    requestSocketToken: true,\n                    guestDisplayName,\n                };\n                postBody += `\\r\\n${JSON.stringify(body)}\\r\\n`;\n            }\n            postBody += `\\r\\n--${formBoundary}--`;\n            const headers: {[index: string]: string} = {\n                \"Content-Type\": `multipart/form-data;boundary=${formBoundary}`,\n            };\n\n            const response = await runWithRetry(\n                async () => epochTracker.fetchAndParseAsJSON<ISocketStorageDiscovery>(\n                    `${getApiRoot(siteOrigin)}/drives/${\n                        urlParts.driveId\n                    }/items/${urlParts.itemId}/${path}?ump=1`,\n                    { method, headers, body: postBody },\n                    \"joinSession\",\n                    true,\n                ),\n                \"joinSession\",\n                logger,\n            );\n\n            const socketUrl = response.content.deltaStreamSocketUrl;\n            // expecting socketUrl to be something like https://{hostName}/...\n            const webSocketHostName = socketUrl.split(\"/\")[2];\n\n            // TODO SPO-specific telemetry\n            event.end({\n                ...response.commonSpoHeaders,\n                // pushV2 websocket urls will contain pushf\n                pushv2: socketUrl.includes(\"pushf\"),\n                webSocketHostName,\n            });\n\n            if (response.content.runtimeTenantId && !response.content.tenantId) {\n                response.content.tenantId = response.content.runtimeTenantId;\n            }\n\n            return response.content;\n        });\n}\n"]}
+{"version":3,"file":"vroom.js","sourceRoot":"","sources":["../src/vroom.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAElC,qEAAmE;AAGnE,2CAA6D;AAC7D,mDAA6C;AAE7C,6CAA4C;AAO5C;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,gBAAgB,CAClC,QAAuB,EACvB,IAAY,EACZ,MAAc,EACd,MAAwB,EACxB,eAAgD,EAChD,YAA0B,EAC1B,kBAA2B,EAC3B,OAA4B,EAC5B,gBAAyB;IAEzB,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAE5D,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO;QAC9B,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;QAClE,CAAC,CAAC,EAAE,CAAC;IACT,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,kBACF,SAAS,EAAE,aAAa,EACxB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAC9B,UAAU,GAEjB,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,MAAM,UAAU,GAAG,qBAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,SAAI,EAAE,CAAC;QAC5B,IAAI,QAAQ,GAAG,KAAK,YAAY,MAAM,CAAC;QACvC,QAAQ,IAAI,yBAAyB,KAAK,MAAM,CAAC;QACjD,QAAQ,IAAI,kCAAkC,CAAC;QAC/C,QAAQ,IAAI,oCAAoC,CAAC;QACjD,QAAQ,IAAI,cAAc,CAAC;QAC3B,sEAAsE;QACtE,IAAI,kBAAkB,IAAI,gBAAgB,KAAK,SAAS,EAAE;YACtD,MAAM,IAAI,GAAqB;gBAC3B,kBAAkB,EAAE,IAAI;gBACxB,gBAAgB;aACnB,CAAC;YACF,QAAQ,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;SACjD;QACD,QAAQ,IAAI,SAAS,YAAY,IAAI,CAAC;QACtC,MAAM,OAAO,GAA8B;YACvC,cAAc,EAAE,gCAAgC,YAAY,EAAE;SACjE,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,yBAAY,CAC/B,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,0BAAU,CAAC,UAAU,CAAC,WACrB,QAAQ,CAAC,OACb,UAAU,QAAQ,CAAC,MAAM,IAAI,IAAI,QAAQ,EACzC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,EACnC,aAAa,EACb,IAAI,CACP,EACD,aAAa,EACb,MAAM,CACT,CAAC;QAEF,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC;QACxD,kEAAkE;QAClE,MAAM,iBAAiB,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,8BAA8B;QAC9B,KAAK,CAAC,GAAG,iCACF,QAAQ,CAAC,UAAU;YACtB,2CAA2C;YAC3C,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EACnC,iBAAiB,IACnB,CAAC;QAEH,IAAI,QAAQ,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE;YAChE,QAAQ,CAAC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC;SAChE;QAED,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC5B,CAAC,CAAC,CAAC;AACX,CAAC;AA1ED,4CA0EC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { InstrumentedStorageTokenFetcher, IOdspUrlParts } from \"@fluidframework/odsp-driver-definitions\";\nimport { ISocketStorageDiscovery } from \"./contracts\";\nimport { getOrigin, TokenFetchOptionsEx } from \"./odspUtils\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { runWithRetry } from \"./retryUtils\";\n\ninterface IJoinSessionBody {\n    requestSocketToken: boolean;\n    guestDisplayName: string;\n}\n\n/**\n * Makes join session call on SPO to get information about the web socket for a document\n * @param urlParts - The SPO drive id, itemId, siteUrl that this request should be made against\n * @param path - The API path that is relevant to this request\n * @param method - The type of request, such as GET or POST\n * @param logger - A logger to use for this request\n * @param getStorageToken - A function that is able to provide the access token for this request\n * @param epochTracker - fetch wrapper which incorporates epoch logic around joinSession call\n * @param requestSocketToken - flag indicating whether joinSession is expected to return access token\n * which is used when establishing websocket connection with collab session backend service.\n * @param options - Options to fetch the token.\n * @param guestDisplayName - display name used to identify guest user joining a session.\n * This is optional and used only when collab session is being joined via invite.\n */\nexport async function fetchJoinSession(\n    urlParts: IOdspUrlParts,\n    path: string,\n    method: string,\n    logger: ITelemetryLogger,\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    epochTracker: EpochTracker,\n    requestSocketToken: boolean,\n    options: TokenFetchOptionsEx,\n    guestDisplayName?: string,\n): Promise<ISocketStorageDiscovery> {\n    const token = await getStorageToken(options, \"JoinSession\");\n\n    const extraProps = options.refresh\n        ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }\n        : {};\n    return PerformanceEvent.timedExecAsync(\n        logger, {\n            eventName: \"JoinSession\",\n            attempts: options.refresh ? 2 : 1,\n            ...extraProps,\n        },\n        async (event) => {\n            const siteOrigin = getOrigin(urlParts.siteUrl);\n            const formBoundary = uuid();\n            let postBody = `--${formBoundary}\\r\\n`;\n            postBody += `Authorization: Bearer ${token}\\r\\n`;\n            postBody += `X-HTTP-Method-Override: POST\\r\\n`;\n            postBody += `Content-Type: application/json\\r\\n`;\n            postBody += `_post: 1\\r\\n`;\n            // Name should be there when socket token is requested and vice-versa.\n            if (requestSocketToken && guestDisplayName !== undefined) {\n                const body: IJoinSessionBody = {\n                    requestSocketToken: true,\n                    guestDisplayName,\n                };\n                postBody += `\\r\\n${JSON.stringify(body)}\\r\\n`;\n            }\n            postBody += `\\r\\n--${formBoundary}--`;\n            const headers: {[index: string]: string} = {\n                \"Content-Type\": `multipart/form-data;boundary=${formBoundary}`,\n            };\n\n            const response = await runWithRetry(\n                async () => epochTracker.fetchAndParseAsJSON<ISocketStorageDiscovery>(\n                    `${getApiRoot(siteOrigin)}/drives/${\n                        urlParts.driveId\n                    }/items/${urlParts.itemId}/${path}?ump=1`,\n                    { method, headers, body: postBody },\n                    \"joinSession\",\n                    true,\n                ),\n                \"joinSession\",\n                logger,\n            );\n\n            const socketUrl = response.content.deltaStreamSocketUrl;\n            // expecting socketUrl to be something like https://{hostName}/...\n            const webSocketHostName = socketUrl.split(\"/\")[2];\n\n            // TODO SPO-specific telemetry\n            event.end({\n                ...response.propsToLog,\n                // pushV2 websocket urls will contain pushf\n                pushv2: socketUrl.includes(\"pushf\"),\n                webSocketHostName,\n            });\n\n            if (response.content.runtimeTenantId && !response.content.tenantId) {\n                response.content.tenantId = response.content.runtimeTenantId;\n            }\n\n            return response.content;\n        });\n}\n"]}

package/lib/createFile.js

@@ -85,7 +85,7 @@ export async function createNewEmptyFluidFile(getStorageToken, newFileInfo, logg
             if (!content || !content.id) {
                 throw new NonRetryableError("createEmptyFileNoItemId", "ODSP CreateFile call returned no item ID", DriverErrorType.incorrectServerResponse);
             }
-            event.end(Object.assign({ headers: Object.keys(headers).length !== 0 ? true : undefined }, fetchResponse.commonSpoHeaders));
+            event.end(Object.assign({ headers: Object.keys(headers).length !== 0 ? true : undefined }, fetchResponse.propsToLog));
             return content.id;
         }, { end: true, cancel: "error" });
     });
@@ -112,7 +112,7 @@ export async function createNewFluidFileFromSummary(getStorageToken, newFileInfo
             if (!content || !content.itemId) {
                 throw new NonRetryableError("createFileNoItemId", "ODSP CreateFile call returned no item ID", DriverErrorType.incorrectServerResponse);
             }
-            event.end(Object.assign({ headers: Object.keys(headers).length !== 0 ? true : undefined, attempts: options.refresh ? 2 : 1 }, fetchResponse.commonSpoHeaders));
+            event.end(Object.assign({ headers: Object.keys(headers).length !== 0 ? true : undefined, attempts: options.refresh ? 2 : 1 }, fetchResponse.propsToLog));
             return content;
         });
     });

package/lib/createFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"createFile.js","sourceRoot":"","sources":["../src/createFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,mCAAmC,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACtG,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAA8B,MAAM,sCAAsC,CAAC;AAE/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAIH,aAAa,GAChB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAQrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EACH,sBAAsB,EACtB,2BAA2B,EAE3B,SAAS,GAEZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,yCAAyC,EAAE,MAAM,kBAAkB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAW,EAAE;IACpD,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;IAC3C,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACpC,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,gBAA0C,EAC1C,YAA0B,EAC1B,SAAqB,EACrB,gBAAyB,EACzB,sCAA+C;IAE/C,+EAA+E;IAC/E,IAAI,iBAAiB,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACzC,MAAM,IAAI,iBAAiB,CACvB,0BAA0B,EAAE,kBAAkB,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;KAC3F;IAED,IAAI,MAAc,CAAC;IACnB,IAAI,aAAa,GAAW,EAAE,CAAC;IAC/B,IAAI,WAA+B,CAAC;IACpC,IAAI,sBAA0C,CAAC;IAC/C,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAChC,MAAM,GAAG,MAAM,uBAAuB,CAClC,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;KACnG;SAAM;QACH,MAAM,OAAO,GAAG,MAAM,6BAA6B,CAC/C,eAAe,EACf,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,YAAY,EACZ,sCAAsC,CACzC,CAAC;QACF,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACxB,aAAa,GAAG,OAAO,CAAC,EAAE,CAAC;QAC3B,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QAClC,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;KAC3D;IAED,MAAM,OAAO,GAAG,aAAa,iCAAM,WAAW,KAAE,MAAM,EAAE,aAAa,EAAE,GAAG,IAAE,CAAC;IAC7E,MAAM,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC7C,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IACjE,SAAS,CAAC,KAAK,GAAG,eAAe,CAAC,gBAAgB,CAAC;IACnD,SAAS,CAAC,WAAW,GAAG,eAAe,CAAC;IAExC,IAAG,WAAW,IAAI,sBAAsB,EAAE;QACtC,eAAe,CAAC,aAAa,GAAG;YAC5B,UAAU,EAAE;gBACR,IAAI,EAAE,WAAW,CAAC,cAAc;gBAChC,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,sBAAsB;aAChC;SACJ,CAAC;KACL;IAED,IAAI,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,EAAE;QACpD,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAC/E,iDAAiD;QACjD,MAAM,QAAQ,GAAsB,yCAAyC,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAC/G,gCAAgC;QAChC,MAAM,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,CAAC;KAC7E;IACD,OAAO,eAAe,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CACzC,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,YAA0B,EAC1B,sCAA+C;IAE/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,gEAAgE;IAChE,MAAM,eAAe,GAAG,kBAAkB,CAAC,GAAG,WAAW,CAAC,QAAQ,MAAM,CAAC,CAAC;IAC1E,MAAM,UAAU,GACZ,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,WAAW,CAAC,OAAO,gBAAgB,QAC3F,IAAI,eAAe,wEAAwE,CAAC;IAEhG,OAAO,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACjD,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAErE,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,oBAAoB,EAAE,EACnC,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,UAAU,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;YACtE,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAE7C,MAAM,aAAa,GAAG,MAAM,YAAY,CACpC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,EACH;gBACI,IAAI,EAAE,SAAS;gBACf,OAAO;gBACP,MAAM,EAAE,KAAK;aAChB,EACD,YAAY,CACf,EACD,YAAY,EACZ,MAAM,CACT,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACtC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACzB,MAAM,IAAI,iBAAiB,CACvB,yBAAyB,EACzB,0CAA0C,EAC1C,eAAe,CAAC,uBAAuB,CAAC,CAAC;aAChD;YACD,KAAK,CAAC,GAAG,iBACL,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,IAC1D,aAAa,CAAC,gBAAgB,EACnC,CAAC;YACH,OAAO,OAAO,CAAC,EAAE,CAAC;QACtB,CAAC,EACD,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAC/C,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,gBAA8B,EAC9B,YAA0B,EAC1B,sCAA+C;IAE/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,OAAO,GACT,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,WAAW,CAAC,OAAO,cAAc;QACzF,GAAG,QAAQ,IAAI,eAAe,EAAE,CAAC;IAErC,MAAM,iBAAiB,GAAG,mCAAmC,CAAC,gBAAgB,CAAC,CAAC;IAChF,MAAM,UAAU,GAAG,GAAG,OAAO,gCAAgC,WAAW,CAAC,cAAc,CAAC,CAAC;QACrF,mBAAmB,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAE3D,OAAO,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACjD,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAErE,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,eAAe,EAAE,EAC9B,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,UAAU,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;YACtE,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAE7C,MAAM,aAAa,GAAG,MAAM,YAAY,CACpC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,EACH;gBACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC;gBACvC,OAAO;gBACP,MAAM,EAAE,MAAM;aACjB,EACD,YAAY,CACf,EACD,YAAY,EACZ,MAAM,CACT,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACtC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC7B,MAAM,IAAI,iBAAiB,CACvB,oBAAoB,EACpB,0CAA0C,EAC1C,eAAe,CAAC,uBAAuB,CAAC,CAAC;aAChD;YACD,KAAK,CAAC,GAAG,iBACL,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAC7D,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAC9B,aAAa,CAAC,gBAAgB,EACnC,CAAC;YACH,OAAO,OAAO,CAAC;QACnB,CAAC,CACJ,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,mCAAmC,CAAC,gBAA8B;;IACvE,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;IACjE,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;IAC3E,IAAI,CAAC,CAAC,UAAU,IAAI,eAAe,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;KAC9E;IACD,MAAM,kBAAkB,GAAG,mCAAmC,CAAC,eAAe,CAAC,CAAC;IAChF,MAAM,qBAAqB,GAAiB;QACxC,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;KAC9C,CAAC;IACF,eAAe,CAAC,IAAI,CAAC,UAAU,GAAG,qBAAqB,CAAC;IACxD,MAAM,yBAAyB,GAAiB;QAC5C,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,EAAE;YACF,WAAW,EAAE,eAAe;YAC5B,MAAM,EAAE,UAAU;SACrB;KACJ,CAAC;IACF,MAAM,YAAY,GAAG,wCAAwC,CAAC,yBAAyB,CAAC,CAAC;IACzF,MAAM,QAAQ,GAAwB;QAClC,OAAO,QAAE,YAAY,CAAC,OAAO,mCAAI,EAAE;QACnC,OAAO,EAAE,KAAK;QACd,cAAc,EAAE,kBAAkB,CAAC,cAAc;QACjD,IAAI,EAAE,WAAW;KACpB,CAAC;IACF,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wCAAwC,CAAC,OAAqB;;IAC1E,MAAM,YAAY,GAAqB;QACnC,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,EAAE;KACd,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,KAA2B,CAAC;QAChC,yGAAyG;QACzG,4GAA4G;QAC5G,6CAA6C;QAC7C,IAAI,YAA8B,CAAC;QAEnC,QAAQ,aAAa,CAAC,IAAI,EAAE;YACxB,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,KAAK,GAAG,wCAAwC,CAAC,aAAa,CAAC,CAAC;gBAChE,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;gBAC1C,MAAM;aACT;YACD,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,OAAO,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;oBACvD,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAChF,MAAM,QAAQ,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAEhF,KAAK,GAAG;oBACJ,IAAI,EAAE,MAAM;oBACZ,OAAO;oBACP,QAAQ;iBACX,CAAC;gBACF,MAAM;aACT;YACD,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;aACtE;YACD,OAAO,CAAC,CAAC;gBACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;aAC9D;SACJ;QAED,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC;YAC7B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC;YAC/B,KAAK;YACL,YAAY;SACf,CAAC;QACF,MAAA,YAAY,CAAC,OAAO,0CAAE,IAAI,CAAC,KAAK,EAAE;KACrC;IAED,OAAO,YAAY,CAAC;AACxB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, Uint8ArrayToString } from \"@fluidframework/common-utils\";\nimport { getDocAttributesFromProtocolSummary, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { getGitType } from \"@fluidframework/protocol-base\";\nimport { SummaryType, ISummaryTree, ISummaryBlob } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IFileEntry,\n    InstrumentedStorageTokenFetcher,\n    IOdspResolvedUrl,\n    OdspErrorType,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspSummaryTree,\n    OdspSummaryTreeValue,\n    OdspSummaryTreeEntry,\n    ICreateFileResponse,\n    IOdspSummaryPayload,\n} from \"./contracts\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport {\n    createCacheSnapshotKey,\n    getWithRetryForTokenRefresh,\n    INewFileInfo,\n    getOrigin,\n    ISnapshotContents,\n} from \"./odspUtils\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { convertCreateNewSummaryTreeToTreeAndBlobs } from \"./createNewUtils\";\nimport { runWithRetry } from \"./retryUtils\";\n\nconst isInvalidFileName = (fileName: string): boolean => {\n    const invalidCharsRegex = /[\"*/:<>?\\\\|]+/g;\n    return !!fileName.match(invalidCharsRegex);\n};\n\n/**\n * Creates a new Fluid file.\n * Returns resolved url\n */\nexport async function createNewFluidFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree | undefined,\n    epochTracker: EpochTracker,\n    fileEntry: IFileEntry,\n    createNewCaching: boolean,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<IOdspResolvedUrl> {\n    // Check for valid filename before the request to create file is actually made.\n    if (isInvalidFileName(newFileInfo.filename)) {\n        throw new NonRetryableError(\n            \"createNewInvalidFilename\", \"Invalid filename\", OdspErrorType.invalidFileNameError);\n    }\n\n    let itemId: string;\n    let summaryHandle: string = \"\";\n    let sharingLink: string | undefined;\n    let sharingLinkErrorReason: string | undefined;\n    if (createNewSummary === undefined) {\n        itemId = await createNewEmptyFluidFile(\n            getStorageToken, newFileInfo, logger, epochTracker, forceAccessTokenViaAuthorizationHeader);\n    } else {\n        const content = await createNewFluidFileFromSummary(\n            getStorageToken,\n            newFileInfo,\n            logger,\n            createNewSummary,\n            epochTracker,\n            forceAccessTokenViaAuthorizationHeader,\n        );\n        itemId = content.itemId;\n        summaryHandle = content.id;\n        sharingLink = content.sharingLink;\n        sharingLinkErrorReason = content.sharingLinkErrorReason;\n    }\n\n    const odspUrl = createOdspUrl({... newFileInfo, itemId, dataStorePath: \"/\"});\n    const resolver = new OdspDriverUrlResolver();\n    const odspResolvedUrl = await resolver.resolve({ url: odspUrl });\n    fileEntry.docId = odspResolvedUrl.hashedDocumentId;\n    fileEntry.resolvedUrl = odspResolvedUrl;\n\n    if(sharingLink || sharingLinkErrorReason) {\n        odspResolvedUrl.shareLinkInfo = {\n            createLink: {\n                type: newFileInfo.createLinkType,\n                link: sharingLink,\n                error: sharingLinkErrorReason,\n            },\n        };\n    }\n\n    if (createNewSummary !== undefined && createNewCaching) {\n        assert(summaryHandle !== undefined, 0x203 /* \"Summary handle is undefined\" */);\n        // converting summary and getting sequence number\n        const snapshot: ISnapshotContents = convertCreateNewSummaryTreeToTreeAndBlobs(createNewSummary, summaryHandle);\n        // caching the converted summary\n        await epochTracker.put(createCacheSnapshotKey(odspResolvedUrl), snapshot);\n    }\n    return odspResolvedUrl;\n}\n\nexport async function createNewEmptyFluidFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    epochTracker: EpochTracker,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<string> {\n    const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : \"\";\n    // add .tmp extension to empty file (host is expected to rename)\n    const encodedFilename = encodeURIComponent(`${newFileInfo.filename}.tmp`);\n    const initialUrl =\n        `${getApiRoot(getOrigin(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:/${filePath\n        }/${encodedFilename}:/content?@name.conflictBehavior=rename&select=id,name,parentReference`;\n\n    return getWithRetryForTokenRefresh(async (options) => {\n        const storageToken = await getStorageToken(options, \"CreateNewFile\");\n\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            { eventName: \"createNewEmptyFile\" },\n            async (event) => {\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    initialUrl, storageToken, forceAccessTokenViaAuthorizationHeader);\n                headers[\"Content-Type\"] = \"application/json\";\n\n                const fetchResponse = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ICreateFileResponse>(\n                        url,\n                        {\n                            body: undefined,\n                            headers,\n                            method: \"PUT\",\n                        },\n                        \"createFile\",\n                    ),\n                    \"createFile\",\n                    logger,\n                );\n\n                const content = fetchResponse.content;\n                if (!content || !content.id) {\n                    throw new NonRetryableError(\n                        \"createEmptyFileNoItemId\",\n                        \"ODSP CreateFile call returned no item ID\",\n                        DriverErrorType.incorrectServerResponse);\n                }\n                event.end({\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    ...fetchResponse.commonSpoHeaders,\n                });\n                return content.id;\n            },\n            { end: true, cancel: \"error\" });\n    });\n}\n\nexport async function createNewFluidFileFromSummary(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree,\n    epochTracker: EpochTracker,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<ICreateFileResponse> {\n    const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : \"\";\n    const encodedFilename = encodeURIComponent(newFileInfo.filename);\n    const baseUrl =\n        `${getApiRoot(getOrigin(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:` +\n        `${filePath}/${encodedFilename}`;\n\n    const containerSnapshot = convertSummaryIntoContainerSnapshot(createNewSummary);\n    const initialUrl = `${baseUrl}:/opStream/snapshots/snapshot${newFileInfo.createLinkType ?\n        `?createLinkType=${newFileInfo.createLinkType}` : \"\"}`;\n\n    return getWithRetryForTokenRefresh(async (options) => {\n        const storageToken = await getStorageToken(options, \"CreateNewFile\");\n\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            { eventName: \"createNewFile\" },\n            async (event) => {\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    initialUrl, storageToken, forceAccessTokenViaAuthorizationHeader);\n                headers[\"Content-Type\"] = \"application/json\";\n\n                const fetchResponse = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ICreateFileResponse>(\n                        url,\n                        {\n                            body: JSON.stringify(containerSnapshot),\n                            headers,\n                            method: \"POST\",\n                        },\n                        \"createFile\",\n                    ),\n                    \"createFile\",\n                    logger,\n                );\n\n                const content = fetchResponse.content;\n                if (!content || !content.itemId) {\n                    throw new NonRetryableError(\n                        \"createFileNoItemId\",\n                        \"ODSP CreateFile call returned no item ID\",\n                        DriverErrorType.incorrectServerResponse);\n                }\n                event.end({\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    attempts: options.refresh ? 2 : 1,\n                    ...fetchResponse.commonSpoHeaders,\n                });\n                return content;\n            },\n        );\n    });\n}\n\nfunction convertSummaryIntoContainerSnapshot(createNewSummary: ISummaryTree) {\n    const appSummary = createNewSummary.tree[\".app\"] as ISummaryTree;\n    const protocolSummary = createNewSummary.tree[\".protocol\"] as ISummaryTree;\n    if (!(appSummary && protocolSummary)) {\n        throw new Error(\"App and protocol summary required for create new path!!\");\n    }\n    const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);\n    const attributesSummaryBlob: ISummaryBlob = {\n        type: SummaryType.Blob,\n        content: JSON.stringify(documentAttributes),\n    };\n    protocolSummary.tree.attributes = attributesSummaryBlob;\n    const convertedCreateNewSummary: ISummaryTree = {\n        type: SummaryType.Tree,\n        tree: {\n            \".protocol\": protocolSummary,\n            \".app\": appSummary,\n        },\n    };\n    const snapshotTree = convertSummaryToSnapshotTreeForCreateNew(convertedCreateNewSummary);\n    const snapshot: IOdspSummaryPayload = {\n        entries: snapshotTree.entries ?? [],\n        message: \"app\",\n        sequenceNumber: documentAttributes.sequenceNumber,\n        type: \"container\",\n    };\n    return snapshot;\n}\n\n/**\n * Converts a summary tree to ODSP tree\n */\nexport function convertSummaryToSnapshotTreeForCreateNew(summary: ISummaryTree): IOdspSummaryTree {\n    const snapshotTree: IOdspSummaryTree = {\n        type: \"tree\",\n        entries: [],\n    };\n\n    const keys = Object.keys(summary.tree);\n    for (const key of keys) {\n        const summaryObject = summary.tree[key];\n\n        let value: OdspSummaryTreeValue;\n        // Tracks if an entry is unreferenced. Currently, only tree entries can be marked as unreferenced. If the\n        // property is not present, the tree entry is considered referenced. If the property is present and is true,\n        // the tree entry is considered unreferenced.\n        let unreferenced: true | undefined;\n\n        switch (summaryObject.type) {\n            case SummaryType.Tree: {\n                value = convertSummaryToSnapshotTreeForCreateNew(summaryObject);\n                unreferenced = summaryObject.unreferenced;\n                break;\n            }\n            case SummaryType.Blob: {\n                const content = typeof summaryObject.content === \"string\" ?\n                    summaryObject.content : Uint8ArrayToString(summaryObject.content, \"base64\");\n                const encoding = typeof summaryObject.content === \"string\" ? \"utf-8\" : \"base64\";\n\n                value = {\n                    type: \"blob\",\n                    content,\n                    encoding,\n                };\n                break;\n            }\n            case SummaryType.Handle: {\n                throw new Error(\"No handle should be present for first summary!!\");\n            }\n            default: {\n                throw new Error(`Unknown tree type ${summaryObject.type}`);\n            }\n        }\n\n        const entry: OdspSummaryTreeEntry = {\n            path: encodeURIComponent(key),\n            type: getGitType(summaryObject),\n            value,\n            unreferenced,\n        };\n        snapshotTree.entries?.push(entry);\n    }\n\n    return snapshotTree;\n}\n"]}
+{"version":3,"file":"createFile.js","sourceRoot":"","sources":["../src/createFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,mCAAmC,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACtG,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAA8B,MAAM,sCAAsC,CAAC;AAE/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAIH,aAAa,GAChB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAQrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EACH,sBAAsB,EACtB,2BAA2B,EAE3B,SAAS,GAEZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,yCAAyC,EAAE,MAAM,kBAAkB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAW,EAAE;IACpD,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;IAC3C,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACpC,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,gBAA0C,EAC1C,YAA0B,EAC1B,SAAqB,EACrB,gBAAyB,EACzB,sCAA+C;IAE/C,+EAA+E;IAC/E,IAAI,iBAAiB,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACzC,MAAM,IAAI,iBAAiB,CACvB,0BAA0B,EAAE,kBAAkB,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;KAC3F;IAED,IAAI,MAAc,CAAC;IACnB,IAAI,aAAa,GAAW,EAAE,CAAC;IAC/B,IAAI,WAA+B,CAAC;IACpC,IAAI,sBAA0C,CAAC;IAC/C,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAChC,MAAM,GAAG,MAAM,uBAAuB,CAClC,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;KACnG;SAAM;QACH,MAAM,OAAO,GAAG,MAAM,6BAA6B,CAC/C,eAAe,EACf,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,YAAY,EACZ,sCAAsC,CACzC,CAAC;QACF,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACxB,aAAa,GAAG,OAAO,CAAC,EAAE,CAAC;QAC3B,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QAClC,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;KAC3D;IAED,MAAM,OAAO,GAAG,aAAa,iCAAM,WAAW,KAAE,MAAM,EAAE,aAAa,EAAE,GAAG,IAAE,CAAC;IAC7E,MAAM,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC7C,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IACjE,SAAS,CAAC,KAAK,GAAG,eAAe,CAAC,gBAAgB,CAAC;IACnD,SAAS,CAAC,WAAW,GAAG,eAAe,CAAC;IAExC,IAAG,WAAW,IAAI,sBAAsB,EAAE;QACtC,eAAe,CAAC,aAAa,GAAG;YAC5B,UAAU,EAAE;gBACR,IAAI,EAAE,WAAW,CAAC,cAAc;gBAChC,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,sBAAsB;aAChC;SACJ,CAAC;KACL;IAED,IAAI,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,EAAE;QACpD,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAC/E,iDAAiD;QACjD,MAAM,QAAQ,GAAsB,yCAAyC,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAC/G,gCAAgC;QAChC,MAAM,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,CAAC;KAC7E;IACD,OAAO,eAAe,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CACzC,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,YAA0B,EAC1B,sCAA+C;IAE/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,gEAAgE;IAChE,MAAM,eAAe,GAAG,kBAAkB,CAAC,GAAG,WAAW,CAAC,QAAQ,MAAM,CAAC,CAAC;IAC1E,MAAM,UAAU,GACZ,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,WAAW,CAAC,OAAO,gBAAgB,QAC3F,IAAI,eAAe,wEAAwE,CAAC;IAEhG,OAAO,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACjD,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAErE,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,oBAAoB,EAAE,EACnC,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,UAAU,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;YACtE,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAE7C,MAAM,aAAa,GAAG,MAAM,YAAY,CACpC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,EACH;gBACI,IAAI,EAAE,SAAS;gBACf,OAAO;gBACP,MAAM,EAAE,KAAK;aAChB,EACD,YAAY,CACf,EACD,YAAY,EACZ,MAAM,CACT,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACtC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACzB,MAAM,IAAI,iBAAiB,CACvB,yBAAyB,EACzB,0CAA0C,EAC1C,eAAe,CAAC,uBAAuB,CAAC,CAAC;aAChD;YACD,KAAK,CAAC,GAAG,iBACL,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,IAC1D,aAAa,CAAC,UAAU,EAC7B,CAAC;YACH,OAAO,OAAO,CAAC,EAAE,CAAC;QACtB,CAAC,EACD,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAC/C,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,gBAA8B,EAC9B,YAA0B,EAC1B,sCAA+C;IAE/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,OAAO,GACT,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,WAAW,CAAC,OAAO,cAAc;QACzF,GAAG,QAAQ,IAAI,eAAe,EAAE,CAAC;IAErC,MAAM,iBAAiB,GAAG,mCAAmC,CAAC,gBAAgB,CAAC,CAAC;IAChF,MAAM,UAAU,GAAG,GAAG,OAAO,gCAAgC,WAAW,CAAC,cAAc,CAAC,CAAC;QACrF,mBAAmB,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAE3D,OAAO,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACjD,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAErE,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,eAAe,EAAE,EAC9B,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,UAAU,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;YACtE,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAE7C,MAAM,aAAa,GAAG,MAAM,YAAY,CACpC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,EACH;gBACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC;gBACvC,OAAO;gBACP,MAAM,EAAE,MAAM;aACjB,EACD,YAAY,CACf,EACD,YAAY,EACZ,MAAM,CACT,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACtC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC7B,MAAM,IAAI,iBAAiB,CACvB,oBAAoB,EACpB,0CAA0C,EAC1C,eAAe,CAAC,uBAAuB,CAAC,CAAC;aAChD;YACD,KAAK,CAAC,GAAG,iBACL,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAC7D,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAC9B,aAAa,CAAC,UAAU,EAC7B,CAAC;YACH,OAAO,OAAO,CAAC;QACnB,CAAC,CACJ,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,mCAAmC,CAAC,gBAA8B;;IACvE,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;IACjE,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;IAC3E,IAAI,CAAC,CAAC,UAAU,IAAI,eAAe,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;KAC9E;IACD,MAAM,kBAAkB,GAAG,mCAAmC,CAAC,eAAe,CAAC,CAAC;IAChF,MAAM,qBAAqB,GAAiB;QACxC,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;KAC9C,CAAC;IACF,eAAe,CAAC,IAAI,CAAC,UAAU,GAAG,qBAAqB,CAAC;IACxD,MAAM,yBAAyB,GAAiB;QAC5C,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,EAAE;YACF,WAAW,EAAE,eAAe;YAC5B,MAAM,EAAE,UAAU;SACrB;KACJ,CAAC;IACF,MAAM,YAAY,GAAG,wCAAwC,CAAC,yBAAyB,CAAC,CAAC;IACzF,MAAM,QAAQ,GAAwB;QAClC,OAAO,QAAE,YAAY,CAAC,OAAO,mCAAI,EAAE;QACnC,OAAO,EAAE,KAAK;QACd,cAAc,EAAE,kBAAkB,CAAC,cAAc;QACjD,IAAI,EAAE,WAAW;KACpB,CAAC;IACF,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wCAAwC,CAAC,OAAqB;;IAC1E,MAAM,YAAY,GAAqB;QACnC,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,EAAE;KACd,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,KAA2B,CAAC;QAChC,yGAAyG;QACzG,4GAA4G;QAC5G,6CAA6C;QAC7C,IAAI,YAA8B,CAAC;QAEnC,QAAQ,aAAa,CAAC,IAAI,EAAE;YACxB,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,KAAK,GAAG,wCAAwC,CAAC,aAAa,CAAC,CAAC;gBAChE,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;gBAC1C,MAAM;aACT;YACD,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,OAAO,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;oBACvD,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAChF,MAAM,QAAQ,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAEhF,KAAK,GAAG;oBACJ,IAAI,EAAE,MAAM;oBACZ,OAAO;oBACP,QAAQ;iBACX,CAAC;gBACF,MAAM;aACT;YACD,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;aACtE;YACD,OAAO,CAAC,CAAC;gBACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;aAC9D;SACJ;QAED,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC;YAC7B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC;YAC/B,KAAK;YACL,YAAY;SACf,CAAC;QACF,MAAA,YAAY,CAAC,OAAO,0CAAE,IAAI,CAAC,KAAK,EAAE;KACrC;IAED,OAAO,YAAY,CAAC;AACxB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, Uint8ArrayToString } from \"@fluidframework/common-utils\";\nimport { getDocAttributesFromProtocolSummary, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { getGitType } from \"@fluidframework/protocol-base\";\nimport { SummaryType, ISummaryTree, ISummaryBlob } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IFileEntry,\n    InstrumentedStorageTokenFetcher,\n    IOdspResolvedUrl,\n    OdspErrorType,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspSummaryTree,\n    OdspSummaryTreeValue,\n    OdspSummaryTreeEntry,\n    ICreateFileResponse,\n    IOdspSummaryPayload,\n} from \"./contracts\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport {\n    createCacheSnapshotKey,\n    getWithRetryForTokenRefresh,\n    INewFileInfo,\n    getOrigin,\n    ISnapshotContents,\n} from \"./odspUtils\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { convertCreateNewSummaryTreeToTreeAndBlobs } from \"./createNewUtils\";\nimport { runWithRetry } from \"./retryUtils\";\n\nconst isInvalidFileName = (fileName: string): boolean => {\n    const invalidCharsRegex = /[\"*/:<>?\\\\|]+/g;\n    return !!fileName.match(invalidCharsRegex);\n};\n\n/**\n * Creates a new Fluid file.\n * Returns resolved url\n */\nexport async function createNewFluidFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree | undefined,\n    epochTracker: EpochTracker,\n    fileEntry: IFileEntry,\n    createNewCaching: boolean,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<IOdspResolvedUrl> {\n    // Check for valid filename before the request to create file is actually made.\n    if (isInvalidFileName(newFileInfo.filename)) {\n        throw new NonRetryableError(\n            \"createNewInvalidFilename\", \"Invalid filename\", OdspErrorType.invalidFileNameError);\n    }\n\n    let itemId: string;\n    let summaryHandle: string = \"\";\n    let sharingLink: string | undefined;\n    let sharingLinkErrorReason: string | undefined;\n    if (createNewSummary === undefined) {\n        itemId = await createNewEmptyFluidFile(\n            getStorageToken, newFileInfo, logger, epochTracker, forceAccessTokenViaAuthorizationHeader);\n    } else {\n        const content = await createNewFluidFileFromSummary(\n            getStorageToken,\n            newFileInfo,\n            logger,\n            createNewSummary,\n            epochTracker,\n            forceAccessTokenViaAuthorizationHeader,\n        );\n        itemId = content.itemId;\n        summaryHandle = content.id;\n        sharingLink = content.sharingLink;\n        sharingLinkErrorReason = content.sharingLinkErrorReason;\n    }\n\n    const odspUrl = createOdspUrl({... newFileInfo, itemId, dataStorePath: \"/\"});\n    const resolver = new OdspDriverUrlResolver();\n    const odspResolvedUrl = await resolver.resolve({ url: odspUrl });\n    fileEntry.docId = odspResolvedUrl.hashedDocumentId;\n    fileEntry.resolvedUrl = odspResolvedUrl;\n\n    if(sharingLink || sharingLinkErrorReason) {\n        odspResolvedUrl.shareLinkInfo = {\n            createLink: {\n                type: newFileInfo.createLinkType,\n                link: sharingLink,\n                error: sharingLinkErrorReason,\n            },\n        };\n    }\n\n    if (createNewSummary !== undefined && createNewCaching) {\n        assert(summaryHandle !== undefined, 0x203 /* \"Summary handle is undefined\" */);\n        // converting summary and getting sequence number\n        const snapshot: ISnapshotContents = convertCreateNewSummaryTreeToTreeAndBlobs(createNewSummary, summaryHandle);\n        // caching the converted summary\n        await epochTracker.put(createCacheSnapshotKey(odspResolvedUrl), snapshot);\n    }\n    return odspResolvedUrl;\n}\n\nexport async function createNewEmptyFluidFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    epochTracker: EpochTracker,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<string> {\n    const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : \"\";\n    // add .tmp extension to empty file (host is expected to rename)\n    const encodedFilename = encodeURIComponent(`${newFileInfo.filename}.tmp`);\n    const initialUrl =\n        `${getApiRoot(getOrigin(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:/${filePath\n        }/${encodedFilename}:/content?@name.conflictBehavior=rename&select=id,name,parentReference`;\n\n    return getWithRetryForTokenRefresh(async (options) => {\n        const storageToken = await getStorageToken(options, \"CreateNewFile\");\n\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            { eventName: \"createNewEmptyFile\" },\n            async (event) => {\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    initialUrl, storageToken, forceAccessTokenViaAuthorizationHeader);\n                headers[\"Content-Type\"] = \"application/json\";\n\n                const fetchResponse = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ICreateFileResponse>(\n                        url,\n                        {\n                            body: undefined,\n                            headers,\n                            method: \"PUT\",\n                        },\n                        \"createFile\",\n                    ),\n                    \"createFile\",\n                    logger,\n                );\n\n                const content = fetchResponse.content;\n                if (!content || !content.id) {\n                    throw new NonRetryableError(\n                        \"createEmptyFileNoItemId\",\n                        \"ODSP CreateFile call returned no item ID\",\n                        DriverErrorType.incorrectServerResponse);\n                }\n                event.end({\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    ...fetchResponse.propsToLog,\n                });\n                return content.id;\n            },\n            { end: true, cancel: \"error\" });\n    });\n}\n\nexport async function createNewFluidFileFromSummary(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree,\n    epochTracker: EpochTracker,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<ICreateFileResponse> {\n    const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : \"\";\n    const encodedFilename = encodeURIComponent(newFileInfo.filename);\n    const baseUrl =\n        `${getApiRoot(getOrigin(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:` +\n        `${filePath}/${encodedFilename}`;\n\n    const containerSnapshot = convertSummaryIntoContainerSnapshot(createNewSummary);\n    const initialUrl = `${baseUrl}:/opStream/snapshots/snapshot${newFileInfo.createLinkType ?\n        `?createLinkType=${newFileInfo.createLinkType}` : \"\"}`;\n\n    return getWithRetryForTokenRefresh(async (options) => {\n        const storageToken = await getStorageToken(options, \"CreateNewFile\");\n\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            { eventName: \"createNewFile\" },\n            async (event) => {\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    initialUrl, storageToken, forceAccessTokenViaAuthorizationHeader);\n                headers[\"Content-Type\"] = \"application/json\";\n\n                const fetchResponse = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ICreateFileResponse>(\n                        url,\n                        {\n                            body: JSON.stringify(containerSnapshot),\n                            headers,\n                            method: \"POST\",\n                        },\n                        \"createFile\",\n                    ),\n                    \"createFile\",\n                    logger,\n                );\n\n                const content = fetchResponse.content;\n                if (!content || !content.itemId) {\n                    throw new NonRetryableError(\n                        \"createFileNoItemId\",\n                        \"ODSP CreateFile call returned no item ID\",\n                        DriverErrorType.incorrectServerResponse);\n                }\n                event.end({\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    attempts: options.refresh ? 2 : 1,\n                    ...fetchResponse.propsToLog,\n                });\n                return content;\n            },\n        );\n    });\n}\n\nfunction convertSummaryIntoContainerSnapshot(createNewSummary: ISummaryTree) {\n    const appSummary = createNewSummary.tree[\".app\"] as ISummaryTree;\n    const protocolSummary = createNewSummary.tree[\".protocol\"] as ISummaryTree;\n    if (!(appSummary && protocolSummary)) {\n        throw new Error(\"App and protocol summary required for create new path!!\");\n    }\n    const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);\n    const attributesSummaryBlob: ISummaryBlob = {\n        type: SummaryType.Blob,\n        content: JSON.stringify(documentAttributes),\n    };\n    protocolSummary.tree.attributes = attributesSummaryBlob;\n    const convertedCreateNewSummary: ISummaryTree = {\n        type: SummaryType.Tree,\n        tree: {\n            \".protocol\": protocolSummary,\n            \".app\": appSummary,\n        },\n    };\n    const snapshotTree = convertSummaryToSnapshotTreeForCreateNew(convertedCreateNewSummary);\n    const snapshot: IOdspSummaryPayload = {\n        entries: snapshotTree.entries ?? [],\n        message: \"app\",\n        sequenceNumber: documentAttributes.sequenceNumber,\n        type: \"container\",\n    };\n    return snapshot;\n}\n\n/**\n * Converts a summary tree to ODSP tree\n */\nexport function convertSummaryToSnapshotTreeForCreateNew(summary: ISummaryTree): IOdspSummaryTree {\n    const snapshotTree: IOdspSummaryTree = {\n        type: \"tree\",\n        entries: [],\n    };\n\n    const keys = Object.keys(summary.tree);\n    for (const key of keys) {\n        const summaryObject = summary.tree[key];\n\n        let value: OdspSummaryTreeValue;\n        // Tracks if an entry is unreferenced. Currently, only tree entries can be marked as unreferenced. If the\n        // property is not present, the tree entry is considered referenced. If the property is present and is true,\n        // the tree entry is considered unreferenced.\n        let unreferenced: true | undefined;\n\n        switch (summaryObject.type) {\n            case SummaryType.Tree: {\n                value = convertSummaryToSnapshotTreeForCreateNew(summaryObject);\n                unreferenced = summaryObject.unreferenced;\n                break;\n            }\n            case SummaryType.Blob: {\n                const content = typeof summaryObject.content === \"string\" ?\n                    summaryObject.content : Uint8ArrayToString(summaryObject.content, \"base64\");\n                const encoding = typeof summaryObject.content === \"string\" ? \"utf-8\" : \"base64\";\n\n                value = {\n                    type: \"blob\",\n                    content,\n                    encoding,\n                };\n                break;\n            }\n            case SummaryType.Handle: {\n                throw new Error(\"No handle should be present for first summary!!\");\n            }\n            default: {\n                throw new Error(`Unknown tree type ${summaryObject.type}`);\n            }\n        }\n\n        const entry: OdspSummaryTreeEntry = {\n            path: encodeURIComponent(key),\n            type: getGitType(summaryObject),\n            value,\n            unreferenced,\n        };\n        snapshotTree.entries?.push(entry);\n    }\n\n    return snapshotTree;\n}\n"]}

package/lib/epochTracker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"epochTracker.d.ts","sourceRoot":"","sources":["../src/epochTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAmB,WAAW,EAAqB,MAAM,8BAA8B,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAGH,MAAM,EACN,UAAU,EACV,eAAe,EAElB,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAA6D,aAAa,EAAE,MAAM,aAAa,CAAC;AACvG,OAAO,EACH,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACrB,MAAM,aAAa,CAAC;AAItB,oBAAY,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,cAAc,GAC1G,aAAa,GAAG,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAE1D,oBAAY,iBAAiB,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpD,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAG3C,eAAO,MAAM,2BAA2B,EAAE,MAAgC,CAAC;AAE3E;;;;;GAKG;AACH,qBAAa,YAAa,YAAW,mBAAmB;IAQhD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,eAAe;IACzC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IACxC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB;IAT/C,OAAO,CAAC,WAAW,CAAqB;IAExC,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC,OAAO,CAAC,iBAAiB,CAAK;gBAEP,KAAK,EAAE,eAAe,EACtB,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB;IAOxC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,iBAAiB;IAclE,GAAG,CACZ,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAyCF,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAmB7B,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3C,IAAW,UAAU,uBAEpB;IAEY,qBAAqB,CAAC,OAAO,EAAE,UAAU;IAWtD;;;;;;OAMG;IACU,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IA6B5B;;;;;;OAMG;IACU,UAAU,CACnB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EACpC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM;IA8BxB,OAAO,CAAC,iBAAiB;IAkCzB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,yBAAyB;IAQjC,SAAS,CAAC,yBAAyB,CAC/B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,EAAE,iBAAiB,EAC5B,SAAS,GAAE,OAAe;YAahB,kBAAkB;IA4BhC,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,kBAAkB;CAG7B;AAED,qBAAa,0BAA2B,SAAQ,YAAY;IACxD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAwB;IAE5D,SAAS,CAAC,yBAAyB,CAC/B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe;IAUjB,GAAG,CACZ,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAuBF,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EACpC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAgD/B;AAED,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,UAAU,CAAC;IAClB,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED,wBAAgB,yBAAyB,CACrC,iBAAiB,EAAE,eAAe,EAClC,kBAAkB,EAAE,mBAAmB,EACvC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB,GAAG,gBAAgB,CAU9C"}
+{"version":3,"file":"epochTracker.d.ts","sourceRoot":"","sources":["../src/epochTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAmB,WAAW,EAAqB,MAAM,8BAA8B,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAGH,MAAM,EACN,UAAU,EACV,eAAe,EAElB,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAA6D,aAAa,EAAE,MAAM,aAAa,CAAC;AACvG,OAAO,EACH,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACrB,MAAM,aAAa,CAAC;AAItB,oBAAY,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,cAAc,GAC1G,aAAa,GAAG,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAE1D,oBAAY,iBAAiB,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpD,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAG3C,eAAO,MAAM,2BAA2B,EAAE,MAAgC,CAAC;AAE3E;;;;;GAKG;AACH,qBAAa,YAAa,YAAW,mBAAmB;IAQhD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,eAAe;IACzC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IACxC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB;IAT/C,OAAO,CAAC,WAAW,CAAqB;IAExC,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC,OAAO,CAAC,iBAAiB,CAAK;gBAEP,KAAK,EAAE,eAAe,EACtB,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB;IAOxC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,iBAAiB;IAclE,GAAG,CACZ,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAyCF,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAmB7B,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3C,IAAW,UAAU,uBAEpB;IAEY,qBAAqB,CAAC,OAAO,EAAE,UAAU;IAWtD;;;;;;OAMG;IACU,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IA0B5B;;;;;;OAMG;IACU,UAAU,CACnB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EACpC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM;IA2BxB,OAAO,CAAC,iBAAiB;IAkCzB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,yBAAyB;IAQjC,SAAS,CAAC,yBAAyB,CAC/B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,EAAE,iBAAiB,EAC5B,SAAS,GAAE,OAAe;YAahB,kBAAkB;IA4BhC,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,kBAAkB;CAG7B;AAED,qBAAa,0BAA2B,SAAQ,YAAY;IACxD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAwB;IAE5D,SAAS,CAAC,yBAAyB,CAC/B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe;IAUjB,GAAG,CACZ,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAuBF,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EACpC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAgD/B;AAED,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,UAAU,CAAC;IAClB,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED,wBAAgB,yBAAyB,CACrC,iBAAiB,EAAE,eAAe,EAClC,kBAAkB,EAAE,mBAAmB,EACvC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB,GAAG,gBAAgB,CAU9C"}

package/lib/epochTracker.js

@@ -140,7 +140,7 @@ export class EpochTracker {
         return this.rateLimiter.schedule(async () => fetchAndParseAsJSONHelper(url, fetchOptions)).then((response) => {
             epochFromResponse = response.headers.get("x-fluid-epoch");
             this.validateEpochFromResponse(epochFromResponse, fetchType);
-            response.commonSpoHeaders = Object.assign(Object.assign({}, response.commonSpoHeaders), { "X-RequestStats": clientCorrelationId });
+            response.propsToLog.XRequestStatsHeader = clientCorrelationId;
             return response;
         }).catch(async (error) => {
             // Get the server epoch from error in case we don't have it as if undefined we won't be able
@@ -170,7 +170,7 @@ export class EpochTracker {
         return this.rateLimiter.schedule(async () => fetchArray(url, fetchOptions)).then((response) => {
             epochFromResponse = response.headers.get("x-fluid-epoch");
             this.validateEpochFromResponse(epochFromResponse, fetchType);
-            response.commonSpoHeaders = Object.assign(Object.assign({}, response.commonSpoHeaders), { "X-RequestStats": clientCorrelationId });
+            response.propsToLog.XRequestStatsHeader = clientCorrelationId;
             return response;
         }).catch(async (error) => {
             // Get the server epoch from error in case we don't have it as if undefined we won't be able

package/lib/epochTracker.js.map

@@ -1 +1 @@
-{"version":3,"file":"epochTracker.js","sourceRoot":"","sources":["../src/epochTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAE/F,OAAO,EACH,WAAW,GAMd,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjG,OAAO,EAAE,yBAAyB,EAAE,UAAU,EAAE,kBAAkB,EAAiB,MAAM,aAAa,CAAC;AAMvG,OAAO,EAA4B,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACnF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAO1D,MAAM,CAAC,MAAM,YAAY,GAAG,cAAc,CAAC;AAE3C,0GAA0G;AAC1G,MAAM,CAAC,MAAM,2BAA2B,GAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAOrB,YACuB,KAAsB,EACtB,SAAqB,EACrB,MAAwB;QAFxB,UAAK,GAAL,KAAK,CAAiB;QACtB,cAAS,GAAT,SAAS,CAAY;QACrB,WAAM,GAAN,MAAM,CAAkB;QAN9B,aAAQ,GAAG,IAAI,EAAE,CAAC;QACnC,8DAA8D;QACtD,sBAAiB,GAAG,CAAC,CAAC;QAM1B,sDAAsD;QACtD,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,+BAA+B;IACxB,QAAQ,CAAC,KAAa,EAAE,SAAkB,EAAE,SAA4B;QAC3E,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACnE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;YACI,SAAS,EAAE,uBAAuB;YAClC,KAAK;YACL,SAAS;YACT,SAAS;SACZ,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,GAAG,CACZ,KAAa;;QAEb,IAAI;YACA,8FAA8F;YAC9F,MAAM,KAAK,GAA6B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7F,0EAA0E;YAC1E,sCAAsC;YACtC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,0BAA0B,EAAE;gBACrE,OAAO,SAAS,CAAC;aACpB;YACD,MAAM,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;YACrF,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBACnD,4FAA4F;gBAC5F,qCAAqC;aACpC;iBAAM,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,UAAU,EAAE;gBAC9C,OAAO,SAAS,CAAC;aACpB;YACD,gGAAgG;YAChG,wDAAwD;YACxD,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;gBAC5B,MAAM,SAAS,SAAG,KAAK,CAAC,KAAK,0CAAE,cAAc,CAAC;gBAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,IAAI,SAAS,KAAK,SAAS,IAAI,WAAW,GAAG,SAAS,IAAI,2BAA2B,EAAE;oBACnF,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;wBACI,SAAS,EAAE,0BAA0B;wBACrC,QAAQ,EAAE,WAAW,GAAG,SAAS;wBACjC,aAAa,EAAE,2BAA2B;qBAC7C,CAAC,CAAC;oBACP,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;oBAC3B,OAAO,SAAS,CAAC;iBACpB;aACJ;YACD,+DAA+D;YAC/D,OAAO,KAAK,CAAC,KAAK,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YACtF,OAAO,SAAS,CAAC;SACpB;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAa,EAAE,KAAU;;QACtC,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC/D,uGAAuG;QACvG,wCAAwC;QACxC,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;YAC5B,KAAK,CAAC,cAAc,SAAG,KAAK,CAAC,cAAc,mCAAI,IAAI,CAAC,GAAG,EAAE,CAAC;SAC7D;QACD,MAAM,IAAI,GAA6B;YACnC,KAAK;YACL,OAAO,EAAE,0BAA0B;YACnC,UAAU,EAAE,IAAI,CAAC,WAAW;SAC/B,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;aACtD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YACpF,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;IAEM,KAAK,CAAC,aAAa;QACtB,IAAI;YACA,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACzD;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,oBAAoB,EAAE,EAAE,KAAK,CAAC,CAAC;SAC1E;IACL,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,OAAmB;QAClD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnF,IAAI;YACA,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;SACjD;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YACpD,MAAM,KAAK,CAAC;SACf;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,mBAAmB,CAC5B,GAAW,EACX,YAAyB,EACzB,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QACxE,8BAA8B;QAC9B,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,iBAAqC,CAAC;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC5B,KAAK,IAAI,EAAE,CAAC,yBAAyB,CAAI,GAAG,EAAE,YAAY,CAAC,CAC9D,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,iBAAiB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC1D,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;YAC7D,QAAQ,CAAC,gBAAgB,mCAClB,QAAQ,CAAC,gBAAgB,KAC5B,gBAAgB,EAAE,mBAAmB,GACxC,CAAC;YACF,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,4FAA4F;YAC5F,6BAA6B;YAC7B,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACjC,iBAAiB,GAAI,KAAoB,CAAC,WAAW,CAAC;aACzD;YACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;YACnE,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAC;YACjG,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACnB,GAAW,EACX,YAAoC,EACpC,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QACxE,8BAA8B;QAC9B,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,iBAAqC,CAAC;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC5B,KAAK,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,CAAC,CAC5C,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,iBAAiB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC1D,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;YAC7D,QAAQ,CAAC,gBAAgB,mCAClB,QAAQ,CAAC,gBAAgB,KAC5B,gBAAgB,EAAE,mBAAmB,GACxC,CAAC;YACF,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,4FAA4F;YAC5F,6BAA6B;YAC7B,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACjC,iBAAiB,GAAI,KAAoB,CAAC,WAAW,CAAC;aACzD;YACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;YACnE,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAC;YACjG,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,iBAAiB,CACrB,YAAyB,EACzB,SAAkB,EAClB,mBAA2B;QAE3B,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC;QAC3F,IAAI,SAAS,EAAE;YACX,MAAM,OAAO,GAA4B,EAAE,CAAC;YAC5C,OAAO,CAAC,gBAAgB,CAAC,GAAG,mBAAmB,CAAC;YAChD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9C;YACD,IAAI,iBAAiB,EAAE;gBACnB,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;aACnF;YACD,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;SAC9C;aAAM;YACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;gBAC3C,YAAY,CAAC,OAAO,qBACb,YAAY,CAAC,OAAO,CAC1B,CAAC;gBACF,MAAM,CAAC,YAAY,CAAC,OAAO,KAAK,SAAS,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;gBACxF,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YACpC,CAAC,CAAC;YACF,SAAS,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;YACjD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;aAC/C;YACD,IAAI,iBAAiB,EAAE;gBACnB,SAAS,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;aACpF;SACJ;IACL,CAAC;IAEO,cAAc,CAAC,YAAyB,EAAE,OAAgC;QAC9E,0EAA0E;QAC1E,wDAAwD;QACxD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC/B,MAAM,CAAC,OAAO,IAAI,KAAK,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;QACpC,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtG,MAAM,UAAU,GAAG,CAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,UAAU,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;YAChC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEO,yBAAyB,CAAC,WAAoB;QAClD,MAAM,KAAK,GAAa,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE,EAAE,iBAAiB,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QACnG,IAAI,WAAW,KAAK,SAAS,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,eAAe,WAAW,EAAE,CAAC,CAAC;SAC5C;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAES,yBAAyB,CAC/B,iBAAqC,EACrC,SAA4B,EAC5B,YAAqB,KAAK;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAC7D,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,MAAM,KAAK,CAAC;SACf;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;aAC1D;SACJ;IACL,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC5B,KAAc,EACd,iBAA4C,EAC5C,SAA4B,EAC5B,YAAqB,KAAK;QAE1B,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,KAAK,eAAe,CAAC,wBAAwB,EAAE;YACrF,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;YAClE,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,EAC3B,KAAK,CAAC,mFAAmF,CAAC,CAAC;gBAC/F,UAAU,CAAC,sBAAsB,CAAC;oBAC9B,SAAS;oBACT,WAAW,EAAE,IAAI,CAAC,UAAU;oBAC5B,SAAS;iBACZ,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAAE,UAAU,CAAC,CAAC;gBAClF,kFAAkF;gBAClF,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,MAAM,UAAU,CAAC;aACpB;YACD,wGAAwG;YACxG,0GAA0G;YAC1G,cAAc;YACd,MAAM,IAAI,eAAe,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;SACzF;IACL,CAAC;IAEO,sBAAsB,CAAC,iBAA4C;QACvE,8FAA8F;QAC9F,sFAAsF;QACtF,iGAAiG;QACjG,IAAI,IAAI,CAAC,UAAU,IAAI,iBAAiB,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,iBAAiB,CAAC,EAAE;YACjF,6EAA6E;YAC7E,yEAAyE;YACzE,OAAO,IAAI,iBAAiB,CAAC,eAAe,EAAE,gBAAgB,EAAE,eAAe,CAAC,wBAAwB,CAAC,CAAC;SAC7G;IACL,CAAC;IAEO,kBAAkB,CAAC,KAAa;QACpC,uCAAY,KAAK,KAAE,IAAI,EAAE,IAAI,CAAC,SAAS,IAAG;IAC9C,CAAC;CACJ;AAED,MAAM,OAAO,0BAA2B,SAAQ,YAAY;IAA5D;;QACqB,wBAAmB,GAAG,IAAI,QAAQ,EAAQ,CAAC;IA8FhE,CAAC;IA5Fa,yBAAyB,CAC/B,iBAAqC,EACrC,SAAoB,EACpB,YAAqB,KAAK;QAE1B,KAAK,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAEzE,8GAA8G;QAC9G,0GAA0G;QAC1G,oBAAoB;QACpB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,GAAG,CACZ,KAAa;QAEb,IAAI,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAE9B,uDAAuD;QACvD,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;YAC5B,MAAM,GAAG,MAAM;iBACV,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACZ,iGAAiG;gBACjG,8FAA8F;gBAC9F,IAAI,KAAK,KAAK,SAAS,EAAE;oBACrB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;iBACtC;gBACD,+DAA+D;gBAC/D,OAAO,KAAK,CAAC;YACjB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACb,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvC,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;SACV;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC5B,GAAW,EACX,YAAoC,EACpC,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,sGAAsG;QACtG,uGAAuG;QACvG,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC;QAEvD,IAAI;YACA,OAAO,MAAM,KAAK,CAAC,mBAAmB,CAAI,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;SACnG;QAAC,OAAO,KAAK,EAAE;YACZ,+FAA+F;YAC/F,8EAA8E;YAC9E,8EAA8E;YAC9E,IAAI,SAAS,KAAK,aAAa,EAAE;gBAC7B,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC1C;YACD,IAAI,SAAS,KAAK,aAAa,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,SAAS,EAAE;gBAC9F,MAAM,KAAK,CAAC;aACf;SACJ;QAED,gDAAgD;QAChD,yEAAyE;QACzE,wFAAwF;QAExF,gGAAgG;QAChG,wEAAwE;QACxE,+EAA+E;QAC/E,wGAAwG;QACxG,0BAA0B;QAC1B,MAAM,gBAAgB,CAAC,cAAc,CACjC,IAAI,CAAC,MAAM,EACX,EAAE,SAAS,EAAE,qBAAqB,EAAE,EACpC,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,0BAA0B;YACjD,IAAI,KAAoC,CAAC;YACzC,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;gBAC7C,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;gBAC3B,QAAQ;gBACR,kFAAkF;gBAClF,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;aAAC,CAAC,CAAC;YAC1E,IAAI,GAAG,KAAK,UAAU,EAAE;gBACpB,KAAK,CAAC,MAAM,EAAE,CAAC;aAClB;QACL,CAAC,EACD,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACnD,OAAO,KAAK,CAAC,mBAAmB,CAAI,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACjF,CAAC;CACJ;AAOD,MAAM,UAAU,yBAAyB,CACrC,iBAAkC,EAClC,kBAAuC,EACvC,SAAqB,EACrB,MAAwB;IAExB,MAAM,YAAY,GAAG,IAAI,0BAA0B,CAAC,iBAAiB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1F,OAAO;QACH,KAAK,kCACE,kBAAkB,KACrB,cAAc,EAAE,YAAY,GAC/B;QACD,YAAY;KACf,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ThrottlingError, RateLimiter, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { IConnected } from \"@fluidframework/protocol-definitions\";\nimport {\n    snapshotKey,\n    ICacheEntry,\n    IEntry,\n    IFileEntry,\n    IPersistedCache,\n    IOdspError,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { PerformanceEvent, isFluidError, normalizeError } from \"@fluidframework/telemetry-utils\";\nimport { fetchAndParseAsJSONHelper, fetchArray, getOdspResolvedUrl, IOdspResponse } from \"./odspUtils\";\nimport {\n    IOdspCache,\n    INonPersistentCache,\n    IPersistedFileCache,\n } from \"./odspCache\";\nimport { IVersionedValueWithEpoch, persistedCacheValueVersion } from \"./contracts\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\n\nexport type FetchType = \"blob\" | \"createBlob\" | \"createFile\" | \"joinSession\" | \"ops\" | \"test\" | \"snapshotTree\" |\n    \"treesLatest\" | \"uploadSummary\" | \"push\" | \"versions\";\n\nexport type FetchTypeInternal = FetchType | \"cache\";\n\nexport const Odsp409Error = \"Odsp409Error\";\n\n// Please update the README file in odsp-driver-definitions if you change the defaultCacheExpiryTimeoutMs.\nexport const defaultCacheExpiryTimeoutMs: number = 2 * 24 * 60 * 60 * 1000;\n\n/**\n * This class is a wrapper around fetch calls. It adds epoch to the request made so that the\n * server can match it with its epoch value in order to match the version.\n * It also validates the epoch value received in response of fetch calls. If the epoch does not match,\n * then it also clears all the cached entries for the given container.\n */\nexport class EpochTracker implements IPersistedFileCache {\n    private _fluidEpoch: string | undefined;\n\n    public readonly rateLimiter: RateLimiter;\n    private readonly driverId = uuid();\n    // This tracks the request number made by the driver instance.\n    private networkCallNumber = 1;\n    constructor(\n        protected readonly cache: IPersistedCache,\n        protected readonly fileEntry: IFileEntry,\n        protected readonly logger: ITelemetryLogger,\n    ) {\n        // Limits the max number of concurrent requests to 24.\n        this.rateLimiter = new RateLimiter(24);\n    }\n\n    // public for UT purposes only!\n    public setEpoch(epoch: string, fromCache: boolean, fetchType: FetchTypeInternal) {\n        assert(this._fluidEpoch === undefined, 0x1db /* \"epoch exists\" */);\n        this._fluidEpoch = epoch;\n\n        this.logger.sendTelemetryEvent(\n            {\n                eventName: \"EpochLearnedFirstTime\",\n                epoch,\n                fetchType,\n                fromCache,\n            },\n        );\n    }\n\n    public async get(\n        entry: IEntry,\n    ): Promise<any> {\n        try {\n            // Return undefined so that the ops/snapshots are grabbed from the server instead of the cache\n            const value: IVersionedValueWithEpoch = await this.cache.get(this.fileEntryFromEntry(entry));\n            // Version mismatch between what the runtime expects and what it recieved.\n            // The cached value should not be used\n            if (value === undefined || value.version !== persistedCacheValueVersion) {\n                return undefined;\n            }\n            assert(value.fluidEpoch !== undefined, 0x1dc /* \"all entries have to have epoch\" */);\n            if (this._fluidEpoch === undefined) {\n                this.setEpoch(value.fluidEpoch, true, \"cache\");\n            // Epoch mismatch, the cached value is considerably different from what the current state of\n            // the runtime and should not be used\n            } else if (this._fluidEpoch !== value.fluidEpoch) {\n                return undefined;\n            }\n            // Expire the cached snapshot if it's older than the defaultCacheExpiryTimeoutMs and immediately\n            // expire all old caches that do not have cacheEntryTime\n            if (entry.type === snapshotKey) {\n                const cacheTime = value.value?.cacheEntryTime;\n                const currentTime = Date.now();\n                if (cacheTime === undefined || currentTime - cacheTime >= defaultCacheExpiryTimeoutMs) {\n                    this.logger.sendTelemetryEvent(\n                        {\n                            eventName: \"odspVersionsCacheExpired\",\n                            duration: currentTime - cacheTime,\n                            maxCacheAgeMs: defaultCacheExpiryTimeoutMs,\n                        });\n                    await this.removeEntries();\n                    return undefined;\n                }\n            }\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return value.value;\n        } catch (error) {\n            this.logger.sendErrorEvent({ eventName: \"cacheFetchError\", type: entry.type }, error);\n            return undefined;\n        }\n    }\n\n    public async put(entry: IEntry, value: any) {\n        assert(this._fluidEpoch !== undefined, 0x1dd /* \"no epoch\" */);\n        // For snapshots, the value should have the cacheEntryTime. This will be used to expire snapshots older\n        // than the defaultCacheExpiryTimeoutMs.\n        if (entry.type === snapshotKey) {\n            value.cacheEntryTime = value.cacheEntryTime ?? Date.now();\n        }\n        const data: IVersionedValueWithEpoch = {\n            value,\n            version: persistedCacheValueVersion,\n            fluidEpoch: this._fluidEpoch,\n        };\n        return this.cache.put(this.fileEntryFromEntry(entry), data)\n            .catch((error) => {\n                this.logger.sendErrorEvent({ eventName: \"cachePutError\", type: entry.type }, error);\n                throw error;\n            });\n    }\n\n    public async removeEntries(): Promise<void> {\n        try {\n            return await this.cache.removeEntries(this.fileEntry);\n        } catch (error) {\n            this.logger.sendErrorEvent({ eventName: \"removeCacheEntries\" }, error);\n        }\n    }\n\n    public get fluidEpoch() {\n        return this._fluidEpoch;\n    }\n\n    public async validateEpochFromPush(details: IConnected) {\n        const epoch = details.epoch;\n        assert(epoch !== undefined, 0x09d /* \"Connection details should contain epoch\" */);\n        try {\n            this.validateEpochFromResponse(epoch, \"push\");\n        } catch (error) {\n            await this.checkForEpochError(error, epoch, \"push\");\n            throw error;\n        }\n    }\n\n    /**\n     * Api to fetch the response for given request and parse it as json.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     */\n    public async fetchAndParseAsJSON<T>(\n        url: string,\n        fetchOptions: RequestInit,\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ): Promise<IOdspResponse<T>> {\n        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);\n        // Add epoch in fetch request.\n        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);\n        let epochFromResponse: string | undefined;\n        return this.rateLimiter.schedule(\n            async () => fetchAndParseAsJSONHelper<T>(url, fetchOptions),\n        ).then((response) => {\n            epochFromResponse = response.headers.get(\"x-fluid-epoch\");\n            this.validateEpochFromResponse(epochFromResponse, fetchType);\n            response.commonSpoHeaders = {\n                ...response.commonSpoHeaders,\n                \"X-RequestStats\": clientCorrelationId,\n            };\n            return response;\n        }).catch(async (error) => {\n            // Get the server epoch from error in case we don't have it as if undefined we won't be able\n            // to mark it as epoch error.\n            if (epochFromResponse === undefined) {\n                epochFromResponse = (error as IOdspError).serverEpoch;\n            }\n            await this.checkForEpochError(error, epochFromResponse, fetchType);\n            throw error;\n        }).catch((error) => {\n            const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId }});\n            throw fluidError;\n        });\n    }\n\n    /**\n     * Api to fetch the response as it is for given request.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     */\n    public async fetchArray(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ) {\n        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);\n        // Add epoch in fetch request.\n        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);\n        let epochFromResponse: string | undefined;\n        return this.rateLimiter.schedule(\n            async () => fetchArray(url, fetchOptions),\n        ).then((response) => {\n            epochFromResponse = response.headers.get(\"x-fluid-epoch\");\n            this.validateEpochFromResponse(epochFromResponse, fetchType);\n            response.commonSpoHeaders = {\n                ...response.commonSpoHeaders,\n                \"X-RequestStats\": clientCorrelationId,\n            };\n            return response;\n        }).catch(async (error) => {\n            // Get the server epoch from error in case we don't have it as if undefined we won't be able\n            // to mark it as epoch error.\n            if (epochFromResponse === undefined) {\n                epochFromResponse = (error as IOdspError).serverEpoch;\n            }\n            await this.checkForEpochError(error, epochFromResponse, fetchType);\n            throw error;\n        }).catch((error) => {\n            const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId }});\n            throw fluidError;\n        });\n    }\n\n    private addEpochInRequest(\n        fetchOptions: RequestInit,\n        addInBody: boolean,\n        clientCorrelationId: string,\n    ) {\n        const isClpCompliantApp = getOdspResolvedUrl(this.fileEntry.resolvedUrl).isClpCompliantApp;\n        if (addInBody) {\n            const headers: {[key: string]: string} = {};\n            headers[\"X-RequestStats\"] = clientCorrelationId;\n            if (this.fluidEpoch !== undefined) {\n                headers[\"x-fluid-epoch\"] = this.fluidEpoch;\n            }\n            if (isClpCompliantApp) {\n                headers[ClpCompliantAppHeader.isClpCompliantApp] = isClpCompliantApp.toString();\n            }\n            this.addParamInBody(fetchOptions, headers);\n        } else {\n            const addHeader = (key: string, val: string) => {\n                fetchOptions.headers = {\n                    ...fetchOptions.headers,\n                };\n                assert(fetchOptions.headers !== undefined, 0x282 /* \"Headers should be present now\" */);\n                fetchOptions.headers[key] = val;\n            };\n            addHeader(\"X-RequestStats\", clientCorrelationId);\n            if (this.fluidEpoch !== undefined) {\n                addHeader(\"x-fluid-epoch\", this.fluidEpoch);\n            }\n            if (isClpCompliantApp) {\n                addHeader(ClpCompliantAppHeader.isClpCompliantApp, isClpCompliantApp.toString());\n            }\n        }\n    }\n\n    private addParamInBody(fetchOptions: RequestInit, headers: {[key: string]: string}) {\n        // We use multi part form request for post body where we want to use this.\n        // So extract the form boundary to mark the end of form.\n        const body = fetchOptions.body;\n        assert(typeof body === \"string\", 0x21d /* \"body is not string\" */);\n        const splitBody = body.split(\"\\r\\n\");\n        const firstLine = splitBody.shift();\n        assert(firstLine !== undefined && firstLine.startsWith(\"--\"), 0x21e /* \"improper boundary format\" */);\n        const formParams = [firstLine];\n        Object.entries(headers).forEach(([key, value]) => {\n            formParams.push(`${key}: ${value}`);\n        });\n        splitBody.forEach((value: string) => {\n            formParams.push(value);\n        });\n        fetchOptions.body = formParams.join(\"\\r\\n\");\n    }\n\n    private formatClientCorrelationId(fetchReason?: string) {\n        const items: string[] = [`driverId=${this.driverId}`, `RequestNumber=${this.networkCallNumber++}`];\n        if (fetchReason !== undefined) {\n            items.push(`fetchReason=${fetchReason}`);\n        }\n        return items.join(\", \");\n    }\n\n    protected validateEpochFromResponse(\n        epochFromResponse: string | undefined,\n        fetchType: FetchTypeInternal,\n        fromCache: boolean = false,\n    ) {\n        const error = this.checkForEpochErrorCore(epochFromResponse);\n        if (error !== undefined) {\n            throw error;\n        }\n        if (epochFromResponse !== undefined) {\n            if (this._fluidEpoch === undefined) {\n                this.setEpoch(epochFromResponse, fromCache, fetchType);\n            }\n        }\n    }\n\n    private async checkForEpochError(\n        error: unknown,\n        epochFromResponse: string | null | undefined,\n        fetchType: FetchTypeInternal,\n        fromCache: boolean = false,\n    ) {\n        if (isFluidError(error) && error.errorType === DriverErrorType.fileOverwrittenInStorage) {\n            const epochError = this.checkForEpochErrorCore(epochFromResponse);\n            if (epochError !== undefined) {\n                assert(isFluidError(epochError),\n                    0x21f /* \"epochError expected to be thrown by throwOdspNetworkError and of known type\" */);\n                epochError.addTelemetryProperties({\n                    fromCache,\n                    clientEpoch: this.fluidEpoch,\n                    fetchType,\n                });\n                this.logger.sendErrorEvent({ eventName: \"fileOverwrittenInStorage\" }, epochError);\n                // If the epoch mismatches, then clear all entries for such file entry from cache.\n                await this.removeEntries();\n                throw epochError;\n            }\n            // If it was categorized as epoch error but the epoch returned in response matches with the client epoch\n            // then it was coherency 409, so rethrow it as throttling error so that it can retried. Default throttling\n            // time is 1s.\n            throw new ThrottlingError(\"coherency409\", error.message, 1, { [Odsp409Error]: true });\n        }\n    }\n\n    private checkForEpochErrorCore(epochFromResponse: string | null | undefined) {\n        // If epoch is undefined, then don't compare it because initially for createNew or TreesLatest\n        // initializes this value. Sometimes response does not contain epoch as it is still in\n        // implementation phase at server side. In that case also, don't compare it with our epoch value.\n        if (this.fluidEpoch && epochFromResponse && (this.fluidEpoch !== epochFromResponse)) {\n            // This is similar in nature to how fluidEpochMismatchError (409) is handled.\n            // Difference - client detected mismatch, instead of server detecting it.\n            return new NonRetryableError(\"epochMismatch\", \"Epoch mismatch\", DriverErrorType.fileOverwrittenInStorage);\n        }\n    }\n\n    private fileEntryFromEntry(entry: IEntry): ICacheEntry {\n        return { ...entry, file: this.fileEntry };\n    }\n}\n\nexport class EpochTrackerWithRedemption extends EpochTracker {\n    private readonly treesLatestDeferral = new Deferred<void>();\n\n    protected validateEpochFromResponse(\n        epochFromResponse: string | undefined,\n        fetchType: FetchType,\n        fromCache: boolean = false,\n    ) {\n        super.validateEpochFromResponse(epochFromResponse, fetchType, fromCache);\n\n        // Any successful call means we have access to a file, i.e. any redemption that was required already happened.\n        // That covers cases of \"treesLatest\" as well as \"getVersions\" or \"createFile\" - all the ways we can start\n        // exploring a file.\n        this.treesLatestDeferral.resolve();\n    }\n\n    public async get(\n        entry: IEntry,\n    ): Promise<any> {\n        let result = super.get(entry);\n\n        // equivalence of what happens in fetchAndParseAsJSON()\n        if (entry.type === snapshotKey) {\n            result = result\n                .then((value) => {\n                    // If there is nothing in cache, we need to wait for network call to complete (and do redemption)\n                    // Otherwise file was redeemed in prior session, so if joinSession failed, we should not retry\n                    if (value !== undefined) {\n                        this.treesLatestDeferral.resolve();\n                    }\n                    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n                    return value;\n                })\n                .catch((error) => {\n                    this.treesLatestDeferral.reject(error);\n                    throw error;\n                });\n        }\n        return result;\n    }\n\n    public async fetchAndParseAsJSON<T>(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ): Promise<IOdspResponse<T>> {\n        // Optimize the flow if we know that treesLatestDeferral was already completed by the timer we started\n        // joinSession call. If we did - there is no reason to repeat the call as it will fail with same error.\n        const completed = this.treesLatestDeferral.isCompleted;\n\n        try {\n            return await super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody, fetchReason);\n        } catch (error) {\n            // Only handling here treesLatest. If createFile failed, we should never try to do joinSession.\n            // Similar, if getVersions failed, we should not do any further storage calls.\n            // So treesLatest is the only call that can have parallel joinSession request.\n            if (fetchType === \"treesLatest\") {\n                this.treesLatestDeferral.reject(error);\n            }\n            if (fetchType !== \"joinSession\" || error.statusCode < 401 || error.statusCode > 404 || completed) {\n                throw error;\n            }\n        }\n\n        // It is joinSession failing with 401..404 error\n        // Repeat after waiting for treeLatest succeeding (or fail if it failed).\n        // No special handling after first call - if file has been deleted, then it's game over.\n\n        // Ensure we have some safety here - we do not want to deadlock if we got logic somewhere wrong.\n        // If we waited too long, we will log error event and proceed with call.\n        // It may result in failure for user, but refreshing document would address it.\n        // Thus we use rather long timeout (not to get these failures as much as possible), but not large enough\n        // to unblock the process.\n        await PerformanceEvent.timedExecAsync(\n            this.logger,\n            { eventName: \"JoinSessionSyncWait\" },\n            async (event) => {\n                const timeoutRes = 51; // anything will work here\n                let timer: ReturnType<typeof setTimeout>;\n                const timeoutP = new Promise<number>((resolve) => {\n                    timer = setTimeout(() => { resolve(timeoutRes); }, 15000);\n                });\n                const res = await Promise.race([\n                    timeoutP,\n                    // cancel timeout to unblock UTs (otherwise Node process does not exit for 15 sec)\n                    this.treesLatestDeferral.promise.finally(() => clearTimeout(timer))]);\n                if (res === timeoutRes) {\n                    event.cancel();\n                }\n            },\n            { start: true, end: true, cancel: \"generic\" });\n        return super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody);\n    }\n}\n\nexport interface ICacheAndTracker {\n    cache: IOdspCache;\n    epochTracker: EpochTracker;\n}\n\nexport function createOdspCacheAndTracker(\n    persistedCacheArg: IPersistedCache,\n    nonpersistentCache: INonPersistentCache,\n    fileEntry: IFileEntry,\n    logger: ITelemetryLogger): ICacheAndTracker\n{\n    const epochTracker = new EpochTrackerWithRedemption(persistedCacheArg, fileEntry, logger);\n    return {\n        cache: {\n            ...nonpersistentCache,\n            persistedCache: epochTracker,\n        },\n        epochTracker,\n    };\n}\n"]}
+{"version":3,"file":"epochTracker.js","sourceRoot":"","sources":["../src/epochTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAE/F,OAAO,EACH,WAAW,GAMd,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjG,OAAO,EAAE,yBAAyB,EAAE,UAAU,EAAE,kBAAkB,EAAiB,MAAM,aAAa,CAAC;AAMvG,OAAO,EAA4B,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACnF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAO1D,MAAM,CAAC,MAAM,YAAY,GAAG,cAAc,CAAC;AAE3C,0GAA0G;AAC1G,MAAM,CAAC,MAAM,2BAA2B,GAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAOrB,YACuB,KAAsB,EACtB,SAAqB,EACrB,MAAwB;QAFxB,UAAK,GAAL,KAAK,CAAiB;QACtB,cAAS,GAAT,SAAS,CAAY;QACrB,WAAM,GAAN,MAAM,CAAkB;QAN9B,aAAQ,GAAG,IAAI,EAAE,CAAC;QACnC,8DAA8D;QACtD,sBAAiB,GAAG,CAAC,CAAC;QAM1B,sDAAsD;QACtD,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,+BAA+B;IACxB,QAAQ,CAAC,KAAa,EAAE,SAAkB,EAAE,SAA4B;QAC3E,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACnE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;YACI,SAAS,EAAE,uBAAuB;YAClC,KAAK;YACL,SAAS;YACT,SAAS;SACZ,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,GAAG,CACZ,KAAa;;QAEb,IAAI;YACA,8FAA8F;YAC9F,MAAM,KAAK,GAA6B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7F,0EAA0E;YAC1E,sCAAsC;YACtC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,0BAA0B,EAAE;gBACrE,OAAO,SAAS,CAAC;aACpB;YACD,MAAM,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;YACrF,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBACnD,4FAA4F;gBAC5F,qCAAqC;aACpC;iBAAM,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,UAAU,EAAE;gBAC9C,OAAO,SAAS,CAAC;aACpB;YACD,gGAAgG;YAChG,wDAAwD;YACxD,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;gBAC5B,MAAM,SAAS,SAAG,KAAK,CAAC,KAAK,0CAAE,cAAc,CAAC;gBAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,IAAI,SAAS,KAAK,SAAS,IAAI,WAAW,GAAG,SAAS,IAAI,2BAA2B,EAAE;oBACnF,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;wBACI,SAAS,EAAE,0BAA0B;wBACrC,QAAQ,EAAE,WAAW,GAAG,SAAS;wBACjC,aAAa,EAAE,2BAA2B;qBAC7C,CAAC,CAAC;oBACP,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;oBAC3B,OAAO,SAAS,CAAC;iBACpB;aACJ;YACD,+DAA+D;YAC/D,OAAO,KAAK,CAAC,KAAK,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YACtF,OAAO,SAAS,CAAC;SACpB;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAa,EAAE,KAAU;;QACtC,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC/D,uGAAuG;QACvG,wCAAwC;QACxC,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;YAC5B,KAAK,CAAC,cAAc,SAAG,KAAK,CAAC,cAAc,mCAAI,IAAI,CAAC,GAAG,EAAE,CAAC;SAC7D;QACD,MAAM,IAAI,GAA6B;YACnC,KAAK;YACL,OAAO,EAAE,0BAA0B;YACnC,UAAU,EAAE,IAAI,CAAC,WAAW;SAC/B,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;aACtD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YACpF,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;IAEM,KAAK,CAAC,aAAa;QACtB,IAAI;YACA,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACzD;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,oBAAoB,EAAE,EAAE,KAAK,CAAC,CAAC;SAC1E;IACL,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,OAAmB;QAClD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnF,IAAI;YACA,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;SACjD;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YACpD,MAAM,KAAK,CAAC;SACf;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,mBAAmB,CAC5B,GAAW,EACX,YAAyB,EACzB,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QACxE,8BAA8B;QAC9B,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,iBAAqC,CAAC;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC5B,KAAK,IAAI,EAAE,CAAC,yBAAyB,CAAI,GAAG,EAAE,YAAY,CAAC,CAC9D,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,iBAAiB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC1D,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;YAC7D,QAAQ,CAAC,UAAU,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;YAC9D,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,4FAA4F;YAC5F,6BAA6B;YAC7B,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACjC,iBAAiB,GAAI,KAAoB,CAAC,WAAW,CAAC;aACzD;YACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;YACnE,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAC;YACjG,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACnB,GAAW,EACX,YAAoC,EACpC,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QACxE,8BAA8B;QAC9B,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,iBAAqC,CAAC;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC5B,KAAK,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,CAAC,CAC5C,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,iBAAiB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC1D,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;YAC7D,QAAQ,CAAC,UAAU,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;YAC9D,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,4FAA4F;YAC5F,6BAA6B;YAC7B,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACjC,iBAAiB,GAAI,KAAoB,CAAC,WAAW,CAAC;aACzD;YACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;YACnE,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAC;YACjG,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,iBAAiB,CACrB,YAAyB,EACzB,SAAkB,EAClB,mBAA2B;QAE3B,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC;QAC3F,IAAI,SAAS,EAAE;YACX,MAAM,OAAO,GAA4B,EAAE,CAAC;YAC5C,OAAO,CAAC,gBAAgB,CAAC,GAAG,mBAAmB,CAAC;YAChD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9C;YACD,IAAI,iBAAiB,EAAE;gBACnB,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;aACnF;YACD,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;SAC9C;aAAM;YACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;gBAC3C,YAAY,CAAC,OAAO,qBACb,YAAY,CAAC,OAAO,CAC1B,CAAC;gBACF,MAAM,CAAC,YAAY,CAAC,OAAO,KAAK,SAAS,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;gBACxF,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YACpC,CAAC,CAAC;YACF,SAAS,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;YACjD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;aAC/C;YACD,IAAI,iBAAiB,EAAE;gBACnB,SAAS,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;aACpF;SACJ;IACL,CAAC;IAEO,cAAc,CAAC,YAAyB,EAAE,OAAgC;QAC9E,0EAA0E;QAC1E,wDAAwD;QACxD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC/B,MAAM,CAAC,OAAO,IAAI,KAAK,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;QACpC,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtG,MAAM,UAAU,GAAG,CAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,UAAU,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;YAChC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEO,yBAAyB,CAAC,WAAoB;QAClD,MAAM,KAAK,GAAa,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE,EAAE,iBAAiB,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QACnG,IAAI,WAAW,KAAK,SAAS,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,eAAe,WAAW,EAAE,CAAC,CAAC;SAC5C;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAES,yBAAyB,CAC/B,iBAAqC,EACrC,SAA4B,EAC5B,YAAqB,KAAK;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAC7D,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,MAAM,KAAK,CAAC;SACf;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;aAC1D;SACJ;IACL,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC5B,KAAc,EACd,iBAA4C,EAC5C,SAA4B,EAC5B,YAAqB,KAAK;QAE1B,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,KAAK,eAAe,CAAC,wBAAwB,EAAE;YACrF,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;YAClE,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,EAC3B,KAAK,CAAC,mFAAmF,CAAC,CAAC;gBAC/F,UAAU,CAAC,sBAAsB,CAAC;oBAC9B,SAAS;oBACT,WAAW,EAAE,IAAI,CAAC,UAAU;oBAC5B,SAAS;iBACZ,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAAE,UAAU,CAAC,CAAC;gBAClF,kFAAkF;gBAClF,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,MAAM,UAAU,CAAC;aACpB;YACD,wGAAwG;YACxG,0GAA0G;YAC1G,cAAc;YACd,MAAM,IAAI,eAAe,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;SACzF;IACL,CAAC;IAEO,sBAAsB,CAAC,iBAA4C;QACvE,8FAA8F;QAC9F,sFAAsF;QACtF,iGAAiG;QACjG,IAAI,IAAI,CAAC,UAAU,IAAI,iBAAiB,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,iBAAiB,CAAC,EAAE;YACjF,6EAA6E;YAC7E,yEAAyE;YACzE,OAAO,IAAI,iBAAiB,CAAC,eAAe,EAAE,gBAAgB,EAAE,eAAe,CAAC,wBAAwB,CAAC,CAAC;SAC7G;IACL,CAAC;IAEO,kBAAkB,CAAC,KAAa;QACpC,uCAAY,KAAK,KAAE,IAAI,EAAE,IAAI,CAAC,SAAS,IAAG;IAC9C,CAAC;CACJ;AAED,MAAM,OAAO,0BAA2B,SAAQ,YAAY;IAA5D;;QACqB,wBAAmB,GAAG,IAAI,QAAQ,EAAQ,CAAC;IA8FhE,CAAC;IA5Fa,yBAAyB,CAC/B,iBAAqC,EACrC,SAAoB,EACpB,YAAqB,KAAK;QAE1B,KAAK,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAEzE,8GAA8G;QAC9G,0GAA0G;QAC1G,oBAAoB;QACpB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,GAAG,CACZ,KAAa;QAEb,IAAI,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAE9B,uDAAuD;QACvD,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;YAC5B,MAAM,GAAG,MAAM;iBACV,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACZ,iGAAiG;gBACjG,8FAA8F;gBAC9F,IAAI,KAAK,KAAK,SAAS,EAAE;oBACrB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;iBACtC;gBACD,+DAA+D;gBAC/D,OAAO,KAAK,CAAC;YACjB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACb,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvC,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;SACV;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC5B,GAAW,EACX,YAAoC,EACpC,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,sGAAsG;QACtG,uGAAuG;QACvG,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC;QAEvD,IAAI;YACA,OAAO,MAAM,KAAK,CAAC,mBAAmB,CAAI,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;SACnG;QAAC,OAAO,KAAK,EAAE;YACZ,+FAA+F;YAC/F,8EAA8E;YAC9E,8EAA8E;YAC9E,IAAI,SAAS,KAAK,aAAa,EAAE;gBAC7B,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC1C;YACD,IAAI,SAAS,KAAK,aAAa,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,SAAS,EAAE;gBAC9F,MAAM,KAAK,CAAC;aACf;SACJ;QAED,gDAAgD;QAChD,yEAAyE;QACzE,wFAAwF;QAExF,gGAAgG;QAChG,wEAAwE;QACxE,+EAA+E;QAC/E,wGAAwG;QACxG,0BAA0B;QAC1B,MAAM,gBAAgB,CAAC,cAAc,CACjC,IAAI,CAAC,MAAM,EACX,EAAE,SAAS,EAAE,qBAAqB,EAAE,EACpC,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,0BAA0B;YACjD,IAAI,KAAoC,CAAC;YACzC,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;gBAC7C,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;gBAC3B,QAAQ;gBACR,kFAAkF;gBAClF,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;aAAC,CAAC,CAAC;YAC1E,IAAI,GAAG,KAAK,UAAU,EAAE;gBACpB,KAAK,CAAC,MAAM,EAAE,CAAC;aAClB;QACL,CAAC,EACD,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACnD,OAAO,KAAK,CAAC,mBAAmB,CAAI,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACjF,CAAC;CACJ;AAOD,MAAM,UAAU,yBAAyB,CACrC,iBAAkC,EAClC,kBAAuC,EACvC,SAAqB,EACrB,MAAwB;IAExB,MAAM,YAAY,GAAG,IAAI,0BAA0B,CAAC,iBAAiB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1F,OAAO;QACH,KAAK,kCACE,kBAAkB,KACrB,cAAc,EAAE,YAAY,GAC/B;QACD,YAAY;KACf,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ThrottlingError, RateLimiter, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { IConnected } from \"@fluidframework/protocol-definitions\";\nimport {\n    snapshotKey,\n    ICacheEntry,\n    IEntry,\n    IFileEntry,\n    IPersistedCache,\n    IOdspError,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { PerformanceEvent, isFluidError, normalizeError } from \"@fluidframework/telemetry-utils\";\nimport { fetchAndParseAsJSONHelper, fetchArray, getOdspResolvedUrl, IOdspResponse } from \"./odspUtils\";\nimport {\n    IOdspCache,\n    INonPersistentCache,\n    IPersistedFileCache,\n } from \"./odspCache\";\nimport { IVersionedValueWithEpoch, persistedCacheValueVersion } from \"./contracts\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\n\nexport type FetchType = \"blob\" | \"createBlob\" | \"createFile\" | \"joinSession\" | \"ops\" | \"test\" | \"snapshotTree\" |\n    \"treesLatest\" | \"uploadSummary\" | \"push\" | \"versions\";\n\nexport type FetchTypeInternal = FetchType | \"cache\";\n\nexport const Odsp409Error = \"Odsp409Error\";\n\n// Please update the README file in odsp-driver-definitions if you change the defaultCacheExpiryTimeoutMs.\nexport const defaultCacheExpiryTimeoutMs: number = 2 * 24 * 60 * 60 * 1000;\n\n/**\n * This class is a wrapper around fetch calls. It adds epoch to the request made so that the\n * server can match it with its epoch value in order to match the version.\n * It also validates the epoch value received in response of fetch calls. If the epoch does not match,\n * then it also clears all the cached entries for the given container.\n */\nexport class EpochTracker implements IPersistedFileCache {\n    private _fluidEpoch: string | undefined;\n\n    public readonly rateLimiter: RateLimiter;\n    private readonly driverId = uuid();\n    // This tracks the request number made by the driver instance.\n    private networkCallNumber = 1;\n    constructor(\n        protected readonly cache: IPersistedCache,\n        protected readonly fileEntry: IFileEntry,\n        protected readonly logger: ITelemetryLogger,\n    ) {\n        // Limits the max number of concurrent requests to 24.\n        this.rateLimiter = new RateLimiter(24);\n    }\n\n    // public for UT purposes only!\n    public setEpoch(epoch: string, fromCache: boolean, fetchType: FetchTypeInternal) {\n        assert(this._fluidEpoch === undefined, 0x1db /* \"epoch exists\" */);\n        this._fluidEpoch = epoch;\n\n        this.logger.sendTelemetryEvent(\n            {\n                eventName: \"EpochLearnedFirstTime\",\n                epoch,\n                fetchType,\n                fromCache,\n            },\n        );\n    }\n\n    public async get(\n        entry: IEntry,\n    ): Promise<any> {\n        try {\n            // Return undefined so that the ops/snapshots are grabbed from the server instead of the cache\n            const value: IVersionedValueWithEpoch = await this.cache.get(this.fileEntryFromEntry(entry));\n            // Version mismatch between what the runtime expects and what it recieved.\n            // The cached value should not be used\n            if (value === undefined || value.version !== persistedCacheValueVersion) {\n                return undefined;\n            }\n            assert(value.fluidEpoch !== undefined, 0x1dc /* \"all entries have to have epoch\" */);\n            if (this._fluidEpoch === undefined) {\n                this.setEpoch(value.fluidEpoch, true, \"cache\");\n            // Epoch mismatch, the cached value is considerably different from what the current state of\n            // the runtime and should not be used\n            } else if (this._fluidEpoch !== value.fluidEpoch) {\n                return undefined;\n            }\n            // Expire the cached snapshot if it's older than the defaultCacheExpiryTimeoutMs and immediately\n            // expire all old caches that do not have cacheEntryTime\n            if (entry.type === snapshotKey) {\n                const cacheTime = value.value?.cacheEntryTime;\n                const currentTime = Date.now();\n                if (cacheTime === undefined || currentTime - cacheTime >= defaultCacheExpiryTimeoutMs) {\n                    this.logger.sendTelemetryEvent(\n                        {\n                            eventName: \"odspVersionsCacheExpired\",\n                            duration: currentTime - cacheTime,\n                            maxCacheAgeMs: defaultCacheExpiryTimeoutMs,\n                        });\n                    await this.removeEntries();\n                    return undefined;\n                }\n            }\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return value.value;\n        } catch (error) {\n            this.logger.sendErrorEvent({ eventName: \"cacheFetchError\", type: entry.type }, error);\n            return undefined;\n        }\n    }\n\n    public async put(entry: IEntry, value: any) {\n        assert(this._fluidEpoch !== undefined, 0x1dd /* \"no epoch\" */);\n        // For snapshots, the value should have the cacheEntryTime. This will be used to expire snapshots older\n        // than the defaultCacheExpiryTimeoutMs.\n        if (entry.type === snapshotKey) {\n            value.cacheEntryTime = value.cacheEntryTime ?? Date.now();\n        }\n        const data: IVersionedValueWithEpoch = {\n            value,\n            version: persistedCacheValueVersion,\n            fluidEpoch: this._fluidEpoch,\n        };\n        return this.cache.put(this.fileEntryFromEntry(entry), data)\n            .catch((error) => {\n                this.logger.sendErrorEvent({ eventName: \"cachePutError\", type: entry.type }, error);\n                throw error;\n            });\n    }\n\n    public async removeEntries(): Promise<void> {\n        try {\n            return await this.cache.removeEntries(this.fileEntry);\n        } catch (error) {\n            this.logger.sendErrorEvent({ eventName: \"removeCacheEntries\" }, error);\n        }\n    }\n\n    public get fluidEpoch() {\n        return this._fluidEpoch;\n    }\n\n    public async validateEpochFromPush(details: IConnected) {\n        const epoch = details.epoch;\n        assert(epoch !== undefined, 0x09d /* \"Connection details should contain epoch\" */);\n        try {\n            this.validateEpochFromResponse(epoch, \"push\");\n        } catch (error) {\n            await this.checkForEpochError(error, epoch, \"push\");\n            throw error;\n        }\n    }\n\n    /**\n     * Api to fetch the response for given request and parse it as json.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     */\n    public async fetchAndParseAsJSON<T>(\n        url: string,\n        fetchOptions: RequestInit,\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ): Promise<IOdspResponse<T>> {\n        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);\n        // Add epoch in fetch request.\n        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);\n        let epochFromResponse: string | undefined;\n        return this.rateLimiter.schedule(\n            async () => fetchAndParseAsJSONHelper<T>(url, fetchOptions),\n        ).then((response) => {\n            epochFromResponse = response.headers.get(\"x-fluid-epoch\");\n            this.validateEpochFromResponse(epochFromResponse, fetchType);\n            response.propsToLog.XRequestStatsHeader = clientCorrelationId;\n            return response;\n        }).catch(async (error) => {\n            // Get the server epoch from error in case we don't have it as if undefined we won't be able\n            // to mark it as epoch error.\n            if (epochFromResponse === undefined) {\n                epochFromResponse = (error as IOdspError).serverEpoch;\n            }\n            await this.checkForEpochError(error, epochFromResponse, fetchType);\n            throw error;\n        }).catch((error) => {\n            const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId }});\n            throw fluidError;\n        });\n    }\n\n    /**\n     * Api to fetch the response as it is for given request.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     */\n    public async fetchArray(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ) {\n        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);\n        // Add epoch in fetch request.\n        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);\n        let epochFromResponse: string | undefined;\n        return this.rateLimiter.schedule(\n            async () => fetchArray(url, fetchOptions),\n        ).then((response) => {\n            epochFromResponse = response.headers.get(\"x-fluid-epoch\");\n            this.validateEpochFromResponse(epochFromResponse, fetchType);\n            response.propsToLog.XRequestStatsHeader = clientCorrelationId;\n            return response;\n        }).catch(async (error) => {\n            // Get the server epoch from error in case we don't have it as if undefined we won't be able\n            // to mark it as epoch error.\n            if (epochFromResponse === undefined) {\n                epochFromResponse = (error as IOdspError).serverEpoch;\n            }\n            await this.checkForEpochError(error, epochFromResponse, fetchType);\n            throw error;\n        }).catch((error) => {\n            const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId }});\n            throw fluidError;\n        });\n    }\n\n    private addEpochInRequest(\n        fetchOptions: RequestInit,\n        addInBody: boolean,\n        clientCorrelationId: string,\n    ) {\n        const isClpCompliantApp = getOdspResolvedUrl(this.fileEntry.resolvedUrl).isClpCompliantApp;\n        if (addInBody) {\n            const headers: {[key: string]: string} = {};\n            headers[\"X-RequestStats\"] = clientCorrelationId;\n            if (this.fluidEpoch !== undefined) {\n                headers[\"x-fluid-epoch\"] = this.fluidEpoch;\n            }\n            if (isClpCompliantApp) {\n                headers[ClpCompliantAppHeader.isClpCompliantApp] = isClpCompliantApp.toString();\n            }\n            this.addParamInBody(fetchOptions, headers);\n        } else {\n            const addHeader = (key: string, val: string) => {\n                fetchOptions.headers = {\n                    ...fetchOptions.headers,\n                };\n                assert(fetchOptions.headers !== undefined, 0x282 /* \"Headers should be present now\" */);\n                fetchOptions.headers[key] = val;\n            };\n            addHeader(\"X-RequestStats\", clientCorrelationId);\n            if (this.fluidEpoch !== undefined) {\n                addHeader(\"x-fluid-epoch\", this.fluidEpoch);\n            }\n            if (isClpCompliantApp) {\n                addHeader(ClpCompliantAppHeader.isClpCompliantApp, isClpCompliantApp.toString());\n            }\n        }\n    }\n\n    private addParamInBody(fetchOptions: RequestInit, headers: {[key: string]: string}) {\n        // We use multi part form request for post body where we want to use this.\n        // So extract the form boundary to mark the end of form.\n        const body = fetchOptions.body;\n        assert(typeof body === \"string\", 0x21d /* \"body is not string\" */);\n        const splitBody = body.split(\"\\r\\n\");\n        const firstLine = splitBody.shift();\n        assert(firstLine !== undefined && firstLine.startsWith(\"--\"), 0x21e /* \"improper boundary format\" */);\n        const formParams = [firstLine];\n        Object.entries(headers).forEach(([key, value]) => {\n            formParams.push(`${key}: ${value}`);\n        });\n        splitBody.forEach((value: string) => {\n            formParams.push(value);\n        });\n        fetchOptions.body = formParams.join(\"\\r\\n\");\n    }\n\n    private formatClientCorrelationId(fetchReason?: string) {\n        const items: string[] = [`driverId=${this.driverId}`, `RequestNumber=${this.networkCallNumber++}`];\n        if (fetchReason !== undefined) {\n            items.push(`fetchReason=${fetchReason}`);\n        }\n        return items.join(\", \");\n    }\n\n    protected validateEpochFromResponse(\n        epochFromResponse: string | undefined,\n        fetchType: FetchTypeInternal,\n        fromCache: boolean = false,\n    ) {\n        const error = this.checkForEpochErrorCore(epochFromResponse);\n        if (error !== undefined) {\n            throw error;\n        }\n        if (epochFromResponse !== undefined) {\n            if (this._fluidEpoch === undefined) {\n                this.setEpoch(epochFromResponse, fromCache, fetchType);\n            }\n        }\n    }\n\n    private async checkForEpochError(\n        error: unknown,\n        epochFromResponse: string | null | undefined,\n        fetchType: FetchTypeInternal,\n        fromCache: boolean = false,\n    ) {\n        if (isFluidError(error) && error.errorType === DriverErrorType.fileOverwrittenInStorage) {\n            const epochError = this.checkForEpochErrorCore(epochFromResponse);\n            if (epochError !== undefined) {\n                assert(isFluidError(epochError),\n                    0x21f /* \"epochError expected to be thrown by throwOdspNetworkError and of known type\" */);\n                epochError.addTelemetryProperties({\n                    fromCache,\n                    clientEpoch: this.fluidEpoch,\n                    fetchType,\n                });\n                this.logger.sendErrorEvent({ eventName: \"fileOverwrittenInStorage\" }, epochError);\n                // If the epoch mismatches, then clear all entries for such file entry from cache.\n                await this.removeEntries();\n                throw epochError;\n            }\n            // If it was categorized as epoch error but the epoch returned in response matches with the client epoch\n            // then it was coherency 409, so rethrow it as throttling error so that it can retried. Default throttling\n            // time is 1s.\n            throw new ThrottlingError(\"coherency409\", error.message, 1, { [Odsp409Error]: true });\n        }\n    }\n\n    private checkForEpochErrorCore(epochFromResponse: string | null | undefined) {\n        // If epoch is undefined, then don't compare it because initially for createNew or TreesLatest\n        // initializes this value. Sometimes response does not contain epoch as it is still in\n        // implementation phase at server side. In that case also, don't compare it with our epoch value.\n        if (this.fluidEpoch && epochFromResponse && (this.fluidEpoch !== epochFromResponse)) {\n            // This is similar in nature to how fluidEpochMismatchError (409) is handled.\n            // Difference - client detected mismatch, instead of server detecting it.\n            return new NonRetryableError(\"epochMismatch\", \"Epoch mismatch\", DriverErrorType.fileOverwrittenInStorage);\n        }\n    }\n\n    private fileEntryFromEntry(entry: IEntry): ICacheEntry {\n        return { ...entry, file: this.fileEntry };\n    }\n}\n\nexport class EpochTrackerWithRedemption extends EpochTracker {\n    private readonly treesLatestDeferral = new Deferred<void>();\n\n    protected validateEpochFromResponse(\n        epochFromResponse: string | undefined,\n        fetchType: FetchType,\n        fromCache: boolean = false,\n    ) {\n        super.validateEpochFromResponse(epochFromResponse, fetchType, fromCache);\n\n        // Any successful call means we have access to a file, i.e. any redemption that was required already happened.\n        // That covers cases of \"treesLatest\" as well as \"getVersions\" or \"createFile\" - all the ways we can start\n        // exploring a file.\n        this.treesLatestDeferral.resolve();\n    }\n\n    public async get(\n        entry: IEntry,\n    ): Promise<any> {\n        let result = super.get(entry);\n\n        // equivalence of what happens in fetchAndParseAsJSON()\n        if (entry.type === snapshotKey) {\n            result = result\n                .then((value) => {\n                    // If there is nothing in cache, we need to wait for network call to complete (and do redemption)\n                    // Otherwise file was redeemed in prior session, so if joinSession failed, we should not retry\n                    if (value !== undefined) {\n                        this.treesLatestDeferral.resolve();\n                    }\n                    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n                    return value;\n                })\n                .catch((error) => {\n                    this.treesLatestDeferral.reject(error);\n                    throw error;\n                });\n        }\n        return result;\n    }\n\n    public async fetchAndParseAsJSON<T>(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ): Promise<IOdspResponse<T>> {\n        // Optimize the flow if we know that treesLatestDeferral was already completed by the timer we started\n        // joinSession call. If we did - there is no reason to repeat the call as it will fail with same error.\n        const completed = this.treesLatestDeferral.isCompleted;\n\n        try {\n            return await super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody, fetchReason);\n        } catch (error) {\n            // Only handling here treesLatest. If createFile failed, we should never try to do joinSession.\n            // Similar, if getVersions failed, we should not do any further storage calls.\n            // So treesLatest is the only call that can have parallel joinSession request.\n            if (fetchType === \"treesLatest\") {\n                this.treesLatestDeferral.reject(error);\n            }\n            if (fetchType !== \"joinSession\" || error.statusCode < 401 || error.statusCode > 404 || completed) {\n                throw error;\n            }\n        }\n\n        // It is joinSession failing with 401..404 error\n        // Repeat after waiting for treeLatest succeeding (or fail if it failed).\n        // No special handling after first call - if file has been deleted, then it's game over.\n\n        // Ensure we have some safety here - we do not want to deadlock if we got logic somewhere wrong.\n        // If we waited too long, we will log error event and proceed with call.\n        // It may result in failure for user, but refreshing document would address it.\n        // Thus we use rather long timeout (not to get these failures as much as possible), but not large enough\n        // to unblock the process.\n        await PerformanceEvent.timedExecAsync(\n            this.logger,\n            { eventName: \"JoinSessionSyncWait\" },\n            async (event) => {\n                const timeoutRes = 51; // anything will work here\n                let timer: ReturnType<typeof setTimeout>;\n                const timeoutP = new Promise<number>((resolve) => {\n                    timer = setTimeout(() => { resolve(timeoutRes); }, 15000);\n                });\n                const res = await Promise.race([\n                    timeoutP,\n                    // cancel timeout to unblock UTs (otherwise Node process does not exit for 15 sec)\n                    this.treesLatestDeferral.promise.finally(() => clearTimeout(timer))]);\n                if (res === timeoutRes) {\n                    event.cancel();\n                }\n            },\n            { start: true, end: true, cancel: \"generic\" });\n        return super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody);\n    }\n}\n\nexport interface ICacheAndTracker {\n    cache: IOdspCache;\n    epochTracker: EpochTracker;\n}\n\nexport function createOdspCacheAndTracker(\n    persistedCacheArg: IPersistedCache,\n    nonpersistentCache: INonPersistentCache,\n    fileEntry: IFileEntry,\n    logger: ITelemetryLogger): ICacheAndTracker\n{\n    const epochTracker = new EpochTrackerWithRedemption(persistedCacheArg, fileEntry, logger);\n    return {\n        cache: {\n            ...nonpersistentCache,\n            persistedCache: epochTracker,\n        },\n        epochTracker,\n    };\n}\n"]}

package/lib/fetchSnapshot.js

@@ -187,7 +187,7 @@ async function fetchLatestSnapshotCore(odspResolvedUrl, storageTokenFetcher, sna
                 // 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.commonSpoHeaders));
+                sltelemetry: response.odspSnapshotResponse.headers.get("x-fluid-sltelemetry") }, response.odspSnapshotResponse.propsToLog));
             return snapshot;
         }).catch((error) => {
             // We hit these errors in stress tests, under load