Avoid FoundationNetworking and libcurl on non-Darwin platforms

Package.swift

@@ -19,7 +19,7 @@ let swiftSettings: [SwiftSetting] = [
 let package = Package(
     name: "SwiftDocC",
     platforms: [
-        .macOS(.v10_15),
+        .macOS(.v11),
         .iOS(.v13)
     ],
     products: [
@@ -45,6 +45,7 @@ let package = Package(
                 .product(name: "SymbolKit", package: "swift-docc-symbolkit"),
                 .product(name: "CLMDB", package: "swift-lmdb"),
                 .product(name: "Crypto", package: "swift-crypto"),
+                .product(name: "HTTPTypes", package: "swift-http-types"),
             ],
             swiftSettings: swiftSettings
         ),
@@ -139,6 +140,7 @@ if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
         .package(url: "https://github.com/apple/swift-docc-symbolkit", branch: "main"),
         .package(url: "https://github.com/apple/swift-crypto.git", from: "2.5.0"),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.2.0"),
+        .package(url: "https://github.com/apple/swift-http-types.git", .upToNextMinor(from: "0.2.1")),
     ]
 } else {
     // Building in the Swift.org CI system, so rely on local versions of dependencies.
@@ -149,5 +151,6 @@ if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
         .package(path: "../swift-argument-parser"),
         .package(path: "../swift-docc-symbolkit"),
         .package(path: "../swift-crypto"),
+        .package(path: "../swift-http-types"),
     ]
 }

Sources/SwiftDocC/Indexing/Navigator/NavigatorIndex+Ext.swift

