@fluidframework/odsp-driver 0.59.1000 → 0.59.2000-63294

package/lib/prefetchLatestSnapshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"prefetchLatestSnapshot.js","sourceRoot":"","sources":["../src/prefetchLatestSnapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAUtD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EACH,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,8BAA8B,GACjC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAG5E;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CACxC,WAAyB,EACzB,eAA4D,EAC5D,cAA+B,EAC/B,sCAA+C,EAC/C,MAA4B,EAC5B,wBAAsD,EACtD,oBAA8B,EAC9B,yBAAmC;IAEnC,MAAM,UAAU,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;IACpF,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAExD,MAAM,eAAe,GAAkB;QACnC,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,MAAM,EAAE,eAAe,CAAC,MAAM;KACjC,CAAC;IACF,MAAM,mBAAmB,GAAG,8BAA8B,CACtD,UAAU,EACV,eAAe,EACf,eAAe,EACf,IAAI,CAAC,sBAAsB,CAC9B,CAAC;IAEF,MAAM,kBAAkB,GAAG,KAAK,EAC5B,oBAAsC,EACtC,YAAoB,EACpB,eAA6C,EAC7C,UAA4B,EAC9B,EAAE;QACA,OAAO,gBAAgB,CACnB,oBAAoB,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,yBAAyB,EAAE,UAAU,CAAC,CAAC;IAChH,CAAC,CAAC;IACF,MAAM,WAAW,GAAG,sBAAsB,CAAC,eAAe,CAAC,CAAC;IAC5D,IAAI,MAAiC,CAAC;IACtC,MAAM,UAAU,GAAG,KAAK,EAAE,cAAwC,EAAE,EAAE;QAClE,MAAM,GAAG,cAAc,CAAC,GAAG,CACvB,WAAW,EACX,cAAc,CACjB,CAAC;QACF,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACjF,OAAO,gBAAgB,CAAC,cAAc,CAClC,UAAU,EACV,EAAE,SAAS,EAAE,wBAAwB,EAAE,EACvC,KAAK,IAAI,EAAE;QACP,MAAM,uBAAuB,CACrB,eAAe,EACf,mBAAmB,EACnB,wBAAwB,EACxB,sCAAsC,EACtC,UAAU,EACV,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,oBAAoB,CACvB,CAAC;QACN,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACvE,MAAM,MAAM,CAAC;QACb,OAAO,IAAI,CAAC;IACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { default as AbortController } from \"abort-controller\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspResolvedUrl,\n    IPersistedCache,\n    ISnapshotOptions,\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n    IOdspUrlParts,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { ChildLogger, PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    createCacheSnapshotKey,\n    createOdspLogger,\n    getOdspResolvedUrl,\n    toInstrumentedOdspTokenFetcher,\n} from \"./odspUtils\";\nimport { downloadSnapshot, fetchSnapshotWithRedeem } from \"./fetchSnapshot\";\nimport { IVersionedValueWithEpoch } from \"./contracts\";\n\n/**\n * Function to prefetch the snapshot and cached it in the persistant cache, so that when the container is loaded\n * the cached latest snapshot could be used and removes the network call from the critical path.\n * @param resolvedUrl - Resolved url to fetch the snapshot.\n * @param getStorageToken - function that can provide the storage token for a given site. This is\n *  is also referred to as the \"VROOM\" token in SPO.\n * @param persistedCache - Cache to store the fetched snapshot.\n * @param forceAccessTokenViaAuthorizationHeader - whether to force passing given token via authorization header.\n * @param logger - Logger to have telemetry events.\n * @param hostSnapshotFetchOptions - Options to fetch the snapshot if any. Otherwise default will be used.\n * @param enableRedeemFallback - True to have the sharing link redeem fallback in case the Trees Latest/Redeem\n *  1RT call fails with redeem error. During fallback it will first redeem the sharing link and then make\n *  the Trees latest call.\n * @returns - True if the snapshot is cached, false otherwise.\n */\nexport async function prefetchLatestSnapshot(\n    resolvedUrl: IResolvedUrl,\n    getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    persistedCache: IPersistedCache,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n    logger: ITelemetryBaseLogger,\n    hostSnapshotFetchOptions: ISnapshotOptions | undefined,\n    enableRedeemFallback?: boolean,\n    fetchBinarySnapshotFormat?: boolean,\n): Promise<boolean> {\n    const odspLogger = createOdspLogger(ChildLogger.create(logger, \"PrefetchSnapshot\"));\n    const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n\n    const resolvedUrlData: IOdspUrlParts = {\n        siteUrl: odspResolvedUrl.siteUrl,\n        driveId: odspResolvedUrl.driveId,\n        itemId: odspResolvedUrl.itemId,\n    };\n    const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n        odspLogger,\n        resolvedUrlData,\n        getStorageToken,\n        true /* throwOnNullToken */,\n    );\n\n    const snapshotDownloader = async (\n        finalOdspResolvedUrl: IOdspResolvedUrl,\n        storageToken: string,\n        snapshotOptions: ISnapshotOptions | undefined,\n        controller?: AbortController,\n    ) => {\n        return downloadSnapshot(\n            finalOdspResolvedUrl, storageToken, odspLogger, snapshotOptions, fetchBinarySnapshotFormat, controller);\n    };\n    const snapshotKey = createCacheSnapshotKey(odspResolvedUrl);\n    let cacheP: Promise<void> | undefined;\n    const putInCache = async (valueWithEpoch: IVersionedValueWithEpoch) => {\n        cacheP = persistedCache.put(\n            snapshotKey,\n            valueWithEpoch,\n        );\n        return cacheP;\n    };\n    const removeEntries = async () => persistedCache.removeEntries(snapshotKey.file);\n    return PerformanceEvent.timedExecAsync(\n        odspLogger,\n        { eventName: \"PrefetchLatestSnapshot\" },\n        async () => {\n            await fetchSnapshotWithRedeem(\n                    odspResolvedUrl,\n                    storageTokenFetcher,\n                    hostSnapshotFetchOptions,\n                    forceAccessTokenViaAuthorizationHeader,\n                    odspLogger,\n                    snapshotDownloader,\n                    putInCache,\n                    removeEntries,\n                    enableRedeemFallback,\n                );\n            assert(cacheP !== undefined, 0x1e7 /* \"caching was not performed!\" */);\n            await cacheP;\n            return true;\n    }).catch(async (error) => false);\n}\n"]}
+{"version":3,"file":"prefetchLatestSnapshot.js","sourceRoot":"","sources":["../src/prefetchLatestSnapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAUtD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EACH,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,8BAA8B,GACjC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAA6B,MAAM,iBAAiB,CAAC;AAGvG;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CACxC,WAAyB,EACzB,eAA4D,EAC5D,cAA+B,EAC/B,sCAA+C,EAC/C,MAA4B,EAC5B,wBAAsD,EACtD,oBAA8B,EAC9B,yBAAmC,EACnC,uBAAmD;IAEnD,MAAM,UAAU,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;IACpF,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAExD,MAAM,eAAe,GAAkB;QACnC,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,MAAM,EAAE,eAAe,CAAC,MAAM;KACjC,CAAC;IACF,MAAM,mBAAmB,GAAG,8BAA8B,CACtD,UAAU,EACV,eAAe,EACf,eAAe,EACf,IAAI,CAAC,sBAAsB,CAC9B,CAAC;IAEF,MAAM,kBAAkB,GAAG,KAAK,EAC5B,oBAAsC,EACtC,YAAoB,EACpB,eAA6C,EAC7C,UAA4B,EAC9B,EAAE;QACA,OAAO,gBAAgB,CACnB,oBAAoB,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,uBAAuB,EAAE,UAAU,CAAC,CAAC;IAC9G,CAAC,CAAC;IACF,MAAM,WAAW,GAAG,sBAAsB,CAAC,eAAe,CAAC,CAAC;IAC5D,IAAI,MAAiC,CAAC;IACtC,MAAM,UAAU,GAAG,KAAK,EAAE,cAAwC,EAAE,EAAE;QAClE,MAAM,GAAG,cAAc,CAAC,GAAG,CACvB,WAAW,EACX,cAAc,CACjB,CAAC;QACF,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACjF,OAAO,gBAAgB,CAAC,cAAc,CAClC,UAAU,EACV,EAAE,SAAS,EAAE,wBAAwB,EAAE,EACvC,KAAK,IAAI,EAAE;QACP,MAAM,uBAAuB,CACrB,eAAe,EACf,mBAAmB,EACnB,wBAAwB,EACxB,sCAAsC,EACtC,UAAU,EACV,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,oBAAoB,CACvB,CAAC;QACN,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACvE,MAAM,MAAM,CAAC;QACb,OAAO,IAAI,CAAC;IACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { default as AbortController } from \"abort-controller\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspResolvedUrl,\n    IPersistedCache,\n    ISnapshotOptions,\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n    IOdspUrlParts,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { ChildLogger, PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    createCacheSnapshotKey,\n    createOdspLogger,\n    getOdspResolvedUrl,\n    toInstrumentedOdspTokenFetcher,\n} from \"./odspUtils\";\nimport { downloadSnapshot, fetchSnapshotWithRedeem, SnapshotFormatSupportType } from \"./fetchSnapshot\";\nimport { IVersionedValueWithEpoch } from \"./contracts\";\n\n/**\n * Function to prefetch the snapshot and cached it in the persistant cache, so that when the container is loaded\n * the cached latest snapshot could be used and removes the network call from the critical path.\n * @param resolvedUrl - Resolved url to fetch the snapshot.\n * @param getStorageToken - function that can provide the storage token for a given site. This is\n *  is also referred to as the \"VROOM\" token in SPO.\n * @param persistedCache - Cache to store the fetched snapshot.\n * @param forceAccessTokenViaAuthorizationHeader - whether to force passing given token via authorization header.\n * @param logger - Logger to have telemetry events.\n * @param hostSnapshotFetchOptions - Options to fetch the snapshot if any. Otherwise default will be used.\n * @param enableRedeemFallback - True to have the sharing link redeem fallback in case the Trees Latest/Redeem\n *  1RT call fails with redeem error. During fallback it will first redeem the sharing link and then make\n *  the Trees latest call.\n *  @deprecated - This will be replaced with snapshotFormatFetchType.\n * @param fetchBinarySnapshotFormat - Control if we want to fetch binary format snapshot.\n * @param snapshotFormatFetchType - Snapshot format to fetch.\n * @returns - True if the snapshot is cached, false otherwise.\n */\nexport async function prefetchLatestSnapshot(\n    resolvedUrl: IResolvedUrl,\n    getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    persistedCache: IPersistedCache,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n    logger: ITelemetryBaseLogger,\n    hostSnapshotFetchOptions: ISnapshotOptions | undefined,\n    enableRedeemFallback?: boolean,\n    fetchBinarySnapshotFormat?: boolean,\n    snapshotFormatFetchType?: SnapshotFormatSupportType,\n): Promise<boolean> {\n    const odspLogger = createOdspLogger(ChildLogger.create(logger, \"PrefetchSnapshot\"));\n    const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n\n    const resolvedUrlData: IOdspUrlParts = {\n        siteUrl: odspResolvedUrl.siteUrl,\n        driveId: odspResolvedUrl.driveId,\n        itemId: odspResolvedUrl.itemId,\n    };\n    const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n        odspLogger,\n        resolvedUrlData,\n        getStorageToken,\n        true /* throwOnNullToken */,\n    );\n\n    const snapshotDownloader = async (\n        finalOdspResolvedUrl: IOdspResolvedUrl,\n        storageToken: string,\n        snapshotOptions: ISnapshotOptions | undefined,\n        controller?: AbortController,\n    ) => {\n        return downloadSnapshot(\n            finalOdspResolvedUrl, storageToken, odspLogger, snapshotOptions, snapshotFormatFetchType, controller);\n    };\n    const snapshotKey = createCacheSnapshotKey(odspResolvedUrl);\n    let cacheP: Promise<void> | undefined;\n    const putInCache = async (valueWithEpoch: IVersionedValueWithEpoch) => {\n        cacheP = persistedCache.put(\n            snapshotKey,\n            valueWithEpoch,\n        );\n        return cacheP;\n    };\n    const removeEntries = async () => persistedCache.removeEntries(snapshotKey.file);\n    return PerformanceEvent.timedExecAsync(\n        odspLogger,\n        { eventName: \"PrefetchLatestSnapshot\" },\n        async () => {\n            await fetchSnapshotWithRedeem(\n                    odspResolvedUrl,\n                    storageTokenFetcher,\n                    hostSnapshotFetchOptions,\n                    forceAccessTokenViaAuthorizationHeader,\n                    odspLogger,\n                    snapshotDownloader,\n                    putInCache,\n                    removeEntries,\n                    enableRedeemFallback,\n                );\n            assert(cacheP !== undefined, 0x1e7 /* \"caching was not performed!\" */);\n            await cacheP;\n            return true;\n    }).catch(async (error) => false);\n}\n"]}

