Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"#18768

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

Closed
chargome wants to merge 1 commit into from
Closed

Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0" #18768

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 2 additions & 38 deletions packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { SEMATTRS_HTTP_TARGET } from '@opentelemetry/semantic-conventions';
import {
getClient,
GLOBAL_OBJ,
isSentryRequestUrl,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
type Span,
type SpanAttributes,
} from '@sentry/core';
import { GLOBAL_OBJ, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, type Span, type SpanAttributes } from '@sentry/core';
import { isSentryRequestSpan } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';

Expand DownExpand Up@@ -42,36 +36,6 @@ export function dropMiddlewareTunnelRequests(span: Span, attrs: SpanAttributes |
}
}

/**
* Local copy of `@sentry/opentelemetry`'s `isSentryRequestSpan`, to avoid pulling the whole package into Edge bundles.
*/
function isSentryRequestSpan(span: Span): boolean {
const attributes = spanToAttributes(span);
if (!attributes) {
return false;
}

const httpUrl = attributes['http.url'] || attributes['url.full'];
if (!httpUrl) {
return false;
}

return isSentryRequestUrl(httpUrl.toString(), getClient());
}

function spanToAttributes(span: Span): Record<string, unknown> | undefined {
// OTEL spans expose attributes in different shapes depending on implementation.
// We only need best-effort read access.
type MaybeSpanAttributes = {
attributes?: Record<string, unknown>;
_attributes?: Record<string, unknown>;
};

const maybeSpan = span as unknown as MaybeSpanAttributes;
const attrs = maybeSpan.attributes || maybeSpan._attributes;
return attrs;
}

/**
* Checks if a span's HTTP target matches the tunnel route.
*/
Expand Down
30 changes: 2 additions & 28 deletions packages/nextjs/src/edge/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context, createContextKey } from '@opentelemetry/api';
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
type EventProcessor,
Expand All@@ -12,14 +12,14 @@ import {
getRootSpan,
GLOBAL_OBJ,
registerSpanErrorInstrumentation,
type Scope,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
Expand All@@ -42,32 +42,6 @@ export { wrapApiHandlerWithSentry } from './wrapApiHandlerWithSentry';

export type EdgeOptions = VercelEdgeOptions;

type CurrentScopes = {
scope: Scope;
isolationScope: Scope;
};

// This key must match `@sentry/opentelemetry`'s `SENTRY_SCOPES_CONTEXT_KEY`.
// We duplicate it here so the Edge bundle does not need to import the full `@sentry/opentelemetry` package.
const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

type ContextWithGetValue = {
getValue(key: unknown): unknown;
};

function getScopesFromContext(otelContext: unknown): CurrentScopes | undefined {
if (!otelContext || typeof otelContext !== 'object') {
return undefined;
}

const maybeContext = otelContext as Partial<ContextWithGetValue>;
if (typeof maybeContext.getValue !== 'function') {
return undefined;
}

return maybeContext.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
_sentryRewriteFramesDistDir?: string;
_sentryRelease?: string;
Expand Down
4 changes: 0 additions & 4 deletions packages/opentelemetry/src/constants.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ export const SENTRY_TRACE_STATE_URL = 'sentry.url';
export const SENTRY_TRACE_STATE_SAMPLE_RAND = 'sentry.sample_rand';
export const SENTRY_TRACE_STATE_SAMPLE_RATE = 'sentry.sample_rate';

// NOTE: `@sentry/nextjs` has a local copy of this context key for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`SENTRY_SCOPES_CONTEXT_KEY`)
//
// If you change the key name passed to `createContextKey(...)`, update that file too.
export const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

export const SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY = createContextKey('sentry_fork_isolation_scope');
Expand Down
4 changes: 0 additions & 4 deletions packages/opentelemetry/src/utils/contextData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,6 @@ const SCOPE_CONTEXT_FIELD = '_scopeContext';
* This requires a Context Manager that was wrapped with getWrappedContextManager.
*/
export function getScopesFromContext(context: Context): CurrentScopes | undefined {
// NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`getScopesFromContext`)
//
// If you change how scopes are stored/read (key or retrieval), update that file too.
return context.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

Expand Down
4 changes: 0 additions & 4 deletions packages/opentelemetry/src/utils/isSentryRequest.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ import { spanHasAttributes } from './spanTypes';
* @returns boolean
*/
export function isSentryRequestSpan(span: AbstractSpan): boolean {
// NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
// - `packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts` (`isSentryRequestSpan`)
//
// If you change supported OTEL attribute keys or request detection logic, update that file too.
if (!spanHasAttributes(span)) {
return false;
}
Expand Down
201 changes: 71 additions & 130 deletions packages/vercel-edge/rollup.npm.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,138 +1,79 @@
import replace from '@rollup/plugin-replace';
import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '@sentry-internal/rollup-utils';

const downlevelLogicalAssignmentsPlugin = {
name: 'downlevel-logical-assignments',
renderChunk(code) {
// ES2021 logical assignment operators (`||=`, `&&=`, `??=`) are not allowed by our ES2020 compatibility check.
// OTEL currently ships some of these, so we downlevel them in the final output.
//
// Note: This is intentionally conservative (only matches property access-like LHS) to avoid duplicating side effects.
// IMPORTANT: Use regex literals (not `String.raw` + `RegExp(...)`) to avoid accidental double-escaping.
let out = code;

// ??=
out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\?\?=\s*([^;]+);/g, (_m, left, right) => {
return `${left} = ${left} ?? ${right};`;
});

// ||=
out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\|\|=\s*([^;]+);/g, (_m, left, right) => {
return `${left} = ${left} || ${right};`;
});

// &&=
out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*&&=\s*([^;]+);/g, (_m, left, right) => {
return `${left} = ${left} && ${right};`;
});

return { code: out, map: null };
},
};

const baseConfig = makeBaseNPMConfig({
entrypoints: ['src/index.ts'],
bundledBuiltins: ['perf_hooks', 'util'],
packageSpecificConfig: {
context: 'globalThis',
output: {
preserveModules: false,
},
plugins: [
plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
replace({
preventAssignment: true,
values: {
'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
},
}),
{
// This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
// It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
// Both of these APIs are not available in the edge runtime so we need to define a polyfill.
// Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
name: 'edge-runtime-polyfills',
banner: `
{
if (globalThis.performance === undefined) {
globalThis.performance = {
timeOrigin: 0,
now: () => Date.now()
};
}
}
`,
resolveId: source => {
if (source === 'perf_hooks') {
return '\0perf_hooks_sentry_shim';
} else if (source === 'util') {
return '\0util_sentry_shim';
} else {
return null;
}
},
load: id => {
if (id === '\0perf_hooks_sentry_shim') {
return `
export const performance = {
timeOrigin: 0,
now: () => Date.now()
export default makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.ts'],
bundledBuiltins: ['perf_hooks', 'util'],
packageSpecificConfig: {
context: 'globalThis',
output: {
preserveModules: false,
},
plugins: [
plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
replace({
preventAssignment: true,
values: {
'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
},
}),
{
// This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
// It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
// Both of these APIs are not available in the edge runtime so we need to define a polyfill.
// Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
name: 'edge-runtime-polyfills',
banner: `
{
if (globalThis.performance === undefined) {
globalThis.performance = {
timeOrigin: 0,
now: () => Date.now()
};
}
`;
} else if (id === '\0util_sentry_shim') {
return `
export const inspect = (object) =>
JSON.stringify(object, null, 2);
}
`,
resolveId: source => {
if (source === 'perf_hooks') {
return '\0perf_hooks_sentry_shim';
} else if (source === 'util') {
return '\0util_sentry_shim';
} else {
return null;
}
},
load: id => {
if (id === '\0perf_hooks_sentry_shim') {
return `
export const performance = {
timeOrigin: 0,
now: () => Date.now()
}
`;
} else if (id === '\0util_sentry_shim') {
return `
export const inspect = (object) =>
JSON.stringify(object, null, 2);

export const promisify = (fn) => {
return (...args) => {
return new Promise((resolve, reject) => {
fn(...args, (err, result) => {
if (err) reject(err);
else resolve(result);
export const promisify = (fn) => {
return (...args) => {
return new Promise((resolve, reject) => {
fn(...args, (err, result) => {
if (err) reject(err);
else resolve(result);
});
});
});
};
};
};
`;
} else {
return null;
}
`;
} else {
return null;
}
},
},
},
downlevelLogicalAssignmentsPlugin,
],
},
});

// `makeBaseNPMConfig` marks dependencies/peers as external by default.
// For Edge, we must ensure the OTEL SDK bits which reference `process.argv0` are bundled so our replace() plugin applies.
const baseExternal = baseConfig.external;
baseConfig.external = (source, importer, isResolved) => {
// Never treat these as external - they need to be inlined so `process.argv0` can be replaced.
if (
source === '@opentelemetry/resources' ||
source.startsWith('@opentelemetry/resources/') ||
source === '@opentelemetry/sdk-trace-base' ||
source.startsWith('@opentelemetry/sdk-trace-base/')
) {
return false;
}

if (typeof baseExternal === 'function') {
return baseExternal(source, importer, isResolved);
}

if (Array.isArray(baseExternal)) {
return baseExternal.includes(source);
}

if (baseExternal instanceof RegExp) {
return baseExternal.test(source);
}

return false;
};

export default makeNPMConfigVariants(baseConfig);
],
},
}),
);
32 changes: 0 additions & 32 deletions packages/vercel-edge/test/build-artifacts.test.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
Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"#18768

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

 Closed

chargome
wants to merge
1
commit into

from

 Closed


Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"
#18768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


40 changes: 2 additions & 38 deletions
packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { SEMATTRS_HTTP_TARGET } from '@opentelemetry/semantic-conventions';
import {
 getClient,
 GLOBAL_OBJ,
 isSentryRequestUrl,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 type Span,
 type SpanAttributes,
} from '@sentry/core';
import { GLOBAL_OBJ, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, type Span, type SpanAttributes } from '@sentry/core';
import { isSentryRequestSpan } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';

Expand DownExpand Up@@ -42,36 +36,6 @@ export function dropMiddlewareTunnelRequests(span: Span, attrs: SpanAttributes |
 }
}

/**
 * Local copy of `@sentry/opentelemetry`'s `isSentryRequestSpan`, to avoid pulling the whole package into Edge bundles.
 */
function isSentryRequestSpan(span: Span): boolean {
 const attributes = spanToAttributes(span);
 if (!attributes) {
 return false;
 }

 const httpUrl = attributes['http.url'] || attributes['url.full'];
 if (!httpUrl) {
 return false;
 }

 return isSentryRequestUrl(httpUrl.toString(), getClient());
}

function spanToAttributes(span: Span): Record<string, unknown> | undefined {
 // OTEL spans expose attributes in different shapes depending on implementation.
 // We only need best-effort read access.
 type MaybeSpanAttributes = {
 attributes?: Record<string, unknown>;
 _attributes?: Record<string, unknown>;
 };

 const maybeSpan = span as unknown as MaybeSpanAttributes;
 const attrs = maybeSpan.attributes || maybeSpan._attributes;
 return attrs;
}

/**
 * Checks if a span's HTTP target matches the tunnel route.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context, createContextKey } from '@opentelemetry/api';
import { context } from '@opentelemetry/api';
import {
 applySdkMetadata,
 type EventProcessor,
Expand All@@ -12,14 +12,14 @@ import {
 getRootSpan,
 GLOBAL_OBJ,
 registerSpanErrorInstrumentation,
 type Scope,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 setCapturedScopesOnSpan,
 spanToJSON,
 stripUrlQueryAndFragment,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
Expand All@@ -42,32 +42,6 @@ export { wrapApiHandlerWithSentry } from './wrapApiHandlerWithSentry';

export type EdgeOptions = VercelEdgeOptions;

type CurrentScopes = {
 scope: Scope;
 isolationScope: Scope;
};

// This key must match `@sentry/opentelemetry`'s `SENTRY_SCOPES_CONTEXT_KEY`.
// We duplicate it here so the Edge bundle does not need to import the full `@sentry/opentelemetry` package.
const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

type ContextWithGetValue = {
 getValue(key: unknown): unknown;
};

function getScopesFromContext(otelContext: unknown): CurrentScopes | undefined {
 if (!otelContext || typeof otelContext !== 'object') {
 return undefined;
 }

 const maybeContext = otelContext as Partial<ContextWithGetValue>;
 if (typeof maybeContext.getValue !== 'function') {
 return undefined;
 }

 return maybeContext.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 _sentryRewriteFramesDistDir?: string;
 _sentryRelease?: string;
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ export const SENTRY_TRACE_STATE_URL = 'sentry.url';
export const SENTRY_TRACE_STATE_SAMPLE_RAND = 'sentry.sample_rand';
export const SENTRY_TRACE_STATE_SAMPLE_RATE = 'sentry.sample_rate';

// NOTE: `@sentry/nextjs` has a local copy of this context key for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`SENTRY_SCOPES_CONTEXT_KEY`)
//
// If you change the key name passed to `createContextKey(...)`, update that file too.
export const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

export const SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY = createContextKey('sentry_fork_isolation_scope');
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/contextData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,6 @@ const SCOPE_CONTEXT_FIELD = '_scopeContext';
 * This requires a Context Manager that was wrapped with getWrappedContextManager.
 */
export function getScopesFromContext(context: Context): CurrentScopes | undefined {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/edge/index.ts` (`getScopesFromContext`)
 //
 // If you change how scopes are stored/read (key or retrieval), update that file too.
 return context.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/isSentryRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ import { spanHasAttributes } from './spanTypes';
 * @returns boolean
 */
export function isSentryRequestSpan(span: AbstractSpan): boolean {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts` (`isSentryRequestSpan`)
 //
 // If you change supported OTEL attribute keys or request detection logic, update that file too.
 if (!spanHasAttributes(span)) {
 return false;
 }
Expand Down

201 changes: 71 additions & 130 deletions
packages/vercel-edge/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,138 +1,79 @@
import replace from '@rollup/plugin-replace';
import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '@sentry-internal/rollup-utils';

const downlevelLogicalAssignmentsPlugin = {
 name: 'downlevel-logical-assignments',
 renderChunk(code) {
 // ES2021 logical assignment operators (`||=`, `&&=`, `??=`) are not allowed by our ES2020 compatibility check.
 // OTEL currently ships some of these, so we downlevel them in the final output.
 //
 // Note: This is intentionally conservative (only matches property access-like LHS) to avoid duplicating side effects.
 // IMPORTANT: Use regex literals (not `String.raw` + `RegExp(...)`) to avoid accidental double-escaping.
 let out = code;

 // ??=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\?\?=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} ?? ${right};`;
 });

 // ||=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\|\|=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} || ${right};`;
 });

 // &&=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*&&=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} && ${right};`;
 });

 return { code: out, map: null };
 },
};

const baseConfig = makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);

 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 });
 });
 });
 };
 };
};
`;
} else {
return null;
 }
`;
} else {
 return null;
}
 },
 },
 },
 downlevelLogicalAssignmentsPlugin,
 ],
 },
});

