feat(gatsby,gatsby-cli): Listen for segfaults

[tyhopp]

Description

In an effort to help triage segfaults that may occur in our dependencies with native addons (e.g. sharp, lmdb, parcel), include segfault-handler in our build, develop, serve, and child worker processes.

• Opt-in by setting GATSBY_EXPERIMENTAL_LISTEN_FOR_SEGFAULTS to a truthy value
• Segfaults are:
  • Printed to stderr by segfault-handler automatically
  • Written to .cache/logs/gatsby-segfault-[hash].log by us
  • Contextualized with a structured error by us

Usage

To try out the canaries for this feature branch, in your project execute:

npm i gatsby@alpha-segfault-handler gatsby-cli@alpha-segfault-handler

Run GATSBY_EXPERIMENTAL_LISTEN_FOR_SEGFAULTS=true npm run build or set the flag in your gatsby-config file. If a segfault occurs, it should be printed to stderr and written to .cache/logs.

Documentation

Might mention this in the Debugging the Build Process doc.

Related Issues

[sc-46856]

[wardpeet]

I'm a bit hesitant of adding segfault-handler by default because of these comments:
lovell/sharp#2191 (comment)
ddopson/node-segfault-handler#63

Let's make sure to test this on a few sites where segfaults are happening to make sure we're getting the results we want

[tyhopp]

Let's make sure to test this on a few sites where segfaults are happening to make sure we're getting the results we want

👍 Considering whether this might be better as opt-in via a flag, what do you think?

[wardpeet]

If it gives us the information we want I'm happy to keep it enabled all the time