Transition away from Foundation.URL

The parser of `NSURL` is changing in macOS Sonoma and will no longer be compatible with the GitHub-style SSH URLs which means we have to transition back to using our own URL type (which is a wrapper of `String` for now) in order to continue to support SSH URLs.

rdar://112482783

Author: neonichu

Sources/Basics/CMakeLists.txt

@@ -31,6 +31,7 @@ add_library(Basics
   FileSystem/TemporaryFile.swift
   FileSystem/TSCAdapters.swift
   FileSystem/VFSOverlay.swift
+  SourceControlURL.swift
   HTTPClient/HTTPClient.swift
   HTTPClient/HTTPClientConfiguration.swift
   HTTPClient/HTTPClientError.swift

Sources/Basics/SourceControlURL.swift

@@ -0,0 +1,53 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See http://swift.org/LICENSE.txt for license information
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+
+public struct SourceControlURL: Codable, Equatable, Hashable, Sendable {
+    private let urlString: String
+
+    public init(stringLiteral: String) {
+        self.urlString = stringLiteral
+    }
+
+    public init(_ urlString: String) {
+        self.urlString = urlString
+    }
+
+    public init(_ url: URL) {
+        self.urlString = url.absoluteString
+    }
+
+    public var absoluteString: String {
+        return self.urlString
+    }
+
+    public var lastPathComponent: String {
+        return (self.urlString as NSString).lastPathComponent
+    }
+
+    public var url: URL? {
+        return URL(string: self.urlString)
+    }
+}
+
+extension SourceControlURL: CustomStringConvertible {
+    public var description: String {
+        return self.urlString
+    }
+}
+
+extension SourceControlURL: ExpressibleByStringInterpolation {
+}
+
+extension SourceControlURL: ExpressibleByStringLiteral {
+}

Sources/PackageCollections/PackageCollections+Validation.swift

@@ -82,7 +82,7 @@ extension PackageCollectionModel.V1 {
 
         // TODO: validate package url?
         private func validate(package: Collection.Package, messages: inout [ValidationMessage]) {
-            let packageID = "\(PackageIdentity(url: package.url).description) (\(package.url.absoluteString))"
+            let packageID = "\(PackageIdentity(url: SourceControlURL(package.url)).description) (\(package.url.absoluteString))"
 
             guard !package.versions.isEmpty else {
                 messages.append(.error("Package \(packageID) does not have any versions.", property: "package.versions"))

Sources/PackageCollections/Providers/GitHubPackageMetadataProvider.swift

@@ -62,7 +62,7 @@ struct GitHubPackageMetadataProvider: PackageMetadataProvider, Closable {
         callback: @escaping (Result<Model.PackageBasicMetadata, Error>, PackageMetadataProviderContext?) -> Void
     ) {
         guard let baseURL = Self.apiURL(location) else {
-            return self.errorCallback(GitHubPackageMetadataProviderError.invalidGitURL(location), apiHost: nil, callback: callback)
+            return self.errorCallback(GitHubPackageMetadataProviderError.invalidSourceControlURL(location), apiHost: nil, callback: callback)
         }
 
         if let cached = try? self.cache?.get(key: identity.description) {
@@ -334,7 +334,7 @@ struct GitHubPackageMetadataProvider: PackageMetadataProvider, Closable {
 }
 
 enum GitHubPackageMetadataProviderError: Error, Equatable {
-    case invalidGitURL(String)
+    case invalidSourceControlURL(String)
     case invalidResponse(URL, String)
     case permissionDenied(URL)
     case invalidAuthToken(URL)

Sources/PackageCollections/Providers/JSONPackageCollectionProvider.swift

@@ -371,7 +371,7 @@ struct JSONPackageCollectionProvider: PackageCollectionProvider {
 
                 // If package identity is set, use that. Otherwise create one from URL.
                 return .init(
-                    identity: package.identity.map { PackageIdentity.plain($0) } ?? PackageIdentity(url: package.url),
+                    identity: package.identity.map { PackageIdentity.plain($0) } ?? PackageIdentity(url: SourceControlURL(package.url)),
                     location: package.url.absoluteString,
                     summary: package.summary,
                     keywords: package.keywords,

Sources/PackageFingerprint/FilePackageFingerprintStorage.swift

@@ -265,15 +265,14 @@ private enum StorageModel {
 
                                 let fingerprintsByContentType = try Dictionary(
                                     throwingUniqueKeysWithValues: fingerprintsForKind.map { _, storedFingerprint in
-                                        guard let originURL = URL(string: storedFingerprint.origin) else {
-                                            throw SerializationError.invalidURL(storedFingerprint.origin)
-                                        }
-
                                         let origin: Fingerprint.Origin
                                         switch kind {
                                         case .sourceControl:
-                                            origin = .sourceControl(originURL)
+                                            origin = .sourceControl(SourceControlURL(storedFingerprint.origin))
                                         case .registry:
+                                            guard let originURL = URL(string: storedFingerprint.origin) else {
+                                                throw SerializationError.invalidURL(storedFingerprint.origin)
+                                            }
                                             origin = .registry(originURL)
                                         }
 

Sources/PackageFingerprint/Model.swift

@@ -12,6 +12,7 @@
 
 import struct Foundation.URL
 
+import Basics
 import PackageModel
 import struct TSCUtility.Version
 
@@ -34,7 +35,7 @@ extension Fingerprint {
     }
 
     public enum Origin: Equatable, CustomStringConvertible {
-        case sourceControl(URL)
+        case sourceControl(SourceControlURL)
         case registry(URL)
 
         public var kind: Fingerprint.Kind {
@@ -46,12 +47,12 @@ extension Fingerprint {
             }
         }
 
-        public var url: URL? {
+        public var url: SourceControlURL? {
             switch self {
             case .sourceControl(let url):
                 return url
             case .registry(let url):
-                return url
+                return SourceControlURL(url.absoluteString)
             }
         }
 

Sources/PackageGraph/DependencyMirrors.swift

@@ -166,10 +166,8 @@ public final class DependencyMirrors: Equatable {
             return PackageIdentity.plain(location)
         } else if let path = try? AbsolutePath(validating: location) {
             return PackageIdentity(path: path)
-        } else if let url = URL(string: location) {
-            return PackageIdentity(url: url)
         } else {
-            throw StringError("invalid location \(location), cannot extract identity")
+            return PackageIdentity(url: SourceControlURL(location))
         }
     }
 }

Sources/PackageGraph/PinsStore.swift

@@ -428,10 +428,8 @@ extension PinsStore.Pin {
         var packageRef: PackageReference
         if let path = try? AbsolutePath(validating: location) {
             packageRef = .localSourceControl(identity: identity, path: path)
-        } else if let url = URL(string: location) {
-            packageRef = .remoteSourceControl(identity: identity, url: url)
         } else {
-            throw StringError("invalid package location \(location)")
+            packageRef = .remoteSourceControl(identity: identity, url: SourceControlURL(location))
         }
         if let newName = pin.package {
             packageRef = packageRef.withName(newName)
@@ -466,10 +464,7 @@ extension PinsStore.Pin {
         case .localSourceControl:
             packageRef = try .localSourceControl(identity: identity, path: AbsolutePath(validating: location))
         case .remoteSourceControl:
-            guard let url = URL(string: location) else {
-                throw StringError("invalid url location: \(location)")
-            }
-            packageRef = .remoteSourceControl(identity: identity, url: url)
+            packageRef = .remoteSourceControl(identity: identity, url: SourceControlURL(location))
         case .registry:
             packageRef = .registry(identity: identity)
         }

Sources/PackageLoading/ManifestJSONParser.swift

@@ -15,6 +15,7 @@ import PackageModel
 
 import struct Basics.AbsolutePath
 import protocol Basics.FileSystem
+import struct Basics.SourceControlURL
 import struct Basics.InternalError
 import struct Basics.RelativePath
 
@@ -237,7 +238,8 @@ enum ManifestJSONParser {
                 requirement: requirement,
                 productFilter: .everything
             )
-        } else if let url = URL(string: location){
+        } else {
+            let url = SourceControlURL(location)
             // in the future this will check with the registries for the identity of the URL
             let identity = try identityResolver.resolveIdentity(for: url)
             return .remoteSourceControl(
@@ -247,8 +249,6 @@ enum ManifestJSONParser {
                 requirement: requirement,
                 productFilter: .everything
             )
-        } else {
-            throw StringError("invalid location: \(location)")
         }
     }
 
@@ -268,8 +268,9 @@ enum ManifestJSONParser {
                 productFilter: .everything
             )
         } else if let url = URL(string: location){
+            let SourceControlURL = SourceControlURL(url)
             // in the future this will check with the registries for the identity of the URL
-            let identity = try identityResolver.resolveIdentity(for: url)
+            let identity = try identityResolver.resolveIdentity(for: SourceControlURL)
             let sourceControlRequirement: PackageDependency.SourceControl.Requirement
             switch requirement {
             case .exact(let value):
@@ -280,7 +281,7 @@ enum ManifestJSONParser {
             return .remoteSourceControl(
                 identity: identity,
                 nameForTargetDependencyResolutionOnly: identity.description,
-                url: url,
+                url: SourceControlURL,
                 requirement: sourceControlRequirement,
                 productFilter: .everything
             )