Skip to content

Commit 64f5bb6

Browse files
committed
console: Fix second loading spinner on the cluster list
On a cold load the cluster list showed its spinner, rendered the rows once the clusters SUBSCRIBE snapshot arrived, and then replaced them with a second spinner. Each row's closed overflow menu mounts AlterClusterMenuItem, whose cluster sizes query was a useSuspenseQuery, so the first render of the rows suspended to the page's Suspense fallback until the sizes returned. The menu item now reads the sizes with useQuery on a shared availableClusterSizesQuery and stays disabled until they load. The new cluster form and the new replica modal still read them with useSuspenseQuery. Closes: CNS-192
1 parent ba2062a commit 64f5bb6

5 files changed

Lines changed: 93 additions & 19 deletions

File tree

‎console/src/platform/clusters/AlterClusterMenuItem.tsx‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,30 @@
88
// by the Apache License, Version 2.0.
99

1010
import { MenuItem, useDisclosure } from "@chakra-ui/react";
11+
import { useQuery } from "@tanstack/react-query";
1112
import React from "react";
1213

1314
import { Cluster } from "~/api/materialize/cluster/clusterList";
1415

1516
import { AlterClusterModal } from "./AlterClusterModal";
16-
import { useAvailableClusterSizes, useMaxReplicasPerCluster } from "./queries";
17+
import {
18+
availableClusterSizesQuery,
19+
useMaxReplicasPerCluster,
20+
} from "./queries";
1721

