@fluidframework/odsp-driver 2.20.0 → 2.22.0

package/src/socketModule.ts

@@ -5,6 +5,6 @@
 
 import { io } from "socket.io-client";
 
-// Import is required for side-effects.
-// eslint-disable-next-line unicorn/prefer-export-from
-export const SocketIOClientStatic = io;
+import { mockify, type Mockable } from "./mockify.js";
+
+export const SocketIOClientStatic: Mockable<typeof io> = mockify(io);

package/src/vroom.ts

@@ -16,6 +16,7 @@ import {
 import { v4 as uuid } from "uuid";
 
 import { EpochTracker } from "./epochTracker.js";
+import { mockify } from "./mockify.js";
 import { getApiRoot } from "./odspUrlHelper.js";
 import { TokenFetchOptionsEx } from "./odspUtils.js";
 import { runWithRetry } from "./retryUtils.js";
@@ -42,100 +43,102 @@ interface IJoinSessionBody {
  * This is optional and used only when collab session is being joined by client acting in app-only mode (i.e. without user context).
  * If not specified client display name is extracted from the access token that is used to join session.
  */
-export async function fetchJoinSession(
-	urlParts: IOdspUrlParts,
-	path: string,
-	method: "GET" | "POST",
-	logger: ITelemetryLoggerExt,
-	getAuthHeader: InstrumentedStorageTokenFetcher,
-	epochTracker: EpochTracker,
-	requestSocketToken: boolean,
-	options: TokenFetchOptionsEx,
-	disableJoinSessionRefresh: boolean | undefined,
-	isRefreshingJoinSession: boolean,
-	displayName: string | undefined,
-): Promise<ISocketStorageDiscovery> {
-	const apiRoot = getApiRoot(new URL(urlParts.siteUrl));
-	const url = `${apiRoot}/drives/${urlParts.driveId}/items/${urlParts.itemId}/${path}?ump=1`;
-	const authHeader = await getAuthHeader(
-		{ ...options, request: { url, method } },
-		"JoinSession",
-	);
+export const fetchJoinSession = mockify(
+	async (
+		urlParts: IOdspUrlParts,
+		path: string,
+		method: "GET" | "POST",
+		logger: ITelemetryLoggerExt,
+		getAuthHeader: InstrumentedStorageTokenFetcher,
+		epochTracker: EpochTracker,
+		requestSocketToken: boolean,
+		options: TokenFetchOptionsEx,
+		disableJoinSessionRefresh: boolean | undefined,
+		isRefreshingJoinSession: boolean,
+		displayName: string | undefined,
+	): Promise<ISocketStorageDiscovery> => {
+		const apiRoot = getApiRoot(new URL(urlParts.siteUrl));
+		const url = `${apiRoot}/drives/${urlParts.driveId}/items/${urlParts.itemId}/${path}?ump=1`;
+		const authHeader = await getAuthHeader(
+			{ ...options, request: { url, method } },
+			"JoinSession",
+		);
 
-	const tokenRefreshProps = options.refresh
-		? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }
-		: {};
-	const details: ITelemetryBaseProperties = {
-		refreshedToken: options.refresh,
-		requestSocketToken,
-		...tokenRefreshProps,
-		refreshingSession: isRefreshingJoinSession,
-	};
-
-	return PerformanceEvent.timedExecAsync(
-		logger,
-		{
-			eventName: "JoinSession",
-			attempts: options.refresh ? 2 : 1,
-			details: JSON.stringify(details),
+		const tokenRefreshProps = options.refresh
+			? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }
+			: {};
+		const details: ITelemetryBaseProperties = {
+			refreshedToken: options.refresh,
+			requestSocketToken,
 			...tokenRefreshProps,
-		},
-		async (event) => {
-			const formBoundary = uuid();
-			let postBody = `--${formBoundary}\r\n`;
-			postBody += `Authorization: ${authHeader}\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`;
+			refreshingSession: isRefreshingJoinSession,
+		};
 
-			let requestBody: IJoinSessionBody | undefined;
-			if (requestSocketToken) {
-				requestBody = { ...requestBody, requestSocketToken: true };
-			}
-			if (displayName) {
-				requestBody = { ...requestBody, displayName };
-			}
-			if (requestBody) {
-				postBody += `\r\n${JSON.stringify(requestBody)}\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 formBoundary = uuid();
+				let postBody = `--${formBoundary}\r\n`;
+				postBody += `Authorization: ${authHeader}\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`;
 
-			const response = await runWithRetry(
-				async () =>
-					epochTracker.fetchAndParseAsJSON<ISocketStorageDiscovery>(
-						url,
-						{ method, headers, body: postBody },
-						"joinSession",
-						true,
-					),
-				"joinSession",
-				logger,
-			);
+				let requestBody: IJoinSessionBody | undefined;
+				if (requestSocketToken) {
+					requestBody = { ...requestBody, requestSocketToken: true };
+				}
+				if (displayName) {
+					requestBody = { ...requestBody, displayName };
+				}
+				if (requestBody) {
+					postBody += `\r\n${JSON.stringify(requestBody)}\r\n`;
+				}
+				postBody += `\r\n--${formBoundary}--`;
+				const headers: { [index: string]: string } = {
+					"Content-Type": `multipart/form-data;boundary=${formBoundary}`,
+				};
 
-			const socketUrl = response.content.deltaStreamSocketUrl;
-			// expecting socketUrl to be something like https://{hostName}/...
-			const webSocketHostName = socketUrl.split("/")[2];
+				const response = await runWithRetry(
+					async () =>
+						epochTracker.fetchAndParseAsJSON<ISocketStorageDiscovery>(
+							url,
+							{ method, headers, body: postBody },
+							"joinSession",
+							true,
+						),
+					"joinSession",
+					logger,
+				);
 
-			// TODO SPO-specific telemetry
-			event.end({
-				...response.propsToLog,
-				// pushV2 websocket urls will contain pushf
-				pushv2: socketUrl.includes("pushf"),
-				webSocketHostName,
-				refreshSessionDurationSeconds: response.content.refreshSessionDurationSeconds,
-			});
+				const socketUrl = response.content.deltaStreamSocketUrl;
+				// expecting socketUrl to be something like https://{hostName}/...
+				const webSocketHostName = socketUrl.split("/")[2];
 
-			if (response.content.runtimeTenantId && !response.content.tenantId) {
-				response.content.tenantId = response.content.runtimeTenantId;
-			}
+				// TODO SPO-specific telemetry
+				event.end({
+					...response.propsToLog,
+					// pushV2 websocket urls will contain pushf
+					pushv2: socketUrl.includes("pushf"),
+					webSocketHostName,
+					refreshSessionDurationSeconds: response.content.refreshSessionDurationSeconds,
+				});
 
-			return response.content;
-		},
-	);
-}
+				if (response.content.runtimeTenantId && !response.content.tenantId) {
+					response.content.tenantId = response.content.runtimeTenantId;
+				}
+
+				return response.content;
+			},
+		);
+	},
+);

package/dist/odspDocumentServiceFactoryWithCodeSplit.d.ts

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IDocumentServiceFactory } from "@fluidframework/driver-definitions/internal";
-import { HostStoragePolicy, IPersistedCache, OdspResourceTokenFetchOptions, TokenFetcher } from "@fluidframework/odsp-driver-definitions/internal";
-import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore.js";
-/**
- * @deprecated This is deprecated in favour of OdspDocumentServiceFactory as the socket io is now loaded inside the
- * other dynamically imported module.
- * @internal
- */
-export declare class OdspDocumentServiceFactoryWithCodeSplit extends OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
-    constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
-}
-//# sourceMappingURL=odspDocumentServiceFactoryWithCodeSplit.d.ts.map

package/dist/odspDocumentServiceFactoryWithCodeSplit.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"odspDocumentServiceFactoryWithCodeSplit.d.ts","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryWithCodeSplit.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EACN,iBAAiB,EACjB,eAAe,EACf,6BAA6B,EAC7B,YAAY,EACZ,MAAM,kDAAkD,CAAC;AAE1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAErF;;;;GAIG;AACH,qBAAa,uCACZ,SAAQ,8BACR,YAAW,uBAAuB;gBAGjC,eAAe,EAAE,YAAY,CAAC,6BAA6B,CAAC,EAC5D,iBAAiB,EAAE,YAAY,CAAC,6BAA6B,CAAC,GAAG,SAAS,EAC1E,cAAc,CAAC,EAAE,eAAe,EAChC,UAAU,CAAC,EAAE,iBAAiB;CAI/B"}

package/dist/odspDocumentServiceFactoryWithCodeSplit.js

@@ -1,20 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OdspDocumentServiceFactoryWithCodeSplit = void 0;
-const odspDocumentServiceFactoryCore_js_1 = require("./odspDocumentServiceFactoryCore.js");
-/**
- * @deprecated This is deprecated in favour of OdspDocumentServiceFactory as the socket io is now loaded inside the
- * other dynamically imported module.
- * @internal
- */
-class OdspDocumentServiceFactoryWithCodeSplit extends odspDocumentServiceFactoryCore_js_1.OdspDocumentServiceFactoryCore {
-    constructor(getStorageToken, getWebsocketToken, persistedCache, hostPolicy) {
-        super(getStorageToken, getWebsocketToken, persistedCache, hostPolicy);
-    }
-}
-exports.OdspDocumentServiceFactoryWithCodeSplit = OdspDocumentServiceFactoryWithCodeSplit;
-//# sourceMappingURL=odspDocumentServiceFactoryWithCodeSplit.js.map

package/dist/odspDocumentServiceFactoryWithCodeSplit.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"odspDocumentServiceFactoryWithCodeSplit.js","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryWithCodeSplit.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAUH,2FAAqF;AAErF;;;;GAIG;AACH,MAAa,uCACZ,SAAQ,kEAA8B;IAGtC,YACC,eAA4D,EAC5D,iBAA0E,EAC1E,cAAgC,EAChC,UAA8B;QAE9B,KAAK,CAAC,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC;CACD;AAZD,0FAYC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentServiceFactory } from \"@fluidframework/driver-definitions/internal\";\nimport {\n\tHostStoragePolicy,\n\tIPersistedCache,\n\tOdspResourceTokenFetchOptions,\n\tTokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions/internal\";\n\nimport { OdspDocumentServiceFactoryCore } from \"./odspDocumentServiceFactoryCore.js\";\n\n/**\n * @deprecated This is deprecated in favour of OdspDocumentServiceFactory as the socket io is now loaded inside the\n * other dynamically imported module.\n * @internal\n */\nexport class OdspDocumentServiceFactoryWithCodeSplit\n\textends OdspDocumentServiceFactoryCore\n\timplements IDocumentServiceFactory\n{\n\tconstructor(\n\t\tgetStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n\t\tgetWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,\n\t\tpersistedCache?: IPersistedCache,\n\t\thostPolicy?: HostStoragePolicy,\n\t) {\n\t\tsuper(getStorageToken, getWebsocketToken, persistedCache, hostPolicy);\n\t}\n}\n"]}

package/lib/odspDocumentServiceFactoryWithCodeSplit.d.ts

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IDocumentServiceFactory } from "@fluidframework/driver-definitions/internal";
-import { HostStoragePolicy, IPersistedCache, OdspResourceTokenFetchOptions, TokenFetcher } from "@fluidframework/odsp-driver-definitions/internal";
-import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore.js";
-/**
- * @deprecated This is deprecated in favour of OdspDocumentServiceFactory as the socket io is now loaded inside the
- * other dynamically imported module.
- * @internal
- */
-export declare class OdspDocumentServiceFactoryWithCodeSplit extends OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
-    constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
-}
-//# sourceMappingURL=odspDocumentServiceFactoryWithCodeSplit.d.ts.map

package/lib/odspDocumentServiceFactoryWithCodeSplit.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"odspDocumentServiceFactoryWithCodeSplit.d.ts","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryWithCodeSplit.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EACN,iBAAiB,EACjB,eAAe,EACf,6BAA6B,EAC7B,YAAY,EACZ,MAAM,kDAAkD,CAAC;AAE1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAErF;;;;GAIG;AACH,qBAAa,uCACZ,SAAQ,8BACR,YAAW,uBAAuB;gBAGjC,eAAe,EAAE,YAAY,CAAC,6BAA6B,CAAC,EAC5D,iBAAiB,EAAE,YAAY,CAAC,6BAA6B,CAAC,GAAG,SAAS,EAC1E,cAAc,CAAC,EAAE,eAAe,EAChC,UAAU,CAAC,EAAE,iBAAiB;CAI/B"}

package/lib/odspDocumentServiceFactoryWithCodeSplit.js

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore.js";
-/**
- * @deprecated This is deprecated in favour of OdspDocumentServiceFactory as the socket io is now loaded inside the
- * other dynamically imported module.
- * @internal
- */
-export class OdspDocumentServiceFactoryWithCodeSplit extends OdspDocumentServiceFactoryCore {
-    constructor(getStorageToken, getWebsocketToken, persistedCache, hostPolicy) {
-        super(getStorageToken, getWebsocketToken, persistedCache, hostPolicy);
-    }
-}
-//# sourceMappingURL=odspDocumentServiceFactoryWithCodeSplit.js.map

package/lib/odspDocumentServiceFactoryWithCodeSplit.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"odspDocumentServiceFactoryWithCodeSplit.js","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryWithCodeSplit.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAErF;;;;GAIG;AACH,MAAM,OAAO,uCACZ,SAAQ,8BAA8B;IAGtC,YACC,eAA4D,EAC5D,iBAA0E,EAC1E,cAAgC,EAChC,UAA8B;QAE9B,KAAK,CAAC,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentServiceFactory } from \"@fluidframework/driver-definitions/internal\";\nimport {\n\tHostStoragePolicy,\n\tIPersistedCache,\n\tOdspResourceTokenFetchOptions,\n\tTokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions/internal\";\n\nimport { OdspDocumentServiceFactoryCore } from \"./odspDocumentServiceFactoryCore.js\";\n\n/**\n * @deprecated This is deprecated in favour of OdspDocumentServiceFactory as the socket io is now loaded inside the\n * other dynamically imported module.\n * @internal\n */\nexport class OdspDocumentServiceFactoryWithCodeSplit\n\textends OdspDocumentServiceFactoryCore\n\timplements IDocumentServiceFactory\n{\n\tconstructor(\n\t\tgetStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n\t\tgetWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,\n\t\tpersistedCache?: IPersistedCache,\n\t\thostPolicy?: HostStoragePolicy,\n\t) {\n\t\tsuper(getStorageToken, getWebsocketToken, persistedCache, hostPolicy);\n\t}\n}\n"]}

package/src/odspDocumentServiceFactoryWithCodeSplit.ts

@@ -1,33 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { IDocumentServiceFactory } from "@fluidframework/driver-definitions/internal";
-import {
-	HostStoragePolicy,
-	IPersistedCache,
-	OdspResourceTokenFetchOptions,
-	TokenFetcher,
-} from "@fluidframework/odsp-driver-definitions/internal";
-
-import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore.js";
-
-/**
- * @deprecated This is deprecated in favour of OdspDocumentServiceFactory as the socket io is now loaded inside the
- * other dynamically imported module.
- * @internal
- */
-export class OdspDocumentServiceFactoryWithCodeSplit
-	extends OdspDocumentServiceFactoryCore
-	implements IDocumentServiceFactory
-{
-	constructor(
-		getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,
-		getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,
-		persistedCache?: IPersistedCache,
-		hostPolicy?: HostStoragePolicy,
-	) {
-		super(getStorageToken, getWebsocketToken, persistedCache, hostPolicy);
-	}
-}