File size: 11,360 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
import { createNext, FileRef } from 'e2e-utils'
import { NextInstance } from 'e2e-utils'
import webdriver from 'next-webdriver'
import { join } from 'path'
import stripAnsi from 'strip-ansi'
import { retry } from 'next-test-utils'
const bundlerName = process.env.IS_TURBOPACK_TEST ? 'Turbopack' : 'Webpack'
function setupLogCapture() {
const logs: string[] = []
const originalStdout = process.stdout.write
const originalStderr = process.stderr.write
const capture = (chunk: any) => {
logs.push(stripAnsi(chunk.toString()))
return true
}
process.stdout.write = function (chunk: any) {
capture(chunk)
return originalStdout.call(this, chunk)
}
process.stderr.write = function (chunk: any) {
capture(chunk)
return originalStderr.call(this, chunk)
}
const restore = () => {
process.stdout.write = originalStdout
process.stderr.write = originalStderr
}
const clearLogs = () => {
logs.length = 0
}
return { logs, restore, clearLogs }
}
describe(`Terminal Logging (${bundlerName})`, () => {
describe('Pages Router', () => {
let next: NextInstance
let logs: string[] = []
let logCapture: ReturnType<typeof setupLogCapture>
let browser = null
beforeAll(async () => {
logCapture = setupLogCapture()
logs = logCapture.logs
next = await createNext({
files: {
pages: new FileRef(join(__dirname, 'fixtures/pages')),
'next.config.js': `
module.exports = {
experimental: {
browserDebugInfoInTerminal: true
}
}
`,
},
})
})
afterAll(async () => {
logCapture.restore()
await next.destroy()
})
beforeEach(() => {
logCapture.clearLogs()
})
afterEach(async () => {
if (browser) {
await browser.close()
browser = null
}
})
it('should forward client component logs', async () => {
browser = await webdriver(next.url, '/pages-client-log')
await browser.waitForElementByCss('#log-button')
await browser.elementByCss('#log-button').click()
await retry(() => {
const logOutput = logs.join('')
expect(logOutput).toContain(
'[browser] Log from pages router client component'
)
})
})
it('should handle circular references safely', async () => {
browser = await webdriver(next.url, '/circular-refs')
await browser.waitForElementByCss('#circular-button')
await browser.elementByCss('#circular-button').click()
await retry(() => {
const logOutput = logs.join('\n')
expect(logOutput).toContain('[browser] Circular object:')
expect(logOutput).toContain('[Circular]')
})
})
it('should respect default depth limit', async () => {
browser = await webdriver(next.url, '/deep-objects')
await browser.waitForElementByCss('#deep-button')
await browser.elementByCss('#deep-button').click()
await retry(() => {
const logOutput = logs.join('\n')
expect(logOutput).toContain('[browser] Deep object: {')
expect(logOutput).toContain('level1: {')
expect(logOutput).toContain('level2: { level3: { level4: { level5:')
expect(logOutput).toContain("'[Object]'")
})
})
it('should show source-mapped errors in pages router', async () => {
browser = await webdriver(next.url, '/pages-client-error')
await browser.waitForElementByCss('#error-button')
logCapture.clearLogs()
await browser.elementByCss('#error-button').click()
await retry(() => {
const logOutput = logs.join('\n')
const browserErrorPattern =
/\[browser\] Uncaught Error: Client error in pages router\n\s+at throwClientError \(pages\/pages-client-error\.js:2:\d+\)\n\s+at callClientError \(pages\/pages-client-error\.js:6:\d+\)/
expect(logOutput).toMatch(browserErrorPattern)
})
})
it('should show source-mapped errors for server errors from pages router ', async () => {
const outputIndex = logs.length
browser = await webdriver(next.url, '/pages-server-error')
await retry(() => {
const newLogs = logs.slice(outputIndex).join('\n')
const browserErrorPattern =
/\[browser\] Uncaught Error: Server error in pages router\n\s+at throwPagesServerError \(pages\/pages-server-error\.js:2:\d+\)\n\s+at callPagesServerError \(pages\/pages-server-error\.js:6:\d+\)/
expect(newLogs).toMatch(browserErrorPattern)
})
})
})
describe('App Router - Server Components', () => {
let next: NextInstance
let logs: string[] = []
let logCapture: ReturnType<typeof setupLogCapture>
beforeAll(async () => {
logCapture = setupLogCapture()
logs = logCapture.logs
next = await createNext({
files: {
app: new FileRef(join(__dirname, 'fixtures/app')),
'next.config.js': `
module.exports = {
experimental: {
browserDebugInfoInTerminal: true
}
}
`,
},
})
})
afterAll(async () => {
logCapture.restore()
await next.destroy()
})
beforeEach(() => {
logCapture.clearLogs()
})
it('should not re-log server component logs', async () => {
const outputIndex = logs.length
await next.render('/server-log')
await retry(() => {
const newLogs = logs.slice(outputIndex).join('')
expect(newLogs).toContain('Server component console.log')
}, 2000)
const newLogs = logs.slice(outputIndex).join('')
expect(newLogs).not.toContain('[browser] Server component console.log')
expect(newLogs).not.toContain('[browser] Server component console.error')
})
it('should show source-mapped errors for server components', async () => {
const outputIndex = logs.length
const browser = await webdriver(next.url, '/server-error')
await retry(() => {
const newLogs = logs.slice(outputIndex).join('\n')
const browserErrorPattern =
/\[browser\] Uncaught Error: Server component error in app router\n\s+at throwServerError \(app\/server-error\/page\.js:2:\d+\)\n\s+at callServerError \(app\/server-error\/page\.js:6:\d+\)\n\s+at ServerErrorPage \(app\/server-error\/page\.js:10:\d+\)/
expect(newLogs).toMatch(browserErrorPattern)
})
await browser.close()
})
})
describe('App Router - Client Components', () => {
let next: NextInstance
let logs: string[] = []
let logCapture: ReturnType<typeof setupLogCapture>
beforeAll(async () => {
logCapture = setupLogCapture()
logs = logCapture.logs
next = await createNext({
files: {
app: new FileRef(join(__dirname, 'fixtures/app')),
'next.config.js': `
module.exports = {
experimental: {
browserDebugInfoInTerminal: true
}
}
`,
},
})
})
afterAll(async () => {
logCapture.restore()
await next.destroy()
})
beforeEach(() => {
logCapture.clearLogs()
})
it('should forward client component logs in app router', async () => {
const browser = await webdriver(next.url, '/client-log')
await browser.waitForElementByCss('#log-button')
await browser.elementByCss('#log-button').click()
await retry(() => {
const logOutput = logs.join('')
expect(logOutput).toContain(
'[browser] Client component log from app router'
)
})
await browser.close()
})
it('should show source-mapped errors for client components', async () => {
const browser = await webdriver(next.url, '/client-error')
await browser.waitForElementByCss('#error-button')
logCapture.clearLogs()
await browser.elementByCss('#error-button').click()
await retry(() => {
const logOutput = logs.join('\n')
const browserErrorPattern =
/\[browser\] Uncaught Error: Client component error in app router\n\s+at throwError \(app\/client-error\/page\.js:4:\d+\)\n\s+at callError \(app\/client-error\/page\.js:8:\d+\)/
expect(logOutput).toMatch(browserErrorPattern)
})
await browser.close()
})
})
describe('App Router - Edge Runtime', () => {
let next: NextInstance
let logs: string[] = []
let logCapture: ReturnType<typeof setupLogCapture>
beforeAll(async () => {
logCapture = setupLogCapture()
logs = logCapture.logs
next = await createNext({
files: {
app: new FileRef(join(__dirname, 'fixtures/app')),
'next.config.js': `
module.exports = {
experimental: {
browserDebugInfoInTerminal: true
}
}
`,
},
})
})
afterAll(async () => {
logCapture.restore()
await next.destroy()
})
beforeEach(() => {
logCapture.clearLogs()
})
it('should handle edge runtime errors with source mapping', async () => {
const browser = await webdriver(next.url, '/edge-deep-stack')
await retry(() => {
const logOutput = logs.join('\n')
const browserErrorPattern =
/\[browser\] Uncaught Error: Deep stack error during render\n\s+at functionA \(app\/edge-deep-stack\/page\.js:6:\d+\)\n\s+at functionB \(app\/edge-deep-stack\/page\.js:10:\d+\)\n\s+at functionC \(app\/edge-deep-stack\/page\.js:14:\d+\)\n\s+at EdgeDeepStackPage \(app\/edge-deep-stack\/page\.js:18:\d+\)/
expect(logOutput).toMatch(browserErrorPattern)
})
await browser.close()
})
})
describe('Configuration Options', () => {
describe('showSourceLocation disabled', () => {
let next: NextInstance
let logs: string[] = []
let logCapture: ReturnType<typeof setupLogCapture>
let browser = null
beforeAll(async () => {
logCapture = setupLogCapture()
logs = logCapture.logs
next = await createNext({
files: {
pages: new FileRef(join(__dirname, 'fixtures/pages')),
'next.config.js': `
module.exports = {
experimental: {
browserDebugInfoInTerminal: {
showSourceLocation: false
}
}
}
`,
},
})
})
afterAll(async () => {
logCapture.restore()
await next.destroy()
})
beforeEach(() => {
logCapture.clearLogs()
})
afterEach(async () => {
if (browser) {
await browser.close()
browser = null
}
})
it('should omit source location when disabled', async () => {
browser = await webdriver(next.url, '/basic-logs')
await browser.waitForElementByCss('#log-button')
await browser.elementByCss('#log-button').click()
await retry(() => {
const logOutput = logs.join('')
expect(logOutput).toContain('[browser] Hello from browser')
expect(logOutput).not.toMatch(/\([^)]+basic-logs\.[jt]sx?:\d+:\d+\)/)
})
})
})
})
})
|