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

fix(next-server): 'quiet' setting delegate for custom server #64512

Merged
merged 6 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
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
4 changes: 4 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,10 @@ createNextDescribe(
expect($('p').text()).toBe(`Page ${page}`)
})

it('should not log any error messages when server is started with "quiet" setting', async () => {
await next.render(`/error`)
})
Copy link
Contributor Author

@bobaaaaa bobaaaaa Apr 15, 2024

Choose a reason for hiding this comment

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

@ijjk My first impl. was here: https://github.com/vercel/next.js/blob/canary/test/integration/custom-server/test/index.test.js That was super simple. But not for production mode :(

Copy link
Member

Choose a reason for hiding this comment

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

They can be set via the env field next to startCommand then the CLI output can be accessed via next.cliOutput.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ijjk Much appreciated for the help. I added two test cases:

  • quite: true -> no logging
  • default quite -> logging


describe('with app dir', () => {
it('should render app with react canary', async () => {
const $ = await next.render$(`/1`)
Expand Down
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'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

from here:

const { createServer } = require(process.env.USE_HTTPS === '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
Loading