Skip to content

fix: add type-safety for Storybook preview.jsx config file #14671

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

Merged
merged 3 commits into from
Sep 13, 2024
Merged

fix: add type-safety for Storybook preview.jsx config file #14671

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd63ccf
fix: add type-safety to Storybook preview.jsx file
Parkreiner Sep 13, 2024
e5d32ea
fix: add clarifying comments
Parkreiner Sep 13, 2024
b926775
fix: add type-safety to preview config
Parkreiner Sep 13, 2024
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
231 changes: 131 additions & 100 deletions site/.storybook/preview.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,124 +1,155 @@
// @ts-check
/**
* @file Defines the main configuration file for all of our Storybook tests.
* This file must be a JSX/JS file, but we can at least add some type safety via
* the ts-check directive.
* @see {@link https://storybook.js.org/docs/configure#configure-story-rendering}
*
* @typedef {import("react").ReactElement} ReactElement
* @typedef {import("react").PropsWithChildren} PropsWithChildren
* @typedef {import("react").FC<PropsWithChildren>} FC
*
* @typedef {import("@storybook/react").StoryContext} StoryContext
* @typedef {import("@storybook/react").Preview} Preview
*
* @typedef {(Story: FC, Context: StoryContext) => React.JSX.Element} Decorator A
* Storybook decorator function used to inject baseline data dependencies into
* our React components during testing.
*/
import { ThemeProvider as EmotionThemeProvider } from "@emotion/react";
import CssBaseline from "@mui/material/CssBaseline";
import {
StyledEngineProvider,
ThemeProvider as MuiThemeProvider,
ThemeProvider as MuiThemeProvider,
StyledEngineProvider,
} from "@mui/material/styles";
import { ThemeProvider as EmotionThemeProvider } from "@emotion/react";
import { DecoratorHelpers } from "@storybook/addon-themes";
import { withRouter } from "storybook-addon-remix-react-router";
import { StrictMode } from "react";
import { parseQueryArgs, QueryClient, QueryClientProvider } from "react-query";
import isChromatic from "chromatic/isChromatic";
import React, { StrictMode } from "react";
import { HelmetProvider } from "react-helmet-async";
import themes from "theme";
import { parseQueryArgs, QueryClient, QueryClientProvider } from "react-query";
import { withRouter } from "storybook-addon-remix-react-router";
import "theme/globalFonts";
import isChromatic from "chromatic/isChromatic";
import themes from "../src/theme";

DecoratorHelpers.initializeThemeState(Object.keys(themes), "dark");

export const decorators = [
withRouter,
withQuery,
(Story) => {
return (
<HelmetProvider>
<Story />
</HelmetProvider>
);
},
(Story, context) => {
const selectedTheme = DecoratorHelpers.pluckThemeFromContext(context);
const { themeOverride } = DecoratorHelpers.useThemeParameters();
const selected = themeOverride || selectedTheme || "dark";

return (
<StrictMode>
<StyledEngineProvider injectFirst>
<MuiThemeProvider theme={themes[selected]}>
<EmotionThemeProvider theme={themes[selected]}>
<CssBaseline />
<Story />
</EmotionThemeProvider>
</MuiThemeProvider>
</StyledEngineProvider>
</StrictMode>
);
},
];
/** @type {readonly Decorator[]} */
export const decorators = [withRouter, withQuery, withHelmet, withTheme];

/** @type {Preview["parameters"]} */
export const parameters = {
options: {
storySort: {
method: "alphabetical",
order: ["design", "pages", "modules", "components"],
locales: "en-US",
},
},
controls: {
expanded: true,
matchers: {
color: /(background|color)$/i,
date: /Date$/,
},
},
viewport: {
viewports: {
ipad: {
name: "iPad Mini",
styles: {
height: "1024px",
width: "768px",
},
type: "tablet",
},
terminal: {
name: "Terminal",
styles: {
height: "400",
width: "400",
},
},
},
},
options: {
storySort: {
method: "alphabetical",
order: ["design", "pages", "modules", "components"],
locales: "en-US",
},
},
controls: {
expanded: true,
matchers: {
color: /(background|color)$/i,
date: /Date$/,
},
},
viewport: {
viewports: {
ipad: {
name: "iPad Mini",
styles: {
height: "1024px",
width: "768px",
},
type: "tablet",
},
terminal: {
name: "Terminal",
styles: {
height: "400",
width: "400",
},
},
},
},
};

/**
* There's a mismatch on the React Helmet return type that causes issues when
* mounting the component in JS files only. Have to do type assertion, which is
* especially ugly in JSDoc
*/
const SafeHelmetProvider = /** @type {FC} */ (
/** @type {unknown} */ (HelmetProvider)
);

/** @type {Decorator} */
function withHelmet(Story) {
return (
<SafeHelmetProvider>
<Story />
</SafeHelmetProvider>
);
}

/** @type {Decorator} */
function withQuery(Story, { parameters }) {
const queryClient = new QueryClient({
defaultOptions: {
queries: {
staleTime: Infinity,
retry: false,
},
},
});
const queryClient = new QueryClient({
defaultOptions: {
queries: {
staleTime: Number.POSITIVE_INFINITY,
retry: false,
},
},
});

if (parameters.queries) {
for (const query of parameters.queries) {
if (query.data instanceof Error) {
// This is copied from setQueryData() but sets the error.
const cache = queryClient.getQueryCache();
const parsedOptions = parseQueryArgs(query.key);
const defaultedOptions = queryClient.defaultQueryOptions(parsedOptions);
const cachedQuery = cache.build(queryClient, defaultedOptions);
// Set manual data so react-query will not try to refetch.
cachedQuery.setData(undefined, { manual: true });
cachedQuery.setState({ error: query.data });
} else {
queryClient.setQueryData(query.key, query.data);
}
}
}

return (
<QueryClientProvider client={queryClient}>
<Story />
</QueryClientProvider>
);
}

if (parameters.queries) {
parameters.queries.forEach((query) => {
if (query.data instanceof Error) {
// This is copied from setQueryData() but sets the error.
const cache = queryClient.getQueryCache();
const parsedOptions = parseQueryArgs(query.key)
const defaultedOptions = queryClient.defaultQueryOptions(parsedOptions)
const cachedQuery = cache.build(queryClient, defaultedOptions);
// Set manual data so react-query will not try to refetch.
cachedQuery.setData(undefined, { manual: true });
cachedQuery.setState({ error: query.data });
} else {
queryClient.setQueryData(query.key, query.data);
}
});
}
/** @type {Decorator} */
function withTheme(Story, context) {
const selectedTheme = DecoratorHelpers.pluckThemeFromContext(context);
const { themeOverride } = DecoratorHelpers.useThemeParameters();
const selected = themeOverride || selectedTheme || "dark";

return (
<QueryClientProvider client={queryClient}>
<Story />
</QueryClientProvider>
);
return (
<StrictMode>
<StyledEngineProvider injectFirst>
<MuiThemeProvider theme={themes[selected]}>
<EmotionThemeProvider theme={themes[selected]}>
<CssBaseline />
<Story />
</EmotionThemeProvider>
</MuiThemeProvider>
</StyledEngineProvider>
</StrictMode>
);
}

// Try to fix storybook rendering fonts inconsistently
// https://www.chromatic.com/docs/font-loading/#solution-c-check-fonts-have-loaded-in-a-loader
const fontLoader = async () => ({
fonts: await document.fonts.ready,
fonts: await document.fonts.ready,
});

export const loaders = isChromatic() && document.fonts ? [fontLoader] : [];
Loading