cmoresid / lightning-haskell Goto Github PK

Will need to determine what all is involved in displaying a plot in iHaskell.

Comment all the public facing functions in API.

Quickly run through each plot endpoint and make sure it doesn't blow up completely. Create bugs for each endpoint that doesn't work correctly or if you notice it has missing parameters, etc...

There are endpoints in the lightning-viz server that allows a user to delete plots.

There are currently no unit tests written. Hoping to have at least 80% code coverage.

Create a 'Maybe Visualization' field in the streaming plot records. This way, the plot request functions have one less parameter.

In Web.Lightning.Utilities, there are 2 functions, getLinks and getNodes that have no implementation. Once these 2 functions have been implemented, the adjacency, force, graph, and graph bundle plots should function correctly.

They need to be modelled after the two corresponding functions in the Scala API wrapper:

Scala Implementation of getLinks and getNodes

I would like it when a user executes runLightning with Nothing as its first parameter, to automatically create a new session and save it in the LightningState record.

Right now, the plot type parameters are not being validated at all. Need to come up with some sort of mechanism to validate the plot type parameters.

For example, when creating a map plot, the region names have to be 2 or 3 characters long. There is no mechanism to verify this.

Need to provide some helper functions to wrap up some of the configuration aspects of running the API. Too much code is required to create a session and plot. Should be easier to use.

Right now, only the unit tests are run in Travis CI. It would be nice to have the end-to-end (integration) tests run in Travis Ci.

This would require setting up NodeJS + Lightning-Viz server in Travis CI. Need to investigate how to do this.

No integration tests exist at the moment. Hoping to have at least 1 integration test for each plot, just for regression testing purposes.

Need to create wrappers for streaming line plot and streaming scatter plot. This will require further investigation to see how this can be implemented.