Skip to content

Add package metadata to observability scopes used by PackageContainers #5969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 14, 2022
Merged

Add package metadata to observability scopes used by PackageContainers #5969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Sources/PackageModel/PackageReference.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,12 @@ extension PackageReference: Hashable {
}
}

extension PackageReference {
public var diagnosticsMetadata: ObservabilityMetadata {
return .packageMetadata(identity: self.identity, kind: self.kind)
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could this be a non-public extension closer to the call site? seems fairly leaky as a public property of the model


extension PackageReference: CustomStringConvertible {
public var description: String {
return "\(self.identity) \(self.kind)"
Expand Down
4 changes: 3 additions & 1 deletion Sources/Workspace/FileSystemPackageContainer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ public struct FileSystemPackageContainer: PackageContainer {
self.manifestLoader = manifestLoader
self.currentToolsVersion = currentToolsVersion
self.fileSystem = fileSystem
self.observabilityScope = observabilityScope
self.observabilityScope = observabilityScope.makeChildScope(
description: "FileSystemPackageContainer",
metadata: package.diagnosticsMetadata)
}

private func loadManifest() throws -> Manifest {
Expand Down
4 changes: 3 additions & 1 deletion Sources/Workspace/RegistryPackageContainer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ public class RegistryPackageContainer: PackageContainer {
self.registryClient = registryClient
self.manifestLoader = manifestLoader
self.currentToolsVersion = currentToolsVersion
self.observabilityScope = observabilityScope
self.observabilityScope = observabilityScope.makeChildScope(
description: "RegistryPackageContainer",
metadata: package.diagnosticsMetadata)
}

// MARK: - PackageContainer
Expand Down
4 changes: 3 additions & 1 deletion Sources/Workspace/SourceControlPackageContainer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ internal final class SourceControlPackageContainer: PackageContainer, CustomStri
self.currentToolsVersion = currentToolsVersion
self.fingerprintStorage = fingerprintStorage
self.fingerprintCheckingMode = fingerprintCheckingMode
self.observabilityScope = observabilityScope
self.observabilityScope = observabilityScope.makeChildScope(
description: "SourceControlPackageContainer",
metadata: package.diagnosticsMetadata)
}

// Compute the map of known versions.
Expand Down
4 changes: 2 additions & 2 deletions Sources/Workspace/Workspace.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3129,7 +3129,7 @@ extension Workspace {
try? fileSystem.chmod(.userUnWritable, path: checkoutPath, options: [.recursive, .onlyFiles])

// Record the new state.
observabilityScope.emit(debug: "adding '\(package.identity)' (\(package.locationString)) to managed dependencies")
observabilityScope.emit(debug: "adding '\(package.identity)' (\(package.locationString)) to managed dependencies", metadata: package.diagnosticsMetadata)
self.state.dependencies.add(
try .sourceControlCheckout(
packageRef: package,
Expand Down Expand Up @@ -3280,7 +3280,7 @@ extension Workspace {
}

// Record the new state.
observabilityScope.emit(debug: "adding '\(package.identity)' (\(package.locationString)) to managed dependencies")
observabilityScope.emit(debug: "adding '\(package.identity)' (\(package.locationString)) to managed dependencies", metadata: package.diagnosticsMetadata)
self.state.dependencies.add(
try .registryDownload(
packageRef: package,
Expand Down