Refactor global Web PubSub connection Options setup in preparation fo… #54209
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
…r AAD * Abstract Web PubSub access credential into a new class, unifies identity-based connection and key-based connection * Add a util class to create Web PubSub access object from conneciton string or identity-based connection * Unify global service access info into `WebPubSubServiceAccessOptions`.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the Web PubSub connection configuration to prepare for Azure Active Directory (AAD) authentication support. It abstracts the access credentials into a unified model that supports both key-based and identity-based authentication.
- Introduces a credential abstraction layer with
WebPubSubServiceCredential,KeyCredential, andIdentityCredentialclasses - Adds utility class
WebPubSubServiceAccessUtilto parse connection strings and read identity-based configuration - Unifies service access information into
WebPubSubServiceAccessOptionswith corresponding setup class
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| WebPubSubServiceCredential.cs | Defines abstract credential base class with KeyCredential and IdentityCredential implementations |
| WebPubSubServiceAccess.cs | Encapsulates service endpoint and credential information |
| WebPubSubServiceAccessUtil.cs | Provides utility methods to create service access from connection strings and configuration |
| WebPubSubServiceAccessOptions.cs | Options class for global service access configuration |
| WebPubSubServiceAccessOptionsSetup.cs | Configures service access options from multiple configuration sources |
| WebPubSubJobsBuilderExtensions.cs | Registers the new options setup and Azure client dependencies |
| Constants.cs | Adds serviceUri constant for identity-based connections |
| Microsoft.Azure.WebJobs.Extensions.WebPubSub.csproj | Adds Microsoft.Extensions.Azure package reference and removes API compatibility check |
| WebPubSubServiceAccessUtilTests.cs | Comprehensive tests for the utility class methods |
| WebPubSubServiceAccessOptionsSetupTests.cs | Tests for options setup configuration logic |
Comment on lines
+89
to
+90
| var tokenCrential = azureComponentFactory.CreateTokenCredential(section); | ||
| result = new WebPubSubServiceAccess(endpoint, new IdentityCredential(tokenCrential)); |
There was a problem hiding this comment.
Corrected spelling of 'tokenCrential' to 'tokenCredential'.
Suggested change
| var tokenCrential = azureComponentFactory.CreateTokenCredential(section); | |
| result = new WebPubSubServiceAccess(endpoint, new IdentityCredential(tokenCrential)); | |
| var tokenCredential = azureComponentFactory.CreateTokenCredential(section); | |
| result = new WebPubSubServiceAccess(endpoint, new IdentityCredential(tokenCredential)); |
Comment on lines
+41
to
+42
| Assert.IsNotNull(options.DefaultWebPubSubAccess); | ||
| Assert.AreEqual(new System.Uri(TestServiceUri), options.DefaultWebPubSubAccess.ServiceEndpoint); |
There was a problem hiding this comment.
The tests reference DefaultWebPubSubAccess property, but the actual implementation in WebPubSubServiceAccessOptions uses WebPubSubAccess as the property name. This mismatch will cause the tests to fail at compilation.
| Assert.IsNotNull(result); | ||
| Assert.AreEqual(new Uri(serviceUri), result.ServiceEndpoint); | ||
| Assert.IsInstanceOf<IdentityCredential>(result.Credential); | ||
| var identityCredential = (IdentityCredential)result.Credential; |
There was a problem hiding this comment.
The variable identityCredential is declared but never used. Either remove this unused variable or add assertions to verify its properties.
Suggested change
| var identityCredential = (IdentityCredential)result.Credential; |
jsquire
requested changes
Nov 28, 2025
| <Version>1.10.0-beta.1</Version> | ||
| <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.--> | ||
| <ApiCompatVersion>1.9.0</ApiCompatVersion> | ||
| <!--Removed ApiCompatVersion to skip ApiCompatability check to update binding attributes. They'll be added back automatically after release.--> |
Member
There was a problem hiding this comment.
Please revert. API Compat checks are required. If its failing, then you've got a binary breaking change which is not permitted.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
…r AAD
WebPubSubServiceAccessOptions.