Add package metadata to observability scopes used by PackageContainers #5969
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PackageContainer is a protocol that is implemented by various types involved in SwiftPM package resolution. They can emit messages but those messages don't get associated with the diagnostics. There are currently three implementors of this protocol: FileSystemPackageContainer, SourceControlPackageContainer, and RegistryPackageContainer. All three just assign a given ObservabilityScope, and setting a package location metadata on that scope is a good way to make sure that all the diagnostics emitted to that scope get associated with the package. This fix makes sure that diagnostics emitted through these scopes get properly associated with the package. This is particularly useful for manifest-related diagnostics, which inherit the scope used by the various kinds of PackageContainer. rdar://103229985
|
Looking for the best unit tests to extend with additional checks. |
|
@swift-ci please smoke test |
neonichu
approved these changes
Dec 14, 2022
tomerd
reviewed
Dec 21, 2022
| public var diagnosticsMetadata: ObservabilityMetadata { | ||
| return .packageMetadata(identity: self.identity, kind: self.kind) | ||
| } | ||
| } |
There was a problem hiding this comment.
could this be a non-public extension closer to the call site? seems fairly leaky as a public property of the model
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PackageContaineris a protocol that is implemented by various types involved in SwiftPM package resolution. They can emit messages but those messages don't get associated with the diagnostics.There are currently three implementors of this protocol:
FileSystemPackageContainer,SourceControlPackageContainer, andRegistryPackageContainer. All three just assign a givenObservabilityScope, and setting a package location metadata on that scope is a good way to make sure that all the diagnostics emitted to that scope get associated with the package.This fix makes sure that diagnostics emitted through these scopes get properly associated with the package. This is particularly useful for manifest-related diagnostics, which inherit the scope used by the various kinds of
PackageContainer.Changes
diagnosticsMetadataproperty in extension onPackageRerference, similar to the one onPackageObservabilityScopeemitcalls inWorkspacerdar://103229985