Skip to content
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

prep release: v1.33.0 #4046

Merged
merged 5 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .changesets/config_bryn_telemetry_enabled_field.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changesets/docs_eh_docs_k8s_deployment.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changesets/docs_garypen_3838_document_buffering.md

This file was deleted.

9 changes: 0 additions & 9 deletions .changesets/feat_bryn_coprocessor_has_next.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changesets/feat_expose_topology_spread_constraints.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changesets/fix_bryn_fix_coprocessor_stream.md

This file was deleted.

7 changes: 0 additions & 7 deletions .changesets/fix_garypen_3853_jwks_improve.md

This file was deleted.

7 changes: 0 additions & 7 deletions .changesets/fix_garypen_3956_fix_batching_defer_check.md

This file was deleted.

7 changes: 0 additions & 7 deletions .changesets/fix_geal_compression_minimal_output_size.md

This file was deleted.

9 changes: 0 additions & 9 deletions .changesets/fix_geal_idle_connections.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changesets/fix_geal_requires_selection_fix.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changesets/maint_garypen_3998_fix_tls.md

This file was deleted.

115 changes: 115 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,121 @@ 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.33.0] - 2023-10-17

## 🚀 Features

### Add `hasNext` to SupergraphRequest ([Issue #4016](https://github.com/apollographql/router/issues/4016))

Coprocessors multi-part response support has been enhanced to include `hasNext`, allowing you to determine when a request has completed.

When `stage` is `SupergraphResponse`, `hasNext` if present and `true` indicates that there will be subsequent `SupergraphResponse` calls to the co-processor for each multi-part (`@defer`/subscriptions) response.

