Packaging HTML/Javascript "application" for visualizing some json data

[Mark Wielaard]

Hi,

The next release of valgrind (3.15.0) will have an updated dhat tool
which creates a json output file. To make it easier to use the data it
comes with a small html/css/js "application" that makes it easy to
sort/visualize the data.

This html/css/js application is self-contained, it doesn't use any
other javascript code/libraries. It consists of 4 files:
dh_view.html, dh_view.css, dh_view.js and dh_test.js.

You can see all files at:
https://gnu.wildebeest.org/~mark/dh_view/

You would use it something like:
$ valgrind --tool=dhat /bin/sort < /usr/share/dict/words > /dev/null

Which generates a json file dhat.out.3759 (as attached).
Which you can then "load" into the dh_view.html app to see various
different representations of the data collected.

You can try it out on the attached file at:
https://gnu.wildebeest.org/~mark/dh_view/dh_view.html
By clicking "Load" and giving it a copy of the attache dhat.out.3759
file.

sort isn't a very interesting example since it doesn't have a very
complicated allocation pattern, but it should give you an idea of what
the visualization does.

But it isn't really meant as "web app", the idea is that the user runs
this locally in their own browser on their locally generated dhat.out
json files.

I am not sure how to properly package this little app/viewer thingy as
part of valgrind. There are the Java Script and Web Assets guidelines,
but those are really for web applications, which this isn't.

Is there an example that I could follow?

How would users discover where/how to load the html/js application?

We could make the valgrind --tool=dhat output a location of the
html/css/js to load (and the generated json file), but which file
system location is proper for it?

Thanks,

Mark

[John Reiser]

>  The next release of valgrind (3.15.0) will have an updated dhat tool
>  which creates a json output file. To make it easier to use the data it
>  comes with a small html/css/js "application" that makes it easy to
>  sort/visualize the data.
>  
>  This html/css/js application is self-contained, it doesn't use any
>  other javascript code/libraries. It consists of 4 files:
>  dh_view.html, dh_view.css, dh_view.js and dh_test.js. 
>  You would use it something like:
>  $ valgrind --tool=dhat /bin/sort < /usr/share/dict/words > /dev/null
>  
>  Which generates a json file dhat.out.3759 [was attached].
>  Which you can then "load" into the dh_view.html app to see various
>  different representations of the data collected. 
The output  dhat.out.3759  should be created in the current directory
or at the destination specified by valgrind's usual  --xml-*=<where>
command-line parameters.  This is no different from any other output
generated by valgrind.  The user will enter the URL to the browser
app's "load" command as  file://<path>  or as the result of a
"browse" dialog, much like File > Open.

The html/css/js "application" (4 files dh_view.html, dh_view.css,
dh_view.js and dh_test.js) belongs in a directory such as
  /usr/libexec/dhat .

[Mark Wielaard]

On Sat, Mar 23, 2019 at 07:07:53AM -0700, John Reiser wrote:
>  The output  dhat.out.3759  should be created in the current
> directory
>  or at the destination specified by valgrind's usual  --xml-*=<where>
>  command-line parameters.  This is no different from any other output
>  generated by valgrind. 
Yes, that makes sense.

>  The user will enter the URL to the browser
>  app's "load" command as  file://<path>  or as the result of a
>  "browse" dialog, much like File > Open. 
Right, where we would like to print out file://<path>/dh_view.html at
the end of the dhat run to tell users how to load the viewer.

>  The html/css/js "application" (4 files dh_view.html,
> dh_view.css,
>  dh_view.js and dh_test.js) belongs in a directory such as
>   /usr/libexec/dhat . 
OK, so given upstream uses autotools just install in something like
$(libexecdir)/valgrind/dhat/ ?

Thanks,

Mark