Skip to content

feat(site): allow creating a workspace without connecting optional external auth providers #12251

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.

Sign up for GitHub

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 5 commits into from
Feb 22, 2024
Merged

feat(site): allow creating a workspace without connecting optional external auth providers #12251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ee3bad
changes from base
aslilac Feb 21, 2024
c04cd37
support optional external auth providers in the frontend
aslilac Feb 21, 2024
f00b991
🧹
aslilac Feb 21, 2024
5ba780d
remove unnecessary test
aslilac Feb 21, 2024
b8bed3c
Merge branch 'main' into optional-external-auth-frontend
aslilac Feb 22, 2024
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
15 changes: 1 addition & 14 deletions site/src/pages/CreateWorkspacePage/CreateWorkspacePage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,19 +233,6 @@ describe("CreateWorkspacePage", () => {
);
});

it("external auth errors if unauthenticated", async () => {
jest
.spyOn(API, "getTemplateVersionExternalAuth")
.mockResolvedValueOnce([MockTemplateVersionExternalAuthGithub]);

renderCreateWorkspacePage();
await waitForLoaderToBeRemoved();

await screen.findByText(
"To create a workspace using the selected template, please ensure you are authenticated with all the external providers listed below.",
);
});

it("auto create a workspace if uses mode=auto", async () => {
const param = "first_parameter";
const paramValue = "It works!";
Expand Down Expand Up @@ -312,7 +299,7 @@ describe("CreateWorkspacePage", () => {
route: `/templates/${MockWorkspace.name}/workspace?${params.toString()}`,
});

const warningMessage = await screen.findByRole("alert");
const warningMessage = await screen.findByTestId("duplication-warning");
const nameInput = await screen.findByRole("textbox", {
name: "Workspace Name",
});
Expand Down
74 changes: 74 additions & 0 deletions site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,80 @@ export const ExternalAuth: Story = {
authenticate_url: "",
display_icon: "/icon/gitlab.svg",
display_name: "GitLab",
optional: true,
},
],
},
};

export const ExternalAuthError: Story = {
args: {
error: true,
externalAuth: [
{
id: "github",
type: "github",
authenticated: false,
authenticate_url: "",
display_icon: "/icon/github.svg",
display_name: "GitHub",
},
{
id: "gitlab",
type: "gitlab",
authenticated: false,
authenticate_url: "",
display_icon: "/icon/gitlab.svg",
display_name: "GitLab",
optional: true,
},
],
},
};

export const ExternalAuthAllRequiredConnected: Story = {
args: {
externalAuth: [
{
id: "github",
type: "github",
authenticated: true,
authenticate_url: "",
display_icon: "/icon/github.svg",
display_name: "GitHub",
},
{
id: "gitlab",
type: "gitlab",
authenticated: false,
authenticate_url: "",
display_icon: "/icon/gitlab.svg",
display_name: "GitLab",
optional: true,
},
],
},
};

export const ExternalAuthAllConnected: Story = {
args: {
externalAuth: [
{
id: "github",
type: "github",
authenticated: true,
authenticate_url: "",
display_icon: "/icon/github.svg",
display_name: "GitHub",
},
{
id: "gitlab",
type: "gitlab",
authenticated: true,
authenticate_url: "",
display_icon: "/icon/gitlab.svg",
display_name: "GitLab",
optional: true,
},
],
},
Expand Down
21 changes: 12 additions & 9 deletions site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ export const CreateWorkspacePageView: FC<CreateWorkspacePageViewProps> = ({
);
}, [autofillParameters]);

const hasAllRequiredExternalAuth = externalAuth.every(
(auth) => auth.optional || auth.authenticated,
);

