[TASK] Include sorting in test fixtures, add verbose header error

Also refactor index key matching to use simplified version.
TYPO3GmbH · Jan 23, 2025 · cac4798 · cac4798
1 parent 823c16f
commit cac4798
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 10 deletions.
diff --git a/legacy_hook/src/DocumentationLinker.php b/legacy_hook/src/DocumentationLinker.php
@@ -232,17 +232,16 @@ private function parseInventoryForIndex(string $index, array $json): string
             return 0;
         });
 
-        foreach ($json as $mainKey => $subKeys) {
+        foreach ($json as $subKeys) {
             foreach ($subKeys as $indexName => $indexMetaData) {
+                // Note: In the future, we may want to do a check for
+                // in_array($mainKey, $docNodes, true)
+                // ($mainKey would be the key of the foreach($json) loop)
+                // to differentiate between a match contained in the $docNodes
+                // array above, or a fallback match. For now, this all just leads
+                // to the resolved links like 'ApiOverview/Events/Events/Core/Security/InvestigateMutationsEvent.html#typo3-cms-core-security-contentsecuritypolicy-event-investigatemutationsevent-policy'
                 if ($indexName === $index) {
-                    if (in_array($mainKey, $docNodes, true)) {
-                        // Resolves to an entry like 'ApiOverview/Events/Events/Core/Security/InvestigateMutationsEvent.html#typo3-cms-core-security-contentsecuritypolicy-event-investigatemutationsevent-policy'
-                        return $indexMetaData[2];
-                    } else {
-                        // Currently, no replacement is needed, but let's have a distinct case for this
-                        // for forward compatibility.
-                        return $indexMetaData[2];
-                    }
+                    return $indexMetaData[2];
                 }
             }
         }

diff --git a/legacy_hook/tests/Unit/Fixtures/Permalinks/p/dummyvendor/dummy/main/en-us/objects.inv.json b/legacy_hook/tests/Unit/Fixtures/Permalinks/p/dummyvendor/dummy/main/en-us/objects.inv.json
@@ -0,0 +1,74 @@
+{
+    "std:doc": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#std-doc",
+            "Dummy"
+        ]
+    },
+    "std:title": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#std-title",
+            "Dummy"
+        ]
+    },
+    "std:confval": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#std-confval",
+            "Dummy"
+        ]
+    },
+    "std:option": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#std-option",
+            "Dummy"
+        ]
+    },
+    "std:console:command-list": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#std-console-command-list",
+            "Dummy"
+        ]
+    },
+    "std:console:command": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#std-console-command",
+            "Dummy"
+        ]
+    },
+    "php:property": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#php-property",
+            "Dummy"
+        ]
+    },
+    "000anything:random": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#anything-random",
+            "Dummy"
+        ]
+    },
+    "std:label": {
+        "dupe-entry": [
+            "Dummy",
+            "main",
+            "Index.html#dupe-entry",
+            "The real dupe target to prove sorting kind of works"
+        ]
+    }
+}
diff --git a/legacy_hook/tests/Unit/PermalinksTest.php b/legacy_hook/tests/Unit/PermalinksTest.php
@@ -85,6 +85,10 @@ public static function redirectFailsDataProvider(): array
     public static function redirectWorksDataProvider(): array
     {
         return [
+            'dupe sorting' => [
+                'permalink' => 'dummyvendor-dummy:dupe-entry',
+                'location' => 'https://docs.typo3.org/p/dummyvendor/dummy/main/en-us/Index.html#dupe-entry',
+            ],
             'core manual, no version' => [
                 'permalink' => 'changelog:important-100889-1690476872',
                 'location' => 'https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.5.x/Important-100889-AllowInsecureSiteResolutionByQueryParameters.html#important-100889-1690476872',
@@ -285,7 +289,7 @@ public function redirectWorksForPermalink(string $permalink, string $location):
         self::assertInstanceOf(DocumentationLinker::class, $this->subject);
         $describer = $this->subject->resolvePermalink($permalink);
 
-        self::assertSame(307, $describer->statusCode);
+        self::assertSame(307, $describer->statusCode, 'Header mismatch: ' . $describer->body);
         self::assertSame(['Location' => $location], $describer->headers);
         self::assertStringContainsString('Redirect to', $describer->body);
     }