refactor(auth): clean up and enhance sign-in-up logic #8653

AMoreaux · 2024-11-21T15:18:30Z

The Pull Request introduces new authentication provider columns to the Workspace entity and updates various services and modules to accommodate these changes. It also includes the creation of a new WorkspaceException class.

Adds new columns to the Workspace entity for managing authentication providers.
Modifies several services (AuthService, WorkspaceService, SignInUpService, etc.) to utilize the new columns.
Introduces WorkspaceException for better error handling in workspace-related operations.
Updates tests and modules to accommodate the new columns and exception.
Includes code format and refactoring for improved readability and maintainability.

Reorganized the sign-in-up code for better readability and maintainability. Introduced validation for workspace invitations and moved some utility functions to dedicated methods. Added a migration for new auth provider columns in the workspace entity.

Removed unused `EnvironmentService` and redundant `code` property in exceptions for clarity. Simplified email validation in `workspace-invitation.service.ts`. Refactored tests to remove unnecessary `targetWorkspaceSubdomain` property.

Removed redundant services from auth and core modules to streamline the code. Added debug log statements in sign-in-up service and skipped certain test cases temporarily for evaluation.

Eliminate debug logging for workspace invite tokens and validation. This cleanup improves readability and reduces console clutter during runtime.

…ninup # Conflicts: # packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts

greptile-apps

PR Summary

This PR enhances workspace authentication by adding configurable auth provider settings and improving the sign-in/up flow with better separation of concerns.

Added new columns isGoogleAuthEnabled, isPasswordAuthEnabled, isMicrosoftAuthEnabled to workspace.entity.ts for granular auth control
Introduced getAuthProvidersByWorkspaceId in workspace.service.ts to expose available auth methods including SSO configurations
Moved workspace invitation validation to dedicated WorkspaceInvitationService with separate methods for public/personal invites
Added saveDefaultWorkspace to UserService for handling workspace switching during auth flows
Created new WorkspaceException class with specific error codes for better error handling

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

...ver/src/database/typeorm/core/migrations/1730298416367-addAuthProvidersColumnsToWorkspace.ts

packages/twenty-server/src/engine/core-modules/auth/dto/available-workspaces.output.ts

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

packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.spec.ts

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

...server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts

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

packages/twenty-server/src/engine/core-modules/workspace/workspace.entity.ts

…facto/improve-signinup # Conflicts: # packages/twenty-server/src/engine/core-modules/auth/dto/available-workspaces.output.ts # packages/twenty-server/src/engine/core-modules/auth/services/auth.service.ts # packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts # packages/twenty-server/src/engine/core-modules/user/services/user.service.ts # packages/twenty-server/src/engine/core-modules/workspace/services/workspace.service.ts

Removed the redundant `code` property from WorkspaceInvitationException. Adjusted the import order in WorkspaceResolver to comply with coding standards.

…facto/improve-signinup

Replace user object with user ID in saveDefaultWorkspace method call to fix incorrect parameter type. This ensures that the function operates as expected and prevents potential errors in default workspace assignment.

charlesBochet · 2024-11-22T16:16:19Z

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

+      where: {
+        email: challengeInput.email,
+      },
+      relations: ['workspaces'],


double check

charlesBochet · 2024-11-22T16:17:16Z

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

@@ -130,20 +135,29 @@ export class AuthService {
    });
  }

-  async verify(email: string): Promise<Verify> {
+  private async findOneWithWorkspacesByEmail(email: string) {


remove this function

charlesBochet · 2024-11-22T16:19:34Z

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

-    });
+    let user = await this.findOneWithWorkspacesByEmail(email);
+
+    if (user && workspaceId && user.defaultWorkspaceId !== workspaceId) {


const defaultWorkspaceId = await this.userRepository.findOne({ select: ['defaultWorkspaceId'] where: { email, }, }); if (user.defaultWorkspaceId !== workspaceId) { await this.userService.saveDefaultWorkspace(user.id, workspaceId); } const user = await this.userRepository.findOne({ where: { email, }, relations: ['defaultWorkspace', 'workspaces', 'workspaces.workspace'], });

charlesBochet · 2024-11-22T16:33:29Z

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

+            workspaceInviteHash,
+            email,
+          })
+        : null;


