E.showMessage Progress?

[RKBoss6]

Mentioned in espruino/EspruinoAppLoaderCore#85, E.showMessage can show a progress bar now with upload progress. However, I couldn't find much documentation on the the {progress:xxx} option, and was messing around with it for a while trying to get it to show progress. Is there a way to get the E.showMessage to show a progress value at will (eg. showing 20%, or 50%), to be used to show loading/progress outside of uploading and bytes?

Edit: Looked a bit closer, and from what I can tell, uses E.packet event to update itself. Just a thought, but it makes a lot of sense in my mind to have an option to draw a progress bar as an option with a specified percent (progress:0.2).

Of course, we can draw the progress bar manually, but it'd be quite useful as a built in option for consistency across apps, and as an additional way to draw progress bars quickly and efficiently. @gfwilliams wdyt? You and I have disagreed on opinions like this, so just getting a second perspective :)

[ryux1]

The option is uploadProgress, not progress, and its value is the total number of bytes expected, not a fraction between 0 and 1.

For example, the App Loader currently calls E.showMessage(..., { uploadProgress: bytes }) before sending the files. Inside E.showMessage, the implementation starts its own counter at zero, listens for E.packetUpload, adds each packet's e.l, and draws bytes / options.uploadProgress (source).

So this works for an upload whose total size is known:

E.showMessage("Uploading...", { uploadProgress: totalBytes });

But it cannot currently be set to an arbitrary value such as 20% or 50%. uploadProgress: 0.2 means “the upload totals 0.2 bytes”; it does not mean 20%. For non-packet work, manually drawing the bar is currently the available approach. A general percentage/value option would be a separate feature from the packet-driven uploadProgress behavior.

[gfwilliams]

As @ryux1 says really.

The code is at https://github.com/espruino/Espruino/blob/master/libs/js/banglejs/E_showMessage.js

If you do:

E.showMessage("Uploading...", { uploadProgress: 100 });
E.emit("packetUpload",{l:10})

You can force it to work by faking the upload packets. It's not great, but I guess it's ok if you want a progress bar and want to re-use functionality. Not that your code would have to be async for it to work. I guess maybe the thing might be to make a simple module in the modules folder to do it and then at least if things changed we wouldn't have to update every app