feat(*): allow to select auth providers + add multiworkspace with subdomain management #8656

AMoreaux · 2024-11-21T16:32:10Z

Summary

Add support for multi-workspace feature and adjust configurations and states accordingly.

Introduced new state isMultiWorkspaceEnabledState.
Updated ClientConfigProviderEffect component to handle multi-workspace.
Modified GraphQL schema and queries to include multi-workspace related configurations.
Adjusted server environment variables and their respective documentation to support multi-workspace toggle.
Updated server-side logic to handle new multi-workspace configurations and conditions.

Replaced the 'IS_SIGN_UP_DISABLED' flag with 'IS_MULTIWORKSPACE_ENABLED' to control workspace creation. This change allows for conditional workspace setup based on the new environment variable. Also updated related service, resolver, and entity files.

Updated the IS_MULTIWORKSPACE_ENABLED setting description to indicate support for multiple workspaces. This update clarifies that a web server capable of managing subdomain wildcards is required.

Updated the .env.example file to replace the IS_SIGN_UP_DISABLED variable with IS_MULTIWORKSPACE_ENABLED. Removed the IS_SIGN_UP_DISABLED property from environment-variables.ts as it is no longer needed.

…nabled Removed isSignUpDisabledState and associated references, and replaced them with isMultiworkspaceEnabledState. Updated GraphQL queries and related components to reflect this change, and ensured multi-workspace functionality is enabled where applicable.

Corrected the casing of the `isMultiWorkspaceEnabled` variable in the NavigationDrawerHeader component. This ensures consistent naming conventions and avoids potential bugs related to variable misnaming.

…kspace-flag

greptile-apps

PR Summary

This PR introduces multi-workspace functionality by replacing the sign-up disabled flag with a multi-workspace enabled flag across the application.

Inconsistent casing in state key naming (isMultiworkspaceEnabled vs isMultiWorkspaceEnabled) in /packages/twenty-front/src/modules/client-config/states/isMultiWorkspaceEnabledState.ts
Default value mismatch between frontend (true) and server (false) for isMultiWorkspaceEnabled could cause inconsistent behavior
Removal of signUpDisabled state without clear alternative mechanism needs review for impact on user registration flows
Added note in documentation about wildcard subdomain requirement for multi-workspace feature
Server-side logic in sign-in-up.service.ts now blocks creation of additional workspaces when multi-workspace is disabled

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

packages/twenty-front/src/modules/client-config/components/ClientConfigProviderEffect.tsx

packages/twenty-front/src/modules/client-config/states/isMultiWorkspaceEnabledState.ts

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

martmull

LGTM, one comment about default value

packages/twenty-server/src/engine/core-modules/environment/environment-variables.ts

Corrected the typo from isMultiworkspaceEnabled to isMultiWorkspaceEnabled. This change affects multiple files to ensure consistency across the codebase, including GraphQL queries, state management, and server configurations.

AMoreaux · 2024-11-21T16:59:27Z

@martmull I converted this PR to a draft to avoid the merge since we must wait for the review on child PR to have the full feature.

Especially this one #8654
And another one about subdomains, I will open soon.

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

Removed unused `appTokenRepository` injection and renamed variable `numberOfWorkspaces` to `workspacesCount` for clarity. This cleanup helps improve code readability and maintainability.

…kspace-flag # Conflicts: # packages/twenty-front/src/modules/client-config/components/ClientConfigProviderEffect.tsx