// `makeBaseNPMConfig` marks dependencies/peers as external by default.
// For Edge, we must ensure the OTEL SDK bits which reference `process.argv0` are bundled so our replace() plugin applies.
const baseExternal = baseConfig.external;
baseConfig.external = (source, importer, isResolved) => {
 // Never treat these as external - they need to be inlined so `process.argv0` can be replaced.
 if (
 source === '@opentelemetry/resources' ||
 source.startsWith('@opentelemetry/resources/') ||
 source === '@opentelemetry/sdk-trace-base' ||
 source.startsWith('@opentelemetry/sdk-trace-base/')
 ) {
 return false;
 }

 if (typeof baseExternal === 'function') {
 return baseExternal(source, importer, isResolved);
 }

 if (Array.isArray(baseExternal)) {
 return baseExternal.includes(source);
 }

 if (baseExternal instanceof RegExp) {
 return baseExternal.test(source);
 }

 return false;
};

export default makeNPMConfigVariants(baseConfig);
 ],
 },
 }),
);

32 changes: 0 additions & 32 deletions
packages/vercel-edge/test/build-artifacts.test.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
Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"#18768

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

 Closed

chargome
wants to merge
1
commit into

from

 Closed


Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"
#18768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


40 changes: 2 additions & 38 deletions
packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { SEMATTRS_HTTP_TARGET } from '@opentelemetry/semantic-conventions';
import {
 getClient,
 GLOBAL_OBJ,
 isSentryRequestUrl,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 type Span,
 type SpanAttributes,
} from '@sentry/core';
import { GLOBAL_OBJ, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, type Span, type SpanAttributes } from '@sentry/core';
import { isSentryRequestSpan } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';

Expand DownExpand Up@@ -42,36 +36,6 @@ export function dropMiddlewareTunnelRequests(span: Span, attrs: SpanAttributes |
 }
}

/**
 * Local copy of `@sentry/opentelemetry`'s `isSentryRequestSpan`, to avoid pulling the whole package into Edge bundles.
 */
function isSentryRequestSpan(span: Span): boolean {
 const attributes = spanToAttributes(span);
 if (!attributes) {
 return false;
 }

 const httpUrl = attributes['http.url'] || attributes['url.full'];
 if (!httpUrl) {
 return false;
 }

 return isSentryRequestUrl(httpUrl.toString(), getClient());
}

function spanToAttributes(span: Span): Record<string, unknown> | undefined {
 // OTEL spans expose attributes in different shapes depending on implementation.
 // We only need best-effort read access.
 type MaybeSpanAttributes = {
 attributes?: Record<string, unknown>;
 _attributes?: Record<string, unknown>;
 };

 const maybeSpan = span as unknown as MaybeSpanAttributes;
 const attrs = maybeSpan.attributes || maybeSpan._attributes;
 return attrs;
}

/**
 * Checks if a span's HTTP target matches the tunnel route.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context, createContextKey } from '@opentelemetry/api';
import { context } from '@opentelemetry/api';
import {
 applySdkMetadata,
 type EventProcessor,
Expand All@@ -12,14 +12,14 @@ import {
 getRootSpan,
 GLOBAL_OBJ,
 registerSpanErrorInstrumentation,
 type Scope,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 setCapturedScopesOnSpan,
 spanToJSON,
 stripUrlQueryAndFragment,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
Expand All@@ -42,32 +42,6 @@ export { wrapApiHandlerWithSentry } from './wrapApiHandlerWithSentry';

export type EdgeOptions = VercelEdgeOptions;

type CurrentScopes = {
 scope: Scope;
 isolationScope: Scope;
};

// This key must match `@sentry/opentelemetry`'s `SENTRY_SCOPES_CONTEXT_KEY`.
// We duplicate it here so the Edge bundle does not need to import the full `@sentry/opentelemetry` package.
const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

type ContextWithGetValue = {
 getValue(key: unknown): unknown;
};

function getScopesFromContext(otelContext: unknown): CurrentScopes | undefined {
 if (!otelContext || typeof otelContext !== 'object') {
 return undefined;
 }

 const maybeContext = otelContext as Partial<ContextWithGetValue>;
 if (typeof maybeContext.getValue !== 'function') {
 return undefined;
 }

 return maybeContext.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 _sentryRewriteFramesDistDir?: string;
 _sentryRelease?: string;
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ export const SENTRY_TRACE_STATE_URL = 'sentry.url';
export const SENTRY_TRACE_STATE_SAMPLE_RAND = 'sentry.sample_rand';
export const SENTRY_TRACE_STATE_SAMPLE_RATE = 'sentry.sample_rate';

// NOTE: `@sentry/nextjs` has a local copy of this context key for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`SENTRY_SCOPES_CONTEXT_KEY`)
//
// If you change the key name passed to `createContextKey(...)`, update that file too.
export const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

export const SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY = createContextKey('sentry_fork_isolation_scope');
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/contextData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,6 @@ const SCOPE_CONTEXT_FIELD = '_scopeContext';
 * This requires a Context Manager that was wrapped with getWrappedContextManager.
 */
export function getScopesFromContext(context: Context): CurrentScopes | undefined {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/edge/index.ts` (`getScopesFromContext`)
 //
 // If you change how scopes are stored/read (key or retrieval), update that file too.
 return context.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/isSentryRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ import { spanHasAttributes } from './spanTypes';
 * @returns boolean
 */
export function isSentryRequestSpan(span: AbstractSpan): boolean {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts` (`isSentryRequestSpan`)
 //
 // If you change supported OTEL attribute keys or request detection logic, update that file too.
 if (!spanHasAttributes(span)) {
 return false;
 }
Expand Down

201 changes: 71 additions & 130 deletions
packages/vercel-edge/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,138 +1,79 @@
import replace from '@rollup/plugin-replace';
import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '@sentry-internal/rollup-utils';

const downlevelLogicalAssignmentsPlugin = {
 name: 'downlevel-logical-assignments',
 renderChunk(code) {
 // ES2021 logical assignment operators (`||=`, `&&=`, `??=`) are not allowed by our ES2020 compatibility check.
 // OTEL currently ships some of these, so we downlevel them in the final output.
 //
 // Note: This is intentionally conservative (only matches property access-like LHS) to avoid duplicating side effects.
 // IMPORTANT: Use regex literals (not `String.raw` + `RegExp(...)`) to avoid accidental double-escaping.
 let out = code;

 // ??=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\?\?=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} ?? ${right};`;
 });

 // ||=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\|\|=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} || ${right};`;
 });

 // &&=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*&&=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} && ${right};`;
 });

 return { code: out, map: null };
 },
};

const baseConfig = makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);

 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 });
 });
 });
 };
 };
};
`;
} else {
return null;
 }
`;
} else {
 return null;
}
 },
 },
 },
 downlevelLogicalAssignmentsPlugin,
 ],
 },
});

// `makeBaseNPMConfig` marks dependencies/peers as external by default.
// For Edge, we must ensure the OTEL SDK bits which reference `process.argv0` are bundled so our replace() plugin applies.
const baseExternal = baseConfig.external;
baseConfig.external = (source, importer, isResolved) => {
 // Never treat these as external - they need to be inlined so `process.argv0` can be replaced.
 if (
 source === '@opentelemetry/resources' ||
 source.startsWith('@opentelemetry/resources/') ||
 source === '@opentelemetry/sdk-trace-base' ||
 source.startsWith('@opentelemetry/sdk-trace-base/')
 ) {
 return false;
 }

 if (typeof baseExternal === 'function') {
 return baseExternal(source, importer, isResolved);
 }

 if (Array.isArray(baseExternal)) {
 return baseExternal.includes(source);
 }

 if (baseExternal instanceof RegExp) {
 return baseExternal.test(source);
 }

 return false;
};

