release: v1.0.0-rc.1 (#1810)

> **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 <[email protected]>

Author: abernix

CHANGELOG.md

@@ -4,6 +4,152 @@ All notable changes to Router will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [1.0.0-rc.1] - 2022-09-16
+
+> **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](https://github.com/apollographql/router/pull/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](https://github.com/apollographql/router/issues/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](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/1795
+
+### Bind the Sandbox on the same endpoint as the Supergraph, again ([Issue #1785](https://github.com/apollographql/router/issues/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](https://github.com/o0Ignition0o) in https://github.com/apollographql/router/pull/1796
+
+## 🚀 Features
+
+### Automatically check "Return Query Plans from Router" checkbox in Sandbox ([Issue #1803](https://github.com/apollographql/router/issues/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](https://github.com/abernix) in https://github.com/apollographql/router/pull/1804
+
+## 🐛 Fixes
+
+### Fix `--dev` mode when no configuration file is specified ([Issue #1801](https://github.com/apollographql/router/issues/1801)) ([Issue #1802](https://github.com/apollographql/router/issues/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](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/1808
+
+### Respect `supergraph`'s `path` for Kubernetes deployment probes ([Issue #1787](https://github.com/apollographql/router/issues/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](https://github.com/damienpontifex) in https://github.com/apollographql/router/pull/1788
+
+### Get variable default values from the query for query plan condition nodes ([PR #1640](https://github.com/apollographql/router/issues/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](https://github.com/Geal) in https://github.com/apollographql/router/pull/1640
+
+### Correctly hot-reload when changing the `supergraph`'s `listen` socket ([Issue #1814](https://github.com/apollographql/router/issues/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](https://github.com/o0Ignition0o) in https://github.com/apollographql/router/pull/1815
+
+## 🛠 Maintenance
+
+### Improve error message when querying non existent field ([Issue #1816](https://github.com/apollographql/router/issues/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](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/1817
+
+### Update `apollo-router-scaffold` to use the published `apollo-router` crate [PR #1782](https://github.com/apollographql/router/pull/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](https://github.com/o0Ignition0o) in https://github.com/apollographql/router/pull/1782
+
+### Refactor `Configuration` validation ([Issue #1791](https://github.com/apollographql/router/issues/1791))
+
+Instantiating `Configuration`s is now fallible, because it will run consistency checks on top of the already run structure checks.
+
+By [@o0Ignition0o](https://github.com/o0Ignition0o) in https://github.com/apollographql/router/pull/1794
+
+### Refactor response-formatting tests ([Issue #1798](https://github.com/apollographql/router/issues/1798))
+
+Rewrite the response-formatting tests to use a builder pattern instead of macros and move the tests to a separate file.
+
+By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/pull/1798
+
+## 📚 Documentation
+
+### Add `rustdoc` documentation to various modules ([Issue #799](https://github.com/apollographql/router/issues/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](https://github.com/garypen) in https://github.com/apollographql/router/pull/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](https://github.com/rust-lang/rust/issues/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](https://github.com/SimonSapin) in https://github.com/apollographql/federation-rs/pull/185
+
 # [1.0.0-rc.0] - 2022-09-14
 
 ## ❗ BREAKING ❗

Cargo.lock

@@ -26,130 +26,7 @@ By [@USERNAME](https://github.com/USERNAME) in https://github.com/apollographql/
 # [x.x.x] (unreleased) - 2022-mm-dd
 
 ## ❗ BREAKING ❗
-
-### Change header propagation configuration [PR #1795](https://github.com/apollographql/router/pull/1795)
-
-Adds `request` subsection into header propagation configuration to prepare for #1284 coming post 1.0
-
-```patch
-headers:
-    all:
-+     request:
-          - remove:
-              named: "test"
-```
-
-By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/1795
-
-### Bind the Sandbox on the same endpoint as the Supergraph [#1785](https://github.com/apollographql/router/issues/1785)
-
-We have rolled back an addition that we released in yesteday’s `v1.0.0-rc.0` which allowed Sandbox to be on a custom listener address.
-In retrospect, we believe it was premature to make this change without considering the broader impact of this change which touches on CORS and some developer experiences bits.
-We would like more time to make sure we provide you with the best experience before we attempt to make the change again.
-
-Sandbox will continue to be on the same listener address as the GraphQL listener.
-
-If you have updated your configuration for `v1.0.0-rc.0` and enabled the sandbox here is a diff of what has changed:
-
-```diff
-sandbox:
--  listen: 127.0.0.1:4000
--  path: /
-  enabled: true
-# make sure homepage is disabled!
-homepage:
-  enabled: false
-# do not forget to enable introspection,
-# otherwise the sandbox won't work!
-supergraph:
-  introspection: true
-```
-
-Note this means you can either enable the Homepage, or the Sandbox, but not both.
-
-By [@o0Ignition0o](https://github.com/o0Ignition0o) in https://github.com/apollographql/router/pull/1796
-
-
 ## 🚀 Features
-
-### Automatically check "Return Query Plans from Router" checkbox in Sandbox ([Issue #1803](https://github.com/apollographql/router/issues/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](https://github.com/abernix) in https://github.com/apollographql/router/pull/1804
-
 ## 🐛 Fixes
-
-### Fix dev mode when you don't specify a configuration file ([Issue #1801](https://github.com/apollographql/router/issues/1801)) ([Issue #1802](https://github.com/apollographql/router/issues/1802))
-
-Previously the dev mode was ignored if you ran the router without a configuration file.
-
-By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/1808
-
-### Respect supergraph path for kubernetes deployment probes ([Issue #1787](https://github.com/apollographql/router/issues/1787))
-
-For cases where you configured the `supergraph.path` for the router when using the helm chart, the liveness 
-and readiness probes continued to use the default path of `/` and so the start failed.
-
-By [@damienpontifex](https://github.com/damienpontifex) in https://github.com/apollographql/router/pull/1788
-
-### Get variable default values from the query for query plan condition nodes ([PR #1640](https://github.com/apollographql/router/issues/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 argument.
-
-Additionally, this fixes default value validation for all queries.
-
-By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/pull/1640
-
 ## 🛠 Maintenance
-
-### Improve error message when querying non existent field [Issue #1816](https://github.com/apollographql/router/issues/1816)
-
-When querying a non existent field you will get a better error.
-
-```patch
-{
-  "errors": [
-    {
--       "message": "invalid type error, expected another type than 'Named type Computer'"
-+       "message": "Cannot query field \"xxx\" on type \"Computer\""
-    }
-  ]
-}
-```
-
-By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/1817
-
-### Update `apollo-router-scaffold` to use the published `apollo-router` crate [PR #1782](https://github.com/apollographql/router/pull/1782)
-
-Now that apollo-router version "1.0.0-rc.0" is released on [crates.io](https://crates.io/crates/apollo-router), we can update scaffold to it relies on the published crate instead of the git tag.
-
-By [@o0Ignition0o](https://github.com/o0Ignition0o) in https://github.com/apollographql/router/pull/1782
-
-### Refactor Configuration validation [#1791](https://github.com/apollographql/router/issues/1791)
-
-Instantiating `Configuration`s is now fallible, because it will run consistency checks on top of the already run structure checks.
-
-By [@o0Ignition0o](https://github.com/o0Ignition0o) in https://github.com/apollographql/router/pull/1794
-
-### Refactor formatting tests [#1798](https://github.com/apollographql/router/issues/1798)
-
-Rewrite the response formatting tests to use a builder instead of macros, and move the tests to a separate file.
-
-By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/pull/1798
-
 ## 📚 Documentation
-
-### Add rustdoc documentation to varius modules ([Issue #799](https://github.com/apollographql/router/issues/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](https://github.com/garypen) in https://github.com/apollographql/router/pull/1792

NEXT_CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "apollo-router-benchmarks"
-version = "1.0.0-rc.0"
+version = "1.0.0-rc.1"
 authors = ["Apollo Graph, Inc. <[email protected]>"]
 edition = "2021"
 license = "LicenseRef-ELv2"

apollo-router-benchmarks/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "apollo-router-scaffold"
-version = "1.0.0-rc.0"
+version = "1.0.0-rc.1"
 authors = ["Apollo Graph, Inc. <[email protected]>"]
 edition = "2021"
 license = "LicenseRef-ELv2"

apollo-router-scaffold/Cargo.toml

@@ -22,7 +22,7 @@ apollo-router = { path ="{{integration_test}}apollo-router" }
 apollo-router = { git="https://github.com/apollographql/router.git", branch="{{branch}}" }
 {{else}}
 # Note if you update these dependencies then also update xtask/Cargo.toml
-apollo-router = "1.0.0-rc.0"
+apollo-router = "1.0.0-rc.1"
 {{/if}}
 {{/if}}
 async-trait = "0.1.52"

apollo-router-scaffold/templates/base/Cargo.toml

@@ -13,7 +13,7 @@ apollo-router-scaffold = { path ="{{integration_test}}apollo-router-scaffold" }
 {{#if branch}}
 apollo-router-scaffold = { git="https://github.com/apollographql/router.git", branch="{{branch}}" }
 {{else}}
-apollo-router-scaffold = { git="https://github.com/apollographql/router.git", tag="v1.0.0-rc.0"}
+apollo-router-scaffold = { git="https://github.com/apollographql/router.git", tag="v1.0.0-rc.1"}
 {{/if}}
 {{/if}}
 anyhow = "1.0.58"

apollo-router-scaffold/templates/base/xtask/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "apollo-router"
-version = "1.0.0-rc.0"
+version = "1.0.0-rc.1"
 authors = ["Apollo Graph, Inc. <[email protected]>"]
 repository = "https://github.com/apollographql/router/"
 documentation = "https://www.apollographql.com/docs/router/"

apollo-router/Cargo.toml

@@ -3,7 +3,7 @@ services:
 
   apollo-router:
     container_name: apollo-router
-    image: ghcr.io/apollographql/router:v1.0.0-rc.0
+    image: ghcr.io/apollographql/router:v1.0.0-rc.1
     volumes:
       - ./supergraph.graphql:/etc/config/supergraph.graphql
       - ./router/datadog.router.yaml:/etc/config/configuration.yaml

dockerfiles/tracing/docker-compose.datadog.yml

@@ -4,7 +4,7 @@ services:
   apollo-router:
     container_name: apollo-router
     #build: ./router
-    image: ghcr.io/apollographql/router:v1.0.0-rc.0
+    image: ghcr.io/apollographql/router:v1.0.0-rc.1
     volumes:
       - ./supergraph.graphql:/etc/config/supergraph.graphql
       - ./router/jaeger.router.yaml:/etc/config/configuration.yaml

dockerfiles/tracing/docker-compose.jaeger.yml

@@ -4,7 +4,7 @@ services:
   apollo-router:
     container_name: apollo-router
     build: ./router
-    image: ghcr.io/apollographql/router:v1.0.0-rc.0
+    image: ghcr.io/apollographql/router:v1.0.0-rc.1
     volumes:
       - ./supergraph.graphql:/etc/config/supergraph.graphql
       - ./router/zipkin.router.yaml:/etc/config/configuration.yaml