mirror of
https://github.com/docker/compose.git
synced 2026-10-12 02:13:08 +00:00
Nicolas De Loof
fc7c1efa4b
Wire the plan executor to the start-phase vocabulary the reconciler already produces (#14200): OpWaitCondition, OpRunPreStart, the enriched OpStartContainer, and OpRunPostStart all had no case in executeNode and hit "unknown operation type". Every operation reuses the exact imperative primitive it mirrors — waitDependency, runPreStart, runHook, injectSecrets/injectConfigs — so behavior and events cannot drift between the two engines: execWaitCondition resolves the dependency's live containers and hands off to the same polling/condition-check functions waitDependencies uses; the enriched OpStartContainer resolves its target either from the observed container or, for a replica the plan itself creates, from the CreateContainer node's result (the mechanism OpRenameContainer already relies on), then injects secrets/configs before ContainerStart; OpRunPreStart re-checks the daemon first so a replica that started in the observe-to-execute window skips a redundant hook run. A replica's pre_start/start/post_start chain shares one event group, reporting a single Starting→Started progression exactly like startServiceContainer does today — Starting fires specifically at StartContainer, not at the (silent) pre_start hooks preceding it. pkg/api/event.go documents this per-resource progression contract. Still inert in production: create() (executePlan's only caller never builds a plan with start-phase scope, so none of this runs outside tests until a later brick in epic #14081 wires a real caller. EOF ) Signed-off-by: Nicolas De Loof <[email protected]>
130 lines
4.1 KiB
Go
130 lines
4.1 KiB
Go
/*
|
|
Copyright 2020 Docker Compose CLI authors
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package api
|
|
|
|
import (
|
|
"context"
|
|
)
|
|
|
|
// EventStatus indicates the status of an action
|
|
type EventStatus int
|
|
|
|
const (
|
|
// Working means that the current task is working
|
|
Working EventStatus = iota
|
|
// Done means that the current task is done
|
|
Done
|
|
// Warning means that the current task has warning
|
|
Warning
|
|
// Error means that the current task has errored
|
|
Error
|
|
)
|
|
|
|
// ResourceCompose is a special resource ID used when event applies to all resources in the application
|
|
const ResourceCompose = "Compose"
|
|
|
|
const (
|
|
StatusError = "Error"
|
|
StatusCreating = "Creating"
|
|
StatusStarting = "Starting"
|
|
StatusStarted = "Started"
|
|
StatusWaiting = "Waiting"
|
|
StatusHealthy = "Healthy"
|
|
StatusExited = "Exited"
|
|
StatusRestarting = "Restarting"
|
|
StatusRestarted = "Restarted"
|
|
StatusRunning = "Running"
|
|
StatusCreated = "Created"
|
|
StatusStopping = "Stopping"
|
|
StatusStopped = "Stopped"
|
|
StatusKilling = "Killing"
|
|
StatusKilled = "Killed"
|
|
StatusRemoving = "Removing"
|
|
StatusRemoved = "Removed"
|
|
StatusBuilding = "Building"
|
|
StatusBuilt = "Built"
|
|
StatusPulling = "Pulling"
|
|
StatusPulled = "Pulled"
|
|
StatusCommitting = "Committing"
|
|
StatusCommitted = "Committed"
|
|
StatusCopying = "Copying"
|
|
StatusCopied = "Copied"
|
|
StatusExporting = "Exporting"
|
|
StatusExported = "Exported"
|
|
StatusDownloading = "Downloading"
|
|
StatusDownloadComplete = "Download complete"
|
|
StatusConfiguring = "Configuring"
|
|
StatusConfigured = "Configured"
|
|
)
|
|
|
|
// Resource represents status change and progress for a compose resource.
|
|
type Resource struct {
|
|
ID string
|
|
ParentID string
|
|
Text string
|
|
Details string
|
|
Status EventStatus
|
|
Current int64
|
|
Percent int
|
|
Total int64
|
|
}
|
|
|
|
func (e *Resource) StatusText() string {
|
|
switch e.Status {
|
|
case Working:
|
|
return "Working"
|
|
case Warning:
|
|
return "Warning"
|
|
case Done:
|
|
return "Done"
|
|
default:
|
|
return "Error"
|
|
}
|
|
}
|
|
|
|
// EventProcessor is notified about Compose operations and tasks
|
|
//
|
|
// # Event contract
|
|
//
|
|
// The event stream is ordered per resource, not globally: operations run
|
|
// concurrently and events of distinct resources interleave freely, but a
|
|
// given resource's events follow a fixed progression. Consumers must key on
|
|
// Resource.ID and must not rely on global ordering.
|
|
//
|
|
// Typical per-resource progressions (statuses from the Status* constants):
|
|
//
|
|
// container being created: Creating → Created
|
|
// container being started: Starting → Started (pre_start/post_start
|
|
// hooks, when declared, run silently within it)
|
|
// container being replaced: Recreate → Recreated
|
|
// container stop/removal: Stopping → Stopped, Removing → Removed
|
|
// dependency being waited: Waiting → Healthy | Exited
|
|
// networks and volumes: Creating → Created, Removing → Removed
|
|
//
|
|
// Any progression can end early with an Error status, or — for optional
|
|
// outcomes such as a dependency declared with required: false — with a
|
|
// Skipped status carrying the reason. Status texts are stable identifiers:
|
|
// tools may match on them.
|
|
type EventProcessor interface {
|
|
// Start is triggered as a Compose operation is starting with context
|
|
Start(ctx context.Context, operation string)
|
|
// On notify about (sub)task and progress processing operation
|
|
On(events ...Resource)
|
|
// Done is triggered as a Compose operation completed
|
|
Done(operation string, success bool)
|
|
}
|