Skip to content

Beautiful Open-Source Form Builder

feat(forms): let owners set a custom slug from share page (#1310)

Joselito781445712fd1
diff --git a/api/app/Http/Controllers/Forms/FormController.php b/api/app/Http/Controllers/Forms/FormController.php
index d374b39c1..4f5358737 100644
--- a/api/app/Http/Controllers/Forms/FormController.php
+++ b/api/app/Http/Controllers/Forms/FormController.php
@@ -12,6 +12,7 @@ use App\Models\Forms\Form;
use App\Models\Version;
use App\Models\Workspace;
use App\Notifications\Forms\MobileEditorEmail;
+use App\Rules\CustomSlugRule;
use App\Service\Billing\Feature;
use App\Service\Forms\FormCleaner;
use App\Service\Forms\FormCreationService;
@@ -239,11 +240,18 @@ class FormController extends Controller
]);
}
- public function regenerateLink(Form $form, $option)
+ public function regenerateLink(Request $request, Form $form, $option)
{
$this->authorize('update', $form);
- if ($option == 'slug') {
+ if ($option == 'custom') {
+ abort_unless(config('app.self_hosted'), 403, 'Custom form URLs are only available on self-hosted instances.');
+
+ $validated = $request->validate([
+ 'slug' => ['required', 'string', 'max:100', new CustomSlugRule($form)],
+ ]);
+ $form->slug = $validated['slug'];
+ } elseif ($option == 'slug') {
$form->generateSlug();
} elseif ($option == 'uuid') {
$form->slug = Str::uuid();
diff --git a/api/routes/api.php b/api/routes/api.php
index f6a552225..f716fa077 100644
--- a/api/routes/api.php
+++ b/api/routes/api.php
@@ -278,7 +278,7 @@ Route::group(['middleware' => 'auth.multi'], function () {
'/{form}/regenerate-link/{option}',
[FormController::class, 'regenerateLink']
)
- ->where('option', '(uuid|slug)')
+ ->where('option', '(uuid|slug|custom)')
->name('regenerate-link');
Route::post(
'/{form}/duplicate',
diff --git a/api/tests/Feature/Forms/FormUpdateTest.php b/api/tests/Feature/Forms/FormUpdateTest.php
index 83648efbc..d5d29d8ee 100644
--- a/api/tests/Feature/Forms/FormUpdateTest.php
+++ b/api/tests/Feature/Forms/FormUpdateTest.php
@@ -93,3 +93,57 @@ it('can update form with existing record but generates_uuid field is not update'
expect($uuid2)->toBe($uuid);
}
});
+
+it('can set a custom form slug when self hosted', function () {
+ config(['app.self_hosted' => true]);
+ $user = $this->actingAsUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+
+ $this->putJson(route('open.forms.regenerate-link', [$form->id, 'custom']), ['slug' => 'my-custom-form'])
+ ->assertSuccessful()
+ ->assertJsonPath('form.slug', 'my-custom-form');
+
+ expect($form->fresh()->slug)->toBe('my-custom-form');
+});
+
+it('rejects invalid or duplicate custom form slugs', function () {
+ config(['app.self_hosted' => true]);
+ $user = $this->actingAsUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+ $otherForm = $this->createForm($user, $workspace);
+
+ foreach ([$otherForm->slug, '', 'Has Spaces', 'UPPER', '-leading', 'double--hyphen', str_repeat('a', 101)] as $invalid) {
+ $this->putJson(route('open.forms.regenerate-link', [$form->id, 'custom']), ['slug' => $invalid])
+ ->assertStatus(422)
+ ->assertJsonValidationErrors(['slug']);
+ }
+
+ $this->putJson(route('open.forms.regenerate-link', [$form->id, 'custom']), ['slug' => $form->slug])
+ ->assertSuccessful();
+});
+
+it('cannot set a custom form slug when not self hosted', function () {
+ config(['app.self_hosted' => false]);
+ $user = $this->actingAsUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+ $originalSlug = $form->slug;
+
+ $this->putJson(route('open.forms.regenerate-link', [$form->id, 'custom']), ['slug' => 'my-custom-form'])
+ ->assertForbidden();
+
+ expect($form->fresh()->slug)->toBe($originalSlug);
+});
+
+it('cannot set a custom form slug on a form the user cannot update', function () {
+ config(['app.self_hosted' => true]);
+ $owner = $this->createUser();
+ $workspace = $this->createUserWorkspace($owner);
+ $form = $this->createForm($owner, $workspace);
+
+ $this->actingAsUser();
+ $this->putJson(route('open.forms.regenerate-link', [$form->id, 'custom']), ['slug' => 'stolen-form'])
+ ->assertForbidden();
+});
diff --git a/client/api/forms.js b/client/api/forms.js
index ba8a740ff..b3f7ccbaa 100644
--- a/client/api/forms.js
+++ b/client/api/forms.js
@@ -20,7 +20,7 @@ export const formsApi = {
duplicate: (id) => apiService.post(`/open/forms/${id}/duplicate`),
// Form utilities
- regenerateLink: (id, option) => apiService.put(`/open/forms/${id}/regenerate-link/${option}`),
+ regenerateLink: (id, option, data = null) => apiService.put(`/open/forms/${id}/regenerate-link/${option}`, data),
mobileEditorEmail: (id) => apiService.get(`/open/forms/${id}/mobile-editor-email`),
updateWorkspace: (id, workspaceId, data) => apiService.post(`/open/forms/${id}/workspace/${workspaceId}`, data),
diff --git a/client/components/pages/forms/show/RegenerateFormLink.vue b/client/components/pages/forms/show/RegenerateFormLink.vue
index fb58fb03f..1619c7f4b 100644
--- a/client/components/pages/forms/show/RegenerateFormLink.vue
+++ b/client/components/pages/forms/show/RegenerateFormLink.vue
@@ -37,10 +37,54 @@
<template #body>
<p>
- You can choose between two different URL formats for your form.
+ You can choose between different URL formats for your form.
<span class="font-semibold">Be careful, changing your form URL is not a reversible
operation</span>. Make sure to update your form URL everywhere where it's used.
</p>
+ <div
+ v-if="isSelfHosted"
+ class="border-t py-4 mt-4"
+ >
+ <h3 class="text-xl text-neutral-700 font-semibold">
+ Custom URL
+ </h3>
+ <p>
+ Choose your own URL. Use lowercase letters, numbers and hyphens (up to 100 characters).
+ </p>
+ <form
+ class="flex items-start gap-2 mt-4"
+ @submit.prevent="setCustomSlug"
+ >
+ <div class="flex-1">
+ <UInput
+ v-model="customSlug"
+ class="w-full"
+ placeholder="my-form-url"
+ :color="customSlugError ? 'error' : undefined"
+ />
+ <p
+ v-if="customSlugError"
+ class="text-sm text-red-600 mt-1"
+ >
+ {{ customSlugError }}
+ </p>
+ </div>
+ <TrackClick
+ name="regenerate_form_link_custom_click"
+ :properties="{form_id: form.id, form_slug: form.slug, type: 'custom'}"
+ >
+ <UButton
+ type="submit"
+ :loading="regenerateLinkMutationInstance.isPending.value"
+ :disabled="!customSlug"
+ variant="outline"
+ color="primary"
+ >
+ Set custom URL
+ </UButton>
+ </TrackClick>
+ </form>
+ </div>
<div class="border-t py-4 mt-4">
<h3 class="text-xl text-neutral-700 font-semibold">
Human Readable URL
@@ -124,10 +168,20 @@ const isModalOpen = computed({
const { regenerateLink: regenerateLinkMutation } = useForms()
const regenerateLinkMutationInstance = regenerateLinkMutation()
-const regenerateLink = (option) => {
+const isSelfHosted = computed(() => useFeatureFlag('self_hosted'))
+const customSlug = ref("")
+const customSlugError = ref("")
+
+const setCustomSlug = () => {
+ regenerateLink("custom", { slug: customSlug.value.trim() })
+}
+
+const regenerateLink = (option, data = null) => {
+ customSlugError.value = ""
regenerateLinkMutationInstance.mutateAsync({
id: props.form.id,
- option
+ option,
+ data
}).then((data) => {
router.push({
name: "forms-slug-show-share",
@@ -136,6 +190,11 @@ const regenerateLink = (option) => {
useAlert().success(data.message)
showGenerateFormLinkModal.value = false
}).catch((error) => {
+ const slugError = error?.data?.errors?.slug?.[0]
+ if (option === "custom" && slugError) {
+ customSlugError.value = slugError
+ return
+ }
useAlert().error(error?.data?.message || "Something went wrong")
})
}
diff --git a/client/composables/query/forms/useForms.js b/client/composables/query/forms/useForms.js
index 6e1deb6fa..cd99e7372 100644
--- a/client/composables/query/forms/useForms.js
+++ b/client/composables/query/forms/useForms.js
@@ -132,7 +132,7 @@ export function useForms() {
const regenerateLink = (options = {}) => {
return useMutation({
- mutationFn: ({ id, option }) => formsApi.regenerateLink(id, option),
+ mutationFn: ({ id, option, data }) => formsApi.regenerateLink(id, option, data),
onSuccess: (updatedForm, { id }) => {
queryClient.setQueryData(['forms', id], (old) => {
return old ? { ...old, ...updatedForm } : updatedForm