feat(domain): allow to use custom domain #9811

AMoreaux · 2025-01-23T11:08:53Z

No description provided.

…tom-domain

Refactor subdomain generation logic to a dedicated utility while adding comprehensive tests for subdomain handling. Introduce Cloudflare-based custom domain management functions and exceptions for better domain lifecycle management. Simplify workspace domain updates and enhance overall validation processes.

Update terminology across services, entities, and exceptions from 'domain' to 'hostname' for consistency and clarity. Adjust related methods, fields, and exception codes accordingly. Ensure backward compatibility is maintained while implementing the new naming convention.

Refactor subdomain generation logic to a dedicated utility while adding comprehensive tests for subdomain handling. Introduce Cloudflare-based custom domain management functions and exceptions for better domain lifecycle management. Simplify workspace domain updates and enhance overall validation processes.

Update terminology across services, entities, and exceptions from 'domain' to 'hostname' for consistency and clarity. Adjust related methods, fields, and exception codes accordingly. Ensure backward compatibility is maintained while implementing the new naming convention.

… into feat/allow-to-use-custom-domain

…tom-domain # Conflicts: # packages/twenty-front/src/generated/graphql.tsx # packages/twenty-server/src/engine/core-modules/domain-manager/domain-manager.exception.ts # packages/twenty-server/src/engine/core-modules/domain-manager/service/domain-manager.service.ts # packages/twenty-server/src/engine/core-modules/workspace/services/workspace.service.ts # packages/twenty-server/src/engine/core-modules/workspace/workspace.resolver.ts

…tom-domain # Conflicts: # packages/twenty-server/src/engine/core-modules/auth/controllers/google-auth.controller.ts # packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts # packages/twenty-server/src/engine/core-modules/auth/strategies/google.auth.strategy.ts # packages/twenty-server/src/engine/core-modules/auth/strategies/microsoft.auth.strategy.ts

Refactored the auth flow to streamline invitation handling by replacing token-specific fields with a unified `invitation` object. Updated SSO logic to centralize logic for workspace determination, adjust redirect URI handling, and improve maintainability. Removed redundant dependencies and optimized multi-workspace support.

Eliminated the redundant "switch workspace" functionality from both server and front-end implementations. Updated related components and services to utilize hostname-based workspace handling instead. Ensured compatibility with existing workspace management flows.

Refactored domain settings to separate subdomain functionality into its own component for better modularity. Replaced inline logic with `SettingsSubdomain` to streamline `SettingsDomain` structure. Improved readability and maintainability of domain configuration flow.

…tom-domain # Conflicts: # packages/twenty-server/src/engine/core-modules/auth/services/sign-in-up.service.ts # packages/twenty-server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts # packages/twenty-shared/src/index.ts

…tom-domain # Conflicts: # packages/twenty-front/src/modules/settings/admin-panel/hooks/useImpersonate.ts # packages/twenty-server/src/database/typeorm-seeds/core/feature-flags.ts

…tom-domain # Conflicts: # packages/twenty-front/src/generated/graphql.tsx # packages/twenty-front/src/modules/auth/hooks/useAuth.ts # packages/twenty-server/src/database/commands/upgrade-version/0-34/0-34-generate-subdomain.command.ts # packages/twenty-server/src/engine/core-modules/auth/auth.resolver.spec.ts # packages/twenty-server/src/engine/core-modules/auth/auth.resolver.ts # packages/twenty-server/src/engine/core-modules/auth/controllers/google-auth.controller.ts # packages/twenty-server/src/engine/core-modules/auth/controllers/microsoft-auth.controller.ts # packages/twenty-server/src/engine/core-modules/auth/controllers/sso-auth.controller.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/auth/services/social-sso.service.ts # packages/twenty-server/src/engine/core-modules/auth/strategies/google.auth.strategy.ts # packages/twenty-server/src/engine/core-modules/auth/strategies/microsoft.auth.strategy.ts # packages/twenty-server/src/engine/core-modules/domain-manager/service/domain-manager.service.ts # packages/twenty-website/src/content/developers/backend-development/server-commands.mdx

…tom-domain # Conflicts: # packages/twenty-shared/src/index.ts

…tom-domain

…tom-domain # Conflicts: # packages/twenty-front/.eslintrc.cjs # packages/twenty-front/src/pages/settings/workspace/SettingsDomain.tsx # packages/twenty-server/src/engine/core-modules/feature-flag/enums/feature-flag-key.enum.ts

