feat: nextjs integration

[subzero10]

Status

READY

Description

Closes: #1023
A nextjs dedicated package that simplifies integration with nextjs:

• server integration
• client integration
• source map upload

Todos

• Publish alpha version of the package so it can be installed on a Vercel deployment
• Webpack config to configure Honeybadger based on runtime
• Honeybadger Edge API client (Server client may not work) - made it work with the browser client
• Source map upload with webpack plugin
• Tests
• README.md
• Documentation - include known limitations
• cli command to generate config files
• Manual Testing with deployments to Vercel
• Manual Testing with deployments to Heroku
• Manual Testing with deployments to self-hosted server (?)
• Add @honeybadger-io/nextjs in pull-package-versions workflow
• Create issues on github to address limitations (Uncaught errors in API routes or middleware functions are not reported #1055, Support for source maps on Edge Runtime #1056)
• Verify that HoneybadgerErrorBoundary React component provides additional React contextual information
• Update nextjs example repo to use this package - feat(nextjs): integrate with official nextjs package nextjs-with-honeybadger#13

[subzero10]

Just realized that I will have to find a way to publish an alpha version of the package without Lerna (so I can test with Vercel deployments).
Our current Lerna setup uses fixed mode, which uses same versioning strategy for all packages and I don't want to change that at the moment.
It should be easily done with the npm cli.

[subzero10]

I'm sad to realize that it's no easy task to install a package from the monorepo without an npm publish.
I came across gitpkg, but it's not working for me. They have an open issue and I commented.

[subzero10]

Update:

• The HB client can now report errors either from server, browser or vercel edge.
• However, it won't always work because of some strange caveats of Nextjs/Vercel. For example, this one makes it difficult to report an error that comes from an error thrown in an api route, because Nextjs renders a 404 status code 🤷 . Additionally, there is no information about the error at all. As a result, a different way is to be implemented to handle those cases, which I plan to do with a separate issue/PR.

I will pause here as far as "the reporting to Honeybadger" task goes and focus on the next points in the todo list above. I will document known limitations, so we can create issues to improve them.

[subzero10]

Update:
I integrated the webpack plugin so now source maps are automatically uploaded. They are working for server and browser runtimes. They are not working for the vercel edge runtime.
I haven't decided if I should work on this or if I should focus on getting the first version of this package out there (remaining todo items); I'm leaning towards the latter.

[subzero10]

Hey @BethanyBerkowitz, @joshuap and @stympy,

I think this is ready for review. I have some more testing to do, but you should be able to get started with the review.

[subzero10]

I will merge this so that the package will be published on npm. Then, I will be able to do end-to-end testing with our example repository.