@fluidframework/odsp-driver 0.51.0 → 0.52.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "0.51.0",
+  "version": "0.52.0",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -57,16 +57,16 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/core-interfaces": "^0.40.0",
-    "@fluidframework/driver-base": "^0.51.0",
-    "@fluidframework/driver-definitions": "^0.41.0",
-    "@fluidframework/driver-utils": "^0.51.0",
-    "@fluidframework/gitresources": "^0.1033.0",
-    "@fluidframework/odsp-doclib-utils": "^0.51.0",
-    "@fluidframework/odsp-driver-definitions": "^0.51.0",
-    "@fluidframework/protocol-base": "^0.1033.0",
-    "@fluidframework/protocol-definitions": "^0.1025.0",
-    "@fluidframework/telemetry-utils": "^0.51.0",
+    "@fluidframework/core-interfaces": "^0.41.0",
+    "@fluidframework/driver-base": "^0.52.0",
+    "@fluidframework/driver-definitions": "^0.42.0",
+    "@fluidframework/driver-utils": "^0.52.0",
+    "@fluidframework/gitresources": "^0.1034.0",
+    "@fluidframework/odsp-doclib-utils": "^0.52.0",
+    "@fluidframework/odsp-driver-definitions": "^0.52.0",
+    "@fluidframework/protocol-base": "^0.1034.0",
+    "@fluidframework/protocol-definitions": "^0.1026.0",
+    "@fluidframework/telemetry-utils": "^0.52.0",
     "abort-controller": "^3.0.0",
     "node-fetch": "^2.6.1",
     "socket.io-client": "^2.4.0",
@@ -75,7 +75,7 @@
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
     "@fluidframework/eslint-config-fluid": "^0.24.0",
-    "@fluidframework/mocha-test-setup": "^0.51.0",
+    "@fluidframework/mocha-test-setup": "^0.52.0",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/mocha": "^8.2.2",
     "@types/node-fetch": "^2.5.10",

package/src/contractsPublic.ts

@@ -5,11 +5,6 @@
 
 import { IOdspUrlParts } from "@fluidframework/odsp-driver-definitions";
 
-/**
- * @deprecated - use OdspFluidDataStoreLocator
- */
-export type OdspDocumentInfo = OdspFluidDataStoreLocator;
-
 export interface OdspFluidDataStoreLocator extends IOdspUrlParts {
     dataStorePath: string;
     appName?: string;

package/src/epochTracker.ts

@@ -18,7 +18,7 @@ import {
     IOdspError,
 } from "@fluidframework/odsp-driver-definitions";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
-import { PerformanceEvent, isValidLegacyError, isFluidError, normalizeError } from "@fluidframework/telemetry-utils";
+import { PerformanceEvent, isFluidError, normalizeError } from "@fluidframework/telemetry-utils";
 import { fetchAndParseAsJSONHelper, fetchArray, IOdspResponse } from "./odspUtils";
 import {
     IOdspCache,
@@ -167,7 +167,6 @@ export class EpochTracker implements IPersistedFileCache {
             throw error;
         }).catch((error) => {
             const fluidError = normalizeError(error, {props: {"X-RequestStats": clientCorelationId}});
-            // eslint-disable-next-line @typescript-eslint/no-throw-literal
             throw fluidError;
         });
     }
@@ -209,7 +208,6 @@ export class EpochTracker implements IPersistedFileCache {
             throw error;
         }).catch((error) => {
             const fluidError = normalizeError(error, {props: {"X-RequestStats": clientCorelationId}});
-            // eslint-disable-next-line @typescript-eslint/no-throw-literal
             throw fluidError;
         });
     }
