[BUGFIX] Handle "dirty" objects.inv.json data

Handle null values as not set, ignore inventory entries that have non-scalar values or null in the URI.

Until now those were causing type errors

Author: linawolf

packages/guides/src/ReferenceResolvers/Interlink/DefaultInventoryLoader.php

@@ -20,6 +20,9 @@
 
 use function count;
 use function is_array;
+use function is_scalar;
+use function is_string;
+use function sprintf;
 use function strval;
 
 final class DefaultInventoryLoader implements InventoryLoader
@@ -46,11 +49,22 @@ public function loadInventoryFromJson(Inventory $inventory, array $json): void
             if (is_array($groupArray)) {
                 foreach ($groupArray as $linkKey => $linkArray) {
                     if (!is_array($linkArray) || count($linkArray) < 4) {
+                        $this->logger->warning(sprintf('Invalid Inventory entry found. Each entry in array "%s" MUST be an array with at least 4 entries. ', $groupKey));
+                        continue;
+                    }
+
+                    if (!is_string($linkArray[2])) {
+                        $this->logger->warning(sprintf('Invalid Inventory entry found. Each entry in array "%s" must have a path as third entry.', $groupKey));
+                        continue;
+                    }
+
+                    if (!is_scalar($linkArray[0] ?? '') || !is_scalar($linkArray[1] ?? '') || !is_scalar($linkArray[3] ?? '')) {
+                        $this->logger->warning(sprintf('Invalid Inventory entry found. Only scalar values are allowed in each entry of array "%s". ', $groupKey));
                         continue;
                     }
 
                     $reducedLinkKey = $groupAnchorNormalizer->reduceAnchor(strval($linkKey));
-                    $link = new InventoryLink($linkArray[0], $linkArray[1], $linkArray[2], $linkArray[3]);
+                    $link = new InventoryLink(strval($linkArray[0] ?? ''), strval($linkArray[1] ?? ''), $linkArray[2], strval($linkArray[3] ?? '-'));
                     $group->addLink($reducedLinkKey, $link);
                 }
             }

packages/guides/tests/unit/Interlink/InventoryLoaderTest.php

@@ -14,14 +14,14 @@
 namespace phpDocumentor\Guides\Interlink;
 
 use Generator;
+use JsonException;
 use phpDocumentor\Guides\Nodes\Inline\CrossReferenceNode;
 use phpDocumentor\Guides\Nodes\Inline\DocReferenceNode;
 use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
 use phpDocumentor\Guides\ReferenceResolvers\Interlink\DefaultInventoryLoader;
 use phpDocumentor\Guides\ReferenceResolvers\Interlink\DefaultInventoryRepository;
 use phpDocumentor\Guides\ReferenceResolvers\Interlink\Inventory;
 use phpDocumentor\Guides\ReferenceResolvers\Interlink\InventoryLink;
-use phpDocumentor\Guides\ReferenceResolvers\Interlink\InventoryRepository;
 use phpDocumentor\Guides\ReferenceResolvers\Interlink\JsonLoader;
 use phpDocumentor\Guides\ReferenceResolvers\Messages;
 use phpDocumentor\Guides\ReferenceResolvers\SluggerAnchorNormalizer;
@@ -42,7 +42,7 @@ final class InventoryLoaderTest extends TestCase
 {
     private DefaultInventoryLoader $inventoryLoader;
     private JsonLoader&MockObject $jsonLoader;
-    private InventoryRepository $inventoryRepository;
+    private DefaultInventoryRepository $inventoryRepository;
     private RenderContext&MockObject $renderContext;
     /** @var array<string, mixed> */
     private array $json;
@@ -57,7 +57,13 @@ protected function setUp(): void
         );
         $this->renderContext = $this->createMock(RenderContext::class);
         $this->inventoryRepository = new DefaultInventoryRepository(new SluggerAnchorNormalizer(), $this->inventoryLoader, []);
-        $jsonString = file_get_contents(__DIR__ . '/fixtures/objects.inv.json');
+        $this->loadObjectsJsonInv(__DIR__ . '/fixtures/objects.inv.json');
+    }
+
+    /** @throws JsonException */
+    public function loadObjectsJsonInv(string $filename): void
+    {
+        $jsonString = file_get_contents($filename);
         assertIsString($jsonString);
         $this->json = (array) json_decode($jsonString, true, 512, JSON_THROW_ON_ERROR);
         $inventory = new Inventory('https://example.com/', new SluggerAnchorNormalizer());
@@ -83,6 +89,15 @@ public function testInventoryIsLoadedExactlyOnce(): void
         self::assertGreaterThan(1, count($inventory->getGroups()));
     }
 
+    public function testInventoryLoaderAcceptsNull(): void
+    {
+        $this->loadObjectsJsonInv(__DIR__ . '/fixtures/null-in-objects.inv.json');
+        $node = new DocReferenceNode('SomeDocument', '', 'somekey');
+        $inventory = $this->inventoryRepository->getInventory($node, $this->renderContext, new Messages());
+        self::assertTrue($inventory instanceof Inventory);
+        self::assertGreaterThan(1, count($inventory->getGroups()));
+    }
+
     #[DataProvider('rawAnchorProvider')]
     public function testInventoryContainsLink(string $expected, CrossReferenceNode $node): void
     {

packages/guides/tests/unit/Interlink/fixtures/null-in-objects.inv.json

@@ -0,0 +1,54 @@
+{
+   "std:doc": {
+      "Index": [
+         "<project>",
+         "<version>",
+         "index.html",
+         null
+      ],
+      "Page1": [
+         null,
+         "<version>",
+         "Page1.html",
+         "-"
+      ],
+      "Page1/Subpage1": [
+         "<project>",
+         null,
+         "Page1/Subpage1.html",
+         "-"
+      ],
+      "Page2/Subpage2": [
+         "<project>",
+         "<version>",
+         null,
+         "-"
+      ]
+   },
+   "std:label": {
+      "modindex": [
+         null,
+         "<version>",
+         "some_page.html#modindex",
+         "Module Index"
+      ],
+      "php-modindex": [
+         "<project>",
+         null,
+         "some_page.html#php-modindex",
+         "PHP Namespace Index"
+      ],
+      "php_objectsindex": [
+         "<project>",
+         "<version>",
+         null,
+         "PHP Objects Index"
+      ],
+      "php_8-modindex": [
+         "<project>",
+         "<version>",
+         "php-objectsindex.html#php-8-objectsindex",
+         null
+      ]
+   }
+}