export default makeNPMConfigVariants(baseConfig);
 ],
 },
 }),
);

32 changes: 0 additions & 32 deletions
packages/vercel-edge/test/build-artifacts.test.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
Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"#18768

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

 Closed

chargome
wants to merge
1
commit into

from

 Closed


Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"
#18768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


40 changes: 2 additions & 38 deletions
packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { SEMATTRS_HTTP_TARGET } from '@opentelemetry/semantic-conventions';
import {
 getClient,
 GLOBAL_OBJ,
 isSentryRequestUrl,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 type Span,
 type SpanAttributes,
} from '@sentry/core';
import { GLOBAL_OBJ, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, type Span, type SpanAttributes } from '@sentry/core';
import { isSentryRequestSpan } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';

Expand DownExpand Up@@ -42,36 +36,6 @@ export function dropMiddlewareTunnelRequests(span: Span, attrs: SpanAttributes |
 }
}

/**
 * Local copy of `@sentry/opentelemetry`'s `isSentryRequestSpan`, to avoid pulling the whole package into Edge bundles.
 */
function isSentryRequestSpan(span: Span): boolean {
 const attributes = spanToAttributes(span);
 if (!attributes) {
 return false;
 }

 const httpUrl = attributes['http.url'] || attributes['url.full'];
 if (!httpUrl) {
 return false;
 }

 return isSentryRequestUrl(httpUrl.toString(), getClient());
}

function spanToAttributes(span: Span): Record<string, unknown> | undefined {
 // OTEL spans expose attributes in different shapes depending on implementation.
 // We only need best-effort read access.
 type MaybeSpanAttributes = {
 attributes?: Record<string, unknown>;
 _attributes?: Record<string, unknown>;
 };

 const maybeSpan = span as unknown as MaybeSpanAttributes;
 const attrs = maybeSpan.attributes || maybeSpan._attributes;
 return attrs;
}

/**
 * Checks if a span's HTTP target matches the tunnel route.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context, createContextKey } from '@opentelemetry/api';
import { context } from '@opentelemetry/api';
import {
 applySdkMetadata,
 type EventProcessor,
Expand All@@ -12,14 +12,14 @@ import {
 getRootSpan,
 GLOBAL_OBJ,
 registerSpanErrorInstrumentation,
 type Scope,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 setCapturedScopesOnSpan,
 spanToJSON,
 stripUrlQueryAndFragment,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
Expand All@@ -42,32 +42,6 @@ export { wrapApiHandlerWithSentry } from './wrapApiHandlerWithSentry';

export type EdgeOptions = VercelEdgeOptions;

type CurrentScopes = {
 scope: Scope;
 isolationScope: Scope;
};

// This key must match `@sentry/opentelemetry`'s `SENTRY_SCOPES_CONTEXT_KEY`.
// We duplicate it here so the Edge bundle does not need to import the full `@sentry/opentelemetry` package.
const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

type ContextWithGetValue = {
 getValue(key: unknown): unknown;
};

function getScopesFromContext(otelContext: unknown): CurrentScopes | undefined {
 if (!otelContext || typeof otelContext !== 'object') {
 return undefined;
 }

 const maybeContext = otelContext as Partial<ContextWithGetValue>;
 if (typeof maybeContext.getValue !== 'function') {
 return undefined;
 }

 return maybeContext.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 _sentryRewriteFramesDistDir?: string;
 _sentryRelease?: string;
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ export const SENTRY_TRACE_STATE_URL = 'sentry.url';
export const SENTRY_TRACE_STATE_SAMPLE_RAND = 'sentry.sample_rand';
export const SENTRY_TRACE_STATE_SAMPLE_RATE = 'sentry.sample_rate';

// NOTE: `@sentry/nextjs` has a local copy of this context key for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`SENTRY_SCOPES_CONTEXT_KEY`)
//
// If you change the key name passed to `createContextKey(...)`, update that file too.
export const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

export const SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY = createContextKey('sentry_fork_isolation_scope');
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/contextData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,6 @@ const SCOPE_CONTEXT_FIELD = '_scopeContext';
 * This requires a Context Manager that was wrapped with getWrappedContextManager.
 */
export function getScopesFromContext(context: Context): CurrentScopes | undefined {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/edge/index.ts` (`getScopesFromContext`)
 //
 // If you change how scopes are stored/read (key or retrieval), update that file too.
 return context.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/isSentryRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ import { spanHasAttributes } from './spanTypes';
 * @returns boolean
 */
export function isSentryRequestSpan(span: AbstractSpan): boolean {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts` (`isSentryRequestSpan`)
 //
 // If you change supported OTEL attribute keys or request detection logic, update that file too.
 if (!spanHasAttributes(span)) {
 return false;
 }
Expand Down

201 changes: 71 additions & 130 deletions
packages/vercel-edge/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,138 +1,79 @@
import replace from '@rollup/plugin-replace';
import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '@sentry-internal/rollup-utils';

const downlevelLogicalAssignmentsPlugin = {
 name: 'downlevel-logical-assignments',
 renderChunk(code) {
 // ES2021 logical assignment operators (`||=`, `&&=`, `??=`) are not allowed by our ES2020 compatibility check.
 // OTEL currently ships some of these, so we downlevel them in the final output.
 //
 // Note: This is intentionally conservative (only matches property access-like LHS) to avoid duplicating side effects.
 // IMPORTANT: Use regex literals (not `String.raw` + `RegExp(...)`) to avoid accidental double-escaping.
 let out = code;

 // ??=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\?\?=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} ?? ${right};`;
 });

 // ||=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\|\|=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} || ${right};`;
 });

 // &&=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*&&=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} && ${right};`;
 });

 return { code: out, map: null };
 },
};

const baseConfig = makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);

 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 });
 });
 });
 };
 };
};
`;
} else {
return null;
 }
`;
} else {
 return null;
}
 },
 },
 },
 downlevelLogicalAssignmentsPlugin,
 ],
 },
});

// `makeBaseNPMConfig` marks dependencies/peers as external by default.
// For Edge, we must ensure the OTEL SDK bits which reference `process.argv0` are bundled so our replace() plugin applies.
const baseExternal = baseConfig.external;
baseConfig.external = (source, importer, isResolved) => {
 // Never treat these as external - they need to be inlined so `process.argv0` can be replaced.
 if (
 source === '@opentelemetry/resources' ||
 source.startsWith('@opentelemetry/resources/') ||
 source === '@opentelemetry/sdk-trace-base' ||
 source.startsWith('@opentelemetry/sdk-trace-base/')
 ) {
 return false;
 }

 if (typeof baseExternal === 'function') {
 return baseExternal(source, importer, isResolved);
 }

 if (Array.isArray(baseExternal)) {
 return baseExternal.includes(source);
 }

 if (baseExternal instanceof RegExp) {
 return baseExternal.test(source);
 }

 return false;
};

export default makeNPMConfigVariants(baseConfig);
 ],
 },
 }),
);

32 changes: 0 additions & 32 deletions
packages/vercel-edge/test/build-artifacts.test.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
Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"#18768

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

 Closed

chargome
wants to merge
1
commit into

from

 Closed


Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"
#18768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


