Skip to content

Commit 576aa46

Browse files
ndeloofndeloof
authored
Merge pull request docker-archive#1015 from docker/logConsumer
Revisit logs/up API to pass a LogConsumer vs io.Writer
2 parents f8bf0ac + ca123e0 commit 576aa46

File tree

11 files changed

+110
-97
lines changed

11 files changed

+110
-97
lines changed

‎aci/compose.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ package aci
1919
import (
2020
"context"
2121
"fmt"
22-
"io"
2322
"net/http"
2423

2524
"github.com/compose-spec/compose-go/types"
@@ -60,7 +59,7 @@ func (cs *aciComposeService) Create(ctx context.Context, project *types.Project)
6059
return errdefs.ErrNotImplemented
6160
}
6261

63-
func (cs *aciComposeService) Start(ctx context.Context, project *types.Project, w io.Writer) error {
62+
func (cs *aciComposeService) Start(ctx context.Context, project *types.Project, consumer compose.LogConsumer) error {
6463
return errdefs.ErrNotImplemented
6564
}
6665

@@ -176,7 +175,7 @@ func (cs *aciComposeService) List(ctx context.Context, project string) ([]compos
176175
return stacks, nil
177176
}
178177

179-
func (cs *aciComposeService) Logs(ctx context.Context, project string, w io.Writer) error {
178+
func (cs *aciComposeService) Logs(ctx context.Context, projectName string, consumer compose.LogConsumer) error {
180179
return errdefs.ErrNotImplemented
181180
}
182181

‎api/client/compose.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,11 @@ package client
1818

1919
import (
2020
"context"
21-
"io"
22-
23-
"github.com/compose-spec/compose-go/types"
2421

2522
"github.com/docker/compose-cli/api/compose"
2623
"github.com/docker/compose-cli/errdefs"
24+
25+
"github.com/compose-spec/compose-go/types"
2726
)
2827

2928
type composeService struct {
@@ -45,7 +44,7 @@ func (c *composeService) Create(ctx context.Context, project *types.Project) err
4544
return errdefs.ErrNotImplemented
4645
}
4746

48-
func (c *composeService) Start(ctx context.Context, project *types.Project, w io.Writer) error {
47+
func (c *composeService) Start(ctx context.Context, project *types.Project, consumer compose.LogConsumer) error {
4948
return errdefs.ErrNotImplemented
5049
}
5150

@@ -57,7 +56,7 @@ func (c *composeService) Down(context.Context, string) error {
5756
return errdefs.ErrNotImplemented
5857
}
5958

60-
func (c *composeService) Logs(context.Context, string, io.Writer) error {
59+
func (c *composeService) Logs(context.Context, string, compose.LogConsumer) error {
6160
return errdefs.ErrNotImplemented
6261
}
6362

‎api/compose/api.go

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ package compose
1818

1919
import (
2020
"context"
21-
"io"
2221

2322
"github.com/compose-spec/compose-go/types"
2423
)
@@ -34,13 +33,13 @@ type Service interface {
3433
// Create executes the equivalent to a `compose create`
3534
Create(ctx context.Context, project *types.Project) error
3635
// Start executes the equivalent to a `compose start`
37-
Start(ctx context.Context, project *types.Project, w io.Writer) error
36+
Start(ctx context.Context, project *types.Project, consumer LogConsumer) error
3837
// Up executes the equivalent to a `compose up`
3938
Up(ctx context.Context, project *types.Project, detach bool) error
4039
// Down executes the equivalent to a `compose down`
4140
Down(ctx context.Context, projectName string) error
4241
// Logs executes the equivalent to a `compose logs`
43-
Logs(ctx context.Context, projectName string, w io.Writer) error
42+
Logs(ctx context.Context, projectName string, consumer LogConsumer) error
4443
// Ps executes the equivalent to a `compose ps`
4544
Ps(ctx context.Context, projectName string) ([]ServiceStatus, error)
4645
// List executes the equivalent to a `docker stack ls`
@@ -89,3 +88,8 @@ type Stack struct {
8988
Status string
9089
Reason string
9190
}
91+
92+
// LogConsumer is a callback to process log messages from services
93+
type LogConsumer interface {
94+
Log(service, container, message string)
95+
}

‎cli/cmd/compose/logs.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ import (
2020
"context"
2121
"os"
2222

23-
"github.com/spf13/cobra"
24-
2523
"github.com/docker/compose-cli/api/client"
24+
"github.com/docker/compose-cli/formatter"
25+
26+
"github.com/spf13/cobra"
2627
)
2728

2829
func logsCommand() *cobra.Command {
@@ -50,5 +51,6 @@ func runLogs(ctx context.Context, opts composeOptions) error {
5051
if err != nil {
5152
return err
5253
}
53-
return c.ComposeService().Logs(ctx, projectName, os.Stdout)
54+
consumer := formatter.NewLogConsumer(ctx, os.Stdout)
55+
return c.ComposeService().Logs(ctx, projectName, consumer)
5456
}

‎cli/cmd/compose/up.go

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,17 @@ import (
2020
"context"
2121
"errors"
2222
"fmt"
23-
"io"
2423
"os"
2524

26-
"github.com/compose-spec/compose-go/cli"
27-
"github.com/compose-spec/compose-go/types"
28-
"github.com/spf13/cobra"
29-
3025
"github.com/docker/compose-cli/api/client"
26+
"github.com/docker/compose-cli/api/compose"
3127
"github.com/docker/compose-cli/context/store"
28+
"github.com/docker/compose-cli/formatter"
3229
"github.com/docker/compose-cli/progress"
30+
31+
"github.com/compose-spec/compose-go/cli"
32+
"github.com/compose-spec/compose-go/types"
33+
"github.com/spf13/cobra"
3334
)
3435

3536
func upCommand(contextType string) *cobra.Command {
@@ -83,12 +84,12 @@ func runCreateStart(ctx context.Context, opts composeOptions, services []string)
8384
return err
8485
}
8586

86-
var w io.Writer
87+
var consumer compose.LogConsumer
8788
if !opts.Detach {
88-
w = os.Stdout
89+
consumer = formatter.NewLogConsumer(ctx, os.Stdout)
8990
}
9091

91-
err = c.ComposeService().Start(ctx, project, w)
92+
err = c.ComposeService().Start(ctx, project, consumer)
9293
if errors.Is(ctx.Err(), context.Canceled) {
9394
fmt.Println("Gracefully stopping...")
9495
ctx = context.Background()

‎ecs/local/compose.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ import (
2222
"context"
2323
"encoding/json"
2424
"fmt"
25-
"io"
2625
"os"
2726
"os/exec"
2827
"path/filepath"
@@ -56,7 +55,7 @@ func (e ecsLocalSimulation) Create(ctx context.Context, project *types.Project)
5655
return errdefs.ErrNotImplemented
5756
}
5857

59-
func (e ecsLocalSimulation) Start(ctx context.Context, project *types.Project, w io.Writer) error {
58+
func (e ecsLocalSimulation) Start(ctx context.Context, project *types.Project, consumer compose.LogConsumer) error {
6059
return errdefs.ErrNotImplemented
6160
}
6261

@@ -181,7 +180,7 @@ services:
181180
return cmd.Run()
182181
}
183182

184-
func (e ecsLocalSimulation) Logs(ctx context.Context, projectName string, w io.Writer) error {
183+
func (e ecsLocalSimulation) Logs(ctx context.Context, projectName string, consumer compose.LogConsumer) error {
185184
list, err := e.moby.ContainerList(ctx, types2.ContainerListOptions{
186185
Filters: filters.NewArgs(filters.Arg("label", "com.docker.compose.project="+projectName)),
187186
})

‎ecs/logs.go

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,11 @@ package ecs
1818

1919
import (
2020
"context"
21-
"io"
2221

23-
"github.com/docker/compose-cli/formatter"
22+
"github.com/docker/compose-cli/api/compose"
2423
)
2524

26-
func (b *ecsAPIService) Logs(ctx context.Context, project string, w io.Writer) error {
27-
consumer := formatter.NewLogConsumer(ctx, w)
28-
err := b.aws.GetLogs(ctx, project, consumer.Log)
25+
func (b *ecsAPIService) Logs(ctx context.Context, projectName string, consumer compose.LogConsumer) error {
26+
err := b.aws.GetLogs(ctx, projectName, consumer.Log)
2927
return err
3028
}

‎ecs/up.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ package ecs
1919
import (
2020
"context"
2121
"fmt"
22-
"io"
2322
"os"
2423
"os/signal"
2524
"syscall"
2625

27-
"github.com/compose-spec/compose-go/types"
26+
"github.com/docker/compose-cli/api/compose"
2827
"github.com/docker/compose-cli/errdefs"
28+
29+
"github.com/compose-spec/compose-go/types"
2930
)
3031

3132
func (b *ecsAPIService) Build(ctx context.Context, project *types.Project) error {
@@ -44,7 +45,7 @@ func (b *ecsAPIService) Create(ctx context.Context, project *types.Project) erro
4445
return errdefs.ErrNotImplemented
4546
}
4647

47-
func (b *ecsAPIService) Start(ctx context.Context, project *types.Project, w io.Writer) error {
48+
func (b *ecsAPIService) Start(ctx context.Context, project *types.Project, consumer compose.LogConsumer) error {
4849
return errdefs.ErrNotImplemented
4950
}
5051

‎example/backend.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@ import (
2222
"context"
2323
"errors"
2424
"fmt"
25-
"io"
26-
27-
"github.com/compose-spec/compose-go/types"
2825

2926
"github.com/docker/compose-cli/api/compose"
3027
"github.com/docker/compose-cli/api/containers"
@@ -34,6 +31,8 @@ import (
3431
"github.com/docker/compose-cli/backend"
3532
"github.com/docker/compose-cli/context/cloud"
3633
"github.com/docker/compose-cli/errdefs"
34+
35+
"github.com/compose-spec/compose-go/types"
3736
)
3837

3938
type apiService struct {
@@ -155,7 +154,7 @@ func (cs *composeService) Create(ctx context.Context, project *types.Project) er
155154
return errdefs.ErrNotImplemented
156155
}
157156

158-
func (cs *composeService) Start(ctx context.Context, project *types.Project, w io.Writer) error {
157+
func (cs *composeService) Start(ctx context.Context, project *types.Project, consumer compose.LogConsumer) error {
159158
return errdefs.ErrNotImplemented
160159
}
161160

@@ -176,7 +175,7 @@ func (cs *composeService) Ps(ctx context.Context, project string) ([]compose.Ser
176175
func (cs *composeService) List(ctx context.Context, project string) ([]compose.Stack, error) {
177176
return nil, errdefs.ErrNotImplemented
178177
}
179-
func (cs *composeService) Logs(ctx context.Context, project string, w io.Writer) error {
178+
func (cs *composeService) Logs(ctx context.Context, projectName string, consumer compose.LogConsumer) error {
180179
return errdefs.ErrNotImplemented
181180
}
182181

‎formatter/logs.go

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,13 @@ import (
2323
"io"
2424
"strconv"
2525
"strings"
26+
27+
"github.com/docker/compose-cli/api/compose"
2628
)
2729

2830
// NewLogConsumer creates a new LogConsumer
29-
func NewLogConsumer(ctx context.Context, w io.Writer) LogConsumer {
30-
return LogConsumer{
31+
func NewLogConsumer(ctx context.Context, w io.Writer) compose.LogConsumer {
32+
return &logConsumer{
3133
ctx: ctx,
3234
colors: map[string]colorFunc{},
3335
width: 0,
@@ -36,7 +38,7 @@ func NewLogConsumer(ctx context.Context, w io.Writer) LogConsumer {
3638
}
3739

3840
// Log formats a log message as received from service/container
39-
func (l *LogConsumer) Log(service, container, message string) {
41+
func (l *logConsumer) Log(service, container, message string) {
4042
if l.ctx.Err() != nil {
4143
return
4244
}
@@ -54,16 +56,7 @@ func (l *LogConsumer) Log(service, container, message string) {
5456
}
5557
}
5658

57-
// GetWriter creates a io.Writer that will actually split by line and format by LogConsumer
58-
func (l *LogConsumer) GetWriter(service, container string) io.Writer {
59-
return splitBuffer{
60-
service: service,
61-
container: container,
62-
consumer: l,
63-
}
64-
}
65-
66-
func (l *LogConsumer) computeWidth() {
59+
func (l *logConsumer) computeWidth() {
6760
width := 0
6861
for n := range l.colors {
6962
if len(n) > width {
@@ -74,25 +67,9 @@ func (l *LogConsumer) computeWidth() {
7467
}
7568

7669
// LogConsumer consume logs from services and format them
77-
type LogConsumer struct {
70+
type logConsumer struct {
7871
ctx context.Context
7972
colors map[string]colorFunc
8073
width int
8174
writer io.Writer
8275
}
83-
84-
type splitBuffer struct {
85-
service string
86-
container string
87-
consumer *LogConsumer
88-
}
89-
90-
func (s splitBuffer) Write(b []byte) (n int, err error) {
91-
split := bytes.Split(b, []byte{'\n'})
92-
for _, line := range split {
93-
if len(line) != 0 {
94-
s.consumer.Log(s.service, s.container, string(line))
95-
}
96-
}
97-
return len(b), nil
98-
}

0 commit comments

Comments
 (0)