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
16 changes: 6 additions & 10 deletions cmd/ci/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ import (
)

func newStatusReporter(out io.Writer, verbose bool) (status.Reporter, error) {
reporter, err := status.NewReporter(status.ReporterOptions{
Format: "plain",
Out: out,
Prefix: "ci",
Verbose: verbose,
SuppressFailureDetails: true,
return status.NewCLIReporter(status.CLIOptions{
Format: "plain",
Out: out,
Prefix: "ci",
Verbose: verbose,
Pipeline: status.PipelineWorkspaceUp,
Labels: map[status.Phase]string{
status.PhaseCloningRepository: "cloning repository",
status.PhaseResolvingConfig: "resolving devcontainer config",
Expand All @@ -29,8 +29,4 @@ func newStatusReporter(out io.Writer, verbose bool) (status.Reporter, error) {
},
Envelope: func(status.Event) error { return nil },
})
if err != nil {
return nil, err
}
return status.ForPipeline(reporter, status.PipelineWorkspaceUp), nil
}
16 changes: 6 additions & 10 deletions cmd/config/apply.go
Original file line number Diff line number Diff line change
Expand Up @@ -173,12 +173,12 @@ func (cmd *ApplyCmd) prepareContainer(
}

func newStatusReporter(resultFormat string, out io.Writer, verbose bool) (status.Reporter, error) {
reporter, err := status.NewReporter(status.ReporterOptions{
Format: resultFormat,
Out: out,
Prefix: "config",
Verbose: verbose,
SuppressFailureDetails: true,
return status.NewCLIReporter(status.CLIOptions{
Format: resultFormat,
Out: out,
Prefix: "config",
Verbose: verbose,
Pipeline: status.PipelineWorkspaceUp,
Labels: map[status.Phase]string{
status.PhaseResolvingConfig: "resolving devcontainer config",
status.PhaseRunningLifecycleHook: "applying lifecycle configuration",
Expand All @@ -188,10 +188,6 @@ func newStatusReporter(resultFormat string, out io.Writer, verbose bool) (status
return devcconfig.WriteStatusJSON(out, e)
},
})
if err != nil {
return nil, err
}
return status.ForPipeline(reporter, status.PipelineWorkspaceUp), nil
}

func (cmd *ApplyCmd) resolveDockerPath() string {
Expand Down
18 changes: 7 additions & 11 deletions cmd/provider/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,17 @@ func newStatusReporter(
verbose ...bool,
) (status.Reporter, error) {
showDurations := len(verbose) > 0 && verbose[0]
r, err := status.NewReporter(status.ReporterOptions{
Format: resultFormat,
Out: out,
Prefix: "provider",
Labels: phaseLabels,
Verbose: showDurations,
SuppressFailureDetails: true,
return status.NewCLIReporter(status.CLIOptions{
Format: resultFormat,
Out: out,
Prefix: "provider",
Verbose: showDurations,
Pipeline: status.PipelineProvider,
Labels: phaseLabels,
Envelope: func(e status.Event) error {
return config2.WriteStatusJSON(out, e)
},
})
if err != nil {
return nil, err
}
return status.ForPipeline(r, status.PipelineProvider), nil
}

var phaseLabels = map[status.Phase]string{
Expand Down
18 changes: 7 additions & 11 deletions cmd/workspace/up/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,17 @@ func newStatusReporter(
verbose ...bool,
) (status.Reporter, error) {
showDurations := len(verbose) > 0 && verbose[0]
r, err := status.NewReporter(status.ReporterOptions{
Format: resultFormat,
Out: out,
Prefix: "up",
Labels: phaseLabels,
Verbose: showDurations,
SuppressFailureDetails: true,
return status.NewCLIReporter(status.CLIOptions{
Format: resultFormat,
Out: out,
Prefix: "up",
Verbose: showDurations,
Pipeline: status.PipelineWorkspaceUp,
Labels: phaseLabels,
Envelope: func(e status.Event) error {
return config2.WriteStatusJSON(out, e)
},
})
if err != nil {
return nil, err
}
return status.ForPipeline(r, status.PipelineWorkspaceUp), nil
}

var phaseLabels = map[status.Phase]string{
Expand Down
30 changes: 30 additions & 0 deletions pkg/status/render.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,36 @@ func NewReporter(opts ReporterOptions) (Reporter, error) {
return newReporter(resolveFormat(opts), opts)
}

// CLIOptions configures the progress reporter for a CLI command.
type CLIOptions struct {
Format string
Out io.Writer
Prefix string
Pipeline Pipeline
Labels map[Phase]string
Envelope func(Event) error
Verbose bool
}

// NewCLIReporter builds the progress reporter for CLI commands: NewReporter
// with failure details left to the command boundary, and every event stamped
// with o.Pipeline.
func NewCLIReporter(o CLIOptions) (Reporter, error) {
r, err := NewReporter(ReporterOptions{
Format: o.Format,
Out: o.Out,
Prefix: o.Prefix,
Labels: o.Labels,
Envelope: o.Envelope,
Verbose: o.Verbose,
SuppressFailureDetails: true,
})
if err != nil {
return nil, err
}
return ForPipeline(r, o.Pipeline), nil
}

func resolveFormat(opts ReporterOptions) string {
format := opts.Format
if format == "" {
Expand Down
Loading