Refactor Configuration validation #1791
Assignees
Labels
Comments
o0Ignition0o
added a commit
that referenced
this issue
Sep 15, 2022
Fixes #1791 There were three ways one could instantiate a Configuration, and (YAML) validation would only happen if explicitly invoked. No Business rule validation was applied, and yml configuration could be easily bypassed because Configuration derives Deserialize. This PR coerces Configuration instanciation to go through our yml validation when applicable, and allows us to enforce business requirements by making build() functions fallible.
o0Ignition0o
added a commit
that referenced
this issue
Sep 15, 2022
Fixes #1791 There were three ways one could instantiate a Configuration, and (YAML) validation would only happen if explicitly invoked. No Business rule validation was applied, and yml configuration could be easily bypassed because Configuration derives Deserialize. This PR coerces Configuration instanciation to go through our yml validation when applicable, and allows us to enforce business requirements by making build() functions fallible. Warning: This pr makes `ConfigurationError` public.
Merged
o0Ignition0o
pushed a commit
that referenced
this issue
Sep 16, 2022
> **Note** > We're almost to 1.0! We've got a couple relatively small breaking changes to the configuration for this release (none to the API) that should be relatively easy to adapt to and a number of bug fixes and usability improvements. ## ❗ BREAKING ❗ ### Change `headers` propagation configuration ([PR #1795](#1795)) While it wasn't necessary today, we want to avoid a necessary breaking change in the future by proactively making room for up-and-coming work. We've therefore introduced another level into the `headers` configuration with a `request` object, to allow for a `response` (see [Issue #1284](#1284)) to be an _additive_ feature after 1.0. A rough look at this should just be a matter of adding in `request` and indenting everything that was inside it: ```patch headers: all: + request: - remove: named: "test" ``` The good news is that we'll have `response` in the future! For a full set of examples, please see the [header propagation documentation](https://www.apollographql.com/docs/router/configuration/header-propagation/). By @bnjjj in #1795 ### Bind the Sandbox on the same endpoint as the Supergraph, again ([Issue #1785](#1785)) We have rolled back an addition that we released in this week's `v1.0.0-rc.0` which allowed Sandbox (an HTML page that makes requests to the `supergraph` endpoint) to be on a custom socket. In retrospect, we believe it was premature to make this change without considering the broader impact of this change which ultimately touches on CORS and some developer experiences bits. Practically speaking, we may not want to introduce this because it complicates the model in a number of ways. For the foreseeable future, Sandbox will continue to be on the same listener address as the `supergraph` listener. It's unlikely anyone has really leaned into this much already, but if you've already re-configured `sandbox` or `homepage` to be on a custom `listen`-er and/or `path` in `1.0.0-rc.0`, here is a diff of what you should remove: ```diff sandbox: - listen: 127.0.0.1:4000 - path: / enabled: false homepage: - listen: 127.0.0.1:4000 - path: / enabled: true ``` Note this means you can either enable the `homepage`, or the `sandbox`, but not both. By @o0Ignition0o in #1796 ## 🚀 Features ### Automatically check "Return Query Plans from Router" checkbox in Sandbox ([Issue #1803](#1803)) When loading Sandbox, we now automatically configure it to toggle the "Request query plans from Router" checkbox to the enabled position which requests query plans from the Apollo Router when executing operations. These query plans are displayed in the Sandbox interface and can be seen by selecting "Query Plan Preview" from the drop-down above the panel on the right side of the interface. By @abernix in #1804 ## 🐛 Fixes ### Fix `--dev` mode when no configuration file is specified ([Issue #1801](#1801)) ([Issue #1802](#1802)) We've reconciled an issue where the `--dev` mode flag was being ignored when running the router without a configuration file. (While many use cases do require a configuration file, the Router actually doesn't _need_ a confguration in many cases!) By @bnjjj in #1808 ### Respect `supergraph`'s `path` for Kubernetes deployment probes ([Issue #1787](#1787)) If you've configured the `supergraph`'s `path` property using the Helm chart, the liveness and readiness probes now utilize these correctly. This fixes a bug where they continued to use the _default_ path of `/` and resulted in a startup failure. By @damienpontifex in #1788 ### Get variable default values from the query for query plan condition nodes ([PR #1640](#1640)) The query plan condition nodes, generated by the `if` argument of the `@defer` directive, were not using the default value of the variable passed in as an argument. This _also_ fixes _default value_ validations for non-`@defer`'d queries. By @Geal in #1640 ### Correctly hot-reload when changing the `supergraph`'s `listen` socket ([Issue #1814](#1814)) If you change the `supergraph`'s `listen` socket while in `--hot-reload` mode, the Router will now correctly pickup the change and bind to the new socket. By @o0Ignition0o in #1815 ## 🛠 Maintenance ### Improve error message when querying non existent field [Issue #1816](#1816) When querying a non-existent field you will get a better error message: ```patch { "errors": [ { - "message": "invalid type error, expected another type than 'Named type Computer'" + "message": "Cannot query field \"xxx\" on type \"Computer\"" } ] } ``` By @bnjjj in #1817 ### Update `apollo-router-scaffold` to use the published `apollo-router` crate [PR #1782](#1782) Now that `apollo-router` is released on [crates.io](https://crates.io/crates/apollo-router), we have updated the project scaffold to rely on the published crate instead of Git tags. By @o0Ignition0o in #1782 ### Refactor `Configuration` validation [Issue #1791](#1791) Instantiating `Configuration`s is now fallible, because it will run consistency checks on top of the already run structure checks. By @o0Ignition0o in #1794 ### Refactor response-formatting tests [#1798](#1798) Rewrite the response-formatting tests to use a builder pattern instead of macros and move the tests to a separate file. By @Geal in #1798 ## 📚 Documentation ### Add `rustdoc` documentation to various modules ([Issue #799](#799)) Adds documentation for: - `apollo-router/src/layers/instrument.rs` - `apollo-router/src/layers/map_first_graphql_response.rs` - `apollo-router/src/layers/map_future_with_request_data.rs` - `apollo-router/src/layers/sync_checkpoint.rs` - `apollo-router/src/plugin/serde.rs` - `apollo-router/src/tracer.rs` By @garypen in #1792 ### Fixed `docs.rs` publishing error from our last release During our last release we discovered for the first time that our documentation wasn't able to compile on the [docs.rs](https://docs.rs) website, leaving our documentation in a [failed state](https://docs.rs/crate/apollo-router/1.0.0-rc.0/builds/629200). While we've reconciled _that particular problem_, we're now being affected by [this](https://docs.rs/crate/router-bridge/0.1.7/builds/629895) internal compiler errors (ICE) that [is affecting](rust-lang/rust#101844) anyone using `1.65.0-nightly` builds circa today. Since docs.rs uses `nightly` for all builds, this means it'll be a few more days before we're published there. With thanks to @SimonSapin in apollographql/federation-rs#185 Co-authored-by: Coenen Benjamin <benjamin.coenen@hotmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The validate_configuration function makes sure the provided YML is valid, then deserialises the configuration, and does consistency checks.
While this works well for the production settings, it doesn't validate inconsistencies that might occur through configurations build using Buildstructor (new and fake new build actual objects, so no yml validation is performed).
We should separate the "yml validation step" and the "config validation step", and maybe make
build()fallible.The text was updated successfully, but these errors were encountered: