Skip to content
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.

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

change(ui): Enable the progress bar feature by default, but only show progress bars when the config is enabled #7615

Merged
merged 17 commits into from Oct 12, 2023

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Sep 25, 2023

TODO

After this PR merges, add:

  • A changelog feature entry asking for user testing
  • A post on the forums encouraging users to test it after it is released, and mentioning the known issue with estimates
  • A mention in the Arborist call

Motivation

Currently the progress-bars feature turns on progress bars and file logging when it is enabled.

To make it easier for users to test progress bars, we can make the progress bars configurable with zebrad.toml. This allows us to compile the progress-bar feature by default, but not activate it for every user by default.

(Activating progress bars by default could be a breaking change for some users that expect Zebra to write logs to standard output.)

Close #7363
Close #7364

Complex Code or Requirements

When the progress bar feature is activated, the log file also needs to be activated (unless the user has specifically turned it off).

I added a summary and detailed config, because we might want to have an "expert" mode. But we need to know what users want first!

Solution

  • Add a config for progress bars, which is only used when the progress-bars feature is enabled
    • If they are not enabled, log a message telling users how to enable them in the config
    • Document how to enable them in the README
  • Enable the progress-bars feature by default in Zebra builds

Testing

  • Add a config with progress bars enabled to the config tests
  • Make the config tests handle log files correctly
  • Check the config path in the config tests

Review

This is a low priority feature, it doesn't need to go in the 1.3.0 release.

Reviewer Checklist

  • Will the PR name make sense to users?
    • Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
    • Does it change concurrent code, unsafe code, or consensus rules?
  • How do you know it works? Does it have tests?

Follow Up Work

Work out which progress bars users want.

@teor2345 teor2345 added C-enhancement Category: This is an improvement P-Low ❄️ I-usability Zebra is hard to understand or use A-diagnostics Area: Diagnosing issues or monitoring performance labels Sep 25, 2023
@teor2345 teor2345 requested review from a team as code owners September 25, 2023 02:45
@teor2345 teor2345 self-assigned this Sep 25, 2023
@teor2345 teor2345 requested review from arya2 and removed request for a team September 25, 2023 02:45
@github-actions github-actions bot added the C-feature Category: New features label Sep 25, 2023
@teor2345 teor2345 changed the title change(ui): Enable the progress bar feature by default, but require a config to activate them change(ui): Enable the progress bar feature by default, and add a config for it Sep 25, 2023
@upbqdn upbqdn added do-not-merge Tells Mergify not to merge this PR and removed do-not-merge Tells Mergify not to merge this PR labels Sep 25, 2023
@teor2345 teor2345 changed the title change(ui): Enable the progress bar feature by default, and add a config for it change(ui): Enable the progress bar feature by default, but only show progress bars when the config is enabled Sep 26, 2023
@oxarbitrage oxarbitrage self-requested a review September 28, 2023 19:16
arya2

This comment was marked as resolved.

oxarbitrage

This comment was marked as resolved.

@teor2345

This comment was marked as resolved.

@arya2

This comment was marked as off-topic.

@teor2345

This comment was marked as off-topic.

@teor2345

This comment was marked as resolved.

arya2
arya2 previously approved these changes Oct 5, 2023
@teor2345 teor2345 added do-not-merge Tells Mergify not to merge this PR and removed do-not-merge Tells Mergify not to merge this PR labels Oct 5, 2023
@teor2345

This comment was marked as resolved.

@teor2345 teor2345 marked this pull request as draft October 9, 2023 04:07
@teor2345 teor2345 added the do-not-merge Tells Mergify not to merge this PR label Oct 9, 2023
@teor2345 teor2345 marked this pull request as ready for review October 10, 2023 03:13
@teor2345

This comment was marked as resolved.

@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Oct 10, 2023
mergify bot added a commit that referenced this pull request Oct 11, 2023
@mergify mergify bot merged commit ae52e3d into main Oct 12, 2023
176 checks passed
@mergify mergify bot deleted the prog-conf branch October 12, 2023 00:25
@teor2345
Copy link
Contributor Author

TODO

After this PR merges, add:

  • A changelog feature entry asking for user testing
  • A post on the forums encouraging users to test it after it is released, and mentioning the known issue with estimates
  • A mention in the Arborist call

I have done the first task in PR #7610, I'll put the rest in the appropriate Slack channels.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-diagnostics Area: Diagnosing issues or monitoring performance C-enhancement Category: This is an improvement C-feature Category: New features C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG I-usability Zebra is hard to understand or use
Projects
None yet
4 participants