Skip to content

Commit

Permalink
Ensure required-server-files test doesn't get stuck on failure (verce…
Browse files Browse the repository at this point in the history
…l#67576)

This test suite is failing with Turbopack build and when it fails the
suite gets stuck because it will wait on each test case even though the
command has failed.

Introduced it as a new flag on the util as this is a legacy test helper
that we no longer use in new tests and I don't want to break existing
tests that might be checking non-zero exit codes.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
  • Loading branch information
timneutkens authored Jul 9, 2024
1 parent dab0fb9 commit 8f93430
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
10 changes: 10 additions & 0 deletions test/lib/next-test-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export function initNextServerScript(
nodeArgs?: string[]
onStdout?: (data: any) => void
onStderr?: (data: any) => void
// If true, the promise will reject if the process exits with a non-zero code
shouldRejectOnError?: boolean
}
): Promise<ChildProcess> {
return new Promise((resolve, reject) => {
Expand Down Expand Up @@ -83,6 +85,14 @@ export function initNextServerScript(
}
}

if (opts?.shouldRejectOnError) {
instance.on('exit', (code) => {
if (code !== 0) {
reject(new Error('exited with code: ' + code))
}
})
}

instance.stdout.on('data', handleStdout)
instance.stderr.on('data', handleStderr)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ describe('required server files', () => {
errors.push(msg)
stderr += msg
},
shouldRejectOnError: true,
}
)
})
Expand Down

0 comments on commit 8f93430

Please sign in to comment.