Fix API Diff args + async #49164
Merged
Fix API Diff args + async #49164
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
APICompat was exiting at the first time it needed to go async. This was because Commandline was treating the SetAction call as synchronous since it didn't accept a CancellationToken. Fix this and plumb basic cancellation. I also noticed that the usage of Option<T> was incorrect and corrected it to be consistent with the way we use in other tools.
ericstj
commented
May 27, 2025
| rootCommand.Options.Add(optionAttachDebugger); | ||
|
|
||
| rootCommand.SetAction(async (ParseResult result) => | ||
| rootCommand.SetAction(async (ParseResult result, CancellationToken cancellationToken) => |
There was a problem hiding this comment.
This is the only functional fix here. The rest is cleanup after a5fe497
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the API diff tool’s async handling by plumbing a CancellationToken through the asynchronous call chain and correcting Option usage for consistency.
- Updated RunAsync methods to accept a CancellationToken and added early cancellation checks
- Improved Option initialization in command-line options to match other tools
- Adjusted the root command’s SetAction signature to support cancellation token propagation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/MemoryOutputDiffGenerator.cs | Added CancellationToken parameter and inserted cancellation checks in loops |
| src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/IDiffGenerator.cs | Updated interface to require a CancellationToken in RunAsync |
| src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/FileOutputDiffGenerator.cs | Added cancellation checks and passed CancellationToken to inner RunAsync calls |
| src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Program.cs | Updated command line option definitions and SetAction callback to accept a CancellationToken |
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/MemoryOutputDiffGenerator.cs
Outdated
Show resolved
Hide resolved
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/FileOutputDiffGenerator.cs
Outdated
Show resolved
Hide resolved
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Program.cs
Outdated
Show resolved
Hide resolved
jozkee
approved these changes
May 27, 2025
ericstj
commented
May 28, 2025
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/FileOutputDiffGenerator.cs
Outdated
Show resolved
Hide resolved
ericstj
commented
May 28, 2025
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/MemoryOutputDiffGenerator.cs
Outdated
Show resolved
Hide resolved
ericstj
commented
May 28, 2025
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/MemoryOutputDiffGenerator.cs
Outdated
Show resolved
Hide resolved
ViktorHofer
approved these changes
May 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
APICompat was exiting at the first time it needed to go async.
This was because Commandline was treating the SetAction call as synchronous since it didn't accept a CancellationToken. Fix this and plumb basic cancellation.
I also noticed that the usage of Option was incorrect and corrected it to be consistent with the way we use in other tools.