fix: remove the SdkVersion header when redirected to a non-graph endpoint (#1947)

This happens during large file upload as some endpoints throw a CORS error when the SdkVersion header is attached. This change deletes the header from the request object when the request endpoint is a non-graph endpoint.

Co-authored-by: Sébastien Levert <[email protected]>
Co-authored-by: Gavin Barron <[email protected]>

Author: 3 people

packages/mgt-element/src/IGraph.ts

@@ -66,3 +66,24 @@ export interface IGraph {
    */
   createBatch(): IBatch;
 }
+
+export type GraphEndpoint =
+  | 'https://graph.microsoft.com'
+  | 'https://graph.microsoft.us'
+  | 'https://dod-graph.microsoft.us'
+  | 'https://graph.microsoft.de'
+  | 'https://microsoftgraph.chinacloudapi.cn';
+
+export const MICROSOFT_GRAPH_ENDPOINTS: Set<GraphEndpoint> = new Set<GraphEndpoint>();
+export const MICROSOFT_GRAPH_DEFAULT_ENDPOINT: GraphEndpoint = 'https://graph.microsoft.com';
+
+(() => {
+  const endpoints: GraphEndpoint[] = [
+    MICROSOFT_GRAPH_DEFAULT_ENDPOINT,
+    'https://graph.microsoft.us',
+    'https://dod-graph.microsoft.us',
+    'https://graph.microsoft.de',
+    'https://microsoftgraph.chinacloudapi.cn'
+  ];
+  endpoints.forEach(endpoint => MICROSOFT_GRAPH_ENDPOINTS.add(endpoint));
+})();

packages/mgt-element/src/utils/GraphHelpers.ts

@@ -6,7 +6,7 @@
  */
 
 import { AuthenticationHandlerOptions, Middleware } from '@microsoft/microsoft-graph-client';
-import { Providers } from '..';
+import { GraphEndpoint, MICROSOFT_GRAPH_ENDPOINTS, Providers } from '..';
 
 /**
  * creates an AuthenticationHandlerOptions from scopes array that
@@ -46,3 +46,20 @@ export function chainMiddleware(...middleware: Middleware[]): Middleware {
   }
   return rootMiddleware;
 }
+
+/**
+ * Helper method to validate a base URL string
+ * @param url a URL string
+ * @returns GraphEndpoint
+ */
+export function validateBaseURL(url: string): GraphEndpoint {
+  try {
+    const urlObj = new URL(url);
+    const originAsEndpoint = urlObj.origin as GraphEndpoint;
+    if (MICROSOFT_GRAPH_ENDPOINTS.has(originAsEndpoint)) {
+      return originAsEndpoint;
+    }
+  } catch (error) {
+    return;
+  }
+}

packages/mgt-element/src/utils/SdkVersionMiddleware.ts

@@ -8,6 +8,7 @@
 import { Context, Middleware } from '@microsoft/microsoft-graph-client';
 import { getRequestHeader, setRequestHeader } from '@microsoft/microsoft-graph-client/lib/es/middleware/MiddlewareUtil';
 import { ComponentMiddlewareOptions } from './ComponentMiddlewareOptions';
+import { validateBaseURL } from './GraphHelpers';
 
 /**
  * Implements Middleware for the Graph sdk to inject
@@ -33,33 +34,39 @@ export class SdkVersionMiddleware implements Middleware {
   // tslint:disable-next-line: completed-docs
   public async execute(context: Context): Promise<void> {
     try {
-      // Header parts must follow the format: 'name/version'
-      const headerParts: string[] = [];
+      if (typeof context.request === 'string') {
+        if (validateBaseURL(context.request)) {
+          // Header parts must follow the format: 'name/version'
+          const headerParts: string[] = [];
 
-      const componentOptions = context.middlewareControl.getMiddlewareOptions(
-        ComponentMiddlewareOptions
-      ) as ComponentMiddlewareOptions;
+          const componentOptions = context.middlewareControl.getMiddlewareOptions(
+            ComponentMiddlewareOptions
+          ) as ComponentMiddlewareOptions;
 
-      if (componentOptions) {
-        const componentVersion: string = `${componentOptions.componentName}/${this._packageVersion}`;
-        headerParts.push(componentVersion);
-      }
+          if (componentOptions) {
+            const componentVersion: string = `${componentOptions.componentName}/${this._packageVersion}`;
+            headerParts.push(componentVersion);
+          }
 
-      if (this._providerName) {
-        const providerVersion: string = `${this._providerName}/${this._packageVersion}`;
-        headerParts.push(providerVersion);
-      }
+          if (this._providerName) {
+            const providerVersion: string = `${this._providerName}/${this._packageVersion}`;
+            headerParts.push(providerVersion);
+          }
 
-      // Package version
-      const packageVersion: string = `mgt/${this._packageVersion}`;
-      headerParts.push(packageVersion);
+          // Package version
+          const packageVersion: string = `mgt/${this._packageVersion}`;
+          headerParts.push(packageVersion);
 
-      // Existing SdkVersion header value
-      headerParts.push(getRequestHeader(context.request, context.options, 'SdkVersion'));
+          // Existing SdkVersion header value
+          headerParts.push(getRequestHeader(context.request, context.options, 'SdkVersion'));
 
-      // Join the header parts together and update the SdkVersion request header value
-      const sdkVersionHeaderValue = headerParts.join(', ');
-      setRequestHeader(context.request, context.options, 'SdkVersion', sdkVersionHeaderValue);
+          // Join the header parts together and update the SdkVersion request header value
+          const sdkVersionHeaderValue = headerParts.join(', ');
+          setRequestHeader(context.request, context.options, 'SdkVersion', sdkVersionHeaderValue);
+        } else {
+          delete context?.options?.headers['SdkVersion'];
+        }
+      }
     } catch (error) {
       // ignore error
     }