Skip to content

Commit

Permalink
prep release: v1.59.2
Browse files Browse the repository at this point in the history
  • Loading branch information
abernix authored Jan 29, 2025
1 parent b8a71e7 commit d623447
Show file tree
Hide file tree
Showing 17 changed files with 123 additions and 67 deletions.
7 changes: 0 additions & 7 deletions .changesets/fix_query_hash_speedup.md

This file was deleted.

12 changes: 0 additions & 12 deletions .changesets/fix_simon_rayonless_sysinfo.md

This file was deleted.

42 changes: 42 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,46 @@ 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.59.2] - 2025-01-28

> [!IMPORTANT]
>
> This release contains important fixes which address resource utilization regressions which impacted Router v1.59.0 and v1.59.1. These regressions were in the form of:
>
> 1. A small baseline increase in memory usage; AND
> 2. Additional per-request CPU and memory usage for queries which included references to abstract types with a large number of implementations
>
> If you have enabled [Distributed query plan caching](https://www.apollographql.com/docs/router/configuration/distributed-caching/#distributed-query-plan-caching), this release contains changes which necessarily alter the hashing algorithm used for the cache keys. On account of this, you should anticipate additional cache regeneration cost when updating between these versions while the new hashing algorithm comes into service.

## 🐛 Fixes

### Improve performance of query hashing by using a precomputed schema hash ([PR #6622](https://github.com/apollographql/router/pull/6622))

The router now uses a simpler and faster query hashing algorithm with more predictable CPU and memory usage. This improvement is enabled by using a precomputed hash of the entire schema, rather than computing and hashing the subset of types and fields used by each query.

For more details on why these design decisions were made, please see the [PR description](https://github.com/apollographql/router/pull/6622)

By [@IvanGoncharov](https://github.com/IvanGoncharov) in https://github.com/apollographql/router/pull/6622

### Fix increased memory usage in `sysinfo` since Router 1.59.0 ([PR #6634](https://github.com/apollographql/router/pull/6634))

In version 1.59.0, Apollo Router started using the `sysinfo` crate to gather metrics about available CPUs and RAM. By default, that crate uses `rayon` internally to parallelize its handling of system processes. In turn, rayon creates a pool of long-lived threads.

In a particular benchmark on a 32-core Linux server, this caused resident memory use to increase by about 150 MB. This is likely a combination of stack space (which only gets freed when the thread terminates) and per-thread space reserved by the heap allocator to reduce cross-thread synchronization cost.

This regression is now fixed by:

* Disabling `sysinfo`’s use of `rayon`, so the thread pool is not created and system processes information is gathered in a sequential loop.
* Making `sysinfo` not gather that information in the first place since Router does not use it.

By [@SimonSapin](https://github.com/SimonSapin) in https://github.com/apollographql/router/pull/6634

# [1.59.1] - 2025-01-08

> [!IMPORTANT]
>
> This release was impacted by a resource utilization regression which was fixed in [v1.59.2](#1592---2025-01-28). See the release notes for that release for more details. As a result, we recommend using v1.59.2 rather than v1.59.1 or v1.59.0.

## 🐛 Fixes

### Fix transmitted header value for Datadog priority sampling resolution ([PR #6017](https://github.com/apollographql/router/pull/6017))
Expand Down Expand Up @@ -64,6 +102,10 @@ By [@BrynCooke](https://github.com/BrynCooke) in https://github.com/apollographq

# [1.59.0] - 2024-12-17

> [!IMPORTANT]
>
> This release was impacted by a resource utilization regression which was fixed in [v1.59.2](#1592---2025-01-28). See the release notes for that release for more details. As a result, we recommend using v1.59.2 rather than v1.59.1 or v1.59.0.

> [!IMPORTANT]
> If you have enabled [distributed query plan caching](https://www.apollographql.com/docs/router/configuration/distributed-caching/#distributed-query-plan-caching), updates to the query planner in this release will result in query plan caches being regenerated rather than reused. On account of this, you should anticipate additional cache regeneration cost when updating to this router version while the new query plans come into service.

Expand Down
8 changes: 4 additions & 4 deletions Cargo.lock
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ dependencies = [

[[package]]
name = "apollo-federation"
version = "1.59.2-rc.0"
version = "1.59.2"
dependencies = [
"apollo-compiler",
"derive_more",
Expand Down Expand Up @@ -257,7 +257,7 @@ dependencies = [

[[package]]
name = "apollo-router"
version = "1.59.2-rc.0"
version = "1.59.2"
dependencies = [
"access-json",
"ahash",
Expand Down Expand Up @@ -427,7 +427,7 @@ dependencies = [

[[package]]
name = "apollo-router-benchmarks"
version = "1.59.2-rc.0"
version = "1.59.2"
dependencies = [
"apollo-parser",
"apollo-router",
Expand All @@ -443,7 +443,7 @@ dependencies = [

[[package]]
name = "apollo-router-scaffold"
version = "1.59.2-rc.0"
version = "1.59.2"
dependencies = [
"anyhow",
"cargo-scaffold",
Expand Down
2 changes: 1 addition & 1 deletion apollo-federation/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "apollo-federation"
version = "1.59.2-rc.0"
version = "1.59.2"
authors = ["The Apollo GraphQL Contributors"]
edition = "2021"
description = "Apollo Federation"
Expand Down
2 changes: 1 addition & 1 deletion apollo-router-benchmarks/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "apollo-router-benchmarks"
version = "1.59.2-rc.0"
version = "1.59.2"
authors = ["Apollo Graph, Inc. <[email protected]>"]
edition = "2021"
license = "Elastic-2.0"
Expand Down
2 changes: 1 addition & 1 deletion apollo-router-scaffold/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "apollo-router-scaffold"
version = "1.59.2-rc.0"
version = "1.59.2"
authors = ["Apollo Graph, Inc. <[email protected]>"]
edition = "2021"
license = "Elastic-2.0"
Expand Down
2 changes: 1 addition & 1 deletion apollo-router-scaffold/templates/base/Cargo.template.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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.59.2-rc.0"
apollo-router = "1.59.2"
{{/if}}
{{/if}}
async-trait = "0.1.52"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.59.2-rc.0" }
apollo-router-scaffold = { git = "https://github.com/apollographql/router.git", tag = "v1.59.2" }
{{/if}}
{{/if}}
anyhow = "1.0.58"
Expand Down
4 changes: 2 additions & 2 deletions apollo-router/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "apollo-router"
version = "1.59.2-rc.0"
version = "1.59.2"
authors = ["Apollo Graph, Inc. <[email protected]>"]
repository = "https://github.com/apollographql/router/"
documentation = "https://docs.rs/apollo-router"
Expand Down Expand Up @@ -66,7 +66,7 @@ features = ["docs_rs"]
access-json = "0.1.0"
anyhow = "1.0.86"
apollo-compiler.workspace = true
apollo-federation = { path = "../apollo-federation", version = "=1.59.2-rc.0" }
apollo-federation = { path = "../apollo-federation", version = "=1.59.2" }
arc-swap = "1.6.0"
async-channel = "1.9.0"
async-compression = { version = "0.4.6", features = [
Expand Down
2 changes: 1 addition & 1 deletion dockerfiles/tracing/docker-compose.datadog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ services:

apollo-router:
container_name: apollo-router
image: ghcr.io/apollographql/router:v1.59.2-rc.0
image: ghcr.io/apollographql/router:v1.59.2
volumes:
- ./supergraph.graphql:/etc/config/supergraph.graphql
- ./router/datadog.router.yaml:/etc/config/configuration.yaml
Expand Down
2 changes: 1 addition & 1 deletion dockerfiles/tracing/docker-compose.jaeger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ services:
apollo-router:
container_name: apollo-router
#build: ./router
image: ghcr.io/apollographql/router:v1.59.2-rc.0
image: ghcr.io/apollographql/router:v1.59.2
volumes:
- ./supergraph.graphql:/etc/config/supergraph.graphql
- ./router/jaeger.router.yaml:/etc/config/configuration.yaml
Expand Down
2 changes: 1 addition & 1 deletion dockerfiles/tracing/docker-compose.zipkin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ services:
apollo-router:
container_name: apollo-router
build: ./router
image: ghcr.io/apollographql/router:v1.59.2-rc.0
image: ghcr.io/apollographql/router:v1.59.2
volumes:
- ./supergraph.graphql:/etc/config/supergraph.graphql
- ./router/zipkin.router.yaml:/etc/config/configuration.yaml
Expand Down
4 changes: 2 additions & 2 deletions helm/chart/router/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ type: application
# so it matches the shape of our release process and release automation.
# By proxy of that decision, this version uses SemVer 2.0.0, though the prefix
# of "v" is not included.
version: 1.59.2-rc.0
version: 1.59.2

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "v1.59.2-rc.0"
appVersion: "v1.59.2"
6 changes: 3 additions & 3 deletions helm/chart/router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[router](https://github.com/apollographql/router) Rust Graph Routing runtime for Apollo Federation

![Version: 1.59.2-rc.0](https://img.shields.io/badge/Version-1.59.2--rc.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.59.2-rc.0](https://img.shields.io/badge/AppVersion-v1.59.2--rc.0-informational?style=flat-square)
![Version: 1.59.2](https://img.shields.io/badge/Version-1.59.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.59.2](https://img.shields.io/badge/AppVersion-v1.59.2-informational?style=flat-square)

## Prerequisites

Expand All @@ -11,15 +11,15 @@
## Get Repo Info

```console
helm pull oci://ghcr.io/apollographql/helm-charts/router --version 1.59.2-rc.0
helm pull oci://ghcr.io/apollographql/helm-charts/router --version 1.59.2
```

## Install Chart

**Important:** only helm3 is supported

```console
helm upgrade --install [RELEASE_NAME] oci://ghcr.io/apollographql/helm-charts/router --version 1.59.2-rc.0 --values my-values.yaml
helm upgrade --install [RELEASE_NAME] oci://ghcr.io/apollographql/helm-charts/router --version 1.59.2 --values my-values.yaml
```

_See [configuration](#configuration) below._
Expand Down
89 changes: 61 additions & 28 deletions licenses.html
Original file line number Diff line number Diff line change
Expand Up @@ -6115,13 +6115,13 @@ <h4>Used by:</h4>
<h3 id="Apache-2.0">Apache License 2.0</h3>
<h4>Used by:</h4>
<ul class="license-used-by">
<li><a href=" https://github.com/dtolnay/anyhow ">anyhow</a></li>
<li><a href=" https://github.com/dtolnay/async-trait ">async-trait</a></li>
<li><a href=" https://github.com/dtolnay/basic-toml ">basic-toml</a></li>
<li><a href=" https://github.com/dtolnay/dyn-clone ">dyn-clone</a></li>
<li><a href=" https://github.com/dtolnay/erased-serde ">erased-serde</a></li>
<li><a href=" https://github.com/dtolnay/ghost ">ghost</a></li>
<li><a href=" https://github.com/dtolnay/itoa ">itoa</a></li>
<li><a href=" https://github.com/rust-lang/libc ">libc</a></li>
<li><a href=" https://github.com/dtolnay/linkme ">linkme</a></li>
<li><a href=" https://github.com/dtolnay/paste ">paste</a></li>
<li><a href=" https://github.com/dtolnay/prettyplease ">prettyplease</a></li>
Expand Down Expand Up @@ -11933,8 +11933,6 @@ <h4>Used by:</h4>
<h3 id="Apache-2.0">Apache License 2.0</h3>
<h4>Used by:</h4>
<ul class="license-used-by">
<li><a href=" https://github.com/apollographql/apollo-rs ">apollo-compiler</a></li>
<li><a href=" https://github.com/apollographql/apollo-rs ">apollo-parser</a></li>
<li><a href=" https://github.com/apollographql/apollo-rs ">apollo-smith</a></li>
</ul>
<pre class="license-text">../../LICENSE-APACHE</pre>
Expand Down Expand Up @@ -12586,6 +12584,10 @@ <h4>Used by:</h4>
<h3 id="Apache-2.0">Apache License 2.0</h3>
<h4>Used by:</h4>
<ul class="license-used-by">
<li><a href=" https://github.com/nical/android_system_properties ">android_system_properties</a></li>
<li><a href=" https://github.com/dtolnay/anyhow ">anyhow</a></li>
<li><a href=" https://github.com/apollographql/apollo-rs ">apollo-compiler</a></li>
<li><a href=" https://github.com/apollographql/apollo-rs ">apollo-parser</a></li>
<li><a href=" https://github.com/async-graphql/async-graphql ">async-graphql-axum</a></li>
<li><a href=" https://github.com/async-graphql/async-graphql ">async-graphql-derive</a></li>
<li><a href=" https://github.com/async-graphql/async-graphql ">async-graphql-parser</a></li>
Expand All @@ -12600,7 +12602,6 @@ <h4>Used by:</h4>
<li><a href=" https://github.com/graphql-rust/graphql-client ">graphql_query_derive</a></li>
<li><a href=" https://gitlab.com/kornelski/http-serde ">http-serde</a></li>
<li><a href=" https://github.com/TedDriggs/ident_case ">ident_case</a></li>
<li><a href=" https://github.com/rust-lang/libc ">libc</a></li>
<li><a href=" https://github.com/alexcrichton/ssh2-rs ">libssh2-sys</a></li>
<li><a href=" https://github.com/dtolnay/linkme ">linkme-impl</a></li>
<li><a href=" https://github.com/stainless-steel/md5 ">md5</a></li>
Expand Down Expand Up @@ -12689,27 +12690,6 @@ <h4>Used by:</h4>

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</pre>
</li>
<li class="license">
<h3 id="Apache-2.0">Apache License 2.0</h3>
<h4>Used by:</h4>
<ul class="license-used-by">
<li><a href=" https://github.com/nical/android_system_properties ">android_system_properties</a></li>
</ul>
<pre class="license-text">Copyright 2016 Nicolas Silva

Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Expand Down Expand Up @@ -17749,9 +17729,6 @@ <h4>Used by:</h4>
<li><a href=" https://github.com/unicode-org/icu4x ">icu_provider_macros</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">litemap</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">tinystr</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">writeable</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">yoke</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">yoke-derive</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">zerofrom</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">zerofrom-derive</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">zerovec</a></li>
Expand Down Expand Up @@ -17796,6 +17773,62 @@ <h4>Used by:</h4>
not be used in advertising or otherwise to promote the sale, use or other
dealings in these Data Files or Software without prior written
authorization of the copyright holder.
</pre>
</li>
<li class="license">
<h3 id="Unicode-3.0">Unicode License v3</h3>
<h4>Used by:</h4>
<ul class="license-used-by">
<li><a href=" https://github.com/unicode-org/icu4x ">writeable</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">yoke</a></li>
<li><a href=" https://github.com/unicode-org/icu4x ">yoke-derive</a></li>
</ul>
<pre class="license-text">UNICODE LICENSE V3

COPYRIGHT AND PERMISSION NOTICE

Copyright © 2020-2024 Unicode, Inc.

NOTICE TO USER: Carefully read the following legal agreement. BY
DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING DATA FILES, AND/OR
SOFTWARE, YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE
TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE, DO NOT
DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE THE DATA FILES OR SOFTWARE.

Permission is hereby granted, free of charge, to any person obtaining a
copy of data files and any associated documentation (the &quot;Data Files&quot;) or
software and any associated documentation (the &quot;Software&quot;) to deal in the
Data Files or Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, and/or sell
copies of the Data Files or Software, and to permit persons to whom the
Data Files or Software are furnished to do so, provided that either (a)
this copyright and permission notice appear with all copies of the Data
Files or Software, or (b) this copyright and permission notice appear in
associated Documentation.

THE DATA FILES AND SOFTWARE ARE PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
THIRD PARTY RIGHTS.

IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE
BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES,
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA
FILES OR SOFTWARE.

Except as contained in this notice, the name of a copyright holder shall
not be used in advertising or otherwise to promote the sale, use or other
dealings in these Data Files or Software without prior written
authorization of the copyright holder.

SPDX-License-Identifier: Unicode-3.0


Portions of ICU4X may have been adapted from ICU4C and/or ICU4J.
ICU 1.8.1 to ICU 57.1 © 1995-2016 International Business Machines Corporation and others.
</pre>
</li>
<li class="license">
Expand Down
Loading

0 comments on commit d623447

Please sign in to comment.