40 changes: 2 additions & 38 deletions
packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { SEMATTRS_HTTP_TARGET } from '@opentelemetry/semantic-conventions';
import {
 getClient,
 GLOBAL_OBJ,
 isSentryRequestUrl,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 type Span,
 type SpanAttributes,
} from '@sentry/core';
import { GLOBAL_OBJ, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, type Span, type SpanAttributes } from '@sentry/core';
import { isSentryRequestSpan } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';

Expand DownExpand Up@@ -42,36 +36,6 @@ export function dropMiddlewareTunnelRequests(span: Span, attrs: SpanAttributes |
 }
}

/**
 * Local copy of `@sentry/opentelemetry`'s `isSentryRequestSpan`, to avoid pulling the whole package into Edge bundles.
 */
function isSentryRequestSpan(span: Span): boolean {
 const attributes = spanToAttributes(span);
 if (!attributes) {
 return false;
 }

 const httpUrl = attributes['http.url'] || attributes['url.full'];
 if (!httpUrl) {
 return false;
 }

 return isSentryRequestUrl(httpUrl.toString(), getClient());
}

function spanToAttributes(span: Span): Record<string, unknown> | undefined {
 // OTEL spans expose attributes in different shapes depending on implementation.
 // We only need best-effort read access.
 type MaybeSpanAttributes = {
 attributes?: Record<string, unknown>;
 _attributes?: Record<string, unknown>;
 };

 const maybeSpan = span as unknown as MaybeSpanAttributes;
 const attrs = maybeSpan.attributes || maybeSpan._attributes;
 return attrs;
}

/**
 * Checks if a span's HTTP target matches the tunnel route.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context, createContextKey } from '@opentelemetry/api';
import { context } from '@opentelemetry/api';
import {
 applySdkMetadata,
 type EventProcessor,
Expand All@@ -12,14 +12,14 @@ import {
 getRootSpan,
 GLOBAL_OBJ,
 registerSpanErrorInstrumentation,
 type Scope,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 setCapturedScopesOnSpan,
 spanToJSON,
 stripUrlQueryAndFragment,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
Expand All@@ -42,32 +42,6 @@ export { wrapApiHandlerWithSentry } from './wrapApiHandlerWithSentry';

export type EdgeOptions = VercelEdgeOptions;

type CurrentScopes = {
 scope: Scope;
 isolationScope: Scope;
};

// This key must match `@sentry/opentelemetry`'s `SENTRY_SCOPES_CONTEXT_KEY`.
// We duplicate it here so the Edge bundle does not need to import the full `@sentry/opentelemetry` package.
const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

type ContextWithGetValue = {
 getValue(key: unknown): unknown;
};

function getScopesFromContext(otelContext: unknown): CurrentScopes | undefined {
 if (!otelContext || typeof otelContext !== 'object') {
 return undefined;
 }

 const maybeContext = otelContext as Partial<ContextWithGetValue>;
 if (typeof maybeContext.getValue !== 'function') {
 return undefined;
 }

 return maybeContext.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 _sentryRewriteFramesDistDir?: string;
 _sentryRelease?: string;
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ export const SENTRY_TRACE_STATE_URL = 'sentry.url';
export const SENTRY_TRACE_STATE_SAMPLE_RAND = 'sentry.sample_rand';
export const SENTRY_TRACE_STATE_SAMPLE_RATE = 'sentry.sample_rate';

// NOTE: `@sentry/nextjs` has a local copy of this context key for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`SENTRY_SCOPES_CONTEXT_KEY`)
//
// If you change the key name passed to `createContextKey(...)`, update that file too.
export const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

export const SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY = createContextKey('sentry_fork_isolation_scope');
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/contextData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,6 @@ const SCOPE_CONTEXT_FIELD = '_scopeContext';
 * This requires a Context Manager that was wrapped with getWrappedContextManager.
 */
export function getScopesFromContext(context: Context): CurrentScopes | undefined {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/edge/index.ts` (`getScopesFromContext`)
 //
 // If you change how scopes are stored/read (key or retrieval), update that file too.
 return context.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/isSentryRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ import { spanHasAttributes } from './spanTypes';
 * @returns boolean
 */
export function isSentryRequestSpan(span: AbstractSpan): boolean {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts` (`isSentryRequestSpan`)
 //
 // If you change supported OTEL attribute keys or request detection logic, update that file too.
 if (!spanHasAttributes(span)) {
 return false;
 }
Expand Down

201 changes: 71 additions & 130 deletions
packages/vercel-edge/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,138 +1,79 @@
import replace from '@rollup/plugin-replace';
import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '@sentry-internal/rollup-utils';

const downlevelLogicalAssignmentsPlugin = {
 name: 'downlevel-logical-assignments',
 renderChunk(code) {
 // ES2021 logical assignment operators (`||=`, `&&=`, `??=`) are not allowed by our ES2020 compatibility check.
 // OTEL currently ships some of these, so we downlevel them in the final output.
 //
 // Note: This is intentionally conservative (only matches property access-like LHS) to avoid duplicating side effects.
 // IMPORTANT: Use regex literals (not `String.raw` + `RegExp(...)`) to avoid accidental double-escaping.
 let out = code;

 // ??=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\?\?=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} ?? ${right};`;
 });

 // ||=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\|\|=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} || ${right};`;
 });

 // &&=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*&&=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} && ${right};`;
 });

 return { code: out, map: null };
 },
};

const baseConfig = makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);

 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 });
 });
 });
 };
 };
};
`;
} else {
return null;
 }
`;
} else {
 return null;
}
 },
 },
 },
 downlevelLogicalAssignmentsPlugin,
 ],
 },
});

// `makeBaseNPMConfig` marks dependencies/peers as external by default.
// For Edge, we must ensure the OTEL SDK bits which reference `process.argv0` are bundled so our replace() plugin applies.
const baseExternal = baseConfig.external;
baseConfig.external = (source, importer, isResolved) => {
 // Never treat these as external - they need to be inlined so `process.argv0` can be replaced.
 if (
 source === '@opentelemetry/resources' ||
 source.startsWith('@opentelemetry/resources/') ||
 source === '@opentelemetry/sdk-trace-base' ||
 source.startsWith('@opentelemetry/sdk-trace-base/')
 ) {
 return false;
 }

 if (typeof baseExternal === 'function') {
 return baseExternal(source, importer, isResolved);
 }

 if (Array.isArray(baseExternal)) {
 return baseExternal.includes(source);
 }

 if (baseExternal instanceof RegExp) {
 return baseExternal.test(source);
 }

 return false;
};

export default makeNPMConfigVariants(baseConfig);
 ],
 },
 }),
);

32 changes: 0 additions & 32 deletions
packages/vercel-edge/test/build-artifacts.test.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
Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"#18768

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

 Closed

chargome
wants to merge
1
commit into

from

 Closed


Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"
#18768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


40 changes: 2 additions & 38 deletions
packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { SEMATTRS_HTTP_TARGET } from '@opentelemetry/semantic-conventions';
import {
 getClient,
 GLOBAL_OBJ,
 isSentryRequestUrl,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 type Span,
 type SpanAttributes,
} from '@sentry/core';
import { GLOBAL_OBJ, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, type Span, type SpanAttributes } from '@sentry/core';
import { isSentryRequestSpan } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';

Expand DownExpand Up@@ -42,36 +36,6 @@ export function dropMiddlewareTunnelRequests(span: Span, attrs: SpanAttributes |
 }
}

/**
 * Local copy of `@sentry/opentelemetry`'s `isSentryRequestSpan`, to avoid pulling the whole package into Edge bundles.
 */
