-
Notifications
You must be signed in to change notification settings - Fork 3
feat(config): configuration override using env vars, enable/disable graphiql via config #519
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| use config::{builder::BuilderState, ConfigBuilder, ConfigError}; | ||
| use envconfig::Envconfig; | ||
| use tracing::debug; | ||
|
|
||
| use crate::log::{LogFormat, LogLevel}; | ||
|
|
||
| #[derive(Envconfig)] | ||
| pub struct EnvVarOverrides { | ||
| // Logger overrides | ||
| #[envconfig(from = "LOG_LEVEL")] | ||
| pub log_level: Option<LogLevel>, | ||
| #[envconfig(from = "LOG_FORMAT")] | ||
| pub log_format: Option<LogFormat>, | ||
| #[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>, | ||
| #[envconfig(from = "HOST")] | ||
| pub http_host: Option<String>, | ||
|
|
||
| // Supergraph overrides | ||
| #[envconfig(from = "SUPERGRAPH_FILE_PATH")] | ||
| pub supergraph_file_path: Option<String>, | ||
| #[envconfig(from = "HIVE_CDN_ENDPOINT")] | ||
| pub hive_console_cdn_endpoint: Option<String>, | ||
| #[envconfig(from = "HIVE_CDN_KEY")] | ||
| pub hive_console_cdn_key: Option<String>, | ||
dotansimha marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| #[envconfig(from = "HIVE_CDN_POLL_INTERVAL")] | ||
| pub hive_console_cdn_poll_interval: Option<String>, | ||
| } | ||
|
|
||
| #[derive(Debug, thiserror::Error)] | ||
| pub enum EnvVarOverridesError { | ||
| #[error("Failed to override configuration: {0}")] | ||
| FailedToOverrideConfig(#[from] ConfigError), | ||
| #[error("Cannot override supergraph source due to conflict: SUPERGRAPH_FILE_PATH and HIVE_CDN_ENDPOINT cannot be used together")] | ||
| ConflictingSupergraphSource, | ||
| #[error("Missing required environment variable: {0}")] | ||
| MissingRequiredEnvVar(&'static str), | ||
| } | ||
|
|
||
| impl EnvVarOverrides { | ||
| pub fn apply_overrides<T: BuilderState>( | ||
| mut self, | ||
| mut config: ConfigBuilder<T>, | ||
| ) -> Result<ConfigBuilder<T>, EnvVarOverridesError> { | ||
| if let Some(log_level) = self.log_level.take() { | ||
dotansimha marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| debug!("[config-override] 'log.level' = {:?}", log_level); | ||
| config = config.set_override("log.level", log_level.as_str())?; | ||
| } | ||
| if let Some(log_format) = self.log_format.take() { | ||
| debug!("[config-override] 'log.format' = {:?}", log_format); | ||
| config = config.set_override("log.format", log_format.as_str())?; | ||
| } | ||
| if let Some(log_filter) = self.log_filter.take() { | ||
| debug!("[config-override] 'log.filter' = {:?}", log_filter); | ||
| config = config.set_override("log.filter", log_filter)?; | ||
| } | ||
|
|
||
| if let Some(http_port) = self.http_port.take() { | ||
| debug!("[config-override] 'http.port' = {}", http_port); | ||
| config = config.set_override("http.port", http_port)?; | ||
| } | ||
|
|
||
| if let Some(http_host) = self.http_host.take() { | ||
| debug!("[config-override] 'http.host' = {}", http_host); | ||
| config = config.set_override("http.host", http_host)?; | ||
| } | ||
|
|
||
| if self.supergraph_file_path.is_some() && self.hive_console_cdn_endpoint.is_some() { | ||
| return Err(EnvVarOverridesError::ConflictingSupergraphSource); | ||
| } | ||
|
|
||
| if let Some(supergraph_file_path) = self.supergraph_file_path.take() { | ||
| config = config.set_override("supergraph.source", "file")?; | ||
| config = config.set_override("supergraph.path", supergraph_file_path)?; | ||
| } | ||
|
|
||
| if let Some(hive_console_cdn_endpoint) = self.hive_console_cdn_endpoint.take() { | ||
| config = config.set_override("supergraph.source", "hive")?; | ||
| config = config.set_override("supergraph.endpoint", hive_console_cdn_endpoint)?; | ||
|
|
||
| if let Some(hive_console_cdn_key) = self.hive_console_cdn_key.take() { | ||
| config = config.set_override("supergraph.key", hive_console_cdn_key)?; | ||
| } 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) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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(), | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.