utils: Replace activity progress report messages with a live timer #1967
+27
−8
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
MicroFish91
changed the title
bwateratmsft
approved these changes
Apr 17, 2025
MicroFish91
commented
Apr 25, 2025
| @@ -24,6 +24,12 @@ export class ExecuteActivity<TContext extends types.ExecuteActivityContext = typ | |||
| } | |||
| } | |||
|
|
|||
| protected override report(progress?: { message?: string; increment?: number }): void { | |||
| const message: string | undefined = this.context.activityChildren?.length ? this.timerMessage : progress?.message; | |||
| this._onProgressEmitter.fire({ ...this.getState(), message }); | |||
There was a problem hiding this comment.
Made a new change here. I decided to override the report method in the concrete class. Two reasons for this:
- The concrete class is what actually holds the
ExecuteActivityContextwhich I need - The abstract class base implementation doesn't seem coupled to the Wizard, so I didn't want to pollute its implementation with Azure Wizard-y things.
The way this behaves:
- If an activity has children, we just show a timer as the description. We offload the responsibility of showing what's being executed to the children
- If no children, we still should indicate what's happening, so let's default back to any progress report messages in the description
I kept the timer on the abstract class level because its probably useful for any variation of concrete activity.
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.
We had discussed adding a live activity timer and hiding progress reports from the activity log description. This would help accomplish that.
Corresponding Resource Groups PR: microsoft/vscode-azureresourcegroups#1119
(Note: Progress reports would still be used commands leveraging the Azure Wizard without registering an activity, see below.)
vscode-azuretools/utils/src/wizard/AzureWizard.ts
Line 293 in 713123e