function isSentryRequestSpan(span: Span): boolean {
 const attributes = spanToAttributes(span);
 if (!attributes) {
 return false;
 }

 const httpUrl = attributes['http.url'] || attributes['url.full'];
 if (!httpUrl) {
 return false;
 }

 return isSentryRequestUrl(httpUrl.toString(), getClient());
}

function spanToAttributes(span: Span): Record<string, unknown> | undefined {
 // OTEL spans expose attributes in different shapes depending on implementation.
 // We only need best-effort read access.
 type MaybeSpanAttributes = {
 attributes?: Record<string, unknown>;
 _attributes?: Record<string, unknown>;
 };

 const maybeSpan = span as unknown as MaybeSpanAttributes;
 const attrs = maybeSpan.attributes || maybeSpan._attributes;
 return attrs;
}

/**
 * Checks if a span's HTTP target matches the tunnel route.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context, createContextKey } from '@opentelemetry/api';
import { context } from '@opentelemetry/api';
import {
 applySdkMetadata,
 type EventProcessor,
Expand All@@ -12,14 +12,14 @@ import {
 getRootSpan,
 GLOBAL_OBJ,
 registerSpanErrorInstrumentation,
 type Scope,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 setCapturedScopesOnSpan,
 spanToJSON,
 stripUrlQueryAndFragment,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
Expand All@@ -42,32 +42,6 @@ export { wrapApiHandlerWithSentry } from './wrapApiHandlerWithSentry';

export type EdgeOptions = VercelEdgeOptions;

type CurrentScopes = {
 scope: Scope;
 isolationScope: Scope;
};

// This key must match `@sentry/opentelemetry`'s `SENTRY_SCOPES_CONTEXT_KEY`.
// We duplicate it here so the Edge bundle does not need to import the full `@sentry/opentelemetry` package.
const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

type ContextWithGetValue = {
 getValue(key: unknown): unknown;
};

function getScopesFromContext(otelContext: unknown): CurrentScopes | undefined {
 if (!otelContext || typeof otelContext !== 'object') {
 return undefined;
 }

 const maybeContext = otelContext as Partial<ContextWithGetValue>;
 if (typeof maybeContext.getValue !== 'function') {
 return undefined;
 }

 return maybeContext.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 _sentryRewriteFramesDistDir?: string;
 _sentryRelease?: string;
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ export const SENTRY_TRACE_STATE_URL = 'sentry.url';
export const SENTRY_TRACE_STATE_SAMPLE_RAND = 'sentry.sample_rand';
export const SENTRY_TRACE_STATE_SAMPLE_RATE = 'sentry.sample_rate';

// NOTE: `@sentry/nextjs` has a local copy of this context key for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`SENTRY_SCOPES_CONTEXT_KEY`)
//
// If you change the key name passed to `createContextKey(...)`, update that file too.
export const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

export const SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY = createContextKey('sentry_fork_isolation_scope');
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/contextData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,6 @@ const SCOPE_CONTEXT_FIELD = '_scopeContext';
 * This requires a Context Manager that was wrapped with getWrappedContextManager.
 */
export function getScopesFromContext(context: Context): CurrentScopes | undefined {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/edge/index.ts` (`getScopesFromContext`)
 //
 // If you change how scopes are stored/read (key or retrieval), update that file too.
 return context.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/isSentryRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ import { spanHasAttributes } from './spanTypes';
 * @returns boolean
 */
export function isSentryRequestSpan(span: AbstractSpan): boolean {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts` (`isSentryRequestSpan`)
 //
 // If you change supported OTEL attribute keys or request detection logic, update that file too.
 if (!spanHasAttributes(span)) {
 return false;
 }
Expand Down

201 changes: 71 additions & 130 deletions
packages/vercel-edge/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,138 +1,79 @@
import replace from '@rollup/plugin-replace';
import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '@sentry-internal/rollup-utils';

const downlevelLogicalAssignmentsPlugin = {
 name: 'downlevel-logical-assignments',
 renderChunk(code) {
 // ES2021 logical assignment operators (`||=`, `&&=`, `??=`) are not allowed by our ES2020 compatibility check.
 // OTEL currently ships some of these, so we downlevel them in the final output.
 //
 // Note: This is intentionally conservative (only matches property access-like LHS) to avoid duplicating side effects.
 // IMPORTANT: Use regex literals (not `String.raw` + `RegExp(...)`) to avoid accidental double-escaping.
 let out = code;

 // ??=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\?\?=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} ?? ${right};`;
 });

 // ||=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\|\|=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} || ${right};`;
 });

 // &&=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*&&=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} && ${right};`;
 });

 return { code: out, map: null };
 },
};

const baseConfig = makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);

 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 });
 });
 });
 };
 };
};
`;
} else {
return null;
 }
`;
} else {
 return null;
}
 },
 },
 },
 downlevelLogicalAssignmentsPlugin,
 ],
 },
});

// `makeBaseNPMConfig` marks dependencies/peers as external by default.
// For Edge, we must ensure the OTEL SDK bits which reference `process.argv0` are bundled so our replace() plugin applies.
const baseExternal = baseConfig.external;
baseConfig.external = (source, importer, isResolved) => {
 // Never treat these as external - they need to be inlined so `process.argv0` can be replaced.
 if (
 source === '@opentelemetry/resources' ||
 source.startsWith('@opentelemetry/resources/') ||
 source === '@opentelemetry/sdk-trace-base' ||
 source.startsWith('@opentelemetry/sdk-trace-base/')
 ) {
 return false;
 }

 if (typeof baseExternal === 'function') {
 return baseExternal(source, importer, isResolved);
 }

 if (Array.isArray(baseExternal)) {
 return baseExternal.includes(source);
 }

 if (baseExternal instanceof RegExp) {
 return baseExternal.test(source);
 }

 return false;
};

export default makeNPMConfigVariants(baseConfig);
 ],
 },
 }),
);

32 changes: 0 additions & 32 deletions
packages/vercel-edge/test/build-artifacts.test.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
Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"#18768

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

 Closed

chargome
wants to merge
1
commit into

from

 Closed


Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"
#18768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


40 changes: 2 additions & 38 deletions
packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { SEMATTRS_HTTP_TARGET } from '@opentelemetry/semantic-conventions';
import {
 getClient,
 GLOBAL_OBJ,
 isSentryRequestUrl,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 type Span,
 type SpanAttributes,
} from '@sentry/core';
import { GLOBAL_OBJ, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, type Span, type SpanAttributes } from '@sentry/core';
import { isSentryRequestSpan } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';

Expand DownExpand Up@@ -42,36 +36,6 @@ export function dropMiddlewareTunnelRequests(span: Span, attrs: SpanAttributes |
 }
}

/**
 * Local copy of `@sentry/opentelemetry`'s `isSentryRequestSpan`, to avoid pulling the whole package into Edge bundles.
 */
function isSentryRequestSpan(span: Span): boolean {
 const attributes = spanToAttributes(span);
 if (!attributes) {
 return false;
 }

 const httpUrl = attributes['http.url'] || attributes['url.full'];
 if (!httpUrl) {
 return false;
 }

 return isSentryRequestUrl(httpUrl.toString(), getClient());
}

function spanToAttributes(span: Span): Record<string, unknown> | undefined {
 // OTEL spans expose attributes in different shapes depending on implementation.
 // We only need best-effort read access.
 type MaybeSpanAttributes = {
 attributes?: Record<string, unknown>;
 _attributes?: Record<string, unknown>;
 };

 const maybeSpan = span as unknown as MaybeSpanAttributes;
 const attrs = maybeSpan.attributes || maybeSpan._attributes;
 return attrs;
}

