Merge remote-tracking branch 'origin/main' into tom/add-task-name

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 7.0.0 - 2023-09-04
+
+- [789](https://github.com/chromaui/chromatic-cli/pull/789) Use `@antfu/ni` to support `pnpm` for Storybook build
+- [805](https://github.com/chromaui/chromatic-cli/pull/805) Add a `onTaskProgress` option and report progress on it
+
+This is a potentially breaking change due to the introduction of [@antfu/ni](https://github.com/antfu/ni) to handle running the `storybook build` command in the **Build Storybook** step.
+
 # 6.24.1 - 2023-08-25
 
 - [803](https://github.com/chromaui/chromatic-cli/pull/803) Support Mode Name as Suffix for Build Progress Indicator

node-src/git/getCommitAndBranch.test.ts

@@ -87,11 +87,19 @@ describe('getCommitAndBranch', () => {
     expect(info).toMatchObject({ branch: 'master' });
   });
 
-  it('throws when there is only one commit', async () => {
+  it('throws when there is only one commit, CI', async () => {
+    envCi.mockReturnValue({ isCi: true });
     hasPreviousCommit.mockResolvedValue(false);
     await expect(getCommitAndBranch({ log })).rejects.toThrow('Found only one commit');
   });
 
+  it('does NOT throw when there is only one commit, non-CI', async () => {
+    envCi.mockReturnValue({ isCi: false });
+    hasPreviousCommit.mockResolvedValue(false);
+    const info = await getCommitAndBranch({ log });
+    expect(info).toMatchObject({});
+  });
+
   describe('with branchName', () => {
     it('uses provided branchName as branch', async () => {
       const info = await getCommitAndBranch({ log }, { branchName: 'foobar' });

node-src/git/getCommitAndBranch.ts

@@ -50,14 +50,20 @@ export default async function getCommitAndBranch(
     CHROMATIC_PULL_REQUEST_SHA,
     CHROMATIC_SLUG,
   } = process.env;
+  const { isCi, service, prBranch, branch: ciBranch, commit: ciCommit, slug: ciSlug } = envCi();
 
   const isFromEnvVariable = CHROMATIC_SHA && CHROMATIC_BRANCH; // Our GitHub Action also sets these
   const isTravisPrBuild = TRAVIS_EVENT_TYPE === 'pull_request';
   const isGitHubAction = GITHUB_ACTIONS === 'true';
   const isGitHubPrBuild = GITHUB_EVENT_NAME === 'pull_request';
 
   if (!(await hasPreviousCommit())) {
-    throw new Error(gitOneCommit(isGitHubAction));
+    const message = gitOneCommit(isGitHubAction);
+    if (isCi) {
+      throw new Error(message);
+    } else {
+      log.warn(message);
+    }
   }
 
   if (isFromEnvVariable) {
@@ -117,7 +123,6 @@ export default async function getCommitAndBranch(
     slug = GITHUB_REPOSITORY;
   }
 
-  const { isCi, service, prBranch, branch: ciBranch, commit: ciCommit, slug: ciSlug } = envCi();
   const ciService = process.env.CHROMATIC_ACTION ? 'chromaui/action' : service;
   slug = slug || ciSlug;
 

node-src/main.test.ts

@@ -339,6 +339,7 @@ const getContext = (
     },
     packagePath: '',
     statsPath: 'preview-stats.json',
+    options: {},
     ...parseArgs(argv),
   } as any;
 };
@@ -351,6 +352,26 @@ it('fails on missing project token', async () => {
   expect(ctx.testLogger.errors[0]).toMatch(/Missing project token/);
 });
 
+// Note this tests options errors, but not fatal task or runtime errors.
+it('passes options error to onTaskError', async () => {
+  const ctx = getContext([]);
+  ctx.options = {
+    onTaskError: jest.fn(),
+  } as any;
+
+  ctx.options.onTaskError = jest.fn();
+  ctx.env.CHROMATIC_PROJECT_TOKEN = '';
+  await runBuild(ctx);
+
+  await expect(ctx.options.onTaskError).toHaveBeenCalledWith(
+    expect.anything(), // Context
+    expect.objectContaining({
+      formattedError: expect.stringContaining('Missing project token'), // Long formatted error fatalError https://github.com/chromaui/chromatic-cli/blob/217e77671179748eb4ddb8becde78444db93d067/node-src/ui/messages/errors/fatalError.ts#L11
+      originalError: expect.any(Error),
+    })
+  );
+});
+
 it('runs in simple situations', async () => {
   const ctx = getContext(['--project-token=asdf1234']);
   await runBuild(ctx);

node-src/runBuild.ts

@@ -26,6 +26,7 @@ export async function runBuild(ctx: Context, extraOptions?: Partial<Options>) {
   } catch (e) {
     ctx.log.info('');
     ctx.log.error(fatalError(ctx, [e]));
+    ctx.options.onTaskError?.(ctx, { formattedError: fatalError(ctx, [e]), originalError: e });
     setExitCode(ctx, exitCodes.INVALID_OPTIONS, true);
     return;
   }
@@ -71,6 +72,10 @@ export async function runBuild(ctx: Context, extraOptions?: Partial<Options>) {
     }
   } catch (error) {
     const errors = [].concat(error); // GraphQLClient might throw an array of errors
+    ctx.options.onTaskError?.(ctx, {
+      formattedError: fatalError(ctx, errors),
+      originalError: error,
+    });
 
     if (errors.length && !ctx.userError) {
       ctx.log.info('');

node-src/types.ts

@@ -91,6 +91,12 @@ export interface Options {
   /** A callback that is called at the start of each task */
   experimental_onTaskStart?: (ctx: Context) => void;
 
+  /** A callback that is called if a task fails */
+  onTaskError?: (
+    ctx: Context,
+    { formattedError, originalError }: { formattedError: string; originalError: Error | Error[] }
+  ) => void;
+
   /** A callback that is called during tasks that have incremental progress */
   experimental_onTaskProgress?: (
     ctx: Context,