feat(nextjs): Add automatic sourcemapping for edge part of the SDK#9454

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 3 commits into from
Nov 6, 2023
Merged

feat(nextjs): Add automatic sourcemapping for edge part of the SDK #9454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6bdda33
feat(nextjs): Add automatic sourcemapping for Next.js edge
Nov 6, 2023
fa2037b
ci
Nov 6, 2023
003607c
hmm
Nov 6, 2023
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
2 changes: 1 addition & 1 deletion packages/bun/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {

const clientOptions: ServerRuntimeClientOptions = {
...options,
platform: 'bun',
platform: 'javascript',

@Lms24Lms24Nov 6, 2023•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(no action required) hmm completely fine for now but maybe we should tell symbolicator about other platforms?
Although we could also just "converge" towards javascript for everything WinterCG (i.e. not Node) I guess

@lforstlforstNov 6, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should definitely either add new platforms to symbolicator or converge everything. I even vote we have two platforms: server-js and js because I think that's the only differenciator. For browser js we crawl source files for node we don't.

runtime: { name: 'bun', version: Bun.version },
serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(),
};
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/serverruntimeclient.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,13 +22,13 @@ describe('ServerRuntimeClient', () => {
describe('_prepareEvent', () => {
test('adds platform to event', () => {
const options = getDefaultClientOptions({ dsn: PUBLIC_DSN });
const client = new ServerRuntimeClient({ ...options, platform: 'edge' });
const client = new ServerRuntimeClient({ ...options, platform: 'blargh' });

const event: Event = {};
const hint: EventHint = {};
(client as any)._prepareEvent(event, hint);

expect(event.platform).toEqual('edge');
expect(event.platform).toEqual('blargh');
});

test('adds server_name to event', () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/deno/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ export class DenoClient extends ServerRuntimeClient<DenoClientOptions> {

const clientOptions: ServerRuntimeClientOptions = {
...options,
platform: 'deno',
platform: 'javascript',
runtime: { name: 'deno', version: Deno.version.deno },
serverName: options.serverName || getHostName(),
};
Expand Down
4 changes: 2 additions & 2 deletions packages/deno/test/__snapshots__/mod.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -135,7 +135,7 @@ snapshot[`captureException 1`] = `
},
],
},
platform: "deno",
platform: "javascript",
sdk: {
integrations: [
"InboundFilters",
Expand DownExpand Up@@ -195,7 +195,7 @@ snapshot[`captureMessage 1`] = `
event_id: "{{id}}",
level: "info",
message: "Some error message",
platform: "deno",
platform: "javascript",
sdk: {
integrations: [
"InboundFilters",
Expand Down
29 changes: 13 additions & 16 deletions packages/nextjs/src/config/webpack.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -686,24 +686,20 @@ export function getWebpackPluginOptions(
userPluginOptions: Partial<SentryWebpackPluginOptions>,
userSentryOptions: UserSentryOptions,
): SentryWebpackPluginOptions {
const { buildId, isServer, webpack, config, dir: projectDir } = buildContext;
const { buildId, isServer, config, dir: projectDir } = buildContext;
const userNextConfig = config as NextConfigObject;

const distDirAbsPath = path.resolve(projectDir, userNextConfig.distDir || '.next'); // `.next` is the default directory

const isWebpack5 = webpack.version.startsWith('5');
const isServerless = userNextConfig.target === 'experimental-serverless-trace';
const hasSentryProperties = fs.existsSync(path.resolve(projectDir, 'sentry.properties'));
const urlPrefix = '~/_next';

const serverInclude = isServerless
? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]
: [
{ paths: [`${distDirAbsPath}/server/pages/`], urlPrefix: `${urlPrefix}/server/pages` },
{ paths: [`${distDirAbsPath}/server/app/`], urlPrefix: `${urlPrefix}/server/app` },
].concat(
isWebpack5 ? [{ paths: [`${distDirAbsPath}/server/chunks/`], urlPrefix: `${urlPrefix}/server/chunks` }] : [],
);
: [{ paths: [`${distDirAbsPath}/server/`], urlPrefix: `${urlPrefix}/server` }];

const serverIgnore: string[] = [];

const clientInclude = userSentryOptions.widenClientFileUpload
? [{ paths: [`${distDirAbsPath}/static/chunks`], urlPrefix: `${urlPrefix}/static/chunks` }]
Expand All@@ -712,15 +708,16 @@ export function getWebpackPluginOptions(
{ paths: [`${distDirAbsPath}/static/chunks/app`], urlPrefix: `${urlPrefix}/static/chunks/app` },
];

// Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
// don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
// will be there.
const clientIgnore = userSentryOptions.widenClientFileUpload
? ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*']
: [];

const defaultPluginOptions = dropUndefinedKeys({
include: isServer ? serverInclude : clientInclude,
ignore:
isServer || !userSentryOptions.widenClientFileUpload
? []
: // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
// don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
// will be there.
['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*'],
ignore: isServer ? serverIgnore : clientIgnore,
url: process.env.SENTRY_URL,
org: process.env.SENTRY_ORG,
project: process.env.SENTRY_PROJECT,
Expand DownExpand Up@@ -975,7 +972,7 @@ function addValueInjectionLoader(

newConfig.module.rules.push(
{
test: /sentry\.server\.config\.(jsx?|tsx?)/,
test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
use: [
{
loader: path.resolve(__dirname, 'loaders/valueInjectionLoader.js'),
Expand Down
30 changes: 30 additions & 0 deletions packages/nextjs/src/edge/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
import { SDK_VERSION } from '@sentry/core';
import { RewriteFrames } from '@sentry/integrations';
import type { SdkMetadata } from '@sentry/types';
import { addOrUpdateIntegration, escapeStringForRegex, GLOBAL_OBJ } from '@sentry/utils';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

export type EdgeOptions = VercelEdgeOptions;

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
__rewriteFramesDistDir__?: string;
};

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: VercelEdgeOptions = {}): void {
const opts = {
Expand All@@ -23,6 +29,30 @@ export function init(options: VercelEdgeOptions = {}): void {
version: SDK_VERSION,
};

let integrations = opts.integrations || [];

// This value is injected at build time, based on the output directory specified in the build config. Though a default
// is set there, we set it here as well, just in case something has gone wrong with the injection.
const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
if (distDirName) {
const distDirAbsPath = distDirName.replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one

// Normally we would use `path.resolve` to obtain the absolute path we will strip from the stack frame to align with
// the uploaded artifacts, however we don't have access to that API in edge so we need to be a bit more lax.
const SOURCEMAP_FILENAME_REGEX = new RegExp(`.*${escapeStringForRegex(distDirAbsPath)}`);

const defaultRewriteFramesIntegration = new RewriteFrames({
iteratee: frame => {
frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
return frame;
},
});

integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
}

opts.integrations = integrations;

vercelEdgeInit(opts);
}

Expand Down
30 changes: 16 additions & 14 deletions packages/nextjs/src/server/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function showReportDialog(): void {
}

const globalWithInjectedValues = global as typeof global & {
__rewriteFramesDistDir__: string;
__rewriteFramesDistDir__?: string;
};

// TODO (v8): Remove this
Expand DownExpand Up@@ -119,19 +119,21 @@ function addServerIntegrations(options: NodeOptions): void {

// This value is injected at build time, based on the output directory specified in the build config. Though a default
// is set there, we set it here as well, just in case something has gone wrong with the injection.
const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__ || '.next';
// nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
// we can read in the project directory from the currently running process
const distDirAbsPath = path.resolve(process.cwd(), distDirName);
const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

const defaultRewriteFramesIntegration = new RewriteFrames({
iteratee: frame => {
frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
return frame;
},
});
integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
if (distDirName) {
// nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
// we can read in the project directory from the currently running process
const distDirAbsPath = path.resolve(distDirName).replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one
const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

const defaultRewriteFramesIntegration = new RewriteFrames({
iteratee: frame => {
frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
return frame;
},
});
integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
}

const defaultOnUncaughtExceptionIntegration: IntegrationWithExclusionOption = new Integrations.OnUncaughtException({
exitEvenIfOtherHandlersAreRegistered: false,
Expand Down
2 changes: 1 addition & 1 deletion packages/nextjs/test/config/loaders.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ describe('webpack loaders', () => {
});

expect(finalWebpackConfig.module.rules).toContainEqual({
test: /sentry\.server\.config\.(jsx?|tsx?)/,
test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
use: [
{
loader: expect.stringEndingWith('valueInjectionLoader.js'),
Expand Down
7 changes: 2 additions & 5 deletions packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,7 @@ describe('Sentry webpack plugin config', () => {
) as SentryWebpackPlugin;

expect(sentryWebpackPluginInstance.options.include).toEqual([
{ paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
{ paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
{ paths: [`${serverBuildContextWebpack4.dir}/.next/server/`], urlPrefix: '~/_next/server' },
]);
});

Expand All@@ -159,9 +158,7 @@ describe('Sentry webpack plugin config', () => {
) as SentryWebpackPlugin;

expect(sentryWebpackPluginInstance.options.include).toEqual([
{ paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
{ paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
{ paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
{ paths: [`${serverBuildContext.dir}/.next/server/`], urlPrefix: '~/_next/server' },
]);
});
});
Expand Down
2 changes: 1 addition & 1 deletion packages/vercel-edge/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOption

const clientOptions: ServerRuntimeClientOptions = {
...options,
platform: 'vercel-edge',
platform: 'javascript',
// TODO: Grab version information
runtime: { name: 'vercel-edge' },
serverName: options.serverName || process.env.SENTRY_NAME,
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): Add automatic sourcemapping for edge part of the SDK#9454

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 3 commits into

from

Nov 6, 2023
 Merged


feat(nextjs): Add automatic sourcemapping for edge part of the SDK
#9454
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6bdda33

feat(nextjs): Add automatic sourcemapping for Next.js edge

Nov 6, 2023
fa2037b

ci

Nov 6, 2023
003607c

hmm

Nov 6, 2023

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


2 changes: 1 addition & 1 deletion
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'bun',
 platform: 'javascript',
@Lms24Lms24Nov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(no action required) hmm completely fine for now but maybe we should tell symbolicator about other platforms?

Although we could also just "converge" towards javascript for everything WinterCG (i.e. not Node) I guess
@lforstlforstNov 6, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should definitely either add new platforms to symbolicator or converge everything. I even vote we have two platforms: server-js and js because I think that's the only differenciator. For browser js we crawl source files for node we don't.
 runtime: { name: 'bun', version: Bun.version },
 serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/test/lib/serverruntimeclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,13 +22,13 @@ describe('ServerRuntimeClient', () => {
 describe('_prepareEvent', () => {
 test('adds platform to event', () => {
 const options = getDefaultClientOptions({ dsn: PUBLIC_DSN });
 const client = new ServerRuntimeClient({ ...options, platform: 'edge' });
 const client = new ServerRuntimeClient({ ...options, platform: 'blargh' });

 const event: Event = {};
 const hint: EventHint = {};
 (client as any)._prepareEvent(event, hint);

 expect(event.platform).toEqual('edge');
 expect(event.platform).toEqual('blargh');
 });

 test('adds server_name to event', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/deno/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ export class DenoClient extends ServerRuntimeClient<DenoClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'deno',
 platform: 'javascript',
 runtime: { name: 'deno', version: Deno.version.deno },
 serverName: options.serverName || getHostName(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/deno/test/__snapshots__/mod.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -135,7 +135,7 @@ snapshot[`captureException 1`] = `
 },
 ],
 },
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand DownExpand Up@@ -195,7 +195,7 @@ snapshot[`captureMessage 1`] = `
 event_id: "{{id}}",
 level: "info",
 message: "Some error message",
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand Down

29 changes: 13 additions & 16 deletions
packages/nextjs/src/config/webpack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,24 +686,20 @@ export function getWebpackPluginOptions(
 userPluginOptions: Partial<SentryWebpackPluginOptions>,
 userSentryOptions: UserSentryOptions,
): SentryWebpackPluginOptions {
 const { buildId, isServer, webpack, config, dir: projectDir } = buildContext;
 const { buildId, isServer, config, dir: projectDir } = buildContext;
 const userNextConfig = config as NextConfigObject;

 const distDirAbsPath = path.resolve(projectDir, userNextConfig.distDir || '.next'); // `.next` is the default directory

 const isWebpack5 = webpack.version.startsWith('5');
 const isServerless = userNextConfig.target === 'experimental-serverless-trace';
 const hasSentryProperties = fs.existsSync(path.resolve(projectDir, 'sentry.properties'));
 const urlPrefix = '~/_next';

 const serverInclude = isServerless
 ? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]
 : [
 { paths: [`${distDirAbsPath}/server/pages/`], urlPrefix: `${urlPrefix}/server/pages` },
 { paths: [`${distDirAbsPath}/server/app/`], urlPrefix: `${urlPrefix}/server/app` },
 ].concat(
 isWebpack5 ? [{ paths: [`${distDirAbsPath}/server/chunks/`], urlPrefix: `${urlPrefix}/server/chunks` }] : [],
 );
 : [{ paths: [`${distDirAbsPath}/server/`], urlPrefix: `${urlPrefix}/server` }];

 const serverIgnore: string[] = [];

 const clientInclude = userSentryOptions.widenClientFileUpload
 ? [{ paths: [`${distDirAbsPath}/static/chunks`], urlPrefix: `${urlPrefix}/static/chunks` }]
Expand All@@ -712,15 +708,16 @@ export function getWebpackPluginOptions(
 { paths: [`${distDirAbsPath}/static/chunks/app`], urlPrefix: `${urlPrefix}/static/chunks/app` },
 ];

 // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 const clientIgnore = userSentryOptions.widenClientFileUpload
 ? ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*']
 : [];

 const defaultPluginOptions = dropUndefinedKeys({
 include: isServer ? serverInclude : clientInclude,
 ignore:
 isServer || !userSentryOptions.widenClientFileUpload
 ? []
 : // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*'],
 ignore: isServer ? serverIgnore : clientIgnore,
 url: process.env.SENTRY_URL,
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
Expand DownExpand Up@@ -975,7 +972,7 @@ function addValueInjectionLoader(

 newConfig.module.rules.push(
 {
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: path.resolve(__dirname, 'loaders/valueInjectionLoader.js'),
Expand Down

30 changes: 30 additions & 0 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
import { SDK_VERSION } from '@sentry/core';
import { RewriteFrames } from '@sentry/integrations';
import type { SdkMetadata } from '@sentry/types';
import { addOrUpdateIntegration, escapeStringForRegex, GLOBAL_OBJ } from '@sentry/utils';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

export type EdgeOptions = VercelEdgeOptions;

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 __rewriteFramesDistDir__?: string;
};

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: VercelEdgeOptions = {}): void {
 const opts = {
Expand All@@ -23,6 +29,30 @@ export function init(options: VercelEdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 let integrations = opts.integrations || [];

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 const distDirAbsPath = distDirName.replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one

 // Normally we would use `path.resolve` to obtain the absolute path we will strip from the stack frame to align with
 // the uploaded artifacts, however we don't have access to that API in edge so we need to be a bit more lax.
 const SOURCEMAP_FILENAME_REGEX = new RegExp(`.*${escapeStringForRegex(distDirAbsPath)}`);

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });

 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 opts.integrations = integrations;

 vercelEdgeInit(opts);
}

Expand Down

30 changes: 16 additions & 14 deletions
packages/nextjs/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function showReportDialog(): void {
}

const globalWithInjectedValues = global as typeof global & {
 __rewriteFramesDistDir__: string;
 __rewriteFramesDistDir__?: string;
};

// TODO (v8): Remove this
Expand DownExpand Up@@ -119,19 +119,21 @@ function addServerIntegrations(options: NodeOptions): void {

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__ || '.next';
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(process.cwd(), distDirName);
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(distDirName).replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 const defaultOnUncaughtExceptionIntegration: IntegrationWithExclusionOption = new Integrations.OnUncaughtException({
 exitEvenIfOtherHandlersAreRegistered: false,
Expand Down

2 changes: 1 addition & 1 deletion
packages/nextjs/test/config/loaders.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ describe('webpack loaders', () => {
 });

 expect(finalWebpackConfig.module.rules).toContainEqual({
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: expect.stringEndingWith('valueInjectionLoader.js'),
Expand Down

7 changes: 2 additions & 5 deletions
packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });

Expand All@@ -159,9 +158,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
 { paths: [`${serverBuildContext.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/vercel-edge/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOption

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'vercel-edge',
 platform: 'javascript',
 // TODO: Grab version information
 runtime: { name: 'vercel-edge' },
 serverName: options.serverName || process.env.SENTRY_NAME,
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): Add automatic sourcemapping for edge part of the SDK#9454

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 3 commits into

from

Nov 6, 2023
 Merged


feat(nextjs): Add automatic sourcemapping for edge part of the SDK
#9454
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6bdda33

feat(nextjs): Add automatic sourcemapping for Next.js edge

Nov 6, 2023
fa2037b

ci

Nov 6, 2023
003607c

hmm

Nov 6, 2023

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


2 changes: 1 addition & 1 deletion
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'bun',
 platform: 'javascript',
@Lms24Lms24Nov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(no action required) hmm completely fine for now but maybe we should tell symbolicator about other platforms?

Although we could also just "converge" towards javascript for everything WinterCG (i.e. not Node) I guess
@lforstlforstNov 6, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should definitely either add new platforms to symbolicator or converge everything. I even vote we have two platforms: server-js and js because I think that's the only differenciator. For browser js we crawl source files for node we don't.
 runtime: { name: 'bun', version: Bun.version },
 serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/test/lib/serverruntimeclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,13 +22,13 @@ describe('ServerRuntimeClient', () => {
 describe('_prepareEvent', () => {
 test('adds platform to event', () => {
 const options = getDefaultClientOptions({ dsn: PUBLIC_DSN });
 const client = new ServerRuntimeClient({ ...options, platform: 'edge' });
 const client = new ServerRuntimeClient({ ...options, platform: 'blargh' });

 const event: Event = {};
 const hint: EventHint = {};
 (client as any)._prepareEvent(event, hint);

 expect(event.platform).toEqual('edge');
 expect(event.platform).toEqual('blargh');
 });

 test('adds server_name to event', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/deno/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ export class DenoClient extends ServerRuntimeClient<DenoClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'deno',
 platform: 'javascript',
 runtime: { name: 'deno', version: Deno.version.deno },
 serverName: options.serverName || getHostName(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/deno/test/__snapshots__/mod.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -135,7 +135,7 @@ snapshot[`captureException 1`] = `
 },
 ],
 },
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand DownExpand Up@@ -195,7 +195,7 @@ snapshot[`captureMessage 1`] = `
 event_id: "{{id}}",
 level: "info",
 message: "Some error message",
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand Down

29 changes: 13 additions & 16 deletions
packages/nextjs/src/config/webpack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,24 +686,20 @@ export function getWebpackPluginOptions(
 userPluginOptions: Partial<SentryWebpackPluginOptions>,
 userSentryOptions: UserSentryOptions,
): SentryWebpackPluginOptions {
 const { buildId, isServer, webpack, config, dir: projectDir } = buildContext;
 const { buildId, isServer, config, dir: projectDir } = buildContext;
 const userNextConfig = config as NextConfigObject;

 const distDirAbsPath = path.resolve(projectDir, userNextConfig.distDir || '.next'); // `.next` is the default directory

 const isWebpack5 = webpack.version.startsWith('5');
 const isServerless = userNextConfig.target === 'experimental-serverless-trace';
 const hasSentryProperties = fs.existsSync(path.resolve(projectDir, 'sentry.properties'));
 const urlPrefix = '~/_next';

 const serverInclude = isServerless
 ? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]
 : [
 { paths: [`${distDirAbsPath}/server/pages/`], urlPrefix: `${urlPrefix}/server/pages` },
 { paths: [`${distDirAbsPath}/server/app/`], urlPrefix: `${urlPrefix}/server/app` },
 ].concat(
 isWebpack5 ? [{ paths: [`${distDirAbsPath}/server/chunks/`], urlPrefix: `${urlPrefix}/server/chunks` }] : [],
 );
 : [{ paths: [`${distDirAbsPath}/server/`], urlPrefix: `${urlPrefix}/server` }];

 const serverIgnore: string[] = [];

 const clientInclude = userSentryOptions.widenClientFileUpload
 ? [{ paths: [`${distDirAbsPath}/static/chunks`], urlPrefix: `${urlPrefix}/static/chunks` }]
Expand All@@ -712,15 +708,16 @@ export function getWebpackPluginOptions(
 { paths: [`${distDirAbsPath}/static/chunks/app`], urlPrefix: `${urlPrefix}/static/chunks/app` },
 ];

 // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 const clientIgnore = userSentryOptions.widenClientFileUpload
 ? ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*']
 : [];

 const defaultPluginOptions = dropUndefinedKeys({
 include: isServer ? serverInclude : clientInclude,
 ignore:
 isServer || !userSentryOptions.widenClientFileUpload
 ? []
 : // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*'],
 ignore: isServer ? serverIgnore : clientIgnore,
 url: process.env.SENTRY_URL,
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
Expand DownExpand Up@@ -975,7 +972,7 @@ function addValueInjectionLoader(

 newConfig.module.rules.push(
 {
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: path.resolve(__dirname, 'loaders/valueInjectionLoader.js'),
Expand Down

30 changes: 30 additions & 0 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
import { SDK_VERSION } from '@sentry/core';
import { RewriteFrames } from '@sentry/integrations';
import type { SdkMetadata } from '@sentry/types';
import { addOrUpdateIntegration, escapeStringForRegex, GLOBAL_OBJ } from '@sentry/utils';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

export type EdgeOptions = VercelEdgeOptions;

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 __rewriteFramesDistDir__?: string;
};

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: VercelEdgeOptions = {}): void {
 const opts = {
Expand All@@ -23,6 +29,30 @@ export function init(options: VercelEdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 let integrations = opts.integrations || [];

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 const distDirAbsPath = distDirName.replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one

 // Normally we would use `path.resolve` to obtain the absolute path we will strip from the stack frame to align with
 // the uploaded artifacts, however we don't have access to that API in edge so we need to be a bit more lax.
 const SOURCEMAP_FILENAME_REGEX = new RegExp(`.*${escapeStringForRegex(distDirAbsPath)}`);

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });

 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 opts.integrations = integrations;

 vercelEdgeInit(opts);
}

Expand Down

30 changes: 16 additions & 14 deletions
packages/nextjs/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function showReportDialog(): void {
}

const globalWithInjectedValues = global as typeof global & {
 __rewriteFramesDistDir__: string;
 __rewriteFramesDistDir__?: string;
};

// TODO (v8): Remove this
Expand DownExpand Up@@ -119,19 +119,21 @@ function addServerIntegrations(options: NodeOptions): void {

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__ || '.next';
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(process.cwd(), distDirName);
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(distDirName).replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 const defaultOnUncaughtExceptionIntegration: IntegrationWithExclusionOption = new Integrations.OnUncaughtException({
 exitEvenIfOtherHandlersAreRegistered: false,
Expand Down

2 changes: 1 addition & 1 deletion
packages/nextjs/test/config/loaders.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ describe('webpack loaders', () => {
 });

 expect(finalWebpackConfig.module.rules).toContainEqual({
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: expect.stringEndingWith('valueInjectionLoader.js'),
Expand Down

7 changes: 2 additions & 5 deletions
packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });

Expand All@@ -159,9 +158,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
 { paths: [`${serverBuildContext.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/vercel-edge/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOption

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'vercel-edge',
 platform: 'javascript',
 // TODO: Grab version information
 runtime: { name: 'vercel-edge' },
 serverName: options.serverName || process.env.SENTRY_NAME,
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): Add automatic sourcemapping for edge part of the SDK#9454

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 3 commits into

from

Nov 6, 2023
 Merged


feat(nextjs): Add automatic sourcemapping for edge part of the SDK
#9454
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6bdda33

feat(nextjs): Add automatic sourcemapping for Next.js edge

Nov 6, 2023
fa2037b

ci

Nov 6, 2023
003607c

hmm

Nov 6, 2023

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


2 changes: 1 addition & 1 deletion
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'bun',
 platform: 'javascript',
@Lms24Lms24Nov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(no action required) hmm completely fine for now but maybe we should tell symbolicator about other platforms?

Although we could also just "converge" towards javascript for everything WinterCG (i.e. not Node) I guess
@lforstlforstNov 6, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should definitely either add new platforms to symbolicator or converge everything. I even vote we have two platforms: server-js and js because I think that's the only differenciator. For browser js we crawl source files for node we don't.
 runtime: { name: 'bun', version: Bun.version },
 serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/test/lib/serverruntimeclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,13 +22,13 @@ describe('ServerRuntimeClient', () => {
 describe('_prepareEvent', () => {
 test('adds platform to event', () => {
 const options = getDefaultClientOptions({ dsn: PUBLIC_DSN });
 const client = new ServerRuntimeClient({ ...options, platform: 'edge' });
 const client = new ServerRuntimeClient({ ...options, platform: 'blargh' });

 const event: Event = {};
 const hint: EventHint = {};
 (client as any)._prepareEvent(event, hint);

 expect(event.platform).toEqual('edge');
 expect(event.platform).toEqual('blargh');
 });

 test('adds server_name to event', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/deno/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ export class DenoClient extends ServerRuntimeClient<DenoClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'deno',
 platform: 'javascript',
 runtime: { name: 'deno', version: Deno.version.deno },
 serverName: options.serverName || getHostName(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/deno/test/__snapshots__/mod.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -135,7 +135,7 @@ snapshot[`captureException 1`] = `
 },
 ],
 },
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand DownExpand Up@@ -195,7 +195,7 @@ snapshot[`captureMessage 1`] = `
 event_id: "{{id}}",
 level: "info",
 message: "Some error message",
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand Down

29 changes: 13 additions & 16 deletions
packages/nextjs/src/config/webpack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,24 +686,20 @@ export function getWebpackPluginOptions(
 userPluginOptions: Partial<SentryWebpackPluginOptions>,
 userSentryOptions: UserSentryOptions,
): SentryWebpackPluginOptions {
 const { buildId, isServer, webpack, config, dir: projectDir } = buildContext;
 const { buildId, isServer, config, dir: projectDir } = buildContext;
 const userNextConfig = config as NextConfigObject;

 const distDirAbsPath = path.resolve(projectDir, userNextConfig.distDir || '.next'); // `.next` is the default directory

 const isWebpack5 = webpack.version.startsWith('5');
 const isServerless = userNextConfig.target === 'experimental-serverless-trace';
 const hasSentryProperties = fs.existsSync(path.resolve(projectDir, 'sentry.properties'));
 const urlPrefix = '~/_next';

 const serverInclude = isServerless
 ? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]
 : [
 { paths: [`${distDirAbsPath}/server/pages/`], urlPrefix: `${urlPrefix}/server/pages` },
 { paths: [`${distDirAbsPath}/server/app/`], urlPrefix: `${urlPrefix}/server/app` },
 ].concat(
 isWebpack5 ? [{ paths: [`${distDirAbsPath}/server/chunks/`], urlPrefix: `${urlPrefix}/server/chunks` }] : [],
 );
 : [{ paths: [`${distDirAbsPath}/server/`], urlPrefix: `${urlPrefix}/server` }];

 const serverIgnore: string[] = [];

 const clientInclude = userSentryOptions.widenClientFileUpload
 ? [{ paths: [`${distDirAbsPath}/static/chunks`], urlPrefix: `${urlPrefix}/static/chunks` }]
Expand All@@ -712,15 +708,16 @@ export function getWebpackPluginOptions(
 { paths: [`${distDirAbsPath}/static/chunks/app`], urlPrefix: `${urlPrefix}/static/chunks/app` },
 ];

 // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 const clientIgnore = userSentryOptions.widenClientFileUpload
 ? ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*']
 : [];

 const defaultPluginOptions = dropUndefinedKeys({
 include: isServer ? serverInclude : clientInclude,
 ignore:
 isServer || !userSentryOptions.widenClientFileUpload
 ? []
 : // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*'],
 ignore: isServer ? serverIgnore : clientIgnore,
 url: process.env.SENTRY_URL,
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
Expand DownExpand Up@@ -975,7 +972,7 @@ function addValueInjectionLoader(

 newConfig.module.rules.push(
 {
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: path.resolve(__dirname, 'loaders/valueInjectionLoader.js'),
Expand Down

30 changes: 30 additions & 0 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
import { SDK_VERSION } from '@sentry/core';
import { RewriteFrames } from '@sentry/integrations';
import type { SdkMetadata } from '@sentry/types';
import { addOrUpdateIntegration, escapeStringForRegex, GLOBAL_OBJ } from '@sentry/utils';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

export type EdgeOptions = VercelEdgeOptions;

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 __rewriteFramesDistDir__?: string;
};

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: VercelEdgeOptions = {}): void {
 const opts = {
Expand All@@ -23,6 +29,30 @@ export function init(options: VercelEdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 let integrations = opts.integrations || [];

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 const distDirAbsPath = distDirName.replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one

 // Normally we would use `path.resolve` to obtain the absolute path we will strip from the stack frame to align with
 // the uploaded artifacts, however we don't have access to that API in edge so we need to be a bit more lax.
 const SOURCEMAP_FILENAME_REGEX = new RegExp(`.*${escapeStringForRegex(distDirAbsPath)}`);

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });

 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 opts.integrations = integrations;

 vercelEdgeInit(opts);
}

Expand Down

30 changes: 16 additions & 14 deletions
packages/nextjs/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function showReportDialog(): void {
}

const globalWithInjectedValues = global as typeof global & {
 __rewriteFramesDistDir__: string;
 __rewriteFramesDistDir__?: string;
};

// TODO (v8): Remove this
Expand DownExpand Up@@ -119,19 +119,21 @@ function addServerIntegrations(options: NodeOptions): void {

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__ || '.next';
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(process.cwd(), distDirName);
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(distDirName).replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 const defaultOnUncaughtExceptionIntegration: IntegrationWithExclusionOption = new Integrations.OnUncaughtException({
 exitEvenIfOtherHandlersAreRegistered: false,
Expand Down

2 changes: 1 addition & 1 deletion
packages/nextjs/test/config/loaders.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ describe('webpack loaders', () => {
 });

 expect(finalWebpackConfig.module.rules).toContainEqual({
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: expect.stringEndingWith('valueInjectionLoader.js'),
Expand Down

7 changes: 2 additions & 5 deletions
packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });

Expand All@@ -159,9 +158,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
 { paths: [`${serverBuildContext.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/vercel-edge/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOption

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'vercel-edge',
 platform: 'javascript',
 // TODO: Grab version information
 runtime: { name: 'vercel-edge' },
 serverName: options.serverName || process.env.SENTRY_NAME,
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): Add automatic sourcemapping for edge part of the SDK#9454

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 3 commits into

from

Nov 6, 2023
 Merged


feat(nextjs): Add automatic sourcemapping for edge part of the SDK
#9454
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6bdda33

feat(nextjs): Add automatic sourcemapping for Next.js edge

Nov 6, 2023
fa2037b

ci

Nov 6, 2023
003607c

hmm

Nov 6, 2023

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


2 changes: 1 addition & 1 deletion
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'bun',
 platform: 'javascript',
@Lms24Lms24Nov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(no action required) hmm completely fine for now but maybe we should tell symbolicator about other platforms?

Although we could also just "converge" towards javascript for everything WinterCG (i.e. not Node) I guess
@lforstlforstNov 6, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should definitely either add new platforms to symbolicator or converge everything. I even vote we have two platforms: server-js and js because I think that's the only differenciator. For browser js we crawl source files for node we don't.
 runtime: { name: 'bun', version: Bun.version },
 serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/test/lib/serverruntimeclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,13 +22,13 @@ describe('ServerRuntimeClient', () => {
 describe('_prepareEvent', () => {
 test('adds platform to event', () => {
 const options = getDefaultClientOptions({ dsn: PUBLIC_DSN });
 const client = new ServerRuntimeClient({ ...options, platform: 'edge' });
 const client = new ServerRuntimeClient({ ...options, platform: 'blargh' });

 const event: Event = {};
 const hint: EventHint = {};
 (client as any)._prepareEvent(event, hint);

 expect(event.platform).toEqual('edge');
 expect(event.platform).toEqual('blargh');
 });

 test('adds server_name to event', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/deno/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ export class DenoClient extends ServerRuntimeClient<DenoClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'deno',
 platform: 'javascript',
 runtime: { name: 'deno', version: Deno.version.deno },
 serverName: options.serverName || getHostName(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/deno/test/__snapshots__/mod.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -135,7 +135,7 @@ snapshot[`captureException 1`] = `
 },
 ],
 },
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand DownExpand Up@@ -195,7 +195,7 @@ snapshot[`captureMessage 1`] = `
 event_id: "{{id}}",
 level: "info",
 message: "Some error message",
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand Down

29 changes: 13 additions & 16 deletions
packages/nextjs/src/config/webpack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,24 +686,20 @@ export function getWebpackPluginOptions(
 userPluginOptions: Partial<SentryWebpackPluginOptions>,
 userSentryOptions: UserSentryOptions,
): SentryWebpackPluginOptions {
 const { buildId, isServer, webpack, config, dir: projectDir } = buildContext;
 const { buildId, isServer, config, dir: projectDir } = buildContext;
 const userNextConfig = config as NextConfigObject;

 const distDirAbsPath = path.resolve(projectDir, userNextConfig.distDir || '.next'); // `.next` is the default directory

 const isWebpack5 = webpack.version.startsWith('5');
 const isServerless = userNextConfig.target === 'experimental-serverless-trace';
 const hasSentryProperties = fs.existsSync(path.resolve(projectDir, 'sentry.properties'));
 const urlPrefix = '~/_next';

 const serverInclude = isServerless
 ? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]
 : [
 { paths: [`${distDirAbsPath}/server/pages/`], urlPrefix: `${urlPrefix}/server/pages` },
 { paths: [`${distDirAbsPath}/server/app/`], urlPrefix: `${urlPrefix}/server/app` },
 ].concat(
 isWebpack5 ? [{ paths: [`${distDirAbsPath}/server/chunks/`], urlPrefix: `${urlPrefix}/server/chunks` }] : [],
 );
 : [{ paths: [`${distDirAbsPath}/server/`], urlPrefix: `${urlPrefix}/server` }];

 const serverIgnore: string[] = [];

 const clientInclude = userSentryOptions.widenClientFileUpload
 ? [{ paths: [`${distDirAbsPath}/static/chunks`], urlPrefix: `${urlPrefix}/static/chunks` }]
Expand All@@ -712,15 +708,16 @@ export function getWebpackPluginOptions(
 { paths: [`${distDirAbsPath}/static/chunks/app`], urlPrefix: `${urlPrefix}/static/chunks/app` },
 ];

 // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 const clientIgnore = userSentryOptions.widenClientFileUpload
 ? ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*']
 : [];

 const defaultPluginOptions = dropUndefinedKeys({
 include: isServer ? serverInclude : clientInclude,
 ignore:
 isServer || !userSentryOptions.widenClientFileUpload
 ? []
 : // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*'],
 ignore: isServer ? serverIgnore : clientIgnore,
 url: process.env.SENTRY_URL,
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
Expand DownExpand Up@@ -975,7 +972,7 @@ function addValueInjectionLoader(

 newConfig.module.rules.push(
 {
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: path.resolve(__dirname, 'loaders/valueInjectionLoader.js'),
Expand Down

30 changes: 30 additions & 0 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
import { SDK_VERSION } from '@sentry/core';
import { RewriteFrames } from '@sentry/integrations';
import type { SdkMetadata } from '@sentry/types';
import { addOrUpdateIntegration, escapeStringForRegex, GLOBAL_OBJ } from '@sentry/utils';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

export type EdgeOptions = VercelEdgeOptions;

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 __rewriteFramesDistDir__?: string;
};

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: VercelEdgeOptions = {}): void {
 const opts = {
Expand All@@ -23,6 +29,30 @@ export function init(options: VercelEdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 let integrations = opts.integrations || [];

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 const distDirAbsPath = distDirName.replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one

 // Normally we would use `path.resolve` to obtain the absolute path we will strip from the stack frame to align with
 // the uploaded artifacts, however we don't have access to that API in edge so we need to be a bit more lax.
 const SOURCEMAP_FILENAME_REGEX = new RegExp(`.*${escapeStringForRegex(distDirAbsPath)}`);

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });

 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 opts.integrations = integrations;

 vercelEdgeInit(opts);
}

Expand Down

30 changes: 16 additions & 14 deletions
packages/nextjs/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function showReportDialog(): void {
}

const globalWithInjectedValues = global as typeof global & {
 __rewriteFramesDistDir__: string;
 __rewriteFramesDistDir__?: string;
};

// TODO (v8): Remove this
Expand DownExpand Up@@ -119,19 +119,21 @@ function addServerIntegrations(options: NodeOptions): void {

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__ || '.next';
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(process.cwd(), distDirName);
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(distDirName).replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 const defaultOnUncaughtExceptionIntegration: IntegrationWithExclusionOption = new Integrations.OnUncaughtException({
 exitEvenIfOtherHandlersAreRegistered: false,
Expand Down

2 changes: 1 addition & 1 deletion
packages/nextjs/test/config/loaders.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ describe('webpack loaders', () => {
 });

 expect(finalWebpackConfig.module.rules).toContainEqual({
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: expect.stringEndingWith('valueInjectionLoader.js'),
Expand Down

7 changes: 2 additions & 5 deletions
packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });

Expand All@@ -159,9 +158,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
 { paths: [`${serverBuildContext.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/vercel-edge/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOption

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'vercel-edge',
 platform: 'javascript',
 // TODO: Grab version information
 runtime: { name: 'vercel-edge' },
 serverName: options.serverName || process.env.SENTRY_NAME,
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): Add automatic sourcemapping for edge part of the SDK#9454

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 3 commits into

from

Nov 6, 2023
 Merged


feat(nextjs): Add automatic sourcemapping for edge part of the SDK
#9454
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6bdda33

feat(nextjs): Add automatic sourcemapping for Next.js edge

Nov 6, 2023
fa2037b

ci

Nov 6, 2023
003607c

hmm

Nov 6, 2023

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


2 changes: 1 addition & 1 deletion
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'bun',
 platform: 'javascript',
@Lms24Lms24Nov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(no action required) hmm completely fine for now but maybe we should tell symbolicator about other platforms?

Although we could also just "converge" towards javascript for everything WinterCG (i.e. not Node) I guess
@lforstlforstNov 6, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should definitely either add new platforms to symbolicator or converge everything. I even vote we have two platforms: server-js and js because I think that's the only differenciator. For browser js we crawl source files for node we don't.
 runtime: { name: 'bun', version: Bun.version },
 serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/test/lib/serverruntimeclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,13 +22,13 @@ describe('ServerRuntimeClient', () => {
 describe('_prepareEvent', () => {
 test('adds platform to event', () => {
 const options = getDefaultClientOptions({ dsn: PUBLIC_DSN });
 const client = new ServerRuntimeClient({ ...options, platform: 'edge' });
 const client = new ServerRuntimeClient({ ...options, platform: 'blargh' });

 const event: Event = {};
 const hint: EventHint = {};
 (client as any)._prepareEvent(event, hint);

 expect(event.platform).toEqual('edge');
 expect(event.platform).toEqual('blargh');
 });

 test('adds server_name to event', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/deno/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ export class DenoClient extends ServerRuntimeClient<DenoClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'deno',
 platform: 'javascript',
 runtime: { name: 'deno', version: Deno.version.deno },
 serverName: options.serverName || getHostName(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/deno/test/__snapshots__/mod.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -135,7 +135,7 @@ snapshot[`captureException 1`] = `
 },
 ],
 },
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand DownExpand Up@@ -195,7 +195,7 @@ snapshot[`captureMessage 1`] = `
 event_id: "{{id}}",
 level: "info",
 message: "Some error message",
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand Down

29 changes: 13 additions & 16 deletions
packages/nextjs/src/config/webpack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,24 +686,20 @@ export function getWebpackPluginOptions(
 userPluginOptions: Partial<SentryWebpackPluginOptions>,
 userSentryOptions: UserSentryOptions,
): SentryWebpackPluginOptions {
 const { buildId, isServer, webpack, config, dir: projectDir } = buildContext;
 const { buildId, isServer, config, dir: projectDir } = buildContext;
 const userNextConfig = config as NextConfigObject;

 const distDirAbsPath = path.resolve(projectDir, userNextConfig.distDir || '.next'); // `.next` is the default directory

 const isWebpack5 = webpack.version.startsWith('5');
 const isServerless = userNextConfig.target === 'experimental-serverless-trace';
 const hasSentryProperties = fs.existsSync(path.resolve(projectDir, 'sentry.properties'));
 const urlPrefix = '~/_next';

 const serverInclude = isServerless
 ? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]
 : [
 { paths: [`${distDirAbsPath}/server/pages/`], urlPrefix: `${urlPrefix}/server/pages` },
 { paths: [`${distDirAbsPath}/server/app/`], urlPrefix: `${urlPrefix}/server/app` },
 ].concat(
 isWebpack5 ? [{ paths: [`${distDirAbsPath}/server/chunks/`], urlPrefix: `${urlPrefix}/server/chunks` }] : [],
 );
 : [{ paths: [`${distDirAbsPath}/server/`], urlPrefix: `${urlPrefix}/server` }];

 const serverIgnore: string[] = [];

 const clientInclude = userSentryOptions.widenClientFileUpload
 ? [{ paths: [`${distDirAbsPath}/static/chunks`], urlPrefix: `${urlPrefix}/static/chunks` }]
Expand All@@ -712,15 +708,16 @@ export function getWebpackPluginOptions(
 { paths: [`${distDirAbsPath}/static/chunks/app`], urlPrefix: `${urlPrefix}/static/chunks/app` },
 ];

 // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 const clientIgnore = userSentryOptions.widenClientFileUpload
 ? ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*']
 : [];

 const defaultPluginOptions = dropUndefinedKeys({
 include: isServer ? serverInclude : clientInclude,
 ignore:
 isServer || !userSentryOptions.widenClientFileUpload
 ? []
 : // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*'],
 ignore: isServer ? serverIgnore : clientIgnore,
 url: process.env.SENTRY_URL,
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
Expand DownExpand Up@@ -975,7 +972,7 @@ function addValueInjectionLoader(

 newConfig.module.rules.push(
 {
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: path.resolve(__dirname, 'loaders/valueInjectionLoader.js'),
Expand Down

30 changes: 30 additions & 0 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
import { SDK_VERSION } from '@sentry/core';
import { RewriteFrames } from '@sentry/integrations';
import type { SdkMetadata } from '@sentry/types';
import { addOrUpdateIntegration, escapeStringForRegex, GLOBAL_OBJ } from '@sentry/utils';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

export type EdgeOptions = VercelEdgeOptions;

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 __rewriteFramesDistDir__?: string;
};

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: VercelEdgeOptions = {}): void {
 const opts = {
Expand All@@ -23,6 +29,30 @@ export function init(options: VercelEdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 let integrations = opts.integrations || [];

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 const distDirAbsPath = distDirName.replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one

 // Normally we would use `path.resolve` to obtain the absolute path we will strip from the stack frame to align with
 // the uploaded artifacts, however we don't have access to that API in edge so we need to be a bit more lax.
 const SOURCEMAP_FILENAME_REGEX = new RegExp(`.*${escapeStringForRegex(distDirAbsPath)}`);

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });

 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 opts.integrations = integrations;

 vercelEdgeInit(opts);
}

Expand Down

30 changes: 16 additions & 14 deletions
packages/nextjs/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function showReportDialog(): void {
}

const globalWithInjectedValues = global as typeof global & {
 __rewriteFramesDistDir__: string;
 __rewriteFramesDistDir__?: string;
};

// TODO (v8): Remove this
Expand DownExpand Up@@ -119,19 +119,21 @@ function addServerIntegrations(options: NodeOptions): void {

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__ || '.next';
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(process.cwd(), distDirName);
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(distDirName).replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 const defaultOnUncaughtExceptionIntegration: IntegrationWithExclusionOption = new Integrations.OnUncaughtException({
 exitEvenIfOtherHandlersAreRegistered: false,
Expand Down

2 changes: 1 addition & 1 deletion
packages/nextjs/test/config/loaders.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ describe('webpack loaders', () => {
 });

 expect(finalWebpackConfig.module.rules).toContainEqual({
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: expect.stringEndingWith('valueInjectionLoader.js'),
Expand Down

7 changes: 2 additions & 5 deletions
packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });

Expand All@@ -159,9 +158,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
 { paths: [`${serverBuildContext.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/vercel-edge/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOption

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'vercel-edge',
 platform: 'javascript',
 // TODO: Grab version information
 runtime: { name: 'vercel-edge' },
 serverName: options.serverName || process.env.SENTRY_NAME,
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): Add automatic sourcemapping for edge part of the SDK#9454

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 3 commits into

from

Nov 6, 2023
 Merged


feat(nextjs): Add automatic sourcemapping for edge part of the SDK
#9454
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6bdda33

feat(nextjs): Add automatic sourcemapping for Next.js edge

Nov 6, 2023
fa2037b

ci

Nov 6, 2023
003607c

hmm

Nov 6, 2023

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


2 changes: 1 addition & 1 deletion
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'bun',
 platform: 'javascript',
@Lms24Lms24Nov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(no action required) hmm completely fine for now but maybe we should tell symbolicator about other platforms?

Although we could also just "converge" towards javascript for everything WinterCG (i.e. not Node) I guess
@lforstlforstNov 6, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should definitely either add new platforms to symbolicator or converge everything. I even vote we have two platforms: server-js and js because I think that's the only differenciator. For browser js we crawl source files for node we don't.
 runtime: { name: 'bun', version: Bun.version },
 serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/test/lib/serverruntimeclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,13 +22,13 @@ describe('ServerRuntimeClient', () => {
 describe('_prepareEvent', () => {
 test('adds platform to event', () => {
 const options = getDefaultClientOptions({ dsn: PUBLIC_DSN });
 const client = new ServerRuntimeClient({ ...options, platform: 'edge' });
 const client = new ServerRuntimeClient({ ...options, platform: 'blargh' });

 const event: Event = {};
 const hint: EventHint = {};
 (client as any)._prepareEvent(event, hint);

 expect(event.platform).toEqual('edge');
 expect(event.platform).toEqual('blargh');
 });

 test('adds server_name to event', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/deno/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ export class DenoClient extends ServerRuntimeClient<DenoClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'deno',
 platform: 'javascript',
 runtime: { name: 'deno', version: Deno.version.deno },
 serverName: options.serverName || getHostName(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/deno/test/__snapshots__/mod.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -135,7 +135,7 @@ snapshot[`captureException 1`] = `
 },
 ],
 },
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand DownExpand Up@@ -195,7 +195,7 @@ snapshot[`captureMessage 1`] = `
 event_id: "{{id}}",
 level: "info",
 message: "Some error message",
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand Down

29 changes: 13 additions & 16 deletions
packages/nextjs/src/config/webpack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,24 +686,20 @@ export function getWebpackPluginOptions(
 userPluginOptions: Partial<SentryWebpackPluginOptions>,
 userSentryOptions: UserSentryOptions,
): SentryWebpackPluginOptions {
 const { buildId, isServer, webpack, config, dir: projectDir } = buildContext;
 const { buildId, isServer, config, dir: projectDir } = buildContext;
 const userNextConfig = config as NextConfigObject;

 const distDirAbsPath = path.resolve(projectDir, userNextConfig.distDir || '.next'); // `.next` is the default directory

 const isWebpack5 = webpack.version.startsWith('5');
 const isServerless = userNextConfig.target === 'experimental-serverless-trace';
 const hasSentryProperties = fs.existsSync(path.resolve(projectDir, 'sentry.properties'));
 const urlPrefix = '~/_next';

 const serverInclude = isServerless
 ? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]
 : [
 { paths: [`${distDirAbsPath}/server/pages/`], urlPrefix: `${urlPrefix}/server/pages` },
 { paths: [`${distDirAbsPath}/server/app/`], urlPrefix: `${urlPrefix}/server/app` },
 ].concat(
 isWebpack5 ? [{ paths: [`${distDirAbsPath}/server/chunks/`], urlPrefix: `${urlPrefix}/server/chunks` }] : [],
 );
 : [{ paths: [`${distDirAbsPath}/server/`], urlPrefix: `${urlPrefix}/server` }];

 const serverIgnore: string[] = [];

 const clientInclude = userSentryOptions.widenClientFileUpload
 ? [{ paths: [`${distDirAbsPath}/static/chunks`], urlPrefix: `${urlPrefix}/static/chunks` }]
Expand All@@ -712,15 +708,16 @@ export function getWebpackPluginOptions(
 { paths: [`${distDirAbsPath}/static/chunks/app`], urlPrefix: `${urlPrefix}/static/chunks/app` },
 ];

 // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 const clientIgnore = userSentryOptions.widenClientFileUpload
 ? ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*']
 : [];

 const defaultPluginOptions = dropUndefinedKeys({
 include: isServer ? serverInclude : clientInclude,
 ignore:
 isServer || !userSentryOptions.widenClientFileUpload
 ? []
 : // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*'],
 ignore: isServer ? serverIgnore : clientIgnore,
 url: process.env.SENTRY_URL,
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
Expand DownExpand Up@@ -975,7 +972,7 @@ function addValueInjectionLoader(

 newConfig.module.rules.push(
 {
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: path.resolve(__dirname, 'loaders/valueInjectionLoader.js'),
Expand Down

30 changes: 30 additions & 0 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
import { SDK_VERSION } from '@sentry/core';
import { RewriteFrames } from '@sentry/integrations';
import type { SdkMetadata } from '@sentry/types';
import { addOrUpdateIntegration, escapeStringForRegex, GLOBAL_OBJ } from '@sentry/utils';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

export type EdgeOptions = VercelEdgeOptions;

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 __rewriteFramesDistDir__?: string;
};

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: VercelEdgeOptions = {}): void {
 const opts = {
Expand All@@ -23,6 +29,30 @@ export function init(options: VercelEdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 let integrations = opts.integrations || [];

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 const distDirAbsPath = distDirName.replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one

 // Normally we would use `path.resolve` to obtain the absolute path we will strip from the stack frame to align with
 // the uploaded artifacts, however we don't have access to that API in edge so we need to be a bit more lax.
 const SOURCEMAP_FILENAME_REGEX = new RegExp(`.*${escapeStringForRegex(distDirAbsPath)}`);

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });

 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 opts.integrations = integrations;

 vercelEdgeInit(opts);
}

Expand Down

30 changes: 16 additions & 14 deletions
packages/nextjs/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function showReportDialog(): void {
}

const globalWithInjectedValues = global as typeof global & {
 __rewriteFramesDistDir__: string;
 __rewriteFramesDistDir__?: string;
};

// TODO (v8): Remove this
Expand DownExpand Up@@ -119,19 +119,21 @@ function addServerIntegrations(options: NodeOptions): void {

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__ || '.next';
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(process.cwd(), distDirName);
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(distDirName).replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 const defaultOnUncaughtExceptionIntegration: IntegrationWithExclusionOption = new Integrations.OnUncaughtException({
 exitEvenIfOtherHandlersAreRegistered: false,
Expand Down

2 changes: 1 addition & 1 deletion
packages/nextjs/test/config/loaders.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ describe('webpack loaders', () => {
 });

 expect(finalWebpackConfig.module.rules).toContainEqual({
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: expect.stringEndingWith('valueInjectionLoader.js'),
Expand Down

7 changes: 2 additions & 5 deletions
packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });

Expand All@@ -159,9 +158,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
 { paths: [`${serverBuildContext.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/vercel-edge/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOption

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'vercel-edge',
 platform: 'javascript',
 // TODO: Grab version information
 runtime: { name: 'vercel-edge' },
 serverName: options.serverName || process.env.SENTRY_NAME,
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): Add automatic sourcemapping for edge part of the SDK#9454

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 3 commits into

from

Nov 6, 2023
 Merged


feat(nextjs): Add automatic sourcemapping for edge part of the SDK
#9454
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6bdda33

feat(nextjs): Add automatic sourcemapping for Next.js edge

Nov 6, 2023
fa2037b

ci

Nov 6, 2023
003607c

hmm

Nov 6, 2023

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


2 changes: 1 addition & 1 deletion
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'bun',
 platform: 'javascript',
@Lms24Lms24Nov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(no action required) hmm completely fine for now but maybe we should tell symbolicator about other platforms?

Although we could also just "converge" towards javascript for everything WinterCG (i.e. not Node) I guess
@lforstlforstNov 6, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should definitely either add new platforms to symbolicator or converge everything. I even vote we have two platforms: server-js and js because I think that's the only differenciator. For browser js we crawl source files for node we don't.
 runtime: { name: 'bun', version: Bun.version },
 serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/test/lib/serverruntimeclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,13 +22,13 @@ describe('ServerRuntimeClient', () => {
 describe('_prepareEvent', () => {
 test('adds platform to event', () => {
 const options = getDefaultClientOptions({ dsn: PUBLIC_DSN });
 const client = new ServerRuntimeClient({ ...options, platform: 'edge' });
 const client = new ServerRuntimeClient({ ...options, platform: 'blargh' });

 const event: Event = {};
 const hint: EventHint = {};
 (client as any)._prepareEvent(event, hint);

 expect(event.platform).toEqual('edge');
 expect(event.platform).toEqual('blargh');
 });

 test('adds server_name to event', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/deno/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ export class DenoClient extends ServerRuntimeClient<DenoClientOptions> {

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'deno',
 platform: 'javascript',
 runtime: { name: 'deno', version: Deno.version.deno },
 serverName: options.serverName || getHostName(),
 };
Expand Down

4 changes: 2 additions & 2 deletions
packages/deno/test/__snapshots__/mod.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -135,7 +135,7 @@ snapshot[`captureException 1`] = `
 },
 ],
 },
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand DownExpand Up@@ -195,7 +195,7 @@ snapshot[`captureMessage 1`] = `
 event_id: "{{id}}",
 level: "info",
 message: "Some error message",
 platform: "deno",
 platform: "javascript",
 sdk: {
 integrations: [
 "InboundFilters",
Expand Down

29 changes: 13 additions & 16 deletions
packages/nextjs/src/config/webpack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,24 +686,20 @@ export function getWebpackPluginOptions(
 userPluginOptions: Partial<SentryWebpackPluginOptions>,
 userSentryOptions: UserSentryOptions,
): SentryWebpackPluginOptions {
 const { buildId, isServer, webpack, config, dir: projectDir } = buildContext;
 const { buildId, isServer, config, dir: projectDir } = buildContext;
 const userNextConfig = config as NextConfigObject;

 const distDirAbsPath = path.resolve(projectDir, userNextConfig.distDir || '.next'); // `.next` is the default directory

 const isWebpack5 = webpack.version.startsWith('5');
 const isServerless = userNextConfig.target === 'experimental-serverless-trace';
 const hasSentryProperties = fs.existsSync(path.resolve(projectDir, 'sentry.properties'));
 const urlPrefix = '~/_next';

 const serverInclude = isServerless
 ? [{ paths: [`${distDirAbsPath}/serverless/`], urlPrefix: `${urlPrefix}/serverless` }]
 : [
 { paths: [`${distDirAbsPath}/server/pages/`], urlPrefix: `${urlPrefix}/server/pages` },
 { paths: [`${distDirAbsPath}/server/app/`], urlPrefix: `${urlPrefix}/server/app` },
 ].concat(
 isWebpack5 ? [{ paths: [`${distDirAbsPath}/server/chunks/`], urlPrefix: `${urlPrefix}/server/chunks` }] : [],
 );
 : [{ paths: [`${distDirAbsPath}/server/`], urlPrefix: `${urlPrefix}/server` }];

 const serverIgnore: string[] = [];

 const clientInclude = userSentryOptions.widenClientFileUpload
 ? [{ paths: [`${distDirAbsPath}/static/chunks`], urlPrefix: `${urlPrefix}/static/chunks` }]
Expand All@@ -712,15 +708,16 @@ export function getWebpackPluginOptions(
 { paths: [`${distDirAbsPath}/static/chunks/app`], urlPrefix: `${urlPrefix}/static/chunks/app` },
 ];

 // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 const clientIgnore = userSentryOptions.widenClientFileUpload
 ? ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*']
 : [];

 const defaultPluginOptions = dropUndefinedKeys({
 include: isServer ? serverInclude : clientInclude,
 ignore:
 isServer || !userSentryOptions.widenClientFileUpload
 ? []
 : // Widening the upload scope is necessarily going to lead to us uploading files we don't need to (ones which
 // don't include any user code). In order to lessen that where we can, exclude the internal nextjs files we know
 // will be there.
 ['framework-*', 'framework.*', 'main-*', 'polyfills-*', 'webpack-*'],
 ignore: isServer ? serverIgnore : clientIgnore,
 url: process.env.SENTRY_URL,
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
Expand DownExpand Up@@ -975,7 +972,7 @@ function addValueInjectionLoader(

 newConfig.module.rules.push(
 {
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: path.resolve(__dirname, 'loaders/valueInjectionLoader.js'),
Expand Down

30 changes: 30 additions & 0 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
import { SDK_VERSION } from '@sentry/core';
import { RewriteFrames } from '@sentry/integrations';
import type { SdkMetadata } from '@sentry/types';
import { addOrUpdateIntegration, escapeStringForRegex, GLOBAL_OBJ } from '@sentry/utils';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

export type EdgeOptions = VercelEdgeOptions;

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 __rewriteFramesDistDir__?: string;
};

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: VercelEdgeOptions = {}): void {
 const opts = {
Expand All@@ -23,6 +29,30 @@ export function init(options: VercelEdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 let integrations = opts.integrations || [];

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 const distDirAbsPath = distDirName.replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one

 // Normally we would use `path.resolve` to obtain the absolute path we will strip from the stack frame to align with
 // the uploaded artifacts, however we don't have access to that API in edge so we need to be a bit more lax.
 const SOURCEMAP_FILENAME_REGEX = new RegExp(`.*${escapeStringForRegex(distDirAbsPath)}`);

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });

 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 opts.integrations = integrations;

 vercelEdgeInit(opts);
}

Expand Down

30 changes: 16 additions & 14 deletions
packages/nextjs/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function showReportDialog(): void {
}

const globalWithInjectedValues = global as typeof global & {
 __rewriteFramesDistDir__: string;
 __rewriteFramesDistDir__?: string;
};

// TODO (v8): Remove this
Expand DownExpand Up@@ -119,19 +119,21 @@ function addServerIntegrations(options: NodeOptions): void {

 // This value is injected at build time, based on the output directory specified in the build config. Though a default
 // is set there, we set it here as well, just in case something has gone wrong with the injection.
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__ || '.next';
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(process.cwd(), distDirName);
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 const distDirName = globalWithInjectedValues.__rewriteFramesDistDir__;
 if (distDirName) {
 // nextjs always puts the build directory at the project root level, which is also where you run `next start` from, so
 // we can read in the project directory from the currently running process
 const distDirAbsPath = path.resolve(distDirName).replace(/(\/|\\)$/, ''); // We strip trailing slashes because "app:///_next" also doesn't have one
 const SOURCEMAP_FILENAME_REGEX = new RegExp(escapeStringForRegex(distDirAbsPath));

 const defaultRewriteFramesIntegration = new RewriteFrames({
 iteratee: frame => {
 frame.filename = frame.filename?.replace(SOURCEMAP_FILENAME_REGEX, 'app:///_next');
 return frame;
 },
 });
 integrations = addOrUpdateIntegration(defaultRewriteFramesIntegration, integrations);
 }

 const defaultOnUncaughtExceptionIntegration: IntegrationWithExclusionOption = new Integrations.OnUncaughtException({
 exitEvenIfOtherHandlersAreRegistered: false,
Expand Down

2 changes: 1 addition & 1 deletion
packages/nextjs/test/config/loaders.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ describe('webpack loaders', () => {
 });

 expect(finalWebpackConfig.module.rules).toContainEqual({
 test: /sentry\.server\.config\.(jsx?|tsx?)/,
 test: /sentry\.(server|edge)\.config\.(jsx?|tsx?)/,
 use: [
 {
 loader: expect.stringEndingWith('valueInjectionLoader.js'),
Expand Down

7 changes: 2 additions & 5 deletions
packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContextWebpack4.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });

Expand All@@ -159,9 +158,7 @@ describe('Sentry webpack plugin config', () => {
 ) as SentryWebpackPlugin;

 expect(sentryWebpackPluginInstance.options.include).toEqual([
 { paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
 { paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
 { paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
 { paths: [`${serverBuildContext.dir}/.next/server/`], urlPrefix: '~/_next/server' },
 ]);
 });
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/vercel-edge/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOption

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 platform: 'vercel-edge',
 platform: 'javascript',
 // TODO: Grab version information
 runtime: { name: 'vercel-edge' },
 serverName: options.serverName || process.env.SENTRY_NAME,
Expand Down