crunchloop / crunchloop/devcontainer

compose: RenderEntrypointWrapper doesn't gate entrypoint/command on overrideCommand

Open
#104 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
5
Forks
0
Avg merge
6h 17m
Merged PRs (30d)
15

Description

## Summary

`compose.RenderEntrypointWrapper` (added in #103) is a faithful port of the reference `devcontainers/cli` `generateFeaturesComposeOverrideContent`, with one deliberate gap: it does **not** implement `overrideCommand` gating of the original entrypoint/command.

## Reference behavior

In `src/spec-node/dockerCompose.ts` the CLI computes:

```ts
const userEntrypoint = overrideCommand ? [] : composeEntrypoint || (imageEntrypoint…);
const userCommand = overrideCommand ? [] : composeCommand || (imageCmd…);
// …emits `command: ` only when userCommand !== composeCommand
```

When `overrideCommand` is **true**, both the original entrypoint and command are zeroed — the generated wrapper runs the feature entrypoints, then `exec "$@"` hits empty args and falls through to the `while sleep 1 & wait $!; do :; done` keep-alive.

## Our behavior

`RenderEntrypointWrapper` always preserves the original entrypoint (service's `entrypoint:`, else the image `ENTRYPOINT`) and never zeroes the command or emits a `command:` override. We do not read `cfg.OverrideCommand` on the compose path at all (`serviceToRunSpec` also ignores it).

## Why this is low priority

Per the dev container spec, `overrideCommand` defaults to **false for Docker Compose** (true only for image/Dockerfile). With it false, the reference takes the `composeEntrypoint || …` / `composeCommand || …` branches — i.e. preserves exactly what we preserve. So for the default compose case (and the DAP devcontainer this was built for), our output is behaviorally equivalent to upstream.

The only divergence is an explicit `"overrideCommand": true` on a **compose** devcontainer: upstream would drop the service command and rely on the wrapper's keep-alive; we keep the command.

## Options

- Implement `overrideCommand` gating in the compose path for full parity (zero entrypoint/command + emit keep-alive command when `overrideCommand` is true), or
- Leave as-is and document the limitation.

## Related

- PR #103 (compose feature security metadata + entrypoint chaining)
- Separate follow-up: image-source (non-compose) entrypoint chaining is also not yet implemented (`newRunSpec` doesn't consume `cfg.Entrypoints`).

Contributor guide

Open the contributing guide

Research direction

Start by locating compose.RenderEntrypointWrapper and serviceToRunSpec, then compare their behavior with src/spec-node/dockerCompose.ts and the newRunSpec path. Verify how cfg.OverrideCommand is represented and test the explicit compose overrideCommand=true case. Done means either matching upstream by zeroing the entrypoint and command with the keep-alive behavior, or documenting the limitation if that option is chosen.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose, go
Domain
devops, infrastructure
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.