add kind-detail tests and required funcs

Author: real-danm

auth/accesstoken.go

@@ -62,6 +62,11 @@ func (t *AccessToken) SetKind(kind livekit.ParticipantInfo_Kind) *AccessToken {
 	return t
 }
 
+func (t *AccessToken) SetKindDetail(kindDetail livekit.ParticipantInfo_KindDetail) *AccessToken {
+	t.grant.SetParticipantKindDetail(kindDetail)
+	return t
+}
+
 // Deprecated: use SetVideoGrant instead
 func (t *AccessToken) AddGrant(grant *VideoGrant) *AccessToken {
 	return t.SetVideoGrant(grant)

auth/grants.go

@@ -49,12 +49,13 @@ func (c *RoomConfiguration) UnmarshalJSON(data []byte) error {
 }
 
 type ClaimGrants struct {
-	Identity string      `json:"-"`
-	Name     string      `json:"name,omitempty"`
-	Kind     string      `json:"kind,omitempty"`
-	Video    *VideoGrant `json:"video,omitempty"`
-	SIP      *SIPGrant   `json:"sip,omitempty"`
-	Agent    *AgentGrant `json:"agent,omitempty"`
+	Identity   string      `json:"-"`
+	Name       string      `json:"name,omitempty"`
+	Kind       string      `json:"kind,omitempty"`
+	KindDetail string      `json:"kindDetail,omitempty"`
+	Video      *VideoGrant `json:"video,omitempty"`
+	SIP        *SIPGrant   `json:"sip,omitempty"`
+	Agent      *AgentGrant `json:"agent,omitempty"`
 	// Room configuration to use if this participant initiates the room
 	RoomConfig *RoomConfiguration `json:"roomConfig,omitempty"`
 	// Cloud-only, config preset to use
@@ -71,10 +72,18 @@ func (c *ClaimGrants) SetParticipantKind(kind livekit.ParticipantInfo_Kind) {
 	c.Kind = kindFromProto(kind)
 }
 
+func (c *ClaimGrants) SetParticipantKindDetail(kindDetail livekit.ParticipantInfo_KindDetail) {
+	c.KindDetail = kindDetailFromProto(kindDetail)
+}
+
 func (c *ClaimGrants) GetParticipantKind() livekit.ParticipantInfo_Kind {
 	return kindToProto(c.Kind)
 }
 
+func (c *ClaimGrants) GetParticipantKindDetail() livekit.ParticipantInfo_KindDetail {
+	return kindDetailToProto(c.KindDetail)
+}
+
 func (c *ClaimGrants) GetRoomConfiguration() *livekit.RoomConfiguration {
 	if c.RoomConfig == nil {
 		return nil
@@ -464,6 +473,10 @@ func kindFromProto(source livekit.ParticipantInfo_Kind) string {
 	return strings.ToLower(source.String())
 }
 
+func kindDetailFromProto(source livekit.ParticipantInfo_KindDetail) string {
+	return strings.ToLower(source.String())
+}
+
 func kindToProto(sourceStr string) livekit.ParticipantInfo_Kind {
 	switch strings.ToLower(sourceStr) {
 	case "", "standard":
@@ -480,3 +493,14 @@ func kindToProto(sourceStr string) livekit.ParticipantInfo_Kind {
 		return livekit.ParticipantInfo_STANDARD
 	}
 }
+
+func kindDetailToProto(sourceStr string) livekit.ParticipantInfo_KindDetail {
+	switch strings.ToLower(sourceStr) {
+	case "cloud_agent":
+		return livekit.ParticipantInfo_CLOUD_AGENT
+	case "forwarded":
+		return livekit.ParticipantInfo_FORWARDED
+	default:
+		return livekit.ParticipantInfo_CLOUD_AGENT
+	}
+}

auth/grants_test.go

@@ -99,3 +99,17 @@ func TestParticipantKind(t *testing.T) {
 		t.Errorf("Please update kindMax to match protobuf. Missing value: %s", kindNext)
 	}
 }
+
+func TestParticipantKindDetail(t *testing.T) {
+	const kindDetailMin, kindDetailMax = livekit.ParticipantInfo_CLOUD_AGENT, livekit.ParticipantInfo_FORWARDED
+	for k := kindDetailMin; k <= kindDetailMax; k++ {
+		k := k
+		t.Run(k.String(), func(t *testing.T) {
+			require.Equal(t, k, kindDetailToProto(kindDetailFromProto(k)))
+		})
+	}
+	const kindDetailNext = kindDetailMax + 1
+	if _, err := strconv.Atoi(kindDetailNext.String()); err != nil {
+		t.Errorf("Please update kindDetailMax to match protobuf. Missing value: %s", kindDetailNext)
+	}
+}

auth/verifier_test.go

@@ -15,13 +15,15 @@
 package auth_test
 
 import (
+	"strings"
 	"testing"
 	"time"
 
 	"github.com/go-jose/go-jose/v3/json"
 	"github.com/stretchr/testify/require"
 
 	"github.com/livekit/protocol/auth"
+	"github.com/livekit/protocol/livekit"
 )
 
 func TestVerifier(t *testing.T) {
@@ -115,4 +117,32 @@ func TestVerifier(t *testing.T) {
 		require.Nil(t, decoded.Video.CanPublish)
 		require.False(t, *decoded.Video.CanPublishData)
 	})
+
+	t.Run("kind test", func(t *testing.T) {
+		at := auth.NewAccessToken(apiKey, secret).
+			SetKind(livekit.ParticipantInfo_AGENT)
+		token, err := at.ToJWT()
+		require.NoError(t, err)
+
+		v, err := auth.ParseAPIToken(token)
+		require.NoError(t, err)
+		decoded, err := v.Verify(secret)
+		require.NoError(t, err)
+		require.Equal(t, strings.ToUpper(livekit.ParticipantInfo_Kind_name[int32(livekit.ParticipantInfo_AGENT)]), strings.ToUpper(decoded.Kind))
+	})
+
+	t.Run("kind detail test", func(t *testing.T) {
+		at := auth.NewAccessToken(apiKey, secret).
+			SetKind(livekit.ParticipantInfo_AGENT).
+			SetKindDetail(livekit.ParticipantInfo_CLOUD_AGENT)
+		token, err := at.ToJWT()
+		require.NoError(t, err)
+
+		v, err := auth.ParseAPIToken(token)
+		require.NoError(t, err)
+		decoded, err := v.Verify(secret)
+		require.NoError(t, err)
+		require.Equal(t, strings.ToLower(livekit.ParticipantInfo_KindDetail_name[int32(livekit.ParticipantInfo_CLOUD_AGENT)]), strings.ToLower(decoded.KindDetail))
+		require.Equal(t, strings.ToLower(livekit.ParticipantInfo_Kind_name[int32(livekit.ParticipantInfo_AGENT)]), strings.ToLower(decoded.Kind))
+	})
 }