Pass documentation context its only bundle during initialization (#1057)

* Add ability to initialize a context with a given bundle

* Update test to verify bundle discovery options in convert command rather than convert action

* Remove unused parameters on DataAssetManager

* Minor refinements to bundle loading test helpers

* Stop using DocumentationConverter in ConvertService

* Update InputsProvider to also return the DataProvider

* Update InputsProvider to raise an error when it can't create inputs

* Remove `throws` for `renderNode(for:)` that doesn't raise any errors

* Stop using DocumentationConverter in ConvertAction

* Update tests that relied on ConvertAction doing validation when run instead of when initialized

* Support initializing TestFileSystem with CopyOfFolder

* Update emit curation action to pass initialize context with bundle

* Use top-level protocol to remain compatible with Swift 5.9

* Make `ConvertActionConverter.convert(...)` synchronous for now

* Remove outdated comment about optional indexer

* Add comment about code that can be simplified after 6.2 is released.

* Add assertion about correct identifier use to new provider code paths

Author: d-ronnqvist

Sources/SwiftDocC/Converter/DocumentationContextConverter.swift

@@ -84,7 +84,7 @@ public class DocumentationContextConverter {
     /// - Parameters:
     ///   - node: The documentation node to convert.
     /// - Returns: The render node representation of the documentation node.
-    public func renderNode(for node: DocumentationNode) throws -> RenderNode? {
+    public func renderNode(for node: DocumentationNode) -> RenderNode? {
         guard !node.isVirtual else {
             return nil
         }
@@ -104,6 +104,6 @@ public class DocumentationContextConverter {
 
     @available(*, deprecated, renamed: "renderNode(for:)", message: "Use 'renderNode(for:)' instead. This deprecated API will be removed after 6.1 is released")
     public func renderNode(for node: DocumentationNode, at source: URL?) throws -> RenderNode? {
-        return try self.renderNode(for: node)
+        self.renderNode(for: node)
     }
 }

Sources/SwiftDocC/DocumentationService/Convert/ConvertService+DataProvider.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -11,91 +11,46 @@
 import Foundation
 
 extension ConvertService {
-    /// Data provider for a conversion service.
-    ///
-    /// This data provider accepts in-memory documentation and assigns unique URLs for each document.
-    struct InMemoryContentDataProvider: DocumentationWorkspaceDataProvider {
-        var identifier: String = UUID().uuidString
-        var bundles: [DocumentationBundle] = []
-        
+    /// Creates a bundle and an associated in-memory data provider from the information of a given convert request
+    static func makeBundleAndInMemoryDataProvider(_ request: ConvertRequest) -> (bundle: DocumentationBundle, provider: InMemoryDataProvider) {
         var files: [URL: Data] = [:]
-
-        mutating func registerBundle(
-            info: DocumentationBundle.Info,
-            symbolGraphs: [Data],
-            markupFiles: [Data],
-            tutorialFiles: [Data],
-            miscResourceURLs: [URL]
-        ) {
-            let symbolGraphURLs = symbolGraphs.map { registerFile(contents: $0, pathExtension: nil) }
-            let markupFileURLs = markupFiles.map { markupFile in
-                registerFile(
-                    contents: markupFile,
-                    pathExtension:
-                        DocumentationBundleFileTypes.referenceFileExtension
-                )
-            } + tutorialFiles.map { tutorialFile in
-                registerFile(
-                    contents: tutorialFile,
-                    pathExtension:
-                        DocumentationBundleFileTypes.tutorialFileExtension
-                )
-            }
-            
-            bundles.append(
-                DocumentationBundle(
-                    info: info,
-                    symbolGraphURLs: symbolGraphURLs,
-                    markupURLs: markupFileURLs,
-                    miscResourceURLs: miscResourceURLs
-                )
-            )
+        files.reserveCapacity(
+              request.symbolGraphs.count
+            + request.markupFiles.count
+            + request.tutorialFiles.count
+            + request.miscResourceURLs.count
+        )
+        for markupFile in request.markupFiles {
+            files[makeURL().appendingPathExtension(DocumentationBundleFileTypes.referenceFileExtension)] = markupFile
         }
-        
-        private mutating func registerFile(contents: Data, pathExtension: String?) -> URL {
-            let url = Self.createURL(pathExtension: pathExtension)
-            files[url] = contents
-            return url
-        }
-
-        /// Creates a unique URL for a resource.
-        ///
-        /// The URL this function generates for a resource is not derived from the resource itself, because it doesn't need to be. The
-        /// ``DocumentationWorkspaceDataProvider`` model revolves around retrieving resources by their URL. In our use
-        /// case, our resources are not file URLs so we generate a URL for each resource.
-        static private func createURL(pathExtension: String? = nil) -> URL {
-            var url = URL(string: "docc-service:/\(UUID().uuidString)")!
-            
-            if let pathExtension {
-                url.appendPathExtension(pathExtension)
-            }
-            
-            return url
+        for tutorialFile in request.tutorialFiles {
+            files[makeURL().appendingPathExtension(DocumentationBundleFileTypes.tutorialFileExtension)] = tutorialFile
         }
+        let markupFileURL = Array(files.keys)
 
-        func contentsOfURL(_ url: URL) throws -> Data {
-            guard let contents = files[url] else {
-                throw Error.unknownURL(url: url)
-            }
-            return contents
+        var symbolGraphURLs: [URL] = []
+        symbolGraphURLs.reserveCapacity(request.symbolGraphs.count)
+        for symbolGraph in request.symbolGraphs {
+            let url = makeURL()
+            symbolGraphURLs.append(url)
+            files[url] = symbolGraph
         }
 
-        func bundles(options: BundleDiscoveryOptions) throws -> [DocumentationBundle] {
-            return bundles
-        }
-        
-        enum Error: DescribedError {
-            case unknownURL(url: URL)
-            
-            var errorDescription: String {
-                switch self {
-                case .unknownURL(let url):
-                    return """
-                    Unable to retrieve contents of file at \(url.absoluteString.singleQuoted).
-                    """
-                }
-            }
-        }
+        return (
+            DocumentationBundle(
+                info: request.bundleInfo,
+                symbolGraphURLs: symbolGraphURLs,
+                markupURLs: markupFileURL,
+                miscResourceURLs: request.miscResourceURLs
+            ),
+            InMemoryDataProvider(
+                files: files,
+                fallbackFileManager: FileManager.default
+            )
+        )
     }
 
+    private static func makeURL() -> URL {
+        URL(string: "docc-service:/\(UUID().uuidString)")!
+    }
 }