Use the asset's per module file path in the render JSON (#832)

rdar://123145729

Author: d-ronnqvist

Sources/SwiftDocCUtilities/Action/Actions/Convert/JSONEncodingRenderNodeWriter.swift

@@ -78,8 +78,6 @@ class JSONEncodingRenderNodeWriter {
             }
         }
 
-        let encoder = RenderJSONEncoder.makeEncoder()
-        
         let data = try renderNode.encodeToJSON(with: encoder, renderReferenceCache: renderReferenceCache)
         try fileManager.createFile(at: renderNodeTargetFileURL, contents: data, options: nil)
 

Tests/SwiftDocCUtilitiesTests/ConvertActionTests.swift

@@ -3196,6 +3196,78 @@ class ConvertActionTests: XCTestCase {
         XCTAssertEqual(logLines.filter { $0.hasPrefix("warning: No symbol matched 'ModuleThatDoesNotExist'. Can't resolve 'ModuleThatDoesNotExist'.") }.count, 1)
     }
 
+    func testEncodedImagePaths() throws {
+        let catalog = Folder(name: "unit-test.docc", content: [
+            TextFile(name: "Something.md", utf8Content: """
+            # Something
+            
+            This article links to some assets
+            
+            ![Some alt text](image-name)
+            """),
+            
+            // Image variants
+            DataFile(name: "image-name.png", data: Data()),
+            DataFile(name: "image-name~dark.png", data: Data()),
+            DataFile(name: "[email protected]", data: Data()),
+            DataFile(name: "[email protected]", data: Data()),
+        ])
+    
+        let fileSystem = try TestFileSystem(folders: [catalog])
+        let targetURL = URL(fileURLWithPath: "/Output.doccarchive")
+        
+        var action = try ConvertAction(
+            documentationBundleURL: catalog.absoluteURL,
+            outOfProcessResolver: nil,
+            analyze: false,
+            targetDirectory: targetURL,
+            htmlTemplateDirectory: Folder.emptyHTMLTemplateDirectory.absoluteURL,
+            emitDigest: false,
+            currentPlatforms: nil,
+            dataProvider: fileSystem,
+            fileManager: fileSystem,
+            temporaryDirectory: fileSystem.temporaryDirectory
+        )
+        
+        let result = try action.perform(logHandle: .none)
+        XCTAssertEqual(result.outputs, [targetURL])
+        
+        XCTAssertEqual(fileSystem.dump(subHierarchyFrom: targetURL.path), """
+        Output.doccarchive/
+        ├─ data/
+        │  ╰─ documentation/
+        │     ╰─ something.json
+        ├─ downloads/
+        │  ╰─ unit-test/
+        ├─ images/
+        │  ╰─ unit-test/
+        │     ├─ image-name.png
+        │     ├─ [email protected]
+        │     ├─ image-name~dark.png
+        │     ╰─ [email protected]
+        ├─ metadata.json
+        ╰─ videos/
+           ╰─ unit-test/
+        """)
+        
+        XCTAssert(fileSystem.fileExists(atPath: targetURL.appendingPathComponent("images/unit-test/image-name.png").path))
+        let pageURL = targetURL.appendingPathComponent("data/documentation/something.json")
+        XCTAssert(fileSystem.fileExists(atPath: pageURL.path))
+        
+        let renderNode = try JSONDecoder().decode(RenderNode.self, from: fileSystem.contentsOfURL(pageURL))
+        
+        XCTAssertEqual(renderNode.references.keys.sorted(), ["image-name"])
+        let imageReference = try XCTUnwrap(renderNode.references["image-name"] as? ImageReference)
+        
+        XCTAssertEqual(imageReference.altText, "Some alt text")
+        XCTAssertEqual(imageReference.asset.variants.values.map(\.absoluteString).sorted(), [
+            "/images/unit-test/image-name.png",
+            "/images/unit-test/[email protected]",
+            "/images/unit-test/image-name~dark.png",
+            "/images/unit-test/[email protected]"
+        ])
+    }
+    
     #endif
 }