Decouple versioning from Temporal

cli/app.go

@@ -50,7 +50,7 @@ func NewCliApp() *cli.App {
 	app := cli.NewApp()
 	app.Name = "tctl"
 	app.Usage = "A command-line tool for Temporal users"
-	app.Version = "1.14.0-alpha.2"
+	app.Version = "1.17.0-alpha.1"
 	app.Flags = []cli.Flag{
 		&cli.StringFlag{
 			Name:    FlagAddress,

cli/headers/headers.go

@@ -0,0 +1,140 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Copyright (c) 2020 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package headers
+
+import (
+	"context"
+
+	"google.golang.org/grpc/metadata"
+)
+
+const (
+	ClientNameHeaderName              = "client-name"
+	ClientVersionHeaderName           = "client-version"
+	SupportedServerVersionsHeaderName = "supported-server-versions"
+	SupportedFeaturesHeaderName       = "supported-features"
+	SupportedFeaturesHeaderDelim      = ","
+)
+
+const (
+	ClientNameCLI = "temporal-cli"
+
+	CLIVersion = "1.16.1"
+
+	// SupportedServerVersions is used by CLI and inter role communication.
+	SupportedServerVersions = ">=1.0.0 <2.0.0"
+)
+
+var (
+	// propagateHeaders are the headers to propagate from the frontend to other services.
+	propagateHeaders = []string{
+		SupportedServerVersionsHeaderName,
+		SupportedFeaturesHeaderName,
+	}
+
+	internalVersionHeaders = metadata.New(map[string]string{
+		SupportedServerVersionsHeaderName: SupportedServerVersions,
+	})
+
+	cliVersionHeaders = metadata.New(map[string]string{
+		ClientNameHeaderName:              ClientNameCLI,
+		ClientVersionHeaderName:           CLIVersion,
+		SupportedServerVersionsHeaderName: SupportedServerVersions,
+		// TODO: This should include SupportedFeaturesHeaderName with a value that's taken
+		// from the Go SDK (since the cli uses the Go SDK for most operations).
+	})
+)
+
+// GetValues returns header values for passed header names.
+// It always returns slice of the same size as number of passed header names.
+func GetValues(ctx context.Context, headerNames ...string) []string {
+	headerValues := make([]string, len(headerNames))
+
+	if md, ok := metadata.FromIncomingContext(ctx); ok {
+		for i, headerName := range headerNames {
+			headerValues[i] = getSingleHeaderValue(md, headerName)
+		}
+	}
+
+	return headerValues
+}
+
+// Propagate propagates version headers from incoming context to outgoing context.
+// It copies all version headers to outgoing context only if they are exist in incoming context
+// and doesn't exist in outgoing context already.
+func Propagate(ctx context.Context) context.Context {
+	if mdIncoming, ok := metadata.FromIncomingContext(ctx); ok {
+		var headersToAppend []string
+		mdOutgoing, mdOutgoingExist := metadata.FromOutgoingContext(ctx)
+		for _, headerName := range propagateHeaders {
+			if incomingValue := mdIncoming.Get(headerName); len(incomingValue) > 0 {
+				if mdOutgoingExist {
+					if outgoingValue := mdOutgoing.Get(headerName); len(outgoingValue) > 0 {
+						continue
+					}
+				}
+				headersToAppend = append(headersToAppend, headerName, incomingValue[0])
+			}
+		}
+		if headersToAppend != nil {
+			if mdOutgoingExist {
+				ctx = metadata.AppendToOutgoingContext(ctx, headersToAppend...)
+			} else {
+				ctx = metadata.NewOutgoingContext(ctx, metadata.Pairs(headersToAppend...))
+			}
+		}
+	}
+	return ctx
+}
+
+// SetVersions sets headers for internal communications.
+func SetVersions(ctx context.Context) context.Context {
+	return metadata.NewOutgoingContext(ctx, internalVersionHeaders)
+}
+
+// SetCLIVersions sets headers for CLI requests.
+func SetCLIVersions(ctx context.Context) context.Context {
+	return metadata.NewOutgoingContext(ctx, cliVersionHeaders)
+}
+
+// SetVersionsForTests sets headers as they would be received from the client.
+// Must be used in tests only.
+func SetVersionsForTests(ctx context.Context, clientVersion, clientName, supportedServerVersions, supportedFeatures string) context.Context {
+	return metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
+		ClientNameHeaderName:              clientName,
+		ClientVersionHeaderName:           clientVersion,
+		SupportedServerVersionsHeaderName: supportedServerVersions,
+		SupportedFeaturesHeaderName:       supportedFeatures,
+	}))
+}
+
+func getSingleHeaderValue(md metadata.MD, headerName string) string {
+	values := md.Get(headerName)
+	if len(values) == 0 {
+		return ""
+	}
+
+	return values[0]
+}

