[PackageGraph] Diagnose invalid tools version for revision-based dependencies

<rdar://problem/48980120>

Author: aciidgh

Sources/PackageGraph/RepositoryPackageContainerProvider.swift

@@ -266,22 +266,12 @@ public class RepositoryPackageContainer: BasePackageContainer, CustomStringConve
  }
 
  // Otherwise, compute and cache the result.
- let isValid = (try? self.toolsVersion(for: $0)).flatMap({
- guard $0 >= ToolsVersion.minimumRequired else {
- return false
- }
-
- guard self.currentToolsVersion >= $0 else {
- return false
- }
-
- return true
- }) ?? false
+ let isValid = (try? self.toolsVersion(for: $0)).flatMap(self.isValidToolsVersion(_:)) ?? false
  self.validToolsVersionsCache[$0] = isValid
-
  return isValid
  }))
  }
+ 
  /// The opened repository.
  let repository: Repository
 
@@ -403,13 +393,19 @@ public class RepositoryPackageContainer: BasePackageContainer, CustomStringConve
  ) throws -> (Manifest, [RepositoryPackageConstraint]) {
  let fs = try repository.openFileView(revision: revision)
 
+ let packageURL = identifier.repository.url
+
  // Load the tools version.
  let toolsVersion = try toolsVersionLoader.load(at: .root, fileSystem: fs)
 
+ // Validate the tools version.
+ try toolsVersion.validateToolsVersion(
+ self.currentToolsVersion, version: revision.identifier, packagePath: packageURL)
+
  // Load the manifest.
  let manifest = try manifestLoader.load(
  package: AbsolutePath.root,
- baseURL: identifier.repository.url,
+ baseURL: packageURL,
  version: version,
  manifestVersion: toolsVersion.manifestVersion,
  fileSystem: fs)
@@ -443,4 +439,15 @@ public class RepositoryPackageContainer: BasePackageContainer, CustomStringConve
  }
  return self.identifier.with(newName: manifest.name)
  }
+
+ /// Returns true if the tools version is valid and can be used by this
+ /// version of the package manager.
+ private func isValidToolsVersion(_ toolsVersion: ToolsVersion) -> Bool {
+ do {
+ try toolsVersion.validateToolsVersion(currentToolsVersion, packagePath: "")
+ return true
+ } catch {
+ return false
+ }
+ }
 }

Sources/PackageModel/ToolsVersion.swift

@@ -93,6 +93,34 @@ public struct ToolsVersion: CustomStringConvertible, Comparable, Hashable {
  public static func < (lhs: ToolsVersion, rhs: ToolsVersion) -> Bool {
  return lhs._version < rhs._version
  }
+
+ /// Returns true if the tools version is valid and can be used by this
+ /// version of the package manager.
+ public func validateToolsVersion(
+ _ currentToolsVersion: ToolsVersion,
+ version: String? = nil,
+ packagePath: String
+ ) throws {
+ // Make sure the package has the right minimum tools version.
+ guard self >= .minimumRequired else {
+ throw UnsupportedToolsVersion(
+ packagePath: packagePath,
+ version: version,
+ minimumRequiredToolsVersion: .minimumRequired,
+ packageToolsVersion: self
+ )
+ }
+
+ // Make sure the package isn't newer than the current tools version.
+ guard currentToolsVersion >= self else {
+ throw RequireNewerTools(
+ packagePath: packagePath,
+ version: version,
+ installedToolsVersion: currentToolsVersion,
+ packageToolsVersion: self
+ )
+ }
+ }
 }
 
 /// Represents a Swift language version.
@@ -191,3 +219,92 @@ extension SwiftLanguageVersion: Codable {
  self.init(uncheckedString: rawValue)
  }
 }
+
+// MARK:- Diagnostics
+
+/// The diagnostic triggered when the package has a newer tools version than the installed tools.
+public struct RequireNewerTools: DiagnosticData, Swift.Error {
+ public static var id = DiagnosticID(
+ type: RequireNewerTools.self,
+ name: "org.swift.diags.workspace.\(RequireNewerTools.self)",
+ description: {
+ $0 <<< .substitution({
+ let `self` = $0 as! RequireNewerTools
+ var text = "package at '\(self.packagePath)'"
+ if let version = self.version {
+ text += " @ \(version)"
+ }
+ return text
+ }, preference: .default)
+ $0 <<< "is using Swift tools version" <<< { $0.packageToolsVersion.description }
+ $0 <<< "but the installed version is" <<< { "\($0.installedToolsVersion.description)" }
+ })
+
+ /// The path of the package.
+ public let packagePath: String
+
+ /// The version of the package.
+ public let version: String?
+
+ /// The installed tools version.
+ public let installedToolsVersion: ToolsVersion
+
+ /// The tools version of the package.
+ public let packageToolsVersion: ToolsVersion
+
+ public init(
+ packagePath: String,
+ version: String? = nil,
+ installedToolsVersion: ToolsVersion,
+ packageToolsVersion: ToolsVersion
+ ) {
+ self.packagePath = packagePath
+ self.version = version
+ self.installedToolsVersion = installedToolsVersion
+ self.packageToolsVersion = packageToolsVersion
+ }
+}
+
+/// The diagnostic triggered when the package has an unsupported tools version.
+public struct UnsupportedToolsVersion: DiagnosticData, Swift.Error {
+ public static var id = DiagnosticID(
+ type: UnsupportedToolsVersion.self,
+ name: "org.swift.diags.workspace.\(UnsupportedToolsVersion.self)",
+ description: {
+ $0 <<< .substitution({
+ let `self` = $0 as! UnsupportedToolsVersion
+ var text = "package at '\(self.packagePath)'"
+ if let version = self.version {
+ text += " @ \(version)"
+ }
+ return text
+ }, preference: .default)
+ $0 <<< "is using Swift tools version" <<< { $0.packageToolsVersion.description }
+ $0 <<< "which is no longer supported; use" <<< { $0.minimumRequiredToolsVersion.description }
+ $0 <<< "or newer instead"
+ })
+
+ /// The path of the package.
+ public let packagePath: String
+
+ /// The version of the package.
+ public let version: String?
+
+ /// The tools version required by the package.
+ public let minimumRequiredToolsVersion: ToolsVersion
+
+ /// The current tools version.
+ public let packageToolsVersion: ToolsVersion
+
+ public init(
+ packagePath: String,
+ version: String? = nil,
+ minimumRequiredToolsVersion: ToolsVersion,
+ packageToolsVersion: ToolsVersion
+ ) {
+ self.packagePath = packagePath
+ self.version = version
+ self.minimumRequiredToolsVersion = minimumRequiredToolsVersion
+ self.packageToolsVersion = packageToolsVersion
+ }
+}

