feat: add VS code notifications for workspace actions

package.json

@@ -232,6 +232,7 @@
   },
   "dependencies": {
     "axios": "0.26.1",
+    "date-fns": "^2.30.0",
     "eventsource": "^2.0.2",
     "find-process": "^1.4.7",
     "fs-extra": "^11.1.0",
@@ -246,4 +247,4 @@
     "yaml": "^1.10.0",
     "zod": "^3.21.4"
   }
-}
+}

src/WorkspaceAction.ts

@@ -0,0 +1,173 @@
+import axios from "axios"
+import { getWorkspaces } from "coder/site/src/api/api"
+import { Workspace, WorkspacesResponse, WorkspaceBuild } from "coder/site/src/api/typesGenerated"
+import { formatDistanceToNowStrict } from "date-fns"
+import * as vscode from "vscode"
+import { Storage } from "./storage"
+
+interface NotifiedWorkspace {
+  workspace: Workspace
+  wasNotified: boolean
+  impendingActionDeadline: string
+}
+
+type WithRequired<T, K extends keyof T> = T & Required<Pick<T, K>>
+
+type WorkspaceWithDeadline = Workspace & { latest_build: WithRequired<WorkspaceBuild, "deadline"> }
+type WorkspaceWithDeletingAt = Workspace & WithRequired<Workspace, "deleting_at">
+
+export class WorkspaceAction {
+  // We use this same interval in the Dashboard to poll for updates on the Workspaces page.
+  #POLL_INTERVAL: number = 1000 * 5
+  #fetchWorkspacesInterval?: ReturnType<typeof setInterval>
+
+  #ownedWorkspaces: Workspace[] = []
+  #workspacesApproachingAutostop: NotifiedWorkspace[] = []
+  #workspacesApproachingDeletion: NotifiedWorkspace[] = []
+
+  private constructor(
+    private readonly vscodeProposed: typeof vscode,
+    private readonly storage: Storage,
+    ownedWorkspaces: Workspace[],
+  ) {
+    this.#ownedWorkspaces = ownedWorkspaces
+
+    // seed initial lists
+    this.updateNotificationLists()
+
+    this.notifyAll()
+
+    // set up polling so we get current workspaces data
+    this.pollGetWorkspaces()
+  }
+
+  static async init(vscodeProposed: typeof vscode, storage: Storage) {
+    // fetch all workspaces owned by the user and set initial public class fields
+    let ownedWorkspacesResponse: WorkspacesResponse
+    try {
+      ownedWorkspacesResponse = await getWorkspaces({ q: "owner:me" })
+    } catch (error) {
+      if (!axios.isAxiosError(error) || error.response?.status !== 401) {
+        storage.writeToCoderOutputChannel(
+          `Failed to fetch owned workspaces. Some workspace notifications may be missing: ${error}`,
+        )
+      }
+
+      ownedWorkspacesResponse = { workspaces: [], count: 0 }
+    }
+    return new WorkspaceAction(vscodeProposed, storage, ownedWorkspacesResponse.workspaces)
+  }
+
+  updateNotificationLists() {
+    this.#workspacesApproachingAutostop = this.#ownedWorkspaces
+      .filter(this.filterWorkspacesImpendingAutostop)
+      .map((workspace) =>
+        this.transformWorkspaceObjects(workspace, this.#workspacesApproachingAutostop, workspace.latest_build.deadline),
+      )
+
+    this.#workspacesApproachingDeletion = this.#ownedWorkspaces
+      .filter(this.filterWorkspacesImpendingDeletion)
+      .map((workspace) =>
+        this.transformWorkspaceObjects(workspace, this.#workspacesApproachingDeletion, workspace.deleting_at),
+      )
+  }
+
+  filterWorkspacesImpendingAutostop(workspace: Workspace): workspace is WorkspaceWithDeadline {
+    // a workspace is eligible for autostop if the last build was successful,
+    // and the workspace is started,
+    // and it has a deadline
+    if (
+      workspace.latest_build.job.status !== "succeeded" ||
+      workspace.latest_build.transition !== "start" ||
+      !workspace.latest_build.deadline
+    ) {
+      return false
+    }
+
+    const hourMilli = 1000 * 60 * 60
+    // return workspaces with a deadline that is in 1 hr or less
+    return Math.abs(new Date().getTime() - new Date(workspace.latest_build.deadline).getTime()) <= hourMilli
+  }
+
+  filterWorkspacesImpendingDeletion(workspace: Workspace): workspace is WorkspaceWithDeletingAt {
+    if (!workspace.deleting_at) {
+      return false
+    }
+
+    const dayMilli = 1000 * 60 * 60 * 24
+
+    // return workspaces with a deleting_at that is 24 hrs or less
+    return Math.abs(new Date().getTime() - new Date(workspace.deleting_at).getTime()) <= dayMilli
+  }
+
+  transformWorkspaceObjects(workspace: Workspace, workspaceList: NotifiedWorkspace[], deadlineField: string) {
+    const wasNotified = workspaceList.find((nw) => nw.workspace.id === workspace.id)?.wasNotified ?? false
+    const impendingActionDeadline = formatDistanceToNowStrict(new Date(deadlineField))
+    return { workspace, wasNotified, impendingActionDeadline }
+  }
+
+  async pollGetWorkspaces() {
+    let errorCount = 0
+    this.#fetchWorkspacesInterval = setInterval(async () => {
+      try {
+        const workspacesResult = await getWorkspaces({ q: "owner:me" })
+        this.#ownedWorkspaces = workspacesResult.workspaces
+        this.updateNotificationLists()
+        this.notifyAll()
+      } catch (error) {
+        errorCount++
+        if (!axios.isAxiosError(error) || error.response?.status !== 401) {
+          this.storage.writeToCoderOutputChannel(
+            `Failed to poll owned workspaces. Some workspace notifications may be missing: ${error}`,
+          )
+        }
+        if (errorCount === 3) {
+          clearInterval(this.#fetchWorkspacesInterval)
+        }
+      }
+    }, this.#POLL_INTERVAL)
+  }
+
+  notifyAll() {
+    this.notifyImpendingAutostop()
+    this.notifyImpendingDeletion()
+  }
+
+  notifyImpendingAutostop() {
+    this.#workspacesApproachingAutostop?.forEach((notifiedWorkspace: NotifiedWorkspace) => {
+      if (notifiedWorkspace.wasNotified) {
+        // don't message the user; we've already messaged
+        return
+      }
+
+      // we display individual notifications for each workspace as VS Code
+      // intentionally strips new lines from the message text
+      // https://github.com/Microsoft/vscode/issues/48900
+      this.vscodeProposed.window.showInformationMessage(
+        `${notifiedWorkspace.workspace.name} is scheduled to shut down in ${notifiedWorkspace.impendingActionDeadline}.`,
+      )
+      notifiedWorkspace.wasNotified = true
+    })
+  }
+
+  notifyImpendingDeletion() {
+    this.#workspacesApproachingDeletion?.forEach((notifiedWorkspace: NotifiedWorkspace) => {
+      if (notifiedWorkspace.wasNotified) {
+        // don't message the user; we've already messaged
+        return
+      }
+
+      // we display individual notifications for each workspace as VS Code
+      // intentionally strips new lines from the message text
+      // https://github.com/Microsoft/vscode/issues/48900
+      this.vscodeProposed.window.showInformationMessage(
+        `${notifiedWorkspace.workspace.name} is scheduled for deletion in ${notifiedWorkspace.impendingActionDeadline}.`,
+      )
+      notifiedWorkspace.wasNotified = true
+    })
+  }
+
+  cleanupWorkspaceActions() {
+    clearInterval(this.#fetchWorkspacesInterval)
+  }
+}

