feat: add support for GCC and other sovereign clouds #1928

musale · 2022-11-02T14:52:46Z

Closes #1030

PR Type

Feature

Description of the changes

Updated how we create the graph client from provider to include setting the baseUrl config value. By default, it is https://graph.microsoft.com but you can now set it to any of these:
- https://graph.microsoft.us
- https://dod-graph.microsoft.us
- https://graph.microsoft.de - this appears to be moved according to https://learn.microsoft.com/en-us/azure/active-directory/develop/msal-national-cloud?tabs=javascript#azure-germany-microsoft-cloud-deutschland
- https://microsoftgraph.chinacloudapi.cn
Added a configurable attribute base-url in the MSAL2Provider, MsalProvider, TeamsMsalProvider, TeamsMsal2Provider to allow setting the base URL you want to use in the graph client.
Added a default baseURL argument to ElectronProvider, SharepointProvider and .handleAuth() method in the teams providers.

PR checklist

Project builds (yarn build) and changes have been tested in at least two supported browsers (Edge + non-Chromium based browser)
All public APIs (classes, methods, etc) have been documented following the jsdoc syntax
Stories have been added and existing stories have been tested
Added appropriate documentation. Docs PR: https://github.com/microsoftgraph/microsoft-graph-docs/pull/19229

License header has been added to all new source files (yarn setLicense)
Contains NO breaking changes

Other information

You can set the baseURL when initializing your provider like this:

Usage

This sets the baseUrl for the MSAL2Provider, MsalProvider, TeamsMsalProvider and TeamsMsal2Provider .

<mgt-msal2-provider
      client-id="2dfea037-938a-4ed8-9b35-c05708a1b241"
      redirect-uri="http://localhost:3000"
      base-url="https://dod-graph.microsoft.us"
      scopes="user.read,user.read.all">
</mgt-msal2-provider>

<mgt-msal-provider
      client-id="2dfea037-938a-4ed8-9b35-c05708a1b241"
      redirect-uri="http://localhost:3000"
      base-url="https://dod-graph.microsoft.us"
      scopes="user.read,user.read.all">
</mgt-msal-provider>

In Teams, you have to call handleAuth first to handle all client side auth or permission consent.

<html>
  <head>
    <script src="https://unpkg.com/@microsoft/teams-js/dist/MicrosoftTeams.min.js" crossorigin="anonymous"></script>
    <script>
      mgt.TeamsProvider.handleAuth(baseUrl="https://dod-graph.microsoft.us");
    </script> -->
    <script type="module">
      // import { TeamsProvider } from './packages/providers/mgt-teams-provider/dist/es6/TeamsProvider.js';
      // TeamsProvider.handleAuth();

      import { TeamsMsal2Provider } from './packages/providers/mgt-teams-msal2-provider/dist/es6/TeamsMsal2Provider.js';
      TeamsMsal2Provider.handleAuth(baseUrl="https://dod-graph.microsoft.us");
    </script>
  </head>
  <body>
    Signing You In...
  </body>
</html>

<mgt-teams-msal2-provider
      client-id="2dfea037-938a-4ed8-9b35-c05708a1b241"
      redirect-uri="http://localhost:3000"
      base-url="https://dod-graph.microsoft.us"
      scopes="user.read,user.read.all">
</mgt-teams-msal2-provider>

<mgt-teams-msal-provider
      client-id="2dfea037-938a-4ed8-9b35-c05708a1b241"
      redirect-uri="http://localhost:3000"
      base-url="https://dod-graph.microsoft.us"
      scopes="user.read,user.read.all">
</mgt-teams-msal2-provider>

This sets the baseURL for ElectronProvider

import { ElectronProvider } from '@microsoft/mgt-electron-provider';
Providers.globalProvider = new ElectronProvider(baseUrl="https://dod-graph.microsoft.us");

This sets the baseURL for SharePointProvider

import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';

// import the providers at the top of the page
import { Providers, SharePointProvider } from '@microsoft/mgt-spfx';

export interface IMgtDemoWebPartProps {
  description: string;
}

