Update navigator image references to the correct relative path (#925)

rdar://128397787

Author: d-ronnqvist

Sources/SwiftDocC/Indexing/Navigator/NavigatorIndex.swift

@@ -1017,12 +1017,11 @@ extension NavigatorIndex {
             if emitJSONRepresentation {
                 let renderIndex = RenderIndex.fromNavigatorIndex(navigatorIndex, with: self)
 
-                let jsonEncoder = JSONEncoder()
-                if shouldPrettyPrintOutputJSON {
-                    jsonEncoder.outputFormatting = [.sortedKeys, .prettyPrinted]
-                } else {
-                    jsonEncoder.outputFormatting = [.sortedKeys]
-                }
+                let jsonEncoder = RenderJSONEncoder.makeEncoder(
+                    prettyPrint: shouldPrettyPrintOutputJSON,
+                    assetPrefixComponent: bundleIdentifier.split(separator: "/").joined(separator: "-")
+                )
+                jsonEncoder.outputFormatting.insert(.sortedKeys)
 
                 let jsonNavigatorIndexURL = outputURL.appendingPathComponent("index.json")
                 do {

Tests/SwiftDocCTests/Indexing/NavigatorIndexTests.swift

@@ -1162,7 +1162,34 @@ Root
         XCTAssertNil(availabilityDB.get(type: String.self, forKey: "content"))
     }
 
-    func testNavigatorIndexDifferenHasherGeneration() throws {
+    func testCustomIconsInNavigator() throws {
+        let (bundle, context) = try testBundleAndContext(named: "BookLikeContent") // This content has a @PageImage with the "icon" purpose
+        let renderContext = RenderContext(documentationContext: context, bundle: bundle)
+        let converter = DocumentationContextConverter(bundle: bundle, context: context, renderContext: renderContext)
+        
+        let targetURL = try createTemporaryDirectory()
+        let builder = NavigatorIndex.Builder(outputURL: targetURL, bundleIdentifier: bundle.identifier, sortRootChildrenByName: true)
+        builder.setup()
+        
+        for identifier in context.knownPages {
+            let source = context.documentURL(for: identifier)
+            let entity = try context.entity(with: identifier)
+            let renderNode = try XCTUnwrap(converter.renderNode(for: entity, at: source))
+            try builder.index(renderNode: renderNode)
+        }
+        
+        builder.finalize()
+        
+        let renderIndexData = try Data(contentsOf: targetURL.appendingPathComponent("index.json"))
+        let renderIndex = try JSONDecoder().decode(RenderIndex.self, from: renderIndexData)
+        
+        let imageReference = try XCTUnwrap(renderIndex.references["plus.svg"])
+        XCTAssertEqual(imageReference.asset.variants.values.map(\.path).sorted(), [
+            "/images/\(bundle.identifier)/plus.svg",
+        ])
+    }
+    
+    func testNavigatorIndexDifferentHasherGeneration() throws {
         let (bundle, context) = try testBundleAndContext(named: "TestBundle")
         let renderContext = RenderContext(documentationContext: context, bundle: bundle)
         let converter = DocumentationContextConverter(bundle: bundle, context: context, renderContext: renderContext)

Tests/SwiftDocCTests/Indexing/RenderIndexTests.swift

@@ -704,7 +704,7 @@ final class RenderIndexTests: XCTestCase {
                       "identifier" : "plus.svg",
                       "variants" : [
                         {
-                          "url" : "\/images\/plus.svg",
+                          "url" : "\/images\/org.swift.docc.Book\/plus.svg",
                           "traits" : [
                             "1x",
                             "light"