@fluidframework/odsp-driver 0.50.0 → 0.50.4

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "0.50.0";
+export const pkgVersion = "0.50.4";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver\";\nexport const pkgVersion = \"0.50.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver\";\nexport const pkgVersion = \"0.50.4\";\n"]}

package/lib/vroom.d.ts

@@ -5,12 +5,11 @@
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { InstrumentedStorageTokenFetcher, IOdspUrlParts } from "@fluidframework/odsp-driver-definitions";
 import { ISocketStorageDiscovery } from "./contracts";
+import { TokenFetchOptionsEx } from "./odspUtils";
 import { EpochTracker } from "./epochTracker";
 /**
  * Makes join session call on SPO to get information about the web socket for a document
- * @param driveId - The SPO drive id that this request should be made against
- * @param itemId -The SPO item id that this request should be made against
- * @param siteUrl - The SPO site that this request should be made against
+ * @param urlParts - The SPO drive id, itemId, siteUrl that this request should be made against
  * @param path - The API path that is relevant to this request
  * @param method - The type of request, such as GET or POST
  * @param logger - A logger to use for this request
@@ -18,8 +17,9 @@ import { EpochTracker } from "./epochTracker";
  * @param epochTracker - fetch wrapper which incorporates epoch logic around joinSession call
  * @param requestSocketToken - flag indicating whether joinSession is expected to return access token
  * which is used when establishing websocket connection with collab session backend service.
+ * @param options - Options to fetch the token.
  * @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 declare function fetchJoinSession(urlParts: IOdspUrlParts, path: string, method: string, logger: ITelemetryLogger, getStorageToken: InstrumentedStorageTokenFetcher, epochTracker: EpochTracker, requestSocketToken: boolean, guestDisplayName?: string): Promise<ISocketStorageDiscovery>;
+export declare function fetchJoinSession(urlParts: IOdspUrlParts, path: string, method: string, logger: ITelemetryLogger, getStorageToken: InstrumentedStorageTokenFetcher, epochTracker: EpochTracker, requestSocketToken: boolean, options: TokenFetchOptionsEx, guestDisplayName?: string): Promise<ISocketStorageDiscovery>;
 //# sourceMappingURL=vroom.d.ts.map

package/lib/vroom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vroom.d.ts","sourceRoot":"","sources":["../src/vroom.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,+BAA+B,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACzG,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAGtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAQ9C;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,gBAAgB,CAClC,QAAQ,EAAE,aAAa,EACvB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,gBAAgB,EACxB,eAAe,EAAE,+BAA+B,EAChD,YAAY,EAAE,YAAY,EAC1B,kBAAkB,EAAE,OAAO,EAC3B,gBAAgB,CAAC,EAAE,MAAM,GAC1B,OAAO,CAAC,uBAAuB,CAAC,CA8DlC"}
+{"version":3,"file":"vroom.d.ts","sourceRoot":"","sources":["../src/vroom.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,+BAA+B,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACzG,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAa,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAE7D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAQ9C;;;;;;;;;;;;;GAaG;AACH,wBAAsB,gBAAgB,CAClC,QAAQ,EAAE,aAAa,EACvB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,gBAAgB,EACxB,eAAe,EAAE,+BAA+B,EAChD,YAAY,EAAE,YAAY,EAC1B,kBAAkB,EAAE,OAAO,EAC3B,OAAO,EAAE,mBAAmB,EAC5B,gBAAgB,CAAC,EAAE,MAAM,GAC1B,OAAO,CAAC,uBAAuB,CAAC,CA4DlC"}

package/lib/vroom.js

@@ -3,14 +3,12 @@
  * Licensed under the MIT License.
  */
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
-import { getWithRetryForTokenRefresh, getOrigin } from "./odspUtils";
+import { getOrigin } from "./odspUtils";
 import { getApiRoot } from "./odspUrlHelper";
 import { runWithRetry } from "./retryUtils";
 /**
  * Makes join session call on SPO to get information about the web socket for a document
- * @param driveId - The SPO drive id that this request should be made against
- * @param itemId -The SPO item id that this request should be made against
- * @param siteUrl - The SPO site that this request should be made against
+ * @param urlParts - The SPO drive id, itemId, siteUrl that this request should be made against
  * @param path - The API path that is relevant to this request
  * @param method - The type of request, such as GET or POST
  * @param logger - A logger to use for this request
@@ -18,47 +16,46 @@ import { runWithRetry } from "./retryUtils";
  * @param epochTracker - fetch wrapper which incorporates epoch logic around joinSession call
  * @param requestSocketToken - flag indicating whether joinSession is expected to return access token
  * which is used when establishing websocket connection with collab session backend service.
+ * @param options - Options to fetch the token.
  * @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, path, method, logger, getStorageToken, epochTracker, requestSocketToken, guestDisplayName) {
-    return getWithRetryForTokenRefresh(async (options) => {
-        const token = await getStorageToken(options, "JoinSession");
-        const extraProps = options.refresh
-            ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }
-            : {};
-        return PerformanceEvent.timedExecAsync(logger, Object.assign({ eventName: "JoinSession", attempts: options.refresh ? 2 : 1 }, 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}` };
+export async function fetchJoinSession(urlParts, path, method, logger, getStorageToken, epochTracker, requestSocketToken, options, guestDisplayName) {
+    const token = await getStorageToken(options, "JoinSession");
+    const extraProps = options.refresh
+        ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }
+        : {};
+    return PerformanceEvent.timedExecAsync(logger, Object.assign({ eventName: "JoinSession", attempts: options.refresh ? 2 : 1 }, 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;
+        if (requestSocketToken || guestDisplayName) {
+            body = {};
+            if (requestSocketToken) {
+                body.requestSocketToken = true;
             }
-            let body;
-            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";
+            if (guestDisplayName) {
+                body.guestDisplayName = guestDisplayName;
             }
-            const response = await runWithRetry(async () => epochTracker.fetchAndParseAsJSON(`${getApiRoot(siteOrigin)}/drives/${urlParts.driveId}/items/${urlParts.itemId}/${path}?${queryParams}`, { method, headers, body: body ? JSON.stringify(body) : undefined }, "joinSession"), "joinSession", logger);
-            // TODO SPO-specific telemetry
-            event.end(Object.assign(Object.assign({}, response.commonSpoHeaders), { 
-                // pushV2 websocket urls will contain pushf
-                pushv2: response.content.deltaStreamSocketUrl.includes("pushf") }));
-            if (response.content.runtimeTenantId && !response.content.tenantId) {
-                response.content.tenantId = response.content.runtimeTenantId;
-            }
-            return response.content;
-        });
+            // 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 response = await runWithRetry(async () => epochTracker.fetchAndParseAsJSON(`${getApiRoot(siteOrigin)}/drives/${urlParts.driveId}/items/${urlParts.itemId}/${path}?${queryParams}`, { method, headers, body: body ? JSON.stringify(body) : undefined }, "joinSession"), "joinSession", logger);
+        // TODO SPO-specific telemetry
+        event.end(Object.assign(Object.assign({}, response.commonSpoHeaders), { 
+            // pushV2 websocket urls will contain pushf
+            pushv2: response.content.deltaStreamSocketUrl.includes("pushf") }));
+        if (response.content.runtimeTenantId && !response.content.tenantId) {
+            response.content.tenantId = response.content.runtimeTenantId;
+        }
+        return response.content;
     });
 }
 //# sourceMappingURL=vroom.js.map

package/lib/vroom.js.map

@@ -1 +1 @@
-{"version":3,"file":"vroom.js","sourceRoot":"","sources":["../src/vroom.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAGnE,OAAO,EAAE,2BAA2B,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAO5C;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAClC,QAAuB,EACvB,IAAY,EACZ,MAAc,EACd,MAAwB,EACxB,eAAgD,EAChD,YAA0B,EAC1B,kBAA2B,EAC3B,gBAAyB;IAEzB,OAAO,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACjD,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAE5D,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO;YAC9B,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;YAClE,CAAC,CAAC,EAAE,CAAC;QACT,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,kBACF,SAAS,EAAE,aAAa,EACxB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAC9B,UAAU,GAEjB,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,kDAAkD;YAClD,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC/C,IAAI,WAAW,GAAG,gBAAgB,KAAK,EAAE,CAAC;YAC1C,IAAI,OAAO,GAAG,EAAE,CAAC;YACjB,IAAI,WAAW,CAAC,MAAM,GAAG,IAAI,EAAE;gBAC3B,WAAW,GAAG,EAAE,CAAC;gBACjB,OAAO,GAAG,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC;aAClD;YACD,IAAI,IAAkC,CAAC;YACvC,IAAI,kBAAkB,IAAI,gBAAgB,EAAE;gBACxC,IAAI,GAAG,EAAE,CAAC;gBACV,IAAI,kBAAkB,EAAE;oBACpB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;iBAClC;gBACD,IAAI,gBAAgB,EAAE;oBAClB,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;iBAC5C;gBACD,gGAAgG;gBAChG,2FAA2F;gBAC3F,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;aAChD;YAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAC/B,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,UAAU,CAAC,UAAU,CAAC,WACrB,QAAQ,CAAC,OACb,UAAU,QAAQ,CAAC,MAAM,IAAI,IAAI,IAAI,WAAW,EAAE,EAClD,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,EAClE,aAAa,CAChB,EACD,aAAa,EACb,MAAM,CACT,CAAC;YAEF,8BAA8B;YAC9B,KAAK,CAAC,GAAG,iCACF,QAAQ,CAAC,gBAAgB;gBAC5B,2CAA2C;gBAC3C,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,IACjE,CAAC;YAEH,IAAI,QAAQ,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE;gBAChE,QAAQ,CAAC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC;aAChE;YAED,OAAO,QAAQ,CAAC,OAAO,CAAC;QAC5B,CAAC,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACP,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 { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { InstrumentedStorageTokenFetcher, IOdspUrlParts } from \"@fluidframework/odsp-driver-definitions\";\nimport { ISocketStorageDiscovery } from \"./contracts\";\nimport { getWithRetryForTokenRefresh, getOrigin } from \"./odspUtils\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { runWithRetry } from \"./retryUtils\";\n\ninterface IJoinSessionBody {\n    requestSocketToken?: boolean;\n    guestDisplayName?: string;\n}\n\n/**\n * Makes join session call on SPO to get information about the web socket for a document\n * @param driveId - The SPO drive id that this request should be made against\n * @param itemId -The SPO item id that this request should be made against\n * @param siteUrl - The SPO site that this request should be made against\n * @param path - The API path that is relevant to this request\n * @param method - The type of request, such as GET or POST\n * @param logger - A logger to use for this request\n * @param getStorageToken - A function that is able to provide the access token for this request\n * @param epochTracker - fetch wrapper which incorporates epoch logic around joinSession call\n * @param requestSocketToken - flag indicating whether joinSession is expected to return access token\n * which is used when establishing websocket connection with collab session backend service.\n * @param guestDisplayName - display name used to identify guest user joining a session.\n * This is optional and used only when collab session is being joined via invite.\n */\nexport async function fetchJoinSession(\n    urlParts: IOdspUrlParts,\n    path: string,\n    method: string,\n    logger: ITelemetryLogger,\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    epochTracker: EpochTracker,\n    requestSocketToken: boolean,\n    guestDisplayName?: string,\n): Promise<ISocketStorageDiscovery> {\n    return getWithRetryForTokenRefresh(async (options) => {\n        const token = await getStorageToken(options, \"JoinSession\");\n\n        const extraProps = options.refresh\n            ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }\n            : {};\n        return PerformanceEvent.timedExecAsync(\n            logger, {\n                eventName: \"JoinSession\",\n                attempts: options.refresh ? 2 : 1,\n                ...extraProps,\n            },\n            async (event) => {\n                // TODO Extract the auth header-vs-query logic out\n                const siteOrigin = getOrigin(urlParts.siteUrl);\n                let queryParams = `access_token=${token}`;\n                let headers = {};\n                if (queryParams.length > 2048) {\n                    queryParams = \"\";\n                    headers = { Authorization: `Bearer ${token}` };\n                }\n                let body: IJoinSessionBody | undefined;\n                if (requestSocketToken || guestDisplayName) {\n                    body = {};\n                    if (requestSocketToken) {\n                        body.requestSocketToken = true;\n                    }\n                    if (guestDisplayName) {\n                        body.guestDisplayName = guestDisplayName;\n                    }\n                    // IMPORTANT: Must set content-type header explicitly to application/json when request has body.\n                    // By default, request will use text/plain as content-type and will be rejected by backend.\n                    headers[\"Content-Type\"] = \"application/json\";\n                }\n\n                const response = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ISocketStorageDiscovery>(\n                        `${getApiRoot(siteOrigin)}/drives/${\n                            urlParts.driveId\n                        }/items/${urlParts.itemId}/${path}?${queryParams}`,\n                        { method, headers, body: body ? JSON.stringify(body) : undefined },\n                        \"joinSession\",\n                    ),\n                    \"joinSession\",\n                    logger,\n                );\n\n                // TODO SPO-specific telemetry\n                event.end({\n                    ...response.commonSpoHeaders,\n                    // pushV2 websocket urls will contain pushf\n                    pushv2: response.content.deltaStreamSocketUrl.includes(\"pushf\"),\n                });\n\n                if (response.content.runtimeTenantId && !response.content.tenantId) {\n                    response.content.tenantId = response.content.runtimeTenantId;\n                }\n\n                return response.content;\n            });\n    });\n}\n"]}
+{"version":3,"file":"vroom.js","sourceRoot":"","sources":["../src/vroom.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAGnE,OAAO,EAAE,SAAS,EAAuB,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAO5C;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAClC,QAAuB,EACvB,IAAY,EACZ,MAAc,EACd,MAAwB,EACxB,eAAgD,EAChD,YAA0B,EAC1B,kBAA2B,EAC3B,OAA4B,EAC5B,gBAAyB;IAEzB,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAE5D,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO;QAC9B,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;QAClE,CAAC,CAAC,EAAE,CAAC;IACT,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,kBACF,SAAS,EAAE,aAAa,EACxB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAC9B,UAAU,GAEjB,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,kDAAkD;QAClD,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,WAAW,GAAG,gBAAgB,KAAK,EAAE,CAAC;QAC1C,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,IAAI,WAAW,CAAC,MAAM,GAAG,IAAI,EAAE;YAC3B,WAAW,GAAG,EAAE,CAAC;YACjB,OAAO,GAAG,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC;SAClD;QACD,IAAI,IAAkC,CAAC;QACvC,IAAI,kBAAkB,IAAI,gBAAgB,EAAE;YACxC,IAAI,GAAG,EAAE,CAAC;YACV,IAAI,kBAAkB,EAAE;gBACpB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;aAClC;YACD,IAAI,gBAAgB,EAAE;gBAClB,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;aAC5C;YACD,gGAAgG;YAChG,2FAA2F;YAC3F,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;SAChD;QAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAC/B,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,UAAU,CAAC,UAAU,CAAC,WACrB,QAAQ,CAAC,OACb,UAAU,QAAQ,CAAC,MAAM,IAAI,IAAI,IAAI,WAAW,EAAE,EAClD,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,EAClE,aAAa,CAChB,EACD,aAAa,EACb,MAAM,CACT,CAAC;QAEF,8BAA8B;QAC9B,KAAK,CAAC,GAAG,iCACF,QAAQ,CAAC,gBAAgB;YAC5B,2CAA2C;YAC3C,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,IACjE,CAAC;QAEH,IAAI,QAAQ,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE;YAChE,QAAQ,CAAC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC;SAChE;QAED,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC5B,CAAC,CAAC,CAAC;AACX,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 { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { InstrumentedStorageTokenFetcher, IOdspUrlParts } from \"@fluidframework/odsp-driver-definitions\";\nimport { ISocketStorageDiscovery } from \"./contracts\";\nimport { getOrigin, TokenFetchOptionsEx } from \"./odspUtils\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { runWithRetry } from \"./retryUtils\";\n\ninterface IJoinSessionBody {\n    requestSocketToken?: boolean;\n    guestDisplayName?: string;\n}\n\n/**\n * Makes join session call on SPO to get information about the web socket for a document\n * @param urlParts - The SPO drive id, itemId, siteUrl that this request should be made against\n * @param path - The API path that is relevant to this request\n * @param method - The type of request, such as GET or POST\n * @param logger - A logger to use for this request\n * @param getStorageToken - A function that is able to provide the access token for this request\n * @param epochTracker - fetch wrapper which incorporates epoch logic around joinSession call\n * @param requestSocketToken - flag indicating whether joinSession is expected to return access token\n * which is used when establishing websocket connection with collab session backend service.\n * @param options - Options to fetch the token.\n * @param guestDisplayName - display name used to identify guest user joining a session.\n * This is optional and used only when collab session is being joined via invite.\n */\nexport async function fetchJoinSession(\n    urlParts: IOdspUrlParts,\n    path: string,\n    method: string,\n    logger: ITelemetryLogger,\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    epochTracker: EpochTracker,\n    requestSocketToken: boolean,\n    options: TokenFetchOptionsEx,\n    guestDisplayName?: string,\n): Promise<ISocketStorageDiscovery> {\n    const token = await getStorageToken(options, \"JoinSession\");\n\n    const extraProps = options.refresh\n        ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }\n        : {};\n    return PerformanceEvent.timedExecAsync(\n        logger, {\n            eventName: \"JoinSession\",\n            attempts: options.refresh ? 2 : 1,\n            ...extraProps,\n        },\n        async (event) => {\n            // TODO Extract the auth header-vs-query logic out\n            const siteOrigin = getOrigin(urlParts.siteUrl);\n            let queryParams = `access_token=${token}`;\n            let headers = {};\n            if (queryParams.length > 2048) {\n                queryParams = \"\";\n                headers = { Authorization: `Bearer ${token}` };\n            }\n            let body: IJoinSessionBody | undefined;\n            if (requestSocketToken || guestDisplayName) {\n                body = {};\n                if (requestSocketToken) {\n                    body.requestSocketToken = true;\n                }\n                if (guestDisplayName) {\n                    body.guestDisplayName = guestDisplayName;\n                }\n                // IMPORTANT: Must set content-type header explicitly to application/json when request has body.\n                // By default, request will use text/plain as content-type and will be rejected by backend.\n                headers[\"Content-Type\"] = \"application/json\";\n            }\n\n            const response = await runWithRetry(\n                async () => epochTracker.fetchAndParseAsJSON<ISocketStorageDiscovery>(\n                    `${getApiRoot(siteOrigin)}/drives/${\n                        urlParts.driveId\n                    }/items/${urlParts.itemId}/${path}?${queryParams}`,\n                    { method, headers, body: body ? JSON.stringify(body) : undefined },\n                    \"joinSession\",\n                ),\n                \"joinSession\",\n                logger,\n            );\n\n            // TODO SPO-specific telemetry\n            event.end({\n                ...response.commonSpoHeaders,\n                // pushV2 websocket urls will contain pushf\n                pushv2: response.content.deltaStreamSocketUrl.includes(\"pushf\"),\n            });\n\n            if (response.content.runtimeTenantId && !response.content.tenantId) {\n                response.content.tenantId = response.content.runtimeTenantId;\n            }\n\n            return response.content;\n        });\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "0.50.0",
+  "version": "0.50.4",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -58,15 +58,15 @@
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
     "@fluidframework/core-interfaces": "^0.40.0",
-    "@fluidframework/driver-base": "^0.50.0",
+    "@fluidframework/driver-base": "^0.50.4",
     "@fluidframework/driver-definitions": "^0.41.0",
-    "@fluidframework/driver-utils": "^0.50.0",
+    "@fluidframework/driver-utils": "^0.50.4",
     "@fluidframework/gitresources": "^0.1033.0",
-    "@fluidframework/odsp-doclib-utils": "^0.50.0",
-    "@fluidframework/odsp-driver-definitions": "^0.50.0",
+    "@fluidframework/odsp-doclib-utils": "^0.50.4",
+    "@fluidframework/odsp-driver-definitions": "^0.50.4",
     "@fluidframework/protocol-base": "^0.1033.0",
     "@fluidframework/protocol-definitions": "^0.1025.0",
-    "@fluidframework/telemetry-utils": "^0.50.0",
+    "@fluidframework/telemetry-utils": "^0.50.4",
     "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.23.0",
-    "@fluidframework/mocha-test-setup": "^0.50.0",
+    "@fluidframework/mocha-test-setup": "^0.50.4",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/mocha": "^8.2.2",
     "@types/node-fetch": "^2.5.10",

package/src/fetchSnapshot.ts

@@ -146,10 +146,10 @@ async function redeemSharingLink(
             eventName: "RedeemShareLink",
         },
         async () => getWithRetryForTokenRefresh(async (tokenFetchOptions) => {
-                assert(!!odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem,
+                assert(!!odspResolvedUrl.sharingLinkToRedeem,
                     0x1ed /* "Share link should be present" */);
                 const storageToken = await storageTokenFetcher(tokenFetchOptions, "RedeemShareLink");
-                const encodedShareUrl = getEncodedShareUrl(odspResolvedUrl.shareLinkInfo.sharingLinkToRedeem);
+                const encodedShareUrl = getEncodedShareUrl(odspResolvedUrl.sharingLinkToRedeem);
                 const redeemUrl = `${odspResolvedUrl.siteUrl}/_api/v2.0/shares/${encodedShareUrl}`;
                 const { url, headers } = getUrlAndHeadersWithAuth(redeemUrl, storageToken);
                 headers.prefer = "redeemSharingLink";
@@ -351,8 +351,8 @@ async function fetchSnapshotContentsCoreV1(
             }
         });
     }
-    if (odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem) {
-        formParams.push(`sl: ${odspResolvedUrl.shareLinkInfo.sharingLinkToRedeem}`);
+    if (odspResolvedUrl.sharingLinkToRedeem) {
+        formParams.push(`sl: ${odspResolvedUrl.sharingLinkToRedeem}`);
     }
     formParams.push(`_post: 1`);
     formParams.push(`\r\n--${formBoundary}--`);
@@ -398,9 +398,9 @@ async function fetchSnapshotContentsCoreV2(
     const fullUrl = `${odspResolvedUrl.siteUrl}/_api/v2.1/drives/${odspResolvedUrl.driveId}/items/${
         odspResolvedUrl.itemId}/opStream/attachments/latest/content`;
     const queryParams = { ...snapshotOptions };
-    if (odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem) {
+    if (odspResolvedUrl.sharingLinkToRedeem) {
         // eslint-disable-next-line @typescript-eslint/dot-notation
-        queryParams["sl"] = odspResolvedUrl.shareLinkInfo.sharingLinkToRedeem;
+        queryParams["sl"] = odspResolvedUrl.sharingLinkToRedeem;
     }
     const queryString = getQueryString(queryParams);
     const { url, headers } = getUrlAndHeadersWithAuth(`${fullUrl}${queryString}`, storageToken);

package/src/odspDocumentService.ts

@@ -32,7 +32,7 @@ import { IOdspCache } from "./odspCache";
 import { OdspDeltaStorageService, OdspDeltaStorageWithCache } from "./odspDeltaStorageService";
 import { OdspDocumentDeltaConnection } from "./odspDocumentDeltaConnection";
 import { OdspDocumentStorageService } from "./odspDocumentStorageManager";
-import { getWithRetryForTokenRefresh, getOdspResolvedUrl } from "./odspUtils";
+import { getWithRetryForTokenRefresh, getOdspResolvedUrl, TokenFetchOptionsEx } from "./odspUtils";
 import { fetchJoinSession } from "./vroom";
 import { isOdcOrigin } from "./odspUrlHelper";
 import { EpochTracker } from "./epochTracker";
@@ -231,35 +231,36 @@ export class OdspDocumentService implements IDocumentService {
      * @returns returns the document delta stream service for onedrive/sharepoint driver.
      */
     public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {
-        // Presence of getWebsocketToken callback dictates whether callback is used for fetching
-        // websocket token or whether it is returned with joinSession response payload
-        const requestWebsocketTokenFromJoinSession = this.getWebsocketToken === undefined;
-        const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession).catch((e) => {
-            const likelyFacetCodes = e as IFacetCodes;
-            if (Array.isArray(likelyFacetCodes.facetCodes)) {
-                for (const code of likelyFacetCodes.facetCodes) {
-                    switch (code) {
-                        case "sessionForbiddenOnPreservedFiles":
-                        case "sessionForbiddenOnModerationEnabledLibrary":
-                        case "sessionForbiddenOnRequireCheckout":
-                            // This document can only be opened in storage-only mode.
-                            // DeltaManager will recognize this error
-                            // and load without a delta stream connection.
-                            this._policies = {...this._policies,storageOnly: true};
-                            throw new DeltaStreamConnectionForbiddenError(code);
-                        default:
-                            continue;
-                    }
-                }
-            }
-            throw e;
-        });
         // Attempt to connect twice, in case we used expired token.
         return getWithRetryForTokenRefresh<IDocumentDeltaConnection>(async (options) => {
+            // Presence of getWebsocketToken callback dictates whether callback is used for fetching
+            // websocket token or whether it is returned with joinSession response payload
+            const requestWebsocketTokenFromJoinSession = this.getWebsocketToken === undefined;
             const websocketTokenPromise = requestWebsocketTokenFromJoinSession
                 ? Promise.resolve(null)
                 : this.getWebsocketToken!(options);
 
+            const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options).catch((e) => {
+                const likelyFacetCodes = e as IFacetCodes;
+                if (Array.isArray(likelyFacetCodes.facetCodes)) {
+                    for (const code of likelyFacetCodes.facetCodes) {
+                        switch (code) {
+                            case "sessionForbiddenOnPreservedFiles":
+                            case "sessionForbiddenOnModerationEnabledLibrary":
+                            case "sessionForbiddenOnRequireCheckout":
+                                // This document can only be opened in storage-only mode.
+                                // DeltaManager will recognize this error
+                                // and load without a delta stream connection.
+                                this._policies = {...this._policies,storageOnly: true};
+                                throw new DeltaStreamConnectionForbiddenError(code);
+                            default:
+                                continue;
+                        }
+                    }
+                }
+                throw e;
+            });
+
             const [websocketEndpoint, websocketToken, io] =
                 await Promise.all([
                     joinSessionPromise,
@@ -294,7 +295,10 @@ export class OdspDocumentService implements IDocumentService {
         });
     }
 
-    private async joinSession(requestSocketToken: boolean): Promise<ISocketStorageDiscovery> {
+    private async joinSession(
+        requestSocketToken: boolean,
+        options: TokenFetchOptionsEx,
+    ): Promise<ISocketStorageDiscovery> {
         const executeFetch = async () =>
             fetchJoinSession(
                 this.odspResolvedUrl,
@@ -304,6 +308,7 @@ export class OdspDocumentService implements IDocumentService {
                 this.getStorageToken,
                 this.epochTracker,
                 requestSocketToken,
+                options,
                 this.hostPolicy.sessionOptions?.unauthenticatedUserDisplayName,
             );
 

package/src/packageVersion.ts

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

package/src/vroom.ts

@@ -7,7 +7,7 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { InstrumentedStorageTokenFetcher, IOdspUrlParts } from "@fluidframework/odsp-driver-definitions";
 import { ISocketStorageDiscovery } from "./contracts";
-import { getWithRetryForTokenRefresh, getOrigin } from "./odspUtils";
+import { getOrigin, TokenFetchOptionsEx } from "./odspUtils";
 import { getApiRoot } from "./odspUrlHelper";
 import { EpochTracker } from "./epochTracker";
 import { runWithRetry } from "./retryUtils";
@@ -19,9 +19,7 @@ interface IJoinSessionBody {
 
 /**
  * Makes join session call on SPO to get information about the web socket for a document
- * @param driveId - The SPO drive id that this request should be made against
- * @param itemId -The SPO item id that this request should be made against
- * @param siteUrl - The SPO site that this request should be made against
+ * @param urlParts - The SPO drive id, itemId, siteUrl that this request should be made against
  * @param path - The API path that is relevant to this request
  * @param method - The type of request, such as GET or POST
  * @param logger - A logger to use for this request
@@ -29,6 +27,7 @@ interface IJoinSessionBody {
  * @param epochTracker - fetch wrapper which incorporates epoch logic around joinSession call
  * @param requestSocketToken - flag indicating whether joinSession is expected to return access token
  * which is used when establishing websocket connection with collab session backend service.
+ * @param options - Options to fetch the token.
  * @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.
  */
@@ -40,67 +39,66 @@ export async function fetchJoinSession(
     getStorageToken: InstrumentedStorageTokenFetcher,
     epochTracker: EpochTracker,
     requestSocketToken: boolean,
+    options: TokenFetchOptionsEx,
     guestDisplayName?: string,
 ): Promise<ISocketStorageDiscovery> {
-    return getWithRetryForTokenRefresh(async (options) => {
-        const token = await getStorageToken(options, "JoinSession");
+    const token = await getStorageToken(options, "JoinSession");
 
-        const extraProps = options.refresh
-            ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }
-            : {};
-        return PerformanceEvent.timedExecAsync(
-            logger, {
-                eventName: "JoinSession",
-                attempts: options.refresh ? 2 : 1,
-                ...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}` };
+    const extraProps = options.refresh
+        ? { hasClaims: !!options.claims, hasTenantId: !!options.tenantId }
+        : {};
+    return PerformanceEvent.timedExecAsync(
+        logger, {
+            eventName: "JoinSession",
+            attempts: options.refresh ? 2 : 1,
+            ...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;
                 }
-                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";
+                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 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 },
-                        "joinSession",
-                    ),
+            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 },
                     "joinSession",
-                    logger,
-                );
+                ),
+                "joinSession",
+                logger,
+            );
 
-                // TODO SPO-specific telemetry
-                event.end({
-                    ...response.commonSpoHeaders,
-                    // pushV2 websocket urls will contain pushf
-                    pushv2: response.content.deltaStreamSocketUrl.includes("pushf"),
-                });
+            // TODO SPO-specific telemetry
+            event.end({
+                ...response.commonSpoHeaders,
+                // pushV2 websocket urls will contain pushf
+                pushv2: response.content.deltaStreamSocketUrl.includes("pushf"),
+            });
 
-                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;
+        });
 }