Beautiful Open-Source Form Builder
Fix CSV export IP metadata and overlapping field IDs (#1322)
Julien Nahum0dfe687c47dc
diff --git a/api/app/Http/Requests/FormSubmissionExportRequest.php b/api/app/Http/Requests/FormSubmissionExportRequest.phpindex a3c18bb11..115a442ba 100644--- a/api/app/Http/Requests/FormSubmissionExportRequest.php+++ b/api/app/Http/Requests/FormSubmissionExportRequest.php@@ -3,10 +3,10 @@namespace App\Http\Requests;use App\Models\Forms\Form;+use App\Service\Forms\SubmissionAttribution;use Illuminate\Foundation\Http\FormRequest;use Illuminate\Http\Request;use Illuminate\Validation\Rule;-use App\Service\Forms\SubmissionAttribution;class FormSubmissionExportRequest extends FormRequest{@@ -25,6 +25,7 @@ class FormSubmissionExportRequest extends FormRequest))->pluck('id')->toArray();$validColumns[] = 'created_at';$validColumns[] = 'status';+ $validColumns[] = 'ip_address';foreach (SubmissionAttribution::PARAMETERS as $parameter) {$validColumns[] = SubmissionAttribution::columnId($parameter);}@@ -36,8 +37,8 @@ class FormSubmissionExportRequest extends FormRequestfunction ($attribute, $value, $fail) use ($validColumns) {$submittedColumns = array_keys($value);$invalidColumns = array_diff($submittedColumns, $validColumns);- if (!empty($invalidColumns)) {- $fail('The columns contain invalid values: ' . implode(', ', $invalidColumns));+ if (! empty($invalidColumns)) {+ $fail('The columns contain invalid values: '.implode(', ', $invalidColumns));}},],diff --git a/api/app/Service/Forms/FormExportService.php b/api/app/Service/Forms/FormExportService.phpindex 1218c7f39..6ab33cd6c 100644--- a/api/app/Service/Forms/FormExportService.php+++ b/api/app/Service/Forms/FormExportService.php@@ -5,15 +5,17 @@ namespace App\Service\Forms;use App\Models\Forms\Form;use App\Models\Forms\FormSubmission;use Carbon\Carbon;-use Illuminate\Support\Facades\Storage;use Illuminate\Support\Facades\Cache;+use Illuminate\Support\Facades\Storage;use Illuminate\Support\Str;use Vinkla\Hashids\Facades\Hashids;class FormExportService{public const SYNC_EXPORT_THRESHOLD = 1000;+public const CACHE_KEY_PREFIX = 'form_export_job';+public const EXPORT_FILE_PATH = 'exports/temp/';public function __construct(private ExternalSubmissionFileLinkPolicy $externalFileLinkPolicy)@@ -58,10 +60,18 @@ class FormExportServiceif ($value === true) {if ($parameter = SubmissionAttribution::parameterFromColumnId($column)) {$filteredData[$parameter] = $submission->meta['attribution'][$parameter] ?? '';+continue;}- $key = collect($formattedData)->keys()->first(fn ($key) => str_contains($key, $column));+ if ($column === 'ip_address') {+ if ($form->enable_ip_tracking && $form->workspace->hasFeature('enable_ip_tracking')) {+ $filteredData['ip_address'] = $submission->meta['ip_address'] ?? '';+ }+ // A form field can also use this ID; preserve its answer below.+ }++ $key = collect($formattedData)->keys()->first(fn ($key) => str_ends_with($key, ' ('.$column.')'));if ($key) {$filteredData[$key] = $formattedData[$key];}@@ -93,13 +103,13 @@ class FormExportService$csvContent = $this->generateCsvContent($rows);// Upload to configured storage disk- $filePath = self::EXPORT_FILE_PATH . $fileName;+ $filePath = self::EXPORT_FILE_PATH.$fileName;$disk = Storage::disk(config('filesystems.default'));$disk->put($filePath, $csvContent, ['visibility' => 'private','Content-Type' => 'text/csv',- 'Content-Disposition' => 'attachment; filename="' . $fileName . '"'+ 'Content-Disposition' => 'attachment; filename="'.$fileName.'"',]);// Generate temporary URL for download (works for all storage types)@@ -177,6 +187,6 @@ class FormExportService*/public function getCacheKey(string $jobId): string{- return self::CACHE_KEY_PREFIX . ':' . $jobId;+ return self::CACHE_KEY_PREFIX.':'.$jobId;}}diff --git a/api/tests/Feature/Forms/FormSubmissionExportTest.php b/api/tests/Feature/Forms/FormSubmissionExportTest.phpindex ed0011d6c..b352c61c6 100644--- a/api/tests/Feature/Forms/FormSubmissionExportTest.php+++ b/api/tests/Feature/Forms/FormSubmissionExportTest.php@@ -1,7 +1,7 @@<?php-use App\Models\User;use App\Models\Forms\FormSubmission;+use App\Models\User;use App\Service\Forms\FormExportService;use App\Service\Forms\SubmissionAttribution;use App\Service\Storage\FileUploadPathService;@@ -43,14 +43,14 @@ it('can export form submissions with selected columns', function () {'name' => 'Email','type' => 'email','required' => true,- ]- ]+ ],+ ],]);// Create some submissions$submissions = [['name_field' => 'John Doe', 'email_field' => '[email protected]'],- ['name_field' => 'Jane Smith', 'email_field' => '[email protected]']+ ['name_field' => 'Jane Smith', 'email_field' => '[email protected]'],];foreach ($submissions as $submission) {@@ -65,12 +65,12 @@ it('can export form submissions with selected columns', function () {'columns' => ['name_field' => true,'email_field' => true,- 'created_at' => true- ]+ 'created_at' => true,+ ],]));$response->assertSuccessful()- ->assertHeader('content-disposition', 'attachment; filename=' . $form->slug . '-submission-data.csv');+ ->assertHeader('content-disposition', 'attachment; filename='.$form->slug.'-submission-data.csv');});it('exports selected attribution columns and leaves unselected attribution out', function () {@@ -204,7 +204,7 @@ it('accepts status as a valid export column', function () {]);$response->assertSuccessful()- ->assertHeader('content-disposition', 'attachment; filename=' . $form->slug . '-submission-data.csv');+ ->assertHeader('content-disposition', 'attachment; filename='.$form->slug.'-submission-data.csv');});it('cannot export form submissions with invalid columns', function () {@@ -217,16 +217,16 @@ it('cannot export form submissions with invalid columns', function () {'name' => 'Name','type' => 'text','required' => true,- ]- ]+ ],+ ],]);$response = $this->postJson(route('open.forms.submissions.export', ['form' => $form,'columns' => ['invalid_field' => true,- 'name_field' => true- ]+ 'name_field' => true,+ ],]));$response->assertStatus(422)@@ -251,7 +251,7 @@ it('cannot export form submissions from another user form', function () {]);$response->assertJson([- 'message' => 'This action is unauthorized.'+ 'message' => 'This action is unauthorized.',]);});@@ -275,7 +275,7 @@ it('includes status column when partial submissions are enabled', function () {$emailField = collect($form->properties)->firstWhere('type', 'email');$completedSubmissionData = $this->generateFormSubmissionData($form, [$textField['id'] => 'Jane Complete',- $emailField['id'] => '[email protected]'+ $emailField['id'] => '[email protected]',]);$completedResponse = $this->postJson(route('forms.answer', $form->slug), $completedSubmissionData);$completedResponse->assertSuccessful();@@ -291,11 +291,11 @@ it('includes status column when partial submissions are enabled', function () {'columns' => [$textField['id'] => true,$emailField['id'] => true,- ]+ ],]));$response->assertSuccessful()- ->assertHeader('content-disposition', 'attachment; filename=' . $form->slug . '-submission-data.csv');+ ->assertHeader('content-disposition', 'attachment; filename='.$form->slug.'-submission-data.csv');// Verify the exported CSV contains status column and correct valuesob_start();@@ -380,7 +380,7 @@ it('does not include status column when partial submissions are disabled', funct'form' => $form,'columns' => [$textField['id'] => true,- ]+ ],]));$response->assertSuccessful();@@ -486,7 +486,7 @@ it('uses the workspace policy for asynchronous CSV download links', function ()parse_str((string) parse_url($fileUrl, PHP_URL_QUERY), $queryParameters);expect((int) ($queryParameters['expiration'] ?? 0))->toBe($now->copy()->addHours(72)->timestamp);- Storage::assertExists(FormExportService::EXPORT_FILE_PATH . 'weekend-submissions.csv');+ Storage::assertExists(FormExportService::EXPORT_FILE_PATH.'weekend-submissions.csv');});it('includes a UTF-8 BOM in asynchronous CSV exports', function () {@@ -498,7 +498,7 @@ it('includes a UTF-8 BOM in asynchronous CSV exports', function () {['name' => 'பெயர்'],], $fileName, now()->addHour());- $csv = Storage::get(FormExportService::EXPORT_FILE_PATH . $fileName);+ $csv = Storage::get(FormExportService::EXPORT_FILE_PATH.$fileName);expect($csv)->toStartWith("\xEF\xBB\xBF")@@ -518,7 +518,7 @@ it('allows export status polling when the general api rate limit is exhausted',$form = $this->createForm($user, $workspace);$jobId = (string) Str::uuid();- Cache::put('form_export_job:' . $jobId, [+ Cache::put('form_export_job:'.$jobId, ['status' => 'processing','progress' => 50,'form_id' => $form->id,@@ -620,3 +620,78 @@ it('returns not found for unknown export jobs', function () {->getJson("/open/forms/{$form->id}/submissions/export/status/{$jobId}")->assertNotFound();});++it('exports IP metadata through the same request used by the submissions table', function () {+ $user = $this->actingAsBusinessUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, ['enable_ip_tracking' => true]);+ $form->submissions()->create([+ 'data' => [], 'meta' => ['ip_address' => '192.0.2.15'],+ 'status' => FormSubmission::STATUS_COMPLETED,+ ]);+ $response = $this->postJson(route('open.forms.submissions.export', ['form' => $form]), [+ 'columns' => ['ip_address' => true, 'created_at' => true],+ ])->assertSuccessful();+ ob_start();+ $response->sendContent();+ $rows = parseCsvRows(ob_get_clean());+ expect($rows[0])->toContain('ip_address')->and($rows[1])->toContain('192.0.2.15');+});++it('does not expose stored IP metadata without the tracking setting and feature', function (bool $tracking, bool $business) {+ $user = $business ? $this->actingAsBusinessUser() : $this->actingAsProUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, ['enable_ip_tracking' => $tracking]);+ $submission = $form->submissions()->create([+ 'data' => [], 'meta' => ['ip_address' => '192.0.2.15'],+ 'status' => FormSubmission::STATUS_COMPLETED,+ ]);+ $row = app(FormExportService::class)->formatSubmissionForExport($form, $submission, ['ip_address' => true]);+ expect($row)->not->toHaveKey('ip_address')->not->toContain('192.0.2.15');+})->with([[false, true], [true, false]]);++it('matches requested field IDs exactly when another label contains the ID', function () {+ $user = $this->actingAsProUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, [+ 'properties' => [+ ['id' => 'prenom', 'name' => 'Prénom', 'type' => 'text'],+ ['id' => 'nom', 'name' => 'Nom', 'type' => 'text'],+ ],+ 'removed_properties' => [['id' => 'old_nom', 'name' => 'Old Nom', 'type' => 'text']],+ ]);+ $submission = $form->submissions()->create([+ 'data' => ['prenom' => 'Alice', 'nom' => 'Dupont', 'old_nom' => 'Archived'],+ 'status' => FormSubmission::STATUS_COMPLETED,+ ]);+ $row = app(FormExportService::class)->formatSubmissionForExport($form, $submission, [+ 'prenom' => true, 'nom' => true, 'old_nom' => true,+ ]);+ expect($row)->toHaveCount(4)+ ->and($row['Prénom (prenom)'])->toBe('Alice')+ ->and($row['Nom (nom)'])->toBe('Dupont');+ expect(array_values($row))->toContain('Archived');+});++it('preserves a form field whose ID matches the IP metadata column', function (bool $tracking) {+ $user = $this->actingAsBusinessUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace, [+ 'enable_ip_tracking' => $tracking,+ 'properties' => [['id' => 'ip_address', 'name' => 'Server IP', 'type' => 'text']],+ ]);+ $submission = $form->submissions()->create([+ 'data' => ['ip_address' => '203.0.113.10'],+ 'meta' => ['ip_address' => '192.0.2.15'],+ 'status' => FormSubmission::STATUS_COMPLETED,+ ]);++ $row = app(FormExportService::class)->formatSubmissionForExport($form, $submission, ['ip_address' => true]);++ expect($row['Server IP (ip_address)'] ?? null)->toBe('203.0.113.10');+ if ($tracking) {+ expect($row['ip_address'])->toBe('192.0.2.15');+ } else {+ expect($row)->not->toHaveKey('ip_address');+ }+})->with([true, false]);diff --git a/docs/api-reference/submissions/export-submissions-csv.mdx b/docs/api-reference/submissions/export-submissions-csv.mdxindex d8a6533f2..a5b23b9d7 100644--- a/docs/api-reference/submissions/export-submissions-csv.mdx+++ b/docs/api-reference/submissions/export-submissions-csv.mdx@@ -72,3 +72,11 @@ The API automatically determines whether to process the export synchronously or### Error Responses`403 Forbidden` – The token lacks `forms-read` or you don't have access.+++The `columns` map may include `ip_address`. IP metadata is emitted only when+IP tracking is enabled on the form and available in its workspace plan. Field+columns are matched by their exact saved IDs, including removed fields.++If a form field also uses `ip_address` as its ID, its answer is exported in+its own named column alongside any permitted IP metadata.