Remove redundant "bundle" parameter from ConvertActionConverter

Author: d-ronnqvist

Sources/SwiftDocC/Infrastructure/ConvertActionConverter.swift

@@ -21,18 +21,16 @@ package enum ConvertActionConverter {
     static package let signposter = NoOpSignposterShim()
 #endif
 
-    /// Converts the documentation bundle in the given context and passes its output to a given consumer.
+    /// Converts the documentation in the given context and passes its output to a given consumer.
     ///
     /// - Parameters:
-    ///   - bundle: The documentation bundle to convert.
     ///   - context: The context that the bundle is a part of.
     ///   - outputConsumer: The consumer that the conversion passes outputs of the conversion to.
     ///   - sourceRepository: The source repository where the documentation's sources are hosted.
     ///   - emitDigest: Whether the conversion should pass additional metadata output––such as linkable entities information, indexing information, or asset references by asset type––to the consumer.
     ///   - documentationCoverageOptions: The level of experimental documentation coverage information that the conversion should pass to the consumer.
     /// - Returns: A list of problems that occurred during the conversion (excluding the problems that the context already encountered).
     package static func convert(
-        bundle: DocumentationBundle,
         context: DocumentationContext,
         outputConsumer: some ConvertOutputConsumer & ExternalNodeConsumer,
         sourceRepository: SourceRepository?,
@@ -66,7 +64,7 @@ package enum ConvertActionConverter {
         try outputConsumer.consume(renderReferenceStore: renderContext.store)
 
         // Copy images, sample files, and other static assets.
-        try outputConsumer.consume(assetsInBundle: bundle)
+        try outputConsumer.consume(assetsInBundle: context.inputs)
 
         let converter = DocumentationContextConverter(
             context: context,
@@ -108,7 +106,7 @@ package enum ConvertActionConverter {
             // Here we're associating the external node with the **current** bundle's bundle ID.
             // This is needed because nodes are only considered children if the parent and child's bundle ID match.
             // Otherwise, the node will be considered as a separate root node and displayed separately.
-            let externalRenderNode = ExternalRenderNode(externalEntity: externalLink.value, bundleIdentifier: bundle.id)
+            let externalRenderNode = ExternalRenderNode(externalEntity: externalLink.value, bundleIdentifier: context.inputs.id)
             try outputConsumer.consume(externalRenderNode: externalRenderNode)
         }
 
@@ -191,7 +189,7 @@ package enum ConvertActionConverter {
         if FeatureFlags.current.isExperimentalLinkHierarchySerializationEnabled {
             signposter.withIntervalSignpost("Serialize link hierarchy", id: signposter.makeSignpostID()) {
                 do {
-                    let serializableLinkInformation = try context.linkResolver.localResolver.prepareForSerialization(bundleID: bundle.id)
+                    let serializableLinkInformation = try context.linkResolver.localResolver.prepareForSerialization(bundleID: context.inputs.id)
                     try outputConsumer.consume(linkResolutionInformation: serializableLinkInformation)
 
                     if !emitDigest {
@@ -224,7 +222,7 @@ package enum ConvertActionConverter {
             break
         }
 
-        try outputConsumer.consume(buildMetadata: BuildMetadata(bundleDisplayName: bundle.displayName, bundleID: bundle.id))
+        try outputConsumer.consume(buildMetadata: BuildMetadata(bundleDisplayName: context.inputs.displayName, bundleID: context.inputs.id))
 
         // Log the finalized topic graph checksum.
         benchmark(add: Benchmark.TopicGraphHash(context: context))

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

@@ -178,12 +178,12 @@ public struct ConvertAction: AsyncAction {
 
         self.configuration = configuration
 
-        self.bundle = bundle
+        self.inputs = bundle
         self.dataProvider = dataProvider
     }
 
     let configuration: DocumentationContext.Configuration
-    private let bundle: DocumentationBundle
+    private let inputs: DocumentationBundle
     private let dataProvider: any DataProvider
 
     /// A block of extra work that tests perform to affect the time it takes to convert documentation
@@ -286,10 +286,10 @@ public struct ConvertAction: AsyncAction {
             workingDirectory: temporaryFolder,
             fileManager: fileManager)
 
-        let indexer = try Indexer(outputURL: temporaryFolder, bundleID: bundle.id)
+        let indexer = try Indexer(outputURL: temporaryFolder, bundleID: inputs.id)
 
         let registerInterval = signposter.beginInterval("Register", id: signposter.makeSignpostID())
-        let context = try await DocumentationContext(bundle: bundle, dataProvider: dataProvider, diagnosticEngine: diagnosticEngine, configuration: configuration)
+        let context = try await DocumentationContext(bundle: inputs, dataProvider: dataProvider, diagnosticEngine: diagnosticEngine, configuration: configuration)
         signposter.endInterval("Register", registerInterval)
 
         let outputConsumer = ConvertFileWritingConsumer(
@@ -300,7 +300,7 @@ public struct ConvertAction: AsyncAction {
             indexer: indexer,
             enableCustomTemplates: experimentalEnableCustomTemplates,
             transformForStaticHostingIndexHTML: transformForStaticHosting ? indexHTML : nil,
-            bundleID: bundle.id
+            bundleID: inputs.id
         )
 
         if experimentalModifyCatalogWithGeneratedCuration, let catalogURL = rootURL {
@@ -318,7 +318,6 @@ public struct ConvertAction: AsyncAction {
         do {
             conversionProblems = try signposter.withIntervalSignpost("Process") {
                 try ConvertActionConverter.convert(
-                    bundle: bundle,
                     context: context,
                     outputConsumer: outputConsumer,
                     sourceRepository: sourceRepository,
@@ -347,7 +346,7 @@ public struct ConvertAction: AsyncAction {
             let tableOfContentsFilename = CatalogTemplateKind.tutorialTopLevelFilename
             let source = rootURL?.appendingPathComponent(tableOfContentsFilename)
             var replacements = [Replacement]()
-            if let tableOfContentsTemplate = CatalogTemplateKind.tutorialTemplateFiles(bundle.displayName)[tableOfContentsFilename] {
+            if let tableOfContentsTemplate = CatalogTemplateKind.tutorialTemplateFiles(inputs.displayName)[tableOfContentsFilename] {
                 replacements.append(
                     Replacement(
                         range: .init(line: 1, column: 1, source: source) ..< .init(line: 1, column: 1, source: source),
@@ -438,7 +437,7 @@ public struct ConvertAction: AsyncAction {
                 context: context,
                 indexer: nil,
                 transformForStaticHostingIndexHTML: nil,
-                bundleID: bundle.id
+                bundleID: inputs.id
             )
 
             try outputConsumer.consume(benchmarks: Benchmark.main)

Tests/SwiftDocCTests/DeprecatedDiagnosticsDigestWarningTests.swift

@@ -23,12 +23,10 @@ class DeprecatedDiagnosticsDigestWarningTests: XCTestCase {
             An empty root page
             """)
         ])
-        let (bundle, context) = try await loadBundle(catalog: catalog)
-        
+        let (_, context) = try await loadBundle(catalog: catalog)
         let outputConsumer = TestOutputConsumer()
 
         _ = try ConvertActionConverter.convert(
-            bundle: bundle,
             context: context,
             outputConsumer: outputConsumer,
             sourceRepository: nil,
@@ -49,12 +47,10 @@ class DeprecatedDiagnosticsDigestWarningTests: XCTestCase {
             This link will result in a warning: ``NotFound``.
             """)
         ])
-        let (bundle, context) = try await loadBundle(catalog: catalog)
-        
+        let (_, context) = try await loadBundle(catalog: catalog)
         let outputConsumer = TestOutputConsumer()
 
         _ = try ConvertActionConverter.convert(
-            bundle: bundle,
             context: context,
             outputConsumer: outputConsumer,
             sourceRepository: nil,

Tests/SwiftDocCTests/TestRenderNodeOutputConsumer.swift

@@ -89,15 +89,13 @@ extension XCTestCase {
         sourceRepository: SourceRepository? = nil,
         configureBundle: ((URL) throws -> Void)? = nil
     ) async throws -> TestRenderNodeOutputConsumer {
-        let (_, bundle, context) = try await testBundleAndContext(
+        let (_, _, context) = try await testBundleAndContext(
             copying: bundleName,
             configureBundle: configureBundle
         )
-        
         let outputConsumer = TestRenderNodeOutputConsumer()
 
         _ = try ConvertActionConverter.convert(
-            bundle: bundle,
             context: context,
             outputConsumer: outputConsumer,
             sourceRepository: sourceRepository,

Tests/SwiftDocCUtilitiesTests/MergeActionTests.swift

@@ -876,13 +876,13 @@ class MergeActionTests: XCTestCase {
             try fileSystem.createDirectory(at: catalogDir, withIntermediateDirectories: true)
             try fileSystem.addFolder(catalog, basePath: catalogDir.deletingLastPathComponent())
 
-            let (bundle, dataProvider) = try DocumentationContext.InputsProvider(fileManager: fileSystem)
+            let (inputs, dataProvider) = try DocumentationContext.InputsProvider(fileManager: fileSystem)
                 .inputsAndDataProvider(startingPoint: catalogDir, options: .init())
-            XCTAssertEqual(bundle.miscResourceURLs.map(\.lastPathComponent), [
+            XCTAssertEqual(inputs.miscResourceURLs.map(\.lastPathComponent), [
                 "\(name.lowercased())-card.png",
             ])
 
-            let context = try await DocumentationContext(bundle: bundle, dataProvider: dataProvider, configuration: .init())
+            let context = try await DocumentationContext(bundle: inputs, dataProvider: dataProvider, configuration: .init())
 
             XCTAssert(
                 context.problems.filter { $0.diagnostic.identifier != "org.swift.docc.SummaryContainsLink" }.isEmpty,
@@ -893,11 +893,11 @@ class MergeActionTests: XCTestCase {
             let outputPath = baseOutputDir.appendingPathComponent("\(name).doccarchive", isDirectory: true)
 
             let realTempURL = try createTemporaryDirectory() // The navigator builder only support real file systems
-            let indexer = try ConvertAction.Indexer(outputURL: realTempURL, bundleID: bundle.id)
+            let indexer = try ConvertAction.Indexer(outputURL: realTempURL, bundleID: inputs.id)
 
-            let outputConsumer = ConvertFileWritingConsumer(targetFolder: outputPath, bundleRootFolder: catalogDir, fileManager: fileSystem, context: context, indexer: indexer, transformForStaticHostingIndexHTML: nil, bundleID: bundle.id)
+            let outputConsumer = ConvertFileWritingConsumer(targetFolder: outputPath, bundleRootFolder: catalogDir, fileManager: fileSystem, context: context, indexer: indexer, transformForStaticHostingIndexHTML: nil, bundleID: inputs.id)
 
-            let convertProblems = try ConvertActionConverter.convert(bundle: bundle, context: context, outputConsumer: outputConsumer, sourceRepository: nil, emitDigest: false, documentationCoverageOptions: .noCoverage)
+            let convertProblems = try ConvertActionConverter.convert(context: context, outputConsumer: outputConsumer, sourceRepository: nil, emitDigest: false, documentationCoverageOptions: .noCoverage)
             XCTAssert(convertProblems.isEmpty, "Unexpected problems: \(context.problems.map(\.diagnostic.summary).joined(separator: "\n"))", file: file, line: line)
 
             let navigatorProblems = indexer.finalize(emitJSON: true, emitLMDB: false)