Rename Unintuitive Function Names in Authentication Flow #9706

samyakpiya · 2025-01-17T03:56:38Z

Resolves #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:

9706-Sign.In.mp4

Sign up works as expected:

9706-Sign.Up.mp4

…twenty-server

…and twenty-server

samyakpiya · 2025-01-17T15:10:51Z

@FelixMalfait @AMoreaux Ready for review!

greptile-apps

PR Summary

This PR renames authentication functions across the frontend and backend to improve clarity and maintainability, replacing generic terms like "challenge" and "verify" with more descriptive names that better reflect their purposes.

Renamed backend mutations from Challenge to GetLoginTokenFromCredentials and Verify to GetAuthTokensFromLoginToken
Updated frontend hooks and components to use new mutation names while maintaining existing functionality
Modified test files and mocks to reflect renamed functions
Updated excluded operations in GraphQL middleware to match new mutation names
Added new feature flag IsLocalizationEnabled in generated metadata

_{16 file(s) reviewed, 7 comment(s)}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-01-17T15:12:08Z

packages/twenty-front/src/modules/auth/components/VerifyEffect.tsx

        variant: SnackBarVariant.Error,
      });
    }

    if (isDefined(loginToken)) {
      setIsAppWaitingForFreshObjectMetadata(true);
-      verify(loginToken);
+      getAuthTokensFromLoginToken(loginToken);


logic: missing error handling for getAuthTokensFromLoginToken call

greptile-apps · 2025-01-17T15:13:05Z

packages/twenty-front/src/modules/auth/hooks/__mocks__/useAuth.ts

      },
    })),
  },
  {
    request: {
      query: queries.signup,
-      variables: variables.challenge,
+      variables: variables.getLoginTokenFromCredentials,


logic: variables.getLoginTokenFromCredentials is used here for signup, but signup likely needs its own variables object

greptile-apps · 2025-01-17T15:13:20Z

packages/twenty-front/src/modules/auth/hooks/useAuth.ts

        variables: { loginToken },
      });

      if (isDefined(verifyResult.errors)) {
        throw verifyResult.errors;
      }

-      if (!verifyResult.data?.verify) {
+      if (!verifyResult.data?.getAuthTokensFromLoginToken) {


syntax: error message still references old terminology 'No verify result' instead of 'No auth tokens result'

greptile-apps · 2025-01-17T15:13:22Z

packages/twenty-front/src/modules/auth/hooks/useAuth.ts

    async (email: string, password: string, captchaToken?: string) => {
      try {
-        const challengeResult = await challenge({
+        const challengeResult = await getLoginTokenFromCredentials({


style: variable name 'challengeResult' should be renamed to 'loginTokenResult' for consistency with new naming

greptile-apps · 2025-01-17T15:13:23Z

packages/twenty-front/src/modules/auth/hooks/useAuth.ts

    async (loginToken: string) => {
      setIsVerifyPendingState(true);

-      const verifyResult = await verify({
+      const verifyResult = await getAuthTokensFromLoginToken({


style: variable name 'verifyResult' should be renamed to 'authTokensResult' for consistency with new naming

greptile-apps · 2025-01-17T15:13:43Z

packages/twenty-server/src/engine/core-modules/auth/auth.resolver.ts

+    const user = await this.authService.challenge(
+      getLoginTokenFromCredentialsInput,
+      workspace,
+    );


style: method name 'challenge' in authService should also be renamed to 'getLoginTokenFromCredentials' for consistency

greptile-apps · 2025-01-17T15:14:16Z

packages/twenty-server/src/engine/core-modules/auth/services/auth.service.ts

+  async challenge(
+    challengeInput: GetLoginTokenFromCredentialsInput,
+    targetWorkspace: Workspace,
+  ) {


logic: function name 'challenge' should be renamed to 'getLoginTokenFromCredentials' to match PR's intent

Specifically, the 'IsLocalizationEnabled' and 'IsWorkflowEnabled' fields were removed from the 'FeatureFlagKey' enum in both 'graphql.ts' and 'graphql.tsx' files to streamline the generated code.

AMoreaux

Thanks for the refactor. It’s better now, but I noticed a few missed renames.

packages/twenty-front/src/modules/auth/hooks/useAuth.ts

packages/twenty-server/src/engine/core-modules/auth/services/auth.service.ts

charlesBochet

Thank you @samyakpiya

@AMoreaux Took your comments

Feedbacks taken

github-actions · 2025-01-24T18:20:34Z

	Fails
🚫	`node` failed.

Log

�[31mError: �[39m SyntaxError: Unexpected token C in JSON at position 0
    at JSON.parse (<anonymous>)
�[90m    at parseJSONFromBytes (node:internal/deps/undici/undici:5584:19)�[39m
�[90m    at successSteps (node:internal/deps/undici/undici:5555:27)�[39m
�[90m    at fullyReadBody (node:internal/deps/undici/undici:1665:9)�[39m
�[90m    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)�[39m
�[90m    at async specConsumeBody (node:internal/deps/undici/undici:5564:7)�[39m
danger-results://tmp/danger-results-0cf13771.json

Generated by 🚫 dangerJS against d41a6a8

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]>

samyakpiya added 2 commits January 16, 2025 22:54

rename verify to getAuthTokensFromLoginToken in twenty-front and …

4868694

…twenty-server

rename challenge to getLoginTokenFromCredentials in twenty-front …

66e138c

…and twenty-server

samyakpiya changed the title ~~[WIP] Rename Unintuitive Function Names in Authentication Flow~~ Rename Unintuitive Function Names in Authentication Flow Jan 17, 2025

samyakpiya marked this pull request as ready for review January 17, 2025 15:11

greptile-apps bot reviewed Jan 17, 2025

View reviewed changes

removed irrelevant fields from the GraphQL code generation output:

3a8009a

Specifically, the 'IsLocalizationEnabled' and 'IsWorkflowEnabled' fields were removed from the 'FeatureFlagKey' enum in both 'graphql.ts' and 'graphql.tsx' files to streamline the generated code.

AMoreaux previously requested changes Jan 20, 2025

View reviewed changes

charlesBochet added the -PR: awaiting author label Jan 21, 2025

charlesBochet added 2 commits January 24, 2025 18:58

Merge branch 'main' into chore/9623-rename-unintuitive-fn-names-in-auth

91920fc

Fix

d41a6a8

charlesBochet approved these changes Jan 24, 2025

View reviewed changes

charlesBochet merged commit 55be726 into twentyhq:main Jan 24, 2025
45 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename Unintuitive Function Names in Authentication Flow #9706

Rename Unintuitive Function Names in Authentication Flow #9706

samyakpiya commented Jan 17, 2025 •

edited

Loading

samyakpiya commented Jan 17, 2025 •

edited

Loading

greptile-apps bot left a comment

greptile-apps bot Jan 17, 2025

greptile-apps bot Jan 17, 2025

greptile-apps bot Jan 17, 2025

greptile-apps bot Jan 17, 2025

greptile-apps bot Jan 17, 2025

greptile-apps bot Jan 17, 2025

greptile-apps bot Jan 17, 2025

AMoreaux left a comment

charlesBochet left a comment

github-actions bot commented Jan 24, 2025

Rename Unintuitive Function Names in Authentication Flow #9706

Rename Unintuitive Function Names in Authentication Flow #9706

Conversation

samyakpiya commented Jan 17, 2025 • edited Loading

Description

Testing

samyakpiya commented Jan 17, 2025 • edited Loading

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot Jan 17, 2025

Choose a reason for hiding this comment

greptile-apps bot Jan 17, 2025

Choose a reason for hiding this comment

greptile-apps bot Jan 17, 2025

Choose a reason for hiding this comment

greptile-apps bot Jan 17, 2025

Choose a reason for hiding this comment

greptile-apps bot Jan 17, 2025

Choose a reason for hiding this comment

greptile-apps bot Jan 17, 2025

Choose a reason for hiding this comment

greptile-apps bot Jan 17, 2025

Choose a reason for hiding this comment

AMoreaux left a comment

Choose a reason for hiding this comment

charlesBochet left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 24, 2025

Log

samyakpiya commented Jan 17, 2025 •

edited

Loading

samyakpiya commented Jan 17, 2025 •

edited

Loading