From 2c7394bb3d23ea269af364f3338c68ea4e34f866 Mon Sep 17 00:00:00 2001 From: Bruno Quaresma Date: Fri, 8 Dec 2023 10:41:58 -0300 Subject: [PATCH] refactor(site): change a few names related to workspace actions (#11079) --- .../WorkspaceActions/WorkspaceActions.tsx | 6 +++--- .../WorkspaceActions/constants.ts | 19 ++++++++----------- 2 files changed, 11 insertions(+), 14 deletions(-) diff --git a/site/src/pages/WorkspacePage/WorkspaceActions/WorkspaceActions.tsx b/site/src/pages/WorkspacePage/WorkspaceActions/WorkspaceActions.tsx index 181c3b4ba0..9da5288386 100644 --- a/site/src/pages/WorkspacePage/WorkspaceActions/WorkspaceActions.tsx +++ b/site/src/pages/WorkspacePage/WorkspaceActions/WorkspaceActions.tsx @@ -3,7 +3,7 @@ import { Workspace, WorkspaceBuildParameter } from "api/typesGenerated"; import { useWorkspaceDuplication } from "pages/CreateWorkspacePage/useWorkspaceDuplication"; import { workspaceUpdatePolicy } from "utils/workspace"; -import { type ButtonType, actionsByWorkspaceStatus } from "./constants"; +import { type ActionType, abilitiesByWorkspaceStatus } from "./constants"; import { ActionLoadingButton, @@ -72,7 +72,7 @@ export const WorkspaceActions: FC = ({ const { duplicateWorkspace, isDuplicationReady } = useWorkspaceDuplication(workspace); - const { actions, canCancel, canAcceptJobs } = actionsByWorkspaceStatus( + const { actions, canCancel, canAcceptJobs } = abilitiesByWorkspaceStatus( workspace, canRetryDebug, ); @@ -85,7 +85,7 @@ export const WorkspaceActions: FC = ({ const canBeUpdated = workspace.outdated && canAcceptJobs; // A mapping of button type to the corresponding React component - const buttonMapping: Record = { + const buttonMapping: Record = { update: , updating: , start: ( diff --git a/site/src/pages/WorkspacePage/WorkspaceActions/constants.ts b/site/src/pages/WorkspacePage/WorkspaceActions/constants.ts index 5d043cc300..ba966d81d5 100644 --- a/site/src/pages/WorkspacePage/WorkspaceActions/constants.ts +++ b/site/src/pages/WorkspacePage/WorkspaceActions/constants.ts @@ -1,9 +1,9 @@ import { type Workspace, type WorkspaceStatus } from "api/typesGenerated"; /** - * An iterable of all button types supported by the workspace actions UI + * An iterable of all action types supported by the workspace UI */ -export const buttonTypes = [ +export const actionTypes = [ "start", "starting", "stop", @@ -28,18 +28,15 @@ export const buttonTypes = [ "pending", ] as const; -/** - * A button type supported by the workspace actions UI - */ -export type ButtonType = (typeof buttonTypes)[number]; +export type ActionType = (typeof actionTypes)[number]; type WorkspaceAbilities = { - actions: readonly ButtonType[]; + actions: readonly ActionType[]; canCancel: boolean; canAcceptJobs: boolean; }; -export const actionsByWorkspaceStatus = ( +export const abilitiesByWorkspaceStatus = ( workspace: Workspace, canRetryDebug: boolean, ): WorkspaceAbilities => { @@ -54,15 +51,15 @@ export const actionsByWorkspaceStatus = ( const status = workspace.latest_build.status; if (status === "failed" && canRetryDebug) { return { - ...statusToActions.failed, + ...statusToAbility.failed, actions: ["retry", "retryDebug"], }; } - return statusToActions[status]; + return statusToAbility[status]; }; -const statusToActions: Record = { +const statusToAbility: Record = { starting: { actions: ["starting"], canCancel: true,