TUN-2315: Replace Scope with IntentLabel

tunnelrpc/pogs/tunnelrpc.go

@@ -2,7 +2,6 @@ package pogs
 
 import (
 	"context"
-	"fmt"
 	"time"
 
 	"github.com/cloudflare/cloudflared/tunnelrpc"
@@ -129,82 +128,13 @@ func UnmarshalServerInfo(s tunnelrpc.ServerInfo) (*ServerInfo, error) {
 	return p, err
 }
 
-//go-sumtype:decl Scope
-type Scope interface {
-	Value() string
-	PostgresType() string
-	GraphQLType() string
-	isScope()
-}
-
-type SystemName struct {
-	systemName string
-}
-
-func NewSystemName(systemName string) *SystemName {
-	return &SystemName{systemName: systemName}
-}
-
-func (s *SystemName) Value() string        { return s.systemName }
-func (_ *SystemName) PostgresType() string { return "system_name" }
-func (_ *SystemName) GraphQLType() string  { return "SYSTEM_NAME" }
-
-func (_ *SystemName) isScope() {}
-
-type Group struct {
-	group string
-}
-
-func NewGroup(group string) *Group {
-	return &Group{group: group}
-}
-
-func (g *Group) Value() string        { return g.group }
-func (_ *Group) PostgresType() string { return "group" }
-func (_ *Group) GraphQLType() string  { return "GROUP" }
-
-func (_ *Group) isScope() {}
-
-func MarshalScope(s tunnelrpc.Scope, p Scope) error {
-	ss := s.Value()
-	switch scope := p.(type) {
-	case *SystemName:
-		ss.SetSystemName(scope.systemName)
-	case *Group:
-		ss.SetGroup(scope.group)
-	default:
-		return fmt.Errorf("unexpected Scope value: %v", p)
-	}
-	return nil
-}
-
-func UnmarshalScope(s tunnelrpc.Scope) (Scope, error) {
-	ss := s.Value()
-	switch ss.Which() {
-	case tunnelrpc.Scope_value_Which_systemName:
-		systemName, err := ss.SystemName()
-		if err != nil {
-			return nil, err
-		}
-		return NewSystemName(systemName), nil
-	case tunnelrpc.Scope_value_Which_group:
-		group, err := ss.Group()
-		if err != nil {
-			return nil, err
-		}
-		return NewGroup(group), nil
-	default:
-		return nil, fmt.Errorf("unexpected Scope tag: %v", ss.Which())
-	}
-}
-
 type ConnectParameters struct {
 	OriginCert          []byte
 	CloudflaredID       uuid.UUID
 	NumPreviousAttempts uint8
 	Tags                []Tag
 	CloudflaredVersion  string
-	Scope               Scope
+	IntentLabel         string
 }
 
 func MarshalConnectParameters(s tunnelrpc.CapnpConnectParameters, p *ConnectParameters) error {
@@ -237,11 +167,7 @@ func MarshalConnectParameters(s tunnelrpc.CapnpConnectParameters, p *ConnectPara
 	if err := s.SetCloudflaredVersion(p.CloudflaredVersion); err != nil {
 		return err
 	}
-	scope, err := s.NewScope()
-	if err != nil {
-		return err
-	}
-	return MarshalScope(scope, p.Scope)
+	return s.SetIntentLabel(p.IntentLabel)
 }
 
 func UnmarshalConnectParameters(s tunnelrpc.CapnpConnectParameters) (*ConnectParameters, error) {
@@ -282,22 +208,14 @@ func UnmarshalConnectParameters(s tunnelrpc.CapnpConnectParameters) (*ConnectPar
 		return nil, err
 	}
 
-	scopeCapnp, err := s.Scope()
-	if err != nil {
-		return nil, err
-	}
-	scope, err := UnmarshalScope(scopeCapnp)
-	if err != nil {
-		return nil, err
-	}
-
+	intentLabel, err := s.IntentLabel()
 	return &ConnectParameters{
 		OriginCert:          originCert,
 		CloudflaredID:       cloudflaredID,
 		NumPreviousAttempts: s.NumPreviousAttempts(),
 		Tags:                tags,
 		CloudflaredVersion:  cloudflaredVersion,
-		Scope:               scope,
+		IntentLabel:         intentLabel,
 	}, nil
 }
 

tunnelrpc/pogs/tunnelrpc_test.go

@@ -11,35 +11,6 @@ import (
 	capnp "zombiezen.com/go/capnproto2"
 )
 
-// Assert *SystemName implements Scope
-var _ Scope = (*SystemName)(nil)
-
-// Assert *Group implements Scope
-var _ Scope = (*Group)(nil)
-
-func TestScope(t *testing.T) {
-	testCases := []Scope{
-		&SystemName{systemName: "my_system"},
-		&Group{group: "my_group"},
-	}
-	for i, testCase := range testCases {
-		_, seg, err := capnp.NewMessage(capnp.SingleSegment(nil))
-		capnpEntity, err := tunnelrpc.NewScope(seg)
-		if !assert.NoError(t, err) {
-			t.Fatal("Couldn't initialize a new message")
-		}
-		err = MarshalScope(capnpEntity, testCase)
-		if !assert.NoError(t, err, "testCase index %v failed to marshal", i) {
-			continue
-		}
-		result, err := UnmarshalScope(capnpEntity)
-		if !assert.NoError(t, err, "testCase index %v failed to unmarshal", i) {
-			continue
-		}
-		assert.Equal(t, testCase, result, "testCase index %v didn't preserve struct through marshalling and unmarshalling", i)
-	}
-}
-
 func sampleTestConnectResult() *ConnectResult {
 	return &ConnectResult{
 		Err: &ConnectError{
@@ -78,7 +49,7 @@ func TestConnectParameters(t *testing.T) {
 	testCases := []*ConnectParameters{
 		sampleConnectParameters(),
 		sampleConnectParameters(func(c *ConnectParameters) {
-			c.Scope = &SystemName{systemName: "my_system"}
+			c.IntentLabel = "my_intent"
 		}),
 		sampleConnectParameters(func(c *ConnectParameters) {
 			c.Tags = nil
@@ -118,7 +89,7 @@ func sampleConnectParameters(overrides ...func(*ConnectParameters)) *ConnectPara
 			},
 		},
 		CloudflaredVersion: "7.0",
-		Scope:              &Group{group: "my_group"},
+		IntentLabel:        "my_intent",
 	}
 	sample.ensureNoZeroFields()
 	for _, f := range overrides {