Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

feat(site): warn on provisioner health during builds#15589

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
SasSwart merged 18 commits intomainfromjjs/15048-fe
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
Show all changes
18 commits
Select commitHold shift + click to select a range
7df3b27
add alert to the create workspace page
SasSwartNov 19, 2024
1e1262f
improve error case documentation
SasSwartNov 19, 2024
0f78afc
add provisioner health hook
SasSwartNov 20, 2024
f0f7216
show provisioner health warnings for templates
SasSwartNov 21, 2024
a3eeb9c
consistent formatting for alerts across pages
SasSwartNov 21, 2024
3cf53ef
Finalise Provisioner Warnings for Templates and template versions
SasSwartNov 22, 2024
e281d6b
linter fixes
SasSwartNov 22, 2024
2baa81e
Merge remote-tracking branch 'origin/main' into jjs/15048-fe
SasSwartNov 26, 2024
0cab768
use matched_provisioners instead of a second api call
SasSwartNov 27, 2024
b228257
provide a key to provisioner tags to keep react happy
SasSwartNov 27, 2024
8b91dc0
fix linting issues
SasSwartNov 27, 2024
bec2913
make fmt
SasSwartNov 27, 2024
4796a32
Copy updates
SasSwartNov 28, 2024
b6f99a6
make fmt
SasSwartNov 28, 2024
aec9cba
add loader back in to build logs drawer
SasSwartNov 28, 2024
75e7394
simplify logic
SasSwartNov 28, 2024
0aed543
fix logic
SasSwartNov 28, 2024
0bd9478
make fmt
SasSwartNov 28, 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
10 changes: 9 additions & 1 deletionsite/src/api/api.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -682,12 +682,20 @@ class ApiMethods {

/**
*@param organization Can be the organization's ID or name
*@param tags to filter provisioner daemons by.
*/
getProvisionerDaemonsByOrganization=async(
organization:string,
tags?:Record<string,string>,
):Promise<TypesGen.ProvisionerDaemon[]>=>{
constparams=newURLSearchParams();

if(tags){
params.append("tags",JSON.stringify(tags));
}

constresponse=awaitthis.axios.get<TypesGen.ProvisionerDaemon[]>(
`/api/v2/organizations/${organization}/provisionerdaemons`,
`/api/v2/organizations/${organization}/provisionerdaemons?${params.toString()}`,
);
returnresponse.data;
};
Expand Down
18 changes: 10 additions & 8 deletionssite/src/api/queries/organizations.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,16 +115,18 @@ export const organizations = () => {
};
};

exportconstgetProvisionerDaemonsKey=(organization:string)=>[
"organization",
organization,
"provisionerDaemons",
];
exportconstgetProvisionerDaemonsKey=(
organization:string,
tags?:Record<string,string>,
)=>["organization",organization,tags,"provisionerDaemons"];

exportconstprovisionerDaemons=(organization:string)=>{
exportconstprovisionerDaemons=(
organization:string,
tags?:Record<string,string>,
)=>{
return{
queryKey:getProvisionerDaemonsKey(organization),
queryFn:()=>API.getProvisionerDaemonsByOrganization(organization),
queryKey:getProvisionerDaemonsKey(organization,tags),
queryFn:()=>API.getProvisionerDaemonsByOrganization(organization,tags),
};
};

Expand Down
3 changes: 3 additions & 0 deletionssite/src/components/Alert/Alert.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
importMuiAlert,{
typeAlertColorasMuiAlertColor,
typeAlertPropsasMuiAlertProps,
// biome-ignore lint/nursery/noRestrictedImports: Used as base component
}from"@mui/material/Alert";
Expand All@@ -11,6 +12,8 @@ import {
useState,
}from"react";

exporttypeAlertColor=MuiAlertColor;

exporttypeAlertProps=MuiAlertProps&{
actions?:ReactNode;
dismissible?:boolean;
Expand Down
28 changes: 28 additions & 0 deletionssite/src/modules/provisioners/ProvisionerAlert.stories.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
importtype{Meta,StoryObj}from"@storybook/react";
import{chromatic}from"testHelpers/chromatic";
import{ProvisionerAlert}from"./ProvisionerAlert";

constmeta:Meta<typeofProvisionerAlert>={
title:"modules/provisioners/ProvisionerAlert",
parameters:{
chromatic,
layout:"centered",
},
component:ProvisionerAlert,
args:{
title:"Title",
detail:"Detail",
severity:"info",
tags:{tag:"tagValue"},
},
};

exportdefaultmeta;
typeStory=StoryObj<typeofProvisionerAlert>;

exportconstInfo:Story={};
exportconstNullTags:Story={
args:{
tags:undefined,
},
};
45 changes: 45 additions & 0 deletionssite/src/modules/provisioners/ProvisionerAlert.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
importAlertTitlefrom"@mui/material/AlertTitle";
import{Alert,typeAlertColor}from"components/Alert/Alert";
import{AlertDetail}from"components/Alert/Alert";
import{Stack}from"components/Stack/Stack";
import{ProvisionerTag}from"modules/provisioners/ProvisionerTag";
importtype{FC}from"react";
interfaceProvisionerAlertProps{
title:string;
detail:string;
severity:AlertColor;
tags:Record<string,string>;
}

exportconstProvisionerAlert:FC<ProvisionerAlertProps>=({
title,
detail,
severity,
tags,
})=>{
return(
<Alert
severity={severity}
css={(theme)=>{
return{
borderRadius:0,
border:0,
borderBottom:`1px solid${theme.palette.divider}`,
borderLeft:`2px solid${theme.palette[severity].main}`,
};
}}
>
<AlertTitle>{title}</AlertTitle>
<AlertDetail>
<div>{detail}</div>
<Stackdirection="row"spacing={1}wrap="wrap">
{Object.entries(tags??{})
.filter(([key])=>key!=="owner")
.map(([key,value])=>(
<ProvisionerTagkey={key}tagName={key}tagValue={value}/>
))}
</Stack>
</AlertDetail>
</Alert>
);
};
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
importtype{Meta,StoryObj}from"@storybook/react";
import{chromatic}from"testHelpers/chromatic";
import{MockTemplateVersion}from"testHelpers/entities";
import{ProvisionerStatusAlert}from"./ProvisionerStatusAlert";

constmeta:Meta<typeofProvisionerStatusAlert>={
title:"modules/provisioners/ProvisionerStatusAlert",
parameters:{
chromatic,
layout:"centered",
},
component:ProvisionerStatusAlert,
args:{
matchingProvisioners:0,
availableProvisioners:0,
tags:MockTemplateVersion.job.tags,
},
};

exportdefaultmeta;
typeStory=StoryObj<typeofProvisionerStatusAlert>;

exportconstHealthyProvisioners:Story={
args:{
matchingProvisioners:1,
availableProvisioners:1,
},
};

exportconstUndefinedMatchingProvisioners:Story={
args:{
matchingProvisioners:undefined,
availableProvisioners:undefined,
},
};

exportconstUndefinedAvailableProvisioners:Story={
args:{
matchingProvisioners:1,
availableProvisioners:undefined,
},
};

exportconstNoMatchingProvisioners:Story={
args:{
matchingProvisioners:0,
},
};

exportconstNoAvailableProvisioners:Story={
args:{
matchingProvisioners:1,
availableProvisioners:0,
},
};
47 changes: 47 additions & 0 deletionssite/src/modules/provisioners/ProvisionerStatusAlert.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
importtype{AlertColor}from"components/Alert/Alert";
importtype{FC}from"react";
import{ProvisionerAlert}from"./ProvisionerAlert";

interfaceProvisionerStatusAlertProps{
matchingProvisioners:number|undefined;
availableProvisioners:number|undefined;
tags:Record<string,string>;
}

exportconstProvisionerStatusAlert:FC<ProvisionerStatusAlertProps>=({
matchingProvisioners,
availableProvisioners,
tags,
})=>{
lettitle:string;
letdetail:string;
letseverity:AlertColor;
switch(true){
casematchingProvisioners===0:
title="Build pending provisioner deployment";
detail=
"Your build has been enqueued, but there are no provisioners that accept the required tags. Once a compatible provisioner becomes available, your build will continue. Please contact your administrator.";
severity="warning";
break;
caseavailableProvisioners===0:
title="Build delayed";
detail=
"Provisioners that accept the required tags have not responded for longer than expected. This may delay your build. Please contact your administrator if your build does not complete.";
severity="warning";
break;
default:
title="Build enqueued";
detail=
"Your build has been enqueued and will begin once a provisioner becomes available to process it.";
severity="info";
}

return(
<ProvisionerAlert
title={title}
detail={detail}
severity={severity}
tags={tags}
/>
);
};
36 changes: 36 additions & 0 deletionssite/src/pages/CreateTemplatePage/BuildLogsDrawer.stories.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,42 @@ export const MissingVariables: Story = {
},
};

exportconstNoProvisioners:Story={
args:{
templateVersion:{
...MockTemplateVersion,
matched_provisioners:{
count:0,
available:0,
},
},
},
};

exportconstProvisionersUnhealthy:Story={
args:{
templateVersion:{
...MockTemplateVersion,
matched_provisioners:{
count:1,
available:0,
},
},
},
};

exportconstProvisionersHealthy:Story={
args:{
templateVersion:{
...MockTemplateVersion,
matched_provisioners:{
count:1,
available:1,
},
},
},
};

exportconstLogs:Story={
args:{
templateVersion:{
Expand Down
16 changes: 15 additions & 1 deletionsite/src/pages/CreateTemplatePage/BuildLogsDrawer.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { visuallyHidden } from "@mui/utils";
import{JobError}from"api/queries/templates";
importtype{TemplateVersion}from"api/typesGenerated";
import{Loader}from"components/Loader/Loader";
import{ProvisionerStatusAlert}from"modules/provisioners/ProvisionerStatusAlert";
import{useWatchVersionLogs}from"modules/templates/useWatchVersionLogs";
import{WorkspaceBuildLogs}from"modules/workspaces/WorkspaceBuildLogs/WorkspaceBuildLogs";
import{typeFC,useLayoutEffect,useRef}from"react";
Expand All@@ -27,6 +28,10 @@ export const BuildLogsDrawer: FC<BuildLogsDrawerProps> = ({
variablesSectionRef,
...drawerProps
})=>{
constmatchingProvisioners=templateVersion?.matched_provisioners?.count;
constavailableProvisioners=
templateVersion?.matched_provisioners?.available;

constlogs=useWatchVersionLogs(templateVersion);
constlogsContainer=useRef<HTMLDivElement>(null);

Expand DownExpand Up@@ -65,6 +70,8 @@ export const BuildLogsDrawer: FC<BuildLogsDrawerProps> = ({
</IconButton>
</header>

{}

{isMissingVariables ?(
<MissingVariablesBanner
onFillVariables={()=>{
Expand All@@ -82,7 +89,14 @@ export const BuildLogsDrawer: FC<BuildLogsDrawerProps> = ({
<WorkspaceBuildLogslogs={logs}css={{border:0}}/>
</section>
) :(
<Loader/>
<>
<ProvisionerStatusAlert
matchingProvisioners={matchingProvisioners}
availableProvisioners={availableProvisioners}
tags={templateVersion?.job.tags??{}}
/>
<Loader/>
</>
)}
</div>
</Drawer>
Expand Down
Loading
Loading
[8]ページ先頭
©2009-2025 Movatter.jp