Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
2.7.2
->2.8.0
2.7.2
->2.8.0
4.10.2
->4.10.4
v1.43.0
->v1.48.1
Release Notes
apollographql/federation (@apollo/composition)
v2.8.0
Compare Source
Minor Changes
Implement new directives to allow getting and setting context. This allows resolvers to reference and access data referenced by entities that exist in the GraphPath that was used to access the field. The following example demonstrates the ability to access the
prop
field within the Child resolver. (#2988)Patch Changes
Various set context bugfixes (#3017)
Updated dependencies [
c4744da360235d8bb8270ea048f0e0fa5d03be1e
,8a936d741a0c05835ff2533714cf330d18209179
,f5fe3e74d36722f78004c1e2e03c77d8b95cd6bf
]:v2.7.8
Compare Source
Patch Changes
Triggering a clean 2.7.8 release now that harmonizer build has been fixed. (#3010)
Updated dependencies [
2ad72802044310a528e8944f4538efe519424504
]:v2.7.7
Compare Source
Patch Changes
No logical changes since 2.7.5 or 2.7.6, but we fixed a bug in the release process, so we need to publish a new patch version (2.7.7). (#2999)
Updated dependencies [
bee0b0828b4fb6a1d3172ac330560e2ab6c046bb
]:v2.7.6
Compare Source
Patch Changes
There is no functionality change between 2.7.5 and 2.7.6. Triggering new release as previous one released partially leading to a broken experience. (#2997)
Updated dependencies []:
v2.7.5
Compare Source
Patch Changes
v2.7.4
Compare Source
Patch Changes
d80b7f0ca1456567a0866a32d2b2abf940598f77
]:v2.7.3
Compare Source
Patch Changes
Fix a query planning bug where invalid subgraph queries are generated with
reuseQueryFragments
set true. (#2952) (#2963)Updated dependencies [
ec04c50b4fb832bfd281ecf9c0c2dd7656431b96
,a494631918156f0431ceace74281c076cf1d5d51
]:apollographql/apollo-server (@apollo/server)
v4.10.4
Compare Source
Patch Changes
18a3827
Thanks @tninesling! - Subscription heartbeats are initialized prior to awaiting subscribe(). This allows long-running setup to happen in the returned Promise without the subscription being terminated prior to resolution.v4.10.3
Compare Source
Patch Changes
5f335a5
Thanks @tninesling! - Catch errors thrown by subscription generators, and gracefully clean up the subscription instead of crashing.apollographql/router (ghcr.io/apollographql/router)
v1.48.1
Compare Source
🐛 Fixes
Improve error message produced when a subgraph response doesn't include an expected
content-type
header value (Issue #5359)To improve a common debuggability challenge when a subgraph response doesn't contain an expected
content-type
header value, the error message produced will include additional details about the error.Some examples of the improved error message:
By @IvanGoncharov in https://github.com/apollographql/router/pull/5223
Update
apollo-compiler
for two small improvements (PR #5347)Updated our underlying
apollo-rs
dependency on ourapollo-compiler
crate to bring in two nice improvements:Fix validation performance bug
Adds a cache in fragment spread validation, fixing a situation where validating a query with many fragment spreads against a schema with many interfaces could take multiple seconds to validate.
Remove ariadne byte/char mapping
Generating JSON or CLI reports for apollo-compiler diagnostics used a translation layer between byte offsets and character offsets, which cost some computation and memory proportional to the size of the source text. The latest version of
ariadne
allows us to remove this translation.By @goto-bus-stop in https://github.com/apollographql/router/pull/5347
📃 Configuration
Rename the telemetry selector which obtains the GraphOS operation id (PR #5337)
Renames a misnamed
trace_id
selector introduced in v1.48.0 to the value which it actually represents which is an Apollo GraphOS operation ID, rather than a trace ID. Apologies for the confusion! Unfortunately, we aren't able to produce an Apollo GraphOS trace ID at this time.If you want to access this operation ID selector, here is an example of how to apply it to your tracing spans:
This can be useful for more easily locating the operation in GraphOS' Insights feature and finding applicable traces in Studio.
By @bnjjj in https://github.com/apollographql/router/pull/5337
v1.48.0
Compare Source
🚀 Features
Demand control preview (PR #5317)
Demand control allows you to control the cost of operations in the router, potentially rejecting requests that are too expensive that could bring down the Router or subgraphs.
Telemetry is emitted for demand control, including the estimated cost of operations and whether they were rejected or not.
Full details will be included in the documentation for demand control which will be finalized before the next release.
By @bryncooke in https://github.com/apollographql/router/pull/5317
Ability to include Apollo Studio trace ID on tracing spans (Issue #3803), (Issue #5172)
Add support for a new trace ID selector kind, the
apollo
trace ID, which represents the trace ID on Apollo GraphOS Studio.An example configuration using
trace_id: apollo
:By @bnjjj in https://github.com/apollographql/router/pull/5189
Add ability for router to deal with query plans with contextual rewrites (PR #5097)
Adds the ability for the router to execute query plans with context rewrites. A context is generated by the
@fromContext
directive, and each context maps values in the collected data JSON onto a variable that's used as an argument to a field resolver. To learn more, see Saving and referencing data with contexts.By @clenfest in https://github.com/apollographql/router/pull/5097
🐛 Fixes
Fix custom attributes for spans and histogram when used with
response_event
(PR #5221)This release fixes multiple issues related to spans and selectors:
on_graphql_error
selector is available on the supergraph stage.otel.status_code
attribute.As an example of using these fixes, the configuration below uses spans with static selectors to mark spans as errors when GraphQL errors occur:
By @bnjjj in https://github.com/apollographql/router/pull/5221
Fix instrument incrementing on aborted request when condition is not fulfilled (PR #5215)
Previously when a telemetry instrument was dropped it would be incremented even if the associated condition was not fulfilled. For instance:
In the case where a request was started, but the client aborted the request before the response was sent, the
response_header
would never be set to"never-received"
,and the instrument would not be triggered. However, the instrument would still be incremented.
Conditions are now checked for aborted requests, and the instrument is only incremented if the condition is fulfilled.
By @BrynCooke in https://github.com/apollographql/router/pull/5215
🛠 Maintenance
Send query planner and lifecycle metrics to Apollo (PR #5267, PR #5270)
To enable the performance measurement of the router's new query planner implementation, the router transmits to Apollo the following new metrics:
apollo.router.query_planning.*
provides metrics on the query planner that help improve the query planning implementation.apollo.router.lifecycle.api_schema
provides feedback on the experimental Rust-based API schema generation.apollo.router.lifecycle.license
provides metrics on license expiration that help improve the reliability of the license check mechanism.These metrics don't leak any sensitive data.
By @BrynCooke in https://github.com/apollographql/router/pull/5267, @goto-bus-stop
📚 Documentation
Add Rhai API constants reference
The Rhai API documentation now includes a list of available constants that are available in the Rhai runtime.
By @bnjjj in https://github.com/apollographql/router/pull/5189
🧪 Experimental
GraphQL instruments (PR #5215, PR #5257)
This PR adds experimental GraphQL instruments to telemetry.
The new instruments are configured in the following:
Using the new instruments consumes significant performance resources from the router. Their performance will be improved in a future release.
Large numbers of metrics may also be generated by using the instruments, so make sure to not incur excessively large APM costs.
⚠ Use these instruments only in development. Don't use them in production.
By @BrynCooke in https://github.com/apollographql/router/pull/5215 and https://github.com/apollographql/router/pull/5257
v1.47.0
Compare Source
🚀 Features
Support telemetry selectors with errors (Issue #5027)
The router now supports telemetry selectors that take into account the occurrence of errors. This capability enables you to create metrics, events, or span attributes that contain error messages.
For example, you can create a counter for the number of timed-out requests for subgraphs:
The router also can now compute new attributes upon receiving a new event in a supergraph response. With this capability, you can fetch data directly from the supergraph response body:
By @bnjjj in https://github.com/apollographql/router/pull/5022
Add support for
status_code
response to Rhai (Issue #5042)The router now supports
response.status_code
on theResponse
interface in Rhai.Examples using the response status code:
By @bnjjj in https://github.com/apollographql/router/pull/5045
Add gt and lt operators for telemetry conditions (PR #5048)
The router supports greater than (
gt
) and less than (lt
) operators for telemetry conditions. Similar to theeq
operator, the configuration for bothgt
andlt
takes two arguments as a list. Thegt
operator checks that the first argument is greater than the second, and thelt
operator checks that the first argument is less than the second. Other conditions such asgte
,lte
, andrange
can be made from combinations ofgt
,lt
,eq
, andall
.By @tninesling in https://github.com/apollographql/router/pull/5048
Expose busy timer APIs (PR #4989)
The router supports public APIs that native plugins can use to control when the router's busy timer is run.
The router's busy timer measures the time spent working on a request outside of waiting for external calls, like coprocessors and subgraph calls. It includes the time spent waiting for other concurrent requests to be handled (the wait time in the executor) to show the actual router overhead when handling requests.
The public methods are
Context::enter_active_request
andContext::busy_time
. The result is reported in theapollo_router_processing_time
metricFor details on using the APIs, see the documentation for
enter_active_request
.By @Geal in https://github.com/apollographql/router/pull/4989
🐛 Fixes
Reduce JSON schema size and Router memory footprint (PR #5061)
As we add more features to the Router the size of the JSON schema for the router configuration file continutes to grow. In particular, adding conditionals to telemetry in v1.46.0 significantly increased this size of the schema. This has a noticeable impact on initial memory footprint, although it does not impact service of requests.
The JSON schema for the router configuration file has been optimized from approximately 100k lines down to just over 7k.
This reduces the startup time of the Router and a smaller schema is more friendly for code editors.
By @BrynCooke in https://github.com/apollographql/router/pull/5061
Prevent query plan cache collision when planning options change (Issue #5093)
The router's hashing algorithm has been updated to prevent cache collisions when the router's configuration changes.
The router supports multiple options that affect the generated query plans, including:
defer_support
generate_query_fragments
experimental_reuse_query_fragments
experimental_type_conditioned_fetching
experimental_query_planner_mode
If distributed query plan caching is enabled, changing any of these options results in different query plans being generated and cached.
This could be problematic in the following scenarios:
To prevent these from happening, the router now creates a hash for the entire query planner configuration and includes it in the cache key.
By @Geal in https://github.com/apollographql/router/pull/5100
5xx internal server error responses returned as GraphQL structured errors (PR #5159)
Previously, the router returned internal server errors (5xx class) as plaintext to clients. Now in this release, the router returns these 5xx errors as structured GraphQL (for example,
{"errors": [...]}
).Internal server errors are returned upon unexpected or unrecoverable disruptions to the GraphQL request lifecycle execution. When these occur, the underlying error messages are logged at an
ERROR
level to the router's logs.By @BrynCooke in https://github.com/apollographql/router/pull/5159
Custom telemetry events not created when logging is disabled (PR #5165)
The router has been fixed to not create custom telemetry events when the log level is set to
off
.An example configuration with
level
set tooff
for a custom event:By @bnjjj in https://github.com/apollographql/router/pull/5165
Ensure that batch entry contexts are correctly preserved (PR #5162)
Previously, the router didn't use contexts correctly when processing batches. A representative context was chosen (the first item in a batch of items) and used to provide context functionality for all the generated responses.
The router now correctly preserves request contexts and uses them during response creation.
By @garypen in https://github.com/apollographql/router/pull/5162
Validate enum values in input variables (Issue #4633)
The router now validates enum values provided in JSON variables. Invalid enum values result in
GRAPHQL_VALIDATION_FAILED
errors.By @Geal in https://github.com/apollographql/router/pull/4753
Strip dashes from
trace_id
inCustomTraceIdPropagator
(Issue #4892)The router now strips dashes from trace IDs to ensure conformance with OpenTelemetry.
In OpenTelemetry, trace IDs are 128-bit values represented as hex strings without dashes, and they're based on W3C's trace ID format.
This has been applied within the router to
trace_id
inCustomTraceIdPropagator
.Note, if raw trace IDs from headers are represented by uuid4 and contain dashes, the dashes should be stripped so that the raw trace ID value can be parsed into a valid
trace_id
.By @kindermax in https://github.com/apollographql/router/pull/5071
v1.46.0
Compare Source
🚀 Features
Entity cache preview: support queries with private scope (PR #4855)
This feature is part of the work on subgraph entity caching, currently in preview.
The router now supports caching responses marked with
private
scope. This caching currently works only on subgraph responses without any schema-level information.For details about the caching behavior, see PR #4855
By @Geal in https://github.com/apollographql/router/pull/4855
Add support of custom events defined by YAML for telemetry (Issue #4320)
Users can now configure telemetry events via YAML
to log that something has happened (e.g. a request had errors of a particular type) without reaching for Rhai or a custom plugin.
Events may be triggered on conditions and can include information in the request/response pipeline as attributes.
Here is an example of configuration:
By @bnjjj in https://github.com/apollographql/router/pull/4956
Ability to ignore auth prefixes in the JWT plugin
The router now supports a configuration to ignore header prefixes with the JWT plugin. Given that many application headers use the format of
Authorization: <scheme> <token>
, this option enables the router to process requests for specific schemes within theAuthorization
header while ignoring others.For example, you can configure the router to process requests with
Authorization: Bearer <token>
defined while ignoring others such asAuthorization: Basic <token>
:If the header prefix is an empty string, this option is ignored.
By @lleadbet in https://github.com/apollographql/router/pull/4718
Support conditions on custom attributes for spans and a new selector for GraphQL errors (Issue #4336)
The router now supports conditionally adding attributes on a span and the new
on_graphql_error
selector that is set to true if the response body contains GraphQL errors.An example configuration using
condition
inattributes
andon_graphql_error
:By @bnjjj in https://github.com/apollographql/router/pull/4987
🐛 Fixes
Federation v2.7.5 (PR #5064)
This brings in a query planner fix released in v2.7.5 of Apollo Federation. Notably, from its changelog:
Fix issue with missing fragment definitions due to
generateQueryFragments
. (#2993)An incorrect implementation detail in
generateQueryFragments
caused certain queries to be missing fragment definitions, causing the operation to be invalid and fail early in the request life-cycle (before execution). Specifically, subsequent fragment "candidates" with the same type condition and the same length of selections as a previous fragment weren't correctly added to the list of fragments. An example of an affected query is:In this case, the second selection set would be converted to an inline fragment spread to subgraph fetches, but the fragment definition would be missing
By @garypen in https://github.com/apollographql/router/pull/5064
Use supergraph schema to extract authorization info (PR #5047)
The router now uses the supergraph schema to extract authorization info, as authorization information may not be available on the query planner's subgraph schemas. This reverts the authorization changes made in PR #4975.
By @tninesling in https://github.com/apollographql/router/pull/5047
Filter fetches added to batch during batch creation (PR #5034)
Previously, the router didn't filter query hashes when creating batches. This could result in failed queries because the additional hashes could incorrectly make a query appear to be committed when it wasn't actually registered in a batch.
This release fixes this issue by filtering query hashes during batch creation.
By @garypen in https://github.com/apollographql/router/pull/5034
Use
subgraph.name
attribute instead ofapollo.subgraph.name
(PR #5012)In the router v1.45.0, subgraph name mapping didn't work correctly in the Datadog exporter.
The Datadog exporter does some explicit mapping of attributes and was using a value
apollo.subgraph.name
that the latest versions of the router don't use. The correct choice issubgraph.name
.This release updates the mapping to reflect the change and fixes subgraph name mapping for Datadog.
By @garypen in https://github.com/apollographql/router/pull/5012
📚 Documentation
Document traffic shaping default configuration (PR #4953)
The documentation for configuring traffic shaping has been updated to clarify that it's enabled by default with preset values. This setting has been the default since PR #3330, which landed in v1.23.0.
By @bnjjj in https://github.com/apollographql/router/pull/4953
🧪 Experimental
Experimental type conditioned fetching (PR #4748)
This release introduces an experimental configuration to enable type-conditioned fetching.
Previously, when querying a field that was in a path of two or more unions, the query planner wasn't able to handle different selections and would aggressively collapse selections in fetches. This resulted in incorrect plans.
Enabling the
experimental_type_conditioned_fetching
option can fix this issue by configuring the query planner to fetch with type conditions.By @o0Ignition0o in https://github.com/apollographql/router/pull/4748
v1.45.1
Compare Source
🐛 Fixes
Correct v1.44.0 regression in query plan cache (PR #5028)
Correct a critical regression that was introduced in v1.44.0 which could lead to execution of an incorrect query plan. This issue only affects Routers that use distributed query plan caching, enabled via the
supergraph.query_planning.cache.redis.urls
configuration property.By @o0Ignition0o in https://github.com/apollographql/router/pull/5028
Use entire schema when hashing an introspection query (Issue #5006)
Correct a different hashing bug which impacted introspection queries which was also introduced in v1.44.0. This other hashing bug failed to account for introspection queries, resulting in introspection results being misaligned to the current schema. This issue only affects Routers that use distributed query plan caching, enabled via the
supergraph.query_planning.cache.redis.urls
configuration property.This release fixes the hashing mechanism by adding the schema string to hashed data if an introspection field is encountered. As a result, the entire schema is taken into account and the correct introspection result is returned.
By @Geal in https://github.com/apollographql/router/pull/5007
Fix subgraph name mapping of Datadog exporter (PR #5012)
Previously in the router v1.45.0, subgraph name mapping didn't work correctly in the router's Datadog exporter. The exporter used the incorrect value
apollo.subgraph.name
for mapping attributes when it should have used the valuesubgraph.name
. This issue has been fixed in this release.By @garypen in https://github.com/apollographql/router/pull/5012
v1.45.0
Compare Source
🚀 Features
Query validation process with Rust (PR #4551)
The router has been updated with a new Rust-based query validation process using
apollo-compiler
from theapollo-rs
project. It replaces the Javascript implementation in the query planner. It improves query planner performance by moving the validation out of the query planner and into the router service, which frees up space in the query planner cache.Because validation now happens earlier in the router service and not in the query planner, error paths in the query planner are no longer encountered. Some messages in error responses returned from invalid queries should now be more clear.
We've tested the new validation process by running it for months in production, concurrently with the JavaScript implementation, and have now completely transitioned to the Rust-based implementation.
By @Geal in https://github.com/apollographql/router/pull/4551
Add support for SHA256 hashing in Rhai (Issue #4939)
The router supports a new
sha256
module to create SHA256 hashes in Rhai scripts. The module supports thesha256::digest
function.An example script that uses the module:
By @lleadbet in https://github.com/apollographql/router/pull/4940
Subgraph support for query batching (Issue #2002)
As an extension to the ongoing work to support client-side query batching in the router, the router now supports batching of subgraph requests. Each subgraph batch request retains the same external format as a client batch request. This optimization reduces the number of round-trip requests from the router to subgraphs.
Also, batching in the router is now a generally available feature: the
experimental_batching
router configuration option has been deprecated and is replaced by thebatching
option.Previously, the router preserved the concept of a batch until a
RouterRequest
finished processing. From that point, the router converted each batch request item into a separateSupergraphRequest
, and the router planned and executed those requests concurrently within the router, then reassembled them into a batch ofRouterResponse
to return to the client. Now with the implementation in this release, the concept of a batch is extended so that batches are issued to configured subgraphs (all or named). Each batch request item is planned and executed separately, but the queries issued to subgraphs are optimally assembled into batches which observe the query constraints of the various batch items.To configure subgraph batching, you can enable
batching.subgraph.all
for all subgraphs. You can also enable batching per subgraph withbatching.subgraph.subgraphs.*
. For example:Note:
all
can be overridden bysubgraphs
. This applies in general for all router subgraph configuration options.To learn more, see query batching in Apollo docs.
By @garypen in https://github.com/apollographql/router/pull/4661
🐛 Fixes
Update
rustls
to v0.21.11, the latest v0.21.x patch (PR #4993)While the Router does use
rustls
, RUSTSEC-2024-0336 (also known as CVE-2024-32650 and GHSA-6g7w-8wpp-frhj) DOES NOT affect the Router since it usestokio-rustls
which is specifically called out in the advisory as unaffected.Despite the lack of impact, we update
rustls
version v0.21.10 to rustls v0.21.11 which includes a patch.By @tninesling in https://github.com/apollographql/router/pull/4993
Performance improvements for Apollo usage report field generation (PR 4951)
The performance of generating Apollo usage report signatures, stats keys, and referenced fields has been improved.
By @bonnici in https://github.com/apollographql/router/pull/4951
Apply alias rewrites to arrays (PR #4958)
The automatic aliasing rules introduced in #2489 to support
@interfaceObject
are now properly applied to lists.By @o0ignition0o in https://github.com/apollographql/router/pull/4958
Fix compatibility of coprocessor metric creation (PR #4930)
Previously, the router's execution stage created coprocessor metrics differently than other stages. This produced metrics with slight incompatibilities.
This release fixes the issue by creating coprocessor metrics in the same way as all other stages.
By @Geal in https://github.com/apollographql/router/pull/4930
📚 Documentation
Documentation updates for caching and metrics instruments (PR #4872)
Router documentation has been updated for a couple topics:
By @smyrick in https://github.com/apollographql/router/pull/4872
🧪 Experimental
Experimental: Introduce a pool of query planners (PR #4897)
The router supports a new experimental feature: a pool of query planners to parallelize query planning.
You can configure query planner pools with the
supergraph.query_planning.experimental_parallelism
option:Its value is the number of query planners that run in parallel, and its default value is
1
. You can set it to the special valueauto
to automatically set it equal to the number of available CPUs.You can discuss and comment about query planner pools in this GitHub discussion.
By @xuorig and @o0Ignition0o in https://github.com/apollographql/router/pull/4897
Experimental: Rust implementation of Apollo usage report field generation (PR 4796)
The router supports a new experimental Rust implementation for generating the stats report keys and referenced fields that are sent in Apollo usage reports. This implementation is one part of the effort to replace the router-bridge with native Rust code.
The feature is configured with the
experimental_apollo_metrics_generation_mode
setting. We recommend that you use its default value, so we can verify that it generates the same payloads as the previous implementation.By @bonnici in https://github.com/apollographql/router/pull/4796
v1.44.0
Compare Source
Correct a critical regression that was introduced in v1.44.0 which could lead to execution of an incorrect query plan. This issue only affects Routers that use distributed query plan caching, enabled via the
supergraph.query_planning.cache.redis.urls
configuration property.By @o0Ignition0o in https://github.com/apollographql/router/pull/5028
v1.43.2
Compare Source
🐛 Fixes
Security fix: update h2 dependency
References:
The router's performance could be degraded when receiving a flood of HTTP/2 CONTINUATION frames, when the Router is set up to terminate TLS for client connections.
By @geal
[
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.