[supervisor] Add annotations to terminals

Author: Christian Weichel

components/supervisor-api/go/terminal.pb.go

@@ -48,7 +48,9 @@ service TerminalService {
 }
 
 message OpenTerminalRequest {
+    reserved 1;
     map<string, string> env = 2;
+    map<string, string> annotations = 3;
 }
 message OpenTerminalResponse {
     string alias = 1;
@@ -70,6 +72,7 @@ message ListTerminalsResponse {
         repeated string command = 2;
         string title = 3;
         int64 pid = 4;
+        map<string, string> annotations = 5;
     }
 
     repeated Terminal terminals = 1;

components/supervisor-api/terminal.proto

@@ -8,6 +8,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"sort"
 	"strings"
 	"text/tabwriter"
 	"time"
@@ -34,9 +35,14 @@ var terminalListCmd = &cobra.Command{
 		tw := tabwriter.NewWriter(os.Stdout, 2, 4, 1, ' ', 0)
 		defer tw.Flush()
 
-		fmt.Fprintf(tw, "ALIAS\tPID\tCOMMAND\n")
+		fmt.Fprintf(tw, "ALIAS\tPID\tCOMMAND\tANNOTATIONS\n")
 		for _, term := range resp.Terminals {
-			fmt.Fprintf(tw, "%s\t%d\t%s\n", term.Alias, term.Pid, strings.Join(term.Command, " "))
+			annotations := make([]string, 0, len(term.Annotations))
+			for k, v := range term.Annotations {
+				annotations = append(annotations, fmt.Sprintf("%s=%s", k, v))
+			}
+			sort.Slice(annotations, func(i, j int) bool { return annotations[i] < annotations[j] })
+			fmt.Fprintf(tw, "%s\t%d\t%s\t%s\n", term.Alias, term.Pid, strings.Join(term.Command, " "), strings.Join(annotations, ","))
 		}
 	},
 }

components/supervisor/cmd/terminal-list.go

@@ -65,17 +65,22 @@ func (srv *MuxTerminalService) RegisterREST(mux *runtime.ServeMux, grpcEndpoint
 func (srv *MuxTerminalService) Open(ctx context.Context, req *api.OpenTerminalRequest) (*api.OpenTerminalResponse, error) {
 	return srv.OpenWithOptions(ctx, req, TermOptions{
 		ReadTimeout: 5 * time.Second,
+		Annotations: req.Annotations,
 	})
 }
 
-// OpenWithOptions opens a new terminal running the shell with given options
+// OpenWithOptions opens a new terminal running the shell with given options.
+// req.Annotations override options.Annotations.
 func (srv *MuxTerminalService) OpenWithOptions(ctx context.Context, req *api.OpenTerminalRequest, options TermOptions) (*api.OpenTerminalResponse, error) {
 	cmd := exec.Command(srv.DefaultShell)
 	cmd.Dir = srv.DefaultWorkdir
 	cmd.Env = append(srv.Env, "TERM=xterm-color")
 	for key, value := range req.Env {
 		cmd.Env = append(cmd.Env, key+"="+value)
 	}
+	for k, v := range req.Annotations {
+		options.Annotations[k] = v
+	}
 	alias, err := srv.Mux.Start(cmd, options)
 	if err != nil {
 		return nil, status.Error(codes.Internal, err.Error())
@@ -116,9 +121,10 @@ func (srv *MuxTerminalService) List(ctx context.Context, req *api.ListTerminalsR
 		}
 
 		res = append(res, &api.ListTerminalsResponse_Terminal{
-			Alias:   alias,
-			Command: term.Command.Args,
-			Pid:     pid,
+			Alias:       alias,
+			Command:     term.Command.Args,
+			Pid:         pid,
+			Annotations: term.Annotations,
 		})
 	}
 

components/supervisor/pkg/terminal/service.go

@@ -192,6 +192,7 @@ func newTerm(pty *os.File, cmd *exec.Cmd, options TermOptions) (*Term, error) {
 			listener: make(map[*multiWriterListener]struct{}),
 			recorder: recorder,
 		},
+		Annotations: options.Annotations,
 
 		StarterToken: token.String(),
 
@@ -205,6 +206,9 @@ func newTerm(pty *os.File, cmd *exec.Cmd, options TermOptions) (*Term, error) {
 type TermOptions struct {
 	// timeout after which a listener is dropped. Use 0 for no timeout.
 	ReadTimeout time.Duration
+
+	// Annotations are user-defined metadata that's attached to a terminal
+	Annotations map[string]string
 }
 
 // Term is a pseudo-terminal
@@ -213,6 +217,7 @@ type Term struct {
 	Command      *exec.Cmd
 	Title        string
 	StarterToken string
+	Annotations  map[string]string
 
 	Stdout *multiWriter
 

components/supervisor/pkg/terminal/terminal.go

@@ -18,6 +18,86 @@ import (
 	"golang.org/x/sync/errgroup"
 )
 
+func TestAnnotations(t *testing.T) {
+	tests := []struct {
+		Desc        string
+		Req         *api.OpenTerminalRequest
+		Opts        *TermOptions
+		Expectation map[string]string
+	}{
+		{
+			Desc: "no annotations",
+			Req: &api.OpenTerminalRequest{
+				Annotations: map[string]string{},
+			},
+			Expectation: map[string]string{},
+		},
+		{
+			Desc: "request annotation",
+			Req: &api.OpenTerminalRequest{
+				Annotations: map[string]string{
+					"hello": "world",
+				},
+			},
+			Expectation: map[string]string{
+				"hello": "world",
+			},
+		},
+		{
+			Desc: "option annotation",
+			Req: &api.OpenTerminalRequest{
+				Annotations: map[string]string{
+					"hello": "world",
+				},
+			},
+			Opts: &TermOptions{
+				Annotations: map[string]string{
+					"hello": "foo",
+					"bar":   "baz",
+				},
+			},
+			Expectation: map[string]string{
+				"hello": "world",
+				"bar":   "baz",
+			},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.Desc, func(t *testing.T) {
+			mux := NewMux()
+			defer mux.Close()
+
+			terminalService := NewMuxTerminalService(mux)
+			var err error
+			if test.Opts == nil {
+				_, err = terminalService.Open(context.Background(), test.Req)
+			} else {
+				_, err = terminalService.OpenWithOptions(context.Background(), test.Req, *test.Opts)
+			}
+			if err != nil {
+				t.Fatal(err)
+				return
+			}
+
+			lr, err := terminalService.List(context.Background(), &api.ListTerminalsRequest{})
+			if err != nil {
+				t.Fatal(err)
+				return
+			}
+			if len(lr.Terminals) != 1 {
+				t.Fatalf("expected exactly one terminal, got %d", len(lr.Terminals))
+				return
+			}
+
+			if diff := cmp.Diff(test.Expectation, lr.Terminals[0].Annotations); diff != "" {
+				t.Errorf("unexpected output (-want +got):\n%s", diff)
+			}
+		})
+
+	}
+}
+
 func TestTerminals(t *testing.T) {
 	tests := []struct {
 		Desc        string