Merge pull request #201 from ram0ng1/refatoracao-tokens-design-system

refactor: melhorar a extração de texto puro de postagens e adicionar testes unitários

Author: ram0ng1

src/Api/DiscussionFields.php

@@ -4,6 +4,8 @@
 
 namespace Ramon\Avocado\Api;
 
+use DOMDocument;
+use DOMXPath;
 use Flarum\Api\Context;
 use Flarum\Api\Resource\EloquentBuffer;
 use Flarum\Api\Schema;
@@ -12,7 +14,6 @@
 use Illuminate\Contracts\Filesystem\Factory as FilesystemFactory;
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Ramon\Avocado\Model\DiscussionHero;
-use s9e\TextFormatter\Utils;
 
 class DiscussionFields
 {
@@ -129,18 +130,64 @@ private function firstPost(Discussion $discussion, Context $context): ?CommentPo
     /**
      * Texto puro do primeiro post, na mesma forma que o front produzia com
      * `getPlainContent(contentHtml)`: sem citações e sem as URLs cruas das
-     * imagens (que o `removeFormatting` devolveria como texto).
+     * imagens (que viriam como texto no lugar da imagem).
      */
     private function excerpt(?CommentPost $post): ?string
     {
         if ($post === null || empty($post->parsed_content)) {
             return null;
         }
 
-        $xml = preg_replace('#<(QUOTE|IMG|UPL-IMAGE-PREVIEW)\b.*?</\1>#is', '', $post->parsed_content) ?? $post->parsed_content;
-        $xml = preg_replace('#<(IMG|UPL-IMAGE-PREVIEW)\b[^>]*/?>#i', '', $xml) ?? $xml;
+        return $this->plainExcerpt($post->parsed_content);
+    }
+
+    /**
+     * Reduz a representação intermediária do s9e a texto corrido.
+     *
+     * O corte é feito no DOM, não por regex: um `<QUOTE>` aninhado fazia o
+     * `.*?</QUOTE>` casar até o fechamento *interno*, deixando o externo órfão.
+     * O XML resultante não carregava, `Utils::removeFormatting()` devolvia null
+     * e o `preg_replace` seguinte derrubava o request inteiro com TypeError —
+     * uma discussão com citação de citação quebrava a lista toda.
+     *
+     * Uma única passada de parse cobre o que era feito em quatro (dois
+     * `preg_replace` mais o load do `removeFormatting`).
+     */
+    private function plainExcerpt(string $xml): ?string
+    {
+        if (trim($xml) === '') {
+            return null;
+        }
+
+        $dom = new DOMDocument();
+
+        // XML de post é gerado pelo s9e e deveria sempre carregar; se um
+        // registro antigo ou corrompido não carregar, o card fica sem descrição
+        // em vez de estourar 500 — e o warning do libxml não vaza no output.
+        $internal = libxml_use_internal_errors(true);
+        $loaded = $dom->loadXML($xml, LIBXML_COMPACT | LIBXML_PARSEHUGE);
+        libxml_clear_errors();
+        libxml_use_internal_errors($internal);
+
+        if (! $loaded || $dom->documentElement === null) {
+            return null;
+        }
+
+        $xpath = new DOMXPath($dom);
+
+        // Citações e imagens saem inteiras, trocadas por um espaço: retirar o
+        // nó sem separador colaria o texto vizinho ("antes<IMG/>depois").
+        foreach ($xpath->query('//QUOTE | //IMG | //UPL-IMAGE-PREVIEW') as $node) {
+            $node->parentNode?->replaceChild($dom->createTextNode(' '), $node);
+        }
+
+        // `e`/`s` são a marcação em si (os `**` do negrito, o `>` da citação):
+        // saem sem espaço, senão partiriam a palavra que estavam decorando.
+        foreach ($xpath->query('//e | //s') as $node) {
+            $node->parentNode?->removeChild($node);
+        }
 
-        $plain = trim(preg_replace('/\s+/', ' ', Utils::removeFormatting($xml)) ?? '');
+        $plain = trim(preg_replace('/\s+/', ' ', $dom->documentElement->textContent) ?? '');
 
         return $plain === '' ? null : mb_substr($plain, 0, self::EXCERPT_LENGTH);
     }

tests/Unit/DiscussionExcerptTest.php

@@ -0,0 +1,122 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ramon\Avocado\Tests\Unit;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Ramon\Avocado\Api\DiscussionFields;
+use ReflectionClass;
+
+/**
+ * `avocadoExcerpt` roda para cada linha de um payload de Index: um post cujo XML
+ * o redutor não soubesse tratar derrubava a listagem inteira com 500, não só o
+ * card daquela discussão. Estes testes fixam o contrato — texto corrido, sem
+ * citação, sem imagem, e null (nunca exceção) para entrada estranha.
+ *
+ * `plainExcerpt()` é privado e puro (string → ?string), então é chamado por
+ * reflexão: não precisa de container, disco nem modelo carregado.
+ */
+final class DiscussionExcerptTest extends TestCase
+{
+    private static function excerpt(string $xml): ?string
+    {
+        $fields = (new ReflectionClass(DiscussionFields::class))->newInstanceWithoutConstructor();
+
+        $method = new \ReflectionMethod(DiscussionFields::class, 'plainExcerpt');
+
+        /** @var string|null $result */
+        $result = $method->invoke($fields, $xml);
+
+        return $result;
+    }
+
+    public function test_plain_text_post_is_returned_as_is(): void
+    {
+        self::assertSame('Bom dia a todos', self::excerpt('<t>Bom dia a todos</t>'));
+    }
+
+    public function test_markup_tags_are_dropped_but_text_is_kept(): void
+    {
+        // <s>/<e> são os próprios asteriscos do negrito na representação do s9e.
+        $xml = '<r>Isto é <STRONG><s>**</s>importante<e>**</e></STRONG> mesmo</r>';
+
+        self::assertSame('Isto é importante mesmo', self::excerpt($xml));
+    }
+
+    public function test_quote_content_is_not_part_of_the_excerpt(): void
+    {
+        $xml = '<r><QUOTE><i>&gt; </i><p>texto citado</p></QUOTE><p>minha resposta</p></r>';
+
+        self::assertSame('minha resposta', self::excerpt($xml));
+    }
+
+    /**
+     * O caso que gerava o TypeError: o `.*?</QUOTE>` casava até o fechamento da
+     * citação interna e deixava o `</QUOTE>` externo órfão, o XML resultante não
+     * carregava e `removeFormatting()` devolvia null.
+     */
+    public function test_nested_quotes_do_not_break_the_excerpt(): void
+    {
+        $xml = '<r><QUOTE><i>&gt; </i><QUOTE><i>&gt;&gt; </i><p>citação de dentro</p></QUOTE>'
+            . '<p>citação de fora</p></QUOTE><p>resposta final</p></r>';
+
+        self::assertSame('resposta final', self::excerpt($xml));
+    }
+
+    #[DataProvider('imageMarkup')]
+    public function test_image_urls_never_leak_into_the_excerpt(string $image): void
+    {
+        $excerpt = self::excerpt('<r><p>antes</p>' . $image . '<p>depois</p></r>');
+
+        self::assertSame('antes depois', $excerpt);
+        self::assertStringNotContainsString('http', (string) $excerpt);
+    }
+
+    /** @return array<string, array{0: string}> */
+    public static function imageMarkup(): array
+    {
+        return [
+            'IMG vazio' => ['<IMG src="https://exemplo.test/foto.png">https://exemplo.test/foto.png</IMG>'],
+            'IMG auto-fechado' => ['<IMG src="https://exemplo.test/foto.png"/>'],
+            'anexo do fof-upload' => ['<UPL-IMAGE-PREVIEW url="https://exemplo.test/anexo.webp">https://exemplo.test/anexo.webp</UPL-IMAGE-PREVIEW>'],
+        ];
+    }
+
+    public function test_whitespace_is_collapsed_into_single_spaces(): void
+    {
+        self::assertSame('linha um linha dois', self::excerpt("<t>linha um\n\n  linha dois</t>"));
+    }
+
+    public function test_excerpt_is_capped(): void
+    {
+        $excerpt = self::excerpt('<t>' . str_repeat('a', 500) . '</t>');
+
+        self::assertSame(300, mb_strlen((string) $excerpt));
+    }
+
+    public function test_post_with_only_a_quote_has_no_excerpt(): void
+    {
+        $xml = '<r><QUOTE><i>&gt; </i><p>só a citação</p></QUOTE></r>';
+
+        self::assertNull(self::excerpt($xml));
+    }
+
+    #[DataProvider('unusableContent')]
+    public function test_content_that_cannot_be_parsed_yields_null(string $xml): void
+    {
+        self::assertNull(self::excerpt($xml));
+    }
+
+    /** @return array<string, array{0: string}> */
+    public static function unusableContent(): array
+    {
+        return [
+            'vazio' => [''],
+            'só espaços' => ['<t>   </t>'],
+            'tag desbalanceada' => ['<r><QUOTE><p>órfã</r>'],
+            'não é XML' => ['isto não é xml <<< nem perto'],
+        ];
+    }
+}