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

Addon Test: Only register testing module in Vite projects #29472

Merged
merged 1 commit into from
Oct 29, 2024
Merged

Addon Test: Only register testing module in Vite projects #29472

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
190 changes: 96 additions & 94 deletions code/addons/test/src/manager.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,104 +80,106 @@ const RelativeTime = ({ timestamp, testCount }: { timestamp: Date; testCount: nu
};

addons.register(ADDON_ID, (api) => {
const openAddonPanel = () => {
api.setSelectedPanel(PANEL_ID);
api.togglePanel(true);
};

addons.add(TEST_PROVIDER_ID, {
type: Addon_TypesEnum.experimental_TEST_PROVIDER,
runnable: true,
watchable: true,

name: 'Component tests',
title: ({ crashed, failed }) =>
crashed || failed ? 'Component tests failed' : 'Component tests',
description: ({ failed, running, watching, progress, crashed, details }) => {
const [isModalOpen, setIsModalOpen] = useState(false);

const errorMessage = details?.error?.message;

let message: string | React.ReactNode = 'Not run';

if (running) {
message = progress
? `Testing... ${progress.numPassedTests}/${progress.numTotalTests}`
: 'Starting...';
} else if (failed && !errorMessage) {
message = 'Component tests failed';
} else if (crashed || (failed && errorMessage)) {
message = (
if (globalThis.STORYBOOK_BUILDER?.includes('vite')) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Consider using a more robust check like STORYBOOK_BUILDER === '@storybook/builder-vite' instead of string includes

const openAddonPanel = () => {
api.setSelectedPanel(PANEL_ID);
api.togglePanel(true);
};

addons.add(TEST_PROVIDER_ID, {
type: Addon_TypesEnum.experimental_TEST_PROVIDER,
runnable: true,
watchable: true,

name: 'Component tests',
title: ({ crashed, failed }) =>
crashed || failed ? 'Component tests failed' : 'Component tests',
description: ({ failed, running, watching, progress, crashed, details }) => {
const [isModalOpen, setIsModalOpen] = useState(false);

const errorMessage = details?.error?.message;

let message: string | React.ReactNode = 'Not run';

if (running) {
message = progress
? `Testing... ${progress.numPassedTests}/${progress.numTotalTests}`
: 'Starting...';
} else if (failed && !errorMessage) {
message = 'Component tests failed';
} else if (crashed || (failed && errorMessage)) {
message = (
<>
<LinkComponent
isButton
onClick={() => {
setIsModalOpen(true);
}}
>
{details?.error?.name || 'View full error'}
</LinkComponent>
</>
);
} else if (progress?.finishedAt) {
message = (
<RelativeTime
timestamp={new Date(progress.finishedAt)}
testCount={progress.numTotalTests}
/>
);
} else if (watching) {
message = 'Watching for file changes';
}

return (
<>
<LinkComponent
isButton
onClick={() => {
setIsModalOpen(true);
{message}
<GlobalErrorModal
error={errorMessage}
open={isModalOpen}
onClose={() => {
setIsModalOpen(false);
}}
>
{details?.error?.name || 'View full error'}
</LinkComponent>
onRerun={() => {
setIsModalOpen(false);
api
.getChannel()
.emit(TESTING_MODULE_RUN_ALL_REQUEST, { providerId: TEST_PROVIDER_ID });
}}
/>
</>
);
} else if (progress?.finishedAt) {
message = (
<RelativeTime
timestamp={new Date(progress.finishedAt)}
testCount={progress.numTotalTests}
/>
);
} else if (watching) {
message = 'Watching for file changes';
}

return (
<>
{message}
<GlobalErrorModal
error={errorMessage}
open={isModalOpen}
onClose={() => {
setIsModalOpen(false);
}}
onRerun={() => {
setIsModalOpen(false);
api
.getChannel()
.emit(TESTING_MODULE_RUN_ALL_REQUEST, { providerId: TEST_PROVIDER_ID });
}}
/>
</>
);
},

mapStatusUpdate: (state) =>
Object.fromEntries(
(state.details.testResults || []).flatMap((testResult) =>
testResult.results
.map(({ storyId, status, testRunId, ...rest }) => {
if (storyId) {
const statusObject: API_StatusObject = {
title: 'Component tests',
status: statusMap[status],
description:
'failureMessages' in rest && rest.failureMessages?.length
? rest.failureMessages.join('\n')
: '',
data: {
testRunId,
},
onClick: openAddonPanel,
};
return [storyId, statusObject];
}
})
.filter(Boolean)
)
),
} as Addon_TestProviderType<{
testResults: TestResult[];
error?: { message: string; name: string };
}>);
},

mapStatusUpdate: (state) =>
Object.fromEntries(
(state.details.testResults || []).flatMap((testResult) =>
testResult.results
.map(({ storyId, status, testRunId, ...rest }) => {
if (storyId) {
const statusObject: API_StatusObject = {
title: 'Component tests',
status: statusMap[status],
description:
'failureMessages' in rest && rest.failureMessages?.length
? rest.failureMessages.join('\n')
: '',
data: {
testRunId,
},
onClick: openAddonPanel,
};
return [storyId, statusObject];
}
})
.filter(Boolean)
)
),
} as Addon_TestProviderType<{
testResults: TestResult[];
error?: { message: string; name: string };
}>);
}

addons.add(PANEL_ID, {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Panel is still registered even when test provider is not available, which could lead to confusing empty UI state

type: types.PANEL,
Expand Down
Loading