Canonicalize docref urls before looking them up

greg0ire · greg0ire · commit b518c8698953 · 2023-07-11T09:03:11.000+02:00
The method ProjectNode::findDocumentEntry() expects canonicalized urls, and we fed it URLs that might be relative, leading to links not being resolved. Fixes #486
diff --git a/packages/guides/src/ReferenceResolvers/DocReferenceResolver.php b/packages/guides/src/ReferenceResolvers/DocReferenceResolver.php
@@ -18,7 +18,9 @@ public function resolve(LinkInlineNode $node, RenderContext $renderContext): boo
             return false;
         }
 
-        $document = $renderContext->getProjectNode()->findDocumentEntry($node->getTargetReference());
+        $document = $renderContext->getProjectNode()->findDocumentEntry(
+            $renderContext->canonicalUrl($node->getTargetReference()),
+        );
         if ($document === null) {
             return false;
         }
diff --git a/tests/Integration/tests/docref/expected/index.html b/tests/Integration/tests/docref/expected/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Root</title>
+
+</head>
+<body>
+    <div class="section" id="root">
+    <h1>Root</h1>
+
+    </div>
+
+</body>
+</html>
diff --git a/tests/Integration/tests/docref/expected/subfolder/index.html b/tests/Integration/tests/docref/expected/subfolder/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Subfolder index</title>
+
+</head>
+<body>
+    <div class="section" id="subfolder-index">
+    <h1>Subfolder index</h1>
+
+            <p><a href="/index.html">Root</a></p>
+    </div>
+
+</body>
+</html>
diff --git a/tests/Integration/tests/docref/input/index.rst b/tests/Integration/tests/docref/input/index.rst
@@ -0,0 +1,3 @@
+====
+Root
+====
diff --git a/tests/Integration/tests/docref/input/subfolder/index.rst b/tests/Integration/tests/docref/input/subfolder/index.rst
@@ -0,0 +1,5 @@
+===============
+Subfolder index
+===============
+
+:doc:`../index`
diff --git a/tests/Integration/tests/references/expected/subfolder/index.html b/tests/Integration/tests/references/expected/subfolder/index.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title></title>
+
+</head>
+<body>
+    <p><a href="/page.html">Page 1</a></p>
+</body>
+</html>
diff --git a/tests/Integration/tests/references/input/subfolder/index.rst b/tests/Integration/tests/references/input/subfolder/index.rst
@@ -0,0 +1,6 @@
+===============
+Subfolder index
+===============
+
+
+:doc:`../page`

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,9 @@ public function resolve(LinkInlineNode $node, RenderContext $renderContext): boo`
`18`	`18`	`return false;`
`19`	`19`	`}`
`20`	`20`
`21`		`- $document = $renderContext->getProjectNode()->findDocumentEntry($node->getTargetReference());`
	`21`	`+ $document = $renderContext->getProjectNode()->findDocumentEntry(`
	`22`	`+ $renderContext->canonicalUrl($node->getTargetReference()),`
	`23`	`+ );`
`22`	`24`	`if ($document === null) {`
`23`	`25`	`return false;`
`24`	`26`	`}`