feat(site): warn on provisioner health during builds #15589
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| import type { Meta, StoryObj } from "@storybook/react"; | ||
| import { chromatic } from "testHelpers/chromatic"; | ||
| import { MockTemplateVersion } from "testHelpers/entities"; | ||
| import { ProvisionerAlert } from "./ProvisionerAlert"; | ||
|
|
||
| const meta: Meta<typeof ProvisionerAlert> = { | ||
| title: "modules/provisioners/ProvisionerAlert", | ||
| parameters: { | ||
| chromatic, | ||
| layout: "centered", | ||
| }, | ||
| component: ProvisionerAlert, | ||
| args: { | ||
| matchingProvisioners: 0, | ||
| availableProvisioners: 0, | ||
| tags: MockTemplateVersion.job.tags, | ||
| }, | ||
| }; | ||
|
|
||
| export default meta; | ||
| type Story = StoryObj<typeof ProvisionerAlert>; | ||
|
|
||
| export const HealthyProvisioners: Story = { | ||
| args: { | ||
| matchingProvisioners: 1, | ||
| availableProvisioners: 1, | ||
| }, | ||
| }; | ||
|
|
||
| export const UndefinedMatchingProvisioners: Story = { | ||
| args: { | ||
| matchingProvisioners: undefined, | ||
| availableProvisioners: undefined, | ||
| }, | ||
| }; | ||
|
|
||
| export const UndefinedAvailableProvisioners: Story = { | ||
| args: { | ||
| matchingProvisioners: 1, | ||
| availableProvisioners: undefined, | ||
| }, | ||
| }; | ||
|
|
||
| export const NoMatchingProvisioners: Story = { | ||
| args: { | ||
| matchingProvisioners: 0, | ||
| }, | ||
| }; | ||
|
|
||
| export const NoAvailableProvisioners: Story = { | ||
| args: { | ||
| matchingProvisioners: 1, | ||
| availableProvisioners: 0, | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| import AlertTitle from "@mui/material/AlertTitle"; | ||
| import { Alert, type AlertColor } from "components/Alert/Alert"; | ||
| import { AlertDetail } from "components/Alert/Alert"; | ||
| import { Stack } from "components/Stack/Stack"; | ||
| import { ProvisionerTag } from "modules/provisioners/ProvisionerTag"; | ||
| import type { FC } from "react"; | ||
|
|
||
| interface ProvisionerAlertProps { | ||
| matchingProvisioners: number | undefined; | ||
| availableProvisioners: number | undefined; | ||
| tags: Record<string, string>; | ||
| } | ||
|
|
||
| export const ProvisionerAlert: FC<ProvisionerAlertProps> = ({ | ||
| matchingProvisioners, | ||
| availableProvisioners, | ||
| tags, | ||
| }) => { | ||
| let title: string; | ||
| let detail: string; | ||
| switch (true) { | ||
| case matchingProvisioners === 0: | ||
| title = "Provisioning Cannot Proceed"; | ||
| detail = | ||
| "There are no provisioners that accept the required tags. Please contact your administrator. Once a compatible provisioner becomes available, provisioning will continue."; | ||
| break; | ||
| case availableProvisioners === 0: | ||
| title = "Provisioning Delayed"; | ||
| detail = | ||
| "Provisioners that accept the required tags are currently anavailable. This may delay your build. Please contact your administrator if your build does not complete."; | ||
|
There was a problem hiding this comment. Are we able to show a queue length, like we do in the workspaces page? If nontrivial, this copy LGTM! There was a problem hiding this comment. I think it might be non-trivial so let's leave it as a follow-up?
SasSwart marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| break; | ||
| default: | ||
| return null; | ||
| } | ||
|
|
||
| return ( | ||
| <Alert | ||
| severity="warning" | ||
| css={(theme) => ({ | ||
| borderRadius: 0, | ||
| border: 0, | ||
| borderBottom: `1px solid ${theme.palette.divider}`, | ||
| borderLeft: `2px solid ${theme.palette.error.main}`, | ||
| })} | ||
| > | ||
| <AlertTitle>{title}</AlertTitle> | ||
| <AlertDetail> | ||
| <div>{detail}</div> | ||
| <Stack direction="row" spacing={1} wrap="wrap"> | ||
| {Object.entries(tags) | ||
| .filter(([key]) => key !== "owner") | ||
| .map(([key, value]) => ( | ||
| <ProvisionerTag key={key} tagName={key} tagValue={value} /> | ||
| ))} | ||
| </Stack> | ||
| </AlertDetail> | ||
| </Alert> | ||
| ); | ||
| }; | ||
|
|
||
| interface ProvisionerJobAlertProps { | ||
| title: string; | ||
| detail: string; | ||
| severity: AlertColor; | ||
| tags: Record<string, string>; | ||
| } | ||
|
|
||
| export const ProvisionerJobAlert: FC<ProvisionerJobAlertProps> = ({ | ||
| title, | ||
| detail, | ||
| severity, | ||
| tags, | ||
| }) => { | ||
| return ( | ||
| <Alert | ||
| severity={severity} | ||
| css={(theme) => ({ | ||
| borderRadius: 0, | ||
| border: 0, | ||
| borderBottom: `1px solid ${theme.palette.divider}`, | ||
| borderLeft: `2px solid ${theme.palette.error.main}`, | ||
| })} | ||
| > | ||
| <AlertTitle>{title}</AlertTitle> | ||
| <AlertDetail> | ||
| <div>{detail}</div> | ||
| <Stack direction="row" spacing={1} wrap="wrap"> | ||
| {Object.entries(tags) | ||
| .filter(([key]) => key !== "owner") | ||
| .map(([key, value]) => ( | ||
| <ProvisionerTag key={key} tagName={key} tagValue={value} /> | ||
| ))} | ||
| </Stack> | ||
| </AlertDetail> | ||
| </Alert> | ||
| ); | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, are we able to link to the docs on external provisioners?
If the user is an admin, it may be nice to remove "Contact your administrator." And also link to the provisioners page for the given organization.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK to do this as a follow-up? I've seen plenty of systems where a "contact your administrator" is shown regardless of your user's capabilities.