Skip to content

feat(coderd): add ability to mark workspaces as favorite #11673

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

Closed
wants to merge 27 commits into from
Closed

feat(coderd): add ability to mark workspaces as favorite #11673

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
46ca00d
feat(coderd): add user_pinned_workspaces table
johnstcn Jan 16, 2024
015aabb
add unique index
johnstcn Jan 17, 2024
0b0dce6
rename migration
johnstcn Jan 17, 2024
9878da7
add queries to pin/unpin workspace
johnstcn Jan 17, 2024
4fba238
add pinned status to GetWorkspaces/GetAuthorizedWorkspaces queries
johnstcn Jan 17, 2024
83b03d9
add API endpoints and test (currently fails)
johnstcn Jan 18, 2024
0961298
rename to favorite workspace
johnstcn Jan 18, 2024
a814b65
move to top-level test
johnstcn Jan 22, 2024
89d618d
s/favored/favorite/g
johnstcn Jan 22, 2024
7238b95
move favorite status to workspaces table to avoid sqlc join sadness
johnstcn Jan 22, 2024
4eef59a
more wiring
johnstcn Jan 22, 2024
0f8904d
improve test to include sort order of favorites
johnstcn Jan 22, 2024
d921aa0
fix swagger summary
johnstcn Jan 22, 2024
b68c18e
make gen
johnstcn Jan 22, 2024
3d0545a
use dbfake for testing sort order
johnstcn Jan 22, 2024
46103a4
reduce scope of TestWorkspaceFavoriteUnfavorite to not include sortin…
johnstcn Jan 22, 2024
f6c0361
beef up sort order test
johnstcn Jan 22, 2024
89f0f50
rm unnecessary fixture
johnstcn Jan 22, 2024
c9ed43c
fix sort ordering, dbfake still TODO
johnstcn Jan 22, 2024
ff3cde2
remove unnecessary change to CreateFirstUser
johnstcn Jan 23, 2024
f735b69
best-effort fix but testing dbmem sort order is a waste of time
johnstcn Jan 23, 2024
f6e9531
requestor->requester
johnstcn Jan 23, 2024
34f2902
fixup! remove unnecessary change to CreateFirstUser
johnstcn Jan 23, 2024
99c7f96
remove unused resource
johnstcn Jan 23, 2024
d530546
fix sort ordering bug in dmem
johnstcn Jan 23, 2024
6392db9
add test case
johnstcn Jan 23, 2024
9979c53
remove need for conditional ordering
johnstcn Jan 23, 2024
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
Prev Previous commit
Next Next commit
reduce scope of TestWorkspaceFavoriteUnfavorite to not include sortin… 
…g order
  • Loading branch information
@johnstcn
johnstcn committed Jan 23, 2024
commit 46103a481b2a0fc48d87625772bf09807cf26d07
76 changes: 24 additions & 52 deletions coderd/workspaces_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2931,84 +2931,56 @@ func TestWorkspaceFavoriteUnfavorite(t *testing.T) {
client, db = coderdtest.NewWithDatabase(t, &coderdtest.Options{
Auditor: auditRecorder,
})
owner = coderdtest.CreateFirstUser(t, client)
memberClient, member = coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
owner = coderdtest.CreateFirstUser(t, client)
memberClient, _ = coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
// This will be our 'favorite' workspace
wsb1 = dbfake.WorkspaceBuild(t, db, database.Workspace{OwnerID: member.ID, OrganizationID: owner.OrganizationID}).Do()
// Another workspace for member, but not their favorite.
_ = dbfake.WorkspaceBuild(t, db, database.Workspace{OwnerID: member.ID, OrganizationID: owner.OrganizationID}).Do()
// A workspace for another user.
_ = dbfake.WorkspaceBuild(t, db, database.Workspace{OwnerID: owner.UserID, OrganizationID: owner.OrganizationID}).Do()
wsb = dbfake.WorkspaceBuild(t, db, database.Workspace{OwnerID: owner.UserID, OrganizationID: owner.OrganizationID}).Do()
)

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

// Initially, workspace should not be favored for member.
workspaces, err := memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
workspaces, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{})
require.NoError(t, err)
require.Len(t, workspaces.Workspaces, 2)
require.Len(t, workspaces.Workspaces, 1)
require.False(t, workspaces.Workspaces[0].Favorite, "no favorites yet")
require.False(t, workspaces.Workspaces[1].Favorite, "no favorites yet")
ws, err := memberClient.Workspace(ctx, wsb1.Workspace.ID)
ws, err := client.Workspace(ctx, wsb.Workspace.ID)
require.NoError(t, err)
require.False(t, ws.Favorite)

