prep release: v1.25.0 (#3473)

> **Note** > > When approved, this PR will merge into **the `1.25.0` branch** which will — upon being approved itself — merge into `main`. > > **Things to review in this PR**: > - Changelog correctness (There is a preview below, but it is not necessarily the most up to date. See the _Files Changed_ for the true reality.) > - Version bumps > - That it targets the right release branch (`1.25.0` in this case!). > --- ## 🚀 Features ### Persisted Queries w/opt-in safelisting (preview) ([PR #3347](#3347)) > ⚠️ **Persisted queries is an [Enterprise feature](https://www.apollographql.com/blog/platform/evaluating-apollo-router-understanding-free-and-open-vs-commercial-features/) of the Apollo Router.** It requires an organization with a [GraphOS Enterprise plan](https://www.apollographql.com/pricing/) and the feature to be enabled for your account. > > If your organization _doesn't_ currently have an Enterprise plan, you can test out this functionality by signing up for a free [Enterprise trial](https://www.apollographql.com/docs/graphos/org/plans/#enterprise-trials) and reaching out to enable the feature for your account. Persisted Queries gives you the tools to prevent unwanted traffic from reaching your graph. It has two modes of operation: * **Unregistered operation monitoring** * Your router can allow all GraphQL operations, while emitting structured traces containing unregistered operation bodies. * **Operation safelisting** * Reject unregistered operations * Require all operations to be sent as an ID Unlike automatic persisted queries (APQ), the ability to create a safelist of operations allows you to prevent a malicious actor from constructing a free-format query that could overload your subgraphh services. For more information con how to register queries and configure your router see the [Persisted Query documentation](https://www.apollographql.com/docs/graphos/routing/persisted-queries). By [@EverlastingBugstopper](https://github.com/EverlastingBugstopper) in #3347 ## 🐛 Fixes ### Fix prometheus statistics issues with _total_total names([Issue #3443](#3443)) When producing prometheus statistics the otel crate (0.19.0) now automatically appends `_total` which is unhelpful. This fix removes `_total_total` from our statistics. However, counter metrics will still have `_total` appended to them if they did not so already. By [@garypen](https://github.com/garypen) in #3471 ### Enforce default buckets for metrics ([PR #3432](#3432)) When `telemetry.metrics.common` was not configured, no default metrics buckets were configured. With this fix by default it set these buckets: `[0.001, 0.005, 0.015, 0.05, 0.1, 0.2, 0.3, 0.4, 0.5, 1.0, 5.0, 10.0]` By [@bnjjj](https://github.com/bnjjj) in #3432 ## 📃 Configuration ### Add `subscription.enabled` field to enable subscription support ([Issue #3428](#3428)) `enabled` is now required in `subscription` configuration. Example: ```yaml subscription: enabled: true mode: passthrough: all: path: /ws ``` By [@bnjjj](https://github.com/bnjjj) in #3450 ### Add option to disable reuse of query fragments ([Issue #3452](#3452)) A new option has been added to the Router to allow disabling of the reuse of query fragments. This is useful for debugging purposes. ```yaml supergraph: experimental_reuse_query_fragments: false ``` The default value depends on the version of federation. By [@BrynCooke](https://github.com/BrynCooke) in #3453 ## 🛠 Maintenance ### Coprocessor: Set a default pool idle timeout duration. ([PR #3434](#3434)) The default idle pool timeout duration in Hyper can sometimes trigger situations in which an HTTP request cannot complete (see [this comment](hyperium/hyper#2136 (comment)) for more information). This changeset sets a default timeout duration of 5 seconds. By [@o0Ignition0o](https://github.com/o0Ignition0o) in #3434 --------- Co-authored-by: bryn <bryn@apollographql.com> Co-authored-by: Chandrika Srinivasan <chandrikas@users.noreply.github.com>
apollographql · Jul 20, 2023 · c9cd3a0 · c9cd3a0
1 parent 0133836
commit c9cd3a0
Show file tree

Hide file tree

Showing 21 changed files with 113 additions and 157 deletions.
diff --git a/.changesets/config_bnjjj_fix_3428.md b/.changesets/config_bnjjj_fix_3428.md
diff --git a/.changesets/feat_avery_persisted_queries.md b/.changesets/feat_avery_persisted_queries.md
diff --git a/.changesets/fix_bnjjj_fix_metrics_default_buckets.md b/.changesets/fix_bnjjj_fix_metrics_default_buckets.md
diff --git a/.changesets/fix_federation_fragments.md b/.changesets/fix_federation_fragments.md
diff --git a/.changesets/fix_garypen_3443_fix_prom.md b/.changesets/fix_garypen_3443_fix_prom.md
diff --git a/.changesets/maint_igni_coprocessor_idle_timeout_duration.md b/.changesets/maint_igni_coprocessor_idle_timeout_duration.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,87 @@ All notable changes to Router will be documented in this file.
 
 This project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
 
+# [1.25.0] - 2023-07-19
+
+## 🚀 Features
+
+### Persisted Queries w/opt-in safelisting (preview) ([PR #3347](https://github.com/apollographql/router/pull/3347))
+
+> ⚠️ **Persisted queries is an [Enterprise feature](https://www.apollographql.com/blog/platform/evaluating-apollo-router-understanding-free-and-open-vs-commercial-features/) of the Apollo Router.** It requires an organization with a [GraphOS Enterprise plan](https://www.apollographql.com/pricing/).
+>
+> If your organization _doesn't_ currently have an Enterprise plan, you can test out this functionality by signing up for a free [Enterprise trial](https://www.apollographql.com/docs/graphos/org/plans/#enterprise-trials).
+
+Persisted Queries gives you the tools to prevent unwanted traffic from reaching your graph.
+
+It has two modes of operation:
+* **Unregistered operation monitoring**
+  * Your router can allow all GraphQL operations, while emitting structured traces containing unregistered operation bodies.
+* **Operation safelisting**
+  * Reject unregistered operations
+  * Require all operations to be sent as an ID
+
+Unlike automatic persisted queries (APQ), the ability to create a safelist of operations allows you to prevent a malicious actor from constructing a free-format query that could overload your subgraph services.
+
+For more information con how to register queries and configure your router see the [Persisted Query documentation](https://www.apollographql.com/docs/graphos/routing/persisted-queries).
+
+By [@EverlastingBugstopper](https://github.com/EverlastingBugstopper) in https://github.com/apollographql/router/pull/3347
+
+## 🐛 Fixes
+
+### Fix prometheus statistics issues with _total_total names([Issue #3443](https://github.com/apollographql/router/issues/3443))
+
+When producing prometheus statistics the otel crate (0.19.0) now automatically appends `_total` which is unhelpful.
+
+This fix removes `_total_total` from our statistics. However, counter metrics will still have `_total` appended to them if they did not so already.
+
+By [@garypen](https://github.com/garypen) in https://github.com/apollographql/router/pull/3471
+
+### Enforce default buckets for metrics ([PR #3432](https://github.com/apollographql/router/pull/3432))
+
+When `telemetry.metrics.common` was not configured, no default metrics buckets were configured.
+With this fix the default buckets are: `[0.001, 0.005, 0.015, 0.05, 0.1, 0.2, 0.3, 0.4, 0.5, 1.0, 5.0, 10.0]`
+
+By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/3432
+
+## 📃 Configuration
+
+### Add `subscription.enabled` field to enable subscription support ([Issue #3428](https://github.com/apollographql/router/issues/3428))
+
+`enabled` is now required in `subscription` configuration. Example:
+
+```yaml
+subscription:
+  enabled: true
+  mode:
+    passthrough:
+      all:
+        path: /ws
+```
+
+By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/3450
+
+### Add option to disable reuse of query fragments  ([Issue #3452](https://github.com/apollographql/router/issues/3452))
+
+A new option has been added to the Router to allow disabling of the reuse of query fragments. This is useful for debugging purposes.
+```yaml
+supergraph:
+  experimental_reuse_query_fragments: false
+```
+
+The default value depends on the version of federation.
+
+By [@BrynCooke](https://github.com/BrynCooke) in https://github.com/apollographql/router/pull/3453
+
+## 🛠 Maintenance
+
+### Coprocessor: Set a default pool idle timeout duration. ([PR #3434](https://github.com/apollographql/router/pull/3434))
+
+The default idle pool timeout duration in Hyper can sometimes trigger situations in which an HTTP request cannot complete (see [this comment](https://github.com/hyperium/hyper/issues/2136#issuecomment-589488526) for more information).
+
+This changeset sets a default timeout duration of 5 seconds.
+
+By [@o0Ignition0o](https://github.com/o0Ignition0o) in https://github.com/apollographql/router/pull/3434
+
 # [1.24.0] - 2023-07-13
 
 ## 🚀 Features

diff --git a/Cargo.lock b/Cargo.lock
@@ -271,7 +271,7 @@ dependencies = [
 
 [[package]]
 name = "apollo-router"
-version = "1.25.0-alpha.2"
+version = "1.25.0"
 dependencies = [
  "access-json",
  "anyhow",
@@ -411,7 +411,7 @@ dependencies = [
 
 [[package]]
 name = "apollo-router-benchmarks"
-version = "1.25.0-alpha.2"
+version = "1.25.0"
 dependencies = [
  "apollo-parser 0.4.1",
  "apollo-router",
@@ -427,7 +427,7 @@ dependencies = [
 
 [[package]]
 name = "apollo-router-scaffold"
-version = "1.25.0-alpha.2"
+version = "1.25.0"
 dependencies = [
  "anyhow",
  "cargo-scaffold",

diff --git a/apollo-router-benchmarks/Cargo.toml b/apollo-router-benchmarks/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "apollo-router-benchmarks"
-version = "1.25.0-alpha.2"
+version = "1.25.0"
 authors = ["Apollo Graph, Inc. <packages@apollographql.com>"]
 edition = "2021"
 license = "Elastic-2.0"

diff --git a/apollo-router-scaffold/Cargo.toml b/apollo-router-scaffold/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "apollo-router-scaffold"
-version = "1.25.0-alpha.2"
+version = "1.25.0"
 authors = ["Apollo Graph, Inc. <packages@apollographql.com>"]
 edition = "2021"
 license = "Elastic-2.0"

diff --git a/apollo-router-scaffold/templates/base/Cargo.toml b/apollo-router-scaffold/templates/base/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.25.0-alpha.2"
+apollo-router = "1.25.0"
 {{/if}}
 {{/if}}
 async-trait = "0.1.52"

diff --git a/apollo-router-scaffold/templates/base/xtask/Cargo.toml b/apollo-router-scaffold/templates/base/xtask/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.25.0-alpha.2" }
+apollo-router-scaffold = { git = "https://github.com/apollographql/router.git", tag = "v1.25.0" }
 {{/if}}
 {{/if}}
 anyhow = "1.0.58"

diff --git a/apollo-router/Cargo.toml b/apollo-router/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "apollo-router"
-version = "1.25.0-alpha.2"
+version = "1.25.0"
 authors = ["Apollo Graph, Inc. <packages@apollographql.com>"]
 repository = "https://github.com/apollographql/router/"
 documentation = "https://docs.rs/apollo-router"

diff --git a/dockerfiles/tracing/docker-compose.datadog.yml b/dockerfiles/tracing/docker-compose.datadog.yml
@@ -3,7 +3,7 @@ services:
 
   apollo-router:
     container_name: apollo-router
-    image: ghcr.io/apollographql/router:v1.25.0-alpha.2
+    image: ghcr.io/apollographql/router:v1.25.0
     volumes:
       - ./supergraph.graphql:/etc/config/supergraph.graphql
       - ./router/datadog.router.yaml:/etc/config/configuration.yaml

diff --git a/dockerfiles/tracing/docker-compose.jaeger.yml b/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.25.0-alpha.2
+    image: ghcr.io/apollographql/router:v1.25.0
     volumes:
       - ./supergraph.graphql:/etc/config/supergraph.graphql
       - ./router/jaeger.router.yaml:/etc/config/configuration.yaml

diff --git a/dockerfiles/tracing/docker-compose.zipkin.yml b/dockerfiles/tracing/docker-compose.zipkin.yml
@@ -4,7 +4,7 @@ services:
   apollo-router:
     container_name: apollo-router
     build: ./router
-    image: ghcr.io/apollographql/router:v1.25.0-alpha.2
+    image: ghcr.io/apollographql/router:v1.25.0
     volumes:
       - ./supergraph.graphql:/etc/config/supergraph.graphql
       - ./router/zipkin.router.yaml:/etc/config/configuration.yaml

diff --git a/docs/source/containerization/docker.mdx b/docs/source/containerization/docker.mdx
@@ -11,7 +11,7 @@ The default behaviour of the router images is suitable for a quickstart or devel
 
 Note: The [docker documentation](https://docs.docker.com/engine/reference/run/) for the run command may be helpful when reading through the examples.
 
-Note: The exact image version to use is your choice depending on which release you wish to use. In the following examples, replace `<image version>` with your chosen version. e.g.: `v1.25.0-alpha.2`
+Note: The exact image version to use is your choice depending on which release you wish to use. In the following examples, replace `<image version>` with your chosen version. e.g.: `v1.25.0`
 
 ## Override the configuration