Repository navigation
Conversation
Rename ISSOIntegrationProvider.startAuthenticationWorflow() to startAuthenticationWorkflow() across the interface, built-in providers, the Auth handler and the test-harness provider. BaseProvider keeps the misspelled name as a deprecated alias, and Auth.start() falls back to it for custom providers that only define the old name.
There was a problem hiding this comment.
🟡 Changes recommended
Legacy overrides on built-in provider subclasses can be bypassed, and the tests do not verify handler dispatch or fallback behavior.
2 open findings
What changed in this PR
Corrects the provider authentication workflow typo while retaining backward compatibility.
Changes:
- Renames the provider contract and implementations.
- Adds deprecated alias and handler fallback logic.
- Adds regression coverage and changelog documentation.
| File | Description |
|---|---|
handlers/Auth.cfc |
Dispatches to the corrected method with legacy fallback. |
models/ISSOIntegrationProvider.cfc |
Corrects the interface method name. |
models/providers/BaseProvider.cfc |
Adds the deprecated alias. |
models/providers/GoogleProvider.cfc |
Renames the workflow method. |
models/providers/GitHubProvider.cfc |
Renames the workflow method. |
models/providers/FacebookProvider.cfc |
Renames the workflow method. |
models/providers/MicrosoftSAMLProvider.cfc |
Renames the workflow method. |
test-harness/models/CustomProvider.cfc |
Updates the test provider and adds an alias. |
test-harness/tests/specs/AuthHandlerSpec.cfc |
Adds compatibility assertions. |
changelog.md |
Documents the correction and compatibility behavior. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+27
to
+30
| if ( structKeyExists( prc.ssoProvider, "startAuthenticationWorkflow" ) ) { | ||
| relocate( url = prc.ssoProvider.startAuthenticationWorkflow( event ) ); | ||
| } else { | ||
| relocate( url = prc.ssoProvider.startAuthenticationWorflow( event ) ); |
Comment on lines
+62
to
+65
| it( "keeps the deprecated startAuthenticationWorflow alias working on providers", function(){ | ||
| var provider = getInstance( "CustomProvider" ); | ||
| expect( provider.startAuthenticationWorflow( getRequestContext() ) ).toBe( | ||
| provider.startAuthenticationWorkflow( getRequestContext() ) |
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
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.
Fix
startAuthenticationWorflowtypo (keep deprecated alias)Bug
The provider contract method is misspelled
startAuthenticationWorflow(missing "k") inISSOIntegrationProvider, every built-in provider, and theAuth.start()handler that calls it from/cbsso/auth/:provider/start. A custom provider, or a subclass of a built-in one, that implements or overrides the correctly spelledstartAuthenticationWorkflow()is never called. The start route silently uses the inherited misspelled method instead. For example, a Google subclass that sets OAuthstatein its override never sets it, so every login then fails the state check on callback.Fix
startAuthenticationWorkflow()inISSOIntegrationProvider, the Google, GitHub, Facebook and MicrosoftSAML providers, and the test-harnessCustomProvider.Auth.start()now callsstartAuthenticationWorkflow().Backward compatibility
BaseProviderkeepsstartAuthenticationWorflow()as a@deprecatedalias that delegates tostartAuthenticationWorkflow(). Existing code that calls the old name on a built-in provider keeps working.Auth.start()falls back to the old name when a provider has nostartAuthenticationWorkflow(). Custom providers that don't declareimplements="cbsso.models.ISSOIntegrationProvider"and only define the old name keep working.implements="cbsso.models.ISSOIntegrationProvider"and only defines the misspelled method must rename it, because the interface now requires the correct name. The fix is a one-line rename. We suggest removing the alias and the fallback in the next major release.Tests
Added an
AuthHandlerSpeccase that checks the alias returns the same URL as the new method, and that built-in providers expose both names. The full suite passes on Lucee 5.4.8.2 / TestBox 7.1.0: 45 passed, 0 failed, 0 errors.Fixes #24