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.

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

Preserve selected mode and/or browser, if possible, while navigating between stories #203

Merged
merged 5 commits into from
Mar 8, 2024
Merged

Preserve selected mode and/or browser, if possible, while navigating between stories #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b9fe04
Persist the last user-selected mode name
andrewortwein Mar 8, 2024
20f40dc
Use useSharedState instead of useAddonState
andrewortwein Mar 8, 2024
0b0c83e
Reset user selected mode if it doesn't apply to current story
andrewortwein Mar 8, 2024
8725b9b
Use shared state constants, clean up
andrewortwein Mar 8, 2024
d36a470
Merge branch 'main' into andrew/ap-4219-preserve-state-of-modesbrowse…
andrewortwein Mar 8, 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
2 changes: 2 additions & 0 deletions src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ export const IS_OUTDATED = `${ADDON_ID}/isOutdated`;
export const START_BUILD = `${ADDON_ID}/startBuild`;
export const STOP_BUILD = `${ADDON_ID}/stopBuild`;
export const LOCAL_BUILD_PROGRESS = `${ADDON_ID}/localBuildProgress`;
export const SELECTED_MODE_NAME = `${ADDON_ID}/selectedModeName`;
export const SELECTED_BROWSER_ID = `${ADDON_ID}/selectedBrowserId`;

export const REMOVE_ADDON = `${ADDON_ID}/removeAddon`;

Expand Down
42 changes: 29 additions & 13 deletions src/utils/useTests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { useGlobals, useGlobalTypes } from "@storybook/manager-api";
import { useCallback, useState } from "react";

import { SELECTED_BROWSER_ID, SELECTED_MODE_NAME } from "../constants";
import { BrowserInfo, StoryTestFieldsFragment, TestMode, TestStatus } from "../gql/graphql";
import { useSharedState } from "./useSharedState";

type BrowserData = Pick<BrowserInfo, "id" | "key" | "name">;
type ModeData = Pick<TestMode, "name">;
Expand All @@ -21,24 +23,38 @@ const useGlobalValue = (key: string) => {
*/
export function useTests(tests: StoryTestFieldsFragment[]) {
const [theme, themeType] = useGlobalValue("theme");
const [selectedBrowserId, onSelectBrowserId] = useState<BrowserData["id"]>(() => {
const test = tests.find(({ status }) => status !== TestStatus.Passed) || tests[0];
return test?.comparisons[0]?.browser.id;
});
const [selectedModeName, onSelectModeName] = useState<ModeData["name"]>(() => {
const changed = tests.filter(({ status }) => status !== TestStatus.Passed);
const candidates = changed.length ? changed : tests;
const test = candidates.find(({ mode }) => mode.globals.theme === theme) || candidates[0];
return test?.mode.name;
});
const [selectedBrowserId, setSelectedBrowserId] = useSharedState<string>(SELECTED_BROWSER_ID);
const [selectedModeName, setSelectedModeName] = useSharedState<string>(SELECTED_MODE_NAME);

const onSelectBrowser = useCallback(({ id }: BrowserData) => onSelectBrowserId(id), []);
const onSelectMode = useCallback(({ name }: ModeData) => onSelectModeName(name), []);
const onSelectBrowser = useCallback(
({ id }: BrowserData) => setSelectedBrowserId(id),
[setSelectedBrowserId]
);
const onSelectMode = useCallback(
({ name }: ModeData) => setSelectedModeName(name),
[setSelectedModeName]
);

const selectedTest = tests.find(({ mode }) => mode.name === selectedModeName) || tests[0];
// Select the test based on the following criteria (in order of priority):
// 1. The first test with changes detected and the mode name matches the one previously selected
// 2. The first test with changes detected
// 3. The first test where the mode name matches the one previously selected
// 4. The first test
const changedTests = tests.filter(({ status }) => status !== TestStatus.Passed);
const selectedTest =
changedTests.find(({ mode }) => mode.name === selectedModeName) ||
changedTests[0] ||
tests.find(({ mode }) => mode.name === selectedModeName) ||
tests[0];
if (selectedTest?.mode.name !== selectedModeName) {
setSelectedModeName(selectedTest?.mode.name);
}
const selectedComparison =
selectedTest?.comparisons.find(({ browser }) => browser.id === selectedBrowserId) ||
selectedTest?.comparisons[0];
if (selectedComparison?.browser.id !== selectedBrowserId) {
setSelectedBrowserId(selectedComparison?.browser.id);
}

return {
modeOrder: themeType?.toolbar?.items?.map((item: { title: string }) => item.title),
Expand Down
Loading