Skip to content

feat(site): add auto mode on create workspace form #8651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Jul 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
a82a189
Add one click workspace
BrunoQuaresma Jul 20, 2023
3a38c03
feat(site): add auto mode on the create workspace form
BrunoQuaresma Jul 21, 2023
f255f37
fix deps
BrunoQuaresma Jul 21, 2023
37e6dd3
fix git auth validation result and callback
BrunoQuaresma Jul 21, 2023
3b82a03
Merge branch 'main' into bq/one-click-workspace
matifali Jul 25, 2023
ed46ee7
Merge branch 'main' into bq/one-click-workspace
BrunoQuaresma Jul 25, 2023
b26b118
Merge branch 'bq/one-click-workspace' of https://github.com/coder/cod…
BrunoQuaresma Jul 25, 2023
3593e0a
Merge branch 'main' into bq/one-click-workspace
matifali Jul 25, 2023
6fcfa13
Merge branch 'main' into bq/one-click-workspace
matifali Jul 25, 2023
0d8b026
Merge branch 'main' into bq/one-click-workspace
matifali Jul 25, 2023
4f440c9
Merge branch 'main' into bq/one-click-workspace
matifali Jul 25, 2023
934c90c
Merge branch 'main' into bq/one-click-workspace
matifali Jul 25, 2023
34135f3
Merge branch 'main' into bq/one-click-workspace
matifali Jul 25, 2023
bfa73bf
Merge branch 'main' into bq/one-click-workspace
matifali Jul 25, 2023
417788b
Merge branch 'main' into bq/one-click-workspace
matifali Jul 26, 2023
2ce8166
Merge branch 'main' into bq/one-click-workspace
matifali Jul 26, 2023
9b87a20
Merge branch 'main' into bq/one-click-workspace
BrunoQuaresma Jul 26, 2023
fefcf2f
Fix invalid option as default parameter
BrunoQuaresma Jul 26, 2023
c785282
Display error when auto creation fails
BrunoQuaresma Jul 26, 2023
116cbe2
Merge branch 'main' into bq/one-click-workspace
BrunoQuaresma Jul 26, 2023
4d7a7c3
Add test to check auto create flow
BrunoQuaresma Jul 26, 2023
73dbc0f
Add option to the user choose auto or manual
BrunoQuaresma Jul 26, 2023
ce75ca0
Fix tests
BrunoQuaresma Jul 26, 2023
8504971
Better unique names
BrunoQuaresma Jul 26, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@
"ts-prune": "0.10.3",
"tzdata": "1.0.30",
"ua-parser-js": "1.0.33",
"unique-names-generator": "4.7.1",
"uuid": "9.0.0",
"vite": "4.4.2",
"xstate": "4.38.1",
Expand Down
26 changes: 26 additions & 0 deletions site/src/pages/CreateWorkspacePage/CreateWorkspacePage.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
MockTemplateVersionParameter2,
MockTemplateVersionParameter3,
MockTemplateVersionGitAuth,
MockOrganization,
} from "testHelpers/entities"
import {
renderWithAuth,
Expand Down Expand Up @@ -217,4 +218,29 @@ describe("CreateWorkspacePage", () => {

await screen.findByText("You must authenticate to create a workspace!")
})

it("auto create a workspace if uses mode=auto", async () => {
const param = "first_parameter"
const paramValue = "It works!"
const createWorkspaceSpy = jest.spyOn(API, "createWorkspace")

renderWithAuth(<CreateWorkspacePage />, {
route:
"/templates/" +
MockTemplate.name +
`/workspace?param.${param}=${paramValue}&mode=auto`,
path: "/templates/:template/workspace",
})

await waitFor(() => {
expect(createWorkspaceSpy).toBeCalledWith(
MockOrganization.id,
"me",
expect.objectContaining({
template_id: MockTemplate.id,
rich_parameter_values: [{ name: param, value: paramValue }],
}),
)
})
})
})
150 changes: 80 additions & 70 deletions site/src/pages/CreateWorkspacePage/CreateWorkspacePage.tsx
Original file line number Diff line number Diff line change
@@ -1,111 +1,113 @@
import { useMachine } from "@xstate/react"
import { TemplateVersionParameter } from "api/typesGenerated"
import {
Template,
TemplateVersionGitAuth,
TemplateVersionParameter,
WorkspaceBuildParameter,
} from "api/typesGenerated"
import { useMe } from "hooks/useMe"
import { useOrganizationId } from "hooks/useOrganizationId"
import { FC } from "react"
import { Helmet } from "react-helmet-async"
import { useNavigate, useParams, useSearchParams } from "react-router-dom"
import { pageTitle } from "utils/page"
import { createWorkspaceMachine } from "xServices/createWorkspace/createWorkspaceXService"
import {
CreateWorkspaceErrors,
CreateWorkspacePageView,
} from "./CreateWorkspacePageView"
CreateWSPermissions,
CreateWorkspaceMode,
createWorkspaceMachine,
} from "xServices/createWorkspace/createWorkspaceXService"
import { CreateWorkspacePageView } from "./CreateWorkspacePageView"
import { Loader } from "components/Loader/Loader"
import { ErrorAlert } from "components/Alert/ErrorAlert"
import {
uniqueNamesGenerator,
animals,
colors,
NumberDictionary,
} from "unique-names-generator"

