Remove references to instance aware #8143
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR removes documentation references to the instance-aware flow feature from MSAL.js. The instance-aware flow allowed applications to indicate which cloud instance tokens were obtained from and which Microsoft Graph hosts they could be used with.
Key changes:
- Removed the instance-aware documentation file entirely
- Removed references to instance-aware documentation from the README and authority documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| lib/msal-common/docs/authority.md | Removed bullet point referencing instance-aware flow documentation |
| lib/msal-browser/docs/instance-aware.md | Deleted entire documentation file describing instance-aware configuration and usage |
| lib/msal-browser/README.md | Removed link to instance-aware documentation from the README |
Comments suppressed due to low confidence (1)
lib/msal-browser/docs/instance-aware.md:1
- This PR removes the instance-aware documentation file but does not remove the actual implementation code. The
instanceAwareconfiguration option andinstance_awarequery parameter are still implemented in:
-
Configuration files:
lib/msal-browser/src/config/Configuration.ts(line 92, 258)lib/msal-common/src/config/ClientConfiguration.ts(line 82, 92, 261)
-
Implementation code:
lib/msal-browser/src/interaction_client/BaseInteractionClient.ts(lines 159-177)lib/msal-common/src/client/AuthorizationCodeClient.ts(line 579-581)lib/msal-common/src/protocol/Authorize.ts(lines 256-265)
-
API surface:
lib/msal-browser/apiReview/msal-browser.api.md(line 287)lib/msal-common/apiReview/msal-common.api.md(line 612)
-
Tests:
- Multiple test files in both msal-browser and msal-common
If the intent is to deprecate this feature, you should also:
- Remove the implementation code
- Remove the configuration options
- Update the API review files
- Remove or update related tests
- Add deprecation notices if this is a phased removal
- Create a migration guide if applications are using this feature
Additionally, lib/msal-browser/docs/configuration.md line 86 still documents the instanceAware configuration option and should be removed.
| - [Cache Storage](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/caching.md) | ||
| - [Performance Enhancements](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/performance.md) | ||
| - [Instance Aware Flow](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/instance-aware.md) | ||
|
|
There was a problem hiding this comment.
The instanceAware configuration option is still documented in lib/msal-browser/docs/configuration.md at line 86. This entry should be removed to be consistent with the removal of the instance-aware documentation file.
| - You can obtain the authority URL required for your app via the **Endpoints** panel on the Azure portal [App Registration](https://aka.ms/appregistrations) experience. | ||
| - You can improve MSAL's performance during token acquisition by providing authority information out-of-band. See [Performance](./performance.md) for how to do so. | ||
| - When working with national/regional clouds, consider using the [instance-aware](../../msal-browser/docs/instance-aware.md) flow, which indicates the particular instance the tokens are obtained from and Microsoft Graph hosts that they can be used with. | ||
|
|
There was a problem hiding this comment.
This PR requires a beachball change file since it modifies documentation in the msal-browser and msal-common packages. Run npm run beachball:change from the repository root and select the appropriate change type (likely "patch" for documentation-only changes, or "minor"/"major" if this represents a feature deprecation).
Moving docs to 1P