Rename Unintuitive Function Names in Authentication Flow #9623
Comments
11 tasks
|
assign me this issue |
DeepaPrasanna
pushed a commit
to DeepaPrasanna/twenty
that referenced
this issue
Jan 27, 2025
Resolves twentyhq#9623 ## Description This PR renames the following functions to better reflect their purpose. - Backend: - Verify → GetAuthTokensFromLoginToken - Challenge → GetLoginTokenFromCredentials - Frontend: - challenge → getLoginTokenFromCredentials - verify → getAuthTokensFromLoginToken ## Testing _Sign in works as expected:_ https://github.com/user-attachments/assets/7e8f73c7-2c7d-4cd2-9965-5ad9f5334cd3 _Sign up works as expected:_ https://github.com/user-attachments/assets/d1794ee4-8b59-4934-84df-d819eabd5224 --------- Co-authored-by: Charles Bochet <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
References
This is a follow up to PR #9288. For more context, look at this conversation.
Scope & Context
The functions
Verify,Challenge, and their corresponding frontend counterparts (challenge,verify) have unclear and non-intuitive names. This creates confusion for developers working with the authentication flow. Updating these names will improve readability and maintainability of the code.Current behavior
Currently, the following functions are named in a way that does not clearly indicate their purpose:
Verify: Exchanges a login token for authentication tokens.Challenge: Generates a login token from user credentials.challenge: Corresponds toChallengeon the backend.verify: Corresponds toVerifyon the backend.These names can be confusing to developers, as they do not directly describe the functions' behavior.
Expected behavior
Rename the functions to better reflect their purpose. Proposed changes:
Verify→GetAuthTokensFromLoginTokenChallenge→GetLoginTokenFromCredentialschallenge→getLoginTokenFromCredentialsverify→getAuthTokensFromLoginTokenThe text was updated successfully, but these errors were encountered: