Skip to content

Tbt/fix frontend linter #1061

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
TBThomas56 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Tbt/fix frontend linter #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cbfc8ad
refactor(frontend): refactor frontend for new linting rules
TBThomas56 Nov 14, 2025
8e6b33c
refactor(frontend): modified tests and stories from refactor
TBThomas56 Dec 1, 2025
41ce86d
refactor(frontend): refactor ScanRangeInput
VictoriaBeilsten-Edmands Dec 17, 2025
d7d60b9
fix(frontend): prevent pagination limit label clashing & remove extra…
VictoriaBeilsten-Edmands Dec 19, 2025
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
2 changes: 1 addition & 1 deletion frontend/relay-workflows-lib/lib/components/TasksFlow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ const TasksFlow: React.FC<TasksFlowProps> = ({
panOnDrag={true}
preventScrolling={false}
defaultViewport={defaultViewport}
fitView={false}
fitView={true}
style={{ width: "100%", height: "100%", overflow: "auto" }}
/>
)}
Expand Down
8 changes: 5 additions & 3 deletions frontend/relay-workflows-lib/lib/components/WorkflowsContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ interface WorkflowsContentProps {
onLimitChange: (limit: number) => void;
updatePageInfo: (hasNextPage: boolean, endCursor: string | null) => void;
isPaginated: boolean;
setIsPaginated: (b: boolean) => void;
setIsPaginated: (isPaginated: boolean) => void;
}

