feat(config): configuration override using env vars, enable/disable graphiql via config (#519)

Closes #508 

## TODO
- [x] setup nice way to define env vars and their overrides
- [x] Define logger overrides
- [x] Define supergraph overrides (file/hive)
- [x] Define HTTP overrides
- [x] Remove existing `config` extractor
- [x] Fix printing of error message in cases where server fails to start
and logger is not configured yet
- [x] graphiql disable/enable
- [x] hive supergraph poll interval
- [x] Fix CI
- [x] Update docs and README 
- [x] Docs graphql-hive/console#7172

Author: dotansimha

.github/workflows/build.yaml

@@ -218,8 +218,7 @@ jobs:
           echo "Docker image: ${{ env.DOCKER_IMAGE_NAME }}@${{ needs.docker.outputs.docker_image_digest }}"
 
           docker run -d --name router -p 4000:4000 \
-          -e HIVE__SUPERGRAPH__SOURCE="file" \
-          -e HIVE__SUPERGRAPH__PATH="/app/supergraph.graphql" \
+          -e SUPERGRAPH_FILE_PATH="/app/supergraph.graphql" \
           -v ./bench/supergraph.graphql:/app/supergraph.graphql \
             ${{ env.DOCKER_IMAGE_NAME }}@${{ needs.docker.outputs.docker_image_digest }}
 

.github/workflows/ci.yaml

@@ -130,8 +130,7 @@ jobs:
       - name: Run router
         run: ./target/release/hive_router & sleep 5
         env:
-          HIVE__SUPERGRAPH__SOURCE: file
-          HIVE__SUPERGRAPH__PATH: bench/supergraph.graphql
+          SUPERGRAPH_FILE_PATH: bench/supergraph.graphql
       - name: Run k6 benchmark
         run: k6 run bench/k6.js
 

Cargo.lock

@@ -35,8 +35,7 @@ supergraph:
 Alternativly, you can use environment variables to configure the router:
 
 ```env
-HIVE__SUPERGRAPH__SOURCE=file
-HIVE__SUPERGRAPH__PATH=./supergraph.graphql
+SUPERGRAPH_FILE_PATH=./supergraph.graphql
 ```
 
 Then, run the router:
@@ -58,8 +57,7 @@ The router image is being published to [Docker to GitHub Container Registry]().
 ```bash
 docker run \
   -p 4000:4000 \
-  -e HIVE__SUPERGRAPH__SOURCE="file" \
-  -e HIVE__SUPERGRAPH__PATH="/app/supergraph.graphql" \
+  -e SUPERGRAPH_FILE_PATH="/app/supergraph.graphql" \
   -v ./my-supergraph.graphql:/app/supergraph.graphql \
   ghcr.io/graphql-hive/router:latest
 ```

README.md

@@ -5,7 +5,7 @@
   "scripts": {
     "test:federation-all": "graphql-federation-audit test --run-script=\"./run-router.sh\" --graphql=\"http://localhost:4000/graphql\" --healthcheck=\"http://localhost:4000/health\" --junit",
     "test:federation-single": "graphql-federation-audit test-suite --run-script=\"./run-router.sh\" --graphql=\"http://localhost:4000/graphql\" --healthcheck=\"http://localhost:4000/health\" --write=\"federation-audit-results.txt\"",
-    "start:test-router": "cd .. && HIVE__SUPERGRAPH__SOURCE=file HIVE__SUPERGRAPH__PATH=lib/query-planner/fixture/spotify-supergraph.graphql cargo router",
+    "start:test-router": "cd .. && SUPERGRAPH_FILE_PATH=lib/query-planner/fixture/spotify-supergraph.graphql cargo router",
     "test:graphql-over-http": "node --test graphql-over-http.test.js",
     "test-junit:graphql-over-http": "node --test --test-reporter=junit --test-reporter-destination=\"./reports/graphql-over-http.xml\" graphql-over-http.test.js",
     "ci:test:graphql-over-http": "start-server-and-test start:test-router http://localhost:4000 test-junit:graphql-over-http"

audits/package.json

@@ -11,6 +11,5 @@ echo "running router..."
 
 cd ..
 
-export HIVE__SUPERGRAPH__SOURCE="file"
-export HIVE__SUPERGRAPH__PATH="audits/fed-audit-supergraph.graphql"
+export SUPERGRAPH_FILE_PATH="audits/fed-audit-supergraph.graphql"
 cargo router

audits/run-router.sh

@@ -3,8 +3,7 @@
 ```
 cargo subgraphs
 
-export HIVE__SUPERGRAPH__SOURCE="file"
-export HIVE__SUPERGRAPH__PATH="bench/supergraph.graphql"
+export SUPERGRAPH_FILE_PATH="bench/supergraph.graphql"
 cargo router
 ```
 

bench/README.md

@@ -5,5 +5,12 @@ static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc;
 
 #[ntex::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    router_entrypoint().await
+    match router_entrypoint().await {
+        Ok(_) => Ok(()),
+        Err(err) => {
+            eprintln!("Failed to start Hive Router:\n  {}", err);
+
+            Err(err)
+        }
+    }
 }

bin/router/src/main.rs

@@ -53,9 +53,13 @@ pub async fn graphql_request_handler(
     schema_state: &Arc<SchemaState>,
 ) -> web::HttpResponse {
     if req.method() == Method::GET && req.accepts_content_type(*TEXT_HTML_CONTENT_TYPE) {
-        return web::HttpResponse::Ok()
-            .header(CONTENT_TYPE, *TEXT_HTML_CONTENT_TYPE)
-            .body(GRAPHIQL_HTML);
+        if shared_state.router_config.graphiql.enabled {
+            return web::HttpResponse::Ok()
+                .header(CONTENT_TYPE, *TEXT_HTML_CONTENT_TYPE)
+                .body(GRAPHIQL_HTML);
+        } else {
+            return web::HttpResponse::NotFound().into();
+        }
     }
 
     if let Some(jwt) = &shared_state.jwt_auth_runtime {

bin/router/src/pipeline/mod.rs

@@ -37,8 +37,7 @@ Use the following command to run the Docker image locally:
 
 ```bash
 docker run -p 4000:4000 \
-  -e HIVE__SUPERGRAPH__SOURCE="file" \
-  -e HIVE__SUPERGRAPH__PATH="/app/supergraph.graphql" \
+  -e SUPERGRAPH_FILE_PATH="/app/supergraph.graphql" \
   -v ./bench/supergraph.graphql:/app/supergraph.graphql \
   <ID_OF_THE_LOCAL_IMAGE>
 ```