const CreateWorkspacePage: FC = () => {
const organizationId = useOrganizationId()
const { template: templateName } = useParams() as { template: string }
const navigate = useNavigate()
const me = useMe()
const navigate = useNavigate()
const [searchParams] = useSearchParams()
const defaultBuildParameters = getDefaultBuildParameters(searchParams)
const mode = (searchParams.get("mode") ?? "form") as CreateWorkspaceMode
const [createWorkspaceState, send] = useMachine(createWorkspaceMachine, {
context: {
organizationId,
templateName,
owner: me,
mode,
defaultBuildParameters,
defaultName:
mode === "auto" ? generateUniqueName() : searchParams.get("name") ?? "",
},
actions: {
onCreateWorkspace: (_, event) => {
navigate(`/@${event.data.owner_name}/${event.data.name}`)
},
},
})
const {
templates,
templateParameters,
templateGitAuth,
selectedTemplate,
getTemplateGitAuthError,
getTemplatesError,
createWorkspaceError,
permissions,
owner,
} = createWorkspaceState.context
const [searchParams] = useSearchParams()
const defaultParameterValues = getDefaultParameterValues(searchParams)
const name = getName(searchParams)
const { template, error, parameters, permissions, gitAuth, defaultName } =
createWorkspaceState.context
const title = createWorkspaceState.matches("autoCreating")
? "Creating workspace..."
: "Create Workspace"

return (
<>
<Helmet>
<title>{pageTitle("Create Workspace")}</title>
<title>{pageTitle(title)}</title>
</Helmet>
<CreateWorkspacePageView
name={name}
defaultParameterValues={defaultParameterValues}
loadingTemplates={createWorkspaceState.matches("gettingTemplates")}
creatingWorkspace={createWorkspaceState.matches("creatingWorkspace")}
hasTemplateErrors={createWorkspaceState.matches("error")}
templateName={templateName}
templates={templates}
selectedTemplate={selectedTemplate}
templateParameters={orderedTemplateParameters(templateParameters)}
templateGitAuth={templateGitAuth}
createWorkspaceErrors={{
[CreateWorkspaceErrors.GET_TEMPLATES_ERROR]: getTemplatesError,
[CreateWorkspaceErrors.CREATE_WORKSPACE_ERROR]: createWorkspaceError,
[CreateWorkspaceErrors.GET_TEMPLATE_GITAUTH_ERROR]:
getTemplateGitAuthError,
}}
canCreateForUser={permissions?.createWorkspaceForUser}
owner={owner}
setOwner={(user) => {
send({
type: "SELECT_OWNER",
owner: user,
})
}}
onCancel={() => {
// Go back
navigate(-1)
}}
onSubmit={(request) => {
send({
type: "CREATE_WORKSPACE",
request,
owner,
})
}}
/>
{Boolean(
createWorkspaceState.matches("loadingFormData") ||
createWorkspaceState.matches("autoCreating"),
) && <Loader />}
{createWorkspaceState.matches("loadError") && (
<ErrorAlert error={error} />
)}
{createWorkspaceState.matches("idle") && (
<CreateWorkspacePageView
defaultName={defaultName}
defaultOwner={me}
defaultBuildParameters={defaultBuildParameters}
error={error}
template={template as Template}
gitAuth={gitAuth as TemplateVersionGitAuth[]}
permissions={permissions as CreateWSPermissions}
parameters={parameters as TemplateVersionParameter[]}
creatingWorkspace={createWorkspaceState.matches("creatingWorkspace")}
onCancel={() => {
navigate(-1)
}}
onSubmit={(request, owner) => {
send({
type: "CREATE_WORKSPACE",
request,
owner,
})
}}
/>
)}
</>
)
}

const getName = (urlSearchParams: URLSearchParams): string => {
return urlSearchParams.get("name") ?? ""
}
export default CreateWorkspacePage

const getDefaultParameterValues = (
const getDefaultBuildParameters = (
urlSearchParams: URLSearchParams,
): Record<string, string> => {
const paramValues: Record<string, string> = {}
): WorkspaceBuildParameter[] => {
const buildValues: WorkspaceBuildParameter[] = []
Array.from(urlSearchParams.keys())
.filter((key) => key.startsWith("param."))
.forEach((key) => {
const paramName = key.replace("param.", "")
const paramValue = urlSearchParams.get(key)
paramValues[paramName] = paramValue ?? ""
const name = key.replace("param.", "")
const value = urlSearchParams.get(key) ?? ""
buildValues.push({ name, value })
})
return paramValues
return buildValues
}

export const orderedTemplateParameters = (
Expand All @@ -122,4 +124,12 @@ export const orderedTemplateParameters = (
return [...immutables, ...mutables]
}

export default CreateWorkspacePage
const generateUniqueName = () => {
const numberDictionary = NumberDictionary.generate({ min: 0, max: 99 })
return uniqueNamesGenerator({
dictionaries: [colors, animals, numberDictionary],
separator: "-",
length: 3,
style: "lowerCase",
})
}
Loading