mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
Hendrik LiebauandGitHub
286e243176
Restores Server Function logging to be enabled by default during development, as originally implemented in #88277. The change to opt-in in #89321 was overly conservative. The implicit default in #88277 was an intentional design decision. Users can still opt out via `next.config.js`: ```js module.exports = { logging: { serverFunctions: false, }, } ``` For `'use cache'` Server Functions called from the client, the logging still needs more work. We'll disable it for those in a follow-up PR rather than gating the entire feature. Also fixes a pre-existing error where `'verbose'` from the deprecated `experimental.browserDebugInfoInTerminal` config wasn't properly normalized to `logging.browserToTerminal`. This was now surfaced because the default `logging` value object was not typed as `LoggingConfig`. <!-- 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 ### 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 # -->
218 lines
7.2 KiB
TypeScript
218 lines
7.2 KiB
TypeScript
import stripAnsi from 'strip-ansi'
|
|
import { retry } from 'next-test-utils'
|
|
import { nextTestSetup } from 'e2e-utils'
|
|
|
|
describe('server-action-logging', () => {
|
|
const { next, isNextStart, skipped } = nextTestSetup({
|
|
skipDeployment: true,
|
|
files: __dirname,
|
|
})
|
|
|
|
if (skipped) return
|
|
|
|
if (isNextStart) {
|
|
it('should not log server actions in production mode', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#success-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
// Wait a bit and verify no action logs appear
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
// Should not contain the server action log format
|
|
expect(logs).not.toContain('└─ ƒ successAction')
|
|
})
|
|
})
|
|
return
|
|
}
|
|
|
|
it('should log successful server action', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#success-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
expect(logs).toContain('└─ ƒ successAction')
|
|
expect(logs).toMatch(/└─ ƒ successAction\(5\) in \d+ms/)
|
|
|
|
// Validate order: POST request and server action log should be on consecutive lines
|
|
const lines = logs.split('\n')
|
|
const postLineIndex = lines.findIndex((line) => line.includes('POST /'))
|
|
const actionLineIndex = lines.findIndex((line) =>
|
|
line.includes('└─ ƒ successAction')
|
|
)
|
|
expect(postLineIndex).toBeGreaterThan(-1)
|
|
expect(actionLineIndex).toBe(postLineIndex + 1)
|
|
})
|
|
})
|
|
|
|
it('should log server action with multiple arguments', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#multi-arg-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
expect(logs).toContain('└─ ƒ multiArgAction')
|
|
expect(logs).toMatch(/└─ ƒ multiArgAction\(1, 2, 3\) in \d+ms/)
|
|
})
|
|
})
|
|
|
|
it('should log server action with object argument', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#object-arg-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
expect(logs).toContain('└─ ƒ objectArgAction')
|
|
// safe-stable-stringify outputs JSON format
|
|
expect(logs).toMatch(
|
|
/└─ ƒ objectArgAction\(\{"name":"test","value":42\}\) in \d+ms/
|
|
)
|
|
})
|
|
})
|
|
|
|
it('should log server action with array argument (truncated)', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#array-arg-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
expect(logs).toContain('└─ ƒ arrayArgAction')
|
|
// Arrays are truncated by safe-stable-stringify
|
|
expect(logs).toMatch(/└─ ƒ arrayArgAction\(\[1,2,3,.*\]\) in \d+ms/)
|
|
})
|
|
})
|
|
|
|
it('should log redirect action', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#redirect-action').click()
|
|
await browser.waitForElementByCss('#redirect-target')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
expect(logs).toContain('└─ ƒ redirectAction')
|
|
expect(logs).toMatch(
|
|
/└─ ƒ redirectAction\("\/redirect-target"\) in \d+ms/
|
|
)
|
|
})
|
|
})
|
|
|
|
it('should log notFound action', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#not-found-action').click()
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
expect(logs).toContain('└─ ƒ notFoundAction')
|
|
expect(logs).toMatch(/└─ ƒ notFoundAction\(\) in \d+ms/)
|
|
})
|
|
})
|
|
|
|
it('should log error action', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#error-action').click()
|
|
await browser.waitForElementByCss('#error')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
expect(logs).toContain('└─ ƒ errorAction')
|
|
expect(logs).toMatch(/└─ ƒ errorAction\(\) in \d+ms/)
|
|
})
|
|
})
|
|
|
|
it('should log server action with promise argument', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#promise-arg-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
expect(logs).toContain('└─ ƒ promiseArgAction')
|
|
expect(logs).toMatch(/└─ ƒ promiseArgAction\(.*\) in \d+ms/)
|
|
})
|
|
})
|
|
|
|
it('should log inline action', async () => {
|
|
const browser = await next.browser('/inline')
|
|
await browser.waitForElementByCss('#inline-page')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#true-inline-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
// Inline actions show as <inline action> with file location
|
|
expect(logs).toMatch(
|
|
/└─ ƒ <inline action>\(10\) in \d+ms app\/inline\/page\.js/
|
|
)
|
|
})
|
|
})
|
|
|
|
it('should show relative file path in log', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#success-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
// Should show relative path like app/actions.js, not full path
|
|
expect(logs).toMatch(/app\/actions\.js/)
|
|
// Should not contain the test directory prefix
|
|
expect(logs).not.toContain('test/e2e/app-dir/server-action-logging/')
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('server-action-logging when logging.serverFunctions is disabled', () => {
|
|
const { next, isNextDev, skipped } = nextTestSetup({
|
|
skipDeployment: true,
|
|
files: __dirname,
|
|
env: {
|
|
NEXT_TEST_SERVER_FUNCTION_LOGGING: 'false',
|
|
},
|
|
})
|
|
|
|
if (skipped) return
|
|
|
|
it('should not log server actions', async () => {
|
|
const browser = await next.browser('/')
|
|
const outputIndex = next.cliOutput.length
|
|
|
|
await browser.elementByCss('#success-action').click()
|
|
await browser.waitForElementByCss('#result')
|
|
|
|
await retry(() => {
|
|
const logs = stripAnsi(next.cliOutput.slice(outputIndex))
|
|
if (isNextDev) {
|
|
expect(logs).toContain('POST /')
|
|
}
|
|
expect(logs).not.toContain('└─ ƒ successAction')
|
|
})
|
|
})
|
|
})
|