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

Jump to bottom

Restore original behavior to use npm_execpath #348

Merged
merged 2 commits into from May 19, 2021
Merged

Restore original behavior to use npm_execpath #348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a14c41
Revert "Use yarn-or-npm to determine spawn params"
ghengeveld May 19, 2021
ce70214
Set mock at proper place
ghengeveld May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions bin/main.test.js
View file
Open in desktop
Expand Up @@ -160,6 +160,7 @@ beforeEach(() => {
CHROMATIC_PROJECT_TOKEN: undefined,
};
execa.mockReset();
execa.mockReturnValue({ stdout: '1.2.3' });
});
afterEach(() => {
process.env = processEnv;
Expand Down
26 changes: 19 additions & 7 deletions bin/tasks/build.js
View file
Open in desktop
Expand Up @@ -3,7 +3,6 @@ import fs from 'fs-extra';
import path from 'path';
import semver from 'semver';
import tmp from 'tmp-promise';
import yarnOrNpm, { spawn } from 'yarn-or-npm';

import { createTask, transitionTo } from '../lib/tasks';
import buildFailed from '../ui/messages/errors/buildFailed';
Expand All @@ -21,23 +20,36 @@ export const setSourceDir = async (ctx) => {
}
};

export const setSpawnParams = (ctx) => {
export const setSpawnParams = async (ctx) => {
const webpackStatsSupported = semver.gte(semver.coerce(ctx.storybook.version), '6.2.0');
if (ctx.git.changedFiles && !webpackStatsSupported) {
ctx.log.warn('Storybook version 6.2.0 or later is required to use the --only-changed flag');
}
const client = yarnOrNpm();
const { stdout } = spawn.sync(['--version']);

// Run either:
// node path/to/npm-cli.js run build-storybook
// node path/to/yarn.js run build-storybook
// npm run build-storybook
// Based on https://github.com/mysticatea/npm-run-all/blob/52eaf86242ba408dedd015f53ca7ca368f25a026/lib/run-task.js#L156-L174
const npmExecPath = process.env.npm_execpath;
const npmExecFile = npmExecPath && path.basename(npmExecPath);
const isJsPath = npmExecFile && /\.m?js$/.test(npmExecFile);
const isYarn = npmExecFile && npmExecFile.includes('yarn');
const isNpx = npmExecFile && npmExecFile.includes('npx');

const client = isYarn ? 'yarn' : 'npm';
const { stdout } = await execa(client, ['--version']);
const clientVersion = stdout && stdout.toString().trim();

ctx.spawnParams = {
client,
clientVersion,
platform: process.platform,
command: client,
clientArgs: ['run', '--silent'],
command: (!isNpx && (isJsPath ? process.execPath : npmExecPath)) || 'npm',
clientArgs: !isNpx && isJsPath ? [npmExecPath, 'run'] : ['run', '--silent'],
scriptArgs: [
ctx.options.buildScriptName,
client === 'yarn' ? '' : '--',
isYarn ? '' : '--',
'--output-dir',
ctx.sourceDir,
ctx.git.changedFiles && webpackStatsSupported && '--webpack-stats-json',
Expand Down
20 changes: 10 additions & 10 deletions bin/tasks/build.test.js
View file
Open in desktop
@@ -1,15 +1,8 @@
import execa from 'execa';
import yarnOrNpm, { spawn } from 'yarn-or-npm';

import { buildStorybook, setSourceDir, setSpawnParams } from './build';

jest.mock('execa');
jest.mock('yarn-or-npm');

beforeEach(() => {
yarnOrNpm.mockReturnValue('npm');
spawn.sync.mockReturnValue({ stdout: '1.2.3' });
});

describe('setSourceDir', () => {
it('sets a random temp directory path on the context', async () => {
Expand Down Expand Up @@ -38,6 +31,13 @@ describe('setSourceDir', () => {
});

describe('setSpawnParams', () => {
const npmExecPath = process.env.npm_execpath;

beforeEach(() => {
process.env.npm_execpath = npmExecPath;
execa.mockReturnValue({ stdout: '1.2.3' });
});

it('sets the spawn params on the context', async () => {
process.env.npm_execpath = 'npm';
const ctx = {
Expand Down Expand Up @@ -69,7 +69,7 @@ describe('setSpawnParams', () => {
});

it('supports yarn', async () => {
yarnOrNpm.mockReturnValue('yarn');
process.env.npm_execpath = '/path/to/yarn.js';
const ctx = {
sourceDir: './source-dir/',
options: { buildScriptName: 'build:storybook' },
Expand All @@ -81,8 +81,8 @@ describe('setSpawnParams', () => {
client: 'yarn',
clientVersion: '1.2.3',
platform: expect.stringMatching(/darwin|linux|win32/),
command: 'yarn',
clientArgs: ['run', '--silent'],
command: expect.stringMatching(/node/),
clientArgs: ['/path/to/yarn.js', 'run'],
scriptArgs: ['build:storybook', '--output-dir', './source-dir/'],
spawnOptions: {
preferLocal: true,
Expand Down