Add core functionality for remote connection resolvers

overture-stack / arranger

Data portal API and component generation

https://www.overture.bio/documentation/arranger/

GNU Affero General Public License v3.0

29 stars 24 forks source link

Add core functionality for remote connection resolvers #880

Closed ciaranschutte closed 4 months ago

ciaranschutte commented 4 months ago

~~- adds basic resolver functionality for remote connections (does not hook them up yet)~~

add resolver functionality
add resolver method to resolver map
modify gql server to expose functionality
basic healthcheck/ping for remote connections (this can be expanded on if we want to introduce some "connection manager" functionality, holding the status in state and pinging from there)
resolver functionality can be memoized or potentially broken down into sub resolvers because we likely don't want to ping all servers so often for a gql query that may not need it (can discuss offline once I get a concrete example)
adds TS util type for const style maps
tested connecting to two remote connections
- both available
- 1 available, 1 not
- neither available

joneubank commented 4 months ago

RE: memoization - I have hesitations around serving stale data, but if we do see performance issues then adding a caching layer could be helpful. I say we build this out fully and then do some performance testing to see if there are situations where caching would help.

justincorrigible commented 4 months ago

Agreed. Some may argue this counts as premature optimisation, which in our case as Jon correctly puts it, puts Arranger at risk of serving outdated data, or even worse, stuff that was meant to not exist anymore (deleted or unpublished).

ciaranschutte commented 4 months ago

I think we should build out a bit more functionality to see how this connects with GQL to resolve requests before finalizing the review.

Taking this into account I will add the following:

returning async function that calls this created functionality
adding to resolver map to expose from gql server (for server)
modification to schema to expose functionality correctly

ciaranschutte commented 4 months ago

I think we should build out a bit more functionality to see how this connects with GQL to resolve requests before finalizing the review.

Updated with PR feedback and expanded to included these modifications: https://github.com/overture-stack/arranger/pull/880#issuecomment-2227720080

This should fulfil the "connecting to GQL" request. Let me know if you'd like it expanded more.