Add extraQueryParams for api calls #7974
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
yongdiw requested review from hectormmg, jo-arroyo, konstantin-msft, lalimasharda, peterzenz, sameerag, shylasummers and tnorling as code owners 
There was a problem hiding this comment.
Pull Request Overview
This pull request adds support for passing extra query parameters (dc and slice) to custom authentication API requests in the MSAL browser library. This enhancement enables clients to specify datacenter and slice information in API calls for improved routing and flexibility.
- Added
extraQueryParametersto configuration types with typed keys fordcandslice - Updated API client constructors to accept and propagate extra query parameters throughout the client stack
- Introduced URL utility function to safely add/overwrite query parameters in API requests
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| CustomAuthConfiguration.ts | Added QueryKey type and extraQueryParameters field to CustomAuthOptions |
| CustomAuthStandardController.ts | Updated to pass extraQueryParameters from config to CustomAuthApiClient |
| CustomAuthApiClient.ts | Modified constructor to accept and pass extraQueryParameters to child API clients |
| BaseApiClient.ts | Updated constructor to accept extraQueryParameters and use new URL utility to append them |
| UrlUtils.ts | Added addQueryParametersToUrl utility function for safe query parameter handling |
| UrlUtils.spec.ts | Added comprehensive tests for the new addQueryParametersToUrl function |
| CustomAuthApiClient.spec.ts | Added tests for constructor with various extraQueryParameters scenarios |
shenj reviewed Aug 13, 2025
lib/msal-browser/src/custom_auth/configuration/CustomAuthConfiguration.ts Outdated Show resolved Hide resolved
shenj reviewed Aug 13, 2025
shenj previously approved these changes Aug 14, 2025
hectormmg previously approved these changes Aug 22, 2025
change/@azure-msal-browser-e3d4b10b-bba6-47de-9ff2-7ee4039bb97e.json Outdated Show resolved Hide resolved
hectormmg previously approved these changes Aug 25, 2025
shenj reviewed Aug 27, 2025
lib/msal-browser/src/custom_auth/configuration/CustomAuthConfiguration.ts Outdated Show resolved Hide resolved
shenj approved these changes Aug 27, 2025
hectormmg approved these changes Aug 27, 2025
yongdiw added a commit that referenced this pull request Aug 28, 2025
yongdiw added a commit that referenced this pull request Sep 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
This pull request adds support for passing extra query parameters (
dcandslice) to custom authentication API requests in the MSAL browser library. This enhancement allows clients to specify datacenter and slice information in API calls, improving flexibility and routing capabilities. The changes include updates to configuration types, API client constructors, URL building utilities, and comprehensive tests to ensure correct behavior.Support for extra query parameters in custom authentication:
extraQueryParameters(with keysdcandslice) toCustomAuthOptionsand associated types, enabling clients to specify additional query parameters for custom authentication requests.BaseApiClientandCustomAuthApiClientto accept and propagateextraQueryParameters, ensuring these parameters are available throughout the API client stack. [1] [2]URL utilities and API request handling:
addQueryParametersToUrlutility function inUrlUtils.ts, which safely adds/overwrites query parameters in URLs, and integrated this function into API request construction to append the extra parameters to outgoing requests. [1] [2] [3]Testing and validation:
CustomAuthApiClientandaddQueryParametersToUrlto verify correct handling of extra query parameters, including cases for single, multiple, undefined, empty, and overwriting scenarios. [1] [2] [3]