Issue #71

- Implemented sanitization of entered text and handling of duplicates

Author: schramm-joboo

src/ChatBasedContentEditor/Presentation/Resources/assets/controllers/prompt_suggestions_controller.ts

@@ -14,6 +14,7 @@ export default class extends Controller {
         "formModal",
         "formInput",
         "formTitle",
+        "formError",
         "deleteModal",
     ];
 
@@ -54,6 +55,8 @@ export default class extends Controller {
     declare readonly formInputTarget: HTMLTextAreaElement;
     declare readonly hasFormTitleTarget: boolean;
     declare readonly formTitleTarget: HTMLElement;
+    declare readonly hasFormErrorTarget: boolean;
+    declare readonly formErrorTarget: HTMLElement;
     declare readonly hasDeleteModalTarget: boolean;
     declare readonly deleteModalTarget: HTMLElement;
 
@@ -197,7 +200,7 @@ export default class extends Controller {
             return;
         }
 
-        const text = this.formInputTarget.value.trim();
+        const text = this.sanitizeText(this.formInputTarget.value);
         if (text === "") {
             return;
         }
@@ -213,11 +216,19 @@ export default class extends Controller {
             method = "PUT";
         }
 
-        const suggestions = await this.sendRequest(url, method, { text });
-        if (suggestions !== null) {
-            this.refreshSuggestionsList(suggestions);
+        const result = await this.sendRequest(url, method, { text });
+
+        if (result === null) {
+            this.showFormError("An unexpected error occurred.");
+            return;
+        }
+
+        if ("error" in result) {
+            this.showFormError(result.error);
+            return;
         }
 
+        this.refreshSuggestionsList(result.suggestions);
         this.hideFormModal();
     }
 
@@ -254,10 +265,10 @@ export default class extends Controller {
         }
 
         const url = this.deleteUrlTemplateValue.replace("99999", String(this.deleteIndex));
-        const suggestions = await this.sendRequest(url, "DELETE");
+        const result = await this.sendRequest(url, "DELETE");
 
-        if (suggestions !== null) {
-            this.refreshSuggestionsList(suggestions);
+        if (result !== null && "suggestions" in result) {
+            this.refreshSuggestionsList(result.suggestions);
         }
 
         this.cancelDelete();
@@ -274,21 +285,39 @@ export default class extends Controller {
             this.formTitleTarget.textContent = title;
         }
 
+        this.clearFormError();
         this.formInputTarget.value = text;
         this.formInputTarget.placeholder = this.placeholderValue;
         this.formModalTarget.classList.remove("hidden");
 
-        // Focus the textarea after it becomes visible
         requestAnimationFrame(() => {
             this.formInputTarget.focus();
         });
     }
 
+    private showFormError(message: string): void {
+        if (this.hasFormErrorTarget) {
+            this.formErrorTarget.textContent = message;
+            this.formErrorTarget.classList.remove("hidden");
+        }
+    }
+
+    private clearFormError(): void {
+        if (this.hasFormErrorTarget) {
+            this.formErrorTarget.textContent = "";
+            this.formErrorTarget.classList.add("hidden");
+        }
+    }
+
     /**
-     * Send a JSON request to the API and return the updated suggestions list.
-     * Returns null if the request failed.
+     * Send a JSON request to the API.
+     * Returns a success object with suggestions, an error object with a message, or null on network failure.
      */
-    private async sendRequest(url: string, method: string, body?: Record<string, string>): Promise<string[] | null> {
+    private async sendRequest(
+        url: string,
+        method: string,
+        body?: Record<string, string>,
+    ): Promise<{ suggestions: string[] } | { error: string } | null> {
         try {
             const options: RequestInit = {
                 method,
@@ -304,16 +333,16 @@ export default class extends Controller {
             }
 
             const response = await fetch(url, options);
-
-            if (!response.ok) {
-                return null;
-            }
-
             const data = (await response.json()) as {
                 suggestions?: string[];
+                error?: string;
             };
 
-            return data.suggestions ?? null;
+            if (!response.ok) {
+                return { error: data.error ?? "Request failed." };
+            }
+
+            return { suggestions: data.suggestions ?? [] };
         } catch {
             return null;
         }
@@ -419,4 +448,15 @@ export default class extends Controller {
             this.expandCollapseWrapperTarget.classList.add("hidden");
         }
     }
+
+    private sanitizeText(raw: string): string {
+        return (
+            raw
+                .replace(/[\r\n]+/g, " ")
+                // eslint-disable-next-line no-control-regex
+                .replace(/[\x00-\x1F\x7F-\x9F]/g, "")
+                .replace(/\s{2,}/g, " ")
+                .trim()
+        );
+    }
 }

src/ChatBasedContentEditor/Presentation/Resources/templates/_prompt_suggestions.twig

@@ -95,6 +95,8 @@
                       {{ stimulus_action('prompt-suggestions', 'handleFormKeydown', 'keydown') }}
                       rows="5"
                       class="w-full px-3 py-2 text-sm border border-dark-300 dark:border-dark-600 rounded-md bg-white dark:bg-dark-700 text-dark-900 dark:text-dark-100 placeholder-dark-400 dark:placeholder-dark-500 focus:ring-2 focus:ring-primary-500 focus:border-primary-500"></textarea>
+            <p {{ stimulus_target('prompt-suggestions', 'formError') }}
+               class="hidden mt-1 text-xs text-red-600 dark:text-red-400"></p>
             <div class="flex justify-end gap-2 mt-4">
                 <button type="button"
                         {{ stimulus_action('prompt-suggestions', 'hideFormModal', 'click') }}

src/ChatBasedContentEditor/Presentation/Service/PromptSuggestionsService.php

@@ -63,12 +63,17 @@ public function getSuggestions(?string $workspacePath): array
      */
     public function addSuggestion(string $workspacePath, string $text): array
     {
-        $text = trim($text);
+        $text = $this->sanitize($text);
         if ($text === '') {
             throw new InvalidArgumentException('Suggestion text must not be empty.');
         }
 
         $suggestions = $this->getSuggestions($workspacePath);
+
+        if ($this->isDuplicate($text, $suggestions)) {
+            throw new InvalidArgumentException('This suggestion already exists.');
+        }
+
         array_unshift($suggestions, $text);
 
         $this->saveSuggestions($workspacePath, $suggestions);
@@ -83,7 +88,7 @@ public function addSuggestion(string $workspacePath, string $text): array
      */
     public function updateSuggestion(string $workspacePath, int $index, string $text): array
     {
-        $text = trim($text);
+        $text = $this->sanitize($text);
         if ($text === '') {
             throw new InvalidArgumentException('Suggestion text must not be empty.');
         }
@@ -94,6 +99,10 @@ public function updateSuggestion(string $workspacePath, int $index, string $text
             throw new OutOfRangeException('Suggestion index ' . $index . ' is out of range.');
         }
 
+        if ($this->isDuplicate($text, $suggestions, $index)) {
+            throw new InvalidArgumentException('This suggestion already exists.');
+        }
+
         $suggestions[$index] = $text;
         $suggestions         = array_values($suggestions);
 
@@ -122,6 +131,44 @@ public function deleteSuggestion(string $workspacePath, int $index): array
         return $suggestions;
     }
 
+    /**
+     * @param list<string> $suggestions
+     */
+    private function isDuplicate(string $text, array $suggestions, ?int $excludeIndex = null): bool
+    {
+        $normalised = mb_strtolower($text);
+
+        foreach ($suggestions as $index => $existing) {
+            if ($excludeIndex !== null && $index === $excludeIndex) {
+                continue;
+            }
+
+            if (mb_strtolower($existing) === $normalised) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Strip newlines, control characters, and collapse whitespace to produce a single-line string.
+     * Suggestions are stored one per line, so embedded newlines would corrupt the file format.
+     */
+    private function sanitize(string $text): string
+    {
+        // Replace newlines with spaces
+        $text = str_replace(["\r\n", "\r", "\n"], ' ', $text);
+
+        // Remove invisible/control characters (Unicode category C) but keep regular spaces
+        $text = (string) preg_replace('/[\p{C}]+/u', '', $text);
+
+        // Collapse multiple spaces into one
+        $text = (string) preg_replace('/\s{2,}/', ' ', $text);
+
+        return trim($text);
+    }
+
     /**
      * Write the suggestions list back to the file.
      *

tests/Unit/ChatBasedContentEditor/PromptSuggestionsServiceTest.php

@@ -204,6 +204,28 @@ public function testAddSuggestionThrowsOnWhitespaceOnlyText(): void
         $service->addSuggestion($this->tempDir, '   ');
     }
 
+    public function testAddSuggestionThrowsOnDuplicate(): void
+    {
+        $this->createSuggestionsFile("Existing suggestion\n");
+
+        $service = new PromptSuggestionsService();
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('This suggestion already exists.');
+        $service->addSuggestion($this->tempDir, 'Existing suggestion');
+    }
+
+    public function testAddSuggestionThrowsOnCaseInsensitiveDuplicate(): void
+    {
+        $this->createSuggestionsFile("Create a landing page\n");
+
+        $service = new PromptSuggestionsService();
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('This suggestion already exists.');
+        $service->addSuggestion($this->tempDir, 'create a LANDING page');
+    }
+
     // ─── updateSuggestion ──────────────────────────────────────────
 
     public function testUpdateSuggestionReplacesAtIndex(): void
@@ -277,6 +299,27 @@ public function testUpdateSuggestionThrowsOnOutOfBoundsIndex(): void
         $service->updateSuggestion($this->tempDir, 5, 'Text');
     }
 
+    public function testUpdateSuggestionThrowsOnDuplicate(): void
+    {
+        $this->createSuggestionsFile("First\nSecond\nThird\n");
+
+        $service = new PromptSuggestionsService();
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('This suggestion already exists.');
+        $service->updateSuggestion($this->tempDir, 0, 'Second');
+    }
+
+    public function testUpdateSuggestionAllowsSameTextAtSameIndex(): void
+    {
+        $this->createSuggestionsFile("First\nSecond\n");
+
+        $service = new PromptSuggestionsService();
+        $result  = $service->updateSuggestion($this->tempDir, 0, 'FIRST');
+
+        self::assertSame(['FIRST', 'Second'], $result);
+    }
+
     // ─── deleteSuggestion ──────────────────────────────────────────
 
     public function testDeleteSuggestionRemovesAtIndex(): void