I wish to work on the idea of creating a web dashboard for the Newman Task Runner this summer. The importance of having an aesthetic GUI can be of paramount importance for newcomers and better visualizations for the experienced ones.
I would be happy if I can get further guidance on this idea so we can start working on this feature.
Currently, in the newman package, we only have a newman.run() feature to start processing the collection. This uses run.start(callbacks) whose implementation is in the postman-runtime library.
Hence, digging deep into the code of postman-runtime, I found out that the Run object provided by this library has a key called commands. This enables run.commands.pause(), run.commands.abort() and run.commands.resume() to be called from the newman package.
However, we do not use these functions currently in the newman package. I believe we can set a listener on the emitter object which listens for pauseabort and resume events and call these functions accordingly.
Similar to these events, we can create another events which we can call through the emitter object returned by newman.run().
@zerefwayne Glad that you’re interested. You’re definitely looking in the right direction. We do want to make a dashboard which can be used by newcomers and advanced users alike. I think we can start small by building a small webpage which shows the currently executing Newman runs + allowing basic actions like stop, pause, etc.
This can then be improved by allowing users to inspect the whole runs in the dashboard itself!
I would be happy to work with you to refine this idea if you can begin by writing a draft proposal on Google Docs and share a link with commenting turned on.
Thank you for the heads up @utkarsh.maheshwari, I’ve started drafting the proposal and shared it with email@example.com with the correct permissions. The core ideas have been written in the document however it is still WIP.