coder · BrunoQuaresma · Mar 14, 2023 · Mar 8, 2023 · Mar 8, 2023 · Mar 9, 2023
diff --git a/site/src/api/api.test.ts b/site/src/api/api.test.ts
@@ -1,5 +1,11 @@
 import axios from "axios"
-import { getApiKey, getURLWithSearchParams, login, logout } from "./api"
+import {
+  MockTemplate,
+  MockTemplateVersionParameter1,
+  MockWorkspace,
+  MockWorkspaceBuild,
+} from "testHelpers/entities"
+import * as api from "./api"
 import * as TypesGen from "./typesGenerated"
 
 describe("api.ts", () => {
@@ -12,7 +18,7 @@ describe("api.ts", () => {
       jest.spyOn(axios, "post").mockResolvedValueOnce({ data: loginResponse })
 
       // when
-      const result = await login("test", "123")
+      const result = await api.login("test", "123")
 
       // then
       expect(axios.post).toHaveBeenCalled()
@@ -33,7 +39,7 @@ describe("api.ts", () => {
       axios.post = axiosMockPost
 
       try {
-        await login("test", "123")
+        await api.login("test", "123")
       } catch (error) {
         expect(error).toStrictEqual(expectedError)
       }
@@ -49,7 +55,7 @@ describe("api.ts", () => {
       axios.post = axiosMockPost
 
       // when
-      await logout()
+      await api.logout()
 
       // then
       expect(axiosMockPost).toHaveBeenCalled()
@@ -68,7 +74,7 @@ describe("api.ts", () => {
       axios.post = axiosMockPost
 
       try {
-        await logout()
+        await api.logout()
       } catch (error) {
         expect(error).toStrictEqual(expectedError)
       }
@@ -87,7 +93,7 @@ describe("api.ts", () => {
       axios.post = axiosMockPost
 
       // when
-      const result = await getApiKey()
+      const result = await api.getApiKey()
 
       // then
       expect(axiosMockPost).toHaveBeenCalled()
@@ -107,7 +113,7 @@ describe("api.ts", () => {
       axios.post = axiosMockPost
 
       try {
-        await getApiKey()
+        await api.getApiKey()
       } catch (error) {
         expect(error).toStrictEqual(expectedError)
       }
@@ -133,7 +139,7 @@ describe("api.ts", () => {
     ])(
       `Workspaces - getURLWithSearchParams(%p, %p) returns %p`,
       (basePath, filter, expected) => {
-        expect(getURLWithSearchParams(basePath, filter)).toBe(expected)
+        expect(api.getURLWithSearchParams(basePath, filter)).toBe(expected)
       },
     )
   })
@@ -150,8 +156,38 @@ describe("api.ts", () => {
     ])(
       `Users - getURLWithSearchParams(%p, %p) returns %p`,
       (basePath, filter, expected) => {
-        expect(getURLWithSearchParams(basePath, filter)).toBe(expected)
+        expect(api.getURLWithSearchParams(basePath, filter)).toBe(expected)
       },
     )
   })
+
+  describe("update", () => {
+    it("creates a build with start and the latest template", async () => {
+      jest
+        .spyOn(api, "postWorkspaceBuild")
+        .mockResolvedValueOnce(MockWorkspaceBuild)
+      jest.spyOn(api, "getTemplate").mockResolvedValueOnce(MockTemplate)
+      await api.updateWorkspace(MockWorkspace)
+      expect(api.postWorkspaceBuild).toHaveBeenCalledWith(MockWorkspace.id, {
+        transition: "start",
+        template_version_id: MockTemplate.active_version_id,
+        rich_parameter_values: [],
+      })
+    })
+
+    it("fails when having missing parameters", async () => {
+      jest
+        .spyOn(api, "postWorkspaceBuild")
+        .mockResolvedValueOnce(MockWorkspaceBuild)
+      jest.spyOn(api, "getTemplate").mockResolvedValueOnce(MockTemplate)
+      jest.spyOn(api, "getWorkspaceBuildParameters").mockResolvedValueOnce([])
+      jest
+        .spyOn(api, "getTemplateVersionRichParameters")
+        .mockResolvedValueOnce([MockTemplateVersionParameter1])
+
+      await expect(api.updateWorkspace(MockWorkspace)).rejects.toThrow(
+        api.MissingBuildParameters,
+      )
+    })
+  })
 })
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -897,3 +897,82 @@ export const getWorkspaceBuildParameters = async (
   )
   return response.data
 }
+
+export class MissingBuildParameters extends Error {
+  parameters: TypesGen.TemplateVersionParameter[] = []
+
+  constructor(parameters: TypesGen.TemplateVersionParameter[]) {
+    super("Missing build parameters.")
+    this.parameters = parameters
+  }
+}
+
+/** Steps to update the workspace
+ * - Get the latest template to access the latest active version
+ * - Get the current build parameters
+ * - Get the template parameters
+ * - Update the build parameters and check if there are missed parameters for the newest version
+ *   - If there are missing parameters raise an error
+ * - Create a build with the latest version and updated build parameters
+ */
+export const updateWorkspace = async (
+  workspace: TypesGen.Workspace,
+  newBuildParameters: TypesGen.WorkspaceBuildParameter[] = [],
+): Promise<TypesGen.WorkspaceBuild> => {
+  const [template, oldBuildParameters] = await Promise.all([
+    getTemplate(workspace.template_id),
+    getWorkspaceBuildParameters(workspace.latest_build.id),
+  ])
+  const activeVersionId = template.active_version_id
+  const templateParameters = await getTemplateVersionRichParameters(
+    activeVersionId,
+  )
+  const [updatedBuildParameters, missingParameters] = updateBuildParameters(
+    oldBuildParameters,
+    newBuildParameters,
+    templateParameters,
+  )
+  if (missingParameters.length > 0) {
+    throw new MissingBuildParameters(missingParameters)
+  }
+
+  return postWorkspaceBuild(workspace.id, {
+    transition: "start",
+    template_version_id: activeVersionId,
+    rich_parameter_values: updatedBuildParameters,
+  })
+}
+
+const updateBuildParameters = (
+  oldBuildParameters: TypesGen.WorkspaceBuildParameter[],
+  newBuildParameters: TypesGen.WorkspaceBuildParameter[],
+  templateParameters: TypesGen.TemplateVersionParameter[],
+) => {
+  const missingParameters: TypesGen.TemplateVersionParameter[] = []
+  const updatedBuildParameters: TypesGen.WorkspaceBuildParameter[] = []
+
+  for (const parameter of templateParameters) {
+    // Check if there is a new value
+    let buildParameter = newBuildParameters.find(
+      (p) => p.name === parameter.name,
+    )
+
+    // If not, get the old one
+    if (!buildParameter) {
+      buildParameter = oldBuildParameters.find((p) => p.name === parameter.name)
+    }
+
+    // If there is a value from the new or old one, add it to the list
+    if (buildParameter) {
+      updatedBuildParameters.push(buildParameter)
+      continue
+    }
+
+    // If there is no value and it is required, add it to the list of missing parameters
+    if (parameter.required) {
+      missingParameters.push(parameter)
+    }
+  }
+
+  return [updatedBuildParameters, missingParameters] as const
+}
diff --git a/...ponents/HorizontalForm/HorizontalForm.tsx → site/src/components/Form/Form.tsx b/...ponents/HorizontalForm/HorizontalForm.tsx → site/src/components/Form/Form.tsx
@@ -4,36 +4,84 @@ import {
   FormFooter as BaseFormFooter,
 } from "components/FormFooter/FormFooter"
 import { Stack } from "components/Stack/Stack"
-import { FC, HTMLProps, PropsWithChildren } from "react"
+import {
+  createContext,
+  FC,
+  HTMLProps,
+  PropsWithChildren,
+  useContext,
+} from "react"
 import { combineClasses } from "util/combineClasses"
 
-export const HorizontalForm: FC<
-  PropsWithChildren & HTMLProps<HTMLFormElement>
-> = ({ children, ...formProps }) => {
+type FormContextValue = { direction?: "horizontal" | "vertical" }
+
+const FormContext = createContext<FormContextValue>({
+  direction: "horizontal",
+})
+
+type FormProps = HTMLProps<HTMLFormElement> & {
+  direction?: FormContextValue["direction"]
+}
+
+export const Form: FC<FormProps> = ({ direction, className, ...formProps }) => {
   const styles = useStyles()
 
   return (
-    <form {...formProps}>
-      <Stack direction="column" spacing={10} className={styles.formSections}>
-        {children}
-      </Stack>
-    </form>
+    <FormContext.Provider value={{ direction }}>
+      <form
+        {...formProps}
+        className={combineClasses([styles.form, className])}
+      />
+    </FormContext.Provider>
+  )
+}
+
+export const HorizontalForm: FC<HTMLProps<HTMLFormElement>> = ({
+  children,
+  ...formProps
+}) => {
+  return (
+    <Form direction="horizontal" {...formProps}>
+      {children}
+    </Form>
+  )
+}
+
+export const VerticalForm: FC<HTMLProps<HTMLFormElement>> = ({
+  children,
+  ...formProps
+}) => {
+  return (
+    <Form direction="vertical" {...formProps}>
+      {children}
+    </Form>
   )
 }
 
 export const FormSection: FC<
   PropsWithChildren & {
-    title: string
+    title: string | JSX.Element
     description: string | JSX.Element
-    className?: string
+    classes?: {
+      root?: string
+      infoTitle?: string
+    }
   }
-> = ({ children, title, description, className }) => {
-  const styles = useStyles()
+> = ({ children, title, description, classes = {} }) => {
+  const formContext = useContext(FormContext)
+  const styles = useStyles(formContext)
 
   return (
-    <div className={combineClasses([styles.formSection, className])}>
+    <div className={combineClasses([styles.formSection, classes.root])}>
       <div className={styles.formSectionInfo}>
-        <h2 className={styles.formSectionInfoTitle}>{title}</h2>
+        <h2
+          className={combineClasses([
+            styles.formSectionInfoTitle,
+            classes.infoTitle,
+          ])}
+        >
+          {title}
+        </h2>
         <div className={styles.formSectionInfoDescription}>{description}</div>
       </div>
 
@@ -62,7 +110,12 @@ export const FormFooter: FC<BaseFormFooterProps> = (props) => {
 }
 
 const useStyles = makeStyles((theme) => ({
-  formSections: {
+  form: {
+    display: "flex",
+    flexDirection: "column",
+    gap: ({ direction }: FormContextValue = {}) =>
+      direction === "horizontal" ? theme.spacing(10) : theme.spacing(5),
+
     [theme.breakpoints.down("sm")]: {
       gap: theme.spacing(8),
     },
@@ -71,7 +124,10 @@ const useStyles = makeStyles((theme) => ({
   formSection: {
     display: "flex",
     alignItems: "flex-start",
-    gap: theme.spacing(15),
+    gap: ({ direction }: FormContextValue = {}) =>
+      direction === "horizontal" ? theme.spacing(15) : theme.spacing(3),
+    flexDirection: ({ direction }: FormContextValue = {}) =>
+      direction === "horizontal" ? "row" : "column",
 
     [theme.breakpoints.down("sm")]: {
       flexDirection: "column",
@@ -80,9 +136,11 @@ const useStyles = makeStyles((theme) => ({
   },
 
   formSectionInfo: {
-    width: 312,
+    maxWidth: ({ direction }: FormContextValue = {}) =>
+      direction === "horizontal" ? 312 : undefined,
     flexShrink: 0,
-    position: "sticky",
+    position: ({ direction }: FormContextValue = {}) =>
+      direction === "horizontal" ? "sticky" : undefined,
     top: theme.spacing(3),
 
     [theme.breakpoints.down("sm")]: {

diff --git a/site/src/i18n/en/workspacePage.json b/site/src/i18n/en/workspacePage.json
@@ -65,5 +65,8 @@
     "agentVersionLabel": "Agent version",
     "serverVersionLabel": "Server version",
     "updateWorkspaceLabel": "Update workspace"
+  },
+  "askParametersDialog": {
+    "message": "It looks like the new version has new parameters that need to be filled in to update the workspace."
   }
 }
diff --git a/site/src/pages/CreateTemplatePage/CreateTemplateForm.tsx b/site/src/pages/CreateTemplatePage/CreateTemplateForm.tsx
@@ -31,12 +31,12 @@ import { LazyIconField } from "components/IconField/LazyIconField"
 import { Maybe } from "components/Conditionals/Maybe"
 import i18next from "i18next"
 import Link from "@material-ui/core/Link"
-import { FormFooter } from "components/FormFooter/FormFooter"
 import {
   HorizontalForm,
   FormSection,
   FormFields,
-} from "components/HorizontalForm/HorizontalForm"
+  FormFooter,
+} from "components/Form/Form"
 import camelCase from "lodash/camelCase"
 import capitalize from "lodash/capitalize"
 import { VariableInput } from "./VariableInput"