cli/headers/headers_test.go

@@ -0,0 +1,153 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Copyright (c) 2020 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package headers
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"github.com/stretchr/testify/suite"
+	"google.golang.org/grpc/metadata"
+)
+
+type (
+	HeadersSuite struct {
+		*require.Assertions
+		suite.Suite
+	}
+)
+
+func TestHeadersSuite(t *testing.T) {
+	suite.Run(t, &HeadersSuite{})
+}
+
+func (s *HeadersSuite) SetupTest() {
+	s.Assertions = require.New(s.T())
+}
+
+func (s *HeadersSuite) TestPropagate_CreateNewOutgoingContext() {
+	ctx := context.Background()
+	ctx = metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
+		ClientVersionHeaderName:           "22.08.78",
+		SupportedServerVersionsHeaderName: ">21.04.16",
+		ClientNameHeaderName:              "28.08.14",
+		SupportedFeaturesHeaderName:       "my-feature",
+	}))
+
+	ctx = Propagate(ctx)
+
+	md, ok := metadata.FromOutgoingContext(ctx)
+	s.True(ok)
+
+	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
+	s.Equal(">21.04.16", md.Get(SupportedServerVersionsHeaderName)[0])
+	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
+	s.Equal("my-feature", md.Get(SupportedFeaturesHeaderName)[0])
+}
+
+func (s *HeadersSuite) TestPropagate_CreateNewOutgoingContext_SomeMissing() {
+	ctx := context.Background()
+	ctx = metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
+		ClientVersionHeaderName: "22.08.78",
+		ClientNameHeaderName:    "28.08.14",
+	}))
+
+	ctx = Propagate(ctx)
+
+	md, ok := metadata.FromOutgoingContext(ctx)
+	s.True(ok)
+
+	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
+	s.Equal(0, len(md.Get(SupportedServerVersionsHeaderName)))
+	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
+	s.Equal(0, len(md.Get(SupportedFeaturesHeaderName)))
+}
+
+func (s *HeadersSuite) TestPropagate_UpdateExistingEmptyOutgoingContext() {
+	ctx := context.Background()
+	ctx = metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
+		ClientVersionHeaderName:           "22.08.78",
+		SupportedServerVersionsHeaderName: "<21.04.16",
+		ClientNameHeaderName:              "28.08.14",
+		SupportedFeaturesHeaderName:       "my-feature",
+	}))
+
+	ctx = metadata.NewOutgoingContext(ctx, metadata.MD{})
+
+	ctx = Propagate(ctx)
+
+	md, ok := metadata.FromOutgoingContext(ctx)
+	s.True(ok)
+
+	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
+	s.Equal("<21.04.16", md.Get(SupportedServerVersionsHeaderName)[0])
+	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
+	s.Equal("my-feature", md.Get(SupportedFeaturesHeaderName)[0])
+}
+
+func (s *HeadersSuite) TestPropagate_UpdateExistingNonEmptyOutgoingContext() {
+	ctx := context.Background()
+	ctx = metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
+		ClientVersionHeaderName:           "07.08.78",   // Must be ignored
+		SupportedServerVersionsHeaderName: "<07.04.16",  // Must be ignored
+		SupportedFeaturesHeaderName:       "my-feature", // Passed through
+	}))
+
+	ctx = metadata.NewOutgoingContext(ctx, metadata.New(map[string]string{
+		ClientVersionHeaderName:           "22.08.78",
+		SupportedServerVersionsHeaderName: "<21.04.16",
+		ClientNameHeaderName:              "28.08.14",
+	}))
+
+	ctx = Propagate(ctx)
+
+	md, ok := metadata.FromOutgoingContext(ctx)
+	s.True(ok)
+
+	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
+	s.Equal("<21.04.16", md.Get(SupportedServerVersionsHeaderName)[0])
+	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
+	s.Equal("my-feature", md.Get(SupportedFeaturesHeaderName)[0])
+}
+
+func (s *HeadersSuite) TestPropagate_EmptyIncomingContext() {
+	ctx := context.Background()
+
+	ctx = metadata.NewOutgoingContext(ctx, metadata.New(map[string]string{
+		ClientVersionHeaderName:           "22.08.78",
+		SupportedServerVersionsHeaderName: "<21.04.16",
+		ClientNameHeaderName:              "28.08.14",
+	}))
+
+	ctx = Propagate(ctx)
+
+	md, ok := metadata.FromOutgoingContext(ctx)
+	s.True(ok)
+
+	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
+	s.Equal("<21.04.16", md.Get(SupportedServerVersionsHeaderName)[0])
+	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
+}

