Skip to content

fix: show proper message if allowed workflows are not defined in CT #483

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
stefinie123 merged 1 commit into from
Mar 23, 2026
Merged

fix: show proper message if allowed workflows are not defined in CT #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
140 changes: 90 additions & 50 deletions packages/app/src/scaffolder/BuildWorkflowPicker/BuildWorkflowPickerExtension.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ import {
CircularProgress,
Box,
Typography,
Link,
} from '@material-ui/core';
import { NotificationBanner } from '@openchoreo/backstage-plugin-react';
import {
useApi,
discoveryApiRef,
Expand Down Expand Up @@ -230,13 +232,16 @@ export const BuildWorkflowPicker = ({
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [namespaceName, isClusterComponentType]);

const hasAllowedWorkflows =
Array.isArray(allowedWorkflows) && allowedWorkflows.length > 0;

// Separate filtering from fetching so that allowedWorkflows changes are
// reflected without triggering a full re-fetch.
const filteredOptions = useMemo(() => {
if (!allowedWorkflows || allowedWorkflows.length === 0) {
return workflowOptions;
if (!hasAllowedWorkflows) {
return [];
}
const normalizedAllowed = allowedWorkflows.map(w => ({
const normalizedAllowed = allowedWorkflows!.map(w => ({
kind: (w.kind as WorkflowKind | undefined) ?? defaultWorkflowKind,
name: w.name,
}));
Expand All @@ -245,7 +250,12 @@ export const BuildWorkflowPicker = ({
aw => aw.name === opt.name && aw.kind === opt.kind,
),
);
}, [workflowOptions, allowedWorkflows, defaultWorkflowKind]);
}, [
workflowOptions,
allowedWorkflows,
hasAllowedWorkflows,
defaultWorkflowKind,
]);

const handleDropdownChange = (event: ChangeEvent<{ value: unknown }>) => {
const key = event.target.value as string;
Expand All @@ -260,54 +270,84 @@ export const BuildWorkflowPicker = ({

// Standard dropdown for non-buildpack workflows
return (
<FormControl
fullWidth
margin="normal"
variant="outlined"
error={!!rawErrors?.length || !!error}
required={required}
>
<InputLabel id={`${idSchema?.$id}-label`}>{label}</InputLabel>
<Select
labelId={`${idSchema?.$id}-label`}
label={label}
value={selectedKey || ''}
onChange={handleDropdownChange}
disabled={loading || filteredOptions.length === 0}
<>
{!hasAllowedWorkflows && !loading && (
<NotificationBanner
variant="warning"
showIcon
message={
<>
This component type does not have any build workflows configured.
To enable building from source, configure allowed workflows in the
component type definition.{' '}
<Link
href="https://openchoreo.dev/docs/reference/api/platform/componenttype/#workflowref"
target="_blank"
rel="noopener noreferrer"
>
Learn more
</Link>
</>
}
/>
)}
<FormControl
fullWidth
margin="normal"
variant="outlined"
error={!!rawErrors?.length || !!error}
required={required}
>
{loading && (
<MenuItem disabled>
<CircularProgress size={20} style={{ marginRight: 8 }} />
Loading workflows...
</MenuItem>
)}
{!loading && filteredOptions.length === 0 && (
<MenuItem disabled>No workflows available</MenuItem>
)}
{!loading &&
filteredOptions.map(workflow => (
<MenuItem key={workflowKey(workflow)} value={workflowKey(workflow)}>
<Box display="flex" flexDirection="column">
<Typography variant="body1">
{getWorkflowDisplayName(workflow)}
</Typography>
{workflow.description && (
<Typography variant="body2" color="textSecondary">
{workflow.description}
</Typography>
)}
</Box>
<InputLabel id={`${idSchema?.$id}-label`}>{label}</InputLabel>
<Select
labelId={`${idSchema?.$id}-label`}
label={label}
value={selectedKey || ''}
onChange={handleDropdownChange}
disabled={loading}
>
{loading && (
<MenuItem disabled>
<CircularProgress size={20} style={{ marginRight: 8 }} />
Loading workflows...
</MenuItem>
))}
</Select>
{error && <FormHelperText error>{error}</FormHelperText>}
{rawErrors?.length ? (
<FormHelperText error>{rawErrors.join(', ')}</FormHelperText>
) : null}
{schema.description && !rawErrors?.length && !error && (
<FormHelperText>{schema.description}</FormHelperText>
)}
</FormControl>
)}
{!loading && !hasAllowedWorkflows && (
<MenuItem disabled>
No build workflows are allowed for this component type
</MenuItem>
)}
{!loading && hasAllowedWorkflows && filteredOptions.length === 0 && (
<MenuItem disabled>No workflows available</MenuItem>
)}
{!loading &&
filteredOptions.map(workflow => (
<MenuItem
key={workflowKey(workflow)}
value={workflowKey(workflow)}
>
<Box display="flex" flexDirection="column">
<Typography variant="body1">
{getWorkflowDisplayName(workflow)}
</Typography>
{workflow.description && (
<Typography variant="body2" color="textSecondary">
{workflow.description}
</Typography>
)}
</Box>
</MenuItem>
))}
</Select>
{error && <FormHelperText error>{error}</FormHelperText>}
{rawErrors?.length ? (
<FormHelperText error>{rawErrors.join(', ')}</FormHelperText>
) : null}
{schema.description && !rawErrors?.length && !error && (
<FormHelperText>{schema.description}</FormHelperText>
)}
</FormControl>
</>
);
};

Expand Down
2 changes: 1 addition & 1 deletion plugins/openchoreo-react/src/components/NotificationBanner/styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const useStyles = makeStyles(theme => ({
borderLeft: `4px solid`,
backgroundColor: theme.palette.background.paper,
position: 'relative',
gap: theme.spacing(1),
gap: theme.spacing(1.5),
},
primary: {
borderLeftColor: theme.palette.primary.main,
Expand Down
Loading