Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ describe("ProviderSheet", () => {
})

it("saves only changed visible options and preserves the machine mode", async () => {
const expression = "${PROVIDER_FOLDER}/config.json"
const expression = ["$", "{PROVIDER_FOLDER}/config.json"].join("")
providerOptions.mockResolvedValue({
CONFIG: { name: "CONFIG", default: expression },
HOST: { name: "HOST", default: "localhost" },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ describe("ProviderWizard", () => {
})

it("does not submit an untouched expression default", async () => {
const expression = "${PROVIDER_FOLDER}/config.json"
const expression = ["$", "{PROVIDER_FOLDER}/config.json"].join("")
providerOptions.mockResolvedValue({
CONFIG: { name: "CONFIG", default: expression },
})
Expand All @@ -243,7 +243,7 @@ describe("ProviderWizard", () => {
})

it("submits an explicitly edited expression default", async () => {
const expression = "${PROVIDER_FOLDER}/config.json"
const expression = ["$", "{PROVIDER_FOLDER}/config.json"].join("")
providerOptions.mockResolvedValue({
CONFIG: { name: "CONFIG", default: expression },
})
Expand Down
67 changes: 31 additions & 36 deletions pkg/compose/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,37 @@ type ComposeHelper struct {
invocationEnvironment map[string]string
}

func NewComposeHelper(dockerHelper *docker.DockerHelper) (*ComposeHelper, error) {
dockerCmd := dockerHelper.DockerCommand
if dockerCmd == "" {
dockerCmd = "docker"
}

type tryFunc func() (*ComposeHelper, error)

var detectors []tryFunc
if dockerHelper.GetRuntime().Name() == docker.RuntimePodman {
detectors = []tryFunc{
func() (*ComposeHelper, error) { return tryComposeSubcommand(dockerCmd) },
func() (*ComposeHelper, error) { return tryDockerComposeV2(dockerCmd) },
}
} else {
detectors = []tryFunc{
func() (*ComposeHelper, error) { return tryDockerComposeV2(dockerCmd) },
func() (*ComposeHelper, error) { return tryComposeSubcommand("podman") },
}
}

for _, detect := range detectors {
if helper, err := detect(); err == nil {
helper.Docker = dockerHelper
return helper, nil
}
}

return nil, fmt.Errorf("docker compose or podman compose not installed")
}

// WithInvocationEnvironment leaves the shared provider helper unchanged.
func (h *ComposeHelper) WithInvocationEnvironment(env map[string]string) *ComposeHelper {
clone := *h
Expand Down Expand Up @@ -121,42 +152,6 @@ func checkWSLgEnvFiles(candidates map[string]string) composecli.ProjectOptionsFn
}
}

// NewComposeHelper creates a new ComposeHelper instance after detecting whether
// Docker Compose V2 or Podman Compose is installed. The detection order depends
// on the container runtime: Podman runtimes try podman compose first, while
// Docker/nerdctl runtimes try docker compose V2 first. It returns an error if
// none are found.
func NewComposeHelper(dockerHelper *docker.DockerHelper) (*ComposeHelper, error) {
dockerCmd := dockerHelper.DockerCommand
if dockerCmd == "" {
dockerCmd = "docker"
}

type tryFunc func() (*ComposeHelper, error)

var detectors []tryFunc
if dockerHelper.GetRuntime().Name() == docker.RuntimePodman {
detectors = []tryFunc{
func() (*ComposeHelper, error) { return tryComposeSubcommand(dockerCmd) },
func() (*ComposeHelper, error) { return tryDockerComposeV2(dockerCmd) },
}
} else {
detectors = []tryFunc{
func() (*ComposeHelper, error) { return tryDockerComposeV2(dockerCmd) },
func() (*ComposeHelper, error) { return tryComposeSubcommand("podman") },
}
}

for _, detect := range detectors {
if helper, err := detect(); err == nil {
helper.Docker = dockerHelper
return helper, nil
}
}

return nil, fmt.Errorf("docker compose or podman compose not installed")
}

// tryDockerComposeV2 checks if Docker Compose V2 is available and returns a ComposeHelper if so.
// The Compose V2 plugin can be installed on linux using
//
Expand Down
136 changes: 100 additions & 36 deletions pkg/devcontainer/compose.go
Original file line number Diff line number Diff line change
Expand Up @@ -363,16 +363,13 @@ func (r *runner) ensureComposeContainer(
if err := r.checkWSLgReuse(containerDetails, options.Recreate); err != nil {
return nil, err
}
effectiveOptions, forceSecretRuntimeRefresh, err := r.composeSecretRuntimeOptions(
effectiveOptions, forceSecretRuntimeRefresh, err := r.effectiveComposeRuntimeOptions(
containerDetails,
options,
)
if err != nil {
return nil, err
}
if forceSecretRuntimeRefresh {
log.Info("workspace secrets require secure runtime mounts")
}

if existing, ok := r.reuseExistingCompose(ctx, params, containerDetails, effectiveOptions); ok {
return existing, nil
Expand Down Expand Up @@ -422,6 +419,23 @@ func (r *runner) reuseExistingCompose(
})
}

func (r *runner) effectiveComposeRuntimeOptions(
containerDetails *config.ContainerDetails,
options UpOptions,
) (UpOptions, bool, error) {
effectiveOptions, forceSecretRuntimeRefresh, err := r.composeSecretRuntimeOptions(
containerDetails,
options,
)
if err != nil {
return UpOptions{}, false, err
}
if forceSecretRuntimeRefresh {
log.Info("workspace secrets require secure runtime mounts")
}
return effectiveOptions, forceSecretRuntimeRefresh, nil
}

func (r *runner) composeSecretRuntimeOptions(
details *config.ContainerDetails,
options UpOptions,
Expand Down Expand Up @@ -1112,27 +1126,39 @@ func (r *runner) buildComposeOverrideArgs(

if override.path != "" {
composeGlobalArgs = append(composeGlobalArgs, "-f", override.path)
invocation := composeInvocation{
Version: 1,
Directory: start.project.WorkingDir,
Args: composeGlobalArgs,
}
if replay := r.wslgReplay(); replay != nil {
invocation.Version = 2
invocation.WSLg = replay
}
if err := recordComposeInvocation(composeInvocationRecord{
Path: override.path,
Service: start.parsedConfig.Config.Service,
Invocation: invocation,
}); err != nil {
if err := r.recordComposeOverrideInvocation(
start,
override.path,
composeGlobalArgs,
); err != nil {
return composeOverrideArgs{}, err
}
}

return composeOverrideArgs{args: composeGlobalArgs, contract: override.contract}, nil
}

func (r *runner) recordComposeOverrideInvocation(
start *startContainerParams,
overridePath string,
args []string,
) error {
invocation := composeInvocation{
Version: 1,
Directory: start.project.WorkingDir,
Args: args,
}
if replay := r.wslgReplay(); replay != nil {
invocation.Version = 2
invocation.WSLg = replay
}
return recordComposeInvocation(composeInvocationRecord{
Path: overridePath,
Service: start.parsedConfig.Config.Service,
Invocation: invocation,
})
}

func resolveComposeRuntimeImage(
ctx context.Context,
params *composeOverrideParams,
Expand Down Expand Up @@ -1188,30 +1214,51 @@ func (r *runner) marshalComposeContract(
})
}

func (r *runner) generateComposeUpOverride(
type composeOverrideMetadata struct {
mergedConfig *config.MergedDevContainerConfig
metadataValue []byte
hasOverlay bool
}

func resolveComposeOverrideMetadata(
ctx context.Context,
params *composeOverrideParams,
start *startContainerParams,
extendResult composeExtendResult,
imageDetails *config.ImageDetails,
) (composeOverrideFile, error) {
start := params.startParams

) (composeOverrideMetadata, error) {
overlay, err := overlayForParsedConfig(
ctx,
start.parsedConfig,
start.options.ExtraDevContainerPath,
)
if err != nil {
return composeOverrideFile{}, err
return composeOverrideMetadata{}, err
}
parsed := *start.parsedConfig
parsed.Overlay = overlay
mergedConfig, err := mergeImageMetadataConfig(ctx, &parsed, extendResult.imageMetadata, "")
if err != nil {
return composeOverrideFile{}, err
return composeOverrideMetadata{}, err
}
rawMetadata := overlayRawMetadata(extendResult.imageMetadata.Raw, overlay)
metadataValue, err := metadata.MarshalImageMetadata(rawMetadata)
if err != nil {
return composeOverrideMetadata{}, err
}
return composeOverrideMetadata{
mergedConfig: mergedConfig,
metadataValue: metadataValue,
hasOverlay: overlay != nil,
}, nil
}

func (r *runner) generateComposeUpOverride(
ctx context.Context,
params *composeOverrideParams,
extendResult composeExtendResult,
imageDetails *config.ImageDetails,
) (composeOverrideFile, error) {
start := params.startParams
meta, err := resolveComposeOverrideMetadata(ctx, start, extendResult)
if err != nil {
return composeOverrideFile{}, err
}
Expand All @@ -1222,26 +1269,25 @@ func (r *runner) generateComposeUpOverride(

contract, err := r.marshalComposeContract(
imageDetails,
string(metadataValue),
string(meta.metadataValue),
featureSignature,
overlay != nil,
meta.hasOverlay,
)
if err != nil {
return composeOverrideFile{}, err
}
additionalLabels, err := r.wslgLabels()
additionalLabels, err := r.resolveComposeOverrideLabels(
imageDetails,
meta.metadataValue,
contract,
structuralSignature(start.parsedConfig.Config),
)
if err != nil {
return composeOverrideFile{}, err
}
if additionalLabels == nil {
additionalLabels = map[string]string{}
}
maps.Copy(additionalLabels, composeOverrideLabels(
imageDetails, metadataValue, contract, structuralSignature(start.parsedConfig.Config),
))
overrideComposeUpFilePath, err := r.extendedDockerComposeUp(&composeUpParams{
parsedConfig: start.parsedConfig,
mergedConfig: mergedConfig,
mergedConfig: meta.mergedConfig,
composeHelper: start.composeHelper,
composeService: params.composeService,
originalImageName: params.originalImageName,
Expand All @@ -1258,6 +1304,24 @@ func (r *runner) generateComposeUpOverride(
return composeOverrideFile{path: overrideComposeUpFilePath, contract: string(contract)}, nil
}

func (r *runner) resolveComposeOverrideLabels(
imageDetails *config.ImageDetails,
metadataValue, contract []byte,
structure string,
) (map[string]string, error) {
additionalLabels, err := r.wslgLabels()
if err != nil {
return nil, err
}
if additionalLabels == nil {
additionalLabels = map[string]string{}
}
maps.Copy(additionalLabels, composeOverrideLabels(
imageDetails, metadataValue, contract, structure,
))
return additionalLabels, nil
}

// overlayRawMetadata persists only the established runtime metadata fields of
// the overlay, excluding feature options, host initialization, and
// source-selection inputs.
Expand Down
15 changes: 13 additions & 2 deletions pkg/devcontainer/config_overlay_lifecycle.go
Original file line number Diff line number Diff line change
Expand Up @@ -363,10 +363,21 @@ func validateComposeInvocationHeader(invocation composeInvocation) error {
len(invocation.Args)%2 != 0 {
return fmt.Errorf("invalid persisted Compose invocation")
}
if !utf8.ValidString(invocation.Directory) ||
strings.ContainsAny(invocation.Directory, "\x00\r\n") {
if err := validateInvocationDirectory(invocation.Directory); err != nil {
return err
}
return validateInvocationWSLg(invocation)
}

func validateInvocationDirectory(dir string) error {
if !utf8.ValidString(dir) ||
strings.ContainsAny(dir, "\x00\r\n") {
return fmt.Errorf("invalid persisted Compose directory")
}
return nil
}

func validateInvocationWSLg(invocation composeInvocation) error {
if invocation.Version == 2 {
return validateWSLgReplay(invocation.WSLg)
}
Expand Down
Loading
Loading