Skip to content

[pat] API allows update which does not change any data #15108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions components/gitpod-db/go/personal_access_token.go
Original file line number Diff line number Diff line change
Expand Up @@ -235,10 +235,6 @@ func UpdatePersonalAccessTokenForUser(ctx context.Context, conn *gorm.DB, opts U
return PersonalAccessToken{}, fmt.Errorf("failed to update personal access token: %w", tx.Error)
}

if tx.RowsAffected == 0 {
return PersonalAccessToken{}, fmt.Errorf("token (ID: %s) for user (ID: %s) does not exist: %w", opts.TokenID, opts.UserID, ErrorNotFound)
}

return GetPersonalAccessTokenForUser(ctx, conn, opts.TokenID, opts.UserID)
}

Expand Down
18 changes: 18 additions & 0 deletions components/gitpod-db/go/personal_access_token_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,24 @@ func TestUpdatePersonalAccessTokenForUser(t *testing.T) {
require.ErrorIs(t, err, db.ErrorNotFound)
})

t.Run("no modified field completes gracefully", func(t *testing.T) {
conn := dbtest.ConnectForTests(t)
name := "first"

created := dbtest.CreatePersonalAccessTokenRecords(t, conn, dbtest.NewPersonalAccessToken(t, db.PersonalAccessToken{
Name: name,
}))[0]

udpated, err := db.UpdatePersonalAccessTokenForUser(context.Background(), conn, db.UpdatePersonalAccessTokenOpts{
TokenID: created.ID,
UserID: created.UserID,
Name: &name,
})
require.NoError(t, err)
require.Equal(t, name, udpated.Name)
require.Len(t, udpated.Scopes, 0)
})

t.Run("no update when all options are nil", func(t *testing.T) {
conn := dbtest.ConnectForTests(t)

Expand Down
25 changes: 25 additions & 0 deletions components/public-api-server/pkg/apiv1/tokens_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,31 @@ func TestTokensService_UpdatePersonalAccessToken(t *testing.T) {
require.Equal(t, connect.CodeInvalidArgument, connect.CodeOf(err))
})

t.Run("allows unmodified udpate", func(t *testing.T) {
serverMock, _, client := setupTokensService(t, withTokenFeatureEnabled)

serverMock.EXPECT().GetLoggedInUser(gomock.Any()).Return(user, nil).Times(2)

createResponse, err := client.CreatePersonalAccessToken(context.Background(), connect.NewRequest(&v1.CreatePersonalAccessTokenRequest{
Token: &v1.PersonalAccessToken{
Name: "first",
ExpirationTime: timestamppb.Now(),
},
}))
require.NoError(t, err)

_, err = client.UpdatePersonalAccessToken(context.Background(), connect.NewRequest(&v1.UpdatePersonalAccessTokenRequest{
Token: &v1.PersonalAccessToken{
Id: createResponse.Msg.GetToken().GetId(),
Name: createResponse.Msg.GetToken().GetName(),
},
UpdateMask: &fieldmaskpb.FieldMask{
Paths: []string{"name", "scopes"},
},
}))
require.NoError(t, err)
})

t.Run("default updates both name and scopes, when no mask specified", func(t *testing.T) {
serverMock, _, client := setupTokensService(t, withTokenFeatureEnabled)

Expand Down