The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import { render } from "@testing-library/react";
import _ from "underscore";
import { getStore } from "__support__/entities-store";
import {
type StoreSeedState,
createMockState,
seedApiQueryCache,
} from "__support__/state";
import { ComponentProviderInternal } from "embedding-sdk-bundle/components/public/ComponentProvider";
import { sdkReducers } from "embedding-sdk-bundle/store";
import { sdkListenerMiddleware } from "embedding-sdk-bundle/store/listener-middleware";
import type { SdkStore } from "embedding-sdk-bundle/store/types";
import { createMockSdkState } from "embedding-sdk-bundle/test/mocks/state";
import type { MetabaseProviderProps } from "embedding-sdk-bundle/types/metabase-provider";
import { ensureMetabaseProviderPropsStore } from "embedding-sdk-shared/lib/ensure-metabase-provider-props-store";
import { Api } from "metabase/api";
import { MetabaseReduxProvider } from "metabase/redux";
import type { MantineThemeOverride } from "metabase/ui";
import { ThemeProviderContext } from "metabase/ui/components/theme/ThemeProvider/context";
export interface RenderWithSDKProvidersOptions {
storeInitialState?: Partial<StoreSeedState>;
componentProviderProps?: Partial<MetabaseProviderProps> | null;
theme?: MantineThemeOverride;
// Needed for Components/Hooks that retrieve Component/Hooks from the window.METABASE_EMBEDDING_SDK_BUNDLE
metabaseEmbeddingSdkBundleExports?: Partial<
typeof window.METABASE_EMBEDDING_SDK_BUNDLE
>;
}
export function renderWithSDKProviders(
ui: React.ReactElement,
{
storeInitialState = {},
componentProviderProps = null,
theme,
metabaseEmbeddingSdkBundleExports,
...options
}: RenderWithSDKProvidersOptions = {},
) {
// `settings` and the current user are served from the `getSessionProperties`
// and `getCurrentUser` RTK Query caches rather than redux slices.
// Settings are captured here and seeded through `preloadedState` below.
// The user entry is seeded by `createMockState` itself.
let { settings: seededSettings, ...initialState }: Partial<StoreSeedState> =
createMockState(storeInitialState);
const sdkReducerNames = Object.keys(sdkReducers);
initialState = _.pick(
{ sdk: createMockSdkState(), ...initialState },
...sdkReducerNames,
);
// Enable the embedding_sdk premium feature and settings by default in SDK tests, unless explicitly disabled.
// Without this, SDK components will not render due to missing token features and settings.
if (!storeInitialState.settings && seededSettings) {
seededSettings.values["token-features"].embedding_sdk = true;
seededSettings.values["enable-embedding-sdk"] = true;
}
if (seededSettings?.values) {
initialState = {
...initialState,
[Api.reducerPath]: seedApiQueryCache(initialState[Api.reducerPath], [
{
endpointName: "getSessionProperties",
value: seededSettings.values,
},
]),
};
}
// Same middleware as the real SDK store
const storeMiddleware = [Api.middleware, sdkListenerMiddleware.middleware];
// Unjustified type cast. FIXME
const store = getStore(
sdkReducers,
initialState,
storeMiddleware,
) as unknown as SdkStore;
// Prevent spamming the console during tests
if (componentProviderProps) {
componentProviderProps.allowConsoleLog = false;
}
if (metabaseEmbeddingSdkBundleExports) {
window.METABASE_EMBEDDING_SDK_BUNDLE =
// Unjustified type cast. FIXME
metabaseEmbeddingSdkBundleExports as typeof window.METABASE_EMBEDDING_SDK_BUNDLE;
ensureMetabaseProviderPropsStore().updateInternalProps({
reduxStore: store,
});
}
const wrapper = (props: any) => {
return (
<MetabaseReduxProvider store={store}>
{/* If we try to inject CSS variables to `.mb-wrapper`, it will slow the Jest tests down like crazy. */}
<ThemeProviderContext.Provider value={{ withCssVariables: false }}>
<ComponentProviderInternal
{...props}
{...componentProviderProps}
reduxStore={store}
/>
</ThemeProviderContext.Provider>
</MetabaseReduxProvider>
);
};
const utils = render(ui, {
wrapper,
...options,
});
return {
...utils,
store,
history,
};
}