feat(nuxt): Add warning when Netlify or Vercel build is discovered by s1gr1d · Pull Request #13868 · getsentry/sentry-javascript

s1gr1d · 2024-10-04T12:50:57Z

Depending on this (because of the link in the warning): getsentry/sentry-docs#11486

lforst · 2024-10-04T12:52:44Z

packages/nuxt/src/module.ts

+        consoleSandbox(() => {
+          const serverDir = nitro.options.output.serverDir;
+
+          if (serverDir.includes('.netlify')) {


Maybe, just maybe, it's more robust to check for !!process.env.NETLIFY: https://docs.netlify.com/configure-builds/environment-variables/#build-metadata

That would only show the warning in the Netlify console, right? I think it's also useful to have this warning locally when people choose to use the netlify build preset. But I can add a || !!process.env.NETLIFY.

lforst · 2024-10-04T12:55:06Z

packages/nuxt/src/module.ts

+          if (serverDir.includes('.netlify')) {
+            // eslint-disable-next-line no-console
+            console.warn(
+              '[Sentry] Warning: The Sentry SDK discovered a Netlify build. The server-side Sentry support with ESM is experimental and may not work as expected. Please check out the docs for how to use Sentry on different deployment providers: https://docs.sentry.io/platforms/javascript/guides/nuxt/deployment-provider-setup/',


idk, maybe:

Suggested change

'[Sentry] Warning: The Sentry SDK discovered a Netlify build. The server-side Sentry support with ESM is experimental and may not work as expected. Please check out the docs for how to use Sentry on different deployment providers: https://docs.sentry.io/platforms/javascript/guides/nuxt/deployment-provider-setup/',

'[Sentry] Warning: The Sentry SDK detected a build running on Netlify. The Sentry Nuxt SDK support for ESM is currently experimental and requires additional setup. Please check out the docs for how to use Sentry on Netlify: https://docs.sentry.io/platforms/javascript/guides/nuxt/deployment-provider-setup/',

I think "with ESM" is more fitting because when you extend it, it would be "with ECMAScript Module syntax" and "for" sounds a bit off in this context. I did a quick search and I got more results with "with":

Edit: Okay, thinking about it "for" sound okay too when you look more at "support for" 😅

I am no English major but I think you have support "for" something and not "with" something. It's less about the word "ESM".

@lizokm hit us with the wisdom

It's "for" :) You're right @lforst, it's "support for" you could say "with the support of..." but that's a different meaning.

lforst · 2024-10-04T13:20:27Z

packages/nuxt/src/module.ts

It would also be great if we could detect when users actually set up everything correctly for the respective platform and not show the warning in that case.

Hmm...one thing we could do is getting the NODE_OPTIONS variable and check if the file path is correct.

It's a good idea.

lforst

👍

lforst · 2024-12-05T13:36:38Z

packages/nuxt/src/module.ts

+          if (serverDir.includes('.netlify') || !!process.env.NETLIFY) {
+            // eslint-disable-next-line no-console
+            console.warn(
+              '[Sentry] Warning: The Sentry SDK detected a Netlify build. Server-side support for the Sentry Nuxt SDK on Netlify is currently unreliable due to technical limitations of serverless functions. Traces are not collected, and some errors may not be reported. For more information on setting up Sentry on the Nuxt server-side, please refer to the documentation: https://docs.sentry.io/platforms/javascript/guides/nuxt/install/',


Suggested change

'[Sentry] Warning: The Sentry SDK detected a Netlify build. Server-side support for the Sentry Nuxt SDK on Netlify is currently unreliable due to technical limitations of serverless functions. Traces are not collected, and some errors may not be reported. For more information on setting up Sentry on the Nuxt server-side, please refer to the documentation: https://docs.sentry.io/platforms/javascript/guides/nuxt/install/',

'[Sentry] Warning: The Sentry SDK detected a Netlify build. Server-side support for the Sentry Nuxt SDK on Netlify is currently unreliable due to technical limitations of serverless functions. Traces are not collected, and errors may occasionally not be reported. For more information on setting up Sentry on the Nuxt server-side, please refer to the documentation: https://docs.sentry.io/platforms/javascript/guides/nuxt/install/',

lforst · 2024-12-05T13:39:31Z

packages/nuxt/src/module.ts

+          if (serverDir.includes('.vercel') || !!process.env.VERCEL) {
+            // eslint-disable-next-line no-console
+            console.warn(
+              '[Sentry] Warning: The Sentry SDK detected a Vercel build. The Sentry Nuxt SDK support for ESM on Vercel is currently experimental. Traces are not collected, but errors are reported. For more information on setting up Sentry on the Nuxt server-side, please refer to the documentation: https://docs.sentry.io/platforms/javascript/guides/nuxt/install/',


I am wondering, isn't Nuxt always ESM? If that is the case, it may make sense then to just not call out ESM at all and just say that tracing doesn't work on Vercel:

Suggested change

'[Sentry] Warning: The Sentry SDK detected a Vercel build. The Sentry Nuxt SDK support for ESM on Vercel is currently experimental. Traces are not collected, but errors are reported. For more information on setting up Sentry on the Nuxt server-side, please refer to the documentation: https://docs.sentry.io/platforms/javascript/guides/nuxt/install/',

'[Sentry] Warning: The Sentry SDK detected a Vercel build. The Sentry Nuxt SDK currently does not support tracing on Vercel. For more information on setting up Sentry on the Nuxt server-side, please refer to the documentation: https://docs.sentry.io/platforms/javascript/guides/nuxt/install/',

Yes it's always ESM - do you think it would still make sense to include this information somewhere? Like "The Sentry SDK detected a Vercel build. The Sentry Nuxt SDK currently does not support tracing on Vercel because of ESM on the server-side."?

From a user's perspective, I wouldn't care, since there is no way I can fix it. No strong opinions though. If you feel like it adds value, feel free to add a sentence like that.

s1gr1d marked this pull request as draft October 4, 2024 12:51

lforst approved these changes Oct 4, 2024

View reviewed changes

s1gr1d force-pushed the sig/warn-netlify branch from 42b0aa1 to b024239 Compare December 5, 2024 12:01

s1gr1d requested a review from andreiborza December 5, 2024 12:41

andreiborza approved these changes Dec 5, 2024

View reviewed changes

s1gr1d changed the title ~~feat(nuxt): Add warning when Netlify build is discovered~~ feat(nuxt): Add warning when Netlify or Vercel build is discovered Dec 5, 2024

lforst approved these changes Dec 5, 2024

View reviewed changes

s1gr1d added 3 commits December 6, 2024 12:48

feat(nuxt): Add warning when Netlify build discovered

a508319

change warning log and add vercel

c5f57b2

review suggestions

344a093

s1gr1d force-pushed the sig/warn-netlify branch from 08cfb85 to 344a093 Compare December 6, 2024 11:49

s1gr1d marked this pull request as ready for review December 6, 2024 13:20

s1gr1d merged commit 05e9dff into develop Dec 6, 2024

s1gr1d deleted the sig/warn-netlify branch December 6, 2024 13:20

	'[Sentry] Warning: The Sentry SDK discovered a Netlify build. The server-side Sentry support with ESM is experimental and may not work as expected. Please check out the docs for how to use Sentry on different deployment providers: https://docs.sentry.io/platforms/javascript/guides/nuxt/deployment-provider-setup/',
	'[Sentry] Warning: The Sentry SDK detected a build running on Netlify. The Sentry Nuxt SDK support for ESM is currently experimental and requires additional setup. Please check out the docs for how to use Sentry on Netlify: https://docs.sentry.io/platforms/javascript/guides/nuxt/deployment-provider-setup/',

Uh oh!

Conversation

s1gr1d commented Oct 4, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lforst Oct 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s1gr1d Oct 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lforst left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lforst Oct 4, 2024 •

edited

Loading

s1gr1d Oct 4, 2024 •

edited

Loading