Beautiful Open-Source Form Builder
ESC-873 = feat: implement handling of special characters in select options and … (#1105)
Chirag Chhatralaacdd0fa3b032
diff --git a/api/app/Http/Requests/AnswerFormRequest.php b/api/app/Http/Requests/AnswerFormRequest.phpindex 2e629f0b8..00c77e3cf 100644--- a/api/app/Http/Requests/AnswerFormRequest.php+++ b/api/app/Http/Requests/AnswerFormRequest.php@@ -14,7 +14,6 @@ use App\Service\Forms\FormLogicPropertyResolver;use Illuminate\Foundation\Http\FormRequest;use Illuminate\Http\Request;use Illuminate\Support\Str;-use Illuminate\Validation\Rule;use Stevebauman\Purify\Facades\Purify;class AnswerFormRequest extends FormRequest@@ -214,7 +213,13 @@ class AnswerFormRequest extends FormRequestreturn ['string'];}- return [Rule::in($this->getSelectPropertyOptions($property))];+ $options = $this->getSelectPropertyOptions($property);++ return [function ($attribute, $value, $fail) use ($options) {+ if (!in_array($value, $options, true)) {+ $fail('validation.in')->translate();+ }+ }];case 'checkbox':return ['boolean'];case 'url':@@ -291,26 +296,6 @@ class AnswerFormRequest extends FormRequestcollect($this->form->properties)->each(function ($property) use ($countryCodeMapper, $receivedData, &$mergeData) {$receivedValue = $receivedData[$property['id']] ?? null;- // Escape all '\' in select options- if (in_array($property['type'], ['select', 'multi_select']) && !is_null($receivedValue)) {- if (is_array($receivedValue)) {- $mergeData[$property['id']] = collect($receivedValue)->map(function ($value) {- $value = Str::of($value);-- return $value->replace(- ["\e", "\f", "\n", "\r", "\t", "\v", '\\'],- ['\\e', '\\f', '\\n', '\\r', '\\t', '\\v', '\\\\']- )->toString();- })->toArray();- } else {- $receivedValue = Str::of($receivedValue);- $mergeData[$property['id']] = $receivedValue->replace(- ["\e", "\f", "\n", "\r", "\t", "\v", '\\'],- ['\\e', '\\f', '\\n', '\\r', '\\t', '\\v', '\\\\']- )->toString();- }- }-if ($property['type'] === 'phone_number' && (!isset($property['use_simple_text_input']) || !$property['use_simple_text_input']) && $receivedValue && in_array($receivedValue, $countryCodeMapper)) {$mergeData[$property['id']] = null;}diff --git a/api/tests/Feature/Forms/SelectOptionSpecialCharsTest.php b/api/tests/Feature/Forms/SelectOptionSpecialCharsTest.phpnew file mode 100644index 000000000..e370bec65--- /dev/null+++ b/api/tests/Feature/Forms/SelectOptionSpecialCharsTest.php@@ -0,0 +1,424 @@+<?php+++describe('select options with special characters', function () {+ beforeEach(function () {+ $this->user = $this->actingAsUser();+ $this->workspace = $this->createUserWorkspace($this->user);+ $this->form = $this->createForm($this->user, $this->workspace);+ });++ it('can submit select option containing a tab character', function () {+ $selectField = [+ 'id' => 'select_tab',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => "Architect\t— Архитектор"],+ ['id' => 'opt2', 'name' => 'Option B'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_tab' => "Architect\t— Архитектор",+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_tab'])->toBe("Architect\t— Архитектор");+ });++ it('can submit select option containing a backslash', function () {+ $selectField = [+ 'id' => 'select_backslash',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => 'C:\\Users\\test'],+ ['id' => 'opt2', 'name' => 'Option B'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_backslash' => 'C:\\Users\\test',+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_backslash'])->toBe('C:\\Users\\test');+ });++ it('can submit select option containing newline characters', function () {+ $selectField = [+ 'id' => 'select_newline',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => "Line1\nLine2"],+ ['id' => 'opt2', 'name' => 'Option B'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_newline' => "Line1\nLine2",+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_newline'])->toBe("Line1\nLine2");+ });++ it('can submit select option containing unicode and em dash', function () {+ $selectField = [+ 'id' => 'select_unicode',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => 'Archaeologist — Археолог'],+ ['id' => 'opt2', 'name' => 'Биолог — Biologist'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_unicode' => 'Archaeologist — Археолог',+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_unicode'])->toBe('Archaeologist — Археолог');+ });++ it('can submit select option containing commas', function () {+ $selectField = [+ 'id' => 'select_comma',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => 'Smith, John'],+ ['id' => 'opt2', 'name' => 'Doe, Jane'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_comma' => 'Smith, John',+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_comma'])->toBe('Smith, John');+ });++ it('can submit select option containing double quotes', function () {+ $selectField = [+ 'id' => 'select_quotes',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => 'The "Best" Option'],+ ['id' => 'opt2', 'name' => 'Option B'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_quotes' => 'The "Best" Option',+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_quotes'])->toBe('The "Best" Option');+ });++ it('can submit multi_select options containing special characters', function () {+ $multiSelectField = [+ 'id' => 'multi_special',+ 'name' => 'Choose Options',+ 'type' => 'multi_select',+ 'required' => true,+ 'multi_select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => "Tab\there"],+ ['id' => 'opt2', 'name' => 'Back\\slash'],+ ['id' => 'opt3', 'name' => 'Comma, inside'],+ ['id' => 'opt4', 'name' => 'Normal option'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$multiSelectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'multi_special' => ["Tab\there", 'Back\\slash', 'Comma, inside'],+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['multi_special'])->toBe(["Tab\there", 'Back\\slash', 'Comma, inside']);+ });++ it('can submit select option containing mixed tab and unicode characters', function () {+ $selectField = [+ 'id' => 'select_mixed',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => "Special\tOption — Опция"],+ ['id' => 'opt2', 'name' => 'Normal'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_mixed' => "Special\tOption — Опция",+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_mixed'])->toBe("Special\tOption — Опция");+ });++ it('rejects invalid select option even with special characters in valid options', function () {+ $selectField = [+ 'id' => 'select_invalid',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => "Valid\tOption"],+ ['id' => 'opt2', 'name' => 'Also Valid'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_invalid' => 'Not A Valid Option',+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertStatus(422);+ });++ it('can submit select option containing carriage return', function () {+ $selectField = [+ 'id' => 'select_cr',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => "Option\r\nwith CRLF"],+ ['id' => 'opt2', 'name' => 'Option B'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_cr' => "Option\r\nwith CRLF",+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_cr'])->toBe("Option\r\nwith CRLF");+ });++ it('stores original value without escape sequences in submission data', function () {+ $optionWithTab = "Architect\t— Архитектор";+ $optionWithBackslash = 'Path\\to\\file';++ $selectField = [+ 'id' => 'select_stored',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => false,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => $optionWithTab],+ ['id' => 'opt2', 'name' => $optionWithBackslash],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ // Submit tab option+ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_stored' => $optionWithTab,+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful();++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_stored'])->toBe($optionWithTab);+ expect($submission->data['select_stored'])->not->toContain('\\t');+ expect($submission->data['select_stored'])->toContain("\t");+ });++ it('can submit select option with a trailing backslash', function () {+ $selectField = [+ 'id' => 'select_trailing_bs',+ 'name' => 'Choose an Option',+ 'type' => 'select',+ 'required' => true,+ 'select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => 'Ends\\'],+ ['id' => 'opt2', 'name' => 'Normal'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$selectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'select_trailing_bs' => 'Ends\\',+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['select_trailing_bs'])->toBe('Ends\\');+ });++ it('can submit multi_select option with trailing backslashes', function () {+ $multiSelectField = [+ 'id' => 'multi_trailing_bs',+ 'name' => 'Choose Options',+ 'type' => 'multi_select',+ 'required' => true,+ 'multi_select' => [+ 'options' => [+ ['id' => 'opt1', 'name' => 'Path\\'],+ ['id' => 'opt2', 'name' => 'Dir\\subdir\\'],+ ['id' => 'opt3', 'name' => 'Normal'],+ ],+ ],+ ];++ $this->form->properties = array_merge($this->form->properties, [$multiSelectField]);+ $this->form->save();++ $formData = $this->generateFormSubmissionData($this->form, [+ 'multi_trailing_bs' => ['Path\\', 'Dir\\subdir\\'],+ ]);++ $this->postJson(route('forms.answer', $this->form->slug), $formData)+ ->assertSuccessful()+ ->assertJson([+ 'type' => 'success',+ 'message' => 'Form submission saved.',+ ]);++ $submission = $this->form->submissions()->first();+ expect($submission->data['multi_trailing_bs'])->toBe(['Path\\', 'Dir\\subdir\\']);+ });+});