[5.8] Add package metadata to a few more ObservabilityScopes in workspace-wide and package graph loading operations (#5984) (#5986)

Clients of libSwiftPM that present diagnostics use the package metadata that can optionally be attached to an emitted Diagnostic to associate it with the package in the user interface.  This change addresses a few more cases in which no package metadata was associated.  Where possible, the metadata is associated with the ObservabilityScope at the highest place in the call stack so that any diagnostic emitted below it gets the package metadata.

rdar://103561534
(cherry picked from commit 723a592)

Author: abertelrud

Sources/PackageGraph/PackageGraph+Loading.swift

@@ -353,7 +353,7 @@ private func createResolvedPackages(
         )
 
         // Create target builders for each target in the package.
-        let targetBuilders = package.targets.map{ ResolvedTargetBuilder(target: $0, observabilityScope: observabilityScope) }
+        let targetBuilders = package.targets.map{ ResolvedTargetBuilder(target: $0, observabilityScope: packageObservabilityScope) }
         packageBuilder.targets = targetBuilders
 
         // Establish dependencies between the targets. A target can only depend on another target present in the same package.

Sources/PackageGraph/Pubgrub/PubgrubDependencyResolver.swift

@@ -1315,7 +1315,7 @@ private final class ContainerProvider {
             self.underlying.getContainer(
                 for: package,
                 skipUpdate: self.skipUpdate,
-                observabilityScope: self.observabilityScope,
+                observabilityScope: self.observabilityScope.makeChildScope(description: "getting package container", metadata: package.diagnosticsMetadata),
                 on: .sharedConcurrent
             ) { result in
                 let result = result.tryMap { container -> PubGrubPackageContainer in
@@ -1344,7 +1344,7 @@ private final class ContainerProvider {
                 self.underlying.getContainer(
                     for: identifier,
                     skipUpdate: self.skipUpdate,
-                    observabilityScope: self.observabilityScope,
+                    observabilityScope: self.observabilityScope.makeChildScope(description: "prefetcing package container", metadata: identifier.diagnosticsMetadata),
                     on: .sharedConcurrent
                 ) { result in
                     defer { self.prefetches[identifier]?.leave() }

Sources/Workspace/Workspace.swift

@@ -715,6 +715,8 @@ extension Workspace {
             observabilityScope.emit(.dependencyNotFound(packageName: packageName))
             return
         }
+        
+        let observabilityScope = observabilityScope.makeChildScope(description: "editing package", metadata: dependency.packageRef.diagnosticsMetadata)
 
         try self.unedit(dependency: dependency, forceRemove: forceRemove, root: root, observabilityScope: observabilityScope)
     }
@@ -745,6 +747,8 @@ extension Workspace {
             throw StringError("dependency '\(packageName)' was not found")
         }
 
+        let observabilityScope = observabilityScope.makeChildScope(description: "editing package", metadata: dependency.packageRef.diagnosticsMetadata)
+
         let defaultRequirement: PackageRequirement
         switch dependency.state {
         case .sourceControlCheckout(let checkoutState):
@@ -1269,6 +1273,8 @@ extension Workspace {
             observabilityScope.emit(.dependencyNotFound(packageName: packageName))
             return
         }
+        
+        let observabilityScope = observabilityScope.makeChildScope(description: "editing package", metadata: dependency.packageRef.diagnosticsMetadata)
 
         let checkoutState: CheckoutState
         switch dependency.state {
@@ -1811,7 +1817,7 @@ extension Workspace {
         // Remove any managed dependency which has become a root.
         for dependency in dependenciesToCheck {
             if root.packages.keys.contains(dependency.packageRef.identity) {
-                observabilityScope.trap {
+                observabilityScope.makeChildScope(description: "removing managed dependencies", metadata: dependency.packageRef.diagnosticsMetadata).trap {
                     try self.remove(package: dependency.packageRef)
                 }
             }
@@ -2060,7 +2066,7 @@ extension Workspace {
         // Make a copy of dependencies as we might mutate them in the for loop.
         let allDependencies = Array(self.state.dependencies)
         for dependency in allDependencies {
-            observabilityScope.trap {
+            observabilityScope.makeChildScope(description: "copying managed dependencies", metadata: dependency.packageRef.diagnosticsMetadata).trap {
                 // If the dependency is present, we're done.
                 let dependencyPath = self.path(to: dependency)
                 if fileSystem.isDirectory(dependencyPath) {
@@ -2287,6 +2293,7 @@ extension Workspace {
         let group = DispatchGroup()
         for pin in pinsStore.pins {
             group.enter()
+            let observabilityScope = observabilityScope.makeChildScope(description: "requesting package containers", metadata: pin.packageRef.diagnosticsMetadata)
             packageContainerProvider.getContainer(for: pin.packageRef, skipUpdate: self.configuration.skipDependenciesUpdates, observabilityScope: observabilityScope, on: .sharedConcurrent, completion: { _ in
                 group.leave()
             })
@@ -2314,7 +2321,7 @@ extension Workspace {
 
         // Retrieve the required pins.
         for pin in requiredPins {
-            observabilityScope.trap {
+            observabilityScope.makeChildScope(description: "retrieving dependency pins", metadata: pin.packageRef.diagnosticsMetadata).trap {
                 switch pin.packageRef.kind {
                 case .localSourceControl, .remoteSourceControl:
                     _ = try self.checkoutRepository(package: pin.packageRef, at: pin.state, observabilityScope: observabilityScope)
@@ -2517,7 +2524,7 @@ extension Workspace {
 
         // First remove the checkouts that are no longer required.
         for (packageRef, state) in packageStateChanges {
-            observabilityScope.trap {
+            observabilityScope.makeChildScope(description: "removing unneeded checkouts", metadata: packageRef.diagnosticsMetadata).trap {
                 switch state {
                 case .added, .updated, .unchanged: break
                 case .removed:
@@ -2528,7 +2535,7 @@ extension Workspace {
 
         // Update or clone new packages.
         for (packageRef, state) in packageStateChanges {
-            observabilityScope.trap {
+            observabilityScope.makeChildScope(description: "updating or cloning new packages", metadata: packageRef.diagnosticsMetadata).trap {
                 switch state {
                 case .added(let state):
                     _ = try self.updateDependency(package: packageRef, requirement: state.requirement, productFilter: state.products, observabilityScope: observabilityScope)

Tests/WorkspaceTests/WorkspaceTests.swift

@@ -4603,11 +4603,13 @@ final class WorkspaceTests: XCTestCase {
                     diagnostic: .equal("the target 'Baz' in product 'Baz' contains unsafe build flags"),
                     severity: .error
                 )
+                XCTAssertEqual(diagnostic1?.metadata?.packageIdentity, .plain("foo"))
                 XCTAssertEqual(diagnostic1?.metadata?.targetName, "Foo")
                 let diagnostic2 = result.checkUnordered(
                     diagnostic: .equal("the target 'Bar' in product 'Baz' contains unsafe build flags"),
                     severity: .error
                 )
+                XCTAssertEqual(diagnostic2?.metadata?.packageIdentity, .plain("foo"))
                 XCTAssertEqual(diagnostic2?.metadata?.targetName, "Foo")
             }
         }