// Also not for owner.
workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
require.NoError(t, err)
require.Len(t, workspaces.Workspaces, 3)
require.False(t, workspaces.Workspaces[0].Favorite, "this user is impartial and has no favorites")
require.False(t, workspaces.Workspaces[1].Favorite, "this user is impartial and has no favorites")
require.False(t, workspaces.Workspaces[2].Favorite, "this user is impartial and has no favorites")

// When member favorites workspace
err = memberClient.FavoriteWorkspace(ctx, wsb1.Workspace.ID)
// When user favorites workspace
err = client.FavoriteWorkspace(ctx, wsb.Workspace.ID)
require.NoError(t, err)

// Then it should be favored for them and show up first.
workspaces, err = memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
// Then it should be favored for them.
workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
require.NoError(t, err)
require.Len(t, workspaces.Workspaces, 2)
require.Len(t, workspaces.Workspaces, 1)
require.True(t, workspaces.Workspaces[0].Favorite, "favorites should come first")
require.False(t, workspaces.Workspaces[1].Favorite, "favorites should come first")
ws, err = memberClient.Workspace(ctx, wsb1.Workspace.ID)
ws, err = client.Workspace(ctx, wsb.Workspace.ID)
require.NoError(t, err)
require.True(t, ws.Favorite)

// But not for someone else
workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
require.NoError(t, err)
require.Len(t, workspaces.Workspaces, 3)
require.False(t, workspaces.Workspaces[0].Favorite, "this user is impartial and has no favorites")
require.False(t, workspaces.Workspaces[1].Favorite, "this user is impartial and has no favorites")
require.False(t, workspaces.Workspaces[2].Favorite, "this user is impartial and has no favorites")
ws, err = client.Workspace(ctx, wsb1.Workspace.ID)
require.NoError(t, err)
require.False(t, ws.Favorite)

// When member unfavorites workspace
err = memberClient.UnfavoriteWorkspace(ctx, wsb1.Workspace.ID)
err = client.UnfavoriteWorkspace(ctx, wsb.Workspace.ID)
require.NoError(t, err)

// Then it should no longer be favored
workspaces, err = memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
require.NoError(t, err)
require.Len(t, workspaces.Workspaces, 2)
require.Len(t, workspaces.Workspaces, 1)
require.False(t, workspaces.Workspaces[0].Favorite, "no longer favorite")
require.False(t, workspaces.Workspaces[1].Favorite, "no longer favorite")
ws, err = memberClient.Workspace(ctx, wsb1.Workspace.ID)
ws, err = client.Workspace(ctx, wsb.Workspace.ID)
require.NoError(t, err)
require.False(t, ws.Favorite)

// Assert invariant: workspace should remain unfavorited for a different user
workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
require.NoError(t, err)
require.Len(t, workspaces.Workspaces, 3)
require.False(t, workspaces.Workspaces[0].Favorite, "this user is impartial and has no favorites")
require.False(t, workspaces.Workspaces[1].Favorite, "this user is impartial and has no favorites")
require.False(t, workspaces.Workspaces[2].Favorite, "this user is impartial and has no favorites")
ws, err = client.Workspace(ctx, wsb1.Workspace.ID)
require.NoError(t, err)
require.False(t, ws.Favorite)
// Users without write access to the workspace should not be able to perform the above.
err = memberClient.FavoriteWorkspace(ctx, wsb.Workspace.ID)
var sdkErr *codersdk.Error
require.ErrorAs(t, err, &sdkErr)
require.Equal(t, http.StatusNotFound, sdkErr.StatusCode())
err = memberClient.UnfavoriteWorkspace(ctx, wsb.Workspace.ID)
require.ErrorAs(t, err, &sdkErr)
require.Equal(t, http.StatusNotFound, sdkErr.StatusCode())
}
4 changes: 2 additions & 2 deletions codersdk/workspaces.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ func (c *Client) FavoriteWorkspace(ctx context.Context, workspaceID uuid.UUID) e
}
defer res.Body.Close()
if res.StatusCode != http.StatusNoContent {
return err
return ReadBodyAsError(res)
}
return nil
}
Expand All @@ -491,7 +491,7 @@ func (c *Client) UnfavoriteWorkspace(ctx context.Context, workspaceID uuid.UUID)
}
defer res.Body.Close()
if res.StatusCode != http.StatusNoContent {
return err
return ReadBodyAsError(res)
}
return nil
}
Expand Down