Improve output during backup/flash process #281

CoryCharlton · 2024-06-19T20:28:56Z

Description

Improve output during backup/flash process.

Motivation and Context

It feels like the flashing process is taking much more time recently so this change allows the user to be confident that work is progressing (see: Nanoff - flash ESP32-S3 hangs Home#1510)

How Has This Been Tested?

Manually

Screenshots

Types of changes

Improvement (non-breaking change that improves a feature, code or algorithm)
Bug fix (non-breaking change which fixes an issue with code or algorithm)
New feature (non-breaking change which adds functionality to code)
Breaking change (fix or feature that would cause existing functionality to change)
Config and build (change in the configuration and build system, has no impact on code or features)
Dependencies (update dependencies and changes associated, has no impact on code or features)
Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

My code follows the code style of this project (only if there are changes in source code).
My changes require an update to the documentation (there are changes that require the docs website to be updated).
I have updated the documentation accordingly (the changes require an update on the docs in this repo).
I have read the CONTRIBUTING document.
I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
I have added new tests to cover my changes.

coderabbitai · 2024-06-19T20:29:02Z

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (2)

nanoFirmwareFlasher.Library/Esp32Operations.cs is excluded by none and included by none
nanoFirmwareFlasher.Library/EspTool.cs is excluded by none and included by none

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

torbacz · 2024-06-20T07:22:48Z

After Jose comment, I thought about the same. Great work!

josesimoes

Yes, simple and effective.

When coding the output with the progress on the various operations, I tried to get to a point where there wasn't too much noise and details and not enough information. This particular operation was one of my concerns. Now that it can potentially take a bit more time, I agree that it makes sense to show a detailed progress in normal diagnostics. After all, we code for humans not machines.

Having said that: the CLI still has to be usable on automated processes on which the absolute minimum output is preferred so it can be easily parsed.

@CoryCharlton bring back those open/close statements, just change the verbosity condition to less than normal and OK to have the new one about the backup operation.

torbacz · 2024-06-20T09:33:56Z

Not quite sure if it should be different than nomal. Normal user uses command in "normal mode" and should be aware that "something" is going on.

josesimoes · 2024-06-20T11:46:47Z

@torbacz you've lost me there... 🤪

My point is that I'm OK with showing the progress with normal verbosity (default). Not showing it when verbose is silent.
So, I suppose we are in agreement...

CoryCharlton · 2024-06-21T20:08:23Z

@CoryCharlton bring back those open/close statements, just change the verbosity condition to less than normal and OK to have the new one about the backup operation.

Hi @josesimoes , I'm not clear on what "open/close statements" you are referring to.

josesimoes · 2024-06-24T10:03:45Z

Hi @josesimoes , I'm not clear on what "open/close statements" you are referring to.

Probably not the best word choice in English... 😅 I'm referring to the output statements that "open" and "close" the operations, like

Console.Write($"Flashing firmware..."); <---- open

Console.WriteLine("OK"); <--- close

I was asking to have those back, just changing the condition to output them to verbosity less than normal, so the feedback of the operation still shows on those conditions.

CoryCharlton · 2024-06-24T17:32:09Z

Hi @josesimoes , I'm not clear on what "open/close statements" you are referring to.

Probably not the best word choice in English... 😅 I'm referring to the output statements that "open" and "close" the operations, like

Console.Write($"Flashing firmware..."); <---- open

Console.WriteLine("OK"); <--- close

I was asking to have those back, just changing the condition to output them to verbosity less than normal, so the feedback of the operation still shows on those conditions.

Understood.

That being said these weren't changed. The "Flashing firmware..." was moved from here to here so the "Backup configuration..." message could occur first.

The existing BackupConfigPartition call ignored failure so I did not add an "OK" message but that can be changed if we want.

josesimoes · 2024-06-25T08:29:25Z

@CoryCharlton I've just made some tweaks on this. Hope you're OK.
Despite ignoring the outcome of the backup operation we should keep a consistent look, otherwise can be confusing.

I've also adjusted the flashing output to be more consistent with the usual flow and have the full message there after the output of esptool. This will prevent breaking changes with any tools parsing the output.

If you're OK with all this, let's have this PR merged!

nanoFirmwareFlasher.Library/EspTool.cs

CoryCharlton · 2024-06-25T21:11:04Z

@josesimoes I further checked and refined the output. This is ready to be merged.

Here's the output of the tests I ran:

nanoff.exe --platform esp32 --serialport COM11 --update

.NET nanoFramework Firmware Flasher v2.5.88+4e6c5c3387
Copyright (C) 2019 .NET Foundation and nanoFramework project contributors

** There is a new version available, update is recommended **
** You should consider updating via the 'dotnet tool update -g nanoff' command **
** If you have it installed on a specific path please check the instructions here: https://git.io/JiU0C **

Reading details from chip...OK                                                                                                            

Connected to:
ESP32-S3 (ESP32-S3 (QFN56) (revision v0.1))
Features WiFi, BLE
Flash size 16MB W25Q128_V from WINBOND_NEX (manufacturer 0x239 device 0x16408)
PSRAM: undetermined
Crystal 40MHz
MAC F4:12:FA:42:03:2C


No target name was provided! Using 'ESP32_S3' based on the device characteristics.

Extracting ESP32_S3-1.9.1.224.zip...OK

Updating to 1.9.1.224

Backup configuration...OK                                                                                                            
Flashing firmware...OK                                                                                                            

Process finished with exit code 0.

nanoff.exe --platform esp32 --serialport COM11 --update --masserase

.NET nanoFramework Firmware Flasher v2.5.88+4e6c5c3387
Copyright (C) 2019 .NET Foundation and nanoFramework project contributors

** There is a new version available, update is recommended **
** You should consider updating via the 'dotnet tool update -g nanoff' command **
** If you have it installed on a specific path please check the instructions here: https://git.io/JiU0C **

Reading details from chip...OK                                                                                                            

Connected to:
ESP32-S3 (ESP32-S3 (QFN56) (revision v0.1))
Features WiFi, BLE
Flash size 16MB W25Q128_V from WINBOND_NEX (manufacturer 0x239 device 0x16408)
PSRAM: undetermined
Crystal 40MHz
MAC F4:12:FA:42:03:2C


No target name was provided! Using 'ESP32_S3' based on the device characteristics.

Extracting ESP32_S3-1.9.1.224.zip...OK

Updating to 1.9.1.224

Erasing flash...OK                                                                                                            
Flashing firmware...OK                                                                                                            

Process finished with exit code 0.

josesimoes

Looks perfect now! Thanks for the final touch. 👍🏻

Improve output during backup/flash process

99fa437

nfbot added the Type: enhancement label Jun 19, 2024

josesimoes requested changes Jun 20, 2024

View reviewed changes

Improve output during backup/flash process

dd7153a

CoryCharlton force-pushed the improve_output branch from 99fa437 to dd7153a Compare June 24, 2024 17:26

CoryCharlton and others added 2 commits June 24, 2024 10:32

Merge remote-tracking branch 'origin/improve_output' into improve_output

21c0583

Tweaking progress output

7bcc43f

CoryCharlton added 2 commits June 25, 2024 13:34

Merge remote-tracking branch 'origin/improve_output' into improve_output

63678c1

Further refinement of the output

a9d8f76

CoryCharlton commented Jun 25, 2024

View reviewed changes

nanoFirmwareFlasher.Library/EspTool.cs Outdated Show resolved Hide resolved

nanoFirmwareFlasher.Library/EspTool.cs Show resolved Hide resolved

josesimoes approved these changes Jun 26, 2024

View reviewed changes

josesimoes merged commit c66e018 into nanoframework:main Jun 26, 2024
4 checks passed

CoryCharlton deleted the improve_output branch June 26, 2024 14:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve output during backup/flash process #281

Improve output during backup/flash process #281

CoryCharlton commented Jun 19, 2024

coderabbitai bot commented Jun 19, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

torbacz commented Jun 20, 2024

josesimoes left a comment

torbacz commented Jun 20, 2024

josesimoes commented Jun 20, 2024

CoryCharlton commented Jun 21, 2024

josesimoes commented Jun 24, 2024

CoryCharlton commented Jun 24, 2024 •

edited

Loading

josesimoes commented Jun 25, 2024

CoryCharlton commented Jun 25, 2024

josesimoes left a comment

Improve output during backup/flash process #281

Improve output during backup/flash process #281

Conversation

CoryCharlton commented Jun 19, 2024

Description

Motivation and Context

How Has This Been Tested?

Screenshots

Types of changes

Checklist:

coderabbitai bot commented Jun 19, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

torbacz commented Jun 20, 2024

josesimoes left a comment

Choose a reason for hiding this comment

torbacz commented Jun 20, 2024

josesimoes commented Jun 20, 2024

CoryCharlton commented Jun 21, 2024

josesimoes commented Jun 24, 2024

CoryCharlton commented Jun 24, 2024 • edited Loading

josesimoes commented Jun 25, 2024

CoryCharlton commented Jun 25, 2024

josesimoes left a comment

Choose a reason for hiding this comment

CodeRabbit Configration File (`.coderabbit.yaml`)

CoryCharlton commented Jun 24, 2024 •

edited

Loading