…tom-domain # Conflicts: # packages/twenty-front/src/generated-metadata/graphql.ts # packages/twenty-front/src/generated/graphql.tsx # packages/twenty-front/src/pages/settings/workspace/SettingsDomain.tsx # packages/twenty-server/src/engine/core-modules/workspace-invitation/services/workspace-invitation.service.ts

packages/twenty-front/codegen-metadata.cjs

packages/twenty-front/codegen.cjs

greptile-apps

PR Summary

This PR implements custom domain support through Cloudflare integration, allowing workspaces to use their own domains alongside the existing subdomain functionality.

Added Cloudflare integration in DomainManagerService with methods for registering, updating, and verifying custom hostnames
Replaced domainName with hostname field across the codebase through migration 1734538670589-add-hostname-to-workspace.ts
Added feature flag IsCustomDomainEnabled to control rollout of custom domain functionality
Implemented new SettingsHostname component with CNAME record verification and status polling
Security concern: NODE_TLS_REJECT_UNAUTHORIZED=0 in codegen files disables SSL certificate validation, which is a significant security risk

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

greptile-apps · 2025-01-23T11:09:54Z

packages/twenty-front/codegen-metadata.cjs

@@ -1,3 +1,5 @@
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';


logic: Setting NODE_TLS_REJECT_UNAUTHORIZED=0 disables SSL/TLS certificate validation. This is a critical security vulnerability and should never be used in production. Consider using proper certificates instead.

greptile-apps · 2025-01-23T11:10:47Z

packages/twenty-front/codegen.cjs

@@ -1,3 +1,5 @@
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';


logic: Setting NODE_TLS_REJECT_UNAUTHORIZED to '0' disables SSL certificate validation. This is a critical security risk and should not be used in production. Consider using proper SSL certificates instead.

greptile-apps · 2025-01-23T11:12:44Z

packages/twenty-front/src/modules/domain-manager/hooks/useGetPublicWorkspaceDataBySubdomain.ts

    onError: (error) => {
      // eslint-disable-next-line no-console
      console.error(error);
-      redirectToDefaultDomain();
+      // redirectToDefaultDomain();
    },


logic: Error handling is incomplete. Users will be left in a broken state if workspace data cannot be retrieved. Either restore the redirect or implement alternative error handling.

greptile-apps · 2025-01-23T11:12:49Z

packages/twenty-front/src/modules/domain-manager/hooks/useBuildWorkspaceUrl.ts

