pkg/compose: use negotiated API version for network setup by glours · Pull Request #13690 · docker/compose

glours · 2026-03-30T13:32:10Z

What I did
This branch changes the API-version plumbing more generally, even if the immediate consumer is the container create path. A better short PR description would be:

This PR makes Compose distinguish between the raw daemon API version and the negotiated client API version.

It adds per-service caching for both values on composeService, introduces CurrentAPIVersion() for callers that need the effective negotiated version, and keeps RuntimeVersion() for raw daemon capability checks.

This avoids using ServerVersion().APIVersion in places where request shaping should follow the client’s negotiated API level.

Targeted tests were added to cover the create path and to verify negotiated API lookup is cached per service instance.

Related issue
N/A

(not mandatory) A picture of a cute animal, if possible in relation to what you did

Copilot

Pull request overview

This PR updates Compose’s API-version plumbing to distinguish between the daemon’s raw API version and the client’s negotiated/effective API version, and applies the negotiated version to request-shaping in the container create/network setup path.

Changes:

Add per-composeService caching for both raw daemon API version (RuntimeVersion) and negotiated client API version (CurrentAPIVersion).
Switch container create networking config to use CurrentAPIVersion() (negotiated) instead of RuntimeVersion() (raw server).
Update internal helpers to use pointer receivers (avoids copying newly-added per-service caches) and extend tests to cover negotiated API version caching.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
pkg/compose/compose.go	Introduces per-service version caches and adds `CurrentAPIVersion()` alongside `RuntimeVersion()`.
pkg/compose/create.go	Uses negotiated API version for network request shaping; clarifies when raw daemon version is required for capability checks.
pkg/compose/images.go	Clarifies use of raw daemon version for capability checks (ImageInspect platform handling).
pkg/compose/hook.go	Switches helpers to pointer receivers to avoid copying service state/caches.
pkg/compose/build_bake.go	Switches dry-run bake helpers to pointer receivers to avoid copying service state/caches.
pkg/compose/convergence_test.go	Updates create-path mocks to use API negotiation and adds a test validating per-service negotiation caching.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pkg/compose/compose.go

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pkg/compose/compose.go

pkg/compose/create.go

pkg/compose/images.go

thaJeztah · 2026-03-30T15:59:20Z

Damn you, tests! 😂

#18 54.92 === RUN   TestImages
#18 54.92     compose.go:536: Unexpected call to *mocks.MockAPIClient.Ping([context.Background.WithCancel {true false}]) at /src/pkg/compose/compose.go:536 because: there are no expected calls of the method "Ping" for that receiver
#18 54.92     controller.go:251: missing call(s) to *mocks.MockAPIClient.ImageInspect(is assignable to , is equal to bar:2 (string)) /src/pkg/compose/images_test.go:52
#18 54.92     controller.go:251: aborting test due to missing call(s)
#18 54.92 --- FAIL: TestImages (0.00s)

thaJeztah

LGTM

ndeloof · 2026-03-31T08:46:57Z

pkg/compose/compose.go

+// RuntimeVersion returns the raw API version reported by the daemon.
+// Callers that need the negotiated/effective client API version should use
+// CurrentAPIVersion instead.
 func (s *composeService) RuntimeVersion(ctx context.Context) (string, error) {


We should only rely on CurrentAPIVersion, as after API has been negociated, if for some reason uses a version < runtime version, compose should never rely on features or request attributes not defined by this API version.
I suggest you merge both functions into RuntimeAPIVersion and use it everywhere we depend on Engine's features

Indeed, I'll do it right now

Move runtimeVersionCache from a package-level var to per-instance fields on composeService and add CurrentAPIVersion() that negotiates via Ping before returning the client version. Switch getCreateConfigs and buildContainerVolumes to use CurrentAPIVersion so that version-gated request shaping matches what the daemon actually validates against (the negotiated API version from the request path, not the server's max capability). Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Guillaume Lours <[email protected]>

…fields Moving runtimeVersionCache from a package-level var to instance fields on composeService caused copylocks violations in methods using value receivers, since sync.Once contains sync.noCopy. Switch the 4 affected methods to pointer receivers. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Guillaume Lours <[email protected]>

Replace sync.Once with sync.Mutex so that only successful version lookups are cached. Errors (context cancellation, network blips) are returned without caching, allowing subsequent calls to retry. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Guillaume Lours <[email protected]>

…ersion After API negotiation, Compose should only rely on the negotiated version and never use the daemon's raw max version for request shaping. Merge both functions into a single RuntimeAPIVersion that negotiates via Ping and returns ClientVersion, erroring if the client reports an empty version instead of silently falling back to ServerVersion. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Guillaume Lours <[email protected]>

glours requested a review from a team as a code owner March 30, 2026 13:32

glours requested review from Copilot and ndeloof and removed request for Copilot March 30, 2026 13:32

glours mentioned this pull request Mar 30, 2026

fix: restore post-connect fallback for multi-network stacks on API < 1.44 #13629

Merged

Copilot AI review requested due to automatic review settings March 30, 2026 13:56

Copilot started reviewing on behalf of glours March 30, 2026 13:57 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

pkg/compose/compose.go Outdated Show resolved Hide resolved

glours force-pushed the fix/negotiated-api-version-main branch from 1eedd3e to cd04968 Compare March 30, 2026 14:55

glours requested a review from Copilot March 30, 2026 15:00

Copilot started reviewing on behalf of glours March 30, 2026 15:01 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

pkg/compose/compose.go Show resolved Hide resolved

pkg/compose/compose.go Outdated Show resolved Hide resolved

thaJeztah reviewed Mar 30, 2026

View reviewed changes

pkg/compose/create.go Outdated Show resolved Hide resolved

glours force-pushed the fix/negotiated-api-version-main branch 3 times, most recently from 6a527d4 to ac0d46d Compare March 30, 2026 15:32

thaJeztah reviewed Mar 30, 2026

View reviewed changes

pkg/compose/images.go Outdated Show resolved Hide resolved

glours force-pushed the fix/negotiated-api-version-main branch from ac0d46d to 232b8f2 Compare March 30, 2026 15:54

glours force-pushed the fix/negotiated-api-version-main branch from 232b8f2 to 3174600 Compare March 30, 2026 17:03

thaJeztah approved these changes Mar 30, 2026

View reviewed changes

ndeloof requested changes Mar 31, 2026

View reviewed changes

glours and others added 3 commits March 31, 2026 10:51

ndeloof enabled auto-merge (rebase) March 31, 2026 08:59

glours force-pushed the fix/negotiated-api-version-main branch from 3174600 to 1059a7c Compare March 31, 2026 09:24

glours requested a review from ndeloof March 31, 2026 09:26

ndeloof approved these changes Mar 31, 2026

View reviewed changes

ndeloof merged commit 9cab439 into main Mar 31, 2026
79 of 80 checks passed

ndeloof deleted the fix/negotiated-api-version-main branch March 31, 2026 12:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pkg/compose: use negotiated API version for network setup#13690

pkg/compose: use negotiated API version for network setup#13690
ndeloof merged 4 commits intomainfrom
fix/negotiated-api-version-main

glours commented Mar 30, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thaJeztah commented Mar 30, 2026

Uh oh!

thaJeztah left a comment

Uh oh!

ndeloof Mar 31, 2026

Uh oh!

glours Mar 31, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

glours commented Mar 30, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thaJeztah commented Mar 30, 2026

Uh oh!

thaJeztah left a comment

Choose a reason for hiding this comment

Uh oh!

ndeloof Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

glours Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants