ref(nextjs): Use @sentry/vercel-edge in nextjs package#9053

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
Lms24 merged 3 commits into from
Sep 20, 2023
Merged

ref(nextjs): Use @sentry/vercel-edge in nextjs package #9053

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
97755e3
ref(nextjs): Use @sentry/vercel-edge in nextjs package
AbhiPrasad Sep 19, 2023
5f78fe0
fix integration tests
Lms24 Sep 20, 2023
24465d9
fix e2e tests
Lms24 Sep 20, 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
4 changes: 2 additions & 2 deletions packages/e2e-tests/test-applications/nextjs-app-dir/tests/edge-route.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ test('Should create a transaction for edge routes', async ({ request }) => {

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty edge routes', async ({ request }) => {
Expand All@@ -34,7 +34,7 @@ test('Should create a transaction with error status for faulty edge routes', asy

expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should record exceptions for faulty edge routes', async ({ request }) => {
Expand Down
4 changes: 2 additions & 2 deletions packages/e2e-tests/test-applications/nextjs-app-dir/tests/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ test('Should create a transaction for middleware', async ({ request }) => {

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty middleware', async ({ request }) => {
Expand All@@ -31,7 +31,7 @@ test('Should create a transaction with error status for faulty middleware', asyn

expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Records exceptions happening in middleware', async ({ request }) => {
Expand Down
4 changes: 2 additions & 2 deletions packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,9 @@ test.describe('Edge runtime', () => {

expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error');
expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
expect(routehandlerTransaction.contexts?.runtime?.name).toBe('edge');
expect(routehandlerTransaction.contexts?.runtime?.name).toBe('vercel-edge');

expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-edge-error');
expect(routehandlerError.contexts?.runtime?.name).toBe('edge');
expect(routehandlerError.contexts?.runtime?.name).toBe('vercel-edge');
});
});
1 change: 1 addition & 0 deletions packages/nextjs/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
"@sentry/react": "7.69.0",
"@sentry/types": "7.69.0",
"@sentry/utils": "7.69.0",
"@sentry/vercel-edge": "7.69.0",
"@sentry/webpack-plugin": "1.20.0",
"chalk": "3.0.0",
"rollup": "2.78.0",
Expand Down
59 changes: 0 additions & 59 deletions packages/nextjs/src/edge/asyncLocalStorageAsyncContextStrategy.ts
View file
Open in desktop

This file was deleted.

117 changes: 10 additions & 107 deletions packages/nextjs/src/edge/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
getIntegrationsToSetup,
initAndBind,
Integrations as CoreIntegrations,
SDK_VERSION,
ServerRuntimeClient,
} from '@sentry/core';
import type { Options } from '@sentry/types';
import { createStackParser, GLOBAL_OBJ, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
import { SDK_VERSION } from '@sentry/core';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

import { getVercelEnv } from '../common/getVercelEnv';
import { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageAsyncContextStrategy';
import { makeEdgeTransport } from './transport';

const nodeStackParser = createStackParser(nodeStackLineParser());

export const defaultIntegrations = [new CoreIntegrations.InboundFilters(), new CoreIntegrations.FunctionToString()];

export type EdgeOptions = Options;
export type EdgeOptions = VercelEdgeOptions;

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: EdgeOptions = {}): void {
setAsyncLocalStorageAsyncContextStrategy();

if (options.defaultIntegrations === undefined) {
options.defaultIntegrations = defaultIntegrations;
}

if (options.dsn === undefined && process.env.SENTRY_DSN) {
options.dsn = process.env.SENTRY_DSN;
}

if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
if (isFinite(tracesSampleRate)) {
options.tracesSampleRate = tracesSampleRate;
}
}

if (options.release === undefined) {
const detectedRelease = getSentryRelease();
if (detectedRelease !== undefined) {
options.release = detectedRelease;
} else {
// If release is not provided, then we should disable autoSessionTracking
options.autoSessionTracking = false;
}
}

options.environment =
options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
options.autoSessionTracking = true;
}

if (options.instrumenter === undefined) {
options.instrumenter = 'sentry';
}

const clientOptions: ServerRuntimeClientOptions = {
...options,
stackParser: stackParserFromStackParserOptions(options.stackParser || nodeStackParser),
integrations: getIntegrationsToSetup(options),
transport: options.transport || makeEdgeTransport,
};

clientOptions._metadata = clientOptions._metadata || {};
clientOptions._metadata.sdk = clientOptions._metadata.sdk || {
export function init(options: VercelEdgeOptions = {}): void {
options._metadata = options._metadata || {};
options._metadata.sdk = options._metadata.sdk || {
name: 'sentry.javascript.nextjs',
packages: [
{
Expand All@@ -78,45 +18,7 @@ export function init(options: EdgeOptions = {}): void {
version: SDK_VERSION,
};

clientOptions.platform = 'edge';
clientOptions.runtime = { name: 'edge' };
clientOptions.serverName = process.env.SENTRY_NAME;

initAndBind(ServerRuntimeClient, clientOptions);

// TODO?: Sessiontracking
}

/**
* Returns a release dynamically from environment variables.
*/
export function getSentryRelease(fallback?: string): string | undefined {
// Always read first as Sentry takes this as precedence
if (process.env.SENTRY_RELEASE) {
return process.env.SENTRY_RELEASE;
}

// This supports the variable that sentry-webpack-plugin injects
if (GLOBAL_OBJ.SENTRY_RELEASE && GLOBAL_OBJ.SENTRY_RELEASE.id) {
return GLOBAL_OBJ.SENTRY_RELEASE.id;
}

return (
// GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
process.env.GITHUB_SHA ||
// Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
process.env.COMMIT_REF ||
// Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
process.env.VERCEL_GIT_COMMIT_SHA ||
process.env.VERCEL_GITHUB_COMMIT_SHA ||
process.env.VERCEL_GITLAB_COMMIT_SHA ||
process.env.VERCEL_BITBUCKET_COMMIT_SHA ||
// Zeit (now known as Vercel)
process.env.ZEIT_GITHUB_COMMIT_SHA ||
process.env.ZEIT_GITLAB_COMMIT_SHA ||
process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
fallback
);
vercelEdgeInit(options);
}

/**
Expand All@@ -126,7 +28,8 @@ export function withSentryConfig<T>(exportedUserNextConfig: T): T {
return exportedUserNextConfig;
}

export * from '@sentry/core';
export * from '@sentry/vercel-edge';
export { Span, Transaction } from '@sentry/core';

// eslint-disable-next-line import/export
export * from '../common';
Expand Down
103 changes: 0 additions & 103 deletions packages/nextjs/src/edge/transport.ts
View file
Open in desktop

This file was deleted.

Loading
, '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
ref(nextjs): Use @sentry/vercel-edge in nextjs package#9053

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

Lms24
merged 3 commits into

from

Sep 20, 2023
 Merged


ref(nextjs): Use @sentry/vercel-edge in nextjs package
#9053
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
97755e3

ref(nextjs): Use @sentry/vercel-edge in nextjs package


AbhiPrasad Sep 19, 2023
5f78fe0

fix integration tests


Lms24 Sep 20, 2023
24465d9

fix e2e tests


Lms24 Sep 20, 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


4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/edge-route.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ test('Should create a transaction for edge routes', async ({ request }) => {

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty edge routes', async ({ request }) => {
Expand All@@ -34,7 +34,7 @@ test('Should create a transaction with error status for faulty edge routes', asy

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should record exceptions for faulty edge routes', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ test('Should create a transaction for middleware', async ({ request }) => {

 expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty middleware', async ({ request }) => {
Expand All@@ -31,7 +31,7 @@ test('Should create a transaction with error status for faulty middleware', asyn

 expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Records exceptions happening in middleware', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,9 @@ test.describe('Edge runtime', () => {

 expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('vercel-edge');

 expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-edge-error');
 expect(routehandlerError.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerError.contexts?.runtime?.name).toBe('vercel-edge');
 });
});

1 change: 1 addition & 0 deletions
packages/nextjs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
 "@sentry/react": "7.69.0",
 "@sentry/types": "7.69.0",
 "@sentry/utils": "7.69.0",
 "@sentry/vercel-edge": "7.69.0",
 "@sentry/webpack-plugin": "1.20.0",
 "chalk": "3.0.0",
 "rollup": "2.78.0",
Expand Down

59 changes: 0 additions & 59 deletions
packages/nextjs/src/edge/asyncLocalStorageAsyncContextStrategy.ts

View file


Open in desktop


This file was deleted.


117 changes: 10 additions & 107 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 getIntegrationsToSetup,
 initAndBind,
 Integrations as CoreIntegrations,
 SDK_VERSION,
 ServerRuntimeClient,
} from '@sentry/core';
import type { Options } from '@sentry/types';
import { createStackParser, GLOBAL_OBJ, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
import { SDK_VERSION } from '@sentry/core';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

import { getVercelEnv } from '../common/getVercelEnv';
import { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageAsyncContextStrategy';
import { makeEdgeTransport } from './transport';

const nodeStackParser = createStackParser(nodeStackLineParser());

export const defaultIntegrations = [new CoreIntegrations.InboundFilters(), new CoreIntegrations.FunctionToString()];

export type EdgeOptions = Options;
export type EdgeOptions = VercelEdgeOptions;

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: EdgeOptions = {}): void {
 setAsyncLocalStorageAsyncContextStrategy();

 if (options.defaultIntegrations === undefined) {
 options.defaultIntegrations = defaultIntegrations;
 }

 if (options.dsn === undefined && process.env.SENTRY_DSN) {
 options.dsn = process.env.SENTRY_DSN;
 }

 if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
 const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
 if (isFinite(tracesSampleRate)) {
 options.tracesSampleRate = tracesSampleRate;
 }
 }

 if (options.release === undefined) {
 const detectedRelease = getSentryRelease();
 if (detectedRelease !== undefined) {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 options.autoSessionTracking = true;
 }

 if (options.instrumenter === undefined) {
 options.instrumenter = 'sentry';
 }

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 stackParser: stackParserFromStackParserOptions(options.stackParser || nodeStackParser),
 integrations: getIntegrationsToSetup(options),
 transport: options.transport || makeEdgeTransport,
 };

 clientOptions._metadata = clientOptions._metadata || {};
 clientOptions._metadata.sdk = clientOptions._metadata.sdk || {
export function init(options: VercelEdgeOptions = {}): void {
 options._metadata = options._metadata || {};
 options._metadata.sdk = options._metadata.sdk || {
 name: 'sentry.javascript.nextjs',
 packages: [
 {
Expand All@@ -78,45 +18,7 @@ export function init(options: EdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 clientOptions.platform = 'edge';
 clientOptions.runtime = { name: 'edge' };
 clientOptions.serverName = process.env.SENTRY_NAME;

 initAndBind(ServerRuntimeClient, clientOptions);

 // TODO?: Sessiontracking
}

/**
 * Returns a release dynamically from environment variables.
 */
export function getSentryRelease(fallback?: string): string | undefined {
 // Always read first as Sentry takes this as precedence
 if (process.env.SENTRY_RELEASE) {
 return process.env.SENTRY_RELEASE;
 }

 // This supports the variable that sentry-webpack-plugin injects
 if (GLOBAL_OBJ.SENTRY_RELEASE && GLOBAL_OBJ.SENTRY_RELEASE.id) {
 return GLOBAL_OBJ.SENTRY_RELEASE.id;
 }

 return (
 // GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 process.env.GITHUB_SHA ||
 // Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
 process.env.COMMIT_REF ||
 // Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
 process.env.VERCEL_GIT_COMMIT_SHA ||
 process.env.VERCEL_GITHUB_COMMIT_SHA ||
 process.env.VERCEL_GITLAB_COMMIT_SHA ||
 process.env.VERCEL_BITBUCKET_COMMIT_SHA ||
 // Zeit (now known as Vercel)
 process.env.ZEIT_GITHUB_COMMIT_SHA ||
 process.env.ZEIT_GITLAB_COMMIT_SHA ||
 process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
 fallback
 );
 vercelEdgeInit(options);
}

/**
Expand All@@ -126,7 +28,8 @@ export function withSentryConfig<T>(exportedUserNextConfig: T): T {
 return exportedUserNextConfig;
}

export * from '@sentry/core';
export * from '@sentry/vercel-edge';
export { Span, Transaction } from '@sentry/core';

// eslint-disable-next-line import/export
export * from '../common';
Expand Down

103 changes: 0 additions & 103 deletions
packages/nextjs/src/edge/transport.ts

View file


Open in desktop


This file was deleted.

Loading

, '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
ref(nextjs): Use @sentry/vercel-edge in nextjs package#9053

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

Lms24
merged 3 commits into

from

Sep 20, 2023
 Merged


ref(nextjs): Use @sentry/vercel-edge in nextjs package
#9053
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
97755e3

ref(nextjs): Use @sentry/vercel-edge in nextjs package


AbhiPrasad Sep 19, 2023
5f78fe0

fix integration tests


Lms24 Sep 20, 2023
24465d9

fix e2e tests


Lms24 Sep 20, 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


4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/edge-route.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ test('Should create a transaction for edge routes', async ({ request }) => {

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty edge routes', async ({ request }) => {
Expand All@@ -34,7 +34,7 @@ test('Should create a transaction with error status for faulty edge routes', asy

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should record exceptions for faulty edge routes', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ test('Should create a transaction for middleware', async ({ request }) => {

 expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty middleware', async ({ request }) => {
Expand All@@ -31,7 +31,7 @@ test('Should create a transaction with error status for faulty middleware', asyn

 expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Records exceptions happening in middleware', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,9 @@ test.describe('Edge runtime', () => {

 expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('vercel-edge');

 expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-edge-error');
 expect(routehandlerError.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerError.contexts?.runtime?.name).toBe('vercel-edge');
 });
});

1 change: 1 addition & 0 deletions
packages/nextjs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
 "@sentry/react": "7.69.0",
 "@sentry/types": "7.69.0",
 "@sentry/utils": "7.69.0",
 "@sentry/vercel-edge": "7.69.0",
 "@sentry/webpack-plugin": "1.20.0",
 "chalk": "3.0.0",
 "rollup": "2.78.0",
Expand Down

59 changes: 0 additions & 59 deletions
packages/nextjs/src/edge/asyncLocalStorageAsyncContextStrategy.ts

View file


Open in desktop


This file was deleted.


117 changes: 10 additions & 107 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 getIntegrationsToSetup,
 initAndBind,
 Integrations as CoreIntegrations,
 SDK_VERSION,
 ServerRuntimeClient,
} from '@sentry/core';
import type { Options } from '@sentry/types';
import { createStackParser, GLOBAL_OBJ, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
import { SDK_VERSION } from '@sentry/core';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

import { getVercelEnv } from '../common/getVercelEnv';
import { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageAsyncContextStrategy';
import { makeEdgeTransport } from './transport';

const nodeStackParser = createStackParser(nodeStackLineParser());

export const defaultIntegrations = [new CoreIntegrations.InboundFilters(), new CoreIntegrations.FunctionToString()];

export type EdgeOptions = Options;
export type EdgeOptions = VercelEdgeOptions;

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: EdgeOptions = {}): void {
 setAsyncLocalStorageAsyncContextStrategy();

 if (options.defaultIntegrations === undefined) {
 options.defaultIntegrations = defaultIntegrations;
 }

 if (options.dsn === undefined && process.env.SENTRY_DSN) {
 options.dsn = process.env.SENTRY_DSN;
 }

 if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
 const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
 if (isFinite(tracesSampleRate)) {
 options.tracesSampleRate = tracesSampleRate;
 }
 }

 if (options.release === undefined) {
 const detectedRelease = getSentryRelease();
 if (detectedRelease !== undefined) {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 options.autoSessionTracking = true;
 }

 if (options.instrumenter === undefined) {
 options.instrumenter = 'sentry';
 }

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 stackParser: stackParserFromStackParserOptions(options.stackParser || nodeStackParser),
 integrations: getIntegrationsToSetup(options),
 transport: options.transport || makeEdgeTransport,
 };

 clientOptions._metadata = clientOptions._metadata || {};
 clientOptions._metadata.sdk = clientOptions._metadata.sdk || {
export function init(options: VercelEdgeOptions = {}): void {
 options._metadata = options._metadata || {};
 options._metadata.sdk = options._metadata.sdk || {
 name: 'sentry.javascript.nextjs',
 packages: [
 {
Expand All@@ -78,45 +18,7 @@ export function init(options: EdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 clientOptions.platform = 'edge';
 clientOptions.runtime = { name: 'edge' };
 clientOptions.serverName = process.env.SENTRY_NAME;

 initAndBind(ServerRuntimeClient, clientOptions);

 // TODO?: Sessiontracking
}

/**
 * Returns a release dynamically from environment variables.
 */
export function getSentryRelease(fallback?: string): string | undefined {
 // Always read first as Sentry takes this as precedence
 if (process.env.SENTRY_RELEASE) {
 return process.env.SENTRY_RELEASE;
 }

 // This supports the variable that sentry-webpack-plugin injects
 if (GLOBAL_OBJ.SENTRY_RELEASE && GLOBAL_OBJ.SENTRY_RELEASE.id) {
 return GLOBAL_OBJ.SENTRY_RELEASE.id;
 }

 return (
 // GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 process.env.GITHUB_SHA ||
 // Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
 process.env.COMMIT_REF ||
 // Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
 process.env.VERCEL_GIT_COMMIT_SHA ||
 process.env.VERCEL_GITHUB_COMMIT_SHA ||
 process.env.VERCEL_GITLAB_COMMIT_SHA ||
 process.env.VERCEL_BITBUCKET_COMMIT_SHA ||
 // Zeit (now known as Vercel)
 process.env.ZEIT_GITHUB_COMMIT_SHA ||
 process.env.ZEIT_GITLAB_COMMIT_SHA ||
 process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
 fallback
 );
 vercelEdgeInit(options);
}

/**
Expand All@@ -126,7 +28,8 @@ export function withSentryConfig<T>(exportedUserNextConfig: T): T {
 return exportedUserNextConfig;
}

export * from '@sentry/core';
export * from '@sentry/vercel-edge';
export { Span, Transaction } from '@sentry/core';

// eslint-disable-next-line import/export
export * from '../common';
Expand Down

103 changes: 0 additions & 103 deletions
packages/nextjs/src/edge/transport.ts

View file


Open in desktop


This file was deleted.

Loading

, '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
ref(nextjs): Use @sentry/vercel-edge in nextjs package#9053

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

Lms24
merged 3 commits into

from

Sep 20, 2023
 Merged


ref(nextjs): Use @sentry/vercel-edge in nextjs package
#9053
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
97755e3

ref(nextjs): Use @sentry/vercel-edge in nextjs package


AbhiPrasad Sep 19, 2023
5f78fe0

fix integration tests


Lms24 Sep 20, 2023
24465d9

fix e2e tests


Lms24 Sep 20, 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


4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/edge-route.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ test('Should create a transaction for edge routes', async ({ request }) => {

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty edge routes', async ({ request }) => {
Expand All@@ -34,7 +34,7 @@ test('Should create a transaction with error status for faulty edge routes', asy

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should record exceptions for faulty edge routes', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ test('Should create a transaction for middleware', async ({ request }) => {

 expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty middleware', async ({ request }) => {
Expand All@@ -31,7 +31,7 @@ test('Should create a transaction with error status for faulty middleware', asyn

 expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Records exceptions happening in middleware', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,9 @@ test.describe('Edge runtime', () => {

 expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('vercel-edge');

 expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-edge-error');
 expect(routehandlerError.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerError.contexts?.runtime?.name).toBe('vercel-edge');
 });
});

1 change: 1 addition & 0 deletions
packages/nextjs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
 "@sentry/react": "7.69.0",
 "@sentry/types": "7.69.0",
 "@sentry/utils": "7.69.0",
 "@sentry/vercel-edge": "7.69.0",
 "@sentry/webpack-plugin": "1.20.0",
 "chalk": "3.0.0",
 "rollup": "2.78.0",
Expand Down

59 changes: 0 additions & 59 deletions
packages/nextjs/src/edge/asyncLocalStorageAsyncContextStrategy.ts

View file


Open in desktop


This file was deleted.


117 changes: 10 additions & 107 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 getIntegrationsToSetup,
 initAndBind,
 Integrations as CoreIntegrations,
 SDK_VERSION,
 ServerRuntimeClient,
} from '@sentry/core';
import type { Options } from '@sentry/types';
import { createStackParser, GLOBAL_OBJ, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
import { SDK_VERSION } from '@sentry/core';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

import { getVercelEnv } from '../common/getVercelEnv';
import { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageAsyncContextStrategy';
import { makeEdgeTransport } from './transport';

const nodeStackParser = createStackParser(nodeStackLineParser());

export const defaultIntegrations = [new CoreIntegrations.InboundFilters(), new CoreIntegrations.FunctionToString()];

export type EdgeOptions = Options;
export type EdgeOptions = VercelEdgeOptions;

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: EdgeOptions = {}): void {
 setAsyncLocalStorageAsyncContextStrategy();

 if (options.defaultIntegrations === undefined) {
 options.defaultIntegrations = defaultIntegrations;
 }

 if (options.dsn === undefined && process.env.SENTRY_DSN) {
 options.dsn = process.env.SENTRY_DSN;
 }

 if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
 const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
 if (isFinite(tracesSampleRate)) {
 options.tracesSampleRate = tracesSampleRate;
 }
 }

 if (options.release === undefined) {
 const detectedRelease = getSentryRelease();
 if (detectedRelease !== undefined) {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 options.autoSessionTracking = true;
 }

 if (options.instrumenter === undefined) {
 options.instrumenter = 'sentry';
 }

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 stackParser: stackParserFromStackParserOptions(options.stackParser || nodeStackParser),
 integrations: getIntegrationsToSetup(options),
 transport: options.transport || makeEdgeTransport,
 };

 clientOptions._metadata = clientOptions._metadata || {};
 clientOptions._metadata.sdk = clientOptions._metadata.sdk || {
export function init(options: VercelEdgeOptions = {}): void {
 options._metadata = options._metadata || {};
 options._metadata.sdk = options._metadata.sdk || {
 name: 'sentry.javascript.nextjs',
 packages: [
 {
Expand All@@ -78,45 +18,7 @@ export function init(options: EdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 clientOptions.platform = 'edge';
 clientOptions.runtime = { name: 'edge' };
 clientOptions.serverName = process.env.SENTRY_NAME;

 initAndBind(ServerRuntimeClient, clientOptions);

 // TODO?: Sessiontracking
}

/**
 * Returns a release dynamically from environment variables.
 */
export function getSentryRelease(fallback?: string): string | undefined {
 // Always read first as Sentry takes this as precedence
 if (process.env.SENTRY_RELEASE) {
 return process.env.SENTRY_RELEASE;
 }

 // This supports the variable that sentry-webpack-plugin injects
 if (GLOBAL_OBJ.SENTRY_RELEASE && GLOBAL_OBJ.SENTRY_RELEASE.id) {
 return GLOBAL_OBJ.SENTRY_RELEASE.id;
 }

 return (
 // GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 process.env.GITHUB_SHA ||
 // Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
 process.env.COMMIT_REF ||
 // Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
 process.env.VERCEL_GIT_COMMIT_SHA ||
 process.env.VERCEL_GITHUB_COMMIT_SHA ||
 process.env.VERCEL_GITLAB_COMMIT_SHA ||
 process.env.VERCEL_BITBUCKET_COMMIT_SHA ||
 // Zeit (now known as Vercel)
 process.env.ZEIT_GITHUB_COMMIT_SHA ||
 process.env.ZEIT_GITLAB_COMMIT_SHA ||
 process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
 fallback
 );
 vercelEdgeInit(options);
}

/**
Expand All@@ -126,7 +28,8 @@ export function withSentryConfig<T>(exportedUserNextConfig: T): T {
 return exportedUserNextConfig;
}

export * from '@sentry/core';
export * from '@sentry/vercel-edge';
export { Span, Transaction } from '@sentry/core';

// eslint-disable-next-line import/export
export * from '../common';
Expand Down

103 changes: 0 additions & 103 deletions
packages/nextjs/src/edge/transport.ts

View file


Open in desktop


This file was deleted.

Loading

, '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
ref(nextjs): Use @sentry/vercel-edge in nextjs package#9053

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

Lms24
merged 3 commits into

from

Sep 20, 2023
 Merged


ref(nextjs): Use @sentry/vercel-edge in nextjs package
#9053
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
97755e3

ref(nextjs): Use @sentry/vercel-edge in nextjs package


AbhiPrasad Sep 19, 2023
5f78fe0

fix integration tests


Lms24 Sep 20, 2023
24465d9

fix e2e tests


Lms24 Sep 20, 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


4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/edge-route.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ test('Should create a transaction for edge routes', async ({ request }) => {

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty edge routes', async ({ request }) => {
Expand All@@ -34,7 +34,7 @@ test('Should create a transaction with error status for faulty edge routes', asy

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should record exceptions for faulty edge routes', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ test('Should create a transaction for middleware', async ({ request }) => {

 expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty middleware', async ({ request }) => {
Expand All@@ -31,7 +31,7 @@ test('Should create a transaction with error status for faulty middleware', asyn

 expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Records exceptions happening in middleware', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,9 @@ test.describe('Edge runtime', () => {

 expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('vercel-edge');

 expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-edge-error');
 expect(routehandlerError.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerError.contexts?.runtime?.name).toBe('vercel-edge');
 });
});

1 change: 1 addition & 0 deletions
packages/nextjs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
 "@sentry/react": "7.69.0",
 "@sentry/types": "7.69.0",
 "@sentry/utils": "7.69.0",
 "@sentry/vercel-edge": "7.69.0",
 "@sentry/webpack-plugin": "1.20.0",
 "chalk": "3.0.0",
 "rollup": "2.78.0",
Expand Down

59 changes: 0 additions & 59 deletions
packages/nextjs/src/edge/asyncLocalStorageAsyncContextStrategy.ts

View file


Open in desktop


This file was deleted.


117 changes: 10 additions & 107 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 getIntegrationsToSetup,
 initAndBind,
 Integrations as CoreIntegrations,
 SDK_VERSION,
 ServerRuntimeClient,
} from '@sentry/core';
import type { Options } from '@sentry/types';
import { createStackParser, GLOBAL_OBJ, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
import { SDK_VERSION } from '@sentry/core';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

import { getVercelEnv } from '../common/getVercelEnv';
import { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageAsyncContextStrategy';
import { makeEdgeTransport } from './transport';

const nodeStackParser = createStackParser(nodeStackLineParser());

export const defaultIntegrations = [new CoreIntegrations.InboundFilters(), new CoreIntegrations.FunctionToString()];

export type EdgeOptions = Options;
export type EdgeOptions = VercelEdgeOptions;

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: EdgeOptions = {}): void {
 setAsyncLocalStorageAsyncContextStrategy();

 if (options.defaultIntegrations === undefined) {
 options.defaultIntegrations = defaultIntegrations;
 }

 if (options.dsn === undefined && process.env.SENTRY_DSN) {
 options.dsn = process.env.SENTRY_DSN;
 }

 if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
 const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
 if (isFinite(tracesSampleRate)) {
 options.tracesSampleRate = tracesSampleRate;
 }
 }

 if (options.release === undefined) {
 const detectedRelease = getSentryRelease();
 if (detectedRelease !== undefined) {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 options.autoSessionTracking = true;
 }

 if (options.instrumenter === undefined) {
 options.instrumenter = 'sentry';
 }

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 stackParser: stackParserFromStackParserOptions(options.stackParser || nodeStackParser),
 integrations: getIntegrationsToSetup(options),
 transport: options.transport || makeEdgeTransport,
 };

 clientOptions._metadata = clientOptions._metadata || {};
 clientOptions._metadata.sdk = clientOptions._metadata.sdk || {
export function init(options: VercelEdgeOptions = {}): void {
 options._metadata = options._metadata || {};
 options._metadata.sdk = options._metadata.sdk || {
 name: 'sentry.javascript.nextjs',
 packages: [
 {
Expand All@@ -78,45 +18,7 @@ export function init(options: EdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 clientOptions.platform = 'edge';
 clientOptions.runtime = { name: 'edge' };
 clientOptions.serverName = process.env.SENTRY_NAME;

 initAndBind(ServerRuntimeClient, clientOptions);

 // TODO?: Sessiontracking
}

/**
 * Returns a release dynamically from environment variables.
 */
export function getSentryRelease(fallback?: string): string | undefined {
 // Always read first as Sentry takes this as precedence
 if (process.env.SENTRY_RELEASE) {
 return process.env.SENTRY_RELEASE;
 }

 // This supports the variable that sentry-webpack-plugin injects
 if (GLOBAL_OBJ.SENTRY_RELEASE && GLOBAL_OBJ.SENTRY_RELEASE.id) {
 return GLOBAL_OBJ.SENTRY_RELEASE.id;
 }

 return (
 // GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 process.env.GITHUB_SHA ||
 // Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
 process.env.COMMIT_REF ||
 // Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
 process.env.VERCEL_GIT_COMMIT_SHA ||
 process.env.VERCEL_GITHUB_COMMIT_SHA ||
 process.env.VERCEL_GITLAB_COMMIT_SHA ||
 process.env.VERCEL_BITBUCKET_COMMIT_SHA ||
 // Zeit (now known as Vercel)
 process.env.ZEIT_GITHUB_COMMIT_SHA ||
 process.env.ZEIT_GITLAB_COMMIT_SHA ||
 process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
 fallback
 );
 vercelEdgeInit(options);
}

/**
Expand All@@ -126,7 +28,8 @@ export function withSentryConfig<T>(exportedUserNextConfig: T): T {
 return exportedUserNextConfig;
}

export * from '@sentry/core';
export * from '@sentry/vercel-edge';
export { Span, Transaction } from '@sentry/core';

// eslint-disable-next-line import/export
export * from '../common';
Expand Down

103 changes: 0 additions & 103 deletions
packages/nextjs/src/edge/transport.ts

View file


Open in desktop


This file was deleted.

Loading

, '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
ref(nextjs): Use @sentry/vercel-edge in nextjs package#9053

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

Lms24
merged 3 commits into

from

Sep 20, 2023
 Merged


ref(nextjs): Use @sentry/vercel-edge in nextjs package
#9053
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
97755e3

ref(nextjs): Use @sentry/vercel-edge in nextjs package


AbhiPrasad Sep 19, 2023
5f78fe0

fix integration tests


Lms24 Sep 20, 2023
24465d9

fix e2e tests


Lms24 Sep 20, 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


4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/edge-route.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ test('Should create a transaction for edge routes', async ({ request }) => {

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty edge routes', async ({ request }) => {
Expand All@@ -34,7 +34,7 @@ test('Should create a transaction with error status for faulty edge routes', asy

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should record exceptions for faulty edge routes', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ test('Should create a transaction for middleware', async ({ request }) => {

 expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty middleware', async ({ request }) => {
Expand All@@ -31,7 +31,7 @@ test('Should create a transaction with error status for faulty middleware', asyn

 expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Records exceptions happening in middleware', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,9 @@ test.describe('Edge runtime', () => {

 expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('vercel-edge');

 expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-edge-error');
 expect(routehandlerError.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerError.contexts?.runtime?.name).toBe('vercel-edge');
 });
});

1 change: 1 addition & 0 deletions
packages/nextjs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
 "@sentry/react": "7.69.0",
 "@sentry/types": "7.69.0",
 "@sentry/utils": "7.69.0",
 "@sentry/vercel-edge": "7.69.0",
 "@sentry/webpack-plugin": "1.20.0",
 "chalk": "3.0.0",
 "rollup": "2.78.0",
Expand Down

59 changes: 0 additions & 59 deletions
packages/nextjs/src/edge/asyncLocalStorageAsyncContextStrategy.ts

View file


Open in desktop


This file was deleted.


117 changes: 10 additions & 107 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 getIntegrationsToSetup,
 initAndBind,
 Integrations as CoreIntegrations,
 SDK_VERSION,
 ServerRuntimeClient,
} from '@sentry/core';
import type { Options } from '@sentry/types';
import { createStackParser, GLOBAL_OBJ, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
import { SDK_VERSION } from '@sentry/core';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

import { getVercelEnv } from '../common/getVercelEnv';
import { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageAsyncContextStrategy';
import { makeEdgeTransport } from './transport';

const nodeStackParser = createStackParser(nodeStackLineParser());

export const defaultIntegrations = [new CoreIntegrations.InboundFilters(), new CoreIntegrations.FunctionToString()];

export type EdgeOptions = Options;
export type EdgeOptions = VercelEdgeOptions;

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: EdgeOptions = {}): void {
 setAsyncLocalStorageAsyncContextStrategy();

 if (options.defaultIntegrations === undefined) {
 options.defaultIntegrations = defaultIntegrations;
 }

 if (options.dsn === undefined && process.env.SENTRY_DSN) {
 options.dsn = process.env.SENTRY_DSN;
 }

 if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
 const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
 if (isFinite(tracesSampleRate)) {
 options.tracesSampleRate = tracesSampleRate;
 }
 }

 if (options.release === undefined) {
 const detectedRelease = getSentryRelease();
 if (detectedRelease !== undefined) {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 options.autoSessionTracking = true;
 }

 if (options.instrumenter === undefined) {
 options.instrumenter = 'sentry';
 }

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 stackParser: stackParserFromStackParserOptions(options.stackParser || nodeStackParser),
 integrations: getIntegrationsToSetup(options),
 transport: options.transport || makeEdgeTransport,
 };

 clientOptions._metadata = clientOptions._metadata || {};
 clientOptions._metadata.sdk = clientOptions._metadata.sdk || {
export function init(options: VercelEdgeOptions = {}): void {
 options._metadata = options._metadata || {};
 options._metadata.sdk = options._metadata.sdk || {
 name: 'sentry.javascript.nextjs',
 packages: [
 {
Expand All@@ -78,45 +18,7 @@ export function init(options: EdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 clientOptions.platform = 'edge';
 clientOptions.runtime = { name: 'edge' };
 clientOptions.serverName = process.env.SENTRY_NAME;

 initAndBind(ServerRuntimeClient, clientOptions);

 // TODO?: Sessiontracking
}

/**
 * Returns a release dynamically from environment variables.
 */
export function getSentryRelease(fallback?: string): string | undefined {
 // Always read first as Sentry takes this as precedence
 if (process.env.SENTRY_RELEASE) {
 return process.env.SENTRY_RELEASE;
 }

 // This supports the variable that sentry-webpack-plugin injects
 if (GLOBAL_OBJ.SENTRY_RELEASE && GLOBAL_OBJ.SENTRY_RELEASE.id) {
 return GLOBAL_OBJ.SENTRY_RELEASE.id;
 }

 return (
 // GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 process.env.GITHUB_SHA ||
 // Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
 process.env.COMMIT_REF ||
 // Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
 process.env.VERCEL_GIT_COMMIT_SHA ||
 process.env.VERCEL_GITHUB_COMMIT_SHA ||
 process.env.VERCEL_GITLAB_COMMIT_SHA ||
 process.env.VERCEL_BITBUCKET_COMMIT_SHA ||
 // Zeit (now known as Vercel)
 process.env.ZEIT_GITHUB_COMMIT_SHA ||
 process.env.ZEIT_GITLAB_COMMIT_SHA ||
 process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
 fallback
 );
 vercelEdgeInit(options);
}

/**
Expand All@@ -126,7 +28,8 @@ export function withSentryConfig<T>(exportedUserNextConfig: T): T {
 return exportedUserNextConfig;
}

export * from '@sentry/core';
export * from '@sentry/vercel-edge';
export { Span, Transaction } from '@sentry/core';

// eslint-disable-next-line import/export
export * from '../common';
Expand Down

103 changes: 0 additions & 103 deletions
packages/nextjs/src/edge/transport.ts

View file


Open in desktop


This file was deleted.

Loading

, '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
ref(nextjs): Use @sentry/vercel-edge in nextjs package#9053

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

Lms24
merged 3 commits into

from

Sep 20, 2023
 Merged


ref(nextjs): Use @sentry/vercel-edge in nextjs package
#9053
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
97755e3

ref(nextjs): Use @sentry/vercel-edge in nextjs package


AbhiPrasad Sep 19, 2023
5f78fe0

fix integration tests


Lms24 Sep 20, 2023
24465d9

fix e2e tests


Lms24 Sep 20, 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


4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/edge-route.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ test('Should create a transaction for edge routes', async ({ request }) => {

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty edge routes', async ({ request }) => {
Expand All@@ -34,7 +34,7 @@ test('Should create a transaction with error status for faulty edge routes', asy

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should record exceptions for faulty edge routes', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ test('Should create a transaction for middleware', async ({ request }) => {

 expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty middleware', async ({ request }) => {
Expand All@@ -31,7 +31,7 @@ test('Should create a transaction with error status for faulty middleware', asyn

 expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Records exceptions happening in middleware', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,9 @@ test.describe('Edge runtime', () => {

 expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('vercel-edge');

 expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-edge-error');
 expect(routehandlerError.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerError.contexts?.runtime?.name).toBe('vercel-edge');
 });
});

1 change: 1 addition & 0 deletions
packages/nextjs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
 "@sentry/react": "7.69.0",
 "@sentry/types": "7.69.0",
 "@sentry/utils": "7.69.0",
 "@sentry/vercel-edge": "7.69.0",
 "@sentry/webpack-plugin": "1.20.0",
 "chalk": "3.0.0",
 "rollup": "2.78.0",
Expand Down

59 changes: 0 additions & 59 deletions
packages/nextjs/src/edge/asyncLocalStorageAsyncContextStrategy.ts

View file


Open in desktop


This file was deleted.


117 changes: 10 additions & 107 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 getIntegrationsToSetup,
 initAndBind,
 Integrations as CoreIntegrations,
 SDK_VERSION,
 ServerRuntimeClient,
} from '@sentry/core';
import type { Options } from '@sentry/types';
import { createStackParser, GLOBAL_OBJ, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
import { SDK_VERSION } from '@sentry/core';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

import { getVercelEnv } from '../common/getVercelEnv';
import { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageAsyncContextStrategy';
import { makeEdgeTransport } from './transport';

const nodeStackParser = createStackParser(nodeStackLineParser());

export const defaultIntegrations = [new CoreIntegrations.InboundFilters(), new CoreIntegrations.FunctionToString()];

export type EdgeOptions = Options;
export type EdgeOptions = VercelEdgeOptions;

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: EdgeOptions = {}): void {
 setAsyncLocalStorageAsyncContextStrategy();

 if (options.defaultIntegrations === undefined) {
 options.defaultIntegrations = defaultIntegrations;
 }

 if (options.dsn === undefined && process.env.SENTRY_DSN) {
 options.dsn = process.env.SENTRY_DSN;
 }

 if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
 const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
 if (isFinite(tracesSampleRate)) {
 options.tracesSampleRate = tracesSampleRate;
 }
 }

 if (options.release === undefined) {
 const detectedRelease = getSentryRelease();
 if (detectedRelease !== undefined) {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 options.autoSessionTracking = true;
 }

 if (options.instrumenter === undefined) {
 options.instrumenter = 'sentry';
 }

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 stackParser: stackParserFromStackParserOptions(options.stackParser || nodeStackParser),
 integrations: getIntegrationsToSetup(options),
 transport: options.transport || makeEdgeTransport,
 };

 clientOptions._metadata = clientOptions._metadata || {};
 clientOptions._metadata.sdk = clientOptions._metadata.sdk || {
export function init(options: VercelEdgeOptions = {}): void {
 options._metadata = options._metadata || {};
 options._metadata.sdk = options._metadata.sdk || {
 name: 'sentry.javascript.nextjs',
 packages: [
 {
Expand All@@ -78,45 +18,7 @@ export function init(options: EdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 clientOptions.platform = 'edge';
 clientOptions.runtime = { name: 'edge' };
 clientOptions.serverName = process.env.SENTRY_NAME;

 initAndBind(ServerRuntimeClient, clientOptions);

 // TODO?: Sessiontracking
}

/**
 * Returns a release dynamically from environment variables.
 */
export function getSentryRelease(fallback?: string): string | undefined {
 // Always read first as Sentry takes this as precedence
 if (process.env.SENTRY_RELEASE) {
 return process.env.SENTRY_RELEASE;
 }

 // This supports the variable that sentry-webpack-plugin injects
 if (GLOBAL_OBJ.SENTRY_RELEASE && GLOBAL_OBJ.SENTRY_RELEASE.id) {
 return GLOBAL_OBJ.SENTRY_RELEASE.id;
 }

 return (
 // GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 process.env.GITHUB_SHA ||
 // Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
 process.env.COMMIT_REF ||
 // Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
 process.env.VERCEL_GIT_COMMIT_SHA ||
 process.env.VERCEL_GITHUB_COMMIT_SHA ||
 process.env.VERCEL_GITLAB_COMMIT_SHA ||
 process.env.VERCEL_BITBUCKET_COMMIT_SHA ||
 // Zeit (now known as Vercel)
 process.env.ZEIT_GITHUB_COMMIT_SHA ||
 process.env.ZEIT_GITLAB_COMMIT_SHA ||
 process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
 fallback
 );
 vercelEdgeInit(options);
}

/**
Expand All@@ -126,7 +28,8 @@ export function withSentryConfig<T>(exportedUserNextConfig: T): T {
 return exportedUserNextConfig;
}

export * from '@sentry/core';
export * from '@sentry/vercel-edge';
export { Span, Transaction } from '@sentry/core';

// eslint-disable-next-line import/export
export * from '../common';
Expand Down

103 changes: 0 additions & 103 deletions
packages/nextjs/src/edge/transport.ts

View file


Open in desktop


This file was deleted.

Loading

, '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
ref(nextjs): Use @sentry/vercel-edge in nextjs package#9053

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

Lms24
merged 3 commits into

from

Sep 20, 2023
 Merged


ref(nextjs): Use @sentry/vercel-edge in nextjs package
#9053
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
97755e3

ref(nextjs): Use @sentry/vercel-edge in nextjs package


AbhiPrasad Sep 19, 2023
5f78fe0

fix integration tests


Lms24 Sep 20, 2023
24465d9

fix e2e tests


Lms24 Sep 20, 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


4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/edge-route.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ test('Should create a transaction for edge routes', async ({ request }) => {

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty edge routes', async ({ request }) => {
Expand All@@ -34,7 +34,7 @@ test('Should create a transaction with error status for faulty edge routes', asy

 expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('edge');
 expect(edgerouteTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should record exceptions for faulty edge routes', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ test('Should create a transaction for middleware', async ({ request }) => {

 expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Should create a transaction with error status for faulty middleware', async ({ request }) => {
Expand All@@ -31,7 +31,7 @@ test('Should create a transaction with error status for faulty middleware', asyn

 expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware.nextjs');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('edge');
 expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
});

test('Records exceptions happening in middleware', async ({ request }) => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,9 @@ test.describe('Edge runtime', () => {

 expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error');
 expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerTransaction.contexts?.runtime?.name).toBe('vercel-edge');

 expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-edge-error');
 expect(routehandlerError.contexts?.runtime?.name).toBe('edge');
 expect(routehandlerError.contexts?.runtime?.name).toBe('vercel-edge');
 });
});

1 change: 1 addition & 0 deletions
packages/nextjs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
 "@sentry/react": "7.69.0",
 "@sentry/types": "7.69.0",
 "@sentry/utils": "7.69.0",
 "@sentry/vercel-edge": "7.69.0",
 "@sentry/webpack-plugin": "1.20.0",
 "chalk": "3.0.0",
 "rollup": "2.78.0",
Expand Down

59 changes: 0 additions & 59 deletions
packages/nextjs/src/edge/asyncLocalStorageAsyncContextStrategy.ts

View file


Open in desktop


This file was deleted.


117 changes: 10 additions & 107 deletions
packages/nextjs/src/edge/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 getIntegrationsToSetup,
 initAndBind,
 Integrations as CoreIntegrations,
 SDK_VERSION,
 ServerRuntimeClient,
} from '@sentry/core';
import type { Options } from '@sentry/types';
import { createStackParser, GLOBAL_OBJ, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
import { SDK_VERSION } from '@sentry/core';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { init as vercelEdgeInit } from '@sentry/vercel-edge';

import { getVercelEnv } from '../common/getVercelEnv';
import { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageAsyncContextStrategy';
import { makeEdgeTransport } from './transport';

const nodeStackParser = createStackParser(nodeStackLineParser());

export const defaultIntegrations = [new CoreIntegrations.InboundFilters(), new CoreIntegrations.FunctionToString()];

export type EdgeOptions = Options;
export type EdgeOptions = VercelEdgeOptions;

/** Inits the Sentry NextJS SDK on the Edge Runtime. */
export function init(options: EdgeOptions = {}): void {
 setAsyncLocalStorageAsyncContextStrategy();

 if (options.defaultIntegrations === undefined) {
 options.defaultIntegrations = defaultIntegrations;
 }

 if (options.dsn === undefined && process.env.SENTRY_DSN) {
 options.dsn = process.env.SENTRY_DSN;
 }

 if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
 const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
 if (isFinite(tracesSampleRate)) {
 options.tracesSampleRate = tracesSampleRate;
 }
 }

 if (options.release === undefined) {
 const detectedRelease = getSentryRelease();
 if (detectedRelease !== undefined) {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 options.autoSessionTracking = true;
 }

 if (options.instrumenter === undefined) {
 options.instrumenter = 'sentry';
 }

 const clientOptions: ServerRuntimeClientOptions = {
 ...options,
 stackParser: stackParserFromStackParserOptions(options.stackParser || nodeStackParser),
 integrations: getIntegrationsToSetup(options),
 transport: options.transport || makeEdgeTransport,
 };

 clientOptions._metadata = clientOptions._metadata || {};
 clientOptions._metadata.sdk = clientOptions._metadata.sdk || {
export function init(options: VercelEdgeOptions = {}): void {
 options._metadata = options._metadata || {};
 options._metadata.sdk = options._metadata.sdk || {
 name: 'sentry.javascript.nextjs',
 packages: [
 {
Expand All@@ -78,45 +18,7 @@ export function init(options: EdgeOptions = {}): void {
 version: SDK_VERSION,
 };

 clientOptions.platform = 'edge';
 clientOptions.runtime = { name: 'edge' };
 clientOptions.serverName = process.env.SENTRY_NAME;

 initAndBind(ServerRuntimeClient, clientOptions);

 // TODO?: Sessiontracking
}

/**
 * Returns a release dynamically from environment variables.
 */
export function getSentryRelease(fallback?: string): string | undefined {
 // Always read first as Sentry takes this as precedence
 if (process.env.SENTRY_RELEASE) {
 return process.env.SENTRY_RELEASE;
 }

 // This supports the variable that sentry-webpack-plugin injects
 if (GLOBAL_OBJ.SENTRY_RELEASE && GLOBAL_OBJ.SENTRY_RELEASE.id) {
 return GLOBAL_OBJ.SENTRY_RELEASE.id;
 }

 return (
 // GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 process.env.GITHUB_SHA ||
 // Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
 process.env.COMMIT_REF ||
 // Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
 process.env.VERCEL_GIT_COMMIT_SHA ||
 process.env.VERCEL_GITHUB_COMMIT_SHA ||
 process.env.VERCEL_GITLAB_COMMIT_SHA ||
 process.env.VERCEL_BITBUCKET_COMMIT_SHA ||
 // Zeit (now known as Vercel)
 process.env.ZEIT_GITHUB_COMMIT_SHA ||
 process.env.ZEIT_GITLAB_COMMIT_SHA ||
 process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
 fallback
 );
 vercelEdgeInit(options);
}

/**
Expand All@@ -126,7 +28,8 @@ export function withSentryConfig<T>(exportedUserNextConfig: T): T {
 return exportedUserNextConfig;
}

export * from '@sentry/core';
export * from '@sentry/vercel-edge';
export { Span, Transaction } from '@sentry/core';

// eslint-disable-next-line import/export
export * from '../common';
Expand Down

103 changes: 0 additions & 103 deletions
packages/nextjs/src/edge/transport.ts

View file


Open in desktop


This file was deleted.

Loading