+    if (!isDefined(hostname)) {
      url.hostname = `${subdomain}.${domainConfiguration.frontDomain}`;


logic: this condition should check subdomain.length !== 0 as well to maintain previous behavior and prevent empty subdomains

greptile-apps · 2025-01-23T11:12:50Z

packages/twenty-front/src/modules/domain-manager/hooks/useBuildWorkspaceUrl.ts

+    const url = hostname
+      ? // We assume that the protocol and port are the same as those of the current domain.
+        new URL(
+          `${currentLocation.protocol}//${hostname}${currentLocation.port ? `:${currentLocation.port}` : ''}`,
+        )
+      : new URL(window.location.href);


style: creating a new URL object twice (line 14 and here) is inefficient - could reuse currentLocation

greptile-apps · 2025-01-23T11:22:40Z

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

+    try {
+      return this.workspaceRepository.save({
+        ...workspace,
+        ...payload,
+      });
+    } catch (e) {


logic: No error is being thrown or returned here. The catch block should either rethrow the error after cleanup or return a meaningful error response.

greptile-apps · 2025-01-23T11:22:56Z

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

@@ -126,6 +122,10 @@ export class Workspace {
  @Column({ unique: true })
  subdomain: string;

+  @Field({ nullable: true })
+  @Column({ unique: true, nullable: true })


style: consider adding an index on the hostname column since it's used as a unique identifier and will likely be queried frequently

greptile-apps · 2025-01-23T11:23:10Z

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

        TypeORMModule,
+        TypeORMModule,


logic: TypeORMModule is imported twice here, and it's already imported at the root level. Remove both of these lines.

greptile-apps · 2025-01-23T11:23:21Z

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

-          WorkspaceExceptionCode.WORKSPACE_NOT_FOUND,
-        ),
-      );
+      workspaceValidator.assertIsDefinedOrThrow(workspace);


logic: assertIsDefinedOrThrow is called without an error parameter, which may result in a generic error instead of a specific workspace not found error

greptile-apps · 2025-01-23T11:23:22Z

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

+    if (!hostname) return null;
+
+    return this.domainManagerService.getCustomHostnameDetails(hostname);


style: getCustomHostnameDetails call could throw an error but has no error handling - should be wrapped in try/catch

Introduced hostname support in domain handling to enhance URL generation and redirection logic. Updated related functions and state management to accommodate the hostname field. Removed unnecessary TLS environment variable from codegen files for a cleaner

...ages/twenty-server/src/engine/core-modules/domain-manager/utils/generate-random-subdomain.ts

packages/twenty-front/src/generated-metadata/graphql.ts

.gitignore

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

charlesBochet · 2025-01-23T12:41:43Z

packages/twenty-front/src/modules/domain-manager/hooks/useBuildWorkspaceUrl.ts

@@ -7,12 +7,20 @@ export const useBuildWorkspaceUrl = () => {

  const buildWorkspaceUrl = (


do we have tests on this function?

charlesBochet · 2025-01-23T12:42:40Z

...ages/twenty-front/src/modules/domain-manager/states/lastAuthenticatedWorkspaceDomainState.ts

@@ -4,6 +4,7 @@ import { cookieStorageEffect } from '~/utils/recoil-effects';
 export const lastAuthenticatedWorkspaceDomainState = createState<
  | {
      subdomain: string;
+      hostname?: string;


I'm not a big fan of having variables that can be underfined. Could we make them all required and return (the SERVER_URL domain all the way from the backend)

charlesBochet · 2025-01-23T12:44:02Z

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

+    getPublicWorkspaceData?.hostname,
+  );
+
+  const isWorkspaceDefaultDomainWithLastAuthenticatedParamsExist =


not a fan of this complexity! could we use the early return pattern instead in the effect?
if (! isMultiWorkspaceEnabled) { return}
...

charlesBochet · 2025-01-23T12:44:31Z

packages/twenty-front/src/modules/workspace/graphql/queries/getHostnameDetails.ts

+  query GetHostnameDetails {
+    getHostnameDetails {
+      hostname
+      ownership_verification {


non standard case

charlesBochet · 2025-01-23T12:46:06Z

packages/twenty-front/src/pages/settings/workspace/SettingsDomain.tsx

-    formState: { isValid },
-  } = useForm<Form>({
+  const form = useForm<{
+    subdomain: string;


isn't hostname also part of the form?

charlesBochet · 2025-01-23T12:47:19Z

packages/twenty-front/src/pages/settings/workspace/SettingsHostname.tsx

+    if (isDefined(currentWorkspace?.hostname)) {
+      pollIntervalFn = setInterval(async () => {
+        try {
+          const { data } = await getHostnameDetailsQuery({


do we need a useEffect here? can't we do it synchronously on click?

charlesBochet · 2025-01-23T12:48:21Z

packages/twenty-front/src/pages/settings/workspace/SettingsHostname.tsx

+          )}
+        />
+      </StyledDomainFromWrapper>
+      <Button onClick={handleSubmit(handleSave)} title={'save'}></Button>


don't we also translate button titles?

charlesBochet · 2025-01-23T12:50:01Z

...erver/src/database/typeorm/core/migrations/common/1734538670589-add-hostname-to-workspace.ts

+      `ALTER TABLE "core"."workspace" RENAME COLUMN "domainName" TO "hostname"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "core"."workspace" ADD CONSTRAINT "UQ_e6fa363bdaf45cbf8ce97bcebf0" UNIQUE ("hostname")`,


this will break on production + How does it behave with NULLs?

Postgres checks only nonnull values for unique constraints.

Why will it break the production?

charlesBochet · 2025-01-23T12:50:40Z

packages/twenty-server/src/engine/api/rest/core/query-builder/core-query-builder.factory.ts

@@ -60,7 +60,7 @@ export class CoreQueryBuilderFactory {
      throw new BadRequestException(
        `No object was found for the workspace associated with this API key. You may generate a new one here ${this.domainManagerService
          .buildWorkspaceURL({
-            subdomain: workspace.subdomain,
+            workspaceSubdomainAndHostname: workspace,


why not passing them as two arguments, hard to read!

charlesBochet · 2025-01-23T12:51:31Z

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

@@ -37,6 +37,9 @@ export class AvailableWorkspaceOutput {
  @Field(() => String)
  subdomain: string;

+  @Field(() => String, { nullable: true })
+  hostname?: string;


let's make it mandatory? and return twenty.com

charlesBochet · 2025-01-23T12:52:10Z

packages/twenty-server/src/engine/core-modules/domain-manager/dtos/custom-hostname-details.ts

+import { CustomHostname } from 'src/engine/core-modules/domain-manager/types/custom-hostname.type';
+
+@ObjectType()
+export class OwnershipVerification {


let's make one file per dto :)

charlesBochet · 2025-01-23T12:52:18Z

packages/twenty-server/src/engine/core-modules/domain-manager/dtos/custom-hostname-details.ts

+@ObjectType()
+export class OwnershipVerificationHttp {
+  @Field(() => String)
+  http_body?: string;


charlesBochet · 2025-01-23T12:52:44Z

packages/twenty-server/src/engine/core-modules/domain-manager/dtos/custom-hostname-details.ts

+@ObjectType()
+export class OwnershipVerification {
+  @Field(() => String)
+  name?: string;


name is not nullable but can be undefined? looks inconsistent to me

charlesBochet · 2025-01-23T12:53:18Z

packages/twenty-server/src/engine/core-modules/domain-manager/service/domain-manager.service.ts


    const existingWorkspaceCount = await this.workspaceRepository.countBy({
      subdomain,
    });

    return `${subdomain}${existingWorkspaceCount > 0 ? `-${Math.random().toString(36).substring(2, 10)}` : ''}`;
  }
+
+  private async getCustomHostname(


this file is too big and impossible to review :(

charlesBochet · 2025-01-23T12:53:55Z

...erver/src/engine/core-modules/domain-manager/utils/__test__/get-subdomain-from-email.spec.ts

+  });
+
+  it('should return undefined if email is not a work email', () => {
+    (isDefined as unknown as jest.Mock).mockReturnValue(true);


why do we need these as casting? first time I see it!

charlesBochet · 2025-01-23T12:55:01Z

...-server/src/engine/core-modules/domain-manager/utils/get-subdomain-name-from-display-name.ts

@@ -0,0 +1,10 @@
+import { isDefined } from 'src/utils/is-defined';
+
+export const getSubdomainNameFromDisplayName = (displayName?: string) => {


charlesBochet · 2025-01-23T12:55:37Z

packages/twenty-server/src/engine/core-modules/domain-manager/validator/cloudflare.validate.ts

+  DomainManagerExceptionCode,
+} from 'src/engine/core-modules/domain-manager/domain-manager.exception';
+
+const isExist = (


still have a problem with this naming :p isExist is not proper english

charlesBochet · 2025-01-23T12:56:46Z

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

+        ...workspace,
+        ...payload,
+      });
+    } catch (e) {


…tom-domain

Updated WorkspaceActivationStatus enum values to use uppercase casing for consistency with GraphQL best practices. This change ensures uniformity across the codebase and prevents potential discrepancies.

Updated redirectToWorkspaceDomain calls to use a single workspace object instead of separate subdomain and hostname parameters. This enhances code readability and ensures consistent function usage across components.

AMoreaux added 30 commits December 16, 2024 16:27

WIP

f807021

Merge remote-tracking branch 'origin/main' into feat/allow-to-use-cus…

7b746e6

…tom-domain

add migration

1256151

WIP

f184330

add migration

f06effe

Merge remote-tracking branch 'origin/feat/allow-to-use-custom-domain'…

36ea594

… into feat/allow-to-use-custom-domain

WIP

24653e0

WIP

6e66db1

WIP

c62e0f8

WIP

e658f75

WIP

39b6fcc

Merge remote-tracking branch 'origin/main' into feat/allow-to-use-cus…

40cd67f

…tom-domain # Conflicts: # packages/twenty-front/src/modules/settings/admin-panel/hooks/useImpersonate.ts # packages/twenty-server/src/database/typeorm-seeds/core/feature-flags.ts

WIP

19f9afb

Merge remote-tracking branch 'origin/main' into feat/allow-to-use-cus…

58b2a81

…tom-domain # Conflicts: # packages/twenty-shared/src/index.ts

Merge remote-tracking branch 'origin/main' into feat/allow-to-use-cus…

5d59665

…tom-domain

WIP

ae92d5d

github-advanced-security bot found potential problems Jan 23, 2025

View reviewed changes

packages/twenty-front/codegen-metadata.cjs Fixed Show fixed Hide fixed

packages/twenty-front/codegen.cjs Fixed Show fixed Hide fixed

greptile-apps bot reviewed Jan 23, 2025

View reviewed changes