package/lib/retryUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"retryUtils.js","sourceRoot":"","sources":["../src/retryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,GAAqB,EACrB,QAAgB,EAChB,MAAwB,EACxB,aAA0B;IAE1B,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,IAAI,SAAc,CAAC;IACnB,KAAK,IAAI,QAAQ,GAAG,CAAC,GAAI,QAAQ,EAAE,EAAE;QACjC,IAAI,aAAa,KAAK,SAAS,EAAE;YAC7B,aAAa,EAAE,CAAC;SACnB;QACD,IAAI;YACA,MAAM,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC;YAC3B,IAAI,QAAQ,GAAG,CAAC,EAAE;gBACd,MAAM,CAAC,kBAAkB,CACrB;oBACI,SAAS,EAAE,iBAAiB;oBAC5B,QAAQ;oBACR,QAAQ;oBACR,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;iBACtC,EACD,SAAS,CAAC,CAAC;aAClB;YACD,OAAO,MAAM,CAAC;SACjB;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;YAExC,MAAM,cAAc,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,YAAY,OAAM,IAAI,CAAC;YACtD,MAAM,oBAAoB,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAK,aAAa,CAAC,eAAe,CAAC;YAChF,4DAA4D;YAC5D,IAAI,CAAC,CAAC,cAAc,IAAI,oBAAoB,CAAC,EAAE;gBAC3C,MAAM,KAAK,CAAC;aACf;YAED,+EAA+E;YAC/E,oFAAoF;YACpF,uEAAuE;YACvE,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAChB,MAAM,CAAC,cAAc,CACjB;oBACI,SAAS,EAAE,cAAc,CAAC,CAAC;wBACvB,8BAA8B,CAAC,CAAC,CAAC,oCAAoC;oBACzE,QAAQ;oBACR,QAAQ;oBACR,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;iBACtC,EACD,KAAK,CAAC,CAAC;gBACX,aAAa;gBACb,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC;gBACvB,MAAM,KAAK,CAAC;aACf;YAED,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;YAC1C,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;YACpC,UAAU,IAAI,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YACnD,SAAS,GAAG,KAAK,CAAC;SACrB;KACJ;AACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, delay, performance } from \"@fluidframework/common-utils\";\nimport { canRetryOnError } from \"@fluidframework/driver-utils\";\nimport { OdspErrorType } from \"@fluidframework/odsp-driver-definitions\";\nimport { Odsp409Error } from \"./epochTracker\";\n\n/**\n * This method retries only for retriable coherency and service read only errors.\n */\nexport async function runWithRetry<T>(\n    api: () => Promise<T>,\n    callName: string,\n    logger: ITelemetryLogger,\n    checkDisposed?: () => void,\n): Promise<T> {\n    let retryAfter = 1000;\n    const start = performance.now();\n    let lastError: any;\n    for (let attempts = 1; ; attempts++) {\n        if (checkDisposed !== undefined) {\n            checkDisposed();\n        }\n        try {\n            const result = await api();\n            if (attempts > 1) {\n                logger.sendTelemetryEvent(\n                    {\n                        eventName: \"MultipleRetries\",\n                        callName,\n                        attempts,\n                        duration: performance.now() - start,\n                    },\n                    lastError);\n            }\n            return result;\n        } catch (error) {\n            const canRetry = canRetryOnError(error);\n\n            const coherencyError = error?.[Odsp409Error] === true;\n            const serviceReadonlyError = error?.errorType === OdspErrorType.serviceReadOnly;\n            // Retry for 409 coherency errors or serviceReadOnly errors.\n            if (!(coherencyError || serviceReadonlyError)) {\n                throw error;\n            }\n\n            // SPO itself does number of retries internally before returning 409 to client.\n            // That multiplied to 5 suggests need to reconsider current design, as client spends\n            // too much time / bandwidth doing the same thing without any progress.\n            if (attempts === 5) {\n                logger.sendErrorEvent(\n                    {\n                        eventName: coherencyError ?\n                            \"CoherencyErrorTooManyRetries\" : \"ServiceReadonlyErrorTooManyRetries\",\n                        callName,\n                        attempts,\n                        duration: performance.now() - start, // record total wait time.\n                    },\n                    error);\n                // Fail hard.\n                error.canRetry = false;\n                throw error;\n            }\n\n            assert(canRetry, 0x24d /* \"can retry\" */);\n            await delay(Math.floor(retryAfter));\n            retryAfter += retryAfter / 4 * (1 + Math.random());\n            lastError = error;\n        }\n    }\n}\n"]}
+{"version":3,"file":"retryUtils.js","sourceRoot":"","sources":["../src/retryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,GAAqB,EACrB,QAAgB,EAChB,MAAwB,EACxB,aAA0B;IAE1B,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,IAAI,SAAc,CAAC;IACnB,KAAK,IAAI,QAAQ,GAAG,CAAC,GAAI,QAAQ,EAAE,EAAE;QACjC,IAAI,aAAa,KAAK,SAAS,EAAE;YAC7B,aAAa,EAAE,CAAC;SACnB;QACD,IAAI;YACA,MAAM,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC;YAC3B,IAAI,QAAQ,GAAG,CAAC,EAAE;gBACd,MAAM,CAAC,kBAAkB,CACrB;oBACI,SAAS,EAAE,iBAAiB;oBAC5B,QAAQ;oBACR,QAAQ;oBACR,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;iBACtC,EACD,SAAS,CAAC,CAAC;aAClB;YACD,OAAO,MAAM,CAAC;SACjB;QAAC,OAAO,KAAU,EAAE;YACjB,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;YAExC,MAAM,cAAc,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,YAAY,OAAM,IAAI,CAAC;YACtD,MAAM,oBAAoB,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAK,aAAa,CAAC,eAAe,CAAC;YAChF,4DAA4D;YAC5D,IAAI,CAAC,CAAC,cAAc,IAAI,oBAAoB,CAAC,EAAE;gBAC3C,MAAM,KAAK,CAAC;aACf;YAED,+EAA+E;YAC/E,oFAAoF;YACpF,uEAAuE;YACvE,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAChB,MAAM,CAAC,cAAc,CACjB;oBACI,SAAS,EAAE,cAAc,CAAC,CAAC;wBACvB,8BAA8B,CAAC,CAAC,CAAC,oCAAoC;oBACzE,QAAQ;oBACR,QAAQ;oBACR,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;iBACtC,EACD,KAAK,CAAC,CAAC;gBACX,aAAa;gBACb,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC;gBACvB,MAAM,KAAK,CAAC;aACf;YAED,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;YAC1C,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;YACpC,UAAU,IAAI,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YACnD,SAAS,GAAG,KAAK,CAAC;SACrB;KACJ;AACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, delay, performance } from \"@fluidframework/common-utils\";\nimport { canRetryOnError } from \"@fluidframework/driver-utils\";\nimport { OdspErrorType } from \"@fluidframework/odsp-driver-definitions\";\nimport { Odsp409Error } from \"./epochTracker\";\n\n/**\n * This method retries only for retriable coherency and service read only errors.\n */\nexport async function runWithRetry<T>(\n    api: () => Promise<T>,\n    callName: string,\n    logger: ITelemetryLogger,\n    checkDisposed?: () => void,\n): Promise<T> {\n    let retryAfter = 1000;\n    const start = performance.now();\n    let lastError: any;\n    for (let attempts = 1; ; attempts++) {\n        if (checkDisposed !== undefined) {\n            checkDisposed();\n        }\n        try {\n            const result = await api();\n            if (attempts > 1) {\n                logger.sendTelemetryEvent(\n                    {\n                        eventName: \"MultipleRetries\",\n                        callName,\n                        attempts,\n                        duration: performance.now() - start,\n                    },\n                    lastError);\n            }\n            return result;\n        } catch (error: any) {\n            const canRetry = canRetryOnError(error);\n\n            const coherencyError = error?.[Odsp409Error] === true;\n            const serviceReadonlyError = error?.errorType === OdspErrorType.serviceReadOnly;\n            // Retry for 409 coherency errors or serviceReadOnly errors.\n            if (!(coherencyError || serviceReadonlyError)) {\n                throw error;\n            }\n\n            // SPO itself does number of retries internally before returning 409 to client.\n            // That multiplied to 5 suggests need to reconsider current design, as client spends\n            // too much time / bandwidth doing the same thing without any progress.\n            if (attempts === 5) {\n                logger.sendErrorEvent(\n                    {\n                        eventName: coherencyError ?\n                            \"CoherencyErrorTooManyRetries\" : \"ServiceReadonlyErrorTooManyRetries\",\n                        callName,\n                        attempts,\n                        duration: performance.now() - start, // record total wait time.\n                    },\n                    error);\n                // Fail hard.\n                error.canRetry = false;\n                throw error;\n            }\n\n            assert(canRetry, 0x24d /* \"can retry\" */);\n            await delay(Math.floor(retryAfter));\n            retryAfter += retryAfter / 4 * (1 + Math.random());\n            lastError = error;\n        }\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "0.59.1000",
+  "version": "0.59.2000-63294",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -16,7 +16,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run tsc && npm run build:test",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
     "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
     "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
@@ -36,7 +36,8 @@
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
     "tsfmt": "tsfmt --verify",
-    "tsfmt:fix": "tsfmt --replace"
+    "tsfmt:fix": "tsfmt --replace",
+    "typetests:gen": "fluid-type-validator -g -d ."
   },
   "nyc": {
     "all": true,
@@ -62,15 +63,15 @@
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
     "@fluidframework/core-interfaces": "^0.43.1000",
-    "@fluidframework/driver-base": "^0.59.1000",
+    "@fluidframework/driver-base": "0.59.2000-63294",
     "@fluidframework/driver-definitions": "^0.46.1000",
-    "@fluidframework/driver-utils": "^0.59.1000",
+    "@fluidframework/driver-utils": "0.59.2000-63294",
     "@fluidframework/gitresources": "^0.1036.1000",
-    "@fluidframework/odsp-doclib-utils": "^0.59.1000",
-    "@fluidframework/odsp-driver-definitions": "^0.59.1000",
+    "@fluidframework/odsp-doclib-utils": "0.59.2000-63294",
+    "@fluidframework/odsp-driver-definitions": "0.59.2000-63294",
     "@fluidframework/protocol-base": "^0.1036.1000",
     "@fluidframework/protocol-definitions": "^0.1028.1000",
-    "@fluidframework/telemetry-utils": "^0.59.1000",
+    "@fluidframework/telemetry-utils": "0.59.2000-63294",
     "abort-controller": "^3.0.0",
     "node-fetch": "^2.6.1",
     "socket.io-client": "^4.4.1",
@@ -79,9 +80,9 @@
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
     "@fluidframework/eslint-config-fluid": "^0.28.1000",
-    "@fluidframework/mocha-test-setup": "^0.59.1000",
-    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@^0.58.0",
-    "@microsoft/api-extractor": "^7.16.1",
+    "@fluidframework/mocha-test-setup": "0.59.2000-63294",
+    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@0.59.1000",
+    "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",
     "@types/node-fetch": "^2.5.10",
@@ -95,8 +96,11 @@
     "eslint-plugin-editorconfig": "~3.2.0",
     "eslint-plugin-eslint-comments": "~3.2.0",
     "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-no-null": "~1.0.2",
+    "eslint-plugin-jest": "~26.1.3",
+    "eslint-plugin-mocha": "~10.0.3",
+    "eslint-plugin-promise": "~6.0.0",
     "eslint-plugin-react": "~7.28.0",
+    "eslint-plugin-tsdoc": "~0.2.14",
     "eslint-plugin-unicorn": "~40.0.0",
     "mocha": "^8.4.0",
     "nyc": "^15.0.0",
@@ -106,7 +110,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.1000",
+    "version": "0.59.2000",
     "broken": {}
   }
 }