return (
<Margins size="medium">
<PageHeader actions={<Button onClick={onCancel}>Cancel</Button>}>
Expand Down Expand Up @@ -179,7 +183,7 @@ export const CreateWorkspacePageView: FC<CreateWorkspacePageViewProps> = ({
{Boolean(error) && <ErrorAlert error={error} />}

{mode === "duplicate" && (
<Alert severity="info" dismissible>
<Alert severity="info" dismissible data-testid="duplication-warning">
{Language.duplicationWarning}
</Alert>
)}
Expand Down Expand Up @@ -248,21 +252,19 @@ export const CreateWorkspacePageView: FC<CreateWorkspacePageViewProps> = ({
{externalAuth && externalAuth.length > 0 && (
<FormSection
title="External Authentication"
description="This template requires authentication to external services."
description="This template uses external services for authentication."
>
<FormFields>
{requiresExternalAuth && (
// This should really be a `notice` but `severity` is a MUI prop, and we'd need
// to basically make our own `Alert` component.
<Alert severity="info">
To create a workspace using the selected template, please
ensure you are authenticated with all the external providers
listed below.
{Boolean(error) && !hasAllRequiredExternalAuth && (
<Alert severity="error">
To create a workspace using this template, please connect to
all required external authentication providers listed below.
</Alert>
)}
{externalAuth.map((auth) => (
<ExternalAuthButton
key={auth.id}
error={error}
auth={auth}
isLoading={externalAuthPollingState === "polling"}
onStartPolling={startPollingExternalAuth}
Expand Down Expand Up @@ -313,6 +315,7 @@ export const CreateWorkspacePageView: FC<CreateWorkspacePageViewProps> = ({
<FormFooter
onCancel={onCancel}
isLoading={creatingWorkspace}
submitDisabled={!hasAllRequiredExternalAuth}
submitLabel="Create Workspace"
/>
</HorizontalForm>
Expand Down
14 changes: 13 additions & 1 deletion site/src/pages/CreateWorkspacePage/ExternalAuthButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const MockExternalAuth: TemplateVersionExternalAuth = {
};

const meta: Meta<typeof ExternalAuthButton> = {
title: "pages/CreateWorkspacePage/ExternalAuth",
title: "pages/CreateWorkspacePage/ExternalAuthButton",
component: ExternalAuthButton,
};

Expand All @@ -25,6 +25,15 @@ export const Github: Story = {
},
};

export const GithubOptional: Story = {
args: {
auth: {
...MockExternalAuth,
optional: true,
},
},
};

export const GithubWithRetry: Story = {
args: {
auth: MockExternalAuth,
Expand All @@ -48,6 +57,7 @@ export const Gitlab: Story = {
display_icon: "/icon/gitlab.svg",
display_name: "GitLab",
authenticated: false,
optional: true,
},
},
};
Expand All @@ -70,6 +80,7 @@ export const AzureDevOps: Story = {
display_icon: "/icon/azure-devops.svg",
display_name: "Azure DevOps",
authenticated: false,
optional: true,
},
},
};
Expand All @@ -92,6 +103,7 @@ export const Bitbucket: Story = {
display_icon: "/icon/bitbucket.svg",
display_name: "Bitbucket",
authenticated: false,
optional: true,
},
},
};
Expand Down
22 changes: 17 additions & 5 deletions site/src/pages/CreateWorkspacePage/ExternalAuthButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
import ReplayIcon from "@mui/icons-material/Replay";
import Button from "@mui/material/Button";
import Tooltip from "@mui/material/Tooltip";
import { type FC } from "react";
import LoadingButton from "@mui/lab/LoadingButton";
import { visuallyHidden } from "@mui/utils";
import { type FC } from "react";
import type { TemplateVersionExternalAuth } from "api/typesGenerated";
import { ExternalImage } from "components/ExternalImage/ExternalImage";
import { TemplateVersionExternalAuth } from "api/typesGenerated";
import { Pill } from "components/Pill/Pill";

export interface ExternalAuthButtonProps {
auth: TemplateVersionExternalAuth;
displayRetry: boolean;
isLoading: boolean;
onStartPolling: () => void;
error?: unknown;
}

export const ExternalAuthButton: FC<ExternalAuthButtonProps> = ({
auth,
displayRetry,
isLoading,
onStartPolling,
error,
}) => {
return (
<>
Expand Down Expand Up @@ -48,9 +51,18 @@ export const ExternalAuthButton: FC<ExternalAuthButtonProps> = ({
onStartPolling();
}}
>
{auth.authenticated
? `Authenticated with ${auth.display_name}`
: `Login with ${auth.display_name}`}
{auth.authenticated ? (
`Authenticated with ${auth.display_name}`
) : (
<>
Login with {auth.display_name}
{!auth.optional && (
<Pill type={error ? "error" : "info"} css={{ marginLeft: 12 }}>
Required
</Pill>
)}
</>
)}
</LoadingButton>

{displayRetry && (
Expand Down