/**
 * Checks if a span's HTTP target matches the tunnel route.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context, createContextKey } from '@opentelemetry/api';
import { context } from '@opentelemetry/api';
import {
 applySdkMetadata,
 type EventProcessor,
Expand All@@ -12,14 +12,14 @@ import {
 getRootSpan,
 GLOBAL_OBJ,
 registerSpanErrorInstrumentation,
 type Scope,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 setCapturedScopesOnSpan,
 spanToJSON,
 stripUrlQueryAndFragment,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
Expand All@@ -42,32 +42,6 @@ export { wrapApiHandlerWithSentry } from './wrapApiHandlerWithSentry';

export type EdgeOptions = VercelEdgeOptions;

type CurrentScopes = {
 scope: Scope;
 isolationScope: Scope;
};

// This key must match `@sentry/opentelemetry`'s `SENTRY_SCOPES_CONTEXT_KEY`.
// We duplicate it here so the Edge bundle does not need to import the full `@sentry/opentelemetry` package.
const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

type ContextWithGetValue = {
 getValue(key: unknown): unknown;
};

function getScopesFromContext(otelContext: unknown): CurrentScopes | undefined {
 if (!otelContext || typeof otelContext !== 'object') {
 return undefined;
 }

 const maybeContext = otelContext as Partial<ContextWithGetValue>;
 if (typeof maybeContext.getValue !== 'function') {
 return undefined;
 }

 return maybeContext.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 _sentryRewriteFramesDistDir?: string;
 _sentryRelease?: string;
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ export const SENTRY_TRACE_STATE_URL = 'sentry.url';
export const SENTRY_TRACE_STATE_SAMPLE_RAND = 'sentry.sample_rand';
export const SENTRY_TRACE_STATE_SAMPLE_RATE = 'sentry.sample_rate';

// NOTE: `@sentry/nextjs` has a local copy of this context key for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`SENTRY_SCOPES_CONTEXT_KEY`)
//
// If you change the key name passed to `createContextKey(...)`, update that file too.
export const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

export const SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY = createContextKey('sentry_fork_isolation_scope');
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/contextData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,6 @@ const SCOPE_CONTEXT_FIELD = '_scopeContext';
 * This requires a Context Manager that was wrapped with getWrappedContextManager.
 */
export function getScopesFromContext(context: Context): CurrentScopes | undefined {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/edge/index.ts` (`getScopesFromContext`)
 //
 // If you change how scopes are stored/read (key or retrieval), update that file too.
 return context.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/isSentryRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ import { spanHasAttributes } from './spanTypes';
 * @returns boolean
 */
export function isSentryRequestSpan(span: AbstractSpan): boolean {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts` (`isSentryRequestSpan`)
 //
 // If you change supported OTEL attribute keys or request detection logic, update that file too.
 if (!spanHasAttributes(span)) {
 return false;
 }
Expand Down

201 changes: 71 additions & 130 deletions
packages/vercel-edge/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,138 +1,79 @@
import replace from '@rollup/plugin-replace';
import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '@sentry-internal/rollup-utils';

const downlevelLogicalAssignmentsPlugin = {
 name: 'downlevel-logical-assignments',
 renderChunk(code) {
 // ES2021 logical assignment operators (`||=`, `&&=`, `??=`) are not allowed by our ES2020 compatibility check.
 // OTEL currently ships some of these, so we downlevel them in the final output.
 //
 // Note: This is intentionally conservative (only matches property access-like LHS) to avoid duplicating side effects.
 // IMPORTANT: Use regex literals (not `String.raw` + `RegExp(...)`) to avoid accidental double-escaping.
 let out = code;

 // ??=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\?\?=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} ?? ${right};`;
 });

 // ||=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\|\|=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} || ${right};`;
 });

 // &&=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*&&=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} && ${right};`;
 });

 return { code: out, map: null };
 },
};

const baseConfig = makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);

 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 });
 });
 });
 };
 };
};
`;
} else {
return null;
 }
`;
} else {
 return null;
}
 },
 },
 },
 downlevelLogicalAssignmentsPlugin,
 ],
 },
});

// `makeBaseNPMConfig` marks dependencies/peers as external by default.
// For Edge, we must ensure the OTEL SDK bits which reference `process.argv0` are bundled so our replace() plugin applies.
const baseExternal = baseConfig.external;
baseConfig.external = (source, importer, isResolved) => {
 // Never treat these as external - they need to be inlined so `process.argv0` can be replaced.
 if (
 source === '@opentelemetry/resources' ||
 source.startsWith('@opentelemetry/resources/') ||
 source === '@opentelemetry/sdk-trace-base' ||
 source.startsWith('@opentelemetry/sdk-trace-base/')
 ) {
 return false;
 }

 if (typeof baseExternal === 'function') {
 return baseExternal(source, importer, isResolved);
 }

 if (Array.isArray(baseExternal)) {
 return baseExternal.includes(source);
 }

 if (baseExternal instanceof RegExp) {
 return baseExternal.test(source);
 }

 return false;
};

export default makeNPMConfigVariants(baseConfig);
 ],
 },
 }),
);

32 changes: 0 additions & 32 deletions
packages/vercel-edge/test/build-artifacts.test.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
Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"#18768

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

 Closed

chargome
wants to merge
1
commit into

from

 Closed


Revert "fix(nextjs): Avoid Edge build warning from OpenTelemetry process.argv0"
#18768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


40 changes: 2 additions & 38 deletions
packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { SEMATTRS_HTTP_TARGET } from '@opentelemetry/semantic-conventions';
import {
 getClient,
 GLOBAL_OBJ,
 isSentryRequestUrl,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 type Span,
 type SpanAttributes,
} from '@sentry/core';
import { GLOBAL_OBJ, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, type Span, type SpanAttributes } from '@sentry/core';
import { isSentryRequestSpan } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';

Expand DownExpand Up@@ -42,36 +36,6 @@ export function dropMiddlewareTunnelRequests(span: Span, attrs: SpanAttributes |
 }
}

/**
 * Local copy of `@sentry/opentelemetry`'s `isSentryRequestSpan`, to avoid pulling the whole package into Edge bundles.
 */
function isSentryRequestSpan(span: Span): boolean {
 const attributes = spanToAttributes(span);
 if (!attributes) {
 return false;
 }

 const httpUrl = attributes['http.url'] || attributes['url.full'];
 if (!httpUrl) {
 return false;
 }

 return isSentryRequestUrl(httpUrl.toString(), getClient());
}

function spanToAttributes(span: Span): Record<string, unknown> | undefined {
 // OTEL spans expose attributes in different shapes depending on implementation.
 // We only need best-effort read access.
 type MaybeSpanAttributes = {
 attributes?: Record<string, unknown>;
 _attributes?: Record<string, unknown>;
 };

 const maybeSpan = span as unknown as MaybeSpanAttributes;
 const attrs = maybeSpan.attributes || maybeSpan._attributes;
 return attrs;
}

