Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UI v2] feat: Adds task run columns to flow run data table #17200

Merged
merged 1 commit into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,44 @@ import {
routerDecorator,
toastDecorator,
} from "@/storybook/utils";
import { faker } from "@faker-js/faker";
import { buildApiUrl } from "@tests/utils/handlers";
import { http, HttpResponse } from "msw";
import { FlowRunsDataTable } from "./data-table";

const MOCK_DATA = Array.from(
{ length: 5 },
createFakeFlowRunWithDeploymentAndFlow,
);
const MOCK_DATA = [
createFakeFlowRunWithDeploymentAndFlow({
id: "0",
state: { type: "SCHEDULED", id: "0" },
}),
createFakeFlowRunWithDeploymentAndFlow({ id: "1" }),
createFakeFlowRunWithDeploymentAndFlow({ id: "2" }),
createFakeFlowRunWithDeploymentAndFlow({ id: "3" }),
createFakeFlowRunWithDeploymentAndFlow({ id: "4" }),
];

const MOCK_FLOW_RUNS_TASK_COUNT = {
"0": faker.number.int({ min: 0, max: 5 }),
"1": faker.number.int({ min: 0, max: 5 }),
"2": faker.number.int({ min: 0, max: 5 }),
"3": faker.number.int({ min: 0, max: 5 }),
"4": faker.number.int({ min: 0, max: 5 }),
};

const meta: Meta<typeof FlowRunsDataTable> = {
title: "Components/FlowRuns/DataTable/FlowRunsDataTable",
decorators: [routerDecorator, reactQueryDecorator, toastDecorator],
args: { flowRuns: MOCK_DATA, flowRunsCount: MOCK_DATA.length },
component: FlowRunsDataTable,
parameters: {
msw: {
handlers: [
http.post(buildApiUrl("/ui/flow_runs/count-task-runs"), () => {
return HttpResponse.json(MOCK_FLOW_RUNS_TASK_COUNT);
}),
],
},
},
};
export default meta;

Expand Down
25 changes: 22 additions & 3 deletions ui-v2/src/components/flow-runs/data-table/data-table.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ import {
getPaginationRowModel,
useReactTable,
} from "@tanstack/react-table";
import { useMemo, useState } from "react";
import { Suspense, useMemo, useState } from "react";

import { Flow } from "@/api/flows";
import { Checkbox } from "@/components/ui/checkbox";
import { DeleteConfirmationDialog } from "@/components/ui/delete-confirmation-dialog";
import { Icon } from "@/components/ui/icons";
import { Skeleton } from "@/components/ui/skeleton";
import { Typography } from "@/components/ui/typography";
import { pluralize } from "@/utils";
import { CheckedState } from "@radix-ui/react-checkbox";
Expand All @@ -33,10 +34,12 @@ import { RunNameSearch } from "./run-name-search";
import { SortFilter } from "./sort-filter";
import { StartTimeCell } from "./start-time-cell";
import { StateFilter } from "./state-filter";
import { TasksCell } from "./tasks-cell";
import { useDeleteFlowRunsDialog } from "./use-delete-flow-runs-dialog";

export type FlowRunsDataTableRow = FlowRun & {
flow: Flow;
numTaskRuns?: number;
deployment?: Deployment;
};

Expand Down Expand Up @@ -79,7 +82,7 @@ const createColumns = ({
enableHiding: false,
}),
columnHelper.display({
size: 200,
size: 320,
id: "name",
header: "Name",
cell: ({ row }) => <NameCell flowRun={row.original} />,
Expand Down Expand Up @@ -116,7 +119,23 @@ const createColumns = ({
return <DurationCell flowRun={flowRun} />;
},
}),

columnHelper.display({
size: 200,
id: "taskRuns",
header: "Task Runs",
cell: ({ row }) => {
const flowRun = row.original;
if (flowRun.state?.type === "SCHEDULED") {
return null;
}
// nb: Defer data loading since this column is not guaranteed
return (
<Suspense fallback={<Skeleton className="p-4 h-2 w-full" />}>
<TasksCell flowRun={flowRun} />
</Suspense>
);
},
}),
columnHelper.accessor("tags", {
id: "tags",
header: "Tags",
Expand Down
39 changes: 39 additions & 0 deletions ui-v2/src/components/flow-runs/data-table/tasks-cell.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import {
type FlowRunWithDeploymentAndFlow,
type FlowRunWithFlow,
} from "@/api/flow-runs";
import { buildGetFlowRusTaskRunsCountQuery } from "@/api/task-runs";
import { Icon } from "@/components/ui/icons";

import { Typography } from "@/components/ui/typography";
import { pluralize } from "@/utils";
import { useSuspenseQuery } from "@tanstack/react-query";
import clsx from "clsx";

type TasksCellsProp = {
flowRun: FlowRunWithFlow | FlowRunWithDeploymentAndFlow;
};

export const TasksCell = ({ flowRun }: TasksCellsProp) => {
const { data } = useSuspenseQuery(
buildGetFlowRusTaskRunsCountQuery([flowRun.id]),
);

const taskRunsCount = data[flowRun.id];

if (taskRunsCount === undefined) {
return null;
}

return (
<div className="flex items-center gap-2">
<Icon id="Spline" />
<Typography
variant="bodySmall"
className={clsx(taskRunsCount === 0 && "text-muted-foreground")}
>
{taskRunsCount} {pluralize(taskRunsCount, "Task run")}
</Typography>
</div>
);
};
2 changes: 2 additions & 0 deletions ui-v2/src/components/ui/icons/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import {
Search,
ServerCrash,
SlidersVertical,
Spline,
Sun,
Trash2,
Variable,
Expand Down Expand Up @@ -77,6 +78,7 @@ export const ICONS = {
Search,
ServerCrash,
SlidersVertical,
Spline,
Sun,
Trash2,
Variable,
Expand Down
19 changes: 10 additions & 9 deletions ui-v2/src/mocks/create-fake-flow-run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,14 @@ export const createFakeFlowRun = (
};
};

export const createFakeFlowRunWithDeploymentAndFlow =
(): FlowRunWithDeploymentAndFlow => {
const flowRun = createFakeFlowRun();

return {
...flowRun,
deployment: createFakeDeployment(),
flow: createFakeFlow(),
};
export const createFakeFlowRunWithDeploymentAndFlow = (
overrides?: Partial<components["schemas"]["FlowRun"]>,
): FlowRunWithDeploymentAndFlow => {
const flowRun = createFakeFlowRun();
return {
...flowRun,
deployment: createFakeDeployment(),
flow: createFakeFlow(),
...overrides,
};
};
Loading