Enhance redirect URL handling and MentionParser functionality (JhumanJ#639)

- Updated the `redirect_url` validation in `UserFormRequest` to accept strings instead of just max length.
- Modified `MentionParser` to include a `urlFriendlyOutput` method, allowing for URL encoding of special characters in parsed values.
- Adjusted the `PublicFormController` to utilize the new `urlFriendlyOutput` method for redirect URLs.
- Created a migration to change the `redirect_url` field type in the database from string to text, accommodating longer URLs.
- Added tests to ensure proper handling of long redirect URLs and the functionality of the new URL-friendly output feature in `MentionParser`.

This update improves the flexibility and robustness of form handling and URL processing.

Author: chiragchhatrala

api/app/Http/Controllers/Forms/PublicFormController.php

@@ -116,7 +116,7 @@ private function getRedirectData($form, $submissionData)
             return ['id' => $key, 'value' => $value];
         })->values()->all();
 
-        $redirectUrl = ($form->redirect_url) ? (new MentionParser($form->redirect_url, $formattedData))->parseAsText() : null;
+        $redirectUrl = ($form->redirect_url) ? (new MentionParser($form->redirect_url, $formattedData))->urlFriendlyOutput()->parseAsText() : null;
 
         if ($redirectUrl && !filter_var($redirectUrl, FILTER_VALIDATE_URL)) {
             $redirectUrl = null;

api/app/Http/Requests/UserFormRequest.php

@@ -55,7 +55,7 @@ public function rules()
             're_fillable' => 'boolean',
             're_fill_button_text' => 'string|min:1|max:50',
             'submitted_text' => 'string|max:2000',
-            'redirect_url' => 'nullable|max:255',
+            'redirect_url' => 'nullable|string',
             'database_fields_update' => 'nullable|array',
             'max_submissions_count' => 'integer|nullable|min:1',
             'max_submissions_reached_text' => 'string|nullable',

api/app/Open/MentionParser.php

@@ -9,13 +9,20 @@ class MentionParser
 {
     private $content;
     private $data;
+    private $urlFriendly = false;
 
     public function __construct($content, $data)
     {
         $this->content = $content;
         $this->data = $data;
     }
 
+    public function urlFriendlyOutput(bool $enable = true): self
+    {
+        $this->urlFriendly = $enable;
+        return $this;
+    }
+
     public function parse()
     {
         $doc = new DOMDocument();
@@ -40,7 +47,7 @@ public function parse()
             $value = $this->getData($fieldId);
 
             if ($value !== null) {
-                $textNode = $doc->createTextNode(is_array($value) ? implode(', ', $value) : $value);
+                $textNode = $doc->createTextNode(is_array($value) ? implode($this->urlFriendly ? ',+' : ', ', $value) : $value);
                 $element->parentNode->replaceChild($textNode, $element);
             } elseif ($fallback) {
                 $textNode = $doc->createTextNode($fallback);
@@ -127,7 +134,13 @@ private function getData($fieldId)
         $value = collect($this->data)->firstWhere('id', $fieldId)['value'] ?? null;
 
         if (is_object($value)) {
-            return (array) $value;
+            $value = (array) $value;
+        }
+
+        if ($this->urlFriendly && $value !== null) {
+            return is_array($value)
+                ? array_map('urlencode', $value)
+                : urlencode($value);
         }
 
         return $value;

api/database/migrations/2024_12_05_121609_change_redirect_url_to_text_in_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->text('redirect_url')->nullable()->change();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('forms', function (Blueprint $table) {
+            $table->string('redirect_url')->nullable()->change();
+        });
+    }
+};

api/tests/Feature/Forms/RedirectUrlLengthTest.php

@@ -0,0 +1,29 @@
+<?php
+
+test('form accepts long redirect urls', function () {
+    $this->withoutExceptionHandling();
+    $user = $this->actingAsUser();
+    $workspace = $this->createUserWorkspace($user);
+    $form = $this->createForm($user, $workspace);
+
+    // Create a very long URL (more than 255 characters)
+    $longUrl = 'https://example.com/?' . str_repeat('very-long-parameter=value&', 50);
+
+    $this->putJson(route('open.forms.update', $form->id), array_merge($form->toArray(), [
+        'redirect_url' => $longUrl
+    ]))->assertStatus(200);
+
+    expect($form->fresh()->redirect_url)->toBe($longUrl);
+});
+
+test('form accepts null redirect url', function () {
+    $user = $this->actingAsUser();
+    $workspace = $this->createUserWorkspace($user);
+    $form = $this->createForm($user, $workspace);
+
+    $this->putJson(route('open.forms.update', $form->id), array_merge($form->toArray(), [
+        'redirect_url' => null
+    ]))->assertStatus(200);
+
+    expect($form->fresh()->redirect_url)->toBeNull();
+});

api/tests/Unit/Service/Forms/MentionParserTest.php

@@ -173,4 +173,46 @@
 
         expect($result)->toBe('some text replaced text dewde');
     });
+
+    describe('urlFriendlyOutput', function () {
+        test('it encodes special characters in values', function () {
+            $content = '<p>Test: <span mention mention-field-id="123">Placeholder</span></p>';
+            $data = [['id' => '123', 'value' => 'Hello & World']];
+
+            $parser = new MentionParser($content, $data);
+            $result = $parser->urlFriendlyOutput()->parse();
+
+            expect($result)->toBe('<p>Test: Hello+%26+World</p>');
+        });
+
+        test('it encodes spaces in values', function () {
+            $content = '<p>Name: <span mention mention-field-id="123">Placeholder</span></p>';
+            $data = [['id' => '123', 'value' => 'John Doe']];
+
+            $parser = new MentionParser($content, $data);
+            $result = $parser->urlFriendlyOutput()->parse();
+
+            expect($result)->toBe('<p>Name: John+Doe</p>');
+        });
+
+        test('it encodes array values', function () {
+            $content = '<p>Tags: <span mention mention-field-id="123">Placeholder</span></p>';
+            $data = [['id' => '123', 'value' => ['Web & Mobile', 'PHP/Laravel']]];
+
+            $parser = new MentionParser($content, $data);
+            $result = $parser->urlFriendlyOutput()->parse();
+
+            expect($result)->toBe('<p>Tags: Web+%26+Mobile,+PHP%2FLaravel</p>');
+        });
+
+        test('it can be disabled explicitly', function () {
+            $content = '<p>Test: <span mention mention-field-id="123">Placeholder</span></p>';
+            $data = [['id' => '123', 'value' => 'Hello & World']];
+
+            $parser = new MentionParser($content, $data);
+            $result = $parser->urlFriendlyOutput(false)->parse();
+
+            expect($result)->toBe('<p>Test: Hello & World</p>');
+        });
+    });
 });