find / make a tool to help write and test JQ strings for BTE's use

[colleenXu]

(From first JQ issue + discussions Jackson @tokebe and I have had)

Jackson says it's difficult to write and test JQ strings for BTE's implementation. I haven't tried yet, but I agree that it's a learning curve to read JQ strings...what can we do to make this easier for us and future contributors?

Jackson suggested a "testing tool".

Any ideas, @rjawesome @newgene ?

[tokebe]

I had a slightly more specific idea here -- essentially, the problem isn't JQ, rather it's the information (and structure of the information) available to the JQ string (the $edge variable, and the structure of the API response), as well as the expected output, all being somewhat vague and hard to capture for use in a testing tool like https://jqplay.org/.

Essentially I'm imagining a framework that allows for testing a JQ string with the data all prepared, so that a potential user wouldn't have to rely on breakpoints and/or BTE logs for debugging their JQ string.

This could be as simple as a document explaining some of this and providing a template JQ command to run in the command line to test. A more in-depth approach could be a script that handles some of the processing to prepare that command and simulate the conditions under which the string would be used.

[tokebe]

@rjawesome If you have any input on how you tested your JQ strings while writing them, it could provide some insight on how to approach making testing documentation/a testing tool/script. Otherwise, I can just use what I threw together while working on CTD's JQ string as a basis.

[rjawesome]

I'm working on a testing tool.

[rjawesome]

See: https://bte-jq.rohanj.dev/
(probably could use some css)

[tokebe]

This is a very good start! I think that we'd probably prefer a locally-runnable application (so a user could expect to use npm run jq-tester in the main workspace).

Additionally, while it's nice that there's an example for $edge, if a user writing such a jq string needed to provide one to test certain functionality, they'd need to obtain it basically by setting breakpoints in a BTE query and copying it. This isn't a reasonable expectation, so we'd probably want something that could automatically convert an x-bte snippet to the $edge format, or something else to make it easy for the user to generate the $edge data. This could make use of the smartapi-kg package to make a conversion, or some bespoke code if necessary.

[rjawesome]

A feature has been added on the website to generate edge from a full smartapi yaml using smartapi-kg package: https://bte-jq.rohanj.dev/create_edge.html. It still needs an input field for the query graph to be used for reasoner edge property of edge. Also I will integrate this into the BTE project soon.

[tokebe]

@rjawesome Given ongoing potential changes, you should hold up on further work on this issue until the path forward is clear.