From 7e534153f325e8a889f31f5f86dd09408efe1ec4 Mon Sep 17 00:00:00 2001
From: Guillaume Tardif <guillaume.tardif@docker.com>
Date: Thu, 24 Sep 2020 09:39:46 +0200
Subject: [PATCH] Avoid nil panic when no progress writer in context, add noop
 writer. (Especially for gRPC invocations)

Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
---
 progress/noop.go        | 34 ++++++++++++++++++++++++++++++++++
 progress/writer.go      |  5 ++++-
 progress/writer_test.go | 31 +++++++++++++++++++++++++++++++
 3 files changed, 69 insertions(+), 1 deletion(-)
 create mode 100644 progress/noop.go
 create mode 100644 progress/writer_test.go

diff --git a/progress/noop.go b/progress/noop.go
new file mode 100644
index 00000000..e638b872
--- /dev/null
+++ b/progress/noop.go
@@ -0,0 +1,34 @@
+/*
+   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 progress
+
+import (
+	"context"
+)
+
+type noopWriter struct {
+}
+
+func (p *noopWriter) Start(ctx context.Context) error {
+	return nil
+}
+
+func (p *noopWriter) Event(e Event) {
+}
+
+func (p *noopWriter) Stop() {
+}
diff --git a/progress/writer.go b/progress/writer.go
index e46f9017..23a5d207 100644
--- a/progress/writer.go
+++ b/progress/writer.go
@@ -73,7 +73,10 @@ func WithContextWriter(ctx context.Context, writer Writer) context.Context {
 
 // ContextWriter returns the writer from the context
 func ContextWriter(ctx context.Context) Writer {
-	s, _ := ctx.Value(writerKey{}).(Writer)
+	s, ok := ctx.Value(writerKey{}).(Writer)
+	if !ok {
+		return &noopWriter{}
+	}
 	return s
 }
 
diff --git a/progress/writer_test.go b/progress/writer_test.go
new file mode 100644
index 00000000..2933811b
--- /dev/null
+++ b/progress/writer_test.go
@@ -0,0 +1,31 @@
+/*
+   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 progress
+
+import (
+	"context"
+	"testing"
+
+	"gotest.tools/v3/assert"
+)
+
+func TestNoopWriter(t *testing.T) {
+	todo := context.TODO()
+	writer := ContextWriter(todo)
+
+	assert.Equal(t, writer, &noopWriter{})
+}