Remove generics from typescript files before highlighting (#1158)

* Remove generics from typescript files before highlighting

* Update src/Service/CodeHighlight/HighlightedFilePreprocessor.php

Co-authored-by: Copilot <[email protected]>

* Remove generics from typescript files before highlighting

---------

Co-authored-by: Copilot <[email protected]>

Author: frankdekker

src/Service/CodeHighlight/HighlightedFilePreprocessor.php

@@ -0,0 +1,18 @@
+<?php
+declare(strict_types=1);
+
+namespace DR\Review\Service\CodeHighlight;
+
+use DR\Utils\Assert;
+
+class HighlightedFilePreprocessor
+{
+    public function process(string $language, string $content): string
+    {
+        if ($language === "typescript") {
+            // currently 2025-08-21 highlightjs does not support typescript generics completely.
+            $content = Assert::string(preg_replace('#<\w+\[]>#', '', $content));
+        }
+        return $content;
+    }
+}

src/Service/CodeHighlight/HighlightedFileService.php

@@ -23,7 +23,8 @@ class HighlightedFileService implements LoggerAwareInterface
     public function __construct(
         private readonly FilenameToLanguageTranslator $translator,
         private readonly HttpClientInterface $highlightjsClient,
-        private readonly HighlightHtmlLineSplitter $splitter
+        private readonly HighlightHtmlLineSplitter $splitter,
+        private readonly HighlightedFilePreprocessor $preprocessor
     ) {
     }
 
@@ -37,10 +38,13 @@ public function fromDiffFile(DiffFile $diffFile): ?HighlightedFile
             return null;
         }
 
-        $lines = $diffFile->getLines();
+        $content = implode("\n", $diffFile->getLines());
+
+        // preprocess certain contents that breaks the highlightjs formatter
+        $content = $this->preprocessor->process($languageName, $content);
 
         try {
-            $response = $this->highlightjsClient->request('POST', '', ['query' => ['language' => $languageName], 'body' => implode("\n", $lines)]);
+            $response = $this->highlightjsClient->request('POST', '', ['query' => ['language' => $languageName], 'body' => $content]);
         } catch (Throwable $exception) {
             $this->logger?->info('Failed to get code highlighting: ' . $exception->getMessage());
 

tests/Unit/Service/CodeHighlight/HighlightedFilePreprocessorTest.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+namespace DR\Review\Tests\Unit\Service\CodeHighlight;
+
+use DR\Review\Service\CodeHighlight\HighlightedFilePreprocessor;
+use DR\Review\Tests\AbstractTestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+
+#[CoversClass(HighlightedFilePreprocessor::class)]
+class HighlightedFilePreprocessorTest extends AbstractTestCase
+{
+    private HighlightedFilePreprocessor $preprocessor;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->preprocessor = new HighlightedFilePreprocessor();
+    }
+
+    public function testProcessShouldSkipOtherLanguages(): void
+    {
+        static::assertSame('test <test[]>test', $this->preprocessor->process('foo', 'test <test[]>test'));
+    }
+
+    public function testProcessShouldRemoveTypescriptGenerics(): void
+    {
+        static::assertSame('test test', $this->preprocessor->process('typescript', 'test <test[]>test'));
+    }
+}

tests/Unit/Service/CodeHighlight/HighlightedFileServiceTest.php

@@ -8,6 +8,7 @@
 use DR\Review\Entity\Git\Diff\DiffFile;
 use DR\Review\Entity\Git\Diff\DiffLine;
 use DR\Review\Service\CodeHighlight\FilenameToLanguageTranslator;
+use DR\Review\Service\CodeHighlight\HighlightedFilePreprocessor;
 use DR\Review\Service\CodeHighlight\HighlightedFileService;
 use DR\Review\Service\CodeHighlight\HighlightHtmlLineSplitter;
 use DR\Review\Tests\AbstractTestCase;
@@ -25,15 +26,17 @@ class HighlightedFileServiceTest extends AbstractTestCase
     private FilenameToLanguageTranslator&MockObject $translator;
     private HttpClientInterface&MockObject          $httpClient;
     private HighlightHtmlLineSplitter&MockObject    $splitter;
+    private HighlightedFilePreprocessor&MockObject  $preprocessor;
     private HighlightedFileService                  $service;
 
     public function setUp(): void
     {
         parent::setUp();
-        $this->translator = $this->createMock(FilenameToLanguageTranslator::class);
-        $this->httpClient = $this->createMock(HttpClientInterface::class);
-        $this->splitter   = $this->createMock(HighlightHtmlLineSplitter::class);
-        $this->service    = new HighlightedFileService($this->translator, $this->httpClient, $this->splitter);
+        $this->translator   = $this->createMock(FilenameToLanguageTranslator::class);
+        $this->httpClient   = $this->createMock(HttpClientInterface::class);
+        $this->splitter     = $this->createMock(HighlightHtmlLineSplitter::class);
+        $this->preprocessor = $this->createMock(HighlightedFilePreprocessor::class);
+        $this->service      = new HighlightedFileService($this->translator, $this->httpClient, $this->splitter, $this->preprocessor);
     }
 
     /**
@@ -73,6 +76,7 @@ public function testGetHighlightedFile(): void
             ->with('POST', '', ['query' => ['language' => 'xml'], 'body' => 'file-data'])
             ->willReturn($response);
         $this->splitter->expects($this->once())->method('split')->with('highlighted-data')->willReturn(['highlighted', 'data']);
+        $this->preprocessor->expects($this->once())->method('process')->with('xml', 'file-data')->willReturnArgument(1);
 
         $actual = $this->service->fromDiffFile($file);
         static::assertNotNull($actual);
@@ -92,6 +96,7 @@ public function testGetHighlightedFileRequestFailure(): void
         $file->addBlock($block);
 
         $this->translator->expects($this->once())->method('translate')->with('/path/to/file.xml')->willReturn('xml');
+        $this->preprocessor->expects($this->once())->method('process')->with('xml', 'file-data')->willReturnArgument(1);
         $this->httpClient->expects($this->once())->method('request')->willThrowException(new RuntimeException('error'));
 
         static::assertNull($this->service->fromDiffFile($file));