export default class MgtDemoWebPart extends BaseClientSideWebPart<IMgtDemoWebPartProps> {
  // set the global provider
  protected async onInit() {
    Providers.globalProvider = new SharePointProvider(this.context, baseUrl="https://dod-graph.microsoft.us");
  }
// Rest of the code

base-url specifies a base url for the graph client config. It is optional and defaults to https://graph.microsoft.com. With this attribute, you can pass in any of the GCC and national clouds urls

ghost · 2022-11-02T14:52:59Z

Thank you for creating a Pull Request @musale.

This is a checklist for the PR reviewer(s) to complete before approving and merging this PR:

I have verified a documentation PR has been linked and is approved (or not applicable)
I have ran this PR locally and have tested the fix/feature
I have verified that stories have been added to storybook (or not applicable)
I have tested existing stories in storybook to verify no regression has occured
I have tested the solution in at least two browsers (Edge + 1 non-Chromium based browser)

sebastienlevert · 2022-11-02T15:43:32Z

Would love to see in the PR some of the usage on different providers. Probably via the packages README?

packages/mgt-element/src/IGraph.ts

musale · 2022-11-03T11:56:25Z

Would love to see in the PR some of the usage on different providers. Probably via the packages README?

Yes! I'm doing incremental updates per provider BUT on this same PR. The final result is all providers supporting the approach and fully documented in all the relevant places.

You can set a baseURL when calling the electron provider. Additional refactors to fix tsc errors

Since it uses Msal2Provider, all we do is pass the base URL where Msal2Provider is called

Since it uses MsalProvider, all we do is pass the base URL where MsalProvider is called

The baseUrl is passed during initialization. The default is already set to MICROSOFT_GRAPH_DEFAULT_ENDPOINT

…raph-toolkit into musale/support-gcc

gavinbarron

I'm not quite clear why we're doing so much repeated work in each of the providers and not pushing that work to the base classes.

packages/mgt-element/src/providers/IProvider.ts

packages/providers/mgt-msal-provider/src/mgt-msal-provider.ts

musale · 2022-11-15T15:05:35Z

I'm not quite clear why we're doing so much repeated work in each of the providers and not pushing that work to the base classes.

Oh my! That completely escaped my refactors. Let me mop up and hopefully reduce the changes.

packages/mgt-element/src/components/baseProvider.ts

packages/providers/mgt-electron-provider/src/Authenticator/ElectronAuthenticator.ts

packages/providers/mgt-msal-provider/src/mgt-msal-provider.ts

packages/mgt-element/src/Graph.ts

packages/mgt-element/src/components/baseProvider.ts

packages/mgt-element/src/providers/IProvider.ts

packages/providers/mgt-electron-provider/src/Authenticator/ElectronAuthenticator.ts

packages/mgt-element/src/IGraph.ts

…raph-toolkit into musale/support-gcc

…orted types

…oft-graph-toolkit into musale/support-gcc

Co-authored-by: Gavin Barron <[email protected]>

* feat: add support for configuring the base URL in the graph client * feat: add base-url attribute to Msal2Provider base-url specifies a base url for the graph client config. It is optional and defaults to https://graph.microsoft.com. With this attribute, you can pass in any of the GCC and national clouds urls * refactor: use GraphEndpoint type instead of string * refactor: move validating base URL to utility function * fix: use new URL().origin to validate the base URL * feat: set baseURL when you initialize with clientID * feat: update the types on the declared variable * fix: cast string to GraphEndpoint type in validation * feat: update MsalProvider to use base-url property * feat: update the ElectronProvider to set a baseURL You can set a baseURL when calling the electron provider. Additional refactors to fix tsc errors * feat: add base url to Sharepoint provider * feat: add base-url attribute to TeamsMsal2Provider Since it uses Msal2Provider, all we do is pass the base URL where Msal2Provider is called * feat: add base-url attribute to TeamsMsalProvider Since it uses MsalProvider, all we do is pass the base URL where MsalProvider is called * feat: add base-url attribute to TeamsFxProvider The baseUrl is passed during initialization. The default is already set to MICROSOFT_GRAPH_DEFAULT_ENDPOINT * feat: change to validating the baseUrl before initializing the client * refactor: set the baseURL default value in constractor * refactor: set the baseURL default value in constructor * feat: add base-url to the baseProvider * refactor: remove re-declaration of property in base class * fix: validate base URL string in the IProvider * fix: do the validation when setting the baseURL * refactor/docs: use one check to get all accounts and document the exported types * fix: remove duplicate import * fix: set licence text on all files * fix: updaet the memberof value of the base provider Co-authored-by: Gavin Barron <[email protected]> Co-authored-by: Gavin Barron <[email protected]>

musale added 2 commits November 2, 2022 17:31

feat: add support for configuring the base URL in the graph client

70def15

feat: add base-url attribute to Msal2Provider

6493323

base-url specifies a base url for the graph client config. It is optional and defaults to https://graph.microsoft.com. With this attribute, you can pass in any of the GCC and national clouds urls

musale added this to the v3.0.0 milestone Nov 2, 2022

musale requested review from gavinbarron, sebastienlevert and Mnickii November 2, 2022 14:52

gavinbarron requested changes Nov 2, 2022

View reviewed changes

packages/mgt-element/src/IGraph.ts Show resolved Hide resolved

ghost added Needs: Author Feedback Issue needs response from issue author and removed Needs: Author Feedback Issue needs response from issue author labels Nov 2, 2022

musale added 16 commits November 3, 2022 16:28

refactor: use GraphEndpoint type instead of string

7a6913e

refactor: move validating base URL to utility function

dec32b7

fix: use new URL().origin to validate the base URL

2b6a4e6

feat: set baseURL when you initialize with clientID

da24b0a

feat: update the types on the declared variable

4d3e4dd

fix: cast string to GraphEndpoint type in validation

6c5e538

feat: update MsalProvider to use base-url property

9e24392

feat: update the ElectronProvider to set a baseURL

461d2cf

You can set a baseURL when calling the electron provider. Additional refactors to fix tsc errors

feat: add base url to Sharepoint provider

d5a9ba3

feat: add base-url attribute to TeamsMsal2Provider

626ad5b

Since it uses Msal2Provider, all we do is pass the base URL where Msal2Provider is called

feat: add base-url attribute to TeamsMsalProvider

31aee59

Since it uses MsalProvider, all we do is pass the base URL where MsalProvider is called

feat: add base-url attribute to TeamsFxProvider

48b4bce

The baseUrl is passed during initialization. The default is already set to MICROSOFT_GRAPH_DEFAULT_ENDPOINT

feat: change to validating the baseUrl before initializing the client

9a7d2d1

refactor: set the baseURL default value in constractor

7249fa1

refactor: set the baseURL default value in constructor

5f6970c

Merge branch 'next/fluentui' of github.com:microsoftgraph/microsoft-g…

65590a4

…raph-toolkit into musale/support-gcc

gavinbarron linked an issue Nov 8, 2022 that may be closed by this pull request

[Feature] Add support for GCC and other clouds #1030

Closed

gavinbarron removed a link to an issue Nov 8, 2022

[Feature] Add support for GCC and other clouds #1030

Closed

gavinbarron linked an issue Nov 8, 2022 that may be closed by this pull request

[Feature] Add support for GCC and other clouds #1030

Closed

musale marked this pull request as ready for review November 14, 2022 11:29

musale requested a review from gavinbarron November 14, 2022 11:29

gavinbarron reviewed Nov 14, 2022

View reviewed changes

packages/mgt-element/src/providers/IProvider.ts Outdated Show resolved Hide resolved

packages/providers/mgt-msal-provider/src/mgt-msal-provider.ts Outdated Show resolved Hide resolved

musale added 3 commits November 15, 2022 18:19

feat: add base-url to the baseProvider

e3debfd

refactor: remove re-declaration of property in base class

23fe581

fix: validate base URL string in the IProvider

aaf3e1f

sebastienlevert removed this from the v3.0.0 milestone Nov 29, 2022

gavinbarron requested changes Nov 29, 2022

View reviewed changes

ghost added the Needs: Author Feedback Issue needs response from issue author label Nov 29, 2022

musale added 2 commits December 2, 2022 11:25

Merge branch 'next/fluentui' of github.com:microsoftgraph/microsoft-g…

3e83174

…raph-toolkit into musale/support-gcc

fix: do the validation when setting the baseURL

89133b2

ghost removed the Needs: Author Feedback Issue needs response from issue author label Dec 2, 2022

musale added 3 commits December 2, 2022 12:04

refactor/docs: use one check to get all accounts and document the exp…

62dcbbc

…orted types

Merge branch 'musale/support-gcc' of github.com:microsoftgraph/micros…

e8c8c29

…oft-graph-toolkit into musale/support-gcc

fix: remove duplicate import

7f0ca96

musale requested a review from gavinbarron December 2, 2022 09:07

musale and others added 2 commits December 2, 2022 12:08

fix: set licence text on all files

10dc01f

fix: updaet the memberof value of the base provider

393a36c

Co-authored-by: Gavin Barron <[email protected]>

gavinbarron approved these changes Dec 5, 2022

View reviewed changes

sebastienlevert merged commit 1edf635 into next/fluentui Dec 6, 2022

sebastienlevert deleted the musale/support-gcc branch December 6, 2022 16:30

gavinbarron mentioned this pull request Dec 13, 2022

[Feature] Add support for GCC and other clouds #1030

Closed

This was referenced Jul 17, 2023

chore(release-please/bootstrap/default): release 3.0.1 #2607

Closed

chore(main): release 4.0.0 #2612

Closed

chore(main): release 3.0.1 #2615

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for GCC and other sovereign clouds #1928

feat: add support for GCC and other sovereign clouds #1928

musale commented Nov 2, 2022 •

edited

Loading

ghost commented Nov 2, 2022

sebastienlevert commented Nov 2, 2022

musale commented Nov 3, 2022

gavinbarron left a comment

musale commented Nov 15, 2022

feat: add support for GCC and other sovereign clouds #1928

feat: add support for GCC and other sovereign clouds #1928

Conversation

musale commented Nov 2, 2022 • edited Loading

PR Type

Description of the changes

PR checklist

Other information

Usage

ghost commented Nov 2, 2022

sebastienlevert commented Nov 2, 2022

musale commented Nov 3, 2022

gavinbarron left a comment

Choose a reason for hiding this comment

musale commented Nov 15, 2022

musale commented Nov 2, 2022 •

edited

Loading