…ace (#8654)

Updated various utility file paths and refactored enums to a separate file. Renamed utility files for consistency and moved 'SignInUpMode' enum to its own type file. Also, removed deprecated workspace invitation and URL-related utility files.

…kspace-flag # Conflicts: # packages/twenty-front/src/generated/graphql.tsx # packages/twenty-front/src/modules/ui/navigation/navigation-drawer/hooks/useWorkspaceSwitching.ts # packages/twenty-website/src/content/developers/self-hosting/self-hosting-var.mdx

charlesBochet · 2024-12-02T15:53:15Z

packages/twenty-front/src/modules/auth/sign-in-up/components/SignInUpWorkspaceScopeForm.tsx

+
+  const { signInUpStep, continueWithEmail } = useSignInUp(form);
+
+  const checkAuthProviders = useCallback(() => {


move to SignInUpWorkspaceScopeFormEffect

charlesBochet · 2024-12-02T16:03:28Z

packages/twenty-front/src/modules/workspace/components/WorkspaceProviderEffect.tsx

+
+  useEffect(() => {
+    try {
+      if (isDefined(workspacePublicData?.logo)) {


see if can leverage react-helmet

charlesBochet · 2024-12-02T16:06:22Z

packages/twenty-front/src/modules/auth/types/signInUpMode.type.ts

@@ -0,0 +1,4 @@
+export enum SignInUpMode {


charlesBochet · 2024-12-02T16:07:44Z

...ty-front/src/modules/settings/security/components/SettingsSSOIdentitiesProvidersListCard.tsx

 import { IconKey } from 'twenty-ui';
+import { useListSsoIdentityProvidersByWorkspaceIdQuery } from '~/generated/graphql';
+import { SnackBarVariant } from '@/ui/feedback/snack-bar-manager/components/SnackBar';
+import { SSOIdentitiesProvidersState } from '@/settings/security/states/SSOIdentitiesProviders.state';


charlesBochet · 2024-12-02T16:09:12Z

packages/twenty-front/src/modules/settings/security/components/SettingsSecurityOptionsList.tsx


  const [updateWorkspace] = useUpdateWorkspaceMutation();

+  const isValidAuthProvider = (


extract this to util so we can test it easily and we the typing complexity is "hidden"

charlesBochet · 2024-12-02T16:12:01Z

packages/twenty-front/src/modules/settings/security/types/AuthProviders.type.ts

@@ -0,0 +1,4 @@
+export type AuthProvidersKeys =


GOOGLE
MICROSOFT

isGoogleAuthEnabled
isMicrosoftAuthEnabled

map(authEnablekyey: AuthProvidersKeys): GOOGLE | MICROSOFT (

)

not mandatory but I would have "avoided the complexity like this"

charlesBochet · 2024-12-02T16:18:11Z

packages/twenty-front/src/utils/workspace-url.helper.ts

+  return url.toString();
+};
+
+export const redirectToHome = () => {


file naming + split into multi files

charlesBochet · 2024-12-02T16:20:45Z

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

    picture?: string | null;
    fromSSO: boolean;
+    isAuthEnabled?: ReturnType<(typeof workspaceValidator)['isAuthEnabled']>;


isAuthProviderEnabled

charlesBochet · 2024-12-02T16:27:50Z

packages/twenty-server/src/engine/core-modules/auth/controllers/google-auth.controller.ts

@@ -53,6 +58,13 @@ export class GoogleAuthController {
      workspaceInviteHash,
      workspacePersonalInviteToken,
      fromSSO: true,
+      isAuthEnabled: workspaceValidator.isAuthEnabled(


authProvider: 'google' | 'microsoft'

charlesBochet · 2024-12-02T16:28:36Z

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

+    );
+
+    if (isAuthEnabled)
+      workspaceValidator.validateAuth(isAuthEnabled, workspace);


workspaceValidator.validateAuth(() => { isValid(authProvider), ${authProvider} not enabled)

charlesBochet · 2024-12-02T16:34:11Z

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

+import { User } from 'src/engine/core-modules/user/user.entity';
+import { CustomException } from 'src/utils/custom-exception';
+
+const assertIsExist = (


assertIsDefinedOrThrow

charlesBochet · 2024-12-02T16:41:05Z

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

+};
+
+export const userValidator: {
+  assertIsExist: typeof assertIsExist;


we would avoid typeof usage usually to lower complexity

charlesBochet · 2024-12-02T16:42:19Z

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

+      },
+    });
+
+    return appTokens.map(castAppTokenToWorkspaceInvitationUtil);


move cast to an util

charlesBochet · 2024-12-02T16:44:03Z

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

@@ -144,4 +152,26 @@ export class WorkspaceResolver {
  hasValidEntrepriseKey(): boolean {
    return isDefined(this.environmentService.get('ENTERPRISE_KEY'));
  }
+
+  @Query(() => PublicWorkspaceDataOutput)


we could extract that to another resolver

charlesBochet · 2024-12-02T16:45:17Z

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

+  exceptionToThrowCustom?: CustomException,
+) => boolean;
+
+const isAuthEnabled: IsAuthEnabled = (provider, exceptionToThrow) => {


see comments above

…kspace-flag # Conflicts: # packages/twenty-front/src/modules/auth/sign-in-up/hooks/useSignInUpForm.ts # packages/twenty-front/src/modules/client-config/components/ClientConfigProviderEffect.tsx # packages/twenty-server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts

…kspace-flag # Conflicts: # packages/twenty-front/src/generated-metadata/graphql.ts # packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts

Refactored GraphQL types to include new structures such as ActivateWorkspaceOutput and AvailableWorkspaceOutput, and updated IdentityProviderType enum. Added GraphQL mutations for workspace activation and switching, enhancing workspace management functionality. Revised authentication-related structures for improved SSO integration and user management.

github-actions · 2024-12-03T18:07:46Z

Thanks @AMoreaux for your contribution!
This marks your 16th PR on the repo. You're top 2% of all our contributors 🎉
See contributor page - Share on LinkedIn - Share on Twitter

greptile-apps

PR Summary

(updates since last review)

This PR significantly expands the multi-workspace functionality with subdomain management and authentication provider configuration.

Added workspace subdomain support in /packages/twenty-server/src/engine/core-modules/workspace/workspace.entity.ts with unique constraint and auth provider flags
Introduced new DomainManagerService in /packages/twenty-server/src/engine/core-modules/domain-manager/service/domain-manager.service.ts for handling workspace URLs and subdomain management
Refactored authentication flow in /packages/twenty-front/src/modules/auth/hooks/useAuth.ts to support workspace-specific auth providers and subdomain-based routing
Added workspace validation utilities in /packages/twenty-server/src/engine/core-modules/workspace/workspace.validate.ts for auth provider and activation checks
Replaced environment variable FRONT_BASE_URL with granular configuration (FRONT_DOMAIN, FRONT_PROTOCOL, FRONT_PORT) for better multi-workspace support

The changes appear comprehensive but should be carefully tested for subdomain handling and authentication flows across workspaces.

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

greptile-apps · 2024-12-03T18:06:37Z

packages/twenty-front/src/modules/auth/graphql/mutations/generateJWT.ts

logic: Removing the JWT generation mutation without a clear replacement could break authentication flows. Ensure there is a new mechanism in place for JWT generation that supports multi-workspace functionality.

greptile-apps · 2024-12-03T18:08:05Z

packages/twenty-front/src/modules/auth/graphql/queries/getPublicWorkspaceDataBySubdomain.ts

+  query GetPublicWorkspaceDataBySubdomain {
+    getPublicWorkspaceDataBySubdomain {


logic: query lacks parameters to specify which subdomain to query

greptile-apps · 2024-12-03T18:09:10Z

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

+          params.workspacePersonalInviteToken,
+        );
+      }
+      const subdomain = getWorkspaceSubdomain;


logic: getWorkspaceSubdomain is being used as a value but appears to be a function - should be getWorkspaceSubdomain()

greptile-apps · 2024-12-03T18:09:10Z

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

+      if (isDefined(workspace) && isTwentyWorkspaceSubdomain) {
+        setLastAuthenticateWorkspaceState({
+          id: workspace.id,
+          subdomain: workspace.subdomain,
+          cookieAttributes: {
+            domain: `.${urlManager.frontDomain}`,
+          },
+        });
+      }


style: consider adding error handling in case workspace.subdomain is undefined when setting cookie domain

greptile-apps · 2024-12-03T18:09:49Z

packages/twenty-front/src/modules/auth/sign-in-up/components/SignInUpEmailField.tsx

+              onChange={(value: string) => {
+                onChange(value);
+                if (isDefined(onChangeFromProps)) onChangeFromProps(value);
+              }}


style: onChange handler could potentially trigger multiple re-renders since it's recreated on each render. Consider memoizing this function with useCallback.

greptile-apps · 2024-12-03T19:33:07Z

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

+    if (provider === 'google' && workspace.isGoogleAuthEnabled) return true;
+    if (provider === 'microsoft' && workspace.isMicrosoftAuthEnabled)
+      return true;
+    if (provider === 'password' && workspace.isPasswordAuthEnabled) return true;


style: consider using a switch statement or object lookup for better maintainability with multiple providers

greptile-apps · 2024-12-03T19:33:45Z

packages/twenty-server/src/engine/decorators/auth/origin-header.decorator.ts

+  (data: unknown, ctx: ExecutionContext) => {
+    const request = getRequest(ctx);
+
+    return request.headers['origin'];


logic: headers['origin'] could be undefined - consider adding type safety checks and default value

greptile-apps · 2024-12-03T19:33:46Z

packages/twenty-server/src/engine/decorators/auth/origin-header.decorator.ts

+  (data: unknown, ctx: ExecutionContext) => {
+    const request = getRequest(ctx);
+
+    return request.headers['origin'];


style: origin header should be validated against expected format to prevent header injection attacks

greptile-apps · 2024-12-03T19:34:52Z

packages/twenty-server/src/engine/middlewares/graphql-hydrate-request-from-token.middleware.ts

  async validateToken(req: Request) {
    try {
-      return await this.accessTokenService.validateToken(req);
+      return await this.accessTokenService.validateTokenByRequest(req);


logic: validateToken method name doesn't match the actual call to validateTokenByRequest

greptile-apps · 2024-12-03T19:35:49Z

packages/twenty-server/src/utils/__test__/is-work-email.spec.ts

+  it('should return false for a personal email', () => {
+    expect(isWorkEmail('[email protected]')).toBe(false);
+  });


style: should test multiple personal email providers (yahoo, hotmail, outlook etc) since implementation uses a set of providers

AMoreaux added 5 commits November 19, 2024 16:46

feat(content): Enable multi-workspace support setting

08f7f23

Updated the IS_MULTIWORKSPACE_ENABLED setting description to indicate support for multiple workspaces. This update clarifies that a web server capable of managing subdomain wildcards is required.

chore(env): replace IS_SIGN_UP_DISABLED with IS_MULTIWORKSPACE_ENABLED

36e9021

Updated the .env.example file to replace the IS_SIGN_UP_DISABLED variable with IS_MULTIWORKSPACE_ENABLED. Removed the IS_SIGN_UP_DISABLED property from environment-variables.ts as it is no longer needed.

fix(ui/navigation): Correct variable casing in header component

3037ff5

Corrected the casing of the `isMultiWorkspaceEnabled` variable in the NavigationDrawerHeader component. This ensures consistent naming conventions and avoids potential bugs related to variable misnaming.

AMoreaux mentioned this pull request Nov 21, 2024

feat(): add IS_MULTIWORKSPACE_ENABLE flag #8589

Closed

Merge remote-tracking branch 'origin/main' into feat/add-is-multi-wor…

629bf06

…kspace-flag

greptile-apps bot reviewed Nov 21, 2024

View reviewed changes

martmull reviewed Nov 21, 2024

View reviewed changes

packages/twenty-server/src/engine/core-modules/environment/environment-variables.ts Show resolved Hide resolved

fix(client-config): correct isMultiWorkspaceEnabled typo

270694e

Corrected the typo from isMultiworkspaceEnabled to isMultiWorkspaceEnabled. This change affects multiple files to ensure consistency across the codebase, including GraphQL queries, state management, and server configurations.

AMoreaux marked this pull request as draft November 21, 2024 16:58

AMoreaux self-assigned this Nov 22, 2024

charlesBochet reviewed Nov 22, 2024

View reviewed changes

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

charlesBochet approved these changes Nov 22, 2024

View reviewed changes

AMoreaux and others added 4 commits November 25, 2024 10:01

refactor(auth): remove unused repository and rename variable

14227c2

Removed unused `appTokenRepository` injection and renamed variable `numberOfWorkspaces` to `workspacesCount` for clarity. This cleanup helps improve code readability and maintainability.

Merge remote-tracking branch 'origin/main' into feat/add-is-multi-wor…

1fbd238

…kspace-flag # Conflicts: # packages/twenty-front/src/modules/client-config/components/ClientConfigProviderEffect.tsx

feat(auth): refactor auth + allow to configure auth methods by worksp…

54aeca6

…ace (#8654)

AMoreaux changed the title ~~feat(): add IS_MULTIWORKSPACE_ENABLE flag~~ feat(*): allow to select auth providers + add multiworkspace with subdomain management Nov 27, 2024

charlesBochet added the -PR: awaiting author label Nov 29, 2024

charlesBochet reviewed Dec 2, 2024

View reviewed changes

packages/twenty-front/src/modules/auth/types/signInUpMode.type.ts

@@ -0,0 +1,4 @@

export enum SignInUpMode {

Copy link

Member

charlesBochet Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

filenaming

charlesBochet reviewed Dec 2, 2024

View reviewed changes

charlesBochet approved these changes Dec 2, 2024

View reviewed changes

AMoreaux added 2 commits December 3, 2024 18:47

feat(*): add subdomain management for multiworkpsace (#8680)

844d218

AMoreaux added 2 commits December 3, 2024 18:59

Merge remote-tracking branch 'origin/main' into feat/add-is-multi-wor…

7e560be

…kspace-flag # Conflicts: # packages/twenty-front/src/generated-metadata/graphql.ts # packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts

AMoreaux marked this pull request as ready for review December 3, 2024 18:02

charlesBochet merged commit 7943141 into main Dec 3, 2024
11 of 18 checks passed

charlesBochet deleted the feat/add-is-multi-workspace-flag branch December 3, 2024 18:06

greptile-apps bot reviewed Dec 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(*): allow to select auth providers + add multiworkspace with subdomain management #8656

feat(*): allow to select auth providers + add multiworkspace with subdomain management #8656

AMoreaux commented Nov 21, 2024

greptile-apps bot left a comment

martmull left a comment

AMoreaux commented Nov 21, 2024 •

edited

Loading

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

charlesBochet Dec 2, 2024

github-actions bot commented Dec 3, 2024

greptile-apps bot left a comment

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024

greptile-apps bot Dec 3, 2024


		const { signInUpStep, continueWithEmail } = useSignInUp(form);

		const checkAuthProviders = useCallback(() => {


		const [updateWorkspace] = useUpdateWorkspaceMutation();

		const isValidAuthProvider = (

		query GetPublicWorkspaceDataBySubdomain {
		getPublicWorkspaceDataBySubdomain {

feat(*): allow to select auth providers + add multiworkspace with subdomain management #8656

feat(*): allow to select auth providers + add multiworkspace with subdomain management #8656

Conversation

AMoreaux commented Nov 21, 2024

Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

martmull left a comment

Choose a reason for hiding this comment

AMoreaux commented Nov 21, 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

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

github-actions bot commented Dec 3, 2024

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 3, 2024

Choose a reason for hiding this comment

AMoreaux commented Nov 21, 2024 •

edited

Loading