Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

SDK loaderComponent now applies to all loaders (#66646)

Sébastienb2a256c792bb
diff --git a/frontend/src/embedding-sdk-bundle/components/private/PublicComponentWrapper/SdkLoader.tsx b/frontend/src/embedding-sdk-bundle/components/private/PublicComponentWrapper/SdkLoader.tsx
index 8022f2c9e4f..7260ce38dce 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/PublicComponentWrapper/SdkLoader.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/PublicComponentWrapper/SdkLoader.tsx
@@ -1,16 +1,10 @@
-import { useSdkSelector } from "embedding-sdk-bundle/store";
-import { getLoaderComponent } from "embedding-sdk-bundle/store/selectors";
import type { CommonStylingProps } from "embedding-sdk-bundle/types/props";
import { Center, Loader } from "metabase/ui";
export const SdkLoader = ({ className, style }: CommonStylingProps) => {
- const CustomLoader = useSdkSelector(getLoaderComponent);
-
- const LoaderComponent = CustomLoader || Loader;
-
return (
<Center className={className} style={style} h="100%" w="100%" mx="auto">
- <LoaderComponent data-testid="loading-indicator" />
+ <Loader data-testid="loading-indicator" />
</Center>
);
};
diff --git a/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx b/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx
index 0b2b1e59a60..d2e25f253aa 100644
--- a/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx
@@ -5,12 +5,12 @@ import { type JSX, memo, useEffect, useId, useRef } from "react";
import { SdkThemeProvider } from "embedding-sdk-bundle/components/private/SdkThemeProvider";
import { useInitDataInternal } from "embedding-sdk-bundle/hooks/private/use-init-data";
import { useNormalizeComponentProviderProps } from "embedding-sdk-bundle/hooks/private/use-normalize-component-provider-props";
+import { useSdkCustomLoader } from "embedding-sdk-bundle/hooks/private/use-sdk-custom-loader";
import { getSdkStore } from "embedding-sdk-bundle/store";
import {
setErrorComponent,
setEventHandlers,
setIsGuestEmbed,
- setLoaderComponent,
setPlugins,
} from "embedding-sdk-bundle/store/reducer";
import type { SdkStore } from "embedding-sdk-bundle/store/types";
@@ -64,7 +64,6 @@ export const ComponentProviderInternal = (
reduxStore,
locale,
errorComponent,
- loaderComponent,
allowConsoleLog,
isLocalHost,
} = useNormalizeComponentProviderProps(props);
@@ -85,6 +84,8 @@ export const ComponentProviderInternal = (
useInitPlugins();
+ useSdkCustomLoader();
+
useEffect(() => {
reduxStore.dispatch(setIsGuestEmbed(!!isGuestEmbed));
}, [reduxStore, isGuestEmbed]);
@@ -103,10 +104,6 @@ export const ComponentProviderInternal = (
reduxStore.dispatch(setEventHandlers(eventHandlers || null));
}, [reduxStore, eventHandlers]);
- useEffect(() => {
- reduxStore.dispatch(setLoaderComponent(loaderComponent ?? null));
- }, [reduxStore, loaderComponent]);
-
useEffect(() => {
reduxStore.dispatch(setErrorComponent(errorComponent ?? null));
}, [reduxStore, errorComponent]);
diff --git a/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/index.ts b/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/index.ts
new file mode 100644
index 00000000000..ec74d1278b1
--- /dev/null
+++ b/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/index.ts
@@ -0,0 +1 @@
+export * from "./use-sdk-custom-loader";
diff --git a/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/use-sdk-custom-loader.ts b/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/use-sdk-custom-loader.ts
new file mode 100644
index 00000000000..8c220b4601f
--- /dev/null
+++ b/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/use-sdk-custom-loader.ts
@@ -0,0 +1,14 @@
+import { useEffect } from "react";
+
+import { useMetabaseProviderPropsStore } from "embedding-sdk-shared/hooks/use-metabase-provider-props-store";
+import { setCustomLoader } from "metabase/ui/components/feedback/Loader/Loader";
+
+export function useSdkCustomLoader() {
+ const {
+ state: { props: metabaseProviderProps },
+ } = useMetabaseProviderPropsStore();
+
+ useEffect(() => {
+ setCustomLoader(metabaseProviderProps?.loaderComponent);
+ }, [metabaseProviderProps?.loaderComponent]);
+}
diff --git a/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/use-sdk-custom-loader.unit.spec.tsx b/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/use-sdk-custom-loader.unit.spec.tsx
new file mode 100644
index 00000000000..b761820fb46
--- /dev/null
+++ b/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-custom-loader/use-sdk-custom-loader.unit.spec.tsx
@@ -0,0 +1,146 @@
+import { renderHook } from "@testing-library/react";
+import type { ReactElement } from "react";
+
+import { useMetabaseProviderPropsStore } from "embedding-sdk-shared/hooks/use-metabase-provider-props-store";
+import { setCustomLoader } from "metabase/ui/components/feedback/Loader/Loader";
+
+import { useSdkCustomLoader } from "./use-sdk-custom-loader";
+
+jest.mock("embedding-sdk-shared/hooks/use-metabase-provider-props-store");
+jest.mock("metabase/ui/components/feedback/Loader/Loader", () => ({
+ setCustomLoader: jest.fn(),
+}));
+
+const mockUseMetabaseProviderPropsStore =
+ useMetabaseProviderPropsStore as jest.Mock;
+const mockSetCustomLoader = setCustomLoader as jest.Mock;
+
+const MockLoaderComponent = () => <div>Custom Loader</div>;
+
+const createMockStore = (loaderComponent?: () => ReactElement) => ({
+ state: {
+ props: {
+ loaderComponent,
+ },
+ },
+});
+
+describe("useSdkCustomLoader", () => {
+ beforeEach(() => {
+ jest.clearAllMocks();
+ });
+
+ it("calls setCustomLoader with undefined when no loader component is provided", () => {
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(undefined),
+ );
+
+ renderHook(() => useSdkCustomLoader());
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(undefined);
+ });
+
+ it("calls setCustomLoader with the loader component when provided", () => {
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(MockLoaderComponent),
+ );
+
+ renderHook(() => useSdkCustomLoader());
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(MockLoaderComponent);
+ });
+
+ it("calls setCustomLoader again when the loader component changes", () => {
+ // Start with no loader component
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(undefined),
+ );
+
+ const { rerender } = renderHook(() => useSdkCustomLoader());
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(undefined);
+ expect(mockSetCustomLoader).toHaveBeenCalledTimes(1);
+
+ // Change to a custom loader component
+ const AnotherLoaderComponent = () => <div>Another Custom Loader</div>;
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(AnotherLoaderComponent),
+ );
+ rerender();
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(AnotherLoaderComponent);
+ expect(mockSetCustomLoader).toHaveBeenCalledTimes(2);
+ });
+
+ it("does not call setCustomLoader again when props haven't changed", () => {
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(MockLoaderComponent),
+ );
+
+ const { rerender } = renderHook(() => useSdkCustomLoader());
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(MockLoaderComponent);
+
+ rerender();
+
+ // Should still be called only once since the loader component hasn't changed
+ expect(mockSetCustomLoader).toHaveBeenCalledTimes(1);
+ });
+
+ it("handles null metabase provider props gracefully", () => {
+ mockUseMetabaseProviderPropsStore.mockReturnValue({
+ state: {
+ props: null,
+ },
+ });
+
+ renderHook(() => useSdkCustomLoader());
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(undefined);
+ });
+
+ it("calls setCustomLoader when loader component changes from defined to undefined", () => {
+ // Start with a loader component
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(MockLoaderComponent),
+ );
+
+ const { rerender } = renderHook(() => useSdkCustomLoader());
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(MockLoaderComponent);
+ expect(mockSetCustomLoader).toHaveBeenCalledTimes(1);
+
+ // Change to no loader component
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(undefined),
+ );
+ rerender();
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(undefined);
+ expect(mockSetCustomLoader).toHaveBeenCalledTimes(2);
+ });
+
+ it("calls setCustomLoader when switching between different loader components", () => {
+ const FirstLoaderComponent = () => <div>First Loader</div>;
+ const SecondLoaderComponent = () => <div>Second Loader</div>;
+
+ // Start with first loader component
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(FirstLoaderComponent),
+ );
+
+ const { rerender } = renderHook(() => useSdkCustomLoader());
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(FirstLoaderComponent);
+ expect(mockSetCustomLoader).toHaveBeenCalledTimes(1);
+
+ // Switch to second loader component
+ mockUseMetabaseProviderPropsStore.mockReturnValue(
+ createMockStore(SecondLoaderComponent),
+ );
+ rerender();
+
+ expect(mockSetCustomLoader).toHaveBeenCalledWith(SecondLoaderComponent);
+ expect(mockSetCustomLoader).toHaveBeenCalledTimes(2);
+ });
+});
diff --git a/frontend/src/embedding-sdk-bundle/store/reducer.ts b/frontend/src/embedding-sdk-bundle/store/reducer.ts
index 313e6f4e270..a9e8b6eabb2 100644
--- a/frontend/src/embedding-sdk-bundle/store/reducer.ts
+++ b/frontend/src/embedding-sdk-bundle/store/reducer.ts
@@ -66,7 +66,6 @@ const initialState: SdkState = {
plugins: null,
eventHandlers: null,
usageProblem: null,
- loaderComponent: null,
errorComponent: null,
fetchRefreshTokenFn: null,
};
@@ -115,10 +114,6 @@ export const sdk = createReducer(initialState, (builder) => {
state.initStatus = { status: "error", error };
});
- builder.addCase(setLoaderComponent, (state, action) => {
- state.loaderComponent = action.payload;
- });
-
builder.addCase(setIsGuestEmbed, (state, action) => {
state.isGuestEmbed = action.payload;
});
diff --git a/frontend/src/embedding-sdk-bundle/store/selectors.ts b/frontend/src/embedding-sdk-bundle/store/selectors.ts
index 219c7ebd754..27b18b5badc 100644
--- a/frontend/src/embedding-sdk-bundle/store/selectors.ts
+++ b/frontend/src/embedding-sdk-bundle/store/selectors.ts
@@ -29,9 +29,6 @@ export const getEventHandlers = (state: SdkStoreState | State) =>
export const getUsageProblem = (state: SdkStoreState) => state.sdk.usageProblem;
-export const getLoaderComponent = (state: SdkStoreState) =>
- state.sdk.loaderComponent;
-
export const getErrorComponent = (state: SdkStoreState) =>
state.sdk.errorComponent;
diff --git a/frontend/src/embedding-sdk-bundle/store/types.ts b/frontend/src/embedding-sdk-bundle/store/types.ts
index d5417689b45..92fcd44e869 100644
--- a/frontend/src/embedding-sdk-bundle/store/types.ts
+++ b/frontend/src/embedding-sdk-bundle/store/types.ts
@@ -5,7 +5,6 @@ import type {
Store,
ThunkDispatch,
} from "@reduxjs/toolkit";
-import type { JSX } from "react";
import type { MetabaseAuthConfig } from "embedding-sdk-bundle/types/auth-config";
import type { SdkEventHandlersConfig } from "embedding-sdk-bundle/types/events";
@@ -41,7 +40,6 @@ export type SdkState = {
plugins: null | MetabasePluginsConfig;
eventHandlers: null | SdkEventHandlersConfig;
usageProblem: null | SdkUsageProblem;
- loaderComponent: null | (() => JSX.Element);
errorComponent: null | SdkErrorComponent;
fetchRefreshTokenFn: null | MetabaseAuthConfig["fetchRequestToken"];
};
diff --git a/frontend/src/embedding-sdk-bundle/test/mocks/state.ts b/frontend/src/embedding-sdk-bundle/test/mocks/state.ts
index 6afde43256e..56e23a4e732 100644
--- a/frontend/src/embedding-sdk-bundle/test/mocks/state.ts
+++ b/frontend/src/embedding-sdk-bundle/test/mocks/state.ts
@@ -35,7 +35,6 @@ export const createMockSdkState = ({
usageProblem: null,
plugins: {},
eventHandlers: {},
- loaderComponent: null,
errorComponent: null,
error: null,
fetchRefreshTokenFn: null,
diff --git a/frontend/src/embedding-sdk-bundle/types/metabase-provider.ts b/frontend/src/embedding-sdk-bundle/types/metabase-provider.ts
index 49bb4dc3a25..84ad39f5e21 100644
--- a/frontend/src/embedding-sdk-bundle/types/metabase-provider.ts
+++ b/frontend/src/embedding-sdk-bundle/types/metabase-provider.ts
@@ -1,4 +1,4 @@
-import type { JSX, ReactNode } from "react";
+import type { ReactNode } from "react";
import type { MetabaseTheme } from "metabase/embedding-sdk/theme";
@@ -52,8 +52,10 @@ export interface MetabaseProviderProps {
/**
* A custom loader component to display while the SDK is loading.
+ *
+ * The component receives an optional `label` prop that can be used to display a loading message.
**/
- loaderComponent?: () => JSX.Element;
+ loaderComponent?: React.ComponentType<{ label?: string }>;
/**
* A custom error component to display when the SDK encounters an error.
diff --git a/frontend/src/metabase/dashboard/components/Dashboard/Dashboard.tsx b/frontend/src/metabase/dashboard/components/Dashboard/Dashboard.tsx
index 4772650a1e0..3472989ecb0 100644
--- a/frontend/src/metabase/dashboard/components/Dashboard/Dashboard.tsx
+++ b/frontend/src/metabase/dashboard/components/Dashboard/Dashboard.tsx
@@ -13,7 +13,7 @@ import { useSelector } from "metabase/lib/redux";
import { FilterApplyToast } from "metabase/parameters/components/FilterApplyToast";
import EmbedFrameS from "metabase/public/components/EmbedFrame/EmbedFrame.module.css";
import { FullWidthContainer } from "metabase/styled-components/layout/FullWidthContainer";
-import { Box, Flex, Loader, Stack, Text } from "metabase/ui";
+import { Box, Flex, Loader } from "metabase/ui";
import type { DashboardCard } from "metabase-types/api";
import { DASHBOARD_PDF_EXPORT_ROOT_ID } from "../../constants";
@@ -53,12 +53,7 @@ const DashboardDefaultView = ({ className }: { className?: string }) => {
const dashboardHasCards = dashboard && dashboard.dashcards.length > 0;
if (!dashboard) {
- return (
- <Stack justify="center" align="center" gap="sm" mt="xl">
- <Loader size="lg" />
- <Text c="text-light" size="xl">{t`Loading…`}</Text>
- </Stack>
- );
+ return <Loader size="lg" label={t`Loading…`} />;
}
const isEmpty = !dashboardHasCards || (dashboardHasCards && !tabHasCards);
diff --git a/frontend/src/metabase/dashboard/components/Dashboard/components/Grid.tsx b/frontend/src/metabase/dashboard/components/Dashboard/components/Grid.tsx
index f407e60457e..5574aee133a 100644
--- a/frontend/src/metabase/dashboard/components/Dashboard/components/Grid.tsx
+++ b/frontend/src/metabase/dashboard/components/Dashboard/components/Grid.tsx
@@ -7,7 +7,7 @@ import {
canUserCreateNativeQueries,
canUserCreateQueries,
} from "metabase/selectors/user";
-import { Loader, Stack, Text } from "metabase/ui";
+import { Loader } from "metabase/ui";
import type { DashboardCard } from "metabase-types/api";
import {
@@ -72,12 +72,7 @@ export const Grid = ({
const isEmpty = !dashboardHasCards || (dashboardHasCards && !tabHasCards);
if (isLoadingWithoutCards) {
- return (
- <Stack justify="center" align="center" gap="sm" mt="xl">
- <Loader size="lg" />
- <Text c="text-light" size="xl">{t`Loading…`}</Text>
- </Stack>
- );
+ return <Loader size="lg" label={t`Loading…`} />;
}
if (isEmpty) {
diff --git a/frontend/src/metabase/nav/components/search/SearchResults/SearchResults.tsx b/frontend/src/metabase/nav/components/search/SearchResults/SearchResults.tsx
index a7fe1603bff..f3aeed8a9ff 100644
--- a/frontend/src/metabase/nav/components/search/SearchResults/SearchResults.tsx
+++ b/frontend/src/metabase/nav/components/search/SearchResults/SearchResults.tsx
@@ -22,7 +22,7 @@ import {
import { SearchResult } from "metabase/search/components/SearchResult/SearchResult";
import { SearchContextTypes } from "metabase/search/constants";
import type { SearchFilters } from "metabase/search/types";
-import { Loader, Stack, Text } from "metabase/ui";
+import { Loader } from "metabase/ui";
import type {
CollectionItem,
SearchModel,
@@ -51,12 +51,7 @@ export type SearchResultsProps = {
};
export const SearchLoadingSpinner = () => (
- <Stack p="xl" align="center">
- <Loader size="lg" data-testid="loading-indicator" />
- <Text size="xl" color="text-light">
- {t`Loading…`}
- </Text>
- </Stack>
+ <Loader size="lg" data-testid="loading-indicator" label={t`Loading…`} />
);
export const SearchResults = ({
diff --git a/frontend/src/metabase/ui/components/feedback/Loader/Loader.tsx b/frontend/src/metabase/ui/components/feedback/Loader/Loader.tsx
index 44319b98fd6..84164fa3795 100644
--- a/frontend/src/metabase/ui/components/feedback/Loader/Loader.tsx
+++ b/frontend/src/metabase/ui/components/feedback/Loader/Loader.tsx
@@ -1,5 +1,6 @@
-import type { LoaderProps } from "@mantine/core";
-import { Loader as MantineLoader, getSize } from "@mantine/core";
+import type { LoaderProps as MantineLoaderProps } from "@mantine/core";
+import { Loader as MantineLoader, Stack, Text, getSize } from "@mantine/core";
+import type React from "react";
const SIZES: Record<string, string> = {
xs: "1rem",
@@ -9,6 +10,31 @@ const SIZES: Record<string, string> = {
xl: "3.5rem",
};
-export const Loader = ({ size = "md", ...props }: LoaderProps) => (
- <MantineLoader {...props} size={getSize(SIZES[size])} />
-);
+interface LoaderProps extends MantineLoaderProps {
+ label?: string;
+}
+
+type CustomLoaderType = React.ComponentType<{ label?: string }> | undefined;
+
+let CustomLoader: CustomLoaderType;
+
+export const setCustomLoader = (component: CustomLoaderType) => {
+ CustomLoader = component;
+};
+
+export const Loader = ({ size = "md", label, ...props }: LoaderProps) => {
+ if (CustomLoader) {
+ return <CustomLoader label={label} />;
+ }
+
+ return label ? (
+ <Stack justify="center" align="center" gap="sm" mt="xl">
+ <MantineLoader {...props} size={getSize(SIZES[size])} />
+ <Text c="text-light" size="xl">
+ {label}
+ </Text>
+ </Stack>
+ ) : (
+ <MantineLoader {...props} size={getSize(SIZES[size])} />
+ );
+};
diff --git a/frontend/src/metabase/ui/components/feedback/Loader/Loader.unit.spec.tsx b/frontend/src/metabase/ui/components/feedback/Loader/Loader.unit.spec.tsx
new file mode 100644
index 00000000000..f970ba892e2
--- /dev/null
+++ b/frontend/src/metabase/ui/components/feedback/Loader/Loader.unit.spec.tsx
@@ -0,0 +1,54 @@
+import { MantineProvider } from "@mantine/core";
+import { render, screen } from "@testing-library/react";
+
+import { Loader, setCustomLoader } from "./Loader";
+
+const renderWithProvider = (component: React.ReactElement) => {
+ return render(<MantineProvider>{component}</MantineProvider>);
+};
+
+describe("Loader", () => {
+ beforeEach(() => {
+ setCustomLoader(undefined);
+ });
+
+ it("renders default Mantine Loader when no custom loader is set", () => {
+ renderWithProvider(<Loader data-testid="loader" />);
+
+ const loader = screen.getByTestId("loader");
+ expect(loader).toBeInTheDocument();
+ expect(loader).toHaveClass("mantine-Loader-root");
+ });
+
+ it("renders custom loader when one is set", () => {
+ const CustomLoader = () => (
+ <div data-testid="custom-loader">Custom Loader</div>
+ );
+
+ setCustomLoader(CustomLoader);
+ renderWithProvider(<Loader />);
+
+ expect(screen.getByTestId("custom-loader")).toBeInTheDocument();
+ expect(screen.queryByTestId("loader")).not.toBeInTheDocument();
+ });
+
+ it("switches back to default loader when custom loader is cleared", () => {
+ const CustomLoader = () => (
+ <div data-testid="custom-loader">Custom Loader</div>
+ );
+
+ setCustomLoader(CustomLoader);
+ const { rerender } = renderWithProvider(<Loader data-testid="loader" />);
+ expect(screen.getByTestId("custom-loader")).toBeInTheDocument();
+
+ setCustomLoader(undefined);
+ rerender(
+ <MantineProvider>
+ <Loader data-testid="loader" />
+ </MantineProvider>,
+ );
+
+ expect(screen.queryByTestId("custom-loader")).not.toBeInTheDocument();
+ expect(screen.getByTestId("loader")).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/ui/components/feedback/Loader/index.ts b/frontend/src/metabase/ui/components/feedback/Loader/index.ts
index 029c2b47f2e..b2165a8664c 100644
--- a/frontend/src/metabase/ui/components/feedback/Loader/index.ts
+++ b/frontend/src/metabase/ui/components/feedback/Loader/index.ts
@@ -1,2 +1,2 @@
-export { Loader } from "./Loader";
+export { Loader, setCustomLoader } from "./Loader";
export type { LoaderProps } from "@mantine/core";