@@ -287,7 +285,7 @@ export class EpochTracker implements IPersistedFileCache {
                 // This will only throw if it is an epoch error.
                 this.checkForEpochErrorCore(epochFromResponse);
             } catch (epochError) {
-                assert(isValidLegacyError(epochError),
+                assert(isFluidError(epochError),
                     0x21f /* "epochError expected to be thrown by throwOdspNetworkError and of known type" */);
                 epochError.addTelemetryProperties({
                     fromCache,
@@ -297,7 +295,6 @@ export class EpochTracker implements IPersistedFileCache {
                 this.logger.sendErrorEvent({ eventName: "fileOverwrittenInStorage" }, epochError);
                 // If the epoch mismatches, then clear all entries for such file entry from cache.
                 await this.removeEntries();
-                // eslint-disable-next-line @typescript-eslint/no-throw-literal
                 throw epochError;
             }
             // If it was categorized as epoch error but the epoch returned in response matches with the client epoch

package/src/fetchSnapshot.ts

@@ -101,16 +101,10 @@ export async function fetchSnapshotWithRedeem(
             logger.sendErrorEvent({
                 eventName: "RedeemFallback",
                 errorType: error.errorType,
-            });
+            }, error);
             await redeemSharingLink(odspResolvedUrl, storageTokenFetcher, logger);
             const odspResolvedUrlWithoutShareLink: IOdspResolvedUrl =
-                { ...odspResolvedUrl, sharingLinkToRedeem: undefined };
-            if(odspResolvedUrlWithoutShareLink.shareLinkInfo) {
-                odspResolvedUrlWithoutShareLink.shareLinkInfo = {
-                    ...odspResolvedUrlWithoutShareLink.shareLinkInfo,
-                    sharingLinkToRedeem: undefined,
-                };
-            }
+            { ...odspResolvedUrl, shareLinkInfo: { ...odspResolvedUrl.shareLinkInfo, sharingLinkToRedeem: undefined } };
 
             return fetchLatestSnapshotCore(
                 odspResolvedUrlWithoutShareLink,
@@ -466,7 +460,7 @@ export async function downloadSnapshot(
 }
 
 function isRedeemSharingLinkError(odspResolvedUrl: IOdspResolvedUrl, error: any) {
-    if (odspResolvedUrl.sharingLinkToRedeem !== undefined
+    if (odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem !== undefined
         && (typeof error === "object" && error !== null)
         && (error.errorType === DriverErrorType.authorizationError
         || error.errorType === DriverErrorType.fileNotFoundOrAccessDeniedError)) {

package/src/getFileLink.ts

@@ -4,9 +4,10 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { delay, PromiseCache } from "@fluidframework/common-utils";
+import { assert, delay } from "@fluidframework/common-utils";
 import { canRetryOnError, getRetryDelayFromError } from "@fluidframework/driver-utils";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
+import { fetchIncorrectResponse, throwOdspNetworkError } from "@fluidframework/odsp-doclib-utils";
 import {
     IOdspUrlParts,
     OdspResourceTokenFetchOptions,
@@ -18,7 +19,7 @@ import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth";
 import { fetchHelper, getWithRetryForTokenRefresh } from "./odspUtils";
 
 // Store cached responses for the lifetime of web session as file link remains the same for given file item
-const fileLinkCache = new PromiseCache<string, string | undefined>();
+const fileLinkCache = new Map<string, Promise<string>>();
 
 /**
  * Returns file link for a file with given drive and item ids.
@@ -39,10 +40,11 @@ export async function getFileLink(
     odspUrlParts: IOdspUrlParts,
     identityType: IdentityType,
     logger: ITelemetryLogger,
-): Promise<string | undefined> {
+): Promise<string> {
     const cacheKey = `${odspUrlParts.siteUrl}_${odspUrlParts.driveId}_${odspUrlParts.itemId}`;
-    if (fileLinkCache.has(cacheKey)) {
-        return fileLinkCache.get(cacheKey);
+    const maybeFileLinkCacheEntry = fileLinkCache.get(cacheKey);
+    if (maybeFileLinkCacheEntry !== undefined) {
+        return maybeFileLinkCacheEntry;
     }
 
     const valueGenerator = async function() {
@@ -54,10 +56,11 @@ export async function getFileLink(
                 result = await getFileLinkCore(getToken, odspUrlParts, identityType, logger);
                 success = true;
             } catch (err) {
-                // If it is not retriable, then just return undefined
+                // If it is not retriable, then just throw
                 if (!canRetryOnError(err)) {
-                    fileLinkCache.remove(cacheKey);
-                    return undefined;
+                    // Delete from the cache to permit retrying later.
+                    fileLinkCache.delete(cacheKey);
+                    throw err;
                 }
                 // If the error is throttling error, then wait for the specified time before retrying.
                 // If the waitTime is not specified, then we start with retrying immediately to max of 8s.
@@ -65,10 +68,14 @@ export async function getFileLink(
                 await delay(retryAfterMs);
             }
         } while (!success);
+
+        // We are guaranteed to run the getFileLinkCore at least once with successful result (which must be a string)
+        assert(result !== undefined, 0x292 /* "Unexpected undefined result from getFileLinkCore" */);
         return result;
     };
-    fileLinkCache.add(cacheKey, valueGenerator);
-    return fileLinkCache.get(cacheKey);
+    const fileLink = valueGenerator();
+    fileLinkCache.set(cacheKey, fileLink);
+    return fileLink;
 }
 
 async function getFileLinkCore(
@@ -76,11 +83,8 @@ async function getFileLinkCore(
     odspUrlParts: IOdspUrlParts,
     identityType: IdentityType,
     logger: ITelemetryLogger,
-): Promise<string | undefined> {
+): Promise<string> {
     const fileItem = await getFileItemLite(getToken, odspUrlParts, logger);
-    if (!fileItem) {
-        return undefined;
-    }
 
     // ODC canonical link does not require any additional processing
     if (identityType === "Consumer") {
@@ -111,11 +115,14 @@ async function getFileLinkCore(
                 };
                 const response = await fetchHelper(url, requestInit);
                 additionalProps = response.commonSpoHeaders;
-                if (response.content.ok) {
-                    const sharingInfo = await response.content.json();
-                    return sharingInfo?.d?.directUrl as string;
+
+                const sharingInfo = await response.content.json();
+                const directUrl = sharingInfo?.d?.directUrl;
+                if (typeof directUrl !== "string") {
+                    // This will retry once in getWithRetryForTokenRefresh
+                    throwOdspNetworkError("malformedGetSharingInformationResponse", fetchIncorrectResponse);
                 }
-                return undefined;
+                return directUrl;
             });
             event.end({ ...additionalProps, attempts });
             return fileLink;
@@ -131,11 +138,18 @@ interface FileItemLite {
     webDavUrl: string;
 }
 
+const isFileItemLite = (maybeFileItemLite: any): maybeFileItemLite is FileItemLite => {
+    if (typeof maybeFileItemLite.webUrl !== "string" || typeof maybeFileItemLite.webDavUrl !== "string") {
+        return false;
+    }
+    return true;
+};
+
 async function getFileItemLite(
     getToken: TokenFetcher<OdspResourceTokenFetchOptions>,
     odspUrlParts: IOdspUrlParts,
     logger: ITelemetryLogger,
-): Promise<FileItemLite | undefined> {
+): Promise<FileItemLite> {
     return PerformanceEvent.timedExecAsync(
         logger,
         { eventName: "odspFileLink", requestName: "getFileItemLite" },
@@ -153,16 +167,16 @@ async function getFileItemLite(
                 const requestInit = { method: "GET", headers };
                 const response = await fetchHelper(url, requestInit);
                 additionalProps = response.commonSpoHeaders;
-                if (response.content.ok) {
-                    return await response.content.json() as FileItemLite;
+
+                const responseJson = await response.content.json();
+                if (!isFileItemLite(responseJson)) {
+                    // This will retry once in getWithRetryForTokenRefresh
+                    throwOdspNetworkError("malformedGetFileItemLiteResponse", fetchIncorrectResponse);
                 }
-                return undefined;
+                return responseJson;
             });
             event.end({ ...additionalProps, attempts });
-            if (fileItem && fileItem.webDavUrl && fileItem.webUrl) {
-                return fileItem;
-            }
-            return undefined;
+            return fileItem;
         },
     );
 }

package/src/odspDocumentStorageManager.ts

@@ -7,8 +7,6 @@ import { default as AbortController } from "abort-controller";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import {
     assert,
-    stringToBuffer,
-    bufferToString,
     delay,
 } from "@fluidframework/common-utils";
 import {
@@ -318,14 +316,7 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
         if (!this.attributesBlobHandles.has(blobId)) {
             return blob;
         }
-        // ODSP document ids are random guids (different per session)
-        // fix the branch name in attributes
-        // this prevents issues when generating summaries
-        const documentAttributes: api.IDocumentAttributes = JSON.parse(bufferToString(blob, "utf8"));
-        documentAttributes.branch = this.documentId;
-        const content = JSON.stringify(documentAttributes);
-        const patchedBlob = stringToBuffer(content, "utf8");
-        return patchedBlob;
+        return blob;
     }
 
     public async readBlob(blobId: string): Promise<ArrayBufferLike> {

package/src/odspDriverUrlResolver.ts

@@ -7,7 +7,6 @@ import { assert } from "@fluidframework/common-utils";
 import { IFluidCodeDetails, IRequest, isFluidPackage } from "@fluidframework/core-interfaces";
 import { DriverHeader, IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
 import { IOdspResolvedUrl, ShareLinkTypes, ShareLinkInfoType } from "@fluidframework/odsp-driver-definitions";
-import { createOdspCreateContainerRequest } from "./createOdspCreateContainerRequest";
 import { createOdspUrl } from "./createOdspUrl";
 import { getApiRoot } from "./odspUrlHelper";
 import { getOdspResolvedUrl } from "./odspUtils";
@@ -166,18 +165,6 @@ export class OdspDriverUrlResolver implements IUrlResolver {
             dataStorePath,
         });
     }
-
-    /**
-     * @deprecated - use createOdspCreateContainerRequest
-     */
-    public createCreateNewRequest(
-        siteUrl: string,
-        driveId: string,
-        filePath: string,
-        fileName: string,
-    ): IRequest {
-        return createOdspCreateContainerRequest(siteUrl, driveId, filePath, fileName);
-    }
 }
 
 function decodeOdspUrl(url: string): {

package/src/odspDriverUrlResolverForShareLink.ts

@@ -22,8 +22,7 @@ import {
     encodeOdspFluidDataStoreLocator,
     locatorQueryParamName,
 } from "./odspFluidFileLink";
-import { OdspDocumentInfo, OdspFluidDataStoreLocator, SharingLinkHeader } from "./contractsPublic";
-import { createOdspCreateContainerRequest } from "./createOdspCreateContainerRequest";
+import { OdspFluidDataStoreLocator, SharingLinkHeader } from "./contractsPublic";
 import { createOdspUrl } from "./createOdspUrl";
 import { OdspDriverUrlResolver } from "./odspDriverUrlResolver";
 import { getOdspResolvedUrl, createOdspLogger } from "./odspUtils";
@@ -77,18 +76,6 @@ export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
         }
     }
 
-    /**
-     * @deprecated - use createOdspCreateContainerRequest
-     */
-    public createCreateNewRequest(
-        siteUrl: string,
-        driveId: string,
-        filePath: string,
-        fileName: string,
-    ) {
-        return createOdspCreateContainerRequest(siteUrl, driveId, filePath, fileName);
-    }
-
     /**
      * Takes an already generated data store url (from requestUrl) and appends a path to the
      * existing data store information.
@@ -145,9 +132,8 @@ export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
             // We need to remove the nav param if set by host when setting the sharelink as otherwise the shareLinkId
             // when redeeming the share link during the redeem fallback for trees latest call becomes greater than
             // the eligible length.
-            odspResolvedUrl.sharingLinkToRedeem = this.removeNavParam(request.url);
             odspResolvedUrl.shareLinkInfo = Object.assign(odspResolvedUrl.shareLinkInfo || {},
-                {sharingLinkToRedeem: odspResolvedUrl.sharingLinkToRedeem});
+                {sharingLinkToRedeem: this.removeNavParam(request.url)});
         }
         if (odspResolvedUrl.itemId) {
             // Kick start the sharing link request if we don't have it already as a performance optimization.
@@ -203,12 +189,8 @@ export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
             resolvedUrl,
             this.shareLinkFetcherProps.identityType,
             this.logger,
-        ).then((fileLink) => {
-            if (!fileLink) {
-                throw new Error("Failed to get share link");
-            }
-            return fileLink;
-        }).catch((error) => {
+        ).catch((error) => {
+            // This should imply that error is a non-retriable error.
             this.logger.sendErrorEvent({ eventName: "FluidFileUrlError" }, error);
             this.sharingLinkCache.remove(key);
             throw error;
@@ -254,7 +236,7 @@ export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
     /**
      * Crafts a supported document/driver URL
      */
-    public static createDocumentUrl(baseUrl: string, driverInfo: OdspDocumentInfo) {
+    public static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator) {
         const url = new URL(baseUrl);
 
         storeLocatorInOdspUrl(url, driverInfo);

package/src/odspUtils.ts

@@ -300,7 +300,6 @@ export function toInstrumentedOdspTokenFetcher(
                 const tokenError = wrapError(
                     error,
                     (errorMessage) => createOdspNetworkError("tokenFetcherFailed", errorMessage, fetchTokenErrorCode));
-                // eslint-disable-next-line @typescript-eslint/no-throw-literal
                 throw tokenError;
             }),
             { cancel: "generic" });

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "0.51.0";
+export const pkgVersion = "0.52.0";

package/src/zipItDataRepresentationUtils.ts

@@ -488,7 +488,6 @@ function throwBufferParseException(
             nodeType: getNodeType(node),
             expectedNodeType,
         });
-    // eslint-disable-next-line @typescript-eslint/no-throw-literal
     throw error;
 }