refactor: isWorkspaceOn utility

greyscaled · greyscaled · commit a72b18798021 · 2022-05-31T15:08:50.000Z
Summary:

A utility is function is added that answers the question if a workspace
is on.

Impact:

This is a shared piece of logic in workspace scheduling presentations.
In particular it unblocks work in 1779, or at least allows an
implementation that shares details with the WorkspaceScheduleBanner.

Notes:

We could possibly instead return whether the workspace is "ON",
"UNKNOWN", or "OFF". Maybe a future improvement for that could be made
as the neds arrises.
diff --git a/site/src/components/WorkspaceScheduleBanner/WorkspaceScheduleBanner.test.tsx b/site/src/components/WorkspaceScheduleBanner/WorkspaceScheduleBanner.test.tsx
@@ -91,7 +91,6 @@ describe("WorkspaceScheduleBanner", () => {
         latest_build: {
           ...Mocks.MockWorkspaceBuild,
           deadline: dayjs().add(27, "minutes").utc().format(),
-          job: Mocks.MockRunningProvisionerJob,
           transition: "start",
         },
       }
diff --git a/site/src/components/WorkspaceScheduleBanner/WorkspaceScheduleBanner.tsx b/site/src/components/WorkspaceScheduleBanner/WorkspaceScheduleBanner.tsx
@@ -5,6 +5,7 @@ import isSameOrBefore from "dayjs/plugin/isSameOrBefore"
 import utc from "dayjs/plugin/utc"
 import { FC } from "react"
 import * as TypesGen from "../../api/typesGenerated"
+import { isWorkspaceOn } from "../../util/workspace"
 
 dayjs.extend(utc)
 dayjs.extend(isSameOrBefore)
@@ -18,12 +19,7 @@ export interface WorkspaceScheduleBannerProps {
 }
 
 export const shouldDisplay = (workspace: TypesGen.Workspace): boolean => {
-  const transition = workspace.latest_build.transition
-  const status = workspace.latest_build.job.status
-
-  if (transition !== "start") {
-    return false
-  } else if (status === "canceled" || status === "canceling" || status === "failed") {
+  if (!isWorkspaceOn(workspace)) {
     return false
   } else {
     // a mannual shutdown has a deadline of '"0001-01-01T00:00:00Z"'
diff --git a/site/src/util/workspace.test.ts b/site/src/util/workspace.test.ts
@@ -0,0 +1,43 @@
+import * as TypesGen from "../api/typesGenerated"
+import * as Mocks from "../testHelpers/entities"
+import { isWorkspaceOn } from "./workspace"
+
+describe("util > workspace", () => {
+  describe("isWorkspaceOn", () => {
+    it.each<[TypesGen.WorkspaceTransition, TypesGen.ProvisionerJobStatus, boolean]>([
+      ["delete", "canceled", false],
+      ["delete", "canceling", false],
+      ["delete", "failed", false],
+      ["delete", "pending", false],
+      ["delete", "running", false],
+      ["delete", "succeeded", false],
+
+      ["stop", "canceled", false],
+      ["stop", "canceling", false],
+      ["stop", "failed", false],
+      ["stop", "pending", false],
+      ["stop", "running", false],
+      ["stop", "succeeded", false],
+
+      ["start", "canceled", false],
+      ["start", "canceling", false],
+      ["start", "failed", false],
+      ["start", "pending", false],
+      ["start", "running", false],
+      ["start", "succeeded", true],
+    ])(`transition=%p, status=%p, isWorkspaceOn=%p`, (transition, status, isOn) => {
+      const workspace: TypesGen.Workspace = {
+        ...Mocks.MockWorkspace,
+        latest_build: {
+          ...Mocks.MockWorkspaceBuild,
+          job: {
+            ...Mocks.MockProvisionerJob,
+            status,
+          },
+          transition,
+        },
+      }
+      expect(isWorkspaceOn(workspace)).toBe(isOn)
+    })
+  })
+})
diff --git a/site/src/util/workspace.ts b/site/src/util/workspace.ts
@@ -1,7 +1,7 @@
 import { Theme } from "@material-ui/core/styles"
 import dayjs from "dayjs"
 import { WorkspaceBuildTransition } from "../api/types"
-import { WorkspaceAgent, WorkspaceBuild } from "../api/typesGenerated"
+import { Workspace, WorkspaceAgent, WorkspaceBuild } from "../api/typesGenerated"
 
 export type WorkspaceStatus =
   | "queued"
@@ -185,3 +185,9 @@ export const getDisplayAgentStatus = (
       }
   }
 }
+
+export const isWorkspaceOn = (workspace: Workspace): boolean => {
+  const transition = workspace.latest_build.transition
+  const status = workspace.latest_build.job.status
+  return transition === "start" && status === "succeeded"
+}

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,6 @@ describe("WorkspaceScheduleBanner", () => {`
`91`	`91`	`latest_build: {`
`92`	`92`	`...Mocks.MockWorkspaceBuild,`
`93`	`93`	`deadline: dayjs().add(27, "minutes").utc().format(),`
`94`		`- job: Mocks.MockRunningProvisionerJob,`
`95`	`94`	`transition: "start",`
`96`	`95`	`},`
`97`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`import { Theme } from "@material-ui/core/styles"`
`2`	`2`	`import dayjs from "dayjs"`
`3`	`3`	`import { WorkspaceBuildTransition } from "../api/types"`
`4`		`-import { WorkspaceAgent, WorkspaceBuild } from "../api/typesGenerated"`
	`4`	`+import { Workspace, WorkspaceAgent, WorkspaceBuild } from "../api/typesGenerated"`
`5`	`5`
`6`	`6`	`export type WorkspaceStatus =`
`7`	`7`	`\| "queued"`
`@@ -185,3 +185,9 @@ export const getDisplayAgentStatus = (`
`185`	`185`	`}`
`186`	`186`	`}`
`187`	`187`	`}`
	`188`	`+`
	`189`	`+export const isWorkspaceOn = (workspace: Workspace): boolean => {`
	`190`	`+ const transition = workspace.latest_build.transition`
	`191`	`+ const status = workspace.latest_build.job.status`
	`192`	`+ return transition === "start" && status === "succeeded"`
	`193`	`+}`