feat(nextjs): Future-proof Next.js config options overriding#13586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lforst merged 2 commits into from
Sep 4, 2024
Merged

feat(nextjs): Future-proof Next.js config options overriding #13586

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
363391b
feat(nextjs): Future-proof Next.js config options overriding
Sep 4, 2024
78f718a
Merge remote-tracking branch 'origin/develop' into lforst-future-proo…
Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 70 additions & 13 deletions packages/nextjs/src/config/withSentryConfig.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
import { isThenable, parseSemver } from '@sentry/utils';

import * as fs from 'fs';
Expand DownExpand Up@@ -47,6 +48,7 @@ function getFinalConfigObject(
incomingUserNextConfigObject: NextConfigObject,
userSentryOptions: SentryBuildOptions,
): NextConfigObject {
// TODO(v9): Remove this check for the Sentry property
if ('sentry' in incomingUserNextConfigObject) {
// eslint-disable-next-line no-console
console.warn(
Expand All@@ -71,21 +73,10 @@ function getFinalConfigObject(
}
}

// We need to enable `instrumentation.ts` for users because we tell them to put their `Sentry.init()` calls inside of it.
if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
// eslint-disable-next-line no-console
console.warn(
'[@sentry/nextjs] You turned off the `instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.ts`.',
);
}
incomingUserNextConfigObject.experimental = {
instrumentationHook: true,
...incomingUserNextConfigObject.experimental,
};
const nextJsVersion = getNextjsVersion();

// Add the `clientTraceMetadata` experimental option based on Next.js version. The option got introduced in Next.js version 15.0.0 (actually 14.3.0-canary.64).
// Adding the option on lower versions will cause Next.js to print nasty warnings we wouldn't confront our users with.
const nextJsVersion = getNextjsVersion();
if (nextJsVersion) {
const { major, minor } = parseSemver(nextJsVersion);
if (major !== undefined && minor !== undefined && (major >= 15 || (major === 14 && minor >= 3))) {
Expand All@@ -99,10 +90,76 @@ function getFinalConfigObject(
} else {
// eslint-disable-next-line no-console
console.log(
"[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
"[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
);
}

// From Next.js version (15.0.0-canary.124) onwards, Next.js does no longer require the `experimental.instrumentationHook` option and will
// print a warning when it is set, so we need to conditionally provide it for lower versions.
if (nextJsVersion) {
const { major, minor, patch, prerelease } = parseSemver(nextJsVersion);
const isFullySupportedRelease =
major !== undefined &&
minor !== undefined &&
patch !== undefined &&
major >= 15 &&
((minor === 0 && patch === 0 && prerelease === undefined) || minor > 0 || patch > 0);
const isSupportedV15Rc =
major !== undefined &&
minor !== undefined &&
patch !== undefined &&
prerelease !== undefined &&
major === 15 &&
minor === 0 &&
patch === 0 &&
prerelease.startsWith('rc.') &&
parseInt(prerelease.split('.')[1] || '', 10) > 0;
const isSupportedCanary =
minor !== undefined &&
patch !== undefined &&
prerelease !== undefined &&
major === 15 &&
minor === 0 &&
patch === 0 &&
prerelease.startsWith('canary.') &&
parseInt(prerelease.split('.')[1] || '', 10) >= 124;

if (!isFullySupportedRelease && !isSupportedV15Rc && !isSupportedCanary) {
if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
// eslint-disable-next-line no-console
console.warn(
'[@sentry/nextjs] You turned off the `experimental.instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.(js|ts)`.',
);
}
incomingUserNextConfigObject.experimental = {
instrumentationHook: true,
...incomingUserNextConfigObject.experimental,
};
}
} else {
// If we cannot detect a Next.js version for whatever reason, the sensible default is to set the `experimental.instrumentationHook`, even though it may create a warning.
if (
incomingUserNextConfigObject.experimental &&
'instrumentationHook' in incomingUserNextConfigObject.experimental
) {
if (incomingUserNextConfigObject.experimental.instrumentationHook === false) {
// eslint-disable-next-line no-console
console.warn(
'[@sentry/nextjs] You set `experimental.instrumentationHook` to `false`. If you are using Next.js version 15 or greater, you can remove that option. If you are using Next.js version 14 or lower, you need to set `experimental.instrumentationHook` in your `next.config.(js|mjs)` to `true` for the SDK to be properly initialized in combination with `instrumentation.(js|ts)`.',
);
}
} else {
// eslint-disable-next-line no-console
console.log(
"[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, Next.js will probably show you a warning about the `experimental.instrumentationHook` being set. To silence Next.js' warning, explicitly set the `experimental.instrumentationHook` option in your `next.config.(js|mjs|ts)` to `undefined`. If you are on Next.js version 14 or lower, you can silence this particular warning by explicitly setting the `experimental.instrumentationHook` option in your `next.config.(js|mjs)` to `true`.",
);
incomingUserNextConfigObject.experimental = {
instrumentationHook: true,
...incomingUserNextConfigObject.experimental,
};
}
}

if (process.env.TURBOPACK && !process.env.SENTRY_SUPPRESS_TURBOPACK_WARNING) {
// eslint-disable-next-line no-console
console.warn(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(nextjs): Future-proof Next.js config options overriding#13586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lforst
merged 2 commits into

from

Sep 4, 2024
 Merged


feat(nextjs): Future-proof Next.js config options overriding
#13586
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
363391b

feat(nextjs): Future-proof Next.js config options overriding

Sep 4, 2024
78f718a

Merge remote-tracking branch 'origin/develop' into lforst-future-proo…

Sep 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 70 additions & 13 deletions
packages/nextjs/src/config/withSentryConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
import { isThenable, parseSemver } from '@sentry/utils';

import * as fs from 'fs';
Expand DownExpand Up@@ -47,6 +48,7 @@ function getFinalConfigObject(
 incomingUserNextConfigObject: NextConfigObject,
 userSentryOptions: SentryBuildOptions,
): NextConfigObject {
 // TODO(v9): Remove this check for the Sentry property
 if ('sentry' in incomingUserNextConfigObject) {
 // eslint-disable-next-line no-console
 console.warn(
Expand All@@ -71,21 +73,10 @@ function getFinalConfigObject(
 }
 }

 // We need to enable `instrumentation.ts` for users because we tell them to put their `Sentry.init()` calls inside of it.
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.ts`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 const nextJsVersion = getNextjsVersion();

 // Add the `clientTraceMetadata` experimental option based on Next.js version. The option got introduced in Next.js version 15.0.0 (actually 14.3.0-canary.64).
 // Adding the option on lower versions will cause Next.js to print nasty warnings we wouldn't confront our users with.
 const nextJsVersion = getNextjsVersion();
 if (nextJsVersion) {
 const { major, minor } = parseSemver(nextJsVersion);
 if (major !== undefined && minor !== undefined && (major >= 15 || (major === 14 && minor >= 3))) {
Expand All@@ -99,10 +90,76 @@ function getFinalConfigObject(
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 );
 }

 // From Next.js version (15.0.0-canary.124) onwards, Next.js does no longer require the `experimental.instrumentationHook` option and will
 // print a warning when it is set, so we need to conditionally provide it for lower versions.
 if (nextJsVersion) {
 const { major, minor, patch, prerelease } = parseSemver(nextJsVersion);
 const isFullySupportedRelease =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 major >= 15 &&
 ((minor === 0 && patch === 0 && prerelease === undefined) || minor > 0 || patch > 0);
 const isSupportedV15Rc =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('rc.') &&
 parseInt(prerelease.split('.')[1] || '', 10) > 0;
 const isSupportedCanary =
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('canary.') &&
 parseInt(prerelease.split('.')[1] || '', 10) >= 124;

 if (!isFullySupportedRelease && !isSupportedV15Rc && !isSupportedCanary) {
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `experimental.instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.(js|ts)`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 } else {
 // If we cannot detect a Next.js version for whatever reason, the sensible default is to set the `experimental.instrumentationHook`, even though it may create a warning.
 if (
 incomingUserNextConfigObject.experimental &&
 'instrumentationHook' in incomingUserNextConfigObject.experimental
 ) {
 if (incomingUserNextConfigObject.experimental.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You set `experimental.instrumentationHook` to `false`. If you are using Next.js version 15 or greater, you can remove that option. If you are using Next.js version 14 or lower, you need to set `experimental.instrumentationHook` in your `next.config.(js|mjs)` to `true` for the SDK to be properly initialized in combination with `instrumentation.(js|ts)`.',
 );
 }
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, Next.js will probably show you a warning about the `experimental.instrumentationHook` being set. To silence Next.js' warning, explicitly set the `experimental.instrumentationHook` option in your `next.config.(js|mjs|ts)` to `undefined`. If you are on Next.js version 14 or lower, you can silence this particular warning by explicitly setting the `experimental.instrumentationHook` option in your `next.config.(js|mjs)` to `true`.",
 );
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 }

 if (process.env.TURBOPACK && !process.env.SENTRY_SUPPRESS_TURBOPACK_WARNING) {
 // eslint-disable-next-line no-console
 console.warn(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(nextjs): Future-proof Next.js config options overriding#13586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lforst
merged 2 commits into

from

Sep 4, 2024
 Merged


feat(nextjs): Future-proof Next.js config options overriding
#13586
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
363391b

feat(nextjs): Future-proof Next.js config options overriding

Sep 4, 2024
78f718a

Merge remote-tracking branch 'origin/develop' into lforst-future-proo…

Sep 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 70 additions & 13 deletions
packages/nextjs/src/config/withSentryConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
import { isThenable, parseSemver } from '@sentry/utils';

import * as fs from 'fs';
Expand DownExpand Up@@ -47,6 +48,7 @@ function getFinalConfigObject(
 incomingUserNextConfigObject: NextConfigObject,
 userSentryOptions: SentryBuildOptions,
): NextConfigObject {
 // TODO(v9): Remove this check for the Sentry property
 if ('sentry' in incomingUserNextConfigObject) {
 // eslint-disable-next-line no-console
 console.warn(
Expand All@@ -71,21 +73,10 @@ function getFinalConfigObject(
 }
 }

 // We need to enable `instrumentation.ts` for users because we tell them to put their `Sentry.init()` calls inside of it.
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.ts`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 const nextJsVersion = getNextjsVersion();

 // Add the `clientTraceMetadata` experimental option based on Next.js version. The option got introduced in Next.js version 15.0.0 (actually 14.3.0-canary.64).
 // Adding the option on lower versions will cause Next.js to print nasty warnings we wouldn't confront our users with.
 const nextJsVersion = getNextjsVersion();
 if (nextJsVersion) {
 const { major, minor } = parseSemver(nextJsVersion);
 if (major !== undefined && minor !== undefined && (major >= 15 || (major === 14 && minor >= 3))) {
Expand All@@ -99,10 +90,76 @@ function getFinalConfigObject(
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 );
 }

 // From Next.js version (15.0.0-canary.124) onwards, Next.js does no longer require the `experimental.instrumentationHook` option and will
 // print a warning when it is set, so we need to conditionally provide it for lower versions.
 if (nextJsVersion) {
 const { major, minor, patch, prerelease } = parseSemver(nextJsVersion);
 const isFullySupportedRelease =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 major >= 15 &&
 ((minor === 0 && patch === 0 && prerelease === undefined) || minor > 0 || patch > 0);
 const isSupportedV15Rc =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('rc.') &&
 parseInt(prerelease.split('.')[1] || '', 10) > 0;
 const isSupportedCanary =
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('canary.') &&
 parseInt(prerelease.split('.')[1] || '', 10) >= 124;

 if (!isFullySupportedRelease && !isSupportedV15Rc && !isSupportedCanary) {
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `experimental.instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.(js|ts)`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 } else {
 // If we cannot detect a Next.js version for whatever reason, the sensible default is to set the `experimental.instrumentationHook`, even though it may create a warning.
 if (
 incomingUserNextConfigObject.experimental &&
 'instrumentationHook' in incomingUserNextConfigObject.experimental
 ) {
 if (incomingUserNextConfigObject.experimental.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You set `experimental.instrumentationHook` to `false`. If you are using Next.js version 15 or greater, you can remove that option. If you are using Next.js version 14 or lower, you need to set `experimental.instrumentationHook` in your `next.config.(js|mjs)` to `true` for the SDK to be properly initialized in combination with `instrumentation.(js|ts)`.',
 );
 }
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, Next.js will probably show you a warning about the `experimental.instrumentationHook` being set. To silence Next.js' warning, explicitly set the `experimental.instrumentationHook` option in your `next.config.(js|mjs|ts)` to `undefined`. If you are on Next.js version 14 or lower, you can silence this particular warning by explicitly setting the `experimental.instrumentationHook` option in your `next.config.(js|mjs)` to `true`.",
 );
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 }

 if (process.env.TURBOPACK && !process.env.SENTRY_SUPPRESS_TURBOPACK_WARNING) {
 // eslint-disable-next-line no-console
 console.warn(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(nextjs): Future-proof Next.js config options overriding#13586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lforst
merged 2 commits into

from

Sep 4, 2024
 Merged


feat(nextjs): Future-proof Next.js config options overriding
#13586
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
363391b

feat(nextjs): Future-proof Next.js config options overriding

Sep 4, 2024
78f718a

Merge remote-tracking branch 'origin/develop' into lforst-future-proo…

Sep 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 70 additions & 13 deletions
packages/nextjs/src/config/withSentryConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
import { isThenable, parseSemver } from '@sentry/utils';

import * as fs from 'fs';
Expand DownExpand Up@@ -47,6 +48,7 @@ function getFinalConfigObject(
 incomingUserNextConfigObject: NextConfigObject,
 userSentryOptions: SentryBuildOptions,
): NextConfigObject {
 // TODO(v9): Remove this check for the Sentry property
 if ('sentry' in incomingUserNextConfigObject) {
 // eslint-disable-next-line no-console
 console.warn(
Expand All@@ -71,21 +73,10 @@ function getFinalConfigObject(
 }
 }

 // We need to enable `instrumentation.ts` for users because we tell them to put their `Sentry.init()` calls inside of it.
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.ts`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 const nextJsVersion = getNextjsVersion();

 // Add the `clientTraceMetadata` experimental option based on Next.js version. The option got introduced in Next.js version 15.0.0 (actually 14.3.0-canary.64).
 // Adding the option on lower versions will cause Next.js to print nasty warnings we wouldn't confront our users with.
 const nextJsVersion = getNextjsVersion();
 if (nextJsVersion) {
 const { major, minor } = parseSemver(nextJsVersion);
 if (major !== undefined && minor !== undefined && (major >= 15 || (major === 14 && minor >= 3))) {
Expand All@@ -99,10 +90,76 @@ function getFinalConfigObject(
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 );
 }

 // From Next.js version (15.0.0-canary.124) onwards, Next.js does no longer require the `experimental.instrumentationHook` option and will
 // print a warning when it is set, so we need to conditionally provide it for lower versions.
 if (nextJsVersion) {
 const { major, minor, patch, prerelease } = parseSemver(nextJsVersion);
 const isFullySupportedRelease =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 major >= 15 &&
 ((minor === 0 && patch === 0 && prerelease === undefined) || minor > 0 || patch > 0);
 const isSupportedV15Rc =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('rc.') &&
 parseInt(prerelease.split('.')[1] || '', 10) > 0;
 const isSupportedCanary =
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('canary.') &&
 parseInt(prerelease.split('.')[1] || '', 10) >= 124;

 if (!isFullySupportedRelease && !isSupportedV15Rc && !isSupportedCanary) {
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `experimental.instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.(js|ts)`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 } else {
 // If we cannot detect a Next.js version for whatever reason, the sensible default is to set the `experimental.instrumentationHook`, even though it may create a warning.
 if (
 incomingUserNextConfigObject.experimental &&
 'instrumentationHook' in incomingUserNextConfigObject.experimental
 ) {
 if (incomingUserNextConfigObject.experimental.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You set `experimental.instrumentationHook` to `false`. If you are using Next.js version 15 or greater, you can remove that option. If you are using Next.js version 14 or lower, you need to set `experimental.instrumentationHook` in your `next.config.(js|mjs)` to `true` for the SDK to be properly initialized in combination with `instrumentation.(js|ts)`.',
 );
 }
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, Next.js will probably show you a warning about the `experimental.instrumentationHook` being set. To silence Next.js' warning, explicitly set the `experimental.instrumentationHook` option in your `next.config.(js|mjs|ts)` to `undefined`. If you are on Next.js version 14 or lower, you can silence this particular warning by explicitly setting the `experimental.instrumentationHook` option in your `next.config.(js|mjs)` to `true`.",
 );
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 }

 if (process.env.TURBOPACK && !process.env.SENTRY_SUPPRESS_TURBOPACK_WARNING) {
 // eslint-disable-next-line no-console
 console.warn(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(nextjs): Future-proof Next.js config options overriding#13586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lforst
merged 2 commits into

from

Sep 4, 2024
 Merged


feat(nextjs): Future-proof Next.js config options overriding
#13586
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
363391b

feat(nextjs): Future-proof Next.js config options overriding

Sep 4, 2024
78f718a

Merge remote-tracking branch 'origin/develop' into lforst-future-proo…

Sep 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 70 additions & 13 deletions
packages/nextjs/src/config/withSentryConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
import { isThenable, parseSemver } from '@sentry/utils';

import * as fs from 'fs';
Expand DownExpand Up@@ -47,6 +48,7 @@ function getFinalConfigObject(
 incomingUserNextConfigObject: NextConfigObject,
 userSentryOptions: SentryBuildOptions,
): NextConfigObject {
 // TODO(v9): Remove this check for the Sentry property
 if ('sentry' in incomingUserNextConfigObject) {
 // eslint-disable-next-line no-console
 console.warn(
Expand All@@ -71,21 +73,10 @@ function getFinalConfigObject(
 }
 }

 // We need to enable `instrumentation.ts` for users because we tell them to put their `Sentry.init()` calls inside of it.
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.ts`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 const nextJsVersion = getNextjsVersion();

 // Add the `clientTraceMetadata` experimental option based on Next.js version. The option got introduced in Next.js version 15.0.0 (actually 14.3.0-canary.64).
 // Adding the option on lower versions will cause Next.js to print nasty warnings we wouldn't confront our users with.
 const nextJsVersion = getNextjsVersion();
 if (nextJsVersion) {
 const { major, minor } = parseSemver(nextJsVersion);
 if (major !== undefined && minor !== undefined && (major >= 15 || (major === 14 && minor >= 3))) {
Expand All@@ -99,10 +90,76 @@ function getFinalConfigObject(
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 );
 }

 // From Next.js version (15.0.0-canary.124) onwards, Next.js does no longer require the `experimental.instrumentationHook` option and will
 // print a warning when it is set, so we need to conditionally provide it for lower versions.
 if (nextJsVersion) {
 const { major, minor, patch, prerelease } = parseSemver(nextJsVersion);
 const isFullySupportedRelease =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 major >= 15 &&
 ((minor === 0 && patch === 0 && prerelease === undefined) || minor > 0 || patch > 0);
 const isSupportedV15Rc =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('rc.') &&
 parseInt(prerelease.split('.')[1] || '', 10) > 0;
 const isSupportedCanary =
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('canary.') &&
 parseInt(prerelease.split('.')[1] || '', 10) >= 124;

 if (!isFullySupportedRelease && !isSupportedV15Rc && !isSupportedCanary) {
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `experimental.instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.(js|ts)`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 } else {
 // If we cannot detect a Next.js version for whatever reason, the sensible default is to set the `experimental.instrumentationHook`, even though it may create a warning.
 if (
 incomingUserNextConfigObject.experimental &&
 'instrumentationHook' in incomingUserNextConfigObject.experimental
 ) {
 if (incomingUserNextConfigObject.experimental.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You set `experimental.instrumentationHook` to `false`. If you are using Next.js version 15 or greater, you can remove that option. If you are using Next.js version 14 or lower, you need to set `experimental.instrumentationHook` in your `next.config.(js|mjs)` to `true` for the SDK to be properly initialized in combination with `instrumentation.(js|ts)`.',
 );
 }
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, Next.js will probably show you a warning about the `experimental.instrumentationHook` being set. To silence Next.js' warning, explicitly set the `experimental.instrumentationHook` option in your `next.config.(js|mjs|ts)` to `undefined`. If you are on Next.js version 14 or lower, you can silence this particular warning by explicitly setting the `experimental.instrumentationHook` option in your `next.config.(js|mjs)` to `true`.",
 );
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 }

 if (process.env.TURBOPACK && !process.env.SENTRY_SUPPRESS_TURBOPACK_WARNING) {
 // eslint-disable-next-line no-console
 console.warn(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(nextjs): Future-proof Next.js config options overriding#13586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lforst
merged 2 commits into

from

Sep 4, 2024
 Merged


feat(nextjs): Future-proof Next.js config options overriding
#13586
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
363391b

feat(nextjs): Future-proof Next.js config options overriding

Sep 4, 2024
78f718a

Merge remote-tracking branch 'origin/develop' into lforst-future-proo…

Sep 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 70 additions & 13 deletions
packages/nextjs/src/config/withSentryConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
import { isThenable, parseSemver } from '@sentry/utils';

import * as fs from 'fs';
Expand DownExpand Up@@ -47,6 +48,7 @@ function getFinalConfigObject(
 incomingUserNextConfigObject: NextConfigObject,
 userSentryOptions: SentryBuildOptions,
): NextConfigObject {
 // TODO(v9): Remove this check for the Sentry property
 if ('sentry' in incomingUserNextConfigObject) {
 // eslint-disable-next-line no-console
 console.warn(
Expand All@@ -71,21 +73,10 @@ function getFinalConfigObject(
 }
 }

 // We need to enable `instrumentation.ts` for users because we tell them to put their `Sentry.init()` calls inside of it.
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.ts`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 const nextJsVersion = getNextjsVersion();

 // Add the `clientTraceMetadata` experimental option based on Next.js version. The option got introduced in Next.js version 15.0.0 (actually 14.3.0-canary.64).
 // Adding the option on lower versions will cause Next.js to print nasty warnings we wouldn't confront our users with.
 const nextJsVersion = getNextjsVersion();
 if (nextJsVersion) {
 const { major, minor } = parseSemver(nextJsVersion);
 if (major !== undefined && minor !== undefined && (major >= 15 || (major === 14 && minor >= 3))) {
Expand All@@ -99,10 +90,76 @@ function getFinalConfigObject(
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 );
 }

 // From Next.js version (15.0.0-canary.124) onwards, Next.js does no longer require the `experimental.instrumentationHook` option and will
 // print a warning when it is set, so we need to conditionally provide it for lower versions.
 if (nextJsVersion) {
 const { major, minor, patch, prerelease } = parseSemver(nextJsVersion);
 const isFullySupportedRelease =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 major >= 15 &&
 ((minor === 0 && patch === 0 && prerelease === undefined) || minor > 0 || patch > 0);
 const isSupportedV15Rc =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('rc.') &&
 parseInt(prerelease.split('.')[1] || '', 10) > 0;
 const isSupportedCanary =
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('canary.') &&
 parseInt(prerelease.split('.')[1] || '', 10) >= 124;

 if (!isFullySupportedRelease && !isSupportedV15Rc && !isSupportedCanary) {
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `experimental.instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.(js|ts)`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 } else {
 // If we cannot detect a Next.js version for whatever reason, the sensible default is to set the `experimental.instrumentationHook`, even though it may create a warning.
 if (
 incomingUserNextConfigObject.experimental &&
 'instrumentationHook' in incomingUserNextConfigObject.experimental
 ) {
 if (incomingUserNextConfigObject.experimental.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You set `experimental.instrumentationHook` to `false`. If you are using Next.js version 15 or greater, you can remove that option. If you are using Next.js version 14 or lower, you need to set `experimental.instrumentationHook` in your `next.config.(js|mjs)` to `true` for the SDK to be properly initialized in combination with `instrumentation.(js|ts)`.',
 );
 }
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, Next.js will probably show you a warning about the `experimental.instrumentationHook` being set. To silence Next.js' warning, explicitly set the `experimental.instrumentationHook` option in your `next.config.(js|mjs|ts)` to `undefined`. If you are on Next.js version 14 or lower, you can silence this particular warning by explicitly setting the `experimental.instrumentationHook` option in your `next.config.(js|mjs)` to `true`.",
 );
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 }

 if (process.env.TURBOPACK && !process.env.SENTRY_SUPPRESS_TURBOPACK_WARNING) {
 // eslint-disable-next-line no-console
 console.warn(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(nextjs): Future-proof Next.js config options overriding#13586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lforst
merged 2 commits into

from

Sep 4, 2024
 Merged


feat(nextjs): Future-proof Next.js config options overriding
#13586
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
363391b

feat(nextjs): Future-proof Next.js config options overriding

Sep 4, 2024
78f718a

Merge remote-tracking branch 'origin/develop' into lforst-future-proo…

Sep 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 70 additions & 13 deletions
packages/nextjs/src/config/withSentryConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
import { isThenable, parseSemver } from '@sentry/utils';

import * as fs from 'fs';
Expand DownExpand Up@@ -47,6 +48,7 @@ function getFinalConfigObject(
 incomingUserNextConfigObject: NextConfigObject,
 userSentryOptions: SentryBuildOptions,
): NextConfigObject {
 // TODO(v9): Remove this check for the Sentry property
 if ('sentry' in incomingUserNextConfigObject) {
 // eslint-disable-next-line no-console
 console.warn(
Expand All@@ -71,21 +73,10 @@ function getFinalConfigObject(
 }
 }

 // We need to enable `instrumentation.ts` for users because we tell them to put their `Sentry.init()` calls inside of it.
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.ts`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 const nextJsVersion = getNextjsVersion();

 // Add the `clientTraceMetadata` experimental option based on Next.js version. The option got introduced in Next.js version 15.0.0 (actually 14.3.0-canary.64).
 // Adding the option on lower versions will cause Next.js to print nasty warnings we wouldn't confront our users with.
 const nextJsVersion = getNextjsVersion();
 if (nextJsVersion) {
 const { major, minor } = parseSemver(nextJsVersion);
 if (major !== undefined && minor !== undefined && (major >= 15 || (major === 14 && minor >= 3))) {
Expand All@@ -99,10 +90,76 @@ function getFinalConfigObject(
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 );
 }

 // From Next.js version (15.0.0-canary.124) onwards, Next.js does no longer require the `experimental.instrumentationHook` option and will
 // print a warning when it is set, so we need to conditionally provide it for lower versions.
 if (nextJsVersion) {
 const { major, minor, patch, prerelease } = parseSemver(nextJsVersion);
 const isFullySupportedRelease =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 major >= 15 &&
 ((minor === 0 && patch === 0 && prerelease === undefined) || minor > 0 || patch > 0);
 const isSupportedV15Rc =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('rc.') &&
 parseInt(prerelease.split('.')[1] || '', 10) > 0;
 const isSupportedCanary =
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('canary.') &&
 parseInt(prerelease.split('.')[1] || '', 10) >= 124;

 if (!isFullySupportedRelease && !isSupportedV15Rc && !isSupportedCanary) {
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `experimental.instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.(js|ts)`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 } else {
 // If we cannot detect a Next.js version for whatever reason, the sensible default is to set the `experimental.instrumentationHook`, even though it may create a warning.
 if (
 incomingUserNextConfigObject.experimental &&
 'instrumentationHook' in incomingUserNextConfigObject.experimental
 ) {
 if (incomingUserNextConfigObject.experimental.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You set `experimental.instrumentationHook` to `false`. If you are using Next.js version 15 or greater, you can remove that option. If you are using Next.js version 14 or lower, you need to set `experimental.instrumentationHook` in your `next.config.(js|mjs)` to `true` for the SDK to be properly initialized in combination with `instrumentation.(js|ts)`.',
 );
 }
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, Next.js will probably show you a warning about the `experimental.instrumentationHook` being set. To silence Next.js' warning, explicitly set the `experimental.instrumentationHook` option in your `next.config.(js|mjs|ts)` to `undefined`. If you are on Next.js version 14 or lower, you can silence this particular warning by explicitly setting the `experimental.instrumentationHook` option in your `next.config.(js|mjs)` to `true`.",
 );
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 }

 if (process.env.TURBOPACK && !process.env.SENTRY_SUPPRESS_TURBOPACK_WARNING) {
 // eslint-disable-next-line no-console
 console.warn(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(nextjs): Future-proof Next.js config options overriding#13586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lforst
merged 2 commits into

from

Sep 4, 2024
 Merged


feat(nextjs): Future-proof Next.js config options overriding
#13586
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
363391b

feat(nextjs): Future-proof Next.js config options overriding

Sep 4, 2024
78f718a

Merge remote-tracking branch 'origin/develop' into lforst-future-proo…

Sep 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 70 additions & 13 deletions
packages/nextjs/src/config/withSentryConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
import { isThenable, parseSemver } from '@sentry/utils';

import * as fs from 'fs';
Expand DownExpand Up@@ -47,6 +48,7 @@ function getFinalConfigObject(
 incomingUserNextConfigObject: NextConfigObject,
 userSentryOptions: SentryBuildOptions,
): NextConfigObject {
 // TODO(v9): Remove this check for the Sentry property
 if ('sentry' in incomingUserNextConfigObject) {
 // eslint-disable-next-line no-console
 console.warn(
Expand All@@ -71,21 +73,10 @@ function getFinalConfigObject(
 }
 }

 // We need to enable `instrumentation.ts` for users because we tell them to put their `Sentry.init()` calls inside of it.
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.ts`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 const nextJsVersion = getNextjsVersion();

 // Add the `clientTraceMetadata` experimental option based on Next.js version. The option got introduced in Next.js version 15.0.0 (actually 14.3.0-canary.64).
 // Adding the option on lower versions will cause Next.js to print nasty warnings we wouldn't confront our users with.
 const nextJsVersion = getNextjsVersion();
 if (nextJsVersion) {
 const { major, minor } = parseSemver(nextJsVersion);
 if (major !== undefined && minor !== undefined && (major >= 15 || (major === 14 && minor >= 3))) {
Expand All@@ -99,10 +90,76 @@ function getFinalConfigObject(
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, please add `experimental.clientTraceMetadata: ['sentry-trace', 'baggage']` to your Next.js config to enable pageload tracing for App Router.",
 );
 }

 // From Next.js version (15.0.0-canary.124) onwards, Next.js does no longer require the `experimental.instrumentationHook` option and will
 // print a warning when it is set, so we need to conditionally provide it for lower versions.
 if (nextJsVersion) {
 const { major, minor, patch, prerelease } = parseSemver(nextJsVersion);
 const isFullySupportedRelease =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 major >= 15 &&
 ((minor === 0 && patch === 0 && prerelease === undefined) || minor > 0 || patch > 0);
 const isSupportedV15Rc =
 major !== undefined &&
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('rc.') &&
 parseInt(prerelease.split('.')[1] || '', 10) > 0;
 const isSupportedCanary =
 minor !== undefined &&
 patch !== undefined &&
 prerelease !== undefined &&
 major === 15 &&
 minor === 0 &&
 patch === 0 &&
 prerelease.startsWith('canary.') &&
 parseInt(prerelease.split('.')[1] || '', 10) >= 124;

 if (!isFullySupportedRelease && !isSupportedV15Rc && !isSupportedCanary) {
 if (incomingUserNextConfigObject.experimental?.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You turned off the `experimental.instrumentationHook` option. Note that Sentry will not be initialized if you did not set it up inside `instrumentation.(js|ts)`.',
 );
 }
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 } else {
 // If we cannot detect a Next.js version for whatever reason, the sensible default is to set the `experimental.instrumentationHook`, even though it may create a warning.
 if (
 incomingUserNextConfigObject.experimental &&
 'instrumentationHook' in incomingUserNextConfigObject.experimental
 ) {
 if (incomingUserNextConfigObject.experimental.instrumentationHook === false) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/nextjs] You set `experimental.instrumentationHook` to `false`. If you are using Next.js version 15 or greater, you can remove that option. If you are using Next.js version 14 or lower, you need to set `experimental.instrumentationHook` in your `next.config.(js|mjs)` to `true` for the SDK to be properly initialized in combination with `instrumentation.(js|ts)`.',
 );
 }
 } else {
 // eslint-disable-next-line no-console
 console.log(
 "[@sentry/nextjs] The Sentry SDK was not able to determine your Next.js version. If you are using Next.js version 15 or greater, Next.js will probably show you a warning about the `experimental.instrumentationHook` being set. To silence Next.js' warning, explicitly set the `experimental.instrumentationHook` option in your `next.config.(js|mjs|ts)` to `undefined`. If you are on Next.js version 14 or lower, you can silence this particular warning by explicitly setting the `experimental.instrumentationHook` option in your `next.config.(js|mjs)` to `true`.",
 );
 incomingUserNextConfigObject.experimental = {
 instrumentationHook: true,
 ...incomingUserNextConfigObject.experimental,
 };
 }
 }

 if (process.env.TURBOPACK && !process.env.SENTRY_SUPPRESS_TURBOPACK_WARNING) {
 // eslint-disable-next-line no-console
 console.warn(
Expand Down