feat(nextjs): Add distDirOverride #6194
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, again, @tmilewski! Thanks for this. You raise an interesting scenario we hadn't thought of. Rather than making the user override the Thanks for pointing out this use case! |
lobsterkatie
added a commit
that referenced
this pull request
Nov 16, 2022
#6214) In nextjs, the output directory (`distDir`) is specified by the user and stored in memory as a relative path. It's then used in two places: - At build time, it's resolved against the project directory, in order to know where to output built files. - At runtime, it's resolved against the working directory, in order to know where to find those built files. In the nextjs SDK, we also use the value in two places: - At build time, we pass it to `@sentry/cli` via Sentry webpack plugin options. `sentry/cli` then resolves it against its working directory, so that it knows where to find built files to upload. - At runtime, we grab it from `global.__rewriteFramesDistDir__` (where we've stashed it at build time via our prefix loader), and then resolve it against the working directory, so the `RewriteFrames` integration knows what value to strip from stackframe paths. At runtime, this resolution always works, because it matches what nextjs itself does. At build time, it also works... most of the time. But in the case where the project directory and `@sentry/cli`'s working directory don't match, it leads to `@sentry/cli` not being able to find the files it needs to upload. (This can happen if, for example, the app is a package in a monorepo - located at `packages/nextjsApp`, say - and `@sentry/cli` is running from the monorepo's root level `node_modules`.) This fixes that by resolving the `distDir` value against the project directory (thereby turning it into an absolute path) before passing it to `@sentry/cli`. That way, no resolution on `@sentry/cli`'s part is necessary, preventing the mismatch. Fixes the problem outlined in #6194.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
We're using a monorepo (Nx) and it runs the NextJS build process in
./apps/webwith thedistDirset to../../dist/apps/web/.next.The CLI is being run at the root of the monorepo. As such,
../../dist/apps/web/.nextdoesn't find anything when it goes to upload the source maps.Proposed Solution
This allows a developer to set the
distDirfor the CLI without compromising the NextdistDir.Order of importance:
distDirOverridein the Nextsentryconfig object.distDirin the Next config..nextDidn't really know what to name it so, in the interim, stuck with
distDirOverride. 馃し