graph-explorer icon indicating copy to clipboard operation
graph-explorer copied to clipboard

[Project] Better integration of client and server

Open kmcginnes opened this issue 7 months ago • 0 comments

The client React code is hosted by the proxy server by default. This means they are already linked together. We can more tightly integrate these two sides making configuration simpler, client side logic simpler, and the user experience better.

Default Connection Configuration

Currently, the default connection is configured in a myriad of ways.

  • Environment values set at docker run time
  • Environment values set in .env file
  • A config.json file that sets environment values

Then a Bash script interprets all of these options and generates a defaultConnection.json file. That file is then served as a static file by the /defaultConnection endpoint in Express.

Instead, I propose simplifying the approach a bit. The /defaultConnection endpoint can read the environment values, validate them, and generate the proper JSON object to send to the client. This removes complex and brittle Bash code to parse and manipulate JSON files and provides an easier path to testing the logic.

tRPC

Use tRPC for the client to server connection will add a layer of type safety and a consistent way to deal with parameter validation and errors.

It is also a chance to reconfigure how the client connects to the server.

Tasks

  • [x] #538
  • [ ] #507
  • [ ] #537
  • [ ] #539
  • [ ] [Task] Test tRPC setup in Neptune Notebook
  • [ ] [Task] Convert logging endpoint to tRPC
  • [ ] [Task] Convert default connection endpoint to tRPC
  • [ ] [Task] Convert summary endpoint to tRPC
  • [ ] [Task] Convert gremlin endpoint to tRPC
  • [ ] [Task] Convert cypher endpoint to tRPC
  • [ ] [Task] Convert sparql endpoint to tRPC

kmcginnes avatar Jul 24 '24 17:07 kmcginnes