feat(frontend)!: rename OpenIdProvider.GitHub to OpenIdProvider.GitHubAuth #2544
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.
Motivation
I should have thought about it when I introduced GitHub login: we do not want the enum to be called
GitHubbut, something else e.g.GitHubAuthorGitHubProxy, because we might use also other official JWT generated by GitHub such as those for actions #2539.While it's not used yet in the Satellite and would not be an issue, it's already live in the Console and few users (not much like 4 at this time) have created an account with it means, in stable memory we have "GitHub" that is saved. I can potentially migrate those data but, to some extent, it's kind of correct to have such a field in memory. Plus using serde I could potentially live with it.
But, in the other hand, if we introduce additional providers for Jwt, we might not want to have all those providers being accepted for completing an authentication and signing a delegation. Typically in #2539 that's not the case.
Finally, the observatory must be able to fetch jwks certificate for any of the providers.
Long story short, the idea is to have an enum
OpenIdProviderthat contains all the provider but, separate providers for saving data in the state as e.g.OpenIdDelegationProviderintroduced here.We rename
GitHubtoGitHubAuthinOpenIdProviderthat's a breaking changes that affect the cache of certificates and configuration of the Console but, we declareOpenIdDelegationProviderwithGoogleandGitHubas enum value so this field is backwards compatible.