@@ -47,8 +47,10 @@ public class FileSystemRenderNodeProvider: RenderNodeProvider {
                 // we need to process JSON files only
                 if file.url.pathExtension.lowercased() == "json" {
                     do {
-                        let data = try Data(contentsOf: file.url)
-                        renderNode = try RenderNode.decode(fromJSON: data)
+                        let fileHandle = try FileHandle(forReadingFrom: file.url)
+                        if let data = try fileHandle.readToEnd() {
+                            renderNode = try RenderNode.decode(fromJSON: data)
+                        }
                     } catch {
                         let diagnostic = Diagnostic(source: file.url,
                                                          severity: .warning,

Sources/SwiftDocC/Indexing/Navigator/NavigatorIndex.swift

@@ -61,8 +61,10 @@ public class NavigatorIndex {
 
     /// A specific error to describe issues when processing a `NavigatorIndex`.
     public enum Error: Swift.Error, DescribedError {
-
         /// Missing bundle identifier.
+        case missingBundleIdentifier
+
+        @available(*, deprecated, renamed: "missingBundleIdentifier")
         case missingBundleIndentifier
 
         /// A RenderNode has no title and won't be indexed.
@@ -72,8 +74,8 @@ public class NavigatorIndex {
         case navigatorIndexIsNil
 
         public var errorDescription: String {
-            switch self  {
-            case .missingBundleIndentifier:
+            switch self {
+            case .missingBundleIdentifier, .missingBundleIndentifier:
                 return "A navigator index requires a bundle identifier, which is missing."
             case .missingTitle:
                 return "The page has no valid title available."
@@ -169,13 +171,17 @@ public class NavigatorIndex {
 
         let information = try environment.openDatabase(named: "information", flags: [])
 
-        let data = try Data(contentsOf: url.appendingPathComponent("availability.index", isDirectory: false))
+        let availabilityIndexFileURL = url.appendingPathComponent("availability.index", isDirectory: false)
+        let availabilityIndexFileHandle = try FileHandle(forReadingFrom: availabilityIndexFileURL)
+        guard let data = try availabilityIndexFileHandle.readToEnd() else {
+            throw CocoaError(.fileReadUnknown, userInfo: ["path": availabilityIndexFileURL.path])
+        }
         let plistDecoder = PropertyListDecoder()
         let availabilityIndex = try plistDecoder.decode(AvailabilityIndex.self, from: data)
         let bundleIdentifier = bundleIdentifier ?? information.get(type: String.self, forKey: NavigatorIndex.bundleKey) ?? NavigatorIndex.UnknownBundleIdentifier
 
         guard bundleIdentifier != NavigatorIndex.UnknownBundleIdentifier else {
-            throw Error.missingBundleIndentifier
+            throw Error.missingBundleIdentifier
         }
 
         // Use `.fnv1` by default if no path hasher is set for compatibility reasons.
@@ -282,7 +288,7 @@ public class NavigatorIndex {
         self.availabilityIndex = AvailabilityIndex()
 
         guard self.bundleIdentifier != NavigatorIndex.UnknownBundleIdentifier else {
-            throw Error.missingBundleIndentifier
+            throw Error.missingBundleIdentifier
         }
     }
 

Sources/SwiftDocC/Indexing/Navigator/NavigatorTree.swift

@@ -129,8 +129,20 @@ public class NavigatorTree {
         - presentationIdentifier: Defines if nodes should have a presentation identifier useful in presentation contexts.
         - broadcast: The callback to update get updates of the current process.
      */
-    public func read(from url: URL, bundleIdentifier: String? = nil, interfaceLanguages: Set<InterfaceLanguage>, timeout: TimeInterval, delay: TimeInterval = 0.01, queue: DispatchQueue, presentationIdentifier: String? = nil, broadcast: BroadcastCallback?) throws {
-        let data = try Data(contentsOf: url)
+    public func read(
+        from url: URL,
+        bundleIdentifier: String? = nil,
+        interfaceLanguages: Set<InterfaceLanguage>,
+        timeout: TimeInterval,
+        delay: TimeInterval = 0.01,
+        queue: DispatchQueue,
+        presentationIdentifier: String? = nil,
+        broadcast: BroadcastCallback?
+    ) throws {
+        let fileHandle = try FileHandle(forReadingFrom: url)
+        guard let data = try fileHandle.readToEnd() else {
+            throw Error.cannotOpenFile(path: url.path)
+        }
         let readingCursor = ReadingCursor(data: data)
         self.readingCursor = readingCursor
 
@@ -312,9 +324,14 @@ public class NavigatorTree {
         presentationIdentifier: String? = nil,
         onNodeRead: ((NavigatorTree.Node) -> Void)? = nil
     ) throws -> NavigatorTree {
-        let fileUrl = URL(fileURLWithPath: path)
-        let data = try Data(contentsOf: fileUrl)
-
+        guard let fileHandle = FileHandle(forReadingAtPath: path) else {
+            throw Error.cannotOpenFile(path: path)
+        }
+
+        guard let data = try fileHandle.readToEnd() else {
+            throw CocoaError(.fileReadUnknown, userInfo: ["path": path])
+        }
+
         var map = [UInt32: Node]()
         var index: UInt32 = 0
         var cursor = 0

Sources/SwiftDocC/Infrastructure/Bundle Assets/SVGIDExtractor.swift

@@ -40,7 +40,10 @@ enum SVGIDExtractor {
     /// Returns nil if any errors are encountered or if an `id` attribute is
     /// not found in the given SVG.
     static func extractID(from svg: URL) -> String? {
-        guard let data = try? Data(contentsOf: svg) else {
+        guard
+            let fileHandle = try? FileHandle(forReadingFrom: svg),
+            let data = try? fileHandle.readToEnd()
+        else {
             return nil
         }
 

Sources/SwiftDocC/Infrastructure/Workspace/LocalFileSystemDataProvider.swift

@@ -48,6 +48,11 @@ public struct LocalFileSystemDataProvider: DocumentationWorkspaceDataProvider, F
 
     public func contentsOfURL(_ url: URL) throws -> Data {
         precondition(url.isFileURL, "Unexpected non-file url '\(url)'.")
-        return try Data(contentsOf: url)
+        let fileHandle = try FileHandle(forReadingFrom: url)
+        guard let data = try fileHandle.readToEnd() else {
+            throw CocoaError(.fileReadUnknown, userInfo: ["path": url.path])
+        }
+
+        return data
     }
 }

Sources/SwiftDocC/Infrastructure/Workspace/PrebuiltLocalFileSystemDataProvider.swift

@@ -28,7 +28,12 @@ public struct PrebuiltLocalFileSystemDataProvider: DocumentationWorkspaceDataPro
 
     public func contentsOfURL(_ url: URL) throws -> Data {
         precondition(url.isFileURL, "Unexpected non-file url '\(url)'.")
-        return try Data(contentsOf: url)
+        let fileHandle = try FileHandle(forReadingFrom: url)
+        guard let data = try fileHandle.readToEnd() else {
+            throw CocoaError(.fileReadUnknown, userInfo: ["path": url.path])
+        }
+
+        return data
     }
 }
 

Sources/SwiftDocC/Servers/DocumentationSchemeHandler.swift

@@ -9,16 +9,17 @@
 */
 
 import Foundation
-
-#if canImport(WebKit)
-import WebKit
+import HTTPTypes
 
 @available(*, deprecated, renamed: "DocumentationSchemeHandler")
 public typealias TopicReferenceSchemeHandler = DocumentationSchemeHandler
 public class DocumentationSchemeHandler: NSObject {
-
-    public typealias FallbackResponseHandler = (URLRequest) -> (URLResponse, Data)?
-
+    enum Error: Swift.Error {
+        case noURLProvided
+    }
+
+    public typealias FallbackResponseHandler = (HTTPRequest) -> (HTTPTypes.HTTPResponse, Data)?
+
     // The schema to support the documentation.
     public static let scheme = "doc"
     public static var fullScheme: String {
@@ -71,7 +72,7 @@ public class DocumentationSchemeHandler: NSObject {
     }
 
     /// Returns a response to a given request.
-    public func response(to request: URLRequest) -> (URLResponse, Data?) {
+    public func response(to request: HTTPRequest) -> (HTTPTypes.HTTPResponse, Data?) {
         var (response, data) = fileServer.response(to: request)
         if data == nil, let fallbackHandler = fallbackHandler,
             let (fallbackResponse, fallbackData) = fallbackHandler(request) {
@@ -82,11 +83,47 @@ public class DocumentationSchemeHandler: NSObject {
     }
 }
 
+#if canImport(WebKit)
+import WebKit
+
 // MARK: WKURLSchemeHandler protocol
 extension DocumentationSchemeHandler: WKURLSchemeHandler {
 
     public func webView(_ webView: WKWebView, start urlSchemeTask: WKURLSchemeTask) {
-        let (response, data) = self.response(to: urlSchemeTask.request)
+        let request = urlSchemeTask.request
+
+        // Render authority pseudo-header in accordance with https://www.rfc-editor.org/rfc/rfc3986.html#section-3.2
+        let authority: String
+        guard let url = request.url else {
+            urlSchemeTask.didFailWithError(Error.noURLProvided)
+            return
+        }
+
+        let userAuthority: String
+        if let user = url.user {
+            userAuthority = "\(user)@"
+        } else {
+            userAuthority = ""
+        }
+
+        let portAuthority: String
+        if let port = url.port {
+            portAuthority = ":\(port)"
+        } else {
+            portAuthority = ""
+        }
+
+        authority = "\(userAuthority)\(url.host ?? "")\(portAuthority)"
+        let httpRequest = HTTPRequest(method: .get, scheme: request.url?.scheme, authority: authority, path: request.url?.path)
+
+        let (httpResponse, data) = self.response(to: httpRequest)
+
+        let response = URLResponse(
+            url: url,
+            mimeType: httpResponse.headerFields[.contentType], 
+            expectedContentLength: httpResponse.headerFields[.contentLength].flatMap(Int.init) ?? -1,
+            textEncodingName: httpResponse.headerFields[.contentEncoding]
+        )
         urlSchemeTask.didReceive(response)
         if let data = data {
             urlSchemeTask.didReceive(data)

Sources/SwiftDocC/Servers/FileServer.swift

@@ -9,10 +9,8 @@
 */
 
 import Foundation
+import HTTPTypes
 import SymbolKit
-#if canImport(FoundationNetworking)
-import FoundationNetworking
-#endif
 
 fileprivate let slashCharSet = CharacterSet(charactersIn: "/")
 
@@ -56,49 +54,54 @@ public class FileServer {
     /**
      Returns the data for a given URL.
      */
+    @available(*, deprecated, message: "Use 'data(for path: String)' instead.")
     public func data(for url: URL) -> Data? {
+        return data(for: url.path)
+    }
+
+    public func data(for path: String) -> Data? {
         let providerKey = providers.keys.sorted { (l, r) -> Bool in
             l.count > r.count
-            }.filter { (path) -> Bool in
-                return url.path.trimmingCharacters(in: slashCharSet).hasPrefix(path)
+            }.filter { (providerPath) -> Bool in
+                return path.trimmingCharacters(in: slashCharSet).hasPrefix(providerPath)
             }.first ?? "" //in case missing an exact match, get the root one
         guard let provider = providers[providerKey] else {
             fatalError("A provider has not been passed to a FileServer.")
         }
-        return provider.data(for: url.path.trimmingCharacters(in: slashCharSet).removingPrefix(providerKey))
+        return provider.data(for: path.trimmingCharacters(in: slashCharSet).removingPrefix(providerKey))
     }
 
     /**
      Returns a tuple with a response and the given data.
      - Parameter request: The request coming from a web client.
      - Returns: The response and data which are going to be served to the client.
      */
-    public func response(to request: URLRequest) -> (URLResponse, Data?) {
-        guard let url = request.url else {
-            return (HTTPURLResponse(url: baseURL, statusCode: 400, httpVersion: "HTTP/1.1", headerFields: nil)!, nil)
+    public func response(to request: HTTPRequest) -> (HTTPTypes.HTTPResponse, Data?) {
+        guard let path = request.path as NSString? else {
+            return (.init(status: 400), nil)
         }
         var data: Data? = nil
-        let response: URLResponse
-        
+        let response: HTTPTypes.HTTPResponse
+
         let mimeType: String
 
         // We need to make sure that the path extension is for an actual file and not a symbol name which is a false positive
         // like: "'...(_:)-6u3ic", that would be recognized as filename with the extension "(_:)-6u3ic". (rdar://71856738)
-        if url.pathExtension.isAlphanumeric && !url.lastPathComponent.isSwiftEntity {
-            data = self.data(for: url)
-            mimeType = FileServer.mimeType(for: url.pathExtension)
+        if path.pathExtension.isAlphanumeric && !path.lastPathComponent.isSwiftEntity {
+            data = self.data(for: path as String)
+            mimeType = FileServer.mimeType(for: path.pathExtension)
         } else { // request is for a path, we need to fake a redirect here
-            if url.pathComponents.isEmpty {
-                xlog("Tried to load an invalid URL: \(url.absoluteString).\nFalling back to serve index.html.")
+            if path.pathComponents.isEmpty {
+                xlog("Tried to load an invalid path: \(path).\nFalling back to serve index.html.")
             }
             mimeType = "text/html"
-            data = self.data(for: baseURL.appendingPathComponent("/index.html"))
+            data = self.data(for: "/index.html")
         }
 
         if let data = data {
-            response = URLResponse(url: url, mimeType: mimeType, expectedContentLength: data.count, textEncodingName: nil)
+            response = .init(status: .ok, headerFields: [.contentType: mimeType, .contentLength: "\(data.count)"])
         } else {
-            response = URLResponse(url: url, mimeType: nil, expectedContentLength: 0, textEncodingName: nil)
+            response = .init(status: .ok, headerFields: [.contentType: "application/octet-stream"])
         }
 
         return (response, data)
@@ -175,7 +178,8 @@ public class FileSystemServerProvider: FileServerProvider {
 
     public func data(for path: String) -> Data? {
         let finalURL = directoryURL.appendingPathComponent(path)
-        return try? Data(contentsOf: finalURL)
+        let fileHandle = try? FileHandle(forReadingFrom: finalURL)
+        return try? fileHandle?.readToEnd()
     }
 
 }
@@ -230,7 +234,12 @@ public class MemoryFileServerProvider: FileServerProvider {
 
         for file in enumerator {
             guard let file = file as? String else { fatalError("Enumerator returned an unexpected type.") }
-            guard let data = try? Data(contentsOf: URL(fileURLWithPath: path).appendingPathComponent(file)) else { continue }
+            let fileURL = URL(fileURLWithPath: path).appendingPathComponent(file)
+            guard
+                let fileHandle = try? FileHandle(forReadingFrom: fileURL),
+                let data = try? fileHandle.readToEnd()
+            else { continue }
+
             if recursive == false && file.contains("/") { continue } // skip if subfolder and recursive is disabled
             addFile(path: "/\(trimmedSubPath)/\(file)", data: data)
         }

Sources/SwiftDocCTestUtilities/FilesAndFolders.swift

@@ -200,7 +200,11 @@ public struct CopyOfFile: File, DataRepresentable {
         // to use `FileManager.default` directly here instead of `FileManagerProtocol`.
         var isDirectory: ObjCBool = false
         guard FileManager.default.fileExists(atPath: original.path, isDirectory: &isDirectory), !isDirectory.boolValue else { throw Error.notAFile(original) }
-        return try Data(contentsOf: original)
+        let fileHandle = try FileHandle(forReadingFrom: original)
+        guard let data = try fileHandle.readToEnd() else {
+            throw CocoaError(.fileReadUnknown, userInfo: ["path": original.path])
+        }
+        return data
     }
 
     public func write(to url: URL) throws {