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.

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

CLI: Handle Yarn PnP wrapper scenario when adding an addon #29027

Merged
merged 2 commits into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 42 additions & 1 deletion code/lib/cli-storybook/src/add.test.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import { describe, expect, test, vi } from 'vitest';
import { beforeEach, describe, expect, test, vi } from 'vitest';

import { add, getVersionSpecifier } from './add';

const MockedConfig = vi.hoisted(() => {
return {
appendValueToArray: vi.fn(),
getFieldNode: vi.fn(),
valueToNode: vi.fn(),
appendNodeToArray: vi.fn(),
};
});
const MockedPackageManager = vi.hoisted(() => {
Expand All @@ -20,6 +23,12 @@ const MockedPostInstall = vi.hoisted(() => {
postinstallAddon: vi.fn(),
};
});
const MockWrapRequireUtils = vi.hoisted(() => {
return {
getRequireWrapperName: vi.fn(),
wrapValueWithRequireWrapper: vi.fn(),
};
});
const MockedConsole = {
log: vi.fn(),
warn: vi.fn(),
Expand All @@ -35,6 +44,9 @@ vi.mock('storybook/internal/csf-tools', () => {
vi.mock('./postinstallAddon', () => {
return MockedPostInstall;
});
vi.mock('./automigrate/fixes/wrap-require-utils', () => {
return MockWrapRequireUtils;
});
vi.mock('storybook/internal/common', () => {
return {
getStorybookInfo: vi.fn(() => ({ mainConfig: {}, configDir: '' })),
Expand Down Expand Up @@ -103,6 +115,35 @@ describe('add', () => {
});

describe('add (extra)', () => {
beforeEach(() => {
vi.clearAllMocks();
});
test('should not add a "wrap require" to the addon when not needed', async () => {
MockedConfig.getFieldNode.mockReturnValue({});
MockWrapRequireUtils.getRequireWrapperName.mockReturnValue(null);
await add(
'@storybook/addon-docs',
{ packageManager: 'npm', skipPostinstall: true },
MockedConsole
);

expect(MockWrapRequireUtils.wrapValueWithRequireWrapper).not.toHaveBeenCalled();
expect(MockedConfig.appendValueToArray).toHaveBeenCalled();
expect(MockedConfig.appendNodeToArray).not.toHaveBeenCalled();
});
test('should add a "wrap require" to the addon when applicable', async () => {
MockedConfig.getFieldNode.mockReturnValue({});
MockWrapRequireUtils.getRequireWrapperName.mockReturnValue('require');
await add(
'@storybook/addon-docs',
{ packageManager: 'npm', skipPostinstall: true },
MockedConsole
);

expect(MockWrapRequireUtils.wrapValueWithRequireWrapper).toHaveBeenCalled();
expect(MockedConfig.appendValueToArray).not.toHaveBeenCalled();
expect(MockedConfig.appendNodeToArray).toHaveBeenCalled();
});
test('not warning when installing the correct version of storybook', async () => {
await add(
'@storybook/addon-docs',
Expand Down
15 changes: 14 additions & 1 deletion code/lib/cli-storybook/src/add.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ import { readConfig, writeConfig } from 'storybook/internal/csf-tools';
import SemVer from 'semver';
import { dedent } from 'ts-dedent';

import {
getRequireWrapperName,
wrapValueWithRequireWrapper,
} from './automigrate/fixes/wrap-require-utils';
import { postinstallAddon } from './postinstallAddon';

export interface PostinstallOptions {
Expand Down Expand Up @@ -136,7 +140,16 @@ export async function add(
await packageManager.addDependencies({ installAsDevDependencies: true }, [addonWithVersion]);

logger.log(`Adding '${addon}' to main.js addons field.`);
main.appendValueToArray(['addons'], addonName);

const mainConfigAddons = main.getFieldNode(['addons']);
if (mainConfigAddons && getRequireWrapperName(main) !== null) {
const addonNode = main.valueToNode(addonName);
main.appendNodeToArray(['addons'], addonNode as any);
wrapValueWithRequireWrapper(main, addonNode as any);
Comment on lines +147 to +148
Copy link
Contributor

Choose a reason for hiding this comment

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

style: type assertion to 'any' may hide potential type errors, consider using a more specific type

} else {
main.appendValueToArray(['addons'], addonName);
}

await writeConfig(main);

if (!skipPostinstall && isCoreAddon(addonName)) {
Expand Down