fix warnings (#3849)

motivations: less warnings, safer code

changes:
* use package identifier for display name in collections
* reduce use of DiagnosticsEngine where possible
* remove use of PackageLocation from Git errors, metadata is already carried on assocaited error
* adjust tests

Author: tomerd

Sources/Commands/SwiftPackageTool.swift

@@ -488,18 +488,25 @@ extension SwiftPackageTool {
             _ comparisonResult: SwiftAPIDigester.ComparisonResult,
             observabilityScope: ObservabilityScope
         ) {
-            // TODO: use observabilityScope directly
-            let diagnosticsEngine = observabilityScope.makeDiagnosticsEngine()
             for diagnostic in comparisonResult.otherDiagnostics {
+                let metadata = diagnostic.location.map { location -> ObservabilityMetadata in
+                    var metadata = ObservabilityMetadata()
+                    metadata.fileLocation = .init(
+                        .init(location.filename),
+                        line: location.line < Int.max ? Int(location.line) : .none
+                    )
+                    return metadata
+                }
+
                 switch diagnostic.level {
                 case .error, .fatal:
-                    diagnosticsEngine.emit(error: diagnostic.text, location: diagnostic.location)
+                    observabilityScope.emit(error: diagnostic.text, metadata: metadata)
                 case .warning:
-                    diagnosticsEngine.emit(warning: diagnostic.text, location: diagnostic.location)
+                    observabilityScope.emit(warning: diagnostic.text, metadata: metadata)
                 case .note:
-                    diagnosticsEngine.emit(note: diagnostic.text, location: diagnostic.location)
+                    observabilityScope.emit(info: diagnostic.text, metadata: metadata)
                 case .remark:
-                    diagnosticsEngine.emit(remark: diagnostic.text, location: diagnostic.location)
+                    observabilityScope.emit(info: diagnostic.text, metadata: metadata)
                 case .ignored:
                     break
                 }

Sources/PackageCollections/Model/Package.swift

@@ -290,6 +290,6 @@ extension PackageCollectionsModel.Package.Version {
 
 extension Model.Package {
     var displayName: String {
-        self.latestVersion?.packageName ?? self.identity.description
+        self.identity.description
     }
 }

Sources/PackageModel/Package.swift

@@ -143,9 +143,6 @@ extension ObservabilityMetadata {
         var metadata = ObservabilityMetadata()
         metadata.packageIdentity = identity
         metadata.packageKind = kind
-        //metadata.packageLocation = location
-        // FIXME: (diagnostics) remove once transition to Observability API is complete
-        //metadata.legacyDiagnosticLocation = .init(PackageLocation.Local(name: identity.description, packagePath: path))
         return metadata
     }
 }

Sources/Workspace/SourceControlPackageContainer.swift

@@ -23,7 +23,7 @@ internal final class SourceControlPackageContainer: PackageContainer, CustomStri
 
     // A wrapper for getDependencies() errors. This adds additional information
     // about the container to identify it for diagnostics.
-    public struct GetDependenciesError: Error, CustomStringConvertible, DiagnosticLocationProviding {
+    public struct GetDependenciesError: Error, CustomStringConvertible {
 
         /// The repository  that encountered the error.
         public let repository: RepositorySpecifier
@@ -37,10 +37,6 @@ internal final class SourceControlPackageContainer: PackageContainer, CustomStri
         /// Optional suggestion for how to resolve the error.
         public let suggestion: String?
 
-        public var diagnosticLocation: DiagnosticLocation? {
-            return PackageLocation.Remote(url: self.repository.location.description, reference: self.reference)
-        }
-
         /// Description shown for errors of this kind.
         public var description: String {
             var desc = "\(underlyingError) in \(self.repository.location)"

Tests/WorkspaceTests/PackageContainerProviderTests.swift

@@ -572,15 +572,17 @@ class PackageContainerProviderTests: XCTestCase {
             catch let error as SourceControlPackageContainer.GetDependenciesError {
                 // We expect to get an error message that mentions main.
                 XCTAssertMatch(error.description, .and(.prefix("could not find a branch named ‘master’"), .suffix("(did you mean ‘main’?)")))
-                XCTAssertMatch(error.diagnosticLocation?.description, .suffix("/SomePackage @ master"))
+                XCTAssertMatch(error.repository.description, .suffix("/SomePackage"))
+                XCTAssertMatch(error.reference, "master")
             }
 
             // Simulate accessing a fictitious dependency on some random commit that doesn't exist, and check that we get back the expected error.
             do { _ = try container.getDependencies(at: "535f4cb5b4a0872fa691473e82d7b27b9894df00", productFilter: .everything) }
             catch let error as SourceControlPackageContainer.GetDependenciesError {
                 // We expect to get an error message about the specific commit.
                 XCTAssertMatch(error.description, .prefix("could not find the commit 535f4cb5b4a0872fa691473e82d7b27b9894df00"))
-                XCTAssertMatch(error.diagnosticLocation?.description, .suffix("/SomePackage @ 535f4cb5b4a0872fa691473e82d7b27b9894df00"))
+                XCTAssertMatch(error.repository.description, .suffix("/SomePackage"))
+                XCTAssertMatch(error.reference, "535f4cb5b4a0872fa691473e82d7b27b9894df00")
             }
         }
     }