feature: Enhanced Client Awareness (v5) #6537

calvincestari · 2025-05-26T23:28:45Z

This adds support for the Enhanced Client Awareness request extensions; similar to apollographql/apollo-ios-dev#638 in Apollo iOS.

Note: This PR is against main which makes it part of a future v5 release.

svc-apollo-docs · 2025-05-26T23:29:33Z

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 2 changed, 0 removed

* (developer-tools)/kotlin/v5/advanced/compiler-plugins.mdx
* (developer-tools)/kotlin/v5/advanced/persisted-queries.mdx

Build ID: 8fb8ccfe3e3a5d14727ae11b

URL: https://www.apollographql.com/docs/deploy-preview/8fb8ccfe3e3a5d14727ae11b

calvincestari

@martinbonnin, @BoD - is this PR on the right track so far?

...lo-api/src/commonMain/kotlin/com/apollographql/apollo/api/http/DefaultHttpRequestComposer.kt

calvincestari · 2025-05-27T00:25:26Z

I'm not sure what the :apollo-api:jvmApiCheck is that's failing. We'll have to talk tomorrow..

calvincestari · 2025-05-27T00:25:56Z

I cancelled the tests-integration check, it looked like it was taking far too long.

martinbonnin

Nice 🚀

...lo-api/src/commonMain/kotlin/com/apollographql/apollo/api/http/DefaultHttpRequestComposer.kt

tests/integration-tests/src/commonTest/kotlin/test/BodyExtensionsTest.kt

tests/integration-tests/src/commonTest/kotlin/test/HttpRequestComposerTest.kt

calvincestari · 2025-06-06T01:51:30Z

@martinbonnin / @BoD - I think this is now ready for another review.

martinbonnin · 2025-06-06T12:07:57Z

...lo-api/src/commonMain/kotlin/com/apollographql/apollo/api/http/DefaultHttpRequestComposer.kt

+          }
+
+          if (sendEnhancedClientAwarenessExtensions) {
+            name("clientLibrary")


Do we have a reference that we could link as a comment here for future readers that would like more context for the feature?

...lo-api/src/commonMain/kotlin/com/apollographql/apollo/api/http/DefaultHttpRequestComposer.kt

calvincestari · 2025-06-06T21:26:09Z

OK, I believe this is now all done. 🎉

I think the only thing left to discuss about it is whether we want v5 or v4 + v5?

calvincestari · 2025-06-06T22:31:49Z

I've noticed that the tests-integration step appears stuck. I looked at the log and could not see any error so I'm not sure what the delay was - is this something that you've seen before?

calvincestari · 2025-06-06T22:36:40Z

I've noticed that the tests-integration step appears stuck. I looked at the log and could not see any error so I'm not sure what the delay was - is this something that you've seen before?

OK, I see what the issue is; there are some test failures but the logs do not make that obvious. Looks like the test fixtures need to be updated or this feature disabled in those tests. Here's an example:

test.LoggingInterceptorTest.levelBody[macosArm64] FAILED
    kotlin.AssertionError: Expected <post http://0.0.0.0/
    accept: multipart/mixed;deferspec=20220824, application/graphql-response+json, application/json
    [end of headers]
    {"operationname":"heroname","variables":{},"query":"query heroname { hero { name } }"}

    >, actual <post http://0.0.0.0/
    accept: multipart/mixed;deferspec=20220824, application/graphql-response+json, application/json
    [end of headers]
    {"operationname":"heroname","variables":{},"query":"query heroname { hero { name } }","extensions":{"clientlibrary":{"name":"apollo-kotlin","version":"5.0.0-snapshot"}}}

apollo-librarian · 2025-06-06T23:01:17Z

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 5 changed, 0 removed

* (developer-tools)/apollo-mcp-server/(latest)/command-reference.mdx
* (developer-tools)/kotlin/v5/advanced/compiler-plugins.mdx
* (developer-tools)/kotlin/v5/advanced/persisted-queries.mdx
* (developer-tools)/rover/commands/dev.mdx
* graphos/schema-design/federated-schemas/reference/moving-to-federation-2.mdx

Build ID: eb2155dce39d5e5df37fc967

URL: https://www.apollographql.com/docs/deploy-preview/eb2155dce39d5e5df37fc967

martinbonnin · 2025-06-06T23:04:56Z

Looks like the test fixtures need to be updated

Indeed, tests updated in 611b459

I've noticed that the tests-integration step appears stuck

This is usually when the JS test fail. The promise never returns and the test just hangs. Not 100% sure how to fix it.

calvincestari · 2025-06-06T23:11:34Z

@martinbonnin - I think in this case it might be better to turn off the feature because of the version string; the tests will all need to be updated each time a new version is released.

calvincestari · 2025-06-06T23:12:04Z

Oh wait..that was your commit updating them.

martinbonnin · 2025-06-06T23:19:49Z

I'd like to avoid those tests doing too much configuration. The drawback is that now the expected string is computed based on the current version instead of before it was a plain string literal but I think this is OKay.

martinbonnin · 2025-06-06T23:23:20Z

This is usually when the JS test fail

I just tested again by simulating an explicit failure and it worked well (after 2min still...). There is definitely something fishy in the JS test code but since this JS is not the highest used feature, I haven't taken the time to dive deep into this. Mid term I'm hoping that https://youtrack.jetbrains.com/issue/KT-58205/Kotlin-Gradle-Plugin-make-multiplatform-tests-build-cacheable makes this mostly indolore 🤞

calvincestari · 2025-06-06T23:26:08Z

Thanks for helping fix it. ❤️

BoD · 2025-06-10T08:16:57Z

tests/integration-tests/testFixtures/expectedOperationsPartBodyMultiple.json

I updated the release.main.kts script to take care of this

BoD

🙏

calvincestari · 2025-06-10T21:27:45Z

scripts/release.main.kts

@@ -243,6 +244,18 @@ fun setVersionInIntelliJPlugin(version: String) {
  }
 }

