s/favored/favorite/g

coder · johnstcn · Jan 16, 2024 · Jan 17, 2024 · Jan 17, 2024 · Jan 17, 2024
commit 89d618df8641237efaefe60f7dded5e44e7f4765
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
@@ -656,20 +656,6 @@ func authorizedTemplateVersionFromJob(ctx context.Context, q *querier, job datab
 	}
 }
 
-func (q *querier) FavoriteWorkspace(ctx context.Context, arg database.FavoriteWorkspaceParams) error {
-	if _, err := q.GetWorkspaceByID(ctx, arg.WorkspaceID); err != nil {
-		return err
-	}
-	return q.db.FavoriteWorkspace(ctx, arg)
-}
-
-func (q *querier) UnfavoriteWorkspace(ctx context.Context, arg database.UnfavoriteWorkspaceParams) error {
-	if _, err := q.GetWorkspaceByID(ctx, arg.WorkspaceID); err != nil {
-		return err
-	}
-	return q.db.UnfavoriteWorkspace(ctx, arg)
-}
-
 func (q *querier) AcquireLock(ctx context.Context, id int64) error {
 	return q.db.AcquireLock(ctx, id)
 }
@@ -905,6 +891,13 @@ func (q *querier) DeleteTailnetTunnel(ctx context.Context, arg database.DeleteTa
 	return q.db.DeleteTailnetTunnel(ctx, arg)
 }
 
+func (q *querier) FavoriteWorkspace(ctx context.Context, arg database.FavoriteWorkspaceParams) error {
+	if _, err := q.GetWorkspaceByID(ctx, arg.WorkspaceID); err != nil {
+		return err
+	}
+	return q.db.FavoriteWorkspace(ctx, arg)
+}
+
 func (q *querier) GetAPIKeyByID(ctx context.Context, id string) (database.APIKey, error) {
 	return fetch(q.log, q.auth, q.db.GetAPIKeyByID)(ctx, id)
 }
@@ -2523,6 +2516,13 @@ func (q *querier) UnarchiveTemplateVersion(ctx context.Context, arg database.Una
 	return q.db.UnarchiveTemplateVersion(ctx, arg)
 }
 
+func (q *querier) UnfavoriteWorkspace(ctx context.Context, arg database.UnfavoriteWorkspaceParams) error {
+	if _, err := q.GetWorkspaceByID(ctx, arg.WorkspaceID); err != nil {
+		return err
+	}
+	return q.db.UnfavoriteWorkspace(ctx, arg)
+}
+
 func (q *querier) UpdateAPIKeyByID(ctx context.Context, arg database.UpdateAPIKeyByIDParams) error {
 	fetch := func(ctx context.Context, arg database.UpdateAPIKeyByIDParams) (database.APIKey, error) {
 		return q.db.GetAPIKeyByID(ctx, arg.ID)

diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -732,47 +732,6 @@ func isNotNull(v interface{}) bool {
 	return reflect.ValueOf(v).FieldByName("Valid").Bool()
 }
 
-func (q *FakeQuerier) FavoriteWorkspace(_ context.Context, arg database.FavoriteWorkspaceParams) error {
-	err := validateDatabaseType(arg)
-	if err != nil {
-		return err
-	}
-
-	q.mutex.Lock()
-	defer q.mutex.Unlock()
-
-	for _, upw := range q.favoriteWorkspaces {
-		if arg.UserID == upw.UserID && arg.WorkspaceID == upw.WorkspaceID {
-			return errDuplicateKey
-		}
-	}
-	return nil
-}
-
-func (q *FakeQuerier) UnfavoriteWorkspace(_ context.Context, arg database.UnfavoriteWorkspaceParams) error {
-	err := validateDatabaseType(arg)
-	if err != nil {
-		return err
-	}
-
-	q.mutex.Lock()
-	defer q.mutex.Unlock()
-
-	for index, upw := range q.favoriteWorkspaces {
-		if upw.UserID != arg.UserID {
-			continue
-		}
-		if upw.WorkspaceID != arg.WorkspaceID {
-			continue
-		}
-		q.favoriteWorkspaces[index] = q.favoriteWorkspaces[len(q.apiKeys)-1]
-		q.favoriteWorkspaces = q.favoriteWorkspaces[:len(q.favoriteWorkspaces)-1]
-		return nil
-	}
-
-	return nil
-}
-
 func (*FakeQuerier) AcquireLock(_ context.Context, _ int64) error {
 	return xerrors.New("AcquireLock must only be called within a transaction")
 }
@@ -1358,6 +1317,23 @@ func (*FakeQuerier) DeleteTailnetTunnel(_ context.Context, arg database.DeleteTa
 	return database.DeleteTailnetTunnelRow{}, ErrUnimplemented
 }
 
+func (q *FakeQuerier) FavoriteWorkspace(_ context.Context, arg database.FavoriteWorkspaceParams) error {
+	err := validateDatabaseType(arg)
+	if err != nil {
+		return err
+	}
+
+	q.mutex.Lock()
+	defer q.mutex.Unlock()
+
+	for _, upw := range q.favoriteWorkspaces {
+		if arg.UserID == upw.UserID && arg.WorkspaceID == upw.WorkspaceID {
+			return errDuplicateKey
+		}
+	}
+	return nil
+}
+
 func (q *FakeQuerier) GetAPIKeyByID(_ context.Context, id string) (database.APIKey, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
@@ -6027,6 +6003,30 @@ func (q *FakeQuerier) UnarchiveTemplateVersion(_ context.Context, arg database.U
 	return sql.ErrNoRows
 }
 
+func (q *FakeQuerier) UnfavoriteWorkspace(_ context.Context, arg database.UnfavoriteWorkspaceParams) error {
+	err := validateDatabaseType(arg)
+	if err != nil {
+		return err
+	}
+
+	q.mutex.Lock()
+	defer q.mutex.Unlock()
+
+	for index, upw := range q.favoriteWorkspaces {
+		if upw.UserID != arg.UserID {
+			continue
+		}
+		if upw.WorkspaceID != arg.WorkspaceID {
+			continue
+		}
+		q.favoriteWorkspaces[index] = q.favoriteWorkspaces[len(q.apiKeys)-1]
+		q.favoriteWorkspaces = q.favoriteWorkspaces[:len(q.favoriteWorkspaces)-1]
+		return nil
+	}
+
+	return nil
+}
+
 func (q *FakeQuerier) UpdateAPIKeyByID(_ context.Context, arg database.UpdateAPIKeyByIDParams) error {
 	if err := validateDatabaseType(arg); err != nil {
 		return err

diff --git a/coderd/database/modelqueries.go b/coderd/database/modelqueries.go
@@ -253,7 +253,7 @@ func (q *sqlQuerier) GetAuthorizedWorkspaces(ctx context.Context, arg GetWorkspa
 			&i.TemplateName,
 			&i.TemplateVersionID,
 			&i.TemplateVersionName,
-			&i.Favored,
+			&i.Favorite,
 			&i.Count,
 		); err != nil {
 			return nil, err

diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspaces.sql b/coderd/database/queries/workspaces.sql
@@ -82,7 +82,7 @@ SELECT
 	COALESCE(template_name.template_name, 'unknown') as template_name,
 	latest_build.template_version_id,
 	latest_build.template_version_name,
-	(fws.user_id IS NOT NULL)::boolean AS favored,
+	(fws.user_id IS NOT NULL)::boolean AS favorite,
 	COUNT(*) OVER () as count
 FROM
     workspaces
@@ -276,7 +276,7 @@ WHERE
 	-- Authorize Filter clause will be injected below in GetAuthorizedWorkspaces
 	-- @authorize_filter
 ORDER BY
-	favored DESC,
+	favorite DESC,
 	(latest_build.completed_at IS NOT NULL AND
 		latest_build.canceled_at IS NULL AND
 		latest_build.error IS NULL AND

diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -2950,17 +2950,17 @@ func TestWorkspaceFavoriteUnfavorite(t *testing.T) {
 	workspaces, err := memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
 	require.NoError(t, err)
 	require.Len(t, workspaces.Workspaces, 1)
-	require.False(t, workspaces.Workspaces[0].Favored)
+	require.False(t, workspaces.Workspaces[0].Favorite)
 	ws, err := memberClient.Workspace(ctx, wsb1.Workspace.ID)
 	require.NoError(t, err)
-	require.False(t, ws.Favored)
+	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, 2)
-	require.False(t, workspaces.Workspaces[0].Favored)
-	require.False(t, workspaces.Workspaces[1].Favored)
+	require.False(t, workspaces.Workspaces[0].Favorite)
+	require.False(t, workspaces.Workspaces[1].Favorite)
 
 	// When member pins workspace
 	err = memberClient.FavoriteWorkspace(ctx, wsb1.Workspace.ID)
@@ -2970,20 +2970,20 @@ func TestWorkspaceFavoriteUnfavorite(t *testing.T) {
 	workspaces, err = memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
 	require.NoError(t, err)
 	require.Len(t, workspaces.Workspaces, 1)
-	require.True(t, workspaces.Workspaces[0].Favored)
+	require.True(t, workspaces.Workspaces[0].Favorite)
 	ws, err = memberClient.Workspace(ctx, wsb1.Workspace.ID)
 	require.NoError(t, err)
-	require.True(t, ws.Favored)
+	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, 2)
-	require.False(t, workspaces.Workspaces[0].Favored)
-	require.False(t, workspaces.Workspaces[1].Favored)
+	require.False(t, workspaces.Workspaces[0].Favorite)
+	require.False(t, workspaces.Workspaces[1].Favorite)
 	ws, err = client.Workspace(ctx, wsb1.Workspace.ID)
 	require.NoError(t, err)
-	require.False(t, ws.Favored)
+	require.False(t, ws.Favorite)
 
 	// When member unpins workspace
 	err = memberClient.UnfavoriteWorkspace(ctx, wsb1.Workspace.ID)
@@ -2993,18 +2993,18 @@ func TestWorkspaceFavoriteUnfavorite(t *testing.T) {
 	workspaces, err = memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
 	require.NoError(t, err)
 	require.Len(t, workspaces.Workspaces, 1)
-	require.False(t, workspaces.Workspaces[0].Favored)
+	require.False(t, workspaces.Workspaces[0].Favorite)
 	ws, err = memberClient.Workspace(ctx, wsb1.Workspace.ID)
 	require.NoError(t, err)
-	require.False(t, ws.Favored)
+	require.False(t, ws.Favorite)
 
 	// Assert invariant: workspace should remain unpinned for a different user
 	workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
 	require.NoError(t, err)
 	require.Len(t, workspaces.Workspaces, 2)
-	require.False(t, workspaces.Workspaces[0].Favored)
-	require.False(t, workspaces.Workspaces[1].Favored)
+	require.False(t, workspaces.Workspaces[0].Favorite)
+	require.False(t, workspaces.Workspaces[1].Favorite)
 	ws, err = client.Workspace(ctx, wsb1.Workspace.ID)
 	require.NoError(t, err)
-	require.False(t, ws.Favored)
+	require.False(t, ws.Favorite)
 }
diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -58,7 +58,7 @@ type Workspace struct {
 	Health           WorkspaceHealth  `json:"health"`
 	AutomaticUpdates AutomaticUpdates `json:"automatic_updates" enums:"always,never"`
 	AllowRenames     bool             `json:"allow_renames"`
-	Favored          bool             `json:"favored"`
+	Favorite         bool             `json:"favorite"`
 }
 
 func (w Workspace) FullName() string {

diff --git a/docs/api/schemas.md b/docs/api/schemas.md