Beautiful Open-Source Form Builder
Implement IP tracking feature for form submissions (#898)
Chirag Chhatrala2fe7b36c3b3d
diff --git a/api/app/Http/Controllers/Forms/PublicFormController.php b/api/app/Http/Controllers/Forms/PublicFormController.phpindex 55f309bb1..f5eda701e 100644--- a/api/app/Http/Controllers/Forms/PublicFormController.php+++ b/api/app/Http/Controllers/Forms/PublicFormController.php@@ -110,15 +110,11 @@ class PublicFormController extends Controller/*** Handle partial form submissions*- * @param Request $request+ * @param array $submissionData* @return \Illuminate\Http\JsonResponse*/- private function handlePartialSubmissions(Request $request, Form $form)+ private function handlePartialSubmissions(array $submissionData, Form $form){-- // Process submission data to extract submission ID- $submissionData = $this->processSubmissionIdentifiers($request, $request->all());-// Validate that at least one field has a value$hasValue = false;foreach ($submissionData as $key => $value) {@@ -133,19 +129,13 @@ class PublicFormController extends Controller], 422);}- // Explicitly mark this as a partial submission$submissionData['is_partial'] = true;-- // Use the same job as regular submissions to ensure consistent processing$job = new StoreFormSubmissionJob($form, $submissionData);$job->handle();- // Get the submission ID- $submissionId = $job->getSubmissionId();-return $this->success(['message' => 'Partial submission saved',- 'submission_hash' => Hashids::encode($submissionId)+ 'submission_hash' => Hashids::encode($job->getSubmissionId())]);}@@ -156,18 +146,29 @@ class PublicFormController extends Controller$isFirstSubmission = ($form->submissions_count === 0);- // Handle partial submissions+ // Check for partial submission flag early (before validation)$isPartial = $request->get('is_partial') ?? false;- if ($isPartial && $form->enable_partial_submissions && $form->is_pro) {- return $this->handlePartialSubmissions($request, $form);- }- // Get validated data (includes all metadata)- $submissionData = $request->validated();+ // Use raw data for partial submissions (don't validate all required fields)+ // Use validated data for complete submissions+ $submissionData = ($isPartial && $form->enable_partial_submissions && $form->is_pro)+ ? $request->all()+ : $request->validated();// Process submission hash and ID$submissionData = $this->processSubmissionIdentifiers($request, $submissionData);+ // Add IP address for tracking if enabled+ unset($submissionData['submitter_ip']);+ if ($form->enable_ip_tracking && $form->is_pro) {+ $submissionData['submitter_ip'] = $request->ip();+ }++ // Handle partial submissions+ if ($isPartial && $form->enable_partial_submissions && $form->is_pro) {+ return $this->handlePartialSubmissions($submissionData, $form);+ }+// Create the job with all data (including metadata)$job = new StoreFormSubmissionJob($form, $submissionData);diff --git a/api/app/Http/Requests/UserFormRequest.php b/api/app/Http/Requests/UserFormRequest.phpindex 844c0c46d..33ef97acb 100644--- a/api/app/Http/Requests/UserFormRequest.php+++ b/api/app/Http/Requests/UserFormRequest.php@@ -155,6 +155,7 @@ abstract class UserFormRequest extends \Illuminate\Foundation\Http\FormRequest'auto_save' => 'boolean','auto_focus' => 'boolean','enable_partial_submissions' => 'boolean',+ 'enable_ip_tracking' => 'boolean',// Properties'properties' => 'required|array',diff --git a/api/app/Http/Resources/FormSubmissionResource.php b/api/app/Http/Resources/FormSubmissionResource.phpindex c3cdb7af6..7e2e1e95a 100644--- a/api/app/Http/Resources/FormSubmissionResource.php+++ b/api/app/Http/Resources/FormSubmissionResource.php@@ -47,12 +47,17 @@ class FormSubmissionResource extends JsonResourceprivate function addExtraData(){- $this->data = array_merge($this->data, [+ $extraData = ['status' => $this->status,'created_at' => $this->created_at->toDateTimeString(),'id' => $this->id,- 'submission_id' => Hashids::encode($this->id),- ]);+ 'submission_id' => Hashids::encode($this->id)+ ];+ if ($this->form->enable_ip_tracking && $this->form->is_pro && !empty($this->meta)) {+ $extraData['ip_address'] = $this->meta['ip_address'] ?? null;+ }++ $this->data = array_merge($this->data, $extraData);}/**diff --git a/api/app/Jobs/Form/StoreFormSubmissionJob.php b/api/app/Jobs/Form/StoreFormSubmissionJob.phpindex 228b376e0..aa0238c1c 100644--- a/api/app/Jobs/Form/StoreFormSubmissionJob.php+++ b/api/app/Jobs/Form/StoreFormSubmissionJob.php@@ -29,6 +29,7 @@ use Stevebauman\Purify\Facades\Purify;* - submission_id: ID of an existing submission to update (must be an integer)* - completion_time: Time in seconds it took to complete the form* - is_partial: Whether this is a partial submission (will be stored with STATUS_PARTIAL)+ * - submitter_ip: IP address of the submitter (will be stored in meta if form has IP tracking enabled)* If not specified, submissions are treated as complete by default.** These metadata fields will be automatically extracted and removed from the stored form data.@@ -49,6 +50,7 @@ class StoreFormSubmissionJob implements ShouldQueueprivate ?array $formData = null;private ?int $completionTime = null;private bool $isPartial = false;+ private ?string $submitterIp = null;/*** Create a new job instance.@@ -85,6 +87,7 @@ class StoreFormSubmissionJob implements ShouldQueue* - submission_id* - completion_time* - is_partial+ * - submitter_ip*/private function extractMetadata(): void{@@ -102,6 +105,10 @@ class StoreFormSubmissionJob implements ShouldQueue$this->isPartial = (bool)$this->submissionData['is_partial'];unset($this->submissionData['is_partial']);}+ if (isset($this->submissionData['submitter_ip'])) {+ $this->submitterIp = $this->submissionData['submitter_ip'];+ unset($this->submissionData['submitter_ip']);+ }}/**@@ -174,6 +181,14 @@ class StoreFormSubmissionJob implements ShouldQueue$submission->status = $this->isPartial? FormSubmission::STATUS_PARTIAL: FormSubmission::STATUS_COMPLETED;++ // Store IP address in meta if IP tracking is enabled+ if ($this->form->enable_ip_tracking && $this->form->is_pro && $this->submitterIp) {+ $existingMeta = $submission->meta ?? [];+ $existingMeta['ip_address'] = $this->submitterIp;+ $submission->meta = $existingMeta;+ }+$submission->save();$this->submissionId = $submission->id;}diff --git a/api/app/Models/Forms/Form.php b/api/app/Models/Forms/Form.phpindex d23bea8f0..6c3c74eaf 100644--- a/api/app/Models/Forms/Form.php+++ b/api/app/Models/Forms/Form.php@@ -103,6 +103,7 @@ class Form extends Model implements CachableAttributes'auto_save','auto_focus','enable_partial_submissions',+ 'enable_ip_tracking',// Security & Privacy'can_be_indexed',@@ -124,6 +125,7 @@ class Form extends Model implements CachableAttributes'cover_settings' => 'array','translations' => 'array','enable_partial_submissions' => 'boolean',+ 'enable_ip_tracking' => 'boolean','auto_save' => 'boolean','presentation_style' => 'string','settings' => 'array',diff --git a/api/app/Models/Forms/FormSubmission.php b/api/app/Models/Forms/FormSubmission.phpindex c087a754b..7814546fa 100644--- a/api/app/Models/Forms/FormSubmission.php+++ b/api/app/Models/Forms/FormSubmission.php@@ -16,7 +16,8 @@ class FormSubmission extends Modelprotected $fillable = ['data','completion_time',- 'status'+ 'status',+ 'meta'];protected function casts(): array@@ -24,6 +25,7 @@ class FormSubmission extends Modelreturn ['data' => 'array','completion_time' => 'integer',+ 'meta' => 'array',];}diff --git a/api/app/Service/Forms/FormCleaner.php b/api/app/Service/Forms/FormCleaner.phpindex d7cdd7fa0..e4103b072 100644--- a/api/app/Service/Forms/FormCleaner.php+++ b/api/app/Service/Forms/FormCleaner.php@@ -36,6 +36,7 @@ class FormCleaner'seo_meta' => [],'redirect_url' => null,'enable_partial_submissions' => false,+ 'enable_ip_tracking' => false,];private array $formNonTrialingDefaults = [@@ -62,6 +63,7 @@ class FormCleaner'seo_meta' => 'Custom SEO was disabled','redirect_url' => 'Redirect Url was disabled','enable_partial_submissions' => 'Partial submissions were disabled',+ 'enable_ip_tracking' => 'IP tracking was disabled',// For fields'file_upload' => 'Link field is not a file upload.',diff --git a/api/database/migrations/2025_09_26_064453_add_enable_ip_tracking_to_forms_table.php b/api/database/migrations/2025_09_26_064453_add_enable_ip_tracking_to_forms_table.phpnew file mode 100644index 000000000..8e101fa7f--- /dev/null+++ b/api/database/migrations/2025_09_26_064453_add_enable_ip_tracking_to_forms_table.php@@ -0,0 +1,27 @@+<?php++use Illuminate\Database\Migrations\Migration;+use Illuminate\Database\Schema\Blueprint;+use Illuminate\Support\Facades\Schema;++return new class () extends Migration {+ /**+ * Run the migrations.+ */+ public function up(): void+ {+ Schema::table('forms', function (Blueprint $table) {+ $table->boolean('enable_ip_tracking')->default(false);+ });+ }++ /**+ * Reverse the migrations.+ */+ public function down(): void+ {+ Schema::table('forms', function (Blueprint $table) {+ $table->dropColumn('enable_ip_tracking');+ });+ }+};diff --git a/api/database/migrations/2025_09_26_064506_add_meta_to_form_submissions_table.php b/api/database/migrations/2025_09_26_064506_add_meta_to_form_submissions_table.phpnew file mode 100644index 000000000..487db6b34--- /dev/null+++ b/api/database/migrations/2025_09_26_064506_add_meta_to_form_submissions_table.php@@ -0,0 +1,27 @@+<?php++use Illuminate\Database\Migrations\Migration;+use Illuminate\Database\Schema\Blueprint;+use Illuminate\Support\Facades\Schema;++return new class () extends Migration {+ /**+ * Run the migrations.+ */+ public function up(): void+ {+ Schema::table('form_submissions', function (Blueprint $table) {+ $table->json('meta')->nullable();+ });+ }++ /**+ * Reverse the migrations.+ */+ public function down(): void+ {+ Schema::table('form_submissions', function (Blueprint $table) {+ $table->dropColumn('meta');+ });+ }+};diff --git a/api/tests/Feature/Submissions/IpTrackingTest.php b/api/tests/Feature/Submissions/IpTrackingTest.phpnew file mode 100644index 000000000..debb349d5--- /dev/null+++ b/api/tests/Feature/Submissions/IpTrackingTest.php@@ -0,0 +1,170 @@+<?php++use App\Models\Forms\FormSubmission;++it('tracks IP address when ip tracking is enabled on pro form', function () {+ $user = $this->actingAsProUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, [+ 'enable_ip_tracking' => true+ ]);++ $formData = $this->generateFormSubmissionData($form, ['text' => 'Test submission']);++ $this->postJson(route('forms.answer', $form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ // Verify IP was tracked in meta+ $submission = FormSubmission::first();+ expect($submission->meta)->not->toBeNull();+ expect($submission->meta)->toHaveKey('ip_address');+ expect($submission->meta['ip_address'])->toContain('127.0.0.1');+});++it('does not track IP when ip tracking is disabled', function () {+ $user = $this->actingAsProUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, [+ 'enable_ip_tracking' => false+ ]);++ $formData = $this->generateFormSubmissionData($form, ['text' => 'Test submission']);++ $this->postJson(route('forms.answer', $form->slug), $formData)+ ->assertSuccessful();++ // Verify IP was not tracked+ $submission = FormSubmission::first();+ expect($submission->meta)->toBeNull();+});++it('does not track IP on non-pro forms even when enabled', function () {+ $user = $this->actingAsUser(); // Non-pro user+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, [+ 'enable_ip_tracking' => true+ ]);++ $formData = $this->generateFormSubmissionData($form, ['text' => 'Test submission']);++ $this->postJson(route('forms.answer', $form->slug), $formData)+ ->assertSuccessful();++ // Verify IP was not tracked on non-pro form+ $submission = FormSubmission::first();+ expect($submission->meta)->toBeNull();+});++it('tracks IP in partial submissions when enabled', function () {+ $user = $this->actingAsProUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, [+ 'enable_ip_tracking' => true,+ 'enable_partial_submissions' => true+ ]);++ // Create partial submission+ $formData = $this->generateFormSubmissionData($form, ['text' => 'Partial submission']);+ $formData['is_partial'] = true;++ $response = $this->postJson(route('forms.answer', $form->slug), $formData)+ ->assertSuccessful();++ $submissionHash = $response->json('submission_hash');++ // Verify IP was tracked in partial submission+ $submission = FormSubmission::first();+ expect($submission->meta)->not->toBeNull();+ expect($submission->meta)->toHaveKey('ip_address');+ expect($submission->meta['ip_address'])->toContain('127.0.0.1');++ // Complete the submission+ $completeData = $this->generateFormSubmissionData($form, ['text' => 'Complete submission']);+ $completeData['submission_hash'] = $submissionHash;++ $this->postJson(route('forms.answer', $form->slug), $completeData)+ ->assertSuccessful();++ // Verify IP is still tracked after completion+ $submission->refresh();+ expect($submission->meta)->not->toBeNull();+ expect($submission->meta)->toHaveKey('ip_address');+ expect($submission->status)->toBe(FormSubmission::STATUS_COMPLETED);+});++it('preserves existing meta data when adding IP tracking', function () {+ $user = $this->actingAsProUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, [+ 'enable_ip_tracking' => true+ ]);++ // Create initial partial submission with existing meta data+ $formData = $this->generateFormSubmissionData($form, ['text' => 'Initial submission']);+ $formData['is_partial'] = true;++ $response = $this->postJson(route('forms.answer', $form->slug), $formData)+ ->assertSuccessful();++ $submissionHash = $response->json('submission_hash');+ $submission = FormSubmission::first();++ // Manually add some custom meta data+ $submission->update([+ 'meta' => array_merge($submission->meta ?? [], ['custom_field' => 'custom_value'])+ ]);++ // Submit form data to update the submission+ $updateData = $this->generateFormSubmissionData($form, ['text' => 'Updated submission']);+ $updateData['submission_hash'] = $submissionHash;++ $this->postJson(route('forms.answer', $form->slug), $updateData)+ ->assertSuccessful();++ // Verify both existing meta and IP are preserved+ $submission->refresh();+ expect($submission->meta)->toHaveKey('custom_field');+ expect($submission->meta['custom_field'])->toBe('custom_value');+ expect($submission->meta)->toHaveKey('ip_address');+ expect($submission->meta['ip_address'])->toContain('127.0.0.1');+});++it('does not modify existing meta when IP tracking conditions are not met', function () {+ $user = $this->actingAsUser(); // Non-pro user+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, [+ 'enable_ip_tracking' => true // Enabled but user is not pro+ ]);++ // Create initial submission with existing meta data+ $formData = $this->generateFormSubmissionData($form, ['text' => 'Initial submission']);+ $formData['is_partial'] = true;++ $response = $this->postJson(route('forms.answer', $form->slug), $formData)+ ->assertSuccessful();++ $submissionHash = $response->json('submission_hash');+ $submission = FormSubmission::first();++ // Manually add some existing meta data+ $submission->update([+ 'meta' => ['existing_field' => 'existing_value']+ ]);++ // Submit form data to update the submission+ $updateData = $this->generateFormSubmissionData($form, ['text' => 'Updated submission']);+ $updateData['submission_hash'] = $submissionHash;++ $this->postJson(route('forms.answer', $form->slug), $updateData)+ ->assertSuccessful();++ // Verify existing meta is preserved and no IP was added+ $submission->refresh();+ expect($submission->meta)->toHaveKey('existing_field');+ expect($submission->meta['existing_field'])->toBe('existing_value');+ expect($submission->meta)->not->toHaveKey('ip_address');+});diff --git a/api/tests/Feature/Submissions/PartialSubmissionTest.php b/api/tests/Feature/Submissions/PartialSubmissionTest.phpindex 21f73a16d..4508185c9 100644--- a/api/tests/Feature/Submissions/PartialSubmissionTest.php+++ b/api/tests/Feature/Submissions/PartialSubmissionTest.php@@ -1,6 +1,5 @@<?php-use App\Models\Forms\Form;use App\Models\Forms\FormSubmission;use Illuminate\Http\UploadedFile;use Illuminate\Support\Facades\Storage;diff --git a/client/components/open/forms/components/form-components/FormSubmissionSettings.vue b/client/components/open/forms/components/form-components/FormSubmissionSettings.vueindex 262c582db..8406d4007 100644--- a/client/components/open/forms/components/form-components/FormSubmissionSettings.vue+++ b/client/components/open/forms/components/form-components/FormSubmissionSettings.vue@@ -108,6 +108,33 @@</template></ToggleSwitchInput>+ <ToggleSwitchInput+ class="mt-4"+ name="enable_ip_tracking"+ :form="form"+ help="Collect and store submitter IP addresses for analytics, fraud prevention, and geographic insights. Helps identify submission patterns and improve security."+ >+ <template #label>+ <span class="text-sm">+ Collect IP addresses+ </span>+ <ProTag+ class="ml-1"+ upgrade-modal-title="Upgrade to collect IP addresses"+ upgrade-modal-description="Automatically capture submitter IP addresses to gain valuable insights into your form traffic. Analyze geographic patterns, detect suspicious activity, and enhance your form security with detailed submission analytics."+ />+ </template>+ </ToggleSwitchInput>+ <UAlert+ v-if="form.enable_ip_tracking"+ color="neutral"+ icon="i-heroicons-shield-exclamation"+ variant="subtle"+ title="GDPR and Privacy Compliance"+ description="Ensure your privacy policy discloses IP address collection and obtain proper user consent where required."+ class="mt-4 max-w-md"+ />+<!-- Post-Submission Behavior --><h4 class="font-semibold mt-4 border-t pt-4">After Submission <pro-tagdiff --git a/client/components/open/tables/OpenTable.vue b/client/components/open/tables/OpenTable.vueindex 909c54c17..8049a4e58 100644--- a/client/components/open/tables/OpenTable.vue+++ b/client/components/open/tables/OpenTable.vue@@ -254,6 +254,7 @@ const fieldComponents = {payment: OpenPayment,barcode: OpenText,status: OpenSubmissionStatus,+ ip_address: OpenText,}const table = ref(null)diff --git a/client/composables/components/tables/useTableState.js b/client/composables/components/tables/useTableState.jsindex 64a58a73f..3854004c5 100644--- a/client/composables/components/tables/useTableState.js+++ b/client/composables/components/tables/useTableState.js@@ -320,6 +320,19 @@ export function useTableState(form, withActions = false) {})}+ // Add IP address column if needed+ if (form.value?.is_pro && (form.value.enable_ip_tracking ?? false)) {+ cols.push({+ id: 'ip_address',+ accessorKey: 'ip_address',+ header: 'IP Address',+ type: 'ip_address',+ enableResizing: true,+ minSize: 100,+ maxSize: 500,+ })+ }+// Add actions columnsif (import.meta.client && withActions) {cols.unshift({