Skip to content

feat: add progress reporting - #376

Merged
xeniape merged 18 commits into
mainfrom
feat/progress-reporting
May 23, 2025
Merged

feat: add progress reporting#376
xeniape merged 18 commits into
mainfrom
feat/progress-reporting

Conversation

@xeniape

@xeniapexeniape commented May 16, 2025

Copy link
Copy Markdown
Member

Description

Implementation for #153

Adds various progress indications/visualizations to stackablectl subcommand outputs.

demo install - operators

demo install - charts

Some explanation regarding println!/eprintln! changes in this PR:
When indicatif is active, it needs to control how text is printed. So instead of printing straight to stdout/stderr via println!/eprintln!, we use indicatif_println!/indicatif_eprintln! so it can deal with it while rendering progress bars. If it is not active, the indicatif macros just use stdout/stderr.

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes
# Author
- [x] Changelog updated
# Reviewer
- [ ] Code contains useful comments
- [ ] (Integration-)Test cases added
- [ ] Documentation added or updated
- [ ] Changelog updated
- [ ] Cargo.toml only contains references to git tags (not specific commits or branches)
# Acceptance
- [ ] Feature Tracker has been updated
- [ ] Proper release label has been added

@xeniapexeniape self-assigned this May 16, 2025

@NickLarsenNZNickLarsenNZ left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Really nice. Here's some initial feedback.

I noticed a lot of formatting changes, but I couldn't tell if it was new or old styling.
I also see pre-commit failed, so could be related.

Comment threadrust/stackable-cockpit/src/platform/demo/spec.rs Outdated
Comment threadrust/stackable-cockpit/src/platform/manifests.rs Outdated
Comment threadrust/stackable-cockpit/src/platform/operator/mod.rs Outdated
Comment threadrust/stackablectl/src/cmds/operator.rs Outdated
Comment threadrust/stackablectl/src/main.rs Outdated
Comment threadrust/stackablectl/src/main.rs Outdated
@xeniape
xeniape marked this pull request as ready for review May 19, 2025 12:42
@xeniapexeniape moved this to Development: Waiting for Review in Stackable EngineeringMay 19, 2025
NickLarsenNZ

This comment was marked as outdated.

Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com>
xeniapeand others added 10 commits May 19, 2025 15:07
@xeniapexeniape linked an issue May 23, 2025 that may be closed by this pull request
3 tasks
}

#[instrument(skip(cli, stack_list, transfer_client))]
#[instrument(skip(cli, stack_list, transfer_client), fields(indicatif.pb_show = true))]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Note to self, we should skip_all here, since args ends up looking so bad in the logs (since it uses the Debug impl). Nothing related to this PR though.

@NickLarsenNZNickLarsenNZ left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@NickLarsenNZNickLarsenNZ moved this from Development: Waiting for Review to Development: In Review in Stackable EngineeringMay 23, 2025
@xeniape
xeniape added this pull request to the merge queueMay 23, 2025
Merged via the queue into main with commit 380ba19May 23, 2025
@xeniape
xeniape deleted the feat/progress-reporting branch May 23, 2025 13:28
@NickLarsenNZNickLarsenNZ moved this from Development: In Review to Development: Done in Stackable EngineeringMay 23, 2025
@lfranckelfrancke moved this from Development: Done to Done in Stackable EngineeringMay 26, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

feat: Implement progress reporting with third-party tool stdout support

3 participants

@xeniape@NickLarsenNZ@lfrancke