Skip to content

Commit

Permalink
fix(next-server): 'quiet' setting delegate for custom server (#64512)
Browse files Browse the repository at this point in the history
## Info

I did not create a GitHub issue, but this PR for fixing the issue. Hope
that's okay.

## The bug

We run a 'normal' custom server described here:
https://nextjs.org/docs/pages/building-your-application/configuring/custom-server

```ts
const next = require('next');
const dev = process.env.NODE_ENV !== 'production';
const port = 3000;
const app = next({ dev, port, quiet: !dev })
const handle = app.getRequestHandler()
// ...
```

The `quiet` settings is missed in some deeper Next.js internal api
calls. For that reason, the setting did not work at all. This works only
in production mode.

## Testing

I tried to implement a test in `/test/production/custom-server` but I
failed to get the `stderr` messages. When someone give me some guidance,
I will add a new test.

Here are some criteria:

- need: custom server with `quiet: true` setting
- need: a next.js page with thrown error. e.g. `export const
getServerSideProps = () => { throw new Error('failed') }`
- need: collect all `stderr` messages

I tested the fix in our project by editing the files in `node_modules`
-- it worked.

## Background

We upgrade our project from next `13.3.4` to `14.2.0` and saw this
regression. I can not tell in which version this bug was added. We run a
Next.js + 'custom server' + Docker setup. Because we have a lot of
traffic, we need to suppress the standard Next.js logging and using our
own logging.


<!-- 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
bobaaaaa authored Apr 17, 2024
1 parent ab344ea commit 048697b
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 1 deletion.
1 change: 1 addition & 0 deletions packages/next/src/server/lib/render-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ async function initializeImpl(opts: {
_ipcKey?: string
bundlerService: DevBundlerService | undefined
startServerSpan: Span | undefined
quiet?: boolean
}) {
const type = process.env.__NEXT_PRIVATE_RENDER_WORKER
if (type) {
Expand Down
2 changes: 2 additions & 0 deletions packages/next/src/server/lib/router-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ export async function initialize(opts: {
customServer?: boolean
experimentalHttpsServer?: boolean
startServerSpan?: Span
quiet?: boolean
}): Promise<[WorkerRequestHandler, WorkerUpgradeHandler, NextServer]> {
if (!process.env.NODE_ENV) {
// @ts-ignore not readonly
Expand Down Expand Up @@ -604,6 +605,7 @@ export async function initialize(opts: {
experimentalHttpsServer: !!opts.experimentalHttpsServer,
bundlerService: devBundlerService,
startServerSpan: opts.startServerSpan,
quiet: opts.quiet,
}
renderServerOpts.serverFields.routerServerHandler = requestHandlerImpl

Expand Down
3 changes: 3 additions & 0 deletions packages/next/src/server/lib/start-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export async function getRequestHandlers({
isNodeDebugging,
keepAliveTimeout,
experimentalHttpsServer,
quiet,
}: {
dir: string
port: number
Expand All @@ -62,6 +63,7 @@ export async function getRequestHandlers({
isNodeDebugging?: boolean
keepAliveTimeout?: number
experimentalHttpsServer?: boolean
quiet?: boolean
}): ReturnType<typeof initialize> {
return initialize({
dir,
Expand All @@ -74,6 +76,7 @@ export async function getRequestHandlers({
keepAliveTimeout,
experimentalHttpsServer,
startServerSpan,
quiet,
})
}

Expand Down
1 change: 1 addition & 0 deletions packages/next/src/server/next.ts
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ class NextCustomServer extends NextServer {
hostname: this.options.hostname || 'localhost',
minimalMode: this.options.minimalMode,
isNodeDebugging: !!isNodeDebugging,
quiet: this.options.quiet,
})
this.requestHandler = initResult[0]
this.upgradeHandler = initResult[1]
Expand Down
23 changes: 23 additions & 0 deletions test/production/custom-server/custom-server.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ createNextDescribe(
expect($('p').text()).toBe(`Page ${page}`)
})

it('should log any error messages when server is started without "quiet" setting', async () => {
await next.render(`/error`)
expect(next.cliOutput).toInclude('Server side error')
})

describe('with app dir', () => {
it('should render app with react canary', async () => {
const $ = await next.render$(`/1`)
Expand All @@ -29,3 +34,21 @@ createNextDescribe(
})
}
)

createNextDescribe(
'custom server with quiet setting',
{
files: __dirname,
startCommand: 'node server.js',
env: { USE_QUIET: 'true' },
dependencies: {
'get-port': '5.1.1',
},
},
({ next }) => {
it('should not log any error messages when server is started with "quiet" setting', async () => {
await next.render(`/error`)
expect(next.cliOutput).not.toInclude('Server side error')
})
}
)
6 changes: 6 additions & 0 deletions test/production/custom-server/pages/page-error.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export default function Page() {
return <p>This page should never be rendered</p>
}
export const getServerSideProps = async () => {
throw new Error('Server side error')
}
5 changes: 4 additions & 1 deletion test/production/custom-server/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ const { createServer } = require('http')
const { parse } = require('url')
const next = require('next')
const getPort = require('get-port')
const quiet = process.env.USE_QUIET === 'true'

async function main() {
const port = await getPort()
const hostname = 'localhost'
// when using middleware `hostname` and `port` must be provided below
const app = next({ hostname, port })
const app = next({ hostname, port, quiet })
const handle = app.getRequestHandler()

app.prepare().then(() => {
Expand All @@ -22,6 +23,8 @@ async function main() {
await app.render(req, res, '/a', query)
} else if (pathname === '/b') {
await app.render(req, res, '/page-b', query)
} else if (pathname === '/error') {
await app.render(req, res, '/page-error')
} else {
await handle(req, res, parsedUrl)
}
Expand Down

0 comments on commit 048697b

Please sign in to comment.