Skip to content

fix(orchestrator): clarify ActiveText retrigger loading #2096

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

Open
lokanandaprabhu wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −11
Open

fix(orchestrator): clarify ActiveText retrigger loading #2096

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
5 changes: 5 additions & 0 deletions workspaces/orchestrator/.changeset/activetext-retrigger-loading-indicator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@red-hat-developer-hub/backstage-plugin-orchestrator-form-widgets': patch
---

Clarify ActiveText retrigger loading by showing a spinner while dependencies resolve.
16 changes: 15 additions & 1 deletion workspaces/orchestrator/plugins/orchestrator-form-widgets/src/utils/useFetchAndEvaluate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,23 @@ export const useFetchAndEvaluate = (
handleFetchEnded?: () => void,
) => {
const unitEvaluator = useTemplateUnitEvaluator();
const hasFetchUrl = !!uiProps['fetch:url'];
const hasRetrigger =
Array.isArray(uiProps['fetch:retrigger']) &&
uiProps['fetch:retrigger'].length > 0;
const retrigger = useRetriggerEvaluate(
unitEvaluator,
formData,
uiProps['fetch:retrigger'] as string[],
);
const retriggerSatisfied =
!hasRetrigger ||
(!!retrigger &&
retrigger.every(
value => value !== undefined && value !== null && value !== '',
));
const waitingForRetrigger =
hasFetchUrl && hasRetrigger && !retriggerSatisfied;
const {
data,
error: fetchError,
Expand All @@ -50,7 +62,7 @@ export const useFetchAndEvaluate = (
useDebounce(
() => {
const evaluate = async () => {
if (!retrigger || fetchLoading || fetchError) {
if (!retrigger || fetchLoading || fetchError || waitingForRetrigger) {
return;
}
try {
Expand Down Expand Up @@ -82,6 +94,7 @@ export const useFetchAndEvaluate = (
retrigger,
fetchError,
fetchLoading,
waitingForRetrigger,
fieldId,
data,
formData,
Expand All @@ -108,6 +121,7 @@ export const useFetchAndEvaluate = (
return {
text: resultText,
loading: completeLoading,
waitingForRetrigger,
error: error ?? fetchError,
};
};
21 changes: 11 additions & 10 deletions workspaces/orchestrator/plugins/orchestrator-form-widgets/src/widgets/ActiveText.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export const ActiveText: Widget<
const handleFetchStarted = formContext?.handleFetchStarted;
const handleFetchEnded = formContext?.handleFetchEnded;

const { text, error, loading } = useFetchAndEvaluate(
const { text, error, loading, waitingForRetrigger } = useFetchAndEvaluate(
uiProps['ui:text'] ?? '',
formData ?? {},
uiProps,
Expand All @@ -59,13 +59,14 @@ export const ActiveText: Widget<
return <ErrorText id={id} text={error} />;
}

return (
<Box data-testid={id}>
{loading ? (
<CircularProgress size={20} />
) : (
<MarkdownContent content={text || ''} />
)}
</Box>
);
let content: React.ReactNode;
if (waitingForRetrigger) {
content = <CircularProgress size={16} />;
} else if (loading) {
content = <CircularProgress size={20} />;
} else {
content = <MarkdownContent content={text || ''} />;
}

return <Box data-testid={id}>{content}</Box>;
};