1822
const AlterClusterMenuItem = ({ cluster }: { cluster: Cluster }) => {
19-
const { data: clusterSizes } = useAvailableClusterSizes();
23+
// NOTE: this mounts while its overflow menu is closed, in cluster list rows
24+
// and the cluster detail header. Suspending would swap the page it renders
25+
// in for that page's Suspense fallback.
26+
const { data: clusterSizes } = useQuery(availableClusterSizesQuery());
2027
const { data: maxReplicas } = useMaxReplicasPerCluster();
2128

2229
const { isOpen, onOpen, onClose } = useDisclosure();
2330

2431
return (
2532
<>
2633
<MenuItem
34+
isDisabled={!clusterSizes}
2735
onClick={(e) => {
2836
e.stopPropagation();
2937
onOpen();

‎console/src/platform/clusters/ClustersList.test.tsx‎

Lines changed: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,24 @@ import { useLocation } from "react-router-dom";
1414

1515
import { Cluster, Replica } from "~/api/materialize/cluster/clusterList";
1616
import { ReplicaUtilization } from "~/api/materialize/cluster/replicaUtilization";
17+
import { buildSqlQueryHandlerV2 } from "~/api/mocks/buildSqlQueryHandler";
18+
import server from "~/api/mocks/server";
1719
import { uiPreviewOptInStorageKey } from "~/hooks/useUiPreview";
1820
import { getStore } from "~/jotai";
1921
import { allClusters } from "~/store/allClusters";
2022
import { mockSubscribeState } from "~/test/mockSubscribe";
21-
import { renderComponent, RenderWithPathname } from "~/test/utils";
23+
import {
24+
MSW_HANDLER_LOADING_WAIT_TIME,
25+
renderComponent,
26+
RenderWithPathname,
27+
} from "~/test/utils";
2228
import {
2329
formatDate,
2430
FRIENDLY_DATETIME_FORMAT_NO_SECONDS,
2531
} from "~/utils/dateFormat";
2632

2733
import ClustersListPage from "./ClustersList";
28-
import { ReplicaHydrationCounts } from "./queries";
34+
import { clusterQueryKeys, ReplicaHydrationCounts } from "./queries";
2935

3036
// The per-replica table is a UI preview: its flag must be on AND the user
3137
// opted in (seeded into localStorage below). The global useFlags mock in
@@ -422,6 +428,64 @@ describe("ClustersList preview gating", () => {
422428
});
423429
});
424430

431+
describe("ClustersList cluster sizes for the alter menu", () => {
432+
const holdClusterSizes = () =>
433+
server.use(
434+
buildSqlQueryHandlerV2(
435+
{ queryKey: clusterQueryKeys.availableClusterSizes(), results: [] },
436+
{ waitTimeMs: MSW_HANDLER_LOADING_WAIT_TIME },
437+
),
438+
);
439+
440+
it("shows the per-replica rows while the sizes load", async () => {
441+
holdClusterSizes();
442+
await renderClustersList([buildCluster()]);
443+
444+
expect(rowOrder()).toEqual(["r1", "r2"]);
445+
});
446+
447+
it("shows the classic table's rows while the sizes load", async () => {
448+
holdClusterSizes();
449+
localStorage.removeItem(
450+
uiPreviewOptInStorageKey("clusterListUsageMetrics"),
451+
);
452+
await renderClustersList([buildCluster()]);
453+
454+
expect(
455+
screen.getByRole("columnheader", { name: "Replicas" }),
456+
).toBeVisible();
457+
expect(screen.getByText("compute")).toBeVisible();
458+
});
459+
460+
it("disables Alter cluster while the sizes load", async () => {
461+
holdClusterSizes();
462+
const user = userEvent.setup();
463+
await renderClustersList([buildCluster()]);
464+
465+
await user.click(
466+
screen.getAllByRole("button", { name: "More actions" })[0],
467+
);
468+
469+
expect(
470+
await screen.findByRole("menuitem", { name: "Alter cluster" }),
471+
).toBeDisabled();
472+
});
473+
474+
it("enables Alter cluster once the sizes load", async () => {
475+
const user = userEvent.setup();
476+
await renderClustersList([buildCluster()]);
477+
478+
await user.click(
479+
screen.getAllByRole("button", { name: "More actions" })[0],
480+
);
481+
482+
const alterCluster = await screen.findByRole("menuitem", {
483+
name: "Alter cluster",
484+
});
485+
await waitFor(() => expect(alterCluster).toBeEnabled());
486+
});
487+
});
488+
425489
describe("ClustersList replica rows", () => {
426490
it("renders one row per replica, naming the cluster on each", async () => {
427491
await renderClustersList([buildCluster()]);

‎console/src/platform/clusters/NewClusterForm.tsx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import {
1616
useTheme,
1717
VStack,
1818
} from "@chakra-ui/react";
19+
import { useSuspenseQuery } from "@tanstack/react-query";
1920
import { sql } from "kysely";
2021
import React from "react";
2122
import { useForm } from "react-hook-form";
@@ -49,7 +50,7 @@ import { MaterializeTheme } from "~/theme";
4950
import { assert, capitalizeSentence } from "~/util";
5051

5152
import {
52-
useAvailableClusterSizes,
53+
availableClusterSizesQuery,
5354
useClusters,
5455
useMaxReplicasPerCluster,
5556
} from "./queries";
@@ -72,7 +73,7 @@ const NewClusterForm = () => {
7273
const { colors } = useTheme<MaterializeTheme>();
7374
const { track } = useSegment();
7475

75-
const { data: clusterSizes } = useAvailableClusterSizes();
76+
const { data: clusterSizes } = useSuspenseQuery(availableClusterSizesQuery());
7677
const { data: maxReplicas } = useMaxReplicasPerCluster();
7778

7879
const { formState, handleSubmit, register, setError, setFocus } =

‎console/src/platform/clusters/NewReplicaModal.tsx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import {
2323
useTheme,
2424
VStack,
2525
} from "@chakra-ui/react";
26+
import { useSuspenseQuery } from "@tanstack/react-query";
2627
import React from "react";
2728
import { useForm } from "react-hook-form";
2829

@@ -40,7 +41,7 @@ import { useToast } from "~/hooks/useToast";
4041
import docUrls from "~/mz-doc-urls.json";
4142
import { MaterializeTheme } from "~/theme";
4243

43-
import { useAvailableClusterSizes } from "./queries";
44+
import { availableClusterSizesQuery } from "./queries";
4445

4546
type FormState = {
4647
name: string;
@@ -72,7 +73,7 @@ const NewReplicaForm = ({
7273
mode: "onTouched",
7374
});
7475

75-
const { data: clusterSizes } = useAvailableClusterSizes();
76+
const { data: clusterSizes } = useSuspenseQuery(availableClusterSizesQuery());
7677
const { runSql: createReplica, loading: isCreationInFlight } = useSqlLazy({
7778
queryBuilder: (values: FormState & { clusterName: string }) => {
7879
const compiledStatement =

‎console/src/platform/clusters/queries.ts‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
import {
1111
keepPreviousData,
12+
QueryFunctionContext,
1213
useMutation,
1314
useQuery,
1415
useQueryClient,
@@ -552,17 +553,16 @@ export function useLargestMaintainedQueries(
552553
});
553554
}
554555

555-
export function useAvailableClusterSizes() {
556-
return useSuspenseQuery({
557-
queryKey: clusterQueryKeys.availableClusterSizes(),
558-
queryFn: ({ queryKey, signal }) => {
559-
return fetchAvailableClusterSizes({
560-
queryKey,
561-
requestOptions: { signal },
562-
});
563-
},
564-
});
565-
}
556+
/** Query options for the replica sizes the environment offers. */
557+
export const availableClusterSizesQuery = () => ({
558+
queryKey: clusterQueryKeys.availableClusterSizes(),
559+
queryFn: ({ queryKey, signal }: QueryFunctionContext) => {
560+
return fetchAvailableClusterSizes({
561+
queryKey,
562+
requestOptions: { signal },
563+
});
564+
},
565+
});
566566

567567
export function useMaxReplicasPerCluster() {
568568
return useQuery({

0 commit comments

Comments
 (0)