src/remote.ts

@@ -19,6 +19,7 @@ import prettyBytes from "pretty-bytes"
 import * as semver from "semver"
 import * as vscode from "vscode"
 import * as ws from "ws"
+import { WorkspaceAction } from "./WorkspaceAction"
 import { SSHConfig, SSHValues, defaultSSHConfigResponse, mergeSSHConfigValues } from "./sshConfig"
 import { computeSSHProperties, sshSupportsSetEnv } from "./sshSupport"
 import { Storage } from "./storage"
@@ -126,6 +127,9 @@ export class Remote {
       this.registerLabelFormatter(remoteAuthority, this.storage.workspace.owner_name, this.storage.workspace.name),
     )
 
+    // Initialize any WorkspaceAction notifications (auto-off, upcoming deletion)
+    const action = await WorkspaceAction.init(this.vscodeProposed, this.storage)
+
     let buildComplete: undefined | (() => void)
     if (this.storage.workspace.latest_build.status === "stopped") {
       this.vscodeProposed.window.withProgress(
@@ -427,6 +431,7 @@ export class Remote {
     return {
       dispose: () => {
         eventSource.close()
+        action.cleanupWorkspaceActions()
         disposables.forEach((d) => d.dispose())
       },
     }

src/storage.ts

@@ -298,6 +298,11 @@ export class Storage {
     })
   }
 
+  public writeToCoderOutputChannel(message: string) {
+    this.output.appendLine(message)
+    this.output.show(true)
+  }
+
   private async updateURL(): Promise<void> {
     const url = this.getURL()
     axios.defaults.baseURL = url

yarn.lock

@@ -163,6 +163,13 @@
   resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.20.13.tgz#ddf1eb5a813588d2fb1692b70c6fce75b945c088"
   integrity sha512-gFDLKMfpiXCsjt4za2JA9oTMn70CeseCehb11kRZgvd7+F67Hih3OHOK24cRrWECJ/ljfPGac6ygXAs/C8kIvw==
 
+"@babel/runtime@^7.21.0":
+  version "7.22.5"
+  resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.22.5.tgz#8564dd588182ce0047d55d7a75e93921107b57ec"
+  integrity sha512-ecjvYlnAaZ/KVneE/OdKYBYfgXV3Ptu6zQWmgEF7vwKhQnvVS6bjMD2XYgj+SNvQ1GfK/pjgokfPkC/2CO8CuA==
+  dependencies:
+    regenerator-runtime "^0.13.11"
+
 "@babel/template@^7.18.10", "@babel/template@^7.20.7":
   version "7.20.7"
   resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.20.7.tgz#a15090c2839a83b02aa996c0b4994005841fd5a8"
@@ -1418,7 +1425,7 @@ [email protected]:
 
 "coder@https://github.com/coder/coder":
   version "0.0.0"
-  resolved "https://github.com/coder/coder#a6fa8cac582f2fc54eca0191bd54fd43d6d67ac2"
+  resolved "https://github.com/coder/coder#5d48122f12ddec2f5a34bf8d0a7d2dc4dd94b0d3"
 
 collapse-white-space@^1.0.2:
   version "1.0.6"
@@ -1530,6 +1537,13 @@ css-what@^6.1.0:
   resolved "https://registry.yarnpkg.com/css-what/-/css-what-6.1.0.tgz#fb5effcf76f1ddea2c81bdfaa4de44e79bac70f4"
   integrity sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==
 
+date-fns@^2.30.0:
+  version "2.30.0"
+  resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-2.30.0.tgz#f367e644839ff57894ec6ac480de40cae4b0f4d0"
+  integrity sha512-fnULvOpxnC5/Vg3NCiWelDsLiUc9bRwAPs/+LfTLNvetFCtCTN+yQz15C/fs4AwX1R9K5GLtLfn8QW+dWisaAw==
+  dependencies:
+    "@babel/runtime" "^7.21.0"
+
 dayjs@^1.11.7:
   version "1.11.7"
   resolved "https://registry.yarnpkg.com/dayjs/-/dayjs-1.11.7.tgz#4b296922642f70999544d1144a2c25730fce63e2"
@@ -3887,6 +3901,11 @@ rechoir@^0.8.0:
   dependencies:
     resolve "^1.20.0"
 
+regenerator-runtime@^0.13.11:
+  version "0.13.11"
+  resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.13.11.tgz#f6dca3e7ceec20590d07ada785636a90cdca17f9"
+  integrity sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg==
+
 regexp.prototype.flags@^1.4.3:
   version "1.4.3"
   resolved "https://registry.yarnpkg.com/regexp.prototype.flags/-/regexp.prototype.flags-1.4.3.tgz#87cab30f80f66660181a3bb7bf5981a872b367ac"