Docs for integrating with Nx monorepo

[nordhagen]

Problem Statement

The Sentry docs need a dedicated section on how to properly configure Sentry in the context of a NextJS app in an Nx monorepo.

Solution Brainstorm

Seeing as this is a common environment, I believe the Sentry documentation needs a dedicated example for this. The basic example for NextJS serves to confuse because of how Nx, plugins, NextJS and Sentry are to interact. I see lots of questions online about this with many different attempts at answering. I think there should be one canonical example from an authoritative source on this.

[lforst]

@nordhagen Thanks for opening this feature request!

We haven't yet investigated what causes the interaction with Nx to be such a pain. Putting this on our backlog. If you have any ideas and pointers what Nx is doing so that we can work around it in the SDK, feel free to ping us here!

[nordhagen]

@lforst Thank you for the quick response. I would love to help, but unfortunately I'm really struggling myself and I have nothing to add right now.

I believe the problem is two-fold:

1. There seems to be a convention around wrapping the nextConfig in a function call and assigning the returned value to module.exports. However both Nx and Sentry wants to do this much the same way, which makes the resulting config awkward to reason about. (module.exports = composePlugins(...plugins)(withSentryConfig(nextConfig, sentryWebpackPluginOptions))???
2. The withNx plugin is required in Nx to make NextJS aware of the monorepo environment. Without it package paths will not be correct. I'm not sure, but I believe there might be something in the way the Sentry config reads the resulting environment or that the order of operations matter in an implicit way.

Sorry I couldn't be of more help. Ultimately the best would be if @sentry/wizard could be Nx workspace-aware.

[lforst]

@nordhagen Thanks! For me, right now this seems like a documentation issue but I will have to verify - anyhow, we'll see what we can do!

[nordhagen]

@nordhagen Thanks! For me, right now this seems like a documentation issue but I will have to verify - anyhow, we'll see what we can do!

Thanks. Documentation goes a long way. But BTW the Vercel integration for Sentry also seems to struggle with Nx monorepos. At least I couldn't get it to work properly with our setup. Then again that might be because the NextJS config isn't correct.