@fluidframework/odsp-driver 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/src/vroom.ts

@@ -4,18 +4,21 @@
  */
 
 import { v4 as uuid } from "uuid";
-import { ITelemetryLogger, ITelemetryProperties } from "@fluidframework/common-definitions";
-import { PerformanceEvent } from "@fluidframework/telemetry-utils";
-import { InstrumentedStorageTokenFetcher, IOdspUrlParts } from "@fluidframework/odsp-driver-definitions";
-import { ISocketStorageDiscovery } from "./contracts";
+import { ITelemetryProperties } from "@fluidframework/core-interfaces";
+import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
+import {
+	InstrumentedStorageTokenFetcher,
+	ISocketStorageDiscovery,
+	IOdspUrlParts,
+} from "@fluidframework/odsp-driver-definitions";
 import { getOrigin, TokenFetchOptionsEx } from "./odspUtils";
 import { getApiRoot } from "./odspUrlHelper";
 import { EpochTracker } from "./epochTracker";
 import { runWithRetry } from "./retryUtils";
 
 interface IJoinSessionBody {
-    requestSocketToken: boolean;
-    guestDisplayName: string;
+	requestSocketToken: boolean;
+	guestDisplayName: string;
 }
 
 /**
@@ -30,93 +33,99 @@ interface IJoinSessionBody {
  * which is used when establishing websocket connection with collab session backend service.
  * @param options - Options to fetch the token.
  * @param disableJoinSessionRefresh - Whether the caller wants to disable refreshing join session periodically.
+ * @param isRefreshingJoinSession - whether call is to refresh the session before expiry.
  * @param guestDisplayName - display name used to identify guest user joining a session.
  * This is optional and used only when collab session is being joined via invite.
  */
 export async function fetchJoinSession(
-    urlParts: IOdspUrlParts,
-    path: string,
-    method: string,
-    logger: ITelemetryLogger,
-    getStorageToken: InstrumentedStorageTokenFetcher,
-    epochTracker: EpochTracker,
-    requestSocketToken: boolean,
-    options: TokenFetchOptionsEx,
-    disableJoinSessionRefresh: boolean | undefined,
-    guestDisplayName?: string,
+	urlParts: IOdspUrlParts,
+	path: string,
+	method: string,
+	logger: ITelemetryLoggerExt,
+	getStorageToken: InstrumentedStorageTokenFetcher,
+	epochTracker: EpochTracker,
+	requestSocketToken: boolean,
+	options: TokenFetchOptionsEx,
+	disableJoinSessionRefresh: boolean | undefined,
+	isRefreshingJoinSession: boolean,
+	guestDisplayName?: string,
 ): Promise<ISocketStorageDiscovery> {
-    const token = await getStorageToken(options, "JoinSession");
+	const token = await getStorageToken(options, "JoinSession");
 
-    const tokenRefreshProps = options.refresh
-        ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }
-        : {};
-    const details: ITelemetryProperties = {
-        refreshedToken: options.refresh,
-        requestSocketToken,
-        ...tokenRefreshProps,
-    };
+	const tokenRefreshProps = options.refresh
+		? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }
+		: {};
+	const details: ITelemetryProperties = {
+		refreshedToken: options.refresh,
+		requestSocketToken,
+		...tokenRefreshProps,
+		refreshingSession: isRefreshingJoinSession,
+	};
 
-    return PerformanceEvent.timedExecAsync(
-        logger, {
-            eventName: "JoinSession",
-            attempts: options.refresh ? 2 : 1,
-            details: JSON.stringify(details),
-            ...tokenRefreshProps,
-        },
-        async (event) => {
-            const siteOrigin = getOrigin(urlParts.siteUrl);
-            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`;
-            if (!disableJoinSessionRefresh) {
-                postBody += `prefer: FluidRemoveCheckAccess\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}`,
-            };
+	return PerformanceEvent.timedExecAsync(
+		logger,
+		{
+			eventName: "JoinSession",
+			attempts: options.refresh ? 2 : 1,
+			details: JSON.stringify(details),
+			...tokenRefreshProps,
+		},
+		async (event) => {
+			const siteOrigin = getOrigin(urlParts.siteUrl);
+			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`;
+			if (!disableJoinSessionRefresh) {
+				postBody += `prefer: FluidRemoveCheckAccess\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}?ump=1`,
-                    { method, headers, body: postBody },
-                    "joinSession",
-                    true,
-                ),
-                "joinSession",
-                logger,
-            );
+			const response = await runWithRetry(
+				async () =>
+					epochTracker.fetchAndParseAsJSON<ISocketStorageDiscovery>(
+						`${getApiRoot(siteOrigin)}/drives/${urlParts.driveId}/items/${
+							urlParts.itemId
+						}/${path}?ump=1`,
+						{ method, headers, body: postBody },
+						"joinSession",
+						true,
+					),
+				"joinSession",
+				logger,
+			);
 
-            const socketUrl = response.content.deltaStreamSocketUrl;
-            // expecting socketUrl to be something like https://{hostName}/...
-            const webSocketHostName = socketUrl.split("/")[2];
+			const socketUrl = response.content.deltaStreamSocketUrl;
+			// expecting socketUrl to be something like https://{hostName}/...
+			const webSocketHostName = socketUrl.split("/")[2];
 
-            // TODO SPO-specific telemetry
-            event.end({
-                ...response.propsToLog,
-                // pushV2 websocket urls will contain pushf
-                pushv2: socketUrl.includes("pushf"),
-                webSocketHostName,
-                refreshSessionDurationSeconds: response.content.refreshSessionDurationSeconds,
-            });
+			// TODO SPO-specific telemetry
+			event.end({
+				...response.propsToLog,
+				// pushV2 websocket urls will contain pushf
+				pushv2: socketUrl.includes("pushf"),
+				webSocketHostName,
+				refreshSessionDurationSeconds: response.content.refreshSessionDurationSeconds,
+			});
 
-            if (response.content.runtimeTenantId && !response.content.tenantId) {
-                response.content.tenantId = response.content.runtimeTenantId;
-            }
+			if (response.content.runtimeTenantId && !response.content.tenantId) {
+				response.content.tenantId = response.content.runtimeTenantId;
+			}
 
-            return response.content;
-        });
+			return response.content;
+		},
+	);
 }