Sources/Workspace/Diagnostics.swift

@@ -255,49 +255,6 @@ public enum WorkspaceDiagnostics {
  public let revision: String
  }
 
- /// The diagnostic triggered when the root package has a newer tools version than the installed tools.
- public struct RequireNewerTools: DiagnosticData, Swift.Error {
- public static var id = DiagnosticID(
- type: RequireNewerTools.self,
- name: "org.swift.diags.workspace.\(RequireNewerTools.self)",
- description: {
- $0 <<< "package at" <<< { "'\($0.packagePath.pathString)'" }
- $0 <<< "is using Swift tools version" <<< { $0.packageToolsVersion.description }
- $0 <<< "but the installed version is" <<< { "\($0.installedToolsVersion.description)" }
- })
-
- /// The path of the package.
- public let packagePath: AbsolutePath
-
- /// The installed tools version.
- public let installedToolsVersion: ToolsVersion
-
- /// The tools version of the package.
- public let packageToolsVersion: ToolsVersion
- }
-
- /// The diagnostic triggered when the root package has an unsupported tools version.
- public struct UnsupportedToolsVersion: DiagnosticData, Swift.Error {
- public static var id = DiagnosticID(
- type: UnsupportedToolsVersion.self,
- name: "org.swift.diags.workspace.\(UnsupportedToolsVersion.self)",
- description: {
- $0 <<< "package at" <<< { "'\($0.packagePath)'" }
- $0 <<< "is using Swift tools version" <<< { $0.packageToolsVersion.description }
- $0 <<< "which is no longer supported; use" <<< { $0.minimumRequiredToolsVersion.description }
- $0 <<< "or newer instead"
- })
-
- /// The path of the package.
- public let packagePath: AbsolutePath
-
- /// The tools version required by the package.
- public let minimumRequiredToolsVersion: ToolsVersion
-
- /// The current tools version.
- public let packageToolsVersion: ToolsVersion
- }
-
  /// The diagnostic triggered when the package at the edit destination is not the
  /// one user is trying to edit.
  public struct MismatchingDestinationPackage: DiagnosticData, Swift.Error {

Sources/Workspace/Workspace.swift

@@ -1031,23 +1031,9 @@ extension Workspace {
  let toolsVersion = try toolsVersionLoader.load(
  at: packagePath, fileSystem: fileSystem)
 
- // Make sure the package has the right minimum tools version.
- guard toolsVersion >= ToolsVersion.minimumRequired else {
- throw WorkspaceDiagnostics.UnsupportedToolsVersion(
- packagePath: packagePath,
- minimumRequiredToolsVersion: .minimumRequired,
- packageToolsVersion: toolsVersion
- )
- }
-
- // Make sure the package isn't newer than the current tools version.
- guard currentToolsVersion >= toolsVersion else {
- throw WorkspaceDiagnostics.RequireNewerTools(
- packagePath: packagePath,
- installedToolsVersion: currentToolsVersion,
- packageToolsVersion: toolsVersion
- )
- }
+ // Validate the tools version.
+ try toolsVersion.validateToolsVersion(
+ currentToolsVersion, packagePath: packagePath.pathString)
 
  // Load the manifest.
  // FIXME: We should have a cache for this.

Tests/PackageGraphTests/RepositoryPackageContainerProviderTests.swift

@@ -337,6 +337,20 @@ class RepositoryPackageContainerProviderTests: XCTestCase {
  let v = container.versions(filter: { _ in true }).map{$0}
  XCTAssertEqual(v, [])
  }
+
+ // Test that getting dependencies on a revision that has unsupported tools version is diganosed properly.
+ do {
+ let provider = createProvider(ToolsVersion(version: "4.0.0"))
+ let ref = PackageReference(identity: "foo", path: specifier.url)
+ let container = try await { provider.getContainer(for: ref, completion: $0) } as! RepositoryPackageContainer
+ let revision = try container.getRevision(forTag: "1.0.0")
+ do {
+ _ = try container.getDependencies(at: revision.identifier)
+ } catch let error as RepositoryPackageContainer.GetDependenciesErrorWrapper {
+ let error = error.underlyingError as! UnsupportedToolsVersion
+ XCTAssertMatch(error.description, .and(.prefix("package at '/some-repo' @"), .suffix("is using Swift tools version 3.1.0 which is no longer supported; use 4.0.0 or newer instead")))
+ }
+ }
  }
 
  func testPrereleaseVersions() throws {