RDPC-GATEWAY

This service serves as the GraphQL API gateway for the Regional Data Processing Centre. The primary responsibility is to stitch the various data sources and microservices that constitute the RDPC infrastructure into a single unified GraphQL API.

Service List

The gateway "joins" together other Apollo GQL services (Apollo Federation) in the RDPC (Regional Data Processing Center) it is deployed in, unifying their various queries into one single API and enabling the use of cross-service enriching of data at query time.

Service Name	Environment Variable	Description	Git Repo	Queries	Mutations
workflows	WORKFLOW_SEARCH_URL	search for workflow runs in the RDPC	workflow-search	runs, tasks, aggregateRuns, aggregateTasks	N/A
workflow-management	WORKFLOW_MANAGEMENT_URL	manage (start/cancel) runs in the RDPC	workflow-management	N/A	startRun, cancelRun
song-search	SONG_SEARCH_URL	search for analyses and files indexed in RDPC SONG(s)	song-search	analyses, files, aggregateAnalyses, aggregateFiles, sampleMatchedAnalysisPairs	N/A

Example Query

An example of this dynamic join at query time is something like this:

{
  runs { // top level query resolved in workflow-search
    content {
      runId
      state
      producedAnalyses { // this field is resolved at query time with data from song-search
        analysisId
  		analysisType
        analysisState
      }
  }
}

Auth

Authorization headers are passed through to the underlying services to resolve as if the query was directly addressed to them. For example, in the case of JWT auth, if the underlying services have differently scoped permissions, and all the required scopes are not present in the request, you will only receive data from the services that have the appropriate scopes and an error response nested within the query response for the service where the scope was missing/invalid/unauthorized.

Tech Stack

• NodeJS
• Typescript
• Express
• Apollo GQL (Apollo Federation)

Build and Run

Quick Start

# Clone & Init
git clone [email protected]:icgc-argo/rdpc-gateway.git
npm i

# Env Variables (default localhost config)
cp .env.example .env

# Start Locally
npm start

Build

# Local
npm build

# Docker
docker build -t ##REPO##:##TAG## .

!! Important Note (Restart Required) !!

Any schema changes in the underlying services connected to rdpc-gateway will require a restart of the gateway in order to correctly stitch the schemas together.