See the [coprocessor documentation](https://www.apollographql.com/docs/router/customizations/coprocessor/) for more details.

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

### Expose the ability to set topology spread constraints on the helm chart ([3891](https://github.com/apollographql/router/issues/3891))

Give developers the ability to set topology spread constraints that can be used to guarantee that federation pods are spread out evenly across AZs.

By [bjoern](https://github.com/bjoernw) in https://github.com/apollographql/router/pull/3892

## 🐛 Fixes

### Ignore JWKS keys which aren't supported by the router ([Issue #3853](https://github.com/apollographql/router/issues/3853))

If you have a JWKS which contains a key which has an algorithm (alg) which the router doesn't recognise, then the entire JWKS is disregarded even if there were other keys in the JWKS which the router could use.

We have changed the JWKS processing logic so that we remove entries with an unrecognised algorithm from the list of available keys. We print a warning with the name of the algorithm for each removed entry.

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

### Fix panic when streaming responses to co-processor ([Issue #4013](https://github.com/apollographql/router/issues/4013))

Streamed responses will no longer cause a panic in the co-processor plugin. This affected defer and stream queries.

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

### Only reject defer/subscriptions if actually part of a batch ([Issue #3956](https://github.com/apollographql/router/issues/3956))

Fix the checking logic so that deferred queries or subscriptions will only be rejected when experimental batching is enabled and the operations are part of a batch.

Without this fix, all subscriptions or deferred queries would be rejected when experimental batching support was enabled.

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

### Fix requires selection in arrays ([Issue #3972](https://github.com/apollographql/router/issues/3972))

When a field has a `@requires` annotation that selects an array, and some fields are missing in that array or some of the elements are null, the router would short circuit the selection and remove the entire array. This relaxes the condition to allow nulls in the selected array

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

### Fix router hang when opening the explorer, prometheus or health check page ([Issue #3941](https://github.com/apollographql/router/issues/3941))

The Router did not gracefully shutdown when an idle connections are made by a client, and would instead hang. In particular, web browsers make such connection in anticipation of future traffic.

This is now fixed, and the Router will now gracefully shut down in a timely fashion.

---
bnjjj marked this conversation as resolved.
Show resolved Hide resolved

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

### Fix hang and high CPU usage when compressing small responses ([PR #3961](https://github.com/apollographql/router/pull/3961))

When returning small responses (less than 10 bytes) and compressing them using gzip, the router could go into an infinite loop

---
bnjjj marked this conversation as resolved.
Show resolved Hide resolved

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

## 📃 Configuration

### Add `enabled` field for telemetry exporters ([PR #3952](https://github.com/apollographql/router/pull/3952))

Telemetry configuration now supports `enabled` on all exporters. This allows exporters to be disabled without removing them from the configuration and in addition allows for a more streamlined default configuration.

```diff
telemetry:
tracing:
datadog:
+ enabled: true
jaeger:
+ enabled: true
otlp:
+ enabled: true
zipkin:
+ enabled: true
```

Existing configurations will be migrated to the new format automatically on startup. However, you should update your configuration to use the new format as soon as possible.

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

## 🛠 Maintenance

### Create a replacement self-signed server certificate: 10 years lifespan ([Issue #3998](https://github.com/apollographql/router/issues/3998))

This certificate is only used for testing, so 10 years lifespan is acceptable.

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

## 📚 Documentation

### Updated documentation for deploying router ([PR #3943](https://github.com/apollographql/router/pull/3943))

Updated documentation for containerized router deployments, with guides and examples for [deploying on Kubernetes](https://www.apollographql.com/docs/router/containerization/kubernetes) and [running on Docker](https://www.apollographql.com/docs/router/containerization/docker).

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

### Document guidance for request and response buffering ([Issue #3838](https://github.com/apollographql/router/issues/3838))

Provides specific guidance on request and response buffering within the router.

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



# [1.32.0] - 2023-10-04

## 🚀 Features
Expand Down
6 changes: 3 additions & 3 deletions Cargo.lock
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ dependencies = [

[[package]]
name = "apollo-router"
version = "1.32.0"
version = "1.33.0"
dependencies = [
"access-json",
"anyhow",
Expand Down Expand Up @@ -415,7 +415,7 @@ dependencies = [

[[package]]
name = "apollo-router-benchmarks"
version = "1.32.0"
version = "1.33.0"
dependencies = [
"apollo-parser 0.6.3",
"apollo-router",
Expand All @@ -431,7 +431,7 @@ dependencies = [

[[package]]
name = "apollo-router-scaffold"
version = "1.32.0"
version = "1.33.0"
dependencies = [
"anyhow",
"cargo-scaffold",
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.32.0"
version = "1.33.0"
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.32.0"
version = "1.33.0"
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.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.32.0"
apollo-router = "1.33.0"
{{/if}}
{{/if}}
async-trait = "0.1.52"
Expand Down
2 changes: 1 addition & 1 deletion apollo-router-scaffold/templates/base/xtask/Cargo.toml
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.32.0" }
apollo-router-scaffold = { git = "https://github.com/apollographql/router.git", tag = "v1.33.0" }
{{/if}}
{{/if}}
anyhow = "1.0.58"
Expand Down
2 changes: 1 addition & 1 deletion apollo-router/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "apollo-router"
version = "1.32.0"
version = "1.33.0"
authors = ["Apollo Graph, Inc. <[email protected]>"]
repository = "https://github.com/apollographql/router/"
documentation = "https://docs.rs/apollo-router"
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.32.0
image: ghcr.io/apollographql/router:v1.33.0
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.32.0
image: ghcr.io/apollographql/router:v1.33.0
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.32.0
image: ghcr.io/apollographql/router:v1.33.0
volumes:
- ./supergraph.graphql:/etc/config/supergraph.graphql
- ./router/zipkin.router.yaml:/etc/config/configuration.yaml
Expand Down
8 changes: 8 additions & 0 deletions docs/source/federation-version-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ The table below shows which version of federation each router release is compile
</tr>
</thead>
<tbody>
<tr>
<td>
v1.32.1 and later (<a href="https://github.com/apollographql/router/releases">see latest releases</a>)
bnjjj marked this conversation as resolved.
Show resolved Hide resolved
</td>
<td>
2.5.5
</td>
</tr>
<tr>
<td>
v1.30.0 and later (<a href="https://github.com/apollographql/router/releases">see latest releases</a>)
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.32.0
version: 1.33.0

# 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.32.0"
appVersion: "v1.33.0"
10 changes: 7 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.32.0](https://img.shields.io/badge/Version-1.32.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.32.0](https://img.shields.io/badge/AppVersion-v1.32.0-informational?style=flat-square)
![Version: 1.33.0](https://img.shields.io/badge/Version-1.33.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.33.0](https://img.shields.io/badge/AppVersion-v1.33.0-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.32.0
helm pull oci://ghcr.io/apollographql/helm-charts/router --version 1.33.0
```

## Install Chart

**Important:** only helm3 is supported

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

_See [configuration](#configuration) below._
Expand Down Expand Up @@ -91,4 +91,8 @@ helm show values oci://ghcr.io/apollographql/helm-charts/router
| supergraphFile | string | `nil` | |
| terminationGracePeriodSeconds | int | `30` | Sets the [termination grace period](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#hook-handler-execution) for Deployment pods |
| tolerations | list | `[]` | |
| topologySpreadConstraints | list | `[]` | Sets the [topology spread constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) for Deployment pods |
| virtualservice.enabled | bool | `false` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Loading