if (workspacePersonalInviteToken || workspaceInviteHash) {
const invitationValidation =
await this.workspaceInvitationService.validateInvitation({
workspacePersonalInviteToken: workspacePersonalInviteToken,
workspaceInviteHash,
email,
})

if (
invitationValidation?.isValid === true &&
invitationValidation.workspace
) {
}
}

not sure it's better

charlesBochet · 2024-11-22T16:36:01Z

...server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts

-      .getOne();
-  }
-
+  // UTILS METHODS
  castAppTokenToWorkspaceInvitation(appToken: AppToken) {


this could be extracted to an .util.ts

charlesBochet · 2024-11-22T16:40:26Z

...server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts

+    });
+
+    if (invitationByType.type === 'PUBLIC_INVITATION') {
+      return await this.validatePublicInvitation(invitationByType);


workspaceInviteHash

charlesBochet · 2024-11-22T16:40:36Z

...server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts

+    }
+
+    if (invitationByType.type === 'PERSONAL_INVITATION') {
+      return await this.validatePersonalInvitation(invitationByType, email);


workspacePersonalInviteToken

charlesBochet · 2024-11-22T16:41:33Z

...server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts

+    workspaceInviteHash?: string;
+    email: string;
+  }) {
+    const invitationByType = this.getInvitationByType({


I don't see the value of invitationByType actually in this code

charlesBochet · 2024-11-22T16:46:04Z

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

    await this.workspaceRepository.update(user.defaultWorkspaceId, {
      displayName: data.displayName,
      activationStatus: WorkspaceActivationStatus.ACTIVE,
    });

-    return existingWorkspace;
+    return await this.workspaceRepository.findOneBy({


double check

AMoreaux added 5 commits November 19, 2024 12:32

refactor: remove unused code and streamline checks

2598ab1

Removed unused `EnvironmentService` and redundant `code` property in exceptions for clarity. Simplified email validation in `workspace-invitation.service.ts`. Refactored tests to remove unnecessary `targetWorkspaceSubdomain` property.

refactor(auth, core): remove unused services and log debug info

1433b24

Removed redundant services from auth and core modules to streamline the code. Added debug log statements in sign-in-up service and skipped certain test cases temporarily for evaluation.

refactor(auth): remove console.log statements

8279057

Eliminate debug logging for workspace invite tokens and validation. This cleanup improves readability and reduces console clutter during runtime.

Merge remote-tracking branch 'upstream/main' into refacto/improve-sig…

703a776

…ninup # Conflicts: # packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts

AMoreaux mentioned this pull request Nov 21, 2024

refactor(auth): clean up and enhance sign-in-up logic #8581

Closed

greptile-apps bot reviewed Nov 21, 2024

View reviewed changes

AMoreaux changed the base branch from main to feat/allow-to-select-auth-methods-by-workspace November 22, 2024 09:32

AMoreaux added the -PR: awaiting review label Nov 22, 2024

AMoreaux added 3 commits November 22, 2024 10:50

fix(workspace-invitation): remove redundant code property

f6705aa

Removed the redundant `code` property from WorkspaceInvitationException. Adjusted the import order in WorkspaceResolver to comply with coding standards.

Merge branch 'feat/allow-to-select-auth-methods-by-workspace' into re…

dbcad4a

…facto/improve-signinup

fix(auth.service): correct parameter in saveDefaultWorkspace call

2dfcc6f

Replace user object with user ID in saveDefaultWorkspace method call to fix incorrect parameter type. This ensures that the function operates as expected and prevents potential errors in default workspace assignment.

charlesBochet reviewed Nov 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(auth): clean up and enhance sign-in-up logic #8653

refactor(auth): clean up and enhance sign-in-up logic #8653

AMoreaux commented Nov 21, 2024

greptile-apps bot left a comment

charlesBochet Nov 22, 2024

charlesBochet Nov 22, 2024

charlesBochet Nov 22, 2024 •

edited

Loading

charlesBochet Nov 22, 2024

charlesBochet Nov 22, 2024

charlesBochet Nov 22, 2024

charlesBochet Nov 22, 2024

charlesBochet Nov 22, 2024

charlesBochet Nov 22, 2024

charlesBochet Nov 22, 2024

refactor(auth): clean up and enhance sign-in-up logic #8653

Are you sure you want to change the base?

refactor(auth): clean up and enhance sign-in-up logic #8653

Conversation

AMoreaux commented Nov 21, 2024

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charlesBochet Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charlesBochet Nov 22, 2024 •

edited

Loading