export default function WorkflowsContent({
Expand All @@ -60,6 +60,7 @@ export default function WorkflowsContent({
const pageInfo = data.pageInfo;
const fetchedWorkflows = data.nodes;
const prevFetchedRef = useRef<string[]>([]);
const isPaginatedRef = useRef<boolean>(isPaginated);

const [expandedWorkflows, setExpandedWorkflows] = useState<Set<string>>(
new Set(),
Expand All @@ -74,12 +75,13 @@ export default function WorkflowsContent({
const prevNames = prevFetchedRef.current;
const fetchedChanged =
JSON.stringify(currentNames) !== JSON.stringify(prevNames);
if (fetchedChanged && isPaginated) {
if (fetchedChanged && isPaginatedRef.current) {
setTimeout(() => {
isPaginatedRef.current = false;
setIsPaginated(false);
}, 0);
}
}, [isPaginated, fetchedWorkflows, setIsPaginated]);
}, [isPaginatedRef, fetchedWorkflows, setIsPaginated]);

const handleToggleExpanded = (name: string) => {
setExpandedWorkflows((prev) => {
Expand Down
1 change: 0 additions & 1 deletion frontend/relay-workflows-lib/lib/query-components/RetriggerWorkflow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ const RetriggerWorkflowBase: React.FC<RetriggerWorkflowProps> = ({
return templateName ? (
<Tooltip title="Rerun workflow">
<NavLink
title="Rerun workflow"
to={`/templates/${templateName}/${visitToText(
instrumentSession,
)}-${workflowName}`}
Expand Down
52 changes: 30 additions & 22 deletions frontend/relay-workflows-lib/lib/utils/workflowRelayUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import { useCallback, useEffect, useMemo, useState } from "react";
import { useCallback, useMemo } from "react";
import { useSearchParams } from "react-router-dom";
import { Artifact, Task } from "workflows-lib";
import { isWorkflowWithTasks } from "../utils/coreUtils";
import { useFragment } from "react-relay";
import { WorkflowTasksFragment } from "../graphql/WorkflowTasksFragment";
import { WorkflowTasksFragment$key } from "../graphql/__generated__/WorkflowTasksFragment.graphql";
import {
WorkflowTasksFragment$data,
WorkflowTasksFragment$key,
} from "../graphql/__generated__/WorkflowTasksFragment.graphql";
import { JSONObject } from "workflows-lib";
import { SubmissionFormParametersFragment$data } from "../components/__generated__/SubmissionFormParametersFragment.graphql";

Expand Down Expand Up @@ -53,32 +56,37 @@ export function useSelectedTaskIds(): [string[], (tasks: string[]) => void] {
return [selectedTaskIds, setSelectedTaskIds];
}

function setFetchedTasks(data: WorkflowTasksFragment$data): Task[] {
if (data.status && isWorkflowWithTasks(data.status)) {
return data.status.tasks.map((task: Task) => ({
id: task.id,
name: task.name,
status: task.status,
depends: [...(task.depends ?? [])],
artifacts: task.artifacts.map((artifact: Artifact) => ({
...artifact,
parentTask: task.name,
parentTaskId: task.id,
key: `${task.id}-${artifact.name}`,
})),
workflow: data.name,
instrumentSession: data.visit,
stepType: task.stepType,
}));
}
return [];
}

export function useFetchedTasks(
fragmentRef: WorkflowTasksFragment$key | null,
): Task[] {
const [fetchedTasks, setFetchedTasks] = useState<Task[]>([]);
const data = useFragment(WorkflowTasksFragment, fragmentRef);

useEffect(() => {
if (data && data.status && isWorkflowWithTasks(data.status)) {
setFetchedTasks(
data.status.tasks.map((task: Task) => ({
id: task.id,
name: task.name,
status: task.status,
depends: [...(task.depends ?? [])],
artifacts: task.artifacts.map((artifact: Artifact) => ({
...artifact,
parentTask: task.name,
parentTaskId: task.id,
key: `${task.id}-${artifact.name}`,
})),
workflow: data.name,
instrumentSession: data.visit,
stepType: task.stepType,
})),
);
const fetchedTasks: Task[] = useMemo(() => {
if (data == null) {
return [];
}
return setFetchedTasks(data);
}, [data]);

return fetchedTasks;
Expand Down
46 changes: 22 additions & 24 deletions frontend/relay-workflows-lib/lib/views/BaseSingleWorkflowView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,33 @@ export default function BaseSingleWorkflowView({
taskIds,
fragmentRef,
}: BaseSingleWorkflowViewProps) {
const [artifactList, setArtifactList] = useState<Artifact[]>([]);
const [outputTaskIds, setOutputTaskIds] = useState<string[]>([]);
const data = useFragment(BaseSingleWorkflowViewFragment, fragmentRef);
const fetchedTasks = useFetchedTasks(data ?? null);
const [selectedTaskIds, setSelectedTaskIds] = useSelectedTaskIds();
const [filledTaskId, setFilledTaskId] = useState<string | null>(null);

const taskTree = useMemo(() => buildTaskTree(fetchedTasks), [fetchedTasks]);

const outputTaskIds: string[] = useMemo(() => {
const newOutputTaskIds: string[] = [];
const traverse = (tasks: TaskNode[]) => {
const sortedTasks = [...tasks].sort((a, b) => a.id.localeCompare(b.id));
sortedTasks.forEach((taskNode) => {
if (
taskNode.children &&
taskNode.children.length === 0 &&
!newOutputTaskIds.includes(taskNode.id)
) {
newOutputTaskIds.push(taskNode.id);
} else if (taskNode.children && taskNode.children.length > 0) {
traverse(taskNode.children);
}
});
};
traverse(taskTree);
return newOutputTaskIds;
}, [taskTree]);

const handleSelectOutput = () => {
setSelectedTaskIds(outputTaskIds);
};
Expand All @@ -62,35 +80,15 @@ export default function BaseSingleWorkflowView({
setSelectedTaskIds(taskIds ?? []);
}, [taskIds, setSelectedTaskIds]);

useEffect(() => {
const artifactList: Artifact[] = useMemo(() => {
const filteredTasks = selectedTaskIds.length
? selectedTaskIds
.map((id) => fetchedTasks.find((task) => task.id === id))
.filter((task): task is Task => !!task)
: fetchedTasks;
setArtifactList(filteredTasks.flatMap((task) => task.artifacts));
return filteredTasks.flatMap((task) => task.artifacts);
}, [selectedTaskIds, fetchedTasks]);

useEffect(() => {
const newOutputTaskIds: string[] = [];
const traverse = (tasks: TaskNode[]) => {
const sortedTasks = [...tasks].sort((a, b) => a.id.localeCompare(b.id));
sortedTasks.forEach((taskNode) => {
if (
taskNode.children &&
taskNode.children.length === 0 &&
!newOutputTaskIds.includes(taskNode.id)
) {
newOutputTaskIds.push(taskNode.id);
} else if (taskNode.children && taskNode.children.length > 0) {
traverse(taskNode.children);
}
});
};
traverse(taskTree);
setOutputTaskIds(newOutputTaskIds);
}, [taskTree]);

if (!data || !data.status) {
return null;
}
Expand Down
10 changes: 7 additions & 3 deletions frontend/relay-workflows-lib/lib/views/WorkflowsListView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,14 @@ const WorkflowsListView: React.FC<WorkflowsListViewProps> = ({
{ fetchPolicy: "store-and-network" },
);

const [isPaginated, setIsPaginated] = useState(false);
const isPaginated = useRef(false);
Copy link
Contributor

@JamesDoingStuff JamesDoingStuff Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm struggling to understand the whole pagination system, but I'm not sure that this can just be substituted like this - previously, the state and its setter got passed down to the WorkflowsContent and it got changed from there, but now I think the isPaginated.current value would only be passed down when the component renders and any changes to isPaginatedRef in the WorkflowsContent won't be seen back here. This seems to start false, get set to true in the useEffect, then have no way of changing back.

I had a bit of a play around with this in the browser and I didn't see any faulty behaviour, so it's possible that the dependencies and re-rendering of components happens to make this irrelevant, but I do think this could use a bit of a closer look. Sorry I can't be any more specific than that...

Copy link
Contributor Author

@TBThomas56 TBThomas56 Dec 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I agree with this. Have added a callback to allow the bi-directional data flow

const lastPage = useRef(currentPage);
const lastLimit = useRef(selectedLimit);

const setIsPaginated = useCallback((value: boolean) => {
isPaginated.current = value;
}, []);

const load = useCallback(() => {
if (visit) {
loadQuery(
Expand All @@ -98,7 +102,7 @@ const WorkflowsListView: React.FC<WorkflowsListViewProps> = ({
currentPage !== lastPage.current ||
selectedLimit !== lastLimit.current
) {
setIsPaginated(true);
isPaginated.current = true;
lastPage.current = currentPage;
lastLimit.current = selectedLimit;
}
Expand Down Expand Up @@ -154,7 +158,7 @@ const WorkflowsListView: React.FC<WorkflowsListViewProps> = ({
onPageChange={goToPage}
onLimitChange={changeLimit}
updatePageInfo={updatePageInfo}
isPaginated={isPaginated}
isPaginated={isPaginated.current}
setIsPaginated={setIsPaginated}
/>
</Suspense>
Expand Down
1 change: 0 additions & 1 deletion frontend/relay-workflows-lib/stories/components/WorkflowsContent.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,5 @@ export const Default: Story = {
onPageChange: () => {},
onLimitChange: () => {},
updatePageInfo: () => {},
setIsPaginated: () => {},
},
};
4 changes: 2 additions & 2 deletions frontend/relay-workflows-lib/tests/components/BaseWorkflowRelay.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ describe("BaseWorkflowRelay", () => {
expect(screen.queryByText("even")).not.toBeVisible();

await user.click(accordionButton);

expect(accordionButton).toHaveAttribute("aria-expanded", "true");
expect(screen.getByText("even")).toBeVisible();
expect(screen.getByText("React Flow")).toBeVisible();
expect(screen.getByText("even")).toBeInTheDocument();
Comment on lines +82 to +83
Copy link
Contributor

@JamesDoingStuff JamesDoingStuff Dec 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will just point out this, as it's something Thomas and I changed to get the test passing, but maybe we shouldn't have: the even node always counts as being in the document, regardless of whether the accordion is expanded or not, thus making this check redundant. I've tried getting it to work with toBeVisible again but no luck.
Perhaps we should change the test to something like this, just to make it a bit less misleading?

  it("should contain a Flow with job nodes", async () => {
    const accordionButton = await screen.findByRole("button", {
      name: /conditional-steps-first/i,
    });
    expect(accordionButton).toHaveAttribute("aria-expanded", "false");
    expect(screen.getByText("React Flow")).not.toBeVisible();
    expect(screen.getByText("even")).toBeInTheDocument();

    await user.click(accordionButton);
    expect(accordionButton).toHaveAttribute("aria-expanded", "true");
    expect(screen.getByText("React Flow")).toBeVisible();
  });

The above also seems to work without the hacky script I introduced in relay-workflows-lib/tests/mocks/mockReactFlow.ts, so that could be binned

});
});
4 changes: 2 additions & 2 deletions frontend/relay-workflows-lib/tests/components/TasksFlow.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ describe("TasksFlow Component", () => {
nodes: mockLayoutedNodes,
edges: mockLayoutedEdges,
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
nodeTypes: expect.objectContaining({ custom: expect.any(Function) }),
nodeTypes: { custom: expect.any(Function) },
nodesDraggable: false,
nodesConnectable: false,
elementsSelectable: true,
Expand All @@ -121,7 +121,7 @@ describe("TasksFlow Component", () => {
zoomOnDoubleClick: false,
panOnDrag: true,
preventScrolling: false,
fitView: false,
fitView: true,
style: { width: "100%", overflow: "auto", height: "100%" },
}),
{},
Expand Down
3 changes: 2 additions & 1 deletion frontend/workflows-lib/lib/components/common/PaginationControls.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,12 @@ export default function PaginationControls({
boundaryCount={0}
/>
<FormControl sx={{ width: 80 }}>
<InputLabel id="workflows-limit-label">Workflows Limit</InputLabel>
<InputLabel id="workflows-limit-label">Limit</InputLabel>
<Select
labelId="workflows-limit-label"
id="workflows-limit-select"
size="small"
label="Limit"
value={selectedLimit.toString()}
onChange={(e) => {
onLimitChange(Number(e.target.value));
Expand Down
Loading