cli/util.go

@@ -44,10 +44,10 @@ import (
 	"go.temporal.io/sdk/converter"
 
 	"github.com/temporalio/tctl/cli/dataconverter"
+	"github.com/temporalio/tctl/cli/headers"
 	"github.com/temporalio/tctl/cli/stringify"
 	"go.temporal.io/server/common/codec"
 	"go.temporal.io/server/common/payloads"
-	"go.temporal.io/server/common/rpc"
 )
 
 // HistoryEventToString convert HistoryEvent to string
@@ -535,18 +535,28 @@ func newContextForLongPoll(c *cli.Context) (context.Context, context.CancelFunc)
 func newIndefiniteContext(c *cli.Context) (context.Context, context.CancelFunc) {
 	if c.IsSet(FlagContextTimeout) {
 		timeout := time.Duration(c.Int(FlagContextTimeout)) * time.Second
-		return rpc.NewContextWithTimeoutAndCLIHeaders(timeout)
+		return NewContextWithTimeoutAndCLIHeaders(timeout)
 	}
 
-	return rpc.NewContextWithCLIHeaders()
+	return NewContextWithCLIHeaders()
 }
 
 func newContextWithTimeout(c *cli.Context, timeout time.Duration) (context.Context, context.CancelFunc) {
 	if c.IsSet(FlagContextTimeout) {
 		timeout = time.Duration(c.Int(FlagContextTimeout)) * time.Second
 	}
 
-	return rpc.NewContextWithTimeoutAndCLIHeaders(timeout)
+	return NewContextWithTimeoutAndCLIHeaders(timeout)
+}
+
+// NewContextWithCLIHeaders creates context with version headers for CLI.
+func NewContextWithCLIHeaders() (context.Context, context.CancelFunc) {
+	return context.WithCancel(headers.SetCLIVersions(context.Background()))
+}
+
+// NewContextWithTimeoutAndCLIHeaders creates context with timeout and version headers for CLI.
+func NewContextWithTimeoutAndCLIHeaders(timeout time.Duration) (context.Context, context.CancelFunc) {
+	return context.WithTimeout(headers.SetCLIVersions(context.Background()), timeout)
 }
 
 // process and validate input provided through cmd or file

cli_curr/adminCommands.go

@@ -245,7 +245,10 @@ func AdminDeleteWorkflow(c *cli.Context) {
 		WorkflowID:  getRequiredOption(c, FlagWorkflowID),
 		RunID:       runID,
 	}
-	err = exeStore.DeleteWorkflowExecution(req)
+
+	ctx, cancel := newContext(c)
+	defer cancel()
+	err = exeStore.DeleteWorkflowExecution(ctx, req)
 	if err != nil {
 		if c.Bool(FlagSkipErrorMode) {
 			fmt.Printf("Unable to DeleteWorkflowExecution for RunID=%s: %v\n", runID, err)
@@ -262,7 +265,10 @@ func AdminDeleteWorkflow(c *cli.Context) {
 		WorkflowID:  getRequiredOption(c, FlagWorkflowID),
 		RunID:       runID,
 	}
-	err = exeStore.DeleteCurrentWorkflowExecution(deleteCurrentReq)
+
+	ctx, cancel = newContext(c)
+	defer cancel()
+	err = exeStore.DeleteCurrentWorkflowExecution(ctx, deleteCurrentReq)
 	if err != nil {
 		if c.Bool(FlagSkipErrorMode) {
 			fmt.Printf("Unable to DeleteCurrentWorkflowExecution for RunID=%s: %v\n", runID, err)