Global-error.js not catching exceptions as expected according to the official doc

[LIIIIINN]

Verify canary release

• I verified that the issue exists in the latest Next.js canary release

Provide environment information

Operating System:
      Platform: darwin
      Arch: x64
      Version: Darwin Kernel Version 22.5.0: Thu Jun  8 22:22:22 PDT 2023; root:xnu-8796.121.3~7/RELEASE_X86_64
    Binaries:
      Node: 18.16.1
      npm: 9.5.1
      Yarn: N/A
      pnpm: N/A
    Relevant Packages:
      next: 13.4.13
      eslint-config-next: 13.4.13
      react: 18.2.0
      react-dom: 18.2.0
      typescript: 5.1.6
    Next.js Config:
      output: N/A

Which area(s) of Next.js are affected? (leave empty if unsure)

No response

Link to the code that reproduces this issue or a replay of the bug

n/a

To Reproduce

1. clone a template of nextjs
2. add throw error in rootLayout or page under app folder
3. add a new file under app folder, global-error.js as doc described
4. spin up next app
5. as you can see from the screen, global-error not triggered

Describe the Bug

exception should be catched by global-error.js file, but not

Expected Behavior

excepted to be catched by global-error.js

Which browser are you using? (if relevant)

chrome

How are you deploying your application? (if relevant)

local

_NEXT-1760

[jpizzati-uvl]

I'm experiencing same issue. At the moment only workaround is to use _error.js file inside /pages directory to handle exceptions.

[github-actions]

We cannot recreate the issue with the provided information. Please add a reproduction in order for us to be able to investigate.

Why was this issue marked with the please add a complete reproduction label?

To be able to investigate, we need access to a reproduction to identify what triggered the issue. We prefer a link to a public GitHub repository (template for App Router, template for Pages Router), but you can also use these templates: CodeSandbox: App Router or CodeSandbox: Pages Router.

To make sure the issue is resolved as quickly as possible, please make sure that the reproduction is as minimal as possible. This means that you should remove unnecessary code, files, and dependencies that do not contribute to the issue. Ensure your reproduction does not depend on secrets, 3rd party registries, private dependencies, or any other data that cannot be made public. Avoid a reproduction including a whole monorepo (unless relevant to the issue). The easier it is to reproduce the issue, the quicker we can help.

Please test your reproduction against the latest version of Next.js (next@canary) to make sure your issue has not already been fixed.

If you cannot create a clean reproduction, another way you can help the maintainers' job is to pinpoint the canary version of next that introduced the issue. Check out our releases, and try to find the first canary release that introduced the issue. This will help us narrow down the scope of the issue, and possibly point to the PR/code change that introduced it. You can install a specific version of next by running npm install next@<version>.

I added a link, why was it still marked?

Ensure the link is pointing to a codebase that is accessible (e.g. not a private repository). "example.com", "n/a", "will add later", etc. are not acceptable links -- we need to see a public codebase. See the above section for accepted links.

What happens if I don't provide a sufficient minimal reproduction?

Issues with the please add a complete reproduction label that receives no meaningful activity (e.g. new comments with a reproduction link) are automatically closed and locked after 30 days.

If your issue has not been resolved in that time and it has been closed/locked, please open a new issue with the required reproduction.

I did not open this issue, but it is relevant to me, what can I do to help?

Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps. Furthermore, you can upvote the issue using the 👍 reaction on the topmost comment (please do not comment "I have the same issue" without reproduction steps). Then, we can sort issues by votes to prioritize.

I think my reproduction is good enough, why aren't you looking into it quicker?

We look into every Next.js issue and constantly monitor open issues for new comments.

However, sometimes we might miss one or two due to the popularity/high traffic of the repository. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority.

Upvoting issues to show your interest will help us prioritize and address them as quickly as possible. That said, every issue is important to us, and if an issue gets closed by accident, we encourage you to open a new one linking to the old issue and we will look into it.

Useful Resources

• How to Contribute to Open Source (Next.js)
• How to create a Minimal, Complete, and Verifiable example
• Reporting a Next.js bug
• Next.js Triaging issues

[huozhi]

Can you share a reproduction that where it couldn't catch and in which mode (next dev or next start)? In dev mode it will display error dialog to let you discover the error and it will show global-error in production mode

[lforst]

It took me an embarrassingly long time to repro this: https://github.com/lforst/next-global-error-bug

The readme in that repo has the repro instructions.

[icazemier]

I did a similar reproduction. Maybe helpful?
#46964 (comment)

[kiddicodes]

I believe that you are just generating the error in a way that shouldn't actually render the global-error.tsx?

It is supposed to handle error generated in the rendering of the root layout right?
@lforst your repro is generating the error down in the page level, correct? That should probably be handled by an error-boundary (error.tsx)

Not sure about your repro @icazemier but it feels wrong to have it in a setTimeout like that (no async/await for a promise or anything). It feels correct that the page should render and then the error occurs.

The way I've been able to get the error to actually show itself is to do something like this within the root layout:

  if (x > 0.6) {
    throw new Error('Random error')
  }

And ofcourse make sure to build & start

The random throwing error snippet above also triggers the global-error when included in a ServerComponent used by the layout.

[github-actions]

This closed issue has been automatically locked because it had no new activity for 2 weeks. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.