Skip to content

IEP-1073: Tools installation download progress now shows text based progress bar #860

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Dec 7, 2023
Merged

IEP-1073: Tools installation download progress now shows text based progress bar #860

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7c2a84e
IEP-1073: Tools installation new line percentages now show a text bas…
alirana01 Nov 28, 2023
87efa7a
testing the runner
alirana01 Nov 29, 2023
104c46d
update to fix spacing errors for the testing of the rdp for windows
alirana01 Nov 29, 2023
93a3bd7
Revert "update to fix spacing errors for the testing of the rdp for w…
alirana01 Nov 29, 2023
8c8648f
Revert "testing the runner"
alirana01 Nov 29, 2023
4d25c51
testing on self-hosted runner
alirana01 Nov 29, 2023
baacb34
updated to v5.1 for windows tesst
alirana01 Nov 29, 2023
3553fe7
update to windows runner and removal of unwanted tests
alirana01 Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/ci_windows.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ on:
jobs:
build_windows:

runs-on: windows-latest
runs-on:
- self-hosted
- ali-test

steps:

Expand All @@ -24,7 +26,7 @@ jobs:
repository: espressif/esp-idf
path: dependencies/idf-tools
submodules: 'true'
ref: v4.4
ref: v5.1

- name: Set up Python
uses: actions/setup-python@v2
Expand Down
12 changes: 10 additions & 2 deletions bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/IDFConsole.java
View file
Open in desktop
Copy link
Collaborator Author

@alirana01 alirana01 Nov 28, 2023

Choose a reason for hiding this comment

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

I added a new method to specifically set the control chars handle to true to make sure that the other areas using the getConsoleStream() don't break anything.

Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,13 @@ public MessageConsoleStream getConsoleStream()
{
return getConsoleStream("ESP-IDF Console", null, false); //$NON-NLS-1$
}
public MessageConsoleStream getConsoleStream(String consoleName, URL imageUrl, boolean errorStream)

public MessageConsoleStream getConsoleStream(String consoleName, URL imageUrl, boolean errorStream, boolean handleControlChars)
{
// Create Tools console
MessageConsole msgConsole = findConsole(consoleName, imageUrl);
msgConsole.setHandleControlCharacters(handleControlChars);
msgConsole.setCarriageReturnAsControlCharacter(handleControlChars);
msgConsole.clearConsole();
MessageConsoleStream console = msgConsole.newMessageStream();
msgConsole.activate();
Expand All @@ -55,6 +57,12 @@ public void run()
return console;
}


public MessageConsoleStream getConsoleStream(String consoleName, URL imageUrl, boolean errorStream)
{
return getConsoleStream(consoleName, imageUrl, errorStream, false);
}

/**
* Find a console for a given name. If not found, it will create a new one and return
*
Expand Down
39 changes: 38 additions & 1 deletion bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/InputStreamConsoleThread.java
View file
Open in desktop
Copy link
Collaborator Author

@alirana01 alirana01 Nov 28, 2023

Choose a reason for hiding this comment

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

This class was only being used in context of tools installation so its safe to modify this to read the progress but it heavily relies on the idf_tools.py script to have the same output as it does now. Better way would be when we get a machine readable output of that script it will handle things much better

Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,14 @@ public void run()
String line = null;
while ((line = br.readLine()) != null)
{
console.println(line);
if (line.matches("^\\d+%$"))
{
updateProgressBar(line);
}
else
{
console.println(line);
}
}
}
catch (IOException e)
Expand All @@ -63,4 +70,34 @@ public void run()
}
}
}

private void updateProgressBar(String progressLine)
{
// Extract the numeric value of the progress
int progress = Integer.parseInt(progressLine.replace("%", ""));
StringBuilder progressBar = new StringBuilder("[");

// Assuming a 50-char wide progress bar for illustration
int totalBars = 50;
int filledBars = (progress * totalBars) / 100;

for (int i = 0; i < totalBars; i++)
{
if (i < filledBars)
{
progressBar.append("=");
}
else if (i == filledBars)
{
progressBar.append(">");
}
else
{
progressBar.append(" ");
}
}
progressBar.append("] ").append(progress).append("%");
console.print("\r" + progressBar.toString());
}

}
8 changes: 5 additions & 3 deletions bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/AbstractToolsHandler.java
View file
Open in desktop
Copy link
Collaborator Author

@alirana01 alirana01 Nov 28, 2023

Choose a reason for hiding this comment

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

I didn't understand the need to create two different console objects even when they are returning the same console. So I added a class level property for the IDFConsole and used the updated method in class to explicitly allow the handling of control chars like carriage return \r that I am using in the InputStreamConsoleThread to overwrite the existing progress when updated

Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public abstract class AbstractToolsHandler extends AbstractHandler
/**
* Tools console
*/
private IDFConsole idfConsole;
protected MessageConsoleStream console;
protected MessageConsoleStream errorConsoleStream;
protected String idfPath;
Expand Down Expand Up @@ -113,9 +114,10 @@ public Object execute(ExecutionEvent event) throws ExecutionException

protected void activateIDFConsoleView()
{
console = new IDFConsole().getConsoleStream(Messages.IDFToolsHandler_ToolsManagerConsole, null, false);
errorConsoleStream = new IDFConsole().getConsoleStream(Messages.IDFToolsHandler_ToolsManagerConsole, null,
true);
idfConsole = new IDFConsole();
console = idfConsole.getConsoleStream(Messages.IDFToolsHandler_ToolsManagerConsole, null, false, true);
errorConsoleStream = idfConsole.getConsoleStream(Messages.IDFToolsHandler_ToolsManagerConsole, null,
true, true);
}

protected String getPythonExecutablePath()
Expand Down