package/src/epochTracker.ts

@@ -423,7 +423,7 @@ export class EpochTrackerWithRedemption extends EpochTracker {
 
         try {
             return await super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody, fetchReason);
-        } catch (error) {
+        } catch (error: any) {
             // Only handling here treesLatest. If createFile failed, we should never try to do joinSession.
             // Similar, if getVersions failed, we should not do any further storage calls.
             // So treesLatest is the only call that can have parallel joinSession request.

package/src/fetchSnapshot.ts

@@ -33,6 +33,15 @@ import { currentReadVersion, parseCompactSnapshotResponse } from "./compactSnaps
 import { ReadBuffer } from "./ReadBufferUtils";
 import { EpochTracker } from "./epochTracker";
 
+/**
+ * Enum to support different types of snapshot formats.
+ */
+export enum SnapshotFormatSupportType {
+    Json = 0,
+    Binary = 1,
+    JsonAndBinary = 2,
+}
+
 /**
  * Fetches a snapshot from the server with a given version id.
  * @param snapshotUrl - snapshot url from where the odsp snapshot will be fetched
@@ -428,7 +437,7 @@ function countTreesInSnapshotTree(snapshotTree: ISnapshotTree): number {
  * @param storageToken - token to do the auth for network request.
  * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
  * @param logger - logger
- * @param fetchBinarySnapshotFormat - whether to fetch binary snapshot or not.
+ * @param snapshotFormatFetchType - Snapshot format to fetch.
  * @param controller - abort controller if caller needs to abort the network call.
  * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
  * @returns fetched snapshot.
@@ -438,7 +447,7 @@ export async function downloadSnapshot(
     storageToken: string,
     logger: ITelemetryLogger,
     snapshotOptions: ISnapshotOptions | undefined,
-    fetchBinarySnapshotFormat?: boolean,
+    snapshotFormatFetchType?: SnapshotFormatSupportType,
     controller?: AbortController,
     epochTracker?: EpochTracker,
 ): Promise<ISnapshotRequestAndResponseOptions> {
@@ -463,13 +472,18 @@ export async function downloadSnapshot(
         signal: controller?.signal,
         method: "POST",
     };
-    // For now we are keeping both json and ms-fluid values in accept header while fetching as we want to let
-    // the server decide what format it wants to send to the client as we roll it out slowly.
-    if (fetchBinarySnapshotFormat) {
-        headers.accept = `application/json, application/ms-fluid; v=${currentReadVersion}`;
-    } else {
-        headers.accept = "application/json";
+    // Decide what snapshot format to fetch as per the feature gate.
+    switch (snapshotFormatFetchType) {
+        case SnapshotFormatSupportType.JsonAndBinary:
+            headers.accept = `application/json, application/ms-fluid; v=${currentReadVersion}`;
+            break;
+        case SnapshotFormatSupportType.Binary:
+            headers.accept = `application/ms-fluid; v=${currentReadVersion}`;
+            break;
+        default:
+            headers.accept = "application/json";
     }
+
     const response = await (epochTracker?.fetch(url, fetchOptions, "treesLatest", true) ??
         fetchHelper(url, fetchOptions));
 

package/src/odspDocumentDeltaConnection.ts

@@ -250,7 +250,7 @@ export class OdspDocumentDeltaConnection extends DocumentDeltaConnection {
         try {
             await deltaConnection.initialize(connectMessage, timeoutMs);
             await epochTracker.validateEpochFromPush(deltaConnection.details);
-        } catch (errorObject) {
+        } catch (errorObject: any) {
             if (errorObject !== null && typeof errorObject === "object") {
                 // We have to special-case error types here in terms of what is re-triable.
                 // These errors have to re-retried, we just need new joinSession result to connect to right server:

package/src/odspDocumentService.ts

@@ -151,8 +151,6 @@ export class OdspDocumentService implements IDocumentService {
             }));
 
         this.hostPolicy = hostPolicy;
-        this.hostPolicy.fetchBinarySnapshotFormat ??=
-            this.mc.config.getBoolean("Fluid.Driver.Odsp.binaryFormatSnapshot");
         if (this.clientIsSummarizer) {
             this.hostPolicy = { ...this.hostPolicy, summarizerClient: true };
         }
@@ -187,6 +185,7 @@ export class OdspDocumentService implements IDocumentService {
                     }
                     throw new Error("Disconnected while uploading summary (attempt to perform flush())");
                 },
+                this.mc.config.getNumber("Fluid.Driver.Odsp.snapshotFormatFetchType"),
             );
         }
 

package/src/odspDocumentStorageManager.ts

@@ -32,7 +32,7 @@ import {
     IVersionedValueWithEpoch,
     ISnapshotCachedEntry,
 } from "./contracts";
-import { downloadSnapshot, fetchSnapshot, fetchSnapshotWithRedeem } from "./fetchSnapshot";
+import { downloadSnapshot, fetchSnapshot, fetchSnapshotWithRedeem, SnapshotFormatSupportType } from "./fetchSnapshot";
 import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth";
 import { IOdspCache } from "./odspCache";
 import {
@@ -221,6 +221,7 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
         private readonly hostPolicy: HostStoragePolicyInternal,
         private readonly epochTracker: EpochTracker,
         private readonly flushCallback: () => Promise<FlushResult>,
+        private readonly snapshotFormatFetchType?: SnapshotFormatSupportType,
     ) {
         this.documentId = this.odspResolvedUrl.hashedDocumentId;
         this.snapshotUrl = this.odspResolvedUrl.endpoints.snapshotStorageUrl;
@@ -578,7 +579,7 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
                 storageToken,
                 this.logger,
                 options,
-                this.hostPolicy.fetchBinarySnapshotFormat,
+                this.snapshotFormatFetchType,
                 controller,
                 this.epochTracker,
             );
@@ -604,7 +605,7 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
                 this.hostPolicy.enableRedeemFallback,
             );
             return odspSnapshot;
-        } catch (error) {
+        } catch (error: any) {
             const errorType = error.errorType;
             // If the snapshot size is too big and the host specified the size limitation(specified in hostSnapshotOptions), then don't try to fetch the snapshot again.
             if ((errorType === OdspErrorType.snapshotTooBig && hostSnapshotOptions?.mds !== undefined) && (this.hostPolicy.summarizerClient !== true)) {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "0.59.1000";
+export const pkgVersion = "0.59.2000-63294";

package/src/prefetchLatestSnapshot.ts

@@ -22,7 +22,7 @@ import {
     getOdspResolvedUrl,
     toInstrumentedOdspTokenFetcher,
 } from "./odspUtils";
-import { downloadSnapshot, fetchSnapshotWithRedeem } from "./fetchSnapshot";
+import { downloadSnapshot, fetchSnapshotWithRedeem, SnapshotFormatSupportType } from "./fetchSnapshot";
 import { IVersionedValueWithEpoch } from "./contracts";
 
 /**
@@ -38,6 +38,9 @@ import { IVersionedValueWithEpoch } from "./contracts";
  * @param enableRedeemFallback - True to have the sharing link redeem fallback in case the Trees Latest/Redeem
  *  1RT call fails with redeem error. During fallback it will first redeem the sharing link and then make
  *  the Trees latest call.
+ *  @deprecated - This will be replaced with snapshotFormatFetchType.
+ * @param fetchBinarySnapshotFormat - Control if we want to fetch binary format snapshot.
+ * @param snapshotFormatFetchType - Snapshot format to fetch.
  * @returns - True if the snapshot is cached, false otherwise.
  */
 export async function prefetchLatestSnapshot(
@@ -49,6 +52,7 @@ export async function prefetchLatestSnapshot(
     hostSnapshotFetchOptions: ISnapshotOptions | undefined,
     enableRedeemFallback?: boolean,
     fetchBinarySnapshotFormat?: boolean,
+    snapshotFormatFetchType?: SnapshotFormatSupportType,
 ): Promise<boolean> {
     const odspLogger = createOdspLogger(ChildLogger.create(logger, "PrefetchSnapshot"));
     const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);
@@ -72,7 +76,7 @@ export async function prefetchLatestSnapshot(
         controller?: AbortController,
     ) => {
         return downloadSnapshot(
-            finalOdspResolvedUrl, storageToken, odspLogger, snapshotOptions, fetchBinarySnapshotFormat, controller);
+            finalOdspResolvedUrl, storageToken, odspLogger, snapshotOptions, snapshotFormatFetchType, controller);
     };
     const snapshotKey = createCacheSnapshotKey(odspResolvedUrl);
     let cacheP: Promise<void> | undefined;

package/src/retryUtils.ts

@@ -38,7 +38,7 @@ export async function runWithRetry<T>(
                     lastError);
             }
             return result;
-        } catch (error) {
+        } catch (error: any) {
             const canRetry = canRetryOnError(error);
 
             const coherencyError = error?.[Odsp409Error] === true;