+fun setVersionInFixtures(nextSnapshot: String) {


calvincestari commented May 26, 2025

View reviewed changes

martinbonnin reviewed May 27, 2025

View reviewed changes

BoD reviewed May 27, 2025

View reviewed changes

...lo-api/src/commonMain/kotlin/com/apollographql/apollo/api/http/DefaultHttpRequestComposer.kt Outdated Show resolved Hide resolved

calvincestari added 3 commits June 2, 2025 14:36

Refactor HTTP body composers

d66dcdf

Remove duplicate extensions declaration

1b7d9c4

Reformat file

f4fc35d

calvincestari force-pushed the feature/enhanced-client-awareness branch from a4e432f to f4fc35d Compare June 2, 2025 21:36

calvincestari added 8 commits June 2, 2025 16:39

Use version constant

dbde14a

Add deprecated function

b6a81c7

Update API signature files

59c9786

Adds property to client and request

6a77434

Set value from request

0c03e8e

Update API signature files

6a9315d

Adds request composer test

7776056

Adds body extensions tests

641b3d0

calvincestari commented Jun 6, 2025

View reviewed changes

tests/integration-tests/src/commonTest/kotlin/test/BodyExtensionsTest.kt Show resolved Hide resolved

calvincestari commented Jun 6, 2025

View reviewed changes

tests/integration-tests/src/commonTest/kotlin/test/HttpRequestComposerTest.kt Outdated Show resolved Hide resolved

calvincestari marked this pull request as ready for review June 6, 2025 01:50

martinbonnin reviewed Jun 6, 2025

View reviewed changes

...lo-api/src/commonMain/kotlin/com/apollographql/apollo/api/http/DefaultHttpRequestComposer.kt Show resolved Hide resolved

calvincestari added 4 commits June 6, 2025 11:09

Remove unnecessary test

968506e

Refactor into single object and fix version

19d1ec8

Correctly set flag value

8e60dc7

Fix null test

ffdbff1

update tests

611b459

calvincestari changed the title ~~feature: Enhanced Client Awareness~~ feature: Enhanced Client Awareness (v5) Jun 9, 2025

Update fixtures when making a release

88ca4cc

BoD reviewed Jun 10, 2025

View reviewed changes

BoD approved these changes Jun 10, 2025

View reviewed changes

martinbonnin approved these changes Jun 10, 2025

View reviewed changes

martinbonnin merged commit 6aa22dc into main Jun 10, 2025
7 checks passed

martinbonnin deleted the feature/enhanced-client-awareness branch June 10, 2025 15:16

calvincestari commented Jun 10, 2025

View reviewed changes

calvincestari mentioned this pull request Jun 13, 2025

[4.x] Enhanced Client Awareness #6567

Merged

feature: Enhanced Client Awareness (v5) #6537

feature: Enhanced Client Awareness (v5) #6537

Uh oh!

Conversation

calvincestari commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

svc-apollo-docs commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Docs preview ready

Uh oh!

calvincestari left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

calvincestari commented May 27, 2025

Uh oh!

calvincestari commented May 27, 2025

Uh oh!

martinbonnin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

calvincestari commented Jun 6, 2025

Uh oh!

martinbonnin Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

calvincestari commented Jun 6, 2025

Uh oh!

calvincestari commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

calvincestari commented Jun 6, 2025

Uh oh!

apollo-librarian bot commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Docs preview ready

Uh oh!

martinbonnin commented Jun 6, 2025

Uh oh!

calvincestari commented Jun 6, 2025

Uh oh!

calvincestari commented Jun 6, 2025

Uh oh!

martinbonnin commented Jun 6, 2025

Uh oh!

martinbonnin commented Jun 6, 2025

Uh oh!

calvincestari commented Jun 6, 2025

Uh oh!

BoD Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

BoD left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

calvincestari Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

calvincestari commented May 26, 2025 •

edited

Loading

svc-apollo-docs commented May 26, 2025 •

edited

Loading

calvincestari commented Jun 6, 2025 •

edited

Loading

apollo-librarian bot commented Jun 6, 2025 •

edited

Loading