Skip to content
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.

Sign up for GitHub

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

Fix UserTask Status not being updated #50855

Merged
merged 3 commits into from
Jan 10, 2025
+52 −11
Merged

Fix UserTask Status not being updated #50855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
16dd2ac
Fix UserTask Status not being updated
marcoandredinis Jan 8, 2025
61bb2ec
copy the status field
marcoandredinis Jan 9, 2025
3d93237
use admin client instead of backend directly
marcoandredinis Jan 10, 2025
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
25 changes: 16 additions & 9 deletions lib/auth/usertasks/usertasksv1/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
package usertasksv1

import (
"cmp"
"context"
"log/slog"
"time"
Expand Down Expand Up @@ -131,7 +132,7 @@ func (s *Service) CreateUserTask(ctx context.Context, req *usertasksv1.CreateUse
return nil, trace.Wrap(err)
}

s.updateStatus(req.UserTask)
s.updateStatus(req.UserTask, nil /* existing user task */)

rsp, err := s.backend.CreateUserTask(ctx, req.UserTask)
s.emitCreateAuditEvent(ctx, rsp, authCtx, err)
Expand Down Expand Up @@ -264,10 +265,7 @@ func (s *Service) UpdateUserTask(ctx context.Context, req *usertasksv1.UpdateUse
}

stateChanged := existingUserTask.GetSpec().GetState() != req.GetUserTask().GetSpec().GetState()

if stateChanged {
s.updateStatus(req.UserTask)
}
s.updateStatus(req.UserTask, existingUserTask)

rsp, err := s.backend.UpdateUserTask(ctx, req.UserTask)
s.emitUpdateAuditEvent(ctx, existingUserTask, req.GetUserTask(), authCtx, err)
Expand Down Expand Up @@ -333,9 +331,7 @@ func (s *Service) UpsertUserTask(ctx context.Context, req *usertasksv1.UpsertUse
stateChanged = existingUserTask.GetSpec().GetState() != req.GetUserTask().GetSpec().GetState()
}

if stateChanged {
s.updateStatus(req.UserTask)
}
s.updateStatus(req.UserTask, existingUserTask)

rsp, err := s.backend.UpsertUserTask(ctx, req.UserTask)
s.emitUpsertAuditEvent(ctx, existingUserTask, req.GetUserTask(), authCtx, err)
Expand All @@ -350,10 +346,21 @@ func (s *Service) UpsertUserTask(ctx context.Context, req *usertasksv1.UpsertUse
return rsp, nil
}

func (s *Service) updateStatus(ut *usertasksv1.UserTask) {
func (s *Service) updateStatus(ut *usertasksv1.UserTask, existing *usertasksv1.UserTask) {
// Default status for UserTask.
ut.Status = &usertasksv1.UserTaskStatus{
LastStateChange: timestamppb.New(s.clock.Now()),
}

if existing != nil {
// Inherit everything from existing UserTask.
ut.Status.LastStateChange = cmp.Or(existing.GetStatus().GetLastStateChange(), ut.Status.LastStateChange)

// Update specific values.
if existing.GetSpec().GetState() != ut.GetSpec().GetState() {
ut.Status.LastStateChange = timestamppb.New(s.clock.Now())
}
}
}

func (s *Service) emitUpsertAuditEvent(ctx context.Context, old, new *usertasksv1.UserTask, authCtx *authz.Context, err error) {
Expand Down
33 changes: 32 additions & 1 deletion lib/auth/usertasks/usertasksv1/service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ func TestEvents(t *testing.T) {
// LastStateChange is updated.
require.Equal(t, timestamppb.New(fakeClock.Now()), createUserTaskResp.Status.LastStateChange)

expectedLastStateChange := createUserTaskResp.Status.LastStateChange
ut1.Spec.DiscoverEc2.Instances["i-345"] = &usertasksv1.DiscoverEC2Instance{
InstanceId: "i-345",
DiscoveryConfig: "dc01",
Expand All @@ -165,7 +166,7 @@ func TestEvents(t *testing.T) {
require.Len(t, testReporter.emittedEvents, 1)
consumeAssertEvent(t, auditEventsSink.C(), auditEventFor(userTaskName, "update", "OPEN", "OPEN"))
// LastStateChange is not updated.
require.Equal(t, createUserTaskResp.Status.LastStateChange, upsertUserTaskResp.Status.LastStateChange)
require.Equal(t, expectedLastStateChange.AsTime(), upsertUserTaskResp.Status.LastStateChange.AsTime())

ut1.Spec.State = "RESOLVED"
fakeClock.Advance(1 * time.Minute)
Expand All @@ -177,6 +178,36 @@ func TestEvents(t *testing.T) {
// LastStateChange was updated because the state changed.
require.Equal(t, timestamppb.New(fakeClock.Now()), updateUserTaskResp.Status.LastStateChange)

// Updating one of the instances.
expectedLastStateChange = updateUserTaskResp.Status.GetLastStateChange()
fakeClock.Advance(1 * time.Minute)
ut1.Spec.DiscoverEc2.Instances["i-345"] = &usertasksv1.DiscoverEC2Instance{
InstanceId: "i-345",
DiscoveryConfig: "dc01",
DiscoveryGroup: "dg01",
SyncTime: timestamppb.New(fakeClock.Now()),
}
updateUserTaskResp, err = service.UpdateUserTask(ctx, &usertasksv1.UpdateUserTaskRequest{UserTask: ut1})
require.NoError(t, err)
// Does not change the LastStateChange
require.Equal(t, expectedLastStateChange.AsTime(), updateUserTaskResp.Status.LastStateChange.AsTime())
consumeAssertEvent(t, auditEventsSink.C(), auditEventFor(userTaskName, "update", "RESOLVED", "RESOLVED"))

// Upserting one of the instances.
expectedLastStateChange = updateUserTaskResp.Status.GetLastStateChange()
fakeClock.Advance(1 * time.Minute)
ut1.Spec.DiscoverEc2.Instances["i-345"] = &usertasksv1.DiscoverEC2Instance{
InstanceId: "i-345",
DiscoveryConfig: "dc01",
DiscoveryGroup: "dg01",
SyncTime: timestamppb.New(fakeClock.Now()),
}
upsertUserTaskResp, err = service.UpsertUserTask(ctx, &usertasksv1.UpsertUserTaskRequest{UserTask: ut1})
require.NoError(t, err)
// Does not change the LastStateChange
require.Equal(t, expectedLastStateChange.AsTime(), upsertUserTaskResp.Status.LastStateChange.AsTime())
consumeAssertEvent(t, auditEventsSink.C(), auditEventFor(userTaskName, "update", "RESOLVED", "RESOLVED"))

_, err = service.DeleteUserTask(ctx, &usertasksv1.DeleteUserTaskRequest{Name: userTaskName})
require.NoError(t, err)
// No usage report for deleted resources.
Expand Down
5 changes: 4 additions & 1 deletion lib/web/usertasks_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import (
usertasksv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/usertasks/v1"
"github.com/gravitational/teleport/api/types"
"github.com/gravitational/teleport/api/types/usertasks"
"github.com/gravitational/teleport/lib/auth"
"github.com/gravitational/teleport/lib/services"
"github.com/gravitational/teleport/lib/web/ui"
)
Expand All @@ -53,6 +54,8 @@ func TestUserTask(t *testing.T) {
})
require.NoError(t, err)
pack := env.proxies[0].authPack(t, userWithRW, []types.Role{roleRWUserTask})
adminClient, err := env.server.NewClient(auth.TestAdmin())
require.NoError(t, err)

getAllEndpoint := pack.clt.Endpoint("webapi", "sites", clusterName, "usertask")
singleItemEndpoint := func(name string) string {
Expand Down Expand Up @@ -90,7 +93,7 @@ func TestUserTask(t *testing.T) {
})
require.NoError(t, err)

_, err = env.proxies[0].auth.Auth().CreateUserTask(ctx, userTask)
_, err = adminClient.UserTasksServiceClient().CreateUserTask(ctx, userTask)
require.NoError(t, err)
userTaskForTest = userTask
}
Expand Down
Loading