wip(site): Add support for informing of updates

coder · mafredri · Dec 1, 2022 · Oct 31, 2022 · Oct 31, 2022 · Oct 31, 2022
commit c163af8def61e991eb987273217115454d74e595
@@ -376,6 +376,12 @@ export const getBuildInfo = async (): Promise<TypesGen.BuildInfoResponse> => {
   return response.data
 }
 
+export const getUpdateCheck =
+  async (): Promise<TypesGen.UpdateCheckResponse> => {
+    const response = await axios.get("/api/v2/updatecheck")
+    return response.data
+  }
+
 export const putWorkspaceAutostart = async (
   workspaceID: string,
   autostart: TypesGen.UpdateWorkspaceAutostartRequest,

@@ -24,6 +24,12 @@ export const MockBuildInfo: TypesGen.BuildInfoResponse = {
   version: "v99.999.9999+c9cdf14",
 }
 
+export const MockUpdateCheck: TypesGen.UpdateCheckResponse = {
+  current: true,
+  url: "file:///mock-url",
+  version: "v99.999.9999+c9cdf14",
+}
+
 export const MockOwnerRole: TypesGen.Role = {
   name: "owner",
   display_name: "Owner",

@@ -15,6 +15,11 @@ export const handlers = [
     return res(ctx.status(200), ctx.json(M.MockBuildInfo))
   }),
 
+  // update check
+  rest.get("/api/v2/updatecheck", async (req, res, ctx) => {
+    return res(ctx.status(200), ctx.json(M.MockUpdateCheck))
+  }),
+
   // organizations
   rest.get("/api/v2/organizations/:organizationId", async (req, res, ctx) => {
     return res(ctx.status(200), ctx.json(M.MockOrganization))

@@ -3,6 +3,7 @@ import { createContext, FC, ReactNode } from "react"
 import { ActorRefFrom } from "xstate"
 import { authMachine } from "./auth/authXService"
 import { buildInfoMachine } from "./buildInfo/buildInfoXService"
+import { updateCheckMachine } from "./updateCheck/updateCheckXService"
 import { deploymentConfigMachine } from "./deploymentConfig/deploymentConfigMachine"
 import { entitlementsMachine } from "./entitlements/entitlementsXService"
 import { siteRolesMachine } from "./roles/siteRolesXService"
@@ -14,6 +15,7 @@ interface XServiceContextType {
   siteRolesXService: ActorRefFrom<typeof siteRolesMachine>
   // Since the info here is used by multiple deployment settings page and we don't want to refetch them every time
   deploymentConfigXService: ActorRefFrom<typeof deploymentConfigMachine>
+  updateCheckXService: ActorRefFrom<typeof updateCheckMachine>
 }
 
 /**
@@ -35,6 +37,7 @@ export const XServiceProvider: FC<{ children: ReactNode }> = ({ children }) => {
         entitlementsXService: useInterpret(entitlementsMachine),
         siteRolesXService: useInterpret(siteRolesMachine),
         deploymentConfigXService: useInterpret(deploymentConfigMachine),
+        updateCheckXService: useInterpret(updateCheckMachine),
       }}
     >
       {children}

@@ -0,0 +1,103 @@
+import { assign, createMachine } from "xstate"
+import * as API from "../../api/api"
+import * as TypesGen from "../../api/typesGenerated"
+import { displayMsg } from "../../components/GlobalSnackbar/utils"
+
+export const Language = {
+  updateAvailable: "New version available",
+  updateAvailableMessage: (
+    version: string,
+    url: string,
+    upgrade_instructions_url: string,
+  ): string =>
+    `Coder ${version} is now available at ${url}. See ${upgrade_instructions_url} for information on how to upgrade.`,
+}
+
+export interface UpdateCheckContext {
+  getUpdateCheckError?: Error | unknown
+  updateCheck?: TypesGen.UpdateCheckResponse
+}
+
+export const updateCheckMachine = createMachine(
+  {
+    id: "updateCheckState",
+    predictableActionArguments: true,
+    tsTypes: {} as import("./updateCheckXService.typegen").Typegen0,
+    schema: {
+      context: {} as UpdateCheckContext,
+      services: {} as {
+        getUpdateCheck: {
+          data: TypesGen.UpdateCheckResponse
+        }
+      },
+    },
+    context: {
+      updateCheck: undefined,
+    },
+    initial: "gettingUpdateCheck",
+    states: {
+      gettingUpdateCheck: {
+        invoke: {
+          src: "getUpdateCheck",
+          id: "getUpdateCheck",
+          onDone: [
+            {
+              actions: [
+                "assignUpdateCheck",
+                "clearGetUpdateCheckError",
+                "notifyUpdateAvailable",
+              ],
+              target: "#updateCheckState.success",
+            },
+          ],
+          onError: [
+            {
+              actions: ["assignGetUpdateCheckError", "clearUpdateCheck"],
+              target: "#updateCheckState.failure",
+            },
+          ],
+        },
+      },
+      success: {
+        type: "final",
+      },
+      failure: {
+        type: "final",
+      },
+    },
+  },
+  {
+    services: {
+      getUpdateCheck: API.getUpdateCheck,
+    },
+    actions: {
+      assignUpdateCheck: assign({
+        updateCheck: (_, event) => event.data,
+      }),
+      clearUpdateCheck: assign((context: UpdateCheckContext) => ({
+        ...context,
+        updateCheck: undefined,
+      })),
+      assignGetUpdateCheckError: assign({
+        getUpdateCheckError: (_, event) => event.data,
+      }),
+      clearGetUpdateCheckError: assign((context: UpdateCheckContext) => ({
+        ...context,
+        getUpdateCheckError: undefined,
+      })),
+      notifyUpdateAvailable: (context: UpdateCheckContext) => {
+        if (context.updateCheck && !context.updateCheck.current) {
+          // TODO(mafredri): HTML formatting, persistance?
+          displayMsg(
+            Language.updateAvailable,
+            Language.updateAvailableMessage(
+              context.updateCheck.version,
+              context.updateCheck.url,
+              "https://coder.com/docs/coder-oss/latest/admin/upgrade",
+            ),
+          )
+        }
+      },
+    },
+  },
+)