fix CI and README

dotansimha · dotansimha · commit 114b22fa1f3e · 2025-10-26T15:41:54.000+02:00
diff --git a/.github/workflows/build.yaml b/.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 }}
 
diff --git a/.github/workflows/ci.yaml b/.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
 
diff --git a/README.md b/README.md
@@ -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
 ```
diff --git a/audits/package.json b/audits/package.json
@@ -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"
diff --git a/audits/run-router.sh b/audits/run-router.sh
@@ -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
diff --git a/bench/README.md b/bench/README.md
@@ -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
 ```
 
diff --git a/bin/router/src/pipeline/mod.rs b/bin/router/src/pipeline/mod.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 {
diff --git a/docker/README.md b/docker/README.md
@@ -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>
 ```
diff --git a/docs/README.md b/docs/README.md
@@ -6,6 +6,7 @@
 |----|----|-----------|--------|
 |[**cors**](#cors)|`object`|Configuration for CORS (Cross-Origin Resource Sharing).<br/>Default: `{"allow_any_origin":false,"allow_credentials":false,"enabled":false,"policies":[]}`<br/>|yes|
 |[**csrf**](#csrf)|`object`|Configuration for CSRF prevention.<br/>Default: `{"enabled":false,"required_headers":[]}`<br/>||
+|[**graphiql**](#graphiql)|`object`|Configuration for the GraphiQL interface.<br/>Default: `{"enabled":true}`<br/>||
 |[**headers**](#headers)|`object`|Configuration for the headers.<br/>Default: `{}`<br/>||
 |[**http**](#http)|`object`|Configuration for the HTTP server/listener.<br/>Default: `{"host":"0.0.0.0","port":4000}`<br/>||
 |[**jwt**](#jwt)|`object`, `null`|Configuration for JWT authentication plugin.<br/>|yes|
@@ -36,6 +37,8 @@ csrf:
   enabled: true
   required_headers:
     - x-csrf-token
+graphiql:
+  enabled: true
 headers:
   all:
     request:
@@ -328,6 +331,26 @@ A valid HTTP header name, according to RFC 7230.
 
 **Item Type:** `string`  
 **Item Pattern:** `^[A-Za-z0-9!#$%&'*+\-.^_\`\|~]+$`  
+<a name="graphiql"></a>
+## graphiql: object
+
+Configuration for the GraphiQL interface.
+
+
+**Properties**
+
+|Name|Type|Description|Required|
+|----|----|-----------|--------|
+|**enabled**|`boolean`|Enables/disables the GraphiQL interface. By default, the GraphiQL interface is enabled.<br/><br/>You can override this setting by setting the `GRAPHIQL_ENABLED` environment variable to `true` or `false`.<br/>Default: `true`<br/>||
+
+**Additional Properties:** not allowed  
+**Example**
+
+```yaml
+enabled: true
+
+```
+
 <a name="headers"></a>
 ## headers: object
 
@@ -1304,8 +1327,8 @@ Configuration for the HTTP server/listener.
 
 |Name|Type|Description|Required|
 |----|----|-----------|--------|
-|**host**|`string`|The host address to bind the HTTP server to.<br/>Default: `"0.0.0.0"`<br/>||
-|**port**|`integer`|The port to bind the HTTP server to.<br/><br/>If you are running the router inside a Docker container, please ensure that the port is exposed correctly using `-p <host_port>:<container_port>` flag.<br/>Default: `4000`<br/>Format: `"uint16"`<br/>Minimum: `0`<br/>Maximum: `65535`<br/>||
+|**host**|`string`|The host address to bind the HTTP server to.<br/><br/>Can also be set via the `HOST` environment variable.<br/>Default: `"0.0.0.0"`<br/>||
+|**port**|`integer`|The port to bind the HTTP server to.<br/><br/>Can also be set via the `PORT` environment variable.<br/><br/>If you are running the router inside a Docker container, please ensure that the port is exposed correctly using `-p <host_port>:<container_port>` flag.<br/>Default: `4000`<br/>Format: `"uint16"`<br/>Minimum: `0`<br/>Maximum: `65535`<br/>||
 
 **Additional Properties:** not allowed  
 **Example**
@@ -1499,9 +1522,9 @@ The router is configured to be mostly silent (`info`) level, and will print only
 
 |Name|Type|Description|Required|
 |----|----|-----------|--------|
-|**filter**|`string`, `null`|||
-|**format**|`string`|Default: `"json"`<br/>Enum: `"pretty-tree"`, `"pretty-compact"`, `"json"`<br/>||
-|**level**|`string`|Default: `"info"`<br/>Enum: `"trace"`, `"debug"`, `"info"`, `"warn"`, `"error"`<br/>||
+|**filter**|`string`, `null`|The filter to apply to log messages.<br/><br/>Can also be set via the `LOG_FILTER` environment variable.<br/>||
+|**format**|`string`|The format of the log messages.<br/><br/>Can also be set via the `LOG_FORMAT` environment variable.<br/>Default: `"json"`<br/>Enum: `"pretty-tree"`, `"pretty-compact"`, `"json"`<br/>||
+|**level**|`string`|The level of logging to use.<br/><br/>Can also be set via the `LOG_LEVEL` environment variable.<br/>Default: `"info"`<br/>Enum: `"trace"`, `"debug"`, `"info"`, `"warn"`, `"error"`<br/>||
 
 **Additional Properties:** not allowed  
 **Example**
@@ -1593,7 +1616,7 @@ The path can be either absolute or relative to the router's working directory.
 
 |Name|Type|Description|Required|
 |----|----|-----------|--------|
-|**path**|`string`|Format: `"path"`<br/>|yes|
+|**path**|`string`|The path to the supergraph file.<br/><br/>Can also be set using the `SUPERGRAPH_FILE_PATH` environment variable.<br/>Format: `"path"`<br/>|yes|
 |[**poll\_interval**](#option1poll_interval)|`object`, `null`|Optional interval at which the file should be polled for changes.<br/>|yes|
 |**source**|`string`|Constant Value: `"file"`<br/>|yes|
 
@@ -1615,8 +1638,8 @@ Loads a supergraph from Hive Console CDN.
 
 |Name|Type|Description|Required|
 |----|----|-----------|--------|
-|**endpoint**|`string`|The CDN endpoint from Hive Console target.<br/>|yes|
-|**key**|`string`|The CDN Access Token with from the Hive Console target.<br/>|yes|
+|**endpoint**|`string`|The CDN endpoint from Hive Console target.<br/><br/>Can also be set using the `HIVE_CDN_ENDPOINT` environment variable.<br/>|yes|
+|**key**|`string`|The CDN Access Token with from the Hive Console target.<br/><br/>Can also be set using the `HIVE_CDN_KEY` environment variable.<br/>|yes|
 |[**poll\_interval**](#option2poll_interval)|`object`|Interval at which the Hive Console should be polled for changes.<br/>Default: `"10s"`<br/>|yes|
 |[**retry\_policy**](#option2retry_policy)|`object`|Interval at which the Hive Console should be polled for changes.<br/>Default: `{"max_retries":10}`<br/>|yes|
 |**source**|`string`|Constant Value: `"hive"`<br/>|yes|
@@ -1660,6 +1683,8 @@ If not provided, the file will only be loaded once when the router starts.
 
 Interval at which the Hive Console should be polled for changes.
 
+Can also be set using the `HIVE_CDN_POLL_INTERVAL` environment variable.
+
 
 **Properties**
 
diff --git a/lib/router-config/src/env_overrides.rs b/lib/router-config/src/env_overrides.rs
@@ -14,6 +14,10 @@ pub struct EnvVarOverrides {
     #[envconfig(from = "LOG_FILTER")]
     pub log_filter: Option<String>,
 
+    // GraphiQL overrides
+    #[envconfig(from = "GRAPHIQL_ENABLED")]
+    pub graphiql_enabled: Option<bool>,
+
     // HTTP overrides
     #[envconfig(from = "PORT")]
     pub http_port: Option<u64>,
@@ -27,6 +31,8 @@ pub struct EnvVarOverrides {
     pub hive_console_cdn_endpoint: Option<String>,
     #[envconfig(from = "HIVE_CDN_KEY")]
     pub hive_console_cdn_key: Option<String>,
+    #[envconfig(from = "HIVE_CDN_POLL_INTERVAL")]
+    pub hive_console_cdn_poll_interval: Option<String>,
 }
 
 #[derive(Debug, thiserror::Error)]
@@ -85,6 +91,17 @@ impl EnvVarOverrides {
             } else {
                 return Err(EnvVarOverridesError::MissingRequiredEnvVar("HIVE_CDN_KEY"));
             }
+
+            if let Some(hive_console_cdn_poll_interval) = self.hive_console_cdn_poll_interval.take()
+            {
+                config = config
+                    .set_override("supergraph.poll_interval", hive_console_cdn_poll_interval)?;
+            }
+        }
+
+        // GraphiQL overrides
+        if let Some(graphiql_enabled) = self.graphiql_enabled.take() {
+            config = config.set_override("graphiql.enabled", graphiql_enabled)?;
         }
 
         Ok(config)
diff --git a/lib/router-config/src/graphiql.rs b/lib/router-config/src/graphiql.rs
@@ -0,0 +1,24 @@
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone)]
+#[serde(deny_unknown_fields)]
+pub struct GraphiQLConfig {
+    /// Enables/disables the GraphiQL interface. By default, the GraphiQL interface is enabled.
+    ///
+    /// You can override this setting by setting the `GRAPHIQL_ENABLED` environment variable to `true` or `false`.
+    #[serde(default = "default_graphiql_enabled")]
+    pub enabled: bool,
+}
+
+fn default_graphiql_enabled() -> bool {
+    true
+}
+
+impl Default for GraphiQLConfig {
+    fn default() -> Self {
+        Self {
+            enabled: default_graphiql_enabled(),
+        }
+    }
+}
diff --git a/lib/router-config/src/http_server.rs b/lib/router-config/src/http_server.rs
@@ -5,11 +5,15 @@ use serde::{Deserialize, Serialize};
 #[serde(deny_unknown_fields)]
 pub struct HttpServerConfig {
     /// The host address to bind the HTTP server to.
+    ///
+    /// Can also be set via the `HOST` environment variable.
     #[serde(default = "http_server_host_default")]
     host: String,
 
     /// The port to bind the HTTP server to.
     ///
+    /// Can also be set via the `PORT` environment variable.
+    ///
     /// If you are running the router inside a Docker container, please ensure that the port is exposed correctly using `-p <host_port>:<container_port>` flag.
     #[serde(default = "http_server_port_default")]
     port: u16,
diff --git a/lib/router-config/src/lib.rs b/lib/router-config/src/lib.rs
@@ -1,6 +1,7 @@
 pub mod cors;
 pub mod csrf;
 mod env_overrides;
+pub mod graphiql;
 pub mod headers;
 pub mod http_server;
 pub mod jwt_auth;
@@ -19,6 +20,7 @@ use std::path::PathBuf;
 
 use crate::{
     env_overrides::{EnvVarOverrides, EnvVarOverridesError},
+    graphiql::GraphiQLConfig,
     http_server::HttpServerConfig,
     log::LoggingConfig,
     primitives::file_path::with_start_path,
@@ -39,6 +41,10 @@ pub struct HiveRouterConfig {
     #[serde(default)]
     pub log: LoggingConfig,
 
+    /// Configuration for the GraphiQL interface.
+    #[serde(default)]
+    pub graphiql: GraphiQLConfig,
+
     /// Configuration for the Federation supergraph source. By default, the router will use a local file-based supergraph source (`./supergraph.graphql`).
     /// Each source has a different set of configuration, depending on the source type.
     #[serde(default)]
diff --git a/lib/router-config/src/log.rs b/lib/router-config/src/log.rs
@@ -6,10 +6,21 @@ use serde::{Deserialize, Serialize};
 #[derive(Debug, Deserialize, Serialize, JsonSchema, Default)]
 #[serde(deny_unknown_fields)]
 pub struct LoggingConfig {
+    /// The level of logging to use.
+    ///
+    /// Can also be set via the `LOG_LEVEL` environment variable.
     #[serde(default)]
     pub level: LogLevel,
+
+    /// The format of the log messages.
+    ///
+    /// Can also be set via the `LOG_FORMAT` environment variable.
     #[serde(default)]
     pub format: LogFormat,
+
+    /// The filter to apply to log messages.
+    ///
+    /// Can also be set via the `LOG_FILTER` environment variable.
     #[serde(default)]
     pub filter: Option<String>,
 }
diff --git a/lib/router-config/src/supergraph.rs b/lib/router-config/src/supergraph.rs
@@ -12,6 +12,9 @@ pub enum SupergraphSource {
     /// The path can be either absolute or relative to the router's working directory.
     #[serde(rename = "file")]
     File {
+        /// The path to the supergraph file.
+        ///
+        /// Can also be set using the `SUPERGRAPH_FILE_PATH` environment variable.
         path: FilePath,
         /// Optional interval at which the file should be polled for changes.
         /// If not provided, the file will only be loaded once when the router starts.
@@ -26,10 +29,16 @@ pub enum SupergraphSource {
     #[serde(rename = "hive")]
     HiveConsole {
         /// The CDN endpoint from Hive Console target.
+        ///
+        /// Can also be set using the `HIVE_CDN_ENDPOINT` environment variable.
         endpoint: String,
         /// The CDN Access Token with from the Hive Console target.
+        ///
+        /// Can also be set using the `HIVE_CDN_KEY` environment variable.
         key: String,
         /// Interval at which the Hive Console should be polled for changes.
+        ///
+        /// Can also be set using the `HIVE_CDN_POLL_INTERVAL` environment variable.
         #[serde(
             default = "default_hive_poll_interval",
             deserialize_with = "humantime_serde::deserialize",