/**
 * Checks if a span's HTTP target matches the tunnel route.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context, createContextKey } from '@opentelemetry/api';
import { context } from '@opentelemetry/api';
import {
 applySdkMetadata,
 type EventProcessor,
Expand All@@ -12,14 +12,14 @@ import {
 getRootSpan,
 GLOBAL_OBJ,
 registerSpanErrorInstrumentation,
 type Scope,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 setCapturedScopesOnSpan,
 spanToJSON,
 stripUrlQueryAndFragment,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
Expand All@@ -42,32 +42,6 @@ export { wrapApiHandlerWithSentry } from './wrapApiHandlerWithSentry';

export type EdgeOptions = VercelEdgeOptions;

type CurrentScopes = {
 scope: Scope;
 isolationScope: Scope;
};

// This key must match `@sentry/opentelemetry`'s `SENTRY_SCOPES_CONTEXT_KEY`.
// We duplicate it here so the Edge bundle does not need to import the full `@sentry/opentelemetry` package.
const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

type ContextWithGetValue = {
 getValue(key: unknown): unknown;
};

function getScopesFromContext(otelContext: unknown): CurrentScopes | undefined {
 if (!otelContext || typeof otelContext !== 'object') {
 return undefined;
 }

 const maybeContext = otelContext as Partial<ContextWithGetValue>;
 if (typeof maybeContext.getValue !== 'function') {
 return undefined;
 }

 return maybeContext.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

const globalWithInjectedValues = GLOBAL_OBJ as typeof GLOBAL_OBJ & {
 _sentryRewriteFramesDistDir?: string;
 _sentryRelease?: string;
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ export const SENTRY_TRACE_STATE_URL = 'sentry.url';
export const SENTRY_TRACE_STATE_SAMPLE_RAND = 'sentry.sample_rand';
export const SENTRY_TRACE_STATE_SAMPLE_RATE = 'sentry.sample_rate';

// NOTE: `@sentry/nextjs` has a local copy of this context key for Edge bundles:
// - `packages/nextjs/src/edge/index.ts` (`SENTRY_SCOPES_CONTEXT_KEY`)
//
// If you change the key name passed to `createContextKey(...)`, update that file too.
export const SENTRY_SCOPES_CONTEXT_KEY = createContextKey('sentry_scopes');

export const SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY = createContextKey('sentry_fork_isolation_scope');
Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/contextData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,6 @@ const SCOPE_CONTEXT_FIELD = '_scopeContext';
 * This requires a Context Manager that was wrapped with getWrappedContextManager.
 */
export function getScopesFromContext(context: Context): CurrentScopes | undefined {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/edge/index.ts` (`getScopesFromContext`)
 //
 // If you change how scopes are stored/read (key or retrieval), update that file too.
 return context.getValue(SENTRY_SCOPES_CONTEXT_KEY) as CurrentScopes | undefined;
}

Expand Down

4 changes: 0 additions & 4 deletions
packages/opentelemetry/src/utils/isSentryRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,10 +9,6 @@ import { spanHasAttributes } from './spanTypes';
 * @returns boolean
 */
export function isSentryRequestSpan(span: AbstractSpan): boolean {
 // NOTE: `@sentry/nextjs` has a local copy of this helper for Edge bundles:
 // - `packages/nextjs/src/common/utils/dropMiddlewareTunnelRequests.ts` (`isSentryRequestSpan`)
 //
 // If you change supported OTEL attribute keys or request detection logic, update that file too.
 if (!spanHasAttributes(span)) {
 return false;
 }
Expand Down

201 changes: 71 additions & 130 deletions
packages/vercel-edge/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,138 +1,79 @@
import replace from '@rollup/plugin-replace';
import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '@sentry-internal/rollup-utils';

const downlevelLogicalAssignmentsPlugin = {
 name: 'downlevel-logical-assignments',
 renderChunk(code) {
 // ES2021 logical assignment operators (`||=`, `&&=`, `??=`) are not allowed by our ES2020 compatibility check.
 // OTEL currently ships some of these, so we downlevel them in the final output.
 //
 // Note: This is intentionally conservative (only matches property access-like LHS) to avoid duplicating side effects.
 // IMPORTANT: Use regex literals (not `String.raw` + `RegExp(...)`) to avoid accidental double-escaping.
 let out = code;

 // ??=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\?\?=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} ?? ${right};`;
 });

 // ||=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*\|\|=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} || ${right};`;
 });

 // &&=
 out = out.replace(/([A-Za-z_$][\w$]*(?:\[[^\]]+\]|\.[A-Za-z_$][\w$]*)+)\s*&&=\s*([^;]+);/g, (_m, left, right) => {
 return `${left} = ${left} && ${right};`;
 });

 return { code: out, map: null };
 },
};

const baseConfig = makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts'],
 bundledBuiltins: ['perf_hooks', 'util'],
 packageSpecificConfig: {
 context: 'globalThis',
 output: {
 preserveModules: false,
 },
 plugins: [
 plugins.makeCommonJSPlugin({ transformMixedEsModules: true }), // Needed because various modules in the OTEL toolchain use CJS (require-in-the-middle, shimmer, etc..)
 plugins.makeJsonPlugin(), // Needed because `require-in-the-middle` imports json via require
 replace({
 preventAssignment: true,
 values: {
 'process.argv0': JSON.stringify(''), // needed because otel relies on process.argv0 for the default service name, but that api is not available in the edge runtime.
 },
 }),
 {
 // This plugin is needed because otel imports `performance` from `perf_hooks` and also uses it via the `performance` global.
 // It also imports `inspect` and `promisify` from node's `util` which are not available in the edge runtime so we need to define a polyfill.
 // Both of these APIs are not available in the edge runtime so we need to define a polyfill.
 // Vercel does something similar in the `@vercel/otel` package: https://github.com/vercel/otel/blob/087601ae585cb116bb2b46c211d014520de76c71/packages/otel/build.ts#L62
 name: 'edge-runtime-polyfills',
 banner: `
 {
 if (globalThis.performance === undefined) {
 globalThis.performance = {
 timeOrigin: 0,
 now: () => Date.now()
 };
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);
 }
 `,
 resolveId: source => {
 if (source === 'perf_hooks') {
 return '\0perf_hooks_sentry_shim';
 } else if (source === 'util') {
 return '\0util_sentry_shim';
 } else {
 return null;
 }
 },
 load: id => {
 if (id === '\0perf_hooks_sentry_shim') {
 return `
 export const performance = {
 timeOrigin: 0,
 now: () => Date.now()
 }
 `;
 } else if (id === '\0util_sentry_shim') {
 return `
 export const inspect = (object) =>
 JSON.stringify(object, null, 2);

 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 export const promisify = (fn) => {
 return (...args) => {
 return new Promise((resolve, reject) => {
 fn(...args, (err, result) => {
 if (err) reject(err);
 else resolve(result);
 });
 });
 });
 };
 };
};
`;
} else {
return null;
 }
`;
} else {
 return null;
}
 },
 },
 },
 downlevelLogicalAssignmentsPlugin,
 ],
 },
});

// `makeBaseNPMConfig` marks dependencies/peers as external by default.
// For Edge, we must ensure the OTEL SDK bits which reference `process.argv0` are bundled so our replace() plugin applies.
const baseExternal = baseConfig.external;
baseConfig.external = (source, importer, isResolved) => {
 // Never treat these as external - they need to be inlined so `process.argv0` can be replaced.
 if (
 source === '@opentelemetry/resources' ||
 source.startsWith('@opentelemetry/resources/') ||
 source === '@opentelemetry/sdk-trace-base' ||
 source.startsWith('@opentelemetry/sdk-trace-base/')
 ) {
 return false;
 }

 if (typeof baseExternal === 'function') {
 return baseExternal(source, importer, isResolved);
 }

 if (Array.isArray(baseExternal)) {
 return baseExternal.includes(source);
 }

 if (baseExternal instanceof RegExp) {
 return baseExternal.test(source);
 }

 return false;
};

export default makeNPMConfigVariants(baseConfig);
 ],
 },
 }),
);

32 changes: 0 additions & 32 deletions
packages/vercel-edge/test/build-artifacts.test.ts

View file


Open in desktop


This file was deleted.

Loading