feat(custom-domain): enable UI for custom domain (#10062)

This commit is contained in:
Antoine Moreaux
2025-02-10 09:43:13 +01:00
committed by GitHub
parent f8c653f153
commit 1b98f40f17
13 changed files with 305 additions and 343 deletions

View File

@ -1,5 +1,8 @@
import { ApolloError } from '@apollo/client';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import {
CurrentWorkspace,
currentWorkspaceState,
} from '@/auth/states/currentWorkspaceState';
import { useRecoilState } from 'recoil';
import { SaveAndCancelButtons } from '@/settings/components/SaveAndCancelButtons/SaveAndCancelButtons';
import { SnackBarVariant } from '@/ui/feedback/snack-bar-manager/components/SnackBar';
@ -22,6 +25,7 @@ import { SubMenuTopBarContainer } from '@/ui/layout/page/components/SubMenuTopBa
import { SettingsPath } from '@/types/SettingsPath';
import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
import { SettingsHostnameEffect } from '~/pages/settings/workspace/SettingsHostnameEffect';
import { isDefined } from 'twenty-shared';
export const SettingsDomain = () => {
const navigate = useNavigateSettings();
@ -36,6 +40,17 @@ export const SettingsDomain = () => {
.regex(/^[a-z0-9][a-z0-9-]{1,28}[a-z0-9]$/, {
message: t`Use letter, number and dash only. Start and finish with a letter or a number`,
}),
hostname: z
.string()
.regex(
/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$/,
{
message: t`Invalid custom hostname. Custom hostnames have to be smaller than 256 characters in length, cannot be IP addresses, cannot contain spaces, cannot contain any special characters such as _~\`!@#$%^*()=+{}[]|\\;:'",<>/? and cannot begin or end with a '-' character.`,
},
)
.max(256)
.optional()
.or(z.literal('')),
})
.required();
@ -53,30 +68,62 @@ export const SettingsDomain = () => {
const form = useForm<{
subdomain: string;
hostname: string | null;
}>({
mode: 'onChange',
delayError: 500,
defaultValues: {
subdomain: currentWorkspace?.subdomain ?? '',
hostname: currentWorkspace?.hostname ?? null,
},
resolver: zodResolver(validationSchema),
});
const subdomainValue = form.watch('subdomain');
const hostnameValue = form.watch('hostname');
const handleSave = async () => {
const values = form.getValues();
if (!values || !form.formState.isValid || !currentWorkspace) {
return enqueueSnackBar(t`Invalid form values`, {
variant: SnackBarVariant.Error,
});
}
await updateWorkspace({
const updateHostname = (
hostname: string | null | undefined,
currentWorkspace: CurrentWorkspace,
) => {
updateWorkspace({
variables: {
input: {
subdomain: values.subdomain,
hostname:
isDefined(hostname) && hostname.length > 0 ? hostname : null,
},
},
onCompleted: () => {
setCurrentWorkspace({
...currentWorkspace,
hostname: hostname,
});
},
onError: (error) => {
if (
error instanceof ApolloError &&
error.graphQLErrors[0]?.extensions?.code === 'CONFLICT'
) {
return form.control.setError('subdomain', {
type: 'manual',
message: t`Subdomain already taken`,
});
}
enqueueSnackBar((error as Error).message, {
variant: SnackBarVariant.Error,
});
},
});
};
const updateSubdomain = (
subdomain: string,
currentWorkspace: CurrentWorkspace,
) => {
updateWorkspace({
variables: {
input: {
subdomain,
},
},
onError: (error) => {
@ -98,11 +145,11 @@ export const SettingsDomain = () => {
currentUrl.hostname = new URL(
currentWorkspace.workspaceUrls.subdomainUrl,
).hostname.replace(currentWorkspace.subdomain, values.subdomain);
).hostname.replace(currentWorkspace.subdomain, subdomain);
setCurrentWorkspace({
...currentWorkspace,
subdomain: values.subdomain,
subdomain,
});
redirectToWorkspaceDomain(currentUrl.toString());
@ -110,6 +157,27 @@ export const SettingsDomain = () => {
});
};
const handleSave = async () => {
const values = form.getValues();
if (!values || !form.formState.isValid || !currentWorkspace) {
return enqueueSnackBar(t`Invalid form values`, {
variant: SnackBarVariant.Error,
});
}
if (
isDefined(values.subdomain) &&
values.subdomain !== currentWorkspace.subdomain
) {
return updateSubdomain(values.subdomain, currentWorkspace);
}
if (values.hostname !== currentWorkspace.hostname) {
return updateHostname(values.hostname, currentWorkspace);
}
};
return (
<SubMenuTopBarContainer
title={t`Domain`}
@ -128,7 +196,8 @@ export const SettingsDomain = () => {
<SaveAndCancelButtons
isSaveDisabled={
!form.formState.isValid ||
subdomainValue === currentWorkspace?.subdomain
(subdomainValue === currentWorkspace?.subdomain &&
hostnameValue === currentWorkspace?.hostname)
}
onCancel={() => navigate(SettingsPath.Workspace)}
onSave={handleSave}
@ -138,15 +207,15 @@ export const SettingsDomain = () => {
<SettingsPageContainer>
{/* eslint-disable-next-line react/jsx-props-no-spreading */}
<FormProvider {...form}>
{(!currentWorkspace?.hostname || !isCustomDomainEnabled) && (
<SettingsSubdomain />
)}
{isCustomDomainEnabled && (
<>
<SettingsHostnameEffect />
<SettingsHostname />
</>
)}
{(!currentWorkspace?.hostname || !isCustomDomainEnabled) && (
<SettingsSubdomain />
)}
</FormProvider>
</SettingsPageContainer>
</SubMenuTopBarContainer>