feat: add frontend for locked workspaces

- Fix workspaces query for locked workspaces.
coder · sreya · Aug 4, 2023 · Jul 14, 2023 · Jul 21, 2023 · Jul 25, 2023
commit 0d79b8fee46e5445edd54c105d44f4e6c5f14bf0
diff --git a/coderd/database/modelqueries.go b/coderd/database/modelqueries.go
@@ -217,6 +217,7 @@ func (q *sqlQuerier) GetAuthorizedWorkspaces(ctx context.Context, arg GetWorkspa
 		arg.Name,
 		arg.HasAgent,
 		arg.AgentInactiveDisconnectTimeoutSeconds,
+		arg.LockedAt,
 		arg.Offset,
 		arg.Limit,
 	)

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
@@ -259,6 +259,12 @@ WHERE
 			) > 0
 		ELSE true
 	END
+	-- Filter by locked workspaces.
+	AND CASE
+		WHEN @locked_at :: timestamptz > '0001-01-01 00:00:00+00'::timestamptz THEN
+			locked_at IS NOT NULL AND locked_at >= @locked_at
+		ELSE true
+	END
 	-- Authorize Filter clause will be injected below in GetAuthorizedWorkspaces
 	-- @authorize_filter
 ORDER BY

diff --git a/coderd/searchquery/search.go b/coderd/searchquery/search.go
@@ -114,6 +114,7 @@ func Workspaces(query string, page codersdk.Pagination, agentInactiveDisconnectT
 	filter.Name = parser.String(values, "", "name")
 	filter.Status = string(httpapi.ParseCustom(parser, values, "", "status", httpapi.ParseEnum[database.WorkspaceStatus]))
 	filter.HasAgent = parser.String(values, "", "has-agent")
+	filter.LockedAt = parser.Time(values, time.Time{}, "locked_at", "2006-01-02")
 
 	if _, ok := values["deleting_by"]; ok {
 		postFilter.DeletingBy = ptr.Ref(parser.Time(values, time.Time{}, "deleting_by", "2006-01-02"))

diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -1407,6 +1407,46 @@ func TestWorkspaceFilterManual(t *testing.T) {
 		// and template.InactivityTTL should be 0
 		assert.Len(t, res.Workspaces, 0)
 	})
+
+	t.Run("LockedAt", func(t *testing.T) {
+		// this test has a licensed counterpart in enterprise/coderd/workspaces_test.go: FilterQueryHasDeletingByAndLicensed
+		t.Parallel()
+		client := coderdtest.New(t, &coderdtest.Options{
+			IncludeProvisionerDaemon: true,
+		})
+		user := coderdtest.CreateFirstUser(t, client)
+		authToken := uuid.NewString()
+		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
+			Parse:          echo.ParseComplete,
+			ProvisionPlan:  echo.ProvisionComplete,
+			ProvisionApply: echo.ProvisionApplyWithAgent(authToken),
+		})
+		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+		_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+
+		// update template with inactivity ttl
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		lockedWorkspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
+		_ = coderdtest.AwaitWorkspaceBuildJob(t, client, lockedWorkspace.LatestBuild.ID)
+
+		// Create another workspace to validate that we do not return unlocked workspaces.
+		_ = coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
+		_ = coderdtest.AwaitWorkspaceBuildJob(t, client, lockedWorkspace.LatestBuild.ID)
+
+		err := client.UpdateWorkspaceLock(ctx, lockedWorkspace.ID, codersdk.UpdateWorkspaceLock{
+			Lock: true,
+		})
+		require.NoError(t, err)
+
+		res, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{
+			FilterQuery: fmt.Sprintf("locked_at:%s", time.Now().Add(-time.Minute).Format("2006-01-02")),
+		})
+		require.NoError(t, err)
+		require.Len(t, res.Workspaces, 1)
+		require.NotNil(t, res.Workspaces[0].LockedAt)
+	})
 }
 
 func TestOffsetLimit(t *testing.T) {

diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -554,6 +554,21 @@ export const cancelWorkspaceBuild = async (
   return response.data
 }
 
+export const updateWorkspaceLock = async (
+  workspaceId: string,
+  lock: boolean,
+): Promise<Types.Message> => {
+  const data: TypesGen.UpdateWorkspaceLock = {
+    lock: lock,
+  }
+
+  const response = await axios.put(
+    `/api/v2/workspaces/${workspaceId}/lock`,
+    data,
+  )
+  return response.data
+}
+
 export const restartWorkspace = async ({
   workspace,
   buildParameters,

diff --git a/site/src/components/Workspace/Workspace.tsx b/site/src/components/Workspace/Workspace.tsx
@@ -1,5 +1,6 @@
 import Button from "@mui/material/Button"
 import { makeStyles } from "@mui/styles"
+import LockIcon from "@mui/icons-material/Lock"
 import { Avatar } from "components/Avatar/Avatar"
 import { AgentRow } from "components/Resources/AgentRow"
 import {
@@ -26,7 +27,7 @@ import {
 } from "components/PageHeader/FullWidthPageHeader"
 import { TemplateVersionWarnings } from "components/TemplateVersionWarnings/TemplateVersionWarnings"
 import { ErrorAlert } from "components/Alert/ErrorAlert"
-import { ImpendingDeletionBanner } from "components/WorkspaceDeletion"
+import { LockedWorkspaceBanner } from "components/WorkspaceDeletion"
 import { useLocalStorage } from "hooks"
 import { ChooseOne, Cond } from "components/Conditionals/ChooseOne"
 import AlertTitle from "@mui/material/AlertTitle"
@@ -53,6 +54,7 @@ export interface WorkspaceProps {
   handleCancel: () => void
   handleSettings: () => void
   handleChangeVersion: () => void
+  handleUnlock: () => void
   isUpdating: boolean
   isRestarting: boolean
   workspace: TypesGen.Workspace
@@ -86,6 +88,7 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
   handleCancel,
   handleSettings,
   handleChangeVersion,
+  handleUnlock,
   workspace,
   isUpdating,
   isRestarting,
@@ -167,14 +170,19 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
     <>
       <FullWidthPageHeader>
         <Stack direction="row" spacing={3} alignItems="center">
-          <Avatar
-            size="md"
-            src={workspace.template_icon}
-            variant={workspace.template_icon ? "square" : undefined}
-            fitImage={Boolean(workspace.template_icon)}
-          >
-            {workspace.name}
-          </Avatar>
+          {workspace.locked_at ? (
+            <LockIcon fontSize="large" color="error" />
+          ) : (
+            <Avatar
+              size="md"
+              src={workspace.template_icon}
+              variant={workspace.template_icon ? "square" : undefined}
+              fitImage={Boolean(workspace.template_icon)}
+            >
+              {workspace.name}
+            </Avatar>
+          )}
+
           <div>
             <PageHeaderTitle>{workspace.name}</PageHeaderTitle>
             <PageHeaderSubtitle>{workspace.owner_name}</PageHeaderSubtitle>
@@ -203,6 +211,7 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
             handleCancel={handleCancel}
             handleSettings={handleSettings}
             handleChangeVersion={handleChangeVersion}
+            handleUnlock={handleUnlock}
             canChangeVersions={canChangeVersions}
             isUpdating={isUpdating}
             isRestarting={isRestarting}
@@ -240,8 +249,8 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
             </Cond>
             <Cond>
               {/* <ImpendingDeletionBanner/> determines its own visibility */}
-              <ImpendingDeletionBanner
-                workspace={workspace}
+              <LockedWorkspaceBanner
+                workspaces={[workspace]}
                 shouldRedisplayBanner={
                   getLocal("dismissedWorkspace") !== workspace.id
                 }

diff --git a/site/src/components/WorkspaceActions/Buttons.tsx b/site/src/components/WorkspaceActions/Buttons.tsx
@@ -3,6 +3,7 @@ import BlockIcon from "@mui/icons-material/Block"
 import CloudQueueIcon from "@mui/icons-material/CloudQueue"
 import CropSquareIcon from "@mui/icons-material/CropSquare"
 import PlayCircleOutlineIcon from "@mui/icons-material/PlayCircleOutline"
+import LockOpenIcon from "@mui/icons-material/LockOpen"
 import ReplayIcon from "@mui/icons-material/Replay"
 import { LoadingButton } from "components/LoadingButton/LoadingButton"
 import { FC } from "react"
@@ -34,6 +35,23 @@ export const UpdateButton: FC<WorkspaceAction> = ({
   )
 }
 
+export const UnlockButton: FC<WorkspaceAction> = ({
+  handleAction,
+  loading,
+}) => {
+  return (
+    <LoadingButton
+      loading={loading}
+      loadingIndicator="Unlocking..."
+      loadingPosition="start"
+      startIcon={<LockOpenIcon />}
+      onClick={handleAction}
+    >
+      Unlock
+    </LoadingButton>
+  )
+}
+
 export const StartButton: FC<
   Omit<WorkspaceAction, "handleAction"> & {
     workspace: Workspace

diff --git a/site/src/components/WorkspaceActions/WorkspaceActions.tsx b/site/src/components/WorkspaceActions/WorkspaceActions.tsx
@@ -3,7 +3,11 @@ import Menu from "@mui/material/Menu"
 import { makeStyles } from "@mui/styles"
 import MoreVertOutlined from "@mui/icons-material/MoreVertOutlined"
 import { FC, Fragment, ReactNode, useRef, useState } from "react"
-import { Workspace, WorkspaceBuildParameter } from "api/typesGenerated"
+import {
+  Workspace,
+  WorkspaceStatus,
+  WorkspaceBuildParameter,
+} from "api/typesGenerated"
 import {
   ActionLoadingButton,
   CancelButton,
@@ -12,6 +16,7 @@ import {
   StopButton,
   RestartButton,
   UpdateButton,
+  UnlockButton,
 } from "./Buttons"
 import {
   ButtonMapping,
@@ -33,6 +38,7 @@ export interface WorkspaceActionsProps {
   handleCancel: () => void
   handleSettings: () => void
   handleChangeVersion: () => void
+  handleUnlock: () => void
   isUpdating: boolean
   isRestarting: boolean
   children?: ReactNode
@@ -49,6 +55,7 @@ export const WorkspaceActions: FC<WorkspaceActionsProps> = ({
   handleCancel,
   handleSettings,
   handleChangeVersion,
+  handleUnlock,
   isUpdating,
   isRestarting,
   canChangeVersions,
@@ -93,6 +100,10 @@ export const WorkspaceActions: FC<WorkspaceActionsProps> = ({
     [ButtonTypesEnum.canceling]: <DisabledButton label="Canceling..." />,
     [ButtonTypesEnum.deleted]: <DisabledButton label="Deleted" />,
     [ButtonTypesEnum.pending]: <ActionLoadingButton label="Pending..." />,
+    [ButtonTypesEnum.unlock]: <UnlockButton handleAction={handleUnlock} />,
+    [ButtonTypesEnum.unlocking]: (
+      <UnlockButton loading handleAction={handleUnlock} />
+    ),
   }
 
   // Returns a function that will execute the action and close the menu

diff --git a/site/src/components/WorkspaceActions/constants.ts b/site/src/components/WorkspaceActions/constants.ts
@@ -1,4 +1,4 @@
-import { WorkspaceStatus } from "api/typesGenerated"
+import { Workspace, WorkspaceStatus } from "api/typesGenerated"
 import { ReactNode } from "react"
 
 // the button types we have
@@ -12,6 +12,8 @@ export enum ButtonTypesEnum {
   deleting = "deleting",
   update = "update",
   updating = "updating",
+  unlock = "lock",
+  unlocking = "unlocking",
   // disabled buttons
   canceling = "canceling",
   deleted = "deleted",
@@ -29,8 +31,16 @@ interface WorkspaceAbilities {
 }
 
 export const actionsByWorkspaceStatus = (
+  workspace: Workspace,
   status: WorkspaceStatus,
 ): WorkspaceAbilities => {
+  if (workspace.locked_at) {
+    return {
+      actions: [ButtonTypesEnum.unlock],
+      canCancel: false,
+      canAcceptJobs: false,
+    }
+  }
   return statusToActions[status]
 }
 

diff --git a/site/src/components/WorkspaceDeletion/ImpendingDeletionBadge.tsx b/site/src/components/WorkspaceDeletion/ImpendingDeletionBadge.tsx
@@ -1,10 +1,10 @@
 import { Workspace } from "api/typesGenerated"
-import { displayImpendingDeletion } from "./utils"
+import { displayLockedWorkspace } from "./utils"
 import { useDashboard } from "components/Dashboard/DashboardProvider"
 import { Pill } from "components/Pill/Pill"
-import ErrorIcon from "@mui/icons-material/ErrorOutline"
+import LockIcon from "@mui/icons-material/Lock"
 
-export const ImpendingDeletionBadge = ({
+export const LockedBadge = ({
   workspace,
 }: {
   workspace: Workspace
@@ -18,7 +18,7 @@ export const ImpendingDeletionBadge = ({
   // return null
 
   if (
-    !displayImpendingDeletion(
+    !displayLockedWorkspace(
       workspace,
       allowAdvancedScheduling,
       allowWorkspaceActions,
@@ -27,5 +27,5 @@ export const ImpendingDeletionBadge = ({
     return null
   }
 
-  return <Pill icon={<ErrorIcon />} text="Impending deletion" type="error" />
+  return <Pill icon={<LockIcon />} text="Locked" type="error" />
 }