@fluidframework/odsp-driver 0.54.3 → 0.55.2

package/src/fetchSnapshot.ts

@@ -95,6 +95,7 @@ export async function fetchSnapshotWithRedeem(
         logger,
         snapshotDownloader,
         putInCache,
+        enableRedeemFallback,
     ).catch(async (error) => {
         if (enableRedeemFallback && isRedeemSharingLinkError(odspResolvedUrl, error)) {
             // Execute the redeem fallback
@@ -171,6 +172,7 @@ async function fetchLatestSnapshotCore(
             controller?: AbortController,
         ) => Promise<ISnapshotRequestAndResponseOptions>,
     putInCache: (valueWithEpoch: IVersionedValueWithEpoch) => Promise<void>,
+    enableRedeemFallback?: boolean,
 ): Promise<ISnapshotContents> {
     return getWithRetryForTokenRefresh(async (tokenFetchOptions) => {
         const storageToken = await storageTokenFetcher(tokenFetchOptions, "TreesLatest", true);
@@ -187,6 +189,8 @@ async function fetchLatestSnapshotCore(
         const perfEvent = {
             eventName: "TreesLatest",
             attempts: tokenFetchOptions.refresh ? 2 : 1,
+            shareLinkPresent: odspResolvedUrl.sharingLinkToRedeem !== undefined,
+            redeemFallbackEnabled: enableRedeemFallback,
         };
         if (snapshotOptions !== undefined) {
             Object.entries(snapshotOptions).forEach(([key, value]) => {
@@ -344,30 +348,9 @@ async function fetchSnapshotContentsCoreV1(
 ): Promise<ISnapshotRequestAndResponseOptions> {
     const snapshotUrl = odspResolvedUrl.endpoints.snapshotStorageUrl;
     const url = `${snapshotUrl}/trees/latest?ump=1`;
-    const formBoundary = uuid();
-    const formParams: string[] = [];
-    formParams.push(`--${formBoundary}`);
-    formParams.push(`Authorization: Bearer ${storageToken}`);
-    formParams.push(`X-HTTP-Method-Override: GET`);
-    if (snapshotOptions !== undefined) {
-        Object.entries(snapshotOptions).forEach(([key, value]) => {
-            if (value !== undefined) {
-                formParams.push(`${key}: ${value}`);
-            }
-        });
-    }
-    if (odspResolvedUrl.sharingLinkToRedeem) {
-        formParams.push(`sl: ${odspResolvedUrl.sharingLinkToRedeem}`);
-    }
-    formParams.push(`_post: 1`);
-    formParams.push(`\r\n--${formBoundary}--`);
-    const postBody = formParams.join("\r\n");
-    const headers: {[index: string]: any} = {
-        "Content-Type": `multipart/form-data;boundary=${formBoundary}`,
-    };
-
+    const { body, headers } = getFormBodyAndHeaders(odspResolvedUrl, storageToken, snapshotOptions);
     const fetchOptions = {
-        body: postBody,
+        body,
         headers,
         signal: controller?.signal,
         method: "POST",
@@ -401,28 +384,55 @@ async function fetchSnapshotContentsCoreV2(
     epochTracker?: EpochTracker,
 ): Promise<ISnapshotRequestAndResponseOptions> {
     const fullUrl = `${odspResolvedUrl.siteUrl}/_api/v2.1/drives/${odspResolvedUrl.driveId}/items/${
-        odspResolvedUrl.itemId}/opStream/attachments/latest/content`;
-    const queryParams = { ...snapshotOptions };
-    if (odspResolvedUrl.sharingLinkToRedeem) {
-        // eslint-disable-next-line @typescript-eslint/dot-notation
-        queryParams["sl"] = odspResolvedUrl.sharingLinkToRedeem;
-    }
-    const queryString = getQueryString(queryParams);
-    const { url, headers } = getUrlAndHeadersWithAuth(`${fullUrl}${queryString}`, storageToken);
+        odspResolvedUrl.itemId}/opStream/attachments/latest/content?ump=1`;
+
+    const { body, headers } = getFormBodyAndHeaders(odspResolvedUrl, storageToken, snapshotOptions);
     const fetchOptions = {
+        body,
         headers,
         signal: controller?.signal,
+        method: "POST",
     };
-    const response = await (epochTracker?.fetchArray(url, fetchOptions, "treesLatest") ??
-        fetchArray(url, fetchOptions));
+
+    const response = await (epochTracker?.fetchArray(fullUrl, fetchOptions, "treesLatest", true) ??
+        fetchArray(fullUrl, fetchOptions));
     const snapshotContents: ISnapshotContents = parseCompactSnapshotResponse(
         new ReadBuffer(new Uint8Array(response.content)));
     const finalSnapshotContents: IOdspResponse<ISnapshotContents> = { ...response, content: snapshotContents };
     return  {
         odspSnapshotResponse: finalSnapshotContents,
         requestHeaders: headers,
-        requestUrl: url,
+        requestUrl: fullUrl,
+    };
+}
+
+function getFormBodyAndHeaders(
+    odspResolvedUrl: IOdspResolvedUrl,
+    storageToken: string,
+    snapshotOptions: ISnapshotOptions | undefined,
+) {
+    const formBoundary = uuid();
+    const formParams: string[] = [];
+    formParams.push(`--${formBoundary}`);
+    formParams.push(`Authorization: Bearer ${storageToken}`);
+    formParams.push(`X-HTTP-Method-Override: GET`);
+    if (snapshotOptions !== undefined) {
+        Object.entries(snapshotOptions).forEach(([key, value]) => {
+            if (value !== undefined) {
+                formParams.push(`${key}: ${value}`);
+            }
+        });
+    }
+    if (odspResolvedUrl.sharingLinkToRedeem) {
+        formParams.push(`sl: ${odspResolvedUrl.sharingLinkToRedeem}`);
+    }
+    formParams.push(`_post: 1`);
+    formParams.push(`\r\n--${formBoundary}--`);
+    const postBody = formParams.join("\r\n");
+    const headers: {[index: string]: any} = {
+        "Content-Type": `multipart/form-data;boundary=${formBoundary}`,
     };
+    return { body: postBody, headers };
 }
 
 function validateAndEvalBlobsAndTrees(snapshot: ISnapshotContents) {

package/src/odspDocumentDeltaConnection.ts

@@ -234,7 +234,7 @@ export class OdspDocumentDeltaConnection extends DocumentDeltaConnection {
 
         // Reference to this client supporting get_ops flow.
         connectMessage.supportedFeatures = { };
-        if (mc.config.getBoolean("Fluid.Driver.Odsp.GetOpsEnabled") === true) {
+        if (mc.config.getBoolean("Fluid.Driver.Odsp.GetOpsEnabled") !== false) {
             connectMessage.supportedFeatures[feature_get_ops] = true;
         }
 

package/src/odspDocumentService.ts

@@ -17,6 +17,7 @@ import {
     IResolvedUrl,
     IDocumentStorageService,
     IDocumentServicePolicies,
+    DriverErrorType,
 } from "@fluidframework/driver-definitions";
 import { DeltaStreamConnectionForbiddenError, NonRetryableError } from "@fluidframework/driver-utils";
 import { IFacetCodes } from "@fluidframework/odsp-doclib-utils";
@@ -281,6 +282,14 @@ export class OdspDocumentService implements IDocumentService {
                 connection.on("op", (documentId, ops: ISequencedDocumentMessage[]) => {
                     this.opsReceived(ops);
                 });
+                // On disconnect with 401/403 error code, we can just clear the joinSession cache as we will again
+                // get the auth error on reconnecting and face latency.
+                connection.on("disconnect", (error: any) => {
+                    if (typeof error === "object" && error !== null
+                        && error.errorType === DriverErrorType.authorizationError) {
+                        this.cache.sessionJoinCache.remove(this.joinSessionKey);
+                    }
+                });
                 this.currentConnection = connection;
                 return connection;
             } catch (error) {

package/src/packageVersion.ts

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

package/src/vroom.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { v4 as uuid } from "uuid";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { InstrumentedStorageTokenFetcher, IOdspUrlParts } from "@fluidframework/odsp-driver-definitions";
@@ -13,8 +14,8 @@ import { EpochTracker } from "./epochTracker";
 import { runWithRetry } from "./retryUtils";
 
 interface IJoinSessionBody {
-    requestSocketToken?: boolean;
-    guestDisplayName?: string;
+    requestSocketToken: boolean;
+    guestDisplayName: string;
 }
 
 /**
@@ -54,35 +55,34 @@ export async function fetchJoinSession(
             ...extraProps,
         },
         async (event) => {
-            // TODO Extract the auth header-vs-query logic out
             const siteOrigin = getOrigin(urlParts.siteUrl);
-            let queryParams = `access_token=${token}`;
-            let headers = {};
-            if (queryParams.length > 2048) {
-                queryParams = "";
-                headers = { Authorization: `Bearer ${token}` };
-            }
-            let body: IJoinSessionBody | undefined;
-            if (requestSocketToken || guestDisplayName) {
-                body = {};
-                if (requestSocketToken) {
-                    body.requestSocketToken = true;
-                }
-                if (guestDisplayName) {
-                    body.guestDisplayName = guestDisplayName;
-                }
-                // IMPORTANT: Must set content-type header explicitly to application/json when request has body.
-                // By default, request will use text/plain as content-type and will be rejected by backend.
-                headers["Content-Type"] = "application/json";
+            const formBoundary = uuid();
+            let postBody = `--${formBoundary}\r\n`;
+            postBody += `Authorization: Bearer ${token}\r\n`;
+            postBody += `X-HTTP-Method-Override: POST\r\n`;
+            postBody += `Content-Type: application/json\r\n`;
+            postBody += `_post: 1\r\n`;
+            // Name should be there when socket token is requested and vice-versa.
+            if (requestSocketToken && guestDisplayName !== undefined) {
+                const body: IJoinSessionBody = {
+                    requestSocketToken: true,
+                    guestDisplayName,
+                };
+                postBody += `\r\n${JSON.stringify(body)}\r\n`;
             }
+            postBody += `\r\n--${formBoundary}--`;
+            const headers: {[index: string]: string} = {
+                "Content-Type": `multipart/form-data;boundary=${formBoundary}`,
+            };
 
             const response = await runWithRetry(
                 async () => epochTracker.fetchAndParseAsJSON<ISocketStorageDiscovery>(
                     `${getApiRoot(siteOrigin)}/drives/${
                         urlParts.driveId
-                    }/items/${urlParts.itemId}/${path}?${queryParams}`,
-                    { method, headers, body: body ? JSON.stringify(body) : undefined },
+                    }/items/${urlParts.itemId}/${path}?ump=1`,
+                    { method, headers, body: postBody },
                     "joinSession",
+                    true,
                 ),
                 "joinSession",
                 logger,