Skip to content

Commit 06182a8

Browse files
author
Laurie T. Malau
committed
[pat] Implement GetPersonalAccessToken
1 parent a0a9ddd commit 06182a8

File tree

4 files changed

+93
-31
lines changed

4 files changed

+93
-31
lines changed

‎components/gitpod-db/go/personal_access_token.go

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"strings"
1313
"time"
1414

15+
connect "github.com/bufbuild/connect-go"
1516
"github.com/google/uuid"
1617
"gorm.io/gorm"
1718
)
@@ -36,14 +37,17 @@ func (d *PersonalAccessToken) TableName() string {
3637
return "d_b_personal_access_token"
3738
}
3839

39-
func GetToken(ctx context.Context, conn *gorm.DB, id uuid.UUID) (PersonalAccessToken, error) {
40+
func GetPersonalAccessTokenForUser(ctx context.Context, conn *gorm.DB, tokenID uuid.UUID, userID uuid.UUID) (PersonalAccessToken, error) {
4041
var token PersonalAccessToken
4142

4243
db := conn.WithContext(ctx)
4344

44-
db = db.Where("id = ?", id).First(&token)
45+
db = db.Where("id = ?", tokenID).Where("userId = ?", userID).Where("deleted = ?", 0).First(&token)
4546
if db.Error != nil {
46-
return PersonalAccessToken{}, fmt.Errorf("Failed to retrieve token: %w", db.Error)
47+
if errors.Is(db.Error, gorm.ErrRecordNotFound) {
48+
return PersonalAccessToken{}, connect.NewError(connect.CodeNotFound, db.Error)
49+
}
50+
return PersonalAccessToken{}, fmt.Errorf("Failed to retrieve token: %v", db.Error)
4751
}
4852

4953
return token, nil
@@ -94,6 +98,7 @@ func ListPersonalAccessTokensForUser(ctx context.Context, conn *gorm.DB, userID
9498
WithContext(ctx).
9599
Table((&PersonalAccessToken{}).TableName()).
96100
Where("userId = ?", userID).
101+
Where("deleted = ?", 0).
97102
Order("createdAt").
98103
Scopes(Paginate(pagination)).
99104
Find(&results)

‎components/gitpod-db/go/personal_access_token_test.go

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,38 @@ import (
1919
func TestPersonalAccessToken_Get(t *testing.T) {
2020
conn := dbtest.ConnectForTests(t)
2121

22-
token := db.PersonalAccessToken{
23-
ID: uuid.New(),
24-
UserID: uuid.New(),
25-
Hash: "some-secure-hash",
26-
Name: "some-name",
27-
Description: "some-description",
28-
Scopes: []string{"read", "write"},
29-
ExpirationTime: time.Now().Add(5),
30-
CreatedAt: time.Now(),
31-
LastModified: time.Now(),
32-
}
22+
firstUserId := uuid.New()
23+
secondUserId := uuid.New()
3324

34-
tx := conn.Create(token)
35-
require.NoError(t, tx.Error)
25+
token := dbtest.NewPersonalAccessToken(t, db.PersonalAccessToken{UserID: firstUserId})
26+
token2 := dbtest.NewPersonalAccessToken(t, db.PersonalAccessToken{UserID: secondUserId})
27+
28+
tokenEntries := []db.PersonalAccessToken{token, token2}
29+
30+
dbtest.CreatePersonalAccessTokenRecords(t, conn, tokenEntries...)
31+
32+
t.Run("not matching user", func(t *testing.T) {
33+
_, err := db.GetPersonalAccessTokenForUser(context.Background(), conn, token.ID, token2.UserID)
34+
require.Error(t, err, db.ErrorNotFound)
35+
})
36+
37+
t.Run("not matching token", func(t *testing.T) {
38+
_, err := db.GetPersonalAccessTokenForUser(context.Background(), conn, token2.ID, token.UserID)
39+
require.Error(t, err, db.ErrorNotFound)
40+
})
41+
42+
t.Run("both token and user don't exist in the DB", func(t *testing.T) {
43+
_, err := db.GetPersonalAccessTokenForUser(context.Background(), conn, uuid.New(), uuid.New())
44+
require.Error(t, err, db.ErrorNotFound)
45+
})
46+
47+
t.Run("valid", func(t *testing.T) {
48+
returned, err := db.GetPersonalAccessTokenForUser(context.Background(), conn, token.ID, token.UserID)
49+
require.NoError(t, err)
50+
require.Equal(t, token.ID, returned.ID)
51+
require.Equal(t, token.UserID, returned.UserID)
52+
})
3653

37-
result, err := db.GetToken(context.Background(), conn, token.ID)
38-
require.NoError(t, err)
39-
require.Equal(t, token.ID, result.ID)
4054
}
4155

4256
func TestPersonalAccessToken_Create(t *testing.T) {

‎components/public-api-server/pkg/apiv1/tokens.go

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"fmt"
1111
"strings"
1212

13-
"github.com/bufbuild/connect-go"
13+
connect "github.com/bufbuild/connect-go"
1414
"github.com/gitpod-io/gitpod/common-go/experiments"
1515
"github.com/gitpod-io/gitpod/common-go/log"
1616
db "github.com/gitpod-io/gitpod/components/gitpod-db/go"
@@ -67,13 +67,24 @@ func (s *TokensService) GetPersonalAccessToken(ctx context.Context, req *connect
6767
return nil, err
6868
}
6969

70-
_, err = s.getUser(ctx, conn)
70+
user, err := s.getUser(ctx, conn)
7171
if err != nil {
7272
return nil, err
7373
}
7474

7575
log.Infof("Handling GetPersonalAccessToken request for Token ID '%s'", tokenID.String())
76-
return nil, connect.NewError(connect.CodeUnimplemented, errors.New("gitpod.experimental.v1.TokensService.GetPersonalAccessToken is not implemented"))
76+
77+
userId, err := uuid.Parse(user.ID)
78+
if err != nil {
79+
return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("Failed to parse user ID as UUID"))
80+
}
81+
82+
token, err := db.GetPersonalAccessTokenForUser(ctx, s.dbConn, tokenID, userId)
83+
if err != nil {
84+
return nil, err
85+
}
86+
87+
return connect.NewResponse(&v1.GetPersonalAccessTokenResponse{Token: personalAccessTokenToAPI(token, "")}), nil
7788
}
7889

7990
func (s *TokensService) ListPersonalAccessTokens(ctx context.Context, req *connect.Request[v1.ListPersonalAccessTokensRequest]) (*connect.Response[v1.ListPersonalAccessTokensResponse], error) {

‎components/public-api-server/pkg/apiv1/tokens_test.go

Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,31 @@ func TestTokensService_CreatePersonalAccessTokenWithoutFeatureFlag(t *testing.T)
6565

6666
func TestTokensService_GetPersonalAccessToken(t *testing.T) {
6767
user := newUser(&protocol.User{})
68+
user2 := newUser(&protocol.User{})
6869

69-
t.Run("permission denied when feature flag is disabled", func(t *testing.T) {
70-
serverMock, _, client := setupTokensService(t, withTokenFeatureDisabled)
70+
t.Run("get correct token", func(t *testing.T) {
71+
serverMock, dbConn, client := setupTokensService(t, withTokenFeatureEnabled)
72+
73+
tokens := dbtest.CreatePersonalAccessTokenRecords(t, dbConn,
74+
dbtest.NewPersonalAccessToken(t, db.PersonalAccessToken{
75+
UserID: uuid.MustParse(user.ID),
76+
}),
77+
dbtest.NewPersonalAccessToken(t, db.PersonalAccessToken{
78+
UserID: uuid.MustParse(user2.ID),
79+
}),
80+
)
7181

7282
serverMock.EXPECT().GetLoggedInUser(gomock.Any()).Return(user, nil)
7383

74-
_, err := client.GetPersonalAccessToken(context.Background(), connect.NewRequest(&v1.GetPersonalAccessTokenRequest{
75-
Id: uuid.New().String(),
84+
response, err := client.GetPersonalAccessToken(context.Background(), connect.NewRequest(&v1.GetPersonalAccessTokenRequest{
85+
Id: tokens[0].ID.String(),
7686
}))
7787

78-
require.Error(t, err, "This feature is currently in beta. If you would like to be part of the beta, please contact us.")
79-
require.Equal(t, connect.CodePermissionDenied, connect.CodeOf(err))
88+
require.NoError(t, err)
89+
90+
requireEqualProto(t, &v1.GetPersonalAccessTokenResponse{
91+
Token: personalAccessTokenToAPI(tokens[0], ""),
92+
}, response.Msg)
8093
})
8194

8295
t.Run("invalid argument when Token ID is empty", func(t *testing.T) {
@@ -97,16 +110,35 @@ func TestTokensService_GetPersonalAccessToken(t *testing.T) {
97110
require.Equal(t, connect.CodeInvalidArgument, connect.CodeOf(err))
98111
})
99112

100-
t.Run("unimplemented when feature flag enabled", func(t *testing.T) {
101-
serverMock, _, client := setupTokensService(t, withTokenFeatureEnabled)
113+
t.Run("responds with not found when token is not found", func(t *testing.T) {
114+
serverMock, dbConn, client := setupTokensService(t, withTokenFeatureEnabled)
115+
116+
dbtest.CreatePersonalAccessTokenRecords(t, dbConn,
117+
dbtest.NewPersonalAccessToken(t, db.PersonalAccessToken{
118+
UserID: uuid.MustParse(user.ID),
119+
}),
120+
)
102121

103122
serverMock.EXPECT().GetLoggedInUser(gomock.Any()).Return(user, nil)
104123

105124
_, err := client.GetPersonalAccessToken(context.Background(), connect.NewRequest(&v1.GetPersonalAccessTokenRequest{
106125
Id: uuid.New().String(),
107126
}))
108127

109-
require.Equal(t, connect.CodeUnimplemented, connect.CodeOf(err))
128+
require.Equal(t, connect.CodeNotFound, connect.CodeOf(err))
129+
})
130+
131+
t.Run("permission denied when feature flag disabled", func(t *testing.T) {
132+
serverMock, _, client := setupTokensService(t, withTokenFeatureDisabled)
133+
134+
serverMock.EXPECT().GetLoggedInUser(gomock.Any()).Return(user, nil)
135+
136+
_, err := client.GetPersonalAccessToken(context.Background(), connect.NewRequest(&v1.GetPersonalAccessTokenRequest{
137+
Id: uuid.New().String(),
138+
}))
139+
140+
require.Error(t, err, "This feature is currently in beta. If you would like to be part of the beta, please contact us.")
141+
require.Equal(t, connect.CodePermissionDenied, connect.CodeOf(err))
110142
})
111143
}
112144

0 commit comments

Comments
 (0)