[nextjs] support assetPrefix option

[klapec]

Package + Version

• @sentry/cli: 1.71.0
• @sentry/nextjs: 6.15.0

Description

I have my Next.js (12.0.4) app served with an assetPrefix option in the next.config.js set to point to a custom CDN location.

Unfortunately, my on-premise Sentry instance seems to be not matching the sourcemaps that are being uploaded every time I do a production app build with the exception trace filename.

Here's the filename that I see in the issue's exception trace filename: /multi-prod/B991483/react/_next/static/chunks/pages/_app-40564a69361d2d0a.js

Here's the filename that I seen in the project's Source Maps > Archive page: ~/_next/static/chunks/pages/_app-40564a69361d2d0a.js (and a corresponding .js.map file: ~/_next/static/chunks/pages/_app-40564a69361d2d0a.js.map)

The actual script is served from https://cdnprod.example.com/multi-prod/B991483/react/_next/static/chunks/pages/_app-40564a69361d2d0a.js

And the script has a following sourceMappingURL comment: //# sourceMappingURL=_app-40564a69361d2d0a.js.map.

Is this all correct? The issue here is that every issue has problems with "Source code was not found".

[nikolay-govorov]

I am experiencing such difficulties - the application is used assetPrefix, which is not taken into account when downloading the release.

I noticed that the toolkit is already checking the basePath. Do you think it is possible to take into account assetPrefix in a similar way?

[github-actions]

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

---

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

[klapec]

This is still relevant as Sentry is unaware of my source maps - which makes debugging quite difficult.

[nikolay-govorov]

This is still relevant for me, I can't use this package, I have to maintain my own configuration. Is there any way I can help in researching the problem?

[colbyjohnson-care]

I have to maintain my own configuration. Is there any way I can help in researching the problem?

This is relevant for us as well. @nikolay-govorov any tips you have to begin on a placeholder configuration to get this working?

[smeubank]

Hi all

we are taking this into our backlog to review, we are aware of the issue and appreciate the need to keep the ticket open.

[lukasvice]

Is there any progress or ETA for this improvement? Thanks!

This is my workaround in the next.config.js:

const sentryNextConfig = withSentryConfig(nextConfig)

// Workaround: fix urlPrefix in Sentry source map config if assetPrefix is used in the Next config
const newWebpackFunction = (incomingConfig, buildContext) => {
  let newConfig = { ...incomingConfig };

  // If user has custom webpack config, run it so we have actual values to work with
  if ('webpack' in sentryNextConfig && typeof sentryNextConfig.webpack === 'function') {
    newConfig = sentryNextConfig.webpack(newConfig, buildContext);
  }

  // Find the SentryCliPlugin options and prepend the assetPrefix to the urlPrefix
  const sentryCliPlugin = newConfig.plugins?.find((p) => typeof p === 'object' && p.constructor?.name === 'SentryCliPlugin')
  sentryCliPlugin?.options?.include?.forEach(option => {
    if (option.urlPrefix) {
      option.urlPrefix = option.urlPrefix.replace('~', `~${sentryNextConfig.assetPrefix}`)
    }
  })

  return newConfig
}

nextConfig = {
  ...sentryNextConfig,
  webpack: newWebpackFunction
}

[jarvelov]

Thank you @lukasvice for the workaround. It works perfectly!

Hoping to see built in support for assetPrefix in Sentry someday.

[panghaoyuan]

i have same qustion. I used a not very good way to solve this problem

@smeubank

I hope my issue will help you resolve this issue as soon as possible. (my issues)(#5072)

i think assetPrefix can perfect resolve this issue. such as

const urlPrefix = (userNextConfig.basePath || userNextConfig.assetPrefix) ? 
`~${userNextConfig.basePath || ''}${userNextConfig.assetPrefix || "}/_next` : 
'~/_next'; 

sentry-javascript/packages/nextjs/src/config/webpack.ts

Line 460 in 034e07d

const urlPrefix = userNextConfig.basePath ? `~${userNextConfig.basePath}/_next` : '~/_next';

[tomas-c]

The workaround from @panghaoyuan causes files to be uploaded without server/chunks/ or static/chunks/ in the path.

I suspect it's because while the workaround overwrites urlPrefix that is passed into the CLI tool, it does not overwrite urlPrefix used in serverIncludes and clientIncludes here:

sentry-javascript/packages/nextjs/src/config/webpack.ts

Line 463 in 5be5a04

? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]

[lobsterkatie]

Hey, all.

This should be fixed now, and will go out in the next release (some time next week).

[lucas0530]

is that solved?