feat: Add support for SENTRY_SPOTLIGHT env var in Node#13325

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
Lms24 merged 10 commits into from
Aug 13, 2024
Merged

feat: Add support for SENTRY_SPOTLIGHT env var in Node #13325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cf04993
feat: Add support for SENTRY_SPOTLIGHT env var in Node
Aug 12, 2024
6b973cd
Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT
BYK Aug 12, 2024
f08ff0d
pull out into helper
Aug 13, 2024
1310252
Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT
BYK Aug 13, 2024
67bd976
forgot strict mode
Aug 13, 2024
32c89cb
fix logic error
Aug 13, 2024
ed51040
add tests
Aug 13, 2024
1d9c633
Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT
BYK Aug 13, 2024
7dcaa82
fix tests & add undefined case
Aug 13, 2024
3a674c2
Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT
BYK Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vscode/settings.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,5 +42,5 @@
"[typescript]": {
"editor.defaultFormatter": "biomejs.biome"
},
"cSpell.words": ["arrayify"]
"cSpell.words": ["arrayify", "OTEL"]
}
7 changes: 4 additions & 3 deletions packages/node/src/preload.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { preloadOpenTelemetry } from './sdk/initOtel';
import { envToBool } from './utils/envToBool';

const debug = !!process.env.SENTRY_DEBUG;
const debug = envToBool(process.env.SENTRY_DEBUG);
const integrationsStr = process.env.SENTRY_PRELOAD_INTEGRATIONS;

const integrations = integrationsStr ? integrationsStr.split(',').map(integration => integration.trim()) : undefined;

/**
* The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL instrumentation,
* without initializing the Sentry SDK.
* The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL
* instrumentation, without initializing the Sentry SDK.
*
* This is useful if you cannot initialize the SDK immediately, but still want to preload the instrumentation,
* e.g. if you have to load the DSN from somewhere else.
Expand Down
13 changes: 11 additions & 2 deletions packages/node/src/sdk/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { envToBool } from '../utils/envToBool';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
Expand DownExpand Up@@ -221,6 +222,15 @@ function getClientOptions(
? true
: options.autoSessionTracking;

if (options.spotlight == null) {
const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
if (spotlightEnv == null) {
options.spotlight = process.env.SENTRY_SPOTLIGHT;
} else {
options.spotlight = spotlightEnv;
}
Comment thread
BYK marked this conversation as resolved.
}

const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);

const baseOptions = dropUndefinedKeys({
Expand DownExpand Up@@ -292,8 +302,7 @@ function getTracesSampleRate(tracesSampleRate: NodeOptions['tracesSampleRate']):
* for more details.
*/
function updateScopeFromEnvVariables(): void {
const sentryUseEnvironment = (process.env.SENTRY_USE_ENVIRONMENT || '').toLowerCase();
if (!['false', 'n', 'no', 'off', '0'].includes(sentryUseEnvironment)) {
if (envToBool(process.env.SENTRY_USE_ENVIRONMENT) !== false) {
const sentryTraceEnv = process.env.SENTRY_TRACE;
const baggageEnv = process.env.SENTRY_BAGGAGE;
const propagationContext = propagationContextFromHeaders(sentryTraceEnv, baggageEnv);
Expand Down
38 changes: 38 additions & 0 deletions packages/node/src/utils/envToBool.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
export const FALSY_ENV_VALUES = new Set(['false', 'f', 'n', 'no', 'off', '0']);
export const TRUTHY_ENV_VALUES = new Set(['true', 't', 'y', 'yes', 'on', '1']);

export type StrictBoolCast = {
strict: true;
};

export type LooseBoolCast = {
strict?: false;
};

export type BoolCastOptions = StrictBoolCast | LooseBoolCast;

export function envToBool(value: unknown, options?: LooseBoolCast): boolean;
export function envToBool(value: unknown, options: StrictBoolCast): boolean | null;
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null;
/**
* A helper function which casts an ENV variable value to `true` or `false` using the constants defined above.
* In strict mode, it may return `null` if the value doesn't match any of the predefined values.
*
* @param value The value of the env variable
* @param options -- Only has `strict` key for now, which requires a strict match for `true` in TRUTHY_ENV_VALUES
* @returns true/false if the lowercase value matches the predefined values above. If not, null in strict mode,
* and Boolean(value) in loose mode.
*/
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null {
Comment thread
BYK marked this conversation as resolved.
const normalized = String(value).toLowerCase();

if (FALSY_ENV_VALUES.has(normalized)) {
return false;
}

if (TRUTHY_ENV_VALUES.has(normalized)) {
return true;
}

return options && options.strict ? null : Boolean(value);
}
66 changes: 66 additions & 0 deletions packages/node/test/utils/envToBool.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { envToBool } from '../../src/utils/envToBool';

describe('envToBool', () => {
it.each([
['', true, null],
['', false, false],
['t', true, true],
['T', true, true],
['t', false, true],
['T', false, true],
['y', true, true],
['Y', true, true],
['y', false, true],
['Y', false, true],
['1', true, true],
['1', false, true],
['true', true, true],
['true', false, true],
['tRuE', true, true],
['tRuE', false, true],
['Yes', true, true],
['Yes', false, true],
['yes', true, true],
['yes', false, true],
['yEs', true, true],
['yEs', false, true],
['On', true, true],
['On', false, true],
['on', true, true],
['on', false, true],
['oN', true, true],
['oN', false, true],
['f', true, false],
['f', false, false],
['n', true, false],
['N', true, false],
['n', false, false],
['N', false, false],
['0', true, false],
['0', false, false],
['false', true, false],
['false', false, false],
['false', true, false],
['false', false, false],
['FaLsE', true, false],
['FaLsE', false, false],
['No', true, false],
['No', false, false],
['no', true, false],
['no', false, false],
['nO', true, false],
['nO', false, false],
['Off', true, false],
['Off', false, false],
['off', true, false],
['off', false, false],
['oFf', true, false],
['oFf', false, false],
['xxx', true, null],
['xxx', false, true],
[undefined, false, false],
[undefined, true, null],
])('%s becomes (strict: %s): %s', (value, strict, expected) => {
expect(envToBool(value, { strict })).toBe(expected);
});
});
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: Add support for SENTRY_SPOTLIGHT env var in Node#13325

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 10 commits into

from

Aug 13, 2024
 Merged


feat: Add support for SENTRY_SPOTLIGHT env var in Node
#13325
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
cf04993

feat: Add support for SENTRY_SPOTLIGHT env var in Node

Aug 12, 2024
6b973cd

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 12, 2024
f08ff0d

pull out into helper

Aug 13, 2024
1310252

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
67bd976

forgot strict mode

Aug 13, 2024
32c89cb

fix logic error

Aug 13, 2024
ed51040

add tests

Aug 13, 2024
1d9c633

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
7dcaa82

fix tests & add undefined case

Aug 13, 2024
3a674c2

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,5 +42,5 @@
 "[typescript]": {
 "editor.defaultFormatter": "biomejs.biome"
 },
 "cSpell.words": ["arrayify"]
 "cSpell.words": ["arrayify", "OTEL"]
}

7 changes: 4 additions & 3 deletions
packages/node/src/preload.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { preloadOpenTelemetry } from './sdk/initOtel';
import { envToBool } from './utils/envToBool';

const debug = !!process.env.SENTRY_DEBUG;
const debug = envToBool(process.env.SENTRY_DEBUG);
const integrationsStr = process.env.SENTRY_PRELOAD_INTEGRATIONS;

const integrations = integrationsStr ? integrationsStr.split(',').map(integration => integration.trim()) : undefined;

/**
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL instrumentation,
 * without initializing the Sentry SDK.
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL
 * instrumentation, without initializing the Sentry SDK.
 *
 * This is useful if you cannot initialize the SDK immediately, but still want to preload the instrumentation,
 * e.g. if you have to load the DSN from somewhere else.
Expand Down

13 changes: 11 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { envToBool } from '../utils/envToBool';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
Expand DownExpand Up@@ -221,6 +222,15 @@ function getClientOptions(
 ? true
 : options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
 if (spotlightEnv == null) {
 options.spotlight = process.env.SENTRY_SPOTLIGHT;
 } else {
 options.spotlight = spotlightEnv;
 }
Comment thread
BYK marked this conversation as resolved.

 }

 const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);

 const baseOptions = dropUndefinedKeys({
Expand DownExpand Up@@ -292,8 +302,7 @@ function getTracesSampleRate(tracesSampleRate: NodeOptions['tracesSampleRate']):
 * for more details.
 */
function updateScopeFromEnvVariables(): void {
 const sentryUseEnvironment = (process.env.SENTRY_USE_ENVIRONMENT || '').toLowerCase();
 if (!['false', 'n', 'no', 'off', '0'].includes(sentryUseEnvironment)) {
 if (envToBool(process.env.SENTRY_USE_ENVIRONMENT) !== false) {
 const sentryTraceEnv = process.env.SENTRY_TRACE;
 const baggageEnv = process.env.SENTRY_BAGGAGE;
 const propagationContext = propagationContextFromHeaders(sentryTraceEnv, baggageEnv);
Expand Down

38 changes: 38 additions & 0 deletions
packages/node/src/utils/envToBool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
export const FALSY_ENV_VALUES = new Set(['false', 'f', 'n', 'no', 'off', '0']);
export const TRUTHY_ENV_VALUES = new Set(['true', 't', 'y', 'yes', 'on', '1']);

export type StrictBoolCast = {
 strict: true;
};

export type LooseBoolCast = {
 strict?: false;
};

export type BoolCastOptions = StrictBoolCast | LooseBoolCast;

export function envToBool(value: unknown, options?: LooseBoolCast): boolean;
export function envToBool(value: unknown, options: StrictBoolCast): boolean | null;
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null;
/**
 * A helper function which casts an ENV variable value to `true` or `false` using the constants defined above.
 * In strict mode, it may return `null` if the value doesn't match any of the predefined values.
 *
 * @param value The value of the env variable
 * @param options -- Only has `strict` key for now, which requires a strict match for `true` in TRUTHY_ENV_VALUES
 * @returns true/false if the lowercase value matches the predefined values above. If not, null in strict mode,
 * and Boolean(value) in loose mode.
 */
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null {
Comment thread
BYK marked this conversation as resolved.

 const normalized = String(value).toLowerCase();

 if (FALSY_ENV_VALUES.has(normalized)) {
 return false;
 }

 if (TRUTHY_ENV_VALUES.has(normalized)) {
 return true;
 }

 return options && options.strict ? null : Boolean(value);
}

66 changes: 66 additions & 0 deletions
packages/node/test/utils/envToBool.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { envToBool } from '../../src/utils/envToBool';

describe('envToBool', () => {
 it.each([
 ['', true, null],
 ['', false, false],
 ['t', true, true],
 ['T', true, true],
 ['t', false, true],
 ['T', false, true],
 ['y', true, true],
 ['Y', true, true],
 ['y', false, true],
 ['Y', false, true],
 ['1', true, true],
 ['1', false, true],
 ['true', true, true],
 ['true', false, true],
 ['tRuE', true, true],
 ['tRuE', false, true],
 ['Yes', true, true],
 ['Yes', false, true],
 ['yes', true, true],
 ['yes', false, true],
 ['yEs', true, true],
 ['yEs', false, true],
 ['On', true, true],
 ['On', false, true],
 ['on', true, true],
 ['on', false, true],
 ['oN', true, true],
 ['oN', false, true],
 ['f', true, false],
 ['f', false, false],
 ['n', true, false],
 ['N', true, false],
 ['n', false, false],
 ['N', false, false],
 ['0', true, false],
 ['0', false, false],
 ['false', true, false],
 ['false', false, false],
 ['false', true, false],
 ['false', false, false],
 ['FaLsE', true, false],
 ['FaLsE', false, false],
 ['No', true, false],
 ['No', false, false],
 ['no', true, false],
 ['no', false, false],
 ['nO', true, false],
 ['nO', false, false],
 ['Off', true, false],
 ['Off', false, false],
 ['off', true, false],
 ['off', false, false],
 ['oFf', true, false],
 ['oFf', false, false],
 ['xxx', true, null],
 ['xxx', false, true],
 [undefined, false, false],
 [undefined, true, null],
 ])('%s becomes (strict: %s): %s', (value, strict, expected) => {
 expect(envToBool(value, { strict })).toBe(expected);
 });
});

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

Skip to content
feat: Add support for SENTRY_SPOTLIGHT env var in Node#13325

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 10 commits into

from

Aug 13, 2024
 Merged


feat: Add support for SENTRY_SPOTLIGHT env var in Node
#13325
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
cf04993

feat: Add support for SENTRY_SPOTLIGHT env var in Node

Aug 12, 2024
6b973cd

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 12, 2024
f08ff0d

pull out into helper

Aug 13, 2024
1310252

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
67bd976

forgot strict mode

Aug 13, 2024
32c89cb

fix logic error

Aug 13, 2024
ed51040

add tests

Aug 13, 2024
1d9c633

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
7dcaa82

fix tests & add undefined case

Aug 13, 2024
3a674c2

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,5 +42,5 @@
 "[typescript]": {
 "editor.defaultFormatter": "biomejs.biome"
 },
 "cSpell.words": ["arrayify"]
 "cSpell.words": ["arrayify", "OTEL"]
}

7 changes: 4 additions & 3 deletions
packages/node/src/preload.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { preloadOpenTelemetry } from './sdk/initOtel';
import { envToBool } from './utils/envToBool';

const debug = !!process.env.SENTRY_DEBUG;
const debug = envToBool(process.env.SENTRY_DEBUG);
const integrationsStr = process.env.SENTRY_PRELOAD_INTEGRATIONS;

const integrations = integrationsStr ? integrationsStr.split(',').map(integration => integration.trim()) : undefined;

/**
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL instrumentation,
 * without initializing the Sentry SDK.
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL
 * instrumentation, without initializing the Sentry SDK.
 *
 * This is useful if you cannot initialize the SDK immediately, but still want to preload the instrumentation,
 * e.g. if you have to load the DSN from somewhere else.
Expand Down

13 changes: 11 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { envToBool } from '../utils/envToBool';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
Expand DownExpand Up@@ -221,6 +222,15 @@ function getClientOptions(
 ? true
 : options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
 if (spotlightEnv == null) {
 options.spotlight = process.env.SENTRY_SPOTLIGHT;
 } else {
 options.spotlight = spotlightEnv;
 }
Comment thread
BYK marked this conversation as resolved.

 }

 const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);

 const baseOptions = dropUndefinedKeys({
Expand DownExpand Up@@ -292,8 +302,7 @@ function getTracesSampleRate(tracesSampleRate: NodeOptions['tracesSampleRate']):
 * for more details.
 */
function updateScopeFromEnvVariables(): void {
 const sentryUseEnvironment = (process.env.SENTRY_USE_ENVIRONMENT || '').toLowerCase();
 if (!['false', 'n', 'no', 'off', '0'].includes(sentryUseEnvironment)) {
 if (envToBool(process.env.SENTRY_USE_ENVIRONMENT) !== false) {
 const sentryTraceEnv = process.env.SENTRY_TRACE;
 const baggageEnv = process.env.SENTRY_BAGGAGE;
 const propagationContext = propagationContextFromHeaders(sentryTraceEnv, baggageEnv);
Expand Down

38 changes: 38 additions & 0 deletions
packages/node/src/utils/envToBool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
export const FALSY_ENV_VALUES = new Set(['false', 'f', 'n', 'no', 'off', '0']);
export const TRUTHY_ENV_VALUES = new Set(['true', 't', 'y', 'yes', 'on', '1']);

export type StrictBoolCast = {
 strict: true;
};

export type LooseBoolCast = {
 strict?: false;
};

export type BoolCastOptions = StrictBoolCast | LooseBoolCast;

export function envToBool(value: unknown, options?: LooseBoolCast): boolean;
export function envToBool(value: unknown, options: StrictBoolCast): boolean | null;
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null;
/**
 * A helper function which casts an ENV variable value to `true` or `false` using the constants defined above.
 * In strict mode, it may return `null` if the value doesn't match any of the predefined values.
 *
 * @param value The value of the env variable
 * @param options -- Only has `strict` key for now, which requires a strict match for `true` in TRUTHY_ENV_VALUES
 * @returns true/false if the lowercase value matches the predefined values above. If not, null in strict mode,
 * and Boolean(value) in loose mode.
 */
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null {
Comment thread
BYK marked this conversation as resolved.

 const normalized = String(value).toLowerCase();

 if (FALSY_ENV_VALUES.has(normalized)) {
 return false;
 }

 if (TRUTHY_ENV_VALUES.has(normalized)) {
 return true;
 }

 return options && options.strict ? null : Boolean(value);
}

66 changes: 66 additions & 0 deletions
packages/node/test/utils/envToBool.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { envToBool } from '../../src/utils/envToBool';

describe('envToBool', () => {
 it.each([
 ['', true, null],
 ['', false, false],
 ['t', true, true],
 ['T', true, true],
 ['t', false, true],
 ['T', false, true],
 ['y', true, true],
 ['Y', true, true],
 ['y', false, true],
 ['Y', false, true],
 ['1', true, true],
 ['1', false, true],
 ['true', true, true],
 ['true', false, true],
 ['tRuE', true, true],
 ['tRuE', false, true],
 ['Yes', true, true],
 ['Yes', false, true],
 ['yes', true, true],
 ['yes', false, true],
 ['yEs', true, true],
 ['yEs', false, true],
 ['On', true, true],
 ['On', false, true],
 ['on', true, true],
 ['on', false, true],
 ['oN', true, true],
 ['oN', false, true],
 ['f', true, false],
 ['f', false, false],
 ['n', true, false],
 ['N', true, false],
 ['n', false, false],
 ['N', false, false],
 ['0', true, false],
 ['0', false, false],
 ['false', true, false],
 ['false', false, false],
 ['false', true, false],
 ['false', false, false],
 ['FaLsE', true, false],
 ['FaLsE', false, false],
 ['No', true, false],
 ['No', false, false],
 ['no', true, false],
 ['no', false, false],
 ['nO', true, false],
 ['nO', false, false],
 ['Off', true, false],
 ['Off', false, false],
 ['off', true, false],
 ['off', false, false],
 ['oFf', true, false],
 ['oFf', false, false],
 ['xxx', true, null],
 ['xxx', false, true],
 [undefined, false, false],
 [undefined, true, null],
 ])('%s becomes (strict: %s): %s', (value, strict, expected) => {
 expect(envToBool(value, { strict })).toBe(expected);
 });
});

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

Skip to content
feat: Add support for SENTRY_SPOTLIGHT env var in Node#13325

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 10 commits into

from

Aug 13, 2024
 Merged


feat: Add support for SENTRY_SPOTLIGHT env var in Node
#13325
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
cf04993

feat: Add support for SENTRY_SPOTLIGHT env var in Node

Aug 12, 2024
6b973cd

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 12, 2024
f08ff0d

pull out into helper

Aug 13, 2024
1310252

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
67bd976

forgot strict mode

Aug 13, 2024
32c89cb

fix logic error

Aug 13, 2024
ed51040

add tests

Aug 13, 2024
1d9c633

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
7dcaa82

fix tests & add undefined case

Aug 13, 2024
3a674c2

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,5 +42,5 @@
 "[typescript]": {
 "editor.defaultFormatter": "biomejs.biome"
 },
 "cSpell.words": ["arrayify"]
 "cSpell.words": ["arrayify", "OTEL"]
}

7 changes: 4 additions & 3 deletions
packages/node/src/preload.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { preloadOpenTelemetry } from './sdk/initOtel';
import { envToBool } from './utils/envToBool';

const debug = !!process.env.SENTRY_DEBUG;
const debug = envToBool(process.env.SENTRY_DEBUG);
const integrationsStr = process.env.SENTRY_PRELOAD_INTEGRATIONS;

const integrations = integrationsStr ? integrationsStr.split(',').map(integration => integration.trim()) : undefined;

/**
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL instrumentation,
 * without initializing the Sentry SDK.
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL
 * instrumentation, without initializing the Sentry SDK.
 *
 * This is useful if you cannot initialize the SDK immediately, but still want to preload the instrumentation,
 * e.g. if you have to load the DSN from somewhere else.
Expand Down

13 changes: 11 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { envToBool } from '../utils/envToBool';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
Expand DownExpand Up@@ -221,6 +222,15 @@ function getClientOptions(
 ? true
 : options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
 if (spotlightEnv == null) {
 options.spotlight = process.env.SENTRY_SPOTLIGHT;
 } else {
 options.spotlight = spotlightEnv;
 }
Comment thread
BYK marked this conversation as resolved.

 }

 const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);

 const baseOptions = dropUndefinedKeys({
Expand DownExpand Up@@ -292,8 +302,7 @@ function getTracesSampleRate(tracesSampleRate: NodeOptions['tracesSampleRate']):
 * for more details.
 */
function updateScopeFromEnvVariables(): void {
 const sentryUseEnvironment = (process.env.SENTRY_USE_ENVIRONMENT || '').toLowerCase();
 if (!['false', 'n', 'no', 'off', '0'].includes(sentryUseEnvironment)) {
 if (envToBool(process.env.SENTRY_USE_ENVIRONMENT) !== false) {
 const sentryTraceEnv = process.env.SENTRY_TRACE;
 const baggageEnv = process.env.SENTRY_BAGGAGE;
 const propagationContext = propagationContextFromHeaders(sentryTraceEnv, baggageEnv);
Expand Down

38 changes: 38 additions & 0 deletions
packages/node/src/utils/envToBool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
export const FALSY_ENV_VALUES = new Set(['false', 'f', 'n', 'no', 'off', '0']);
export const TRUTHY_ENV_VALUES = new Set(['true', 't', 'y', 'yes', 'on', '1']);

export type StrictBoolCast = {
 strict: true;
};

export type LooseBoolCast = {
 strict?: false;
};

export type BoolCastOptions = StrictBoolCast | LooseBoolCast;

export function envToBool(value: unknown, options?: LooseBoolCast): boolean;
export function envToBool(value: unknown, options: StrictBoolCast): boolean | null;
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null;
/**
 * A helper function which casts an ENV variable value to `true` or `false` using the constants defined above.
 * In strict mode, it may return `null` if the value doesn't match any of the predefined values.
 *
 * @param value The value of the env variable
 * @param options -- Only has `strict` key for now, which requires a strict match for `true` in TRUTHY_ENV_VALUES
 * @returns true/false if the lowercase value matches the predefined values above. If not, null in strict mode,
 * and Boolean(value) in loose mode.
 */
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null {
Comment thread
BYK marked this conversation as resolved.

 const normalized = String(value).toLowerCase();

 if (FALSY_ENV_VALUES.has(normalized)) {
 return false;
 }

 if (TRUTHY_ENV_VALUES.has(normalized)) {
 return true;
 }

 return options && options.strict ? null : Boolean(value);
}

66 changes: 66 additions & 0 deletions
packages/node/test/utils/envToBool.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { envToBool } from '../../src/utils/envToBool';

describe('envToBool', () => {
 it.each([
 ['', true, null],
 ['', false, false],
 ['t', true, true],
 ['T', true, true],
 ['t', false, true],
 ['T', false, true],
 ['y', true, true],
 ['Y', true, true],
 ['y', false, true],
 ['Y', false, true],
 ['1', true, true],
 ['1', false, true],
 ['true', true, true],
 ['true', false, true],
 ['tRuE', true, true],
 ['tRuE', false, true],
 ['Yes', true, true],
 ['Yes', false, true],
 ['yes', true, true],
 ['yes', false, true],
 ['yEs', true, true],
 ['yEs', false, true],
 ['On', true, true],
 ['On', false, true],
 ['on', true, true],
 ['on', false, true],
 ['oN', true, true],
 ['oN', false, true],
 ['f', true, false],
 ['f', false, false],
 ['n', true, false],
 ['N', true, false],
 ['n', false, false],
 ['N', false, false],
 ['0', true, false],
 ['0', false, false],
 ['false', true, false],
 ['false', false, false],
 ['false', true, false],
 ['false', false, false],
 ['FaLsE', true, false],
 ['FaLsE', false, false],
 ['No', true, false],
 ['No', false, false],
 ['no', true, false],
 ['no', false, false],
 ['nO', true, false],
 ['nO', false, false],
 ['Off', true, false],
 ['Off', false, false],
 ['off', true, false],
 ['off', false, false],
 ['oFf', true, false],
 ['oFf', false, false],
 ['xxx', true, null],
 ['xxx', false, true],
 [undefined, false, false],
 [undefined, true, null],
 ])('%s becomes (strict: %s): %s', (value, strict, expected) => {
 expect(envToBool(value, { strict })).toBe(expected);
 });
});

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

Skip to content
feat: Add support for SENTRY_SPOTLIGHT env var in Node#13325

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 10 commits into

from

Aug 13, 2024
 Merged


feat: Add support for SENTRY_SPOTLIGHT env var in Node
#13325
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
cf04993

feat: Add support for SENTRY_SPOTLIGHT env var in Node

Aug 12, 2024
6b973cd

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 12, 2024
f08ff0d

pull out into helper

Aug 13, 2024
1310252

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
67bd976

forgot strict mode

Aug 13, 2024
32c89cb

fix logic error

Aug 13, 2024
ed51040

add tests

Aug 13, 2024
1d9c633

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
7dcaa82

fix tests & add undefined case

Aug 13, 2024
3a674c2

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,5 +42,5 @@
 "[typescript]": {
 "editor.defaultFormatter": "biomejs.biome"
 },
 "cSpell.words": ["arrayify"]
 "cSpell.words": ["arrayify", "OTEL"]
}

7 changes: 4 additions & 3 deletions
packages/node/src/preload.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { preloadOpenTelemetry } from './sdk/initOtel';
import { envToBool } from './utils/envToBool';

const debug = !!process.env.SENTRY_DEBUG;
const debug = envToBool(process.env.SENTRY_DEBUG);
const integrationsStr = process.env.SENTRY_PRELOAD_INTEGRATIONS;

const integrations = integrationsStr ? integrationsStr.split(',').map(integration => integration.trim()) : undefined;

/**
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL instrumentation,
 * without initializing the Sentry SDK.
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL
 * instrumentation, without initializing the Sentry SDK.
 *
 * This is useful if you cannot initialize the SDK immediately, but still want to preload the instrumentation,
 * e.g. if you have to load the DSN from somewhere else.
Expand Down

13 changes: 11 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { envToBool } from '../utils/envToBool';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
Expand DownExpand Up@@ -221,6 +222,15 @@ function getClientOptions(
 ? true
 : options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
 if (spotlightEnv == null) {
 options.spotlight = process.env.SENTRY_SPOTLIGHT;
 } else {
 options.spotlight = spotlightEnv;
 }
Comment thread
BYK marked this conversation as resolved.

 }

 const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);

 const baseOptions = dropUndefinedKeys({
Expand DownExpand Up@@ -292,8 +302,7 @@ function getTracesSampleRate(tracesSampleRate: NodeOptions['tracesSampleRate']):
 * for more details.
 */
function updateScopeFromEnvVariables(): void {
 const sentryUseEnvironment = (process.env.SENTRY_USE_ENVIRONMENT || '').toLowerCase();
 if (!['false', 'n', 'no', 'off', '0'].includes(sentryUseEnvironment)) {
 if (envToBool(process.env.SENTRY_USE_ENVIRONMENT) !== false) {
 const sentryTraceEnv = process.env.SENTRY_TRACE;
 const baggageEnv = process.env.SENTRY_BAGGAGE;
 const propagationContext = propagationContextFromHeaders(sentryTraceEnv, baggageEnv);
Expand Down

38 changes: 38 additions & 0 deletions
packages/node/src/utils/envToBool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
export const FALSY_ENV_VALUES = new Set(['false', 'f', 'n', 'no', 'off', '0']);
export const TRUTHY_ENV_VALUES = new Set(['true', 't', 'y', 'yes', 'on', '1']);

export type StrictBoolCast = {
 strict: true;
};

export type LooseBoolCast = {
 strict?: false;
};

export type BoolCastOptions = StrictBoolCast | LooseBoolCast;

export function envToBool(value: unknown, options?: LooseBoolCast): boolean;
export function envToBool(value: unknown, options: StrictBoolCast): boolean | null;
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null;
/**
 * A helper function which casts an ENV variable value to `true` or `false` using the constants defined above.
 * In strict mode, it may return `null` if the value doesn't match any of the predefined values.
 *
 * @param value The value of the env variable
 * @param options -- Only has `strict` key for now, which requires a strict match for `true` in TRUTHY_ENV_VALUES
 * @returns true/false if the lowercase value matches the predefined values above. If not, null in strict mode,
 * and Boolean(value) in loose mode.
 */
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null {
Comment thread
BYK marked this conversation as resolved.

 const normalized = String(value).toLowerCase();

 if (FALSY_ENV_VALUES.has(normalized)) {
 return false;
 }

 if (TRUTHY_ENV_VALUES.has(normalized)) {
 return true;
 }

 return options && options.strict ? null : Boolean(value);
}

66 changes: 66 additions & 0 deletions
packages/node/test/utils/envToBool.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { envToBool } from '../../src/utils/envToBool';

describe('envToBool', () => {
 it.each([
 ['', true, null],
 ['', false, false],
 ['t', true, true],
 ['T', true, true],
 ['t', false, true],
 ['T', false, true],
 ['y', true, true],
 ['Y', true, true],
 ['y', false, true],
 ['Y', false, true],
 ['1', true, true],
 ['1', false, true],
 ['true', true, true],
 ['true', false, true],
 ['tRuE', true, true],
 ['tRuE', false, true],
 ['Yes', true, true],
 ['Yes', false, true],
 ['yes', true, true],
 ['yes', false, true],
 ['yEs', true, true],
 ['yEs', false, true],
 ['On', true, true],
 ['On', false, true],
 ['on', true, true],
 ['on', false, true],
 ['oN', true, true],
 ['oN', false, true],
 ['f', true, false],
 ['f', false, false],
 ['n', true, false],
 ['N', true, false],
 ['n', false, false],
 ['N', false, false],
 ['0', true, false],
 ['0', false, false],
 ['false', true, false],
 ['false', false, false],
 ['false', true, false],
 ['false', false, false],
 ['FaLsE', true, false],
 ['FaLsE', false, false],
 ['No', true, false],
 ['No', false, false],
 ['no', true, false],
 ['no', false, false],
 ['nO', true, false],
 ['nO', false, false],
 ['Off', true, false],
 ['Off', false, false],
 ['off', true, false],
 ['off', false, false],
 ['oFf', true, false],
 ['oFf', false, false],
 ['xxx', true, null],
 ['xxx', false, true],
 [undefined, false, false],
 [undefined, true, null],
 ])('%s becomes (strict: %s): %s', (value, strict, expected) => {
 expect(envToBool(value, { strict })).toBe(expected);
 });
});

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

Skip to content
feat: Add support for SENTRY_SPOTLIGHT env var in Node#13325

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 10 commits into

from

Aug 13, 2024
 Merged


feat: Add support for SENTRY_SPOTLIGHT env var in Node
#13325
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
cf04993

feat: Add support for SENTRY_SPOTLIGHT env var in Node

Aug 12, 2024
6b973cd

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 12, 2024
f08ff0d

pull out into helper

Aug 13, 2024
1310252

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
67bd976

forgot strict mode

Aug 13, 2024
32c89cb

fix logic error

Aug 13, 2024
ed51040

add tests

Aug 13, 2024
1d9c633

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
7dcaa82

fix tests & add undefined case

Aug 13, 2024
3a674c2

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,5 +42,5 @@
 "[typescript]": {
 "editor.defaultFormatter": "biomejs.biome"
 },
 "cSpell.words": ["arrayify"]
 "cSpell.words": ["arrayify", "OTEL"]
}

7 changes: 4 additions & 3 deletions
packages/node/src/preload.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { preloadOpenTelemetry } from './sdk/initOtel';
import { envToBool } from './utils/envToBool';

const debug = !!process.env.SENTRY_DEBUG;
const debug = envToBool(process.env.SENTRY_DEBUG);
const integrationsStr = process.env.SENTRY_PRELOAD_INTEGRATIONS;

const integrations = integrationsStr ? integrationsStr.split(',').map(integration => integration.trim()) : undefined;

/**
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL instrumentation,
 * without initializing the Sentry SDK.
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL
 * instrumentation, without initializing the Sentry SDK.
 *
 * This is useful if you cannot initialize the SDK immediately, but still want to preload the instrumentation,
 * e.g. if you have to load the DSN from somewhere else.
Expand Down

13 changes: 11 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { envToBool } from '../utils/envToBool';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
Expand DownExpand Up@@ -221,6 +222,15 @@ function getClientOptions(
 ? true
 : options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
 if (spotlightEnv == null) {
 options.spotlight = process.env.SENTRY_SPOTLIGHT;
 } else {
 options.spotlight = spotlightEnv;
 }
Comment thread
BYK marked this conversation as resolved.

 }

 const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);

 const baseOptions = dropUndefinedKeys({
Expand DownExpand Up@@ -292,8 +302,7 @@ function getTracesSampleRate(tracesSampleRate: NodeOptions['tracesSampleRate']):
 * for more details.
 */
function updateScopeFromEnvVariables(): void {
 const sentryUseEnvironment = (process.env.SENTRY_USE_ENVIRONMENT || '').toLowerCase();
 if (!['false', 'n', 'no', 'off', '0'].includes(sentryUseEnvironment)) {
 if (envToBool(process.env.SENTRY_USE_ENVIRONMENT) !== false) {
 const sentryTraceEnv = process.env.SENTRY_TRACE;
 const baggageEnv = process.env.SENTRY_BAGGAGE;
 const propagationContext = propagationContextFromHeaders(sentryTraceEnv, baggageEnv);
Expand Down

38 changes: 38 additions & 0 deletions
packages/node/src/utils/envToBool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
export const FALSY_ENV_VALUES = new Set(['false', 'f', 'n', 'no', 'off', '0']);
export const TRUTHY_ENV_VALUES = new Set(['true', 't', 'y', 'yes', 'on', '1']);

export type StrictBoolCast = {
 strict: true;
};

export type LooseBoolCast = {
 strict?: false;
};

export type BoolCastOptions = StrictBoolCast | LooseBoolCast;

export function envToBool(value: unknown, options?: LooseBoolCast): boolean;
export function envToBool(value: unknown, options: StrictBoolCast): boolean | null;
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null;
/**
 * A helper function which casts an ENV variable value to `true` or `false` using the constants defined above.
 * In strict mode, it may return `null` if the value doesn't match any of the predefined values.
 *
 * @param value The value of the env variable
 * @param options -- Only has `strict` key for now, which requires a strict match for `true` in TRUTHY_ENV_VALUES
 * @returns true/false if the lowercase value matches the predefined values above. If not, null in strict mode,
 * and Boolean(value) in loose mode.
 */
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null {
Comment thread
BYK marked this conversation as resolved.

 const normalized = String(value).toLowerCase();

 if (FALSY_ENV_VALUES.has(normalized)) {
 return false;
 }

 if (TRUTHY_ENV_VALUES.has(normalized)) {
 return true;
 }

 return options && options.strict ? null : Boolean(value);
}

66 changes: 66 additions & 0 deletions
packages/node/test/utils/envToBool.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { envToBool } from '../../src/utils/envToBool';

describe('envToBool', () => {
 it.each([
 ['', true, null],
 ['', false, false],
 ['t', true, true],
 ['T', true, true],
 ['t', false, true],
 ['T', false, true],
 ['y', true, true],
 ['Y', true, true],
 ['y', false, true],
 ['Y', false, true],
 ['1', true, true],
 ['1', false, true],
 ['true', true, true],
 ['true', false, true],
 ['tRuE', true, true],
 ['tRuE', false, true],
 ['Yes', true, true],
 ['Yes', false, true],
 ['yes', true, true],
 ['yes', false, true],
 ['yEs', true, true],
 ['yEs', false, true],
 ['On', true, true],
 ['On', false, true],
 ['on', true, true],
 ['on', false, true],
 ['oN', true, true],
 ['oN', false, true],
 ['f', true, false],
 ['f', false, false],
 ['n', true, false],
 ['N', true, false],
 ['n', false, false],
 ['N', false, false],
 ['0', true, false],
 ['0', false, false],
 ['false', true, false],
 ['false', false, false],
 ['false', true, false],
 ['false', false, false],
 ['FaLsE', true, false],
 ['FaLsE', false, false],
 ['No', true, false],
 ['No', false, false],
 ['no', true, false],
 ['no', false, false],
 ['nO', true, false],
 ['nO', false, false],
 ['Off', true, false],
 ['Off', false, false],
 ['off', true, false],
 ['off', false, false],
 ['oFf', true, false],
 ['oFf', false, false],
 ['xxx', true, null],
 ['xxx', false, true],
 [undefined, false, false],
 [undefined, true, null],
 ])('%s becomes (strict: %s): %s', (value, strict, expected) => {
 expect(envToBool(value, { strict })).toBe(expected);
 });
});

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

Skip to content
feat: Add support for SENTRY_SPOTLIGHT env var in Node#13325

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 10 commits into

from

Aug 13, 2024
 Merged


feat: Add support for SENTRY_SPOTLIGHT env var in Node
#13325
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
cf04993

feat: Add support for SENTRY_SPOTLIGHT env var in Node

Aug 12, 2024
6b973cd

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 12, 2024
f08ff0d

pull out into helper

Aug 13, 2024
1310252

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
67bd976

forgot strict mode

Aug 13, 2024
32c89cb

fix logic error

Aug 13, 2024
ed51040

add tests

Aug 13, 2024
1d9c633

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
7dcaa82

fix tests & add undefined case

Aug 13, 2024
3a674c2

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,5 +42,5 @@
 "[typescript]": {
 "editor.defaultFormatter": "biomejs.biome"
 },
 "cSpell.words": ["arrayify"]
 "cSpell.words": ["arrayify", "OTEL"]
}

7 changes: 4 additions & 3 deletions
packages/node/src/preload.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { preloadOpenTelemetry } from './sdk/initOtel';
import { envToBool } from './utils/envToBool';

const debug = !!process.env.SENTRY_DEBUG;
const debug = envToBool(process.env.SENTRY_DEBUG);
const integrationsStr = process.env.SENTRY_PRELOAD_INTEGRATIONS;

const integrations = integrationsStr ? integrationsStr.split(',').map(integration => integration.trim()) : undefined;

/**
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL instrumentation,
 * without initializing the Sentry SDK.
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL
 * instrumentation, without initializing the Sentry SDK.
 *
 * This is useful if you cannot initialize the SDK immediately, but still want to preload the instrumentation,
 * e.g. if you have to load the DSN from somewhere else.
Expand Down

13 changes: 11 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { envToBool } from '../utils/envToBool';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
Expand DownExpand Up@@ -221,6 +222,15 @@ function getClientOptions(
 ? true
 : options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
 if (spotlightEnv == null) {
 options.spotlight = process.env.SENTRY_SPOTLIGHT;
 } else {
 options.spotlight = spotlightEnv;
 }
Comment thread
BYK marked this conversation as resolved.

 }

 const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);

 const baseOptions = dropUndefinedKeys({
Expand DownExpand Up@@ -292,8 +302,7 @@ function getTracesSampleRate(tracesSampleRate: NodeOptions['tracesSampleRate']):
 * for more details.
 */
function updateScopeFromEnvVariables(): void {
 const sentryUseEnvironment = (process.env.SENTRY_USE_ENVIRONMENT || '').toLowerCase();
 if (!['false', 'n', 'no', 'off', '0'].includes(sentryUseEnvironment)) {
 if (envToBool(process.env.SENTRY_USE_ENVIRONMENT) !== false) {
 const sentryTraceEnv = process.env.SENTRY_TRACE;
 const baggageEnv = process.env.SENTRY_BAGGAGE;
 const propagationContext = propagationContextFromHeaders(sentryTraceEnv, baggageEnv);
Expand Down

38 changes: 38 additions & 0 deletions
packages/node/src/utils/envToBool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
export const FALSY_ENV_VALUES = new Set(['false', 'f', 'n', 'no', 'off', '0']);
export const TRUTHY_ENV_VALUES = new Set(['true', 't', 'y', 'yes', 'on', '1']);

export type StrictBoolCast = {
 strict: true;
};

export type LooseBoolCast = {
 strict?: false;
};

export type BoolCastOptions = StrictBoolCast | LooseBoolCast;

export function envToBool(value: unknown, options?: LooseBoolCast): boolean;
export function envToBool(value: unknown, options: StrictBoolCast): boolean | null;
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null;
/**
 * A helper function which casts an ENV variable value to `true` or `false` using the constants defined above.
 * In strict mode, it may return `null` if the value doesn't match any of the predefined values.
 *
 * @param value The value of the env variable
 * @param options -- Only has `strict` key for now, which requires a strict match for `true` in TRUTHY_ENV_VALUES
 * @returns true/false if the lowercase value matches the predefined values above. If not, null in strict mode,
 * and Boolean(value) in loose mode.
 */
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null {
Comment thread
BYK marked this conversation as resolved.

 const normalized = String(value).toLowerCase();

 if (FALSY_ENV_VALUES.has(normalized)) {
 return false;
 }

 if (TRUTHY_ENV_VALUES.has(normalized)) {
 return true;
 }

 return options && options.strict ? null : Boolean(value);
}

66 changes: 66 additions & 0 deletions
packages/node/test/utils/envToBool.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { envToBool } from '../../src/utils/envToBool';

describe('envToBool', () => {
 it.each([
 ['', true, null],
 ['', false, false],
 ['t', true, true],
 ['T', true, true],
 ['t', false, true],
 ['T', false, true],
 ['y', true, true],
 ['Y', true, true],
 ['y', false, true],
 ['Y', false, true],
 ['1', true, true],
 ['1', false, true],
 ['true', true, true],
 ['true', false, true],
 ['tRuE', true, true],
 ['tRuE', false, true],
 ['Yes', true, true],
 ['Yes', false, true],
 ['yes', true, true],
 ['yes', false, true],
 ['yEs', true, true],
 ['yEs', false, true],
 ['On', true, true],
 ['On', false, true],
 ['on', true, true],
 ['on', false, true],
 ['oN', true, true],
 ['oN', false, true],
 ['f', true, false],
 ['f', false, false],
 ['n', true, false],
 ['N', true, false],
 ['n', false, false],
 ['N', false, false],
 ['0', true, false],
 ['0', false, false],
 ['false', true, false],
 ['false', false, false],
 ['false', true, false],
 ['false', false, false],
 ['FaLsE', true, false],
 ['FaLsE', false, false],
 ['No', true, false],
 ['No', false, false],
 ['no', true, false],
 ['no', false, false],
 ['nO', true, false],
 ['nO', false, false],
 ['Off', true, false],
 ['Off', false, false],
 ['off', true, false],
 ['off', false, false],
 ['oFf', true, false],
 ['oFf', false, false],
 ['xxx', true, null],
 ['xxx', false, true],
 [undefined, false, false],
 [undefined, true, null],
 ])('%s becomes (strict: %s): %s', (value, strict, expected) => {
 expect(envToBool(value, { strict })).toBe(expected);
 });
});

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

Skip to content
feat: Add support for SENTRY_SPOTLIGHT env var in Node#13325

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 10 commits into

from

Aug 13, 2024
 Merged


feat: Add support for SENTRY_SPOTLIGHT env var in Node
#13325
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
cf04993

feat: Add support for SENTRY_SPOTLIGHT env var in Node

Aug 12, 2024
6b973cd

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 12, 2024
f08ff0d

pull out into helper

Aug 13, 2024
1310252

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
67bd976

forgot strict mode

Aug 13, 2024
32c89cb

fix logic error

Aug 13, 2024
ed51040

add tests

Aug 13, 2024
1d9c633

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024
7dcaa82

fix tests & add undefined case

Aug 13, 2024
3a674c2

Merge branch 'develop' into byk/feat/SENTRY_SPOTLIGHT


BYK Aug 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,5 +42,5 @@
 "[typescript]": {
 "editor.defaultFormatter": "biomejs.biome"
 },
 "cSpell.words": ["arrayify"]
 "cSpell.words": ["arrayify", "OTEL"]
}

7 changes: 4 additions & 3 deletions
packages/node/src/preload.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { preloadOpenTelemetry } from './sdk/initOtel';
import { envToBool } from './utils/envToBool';

const debug = !!process.env.SENTRY_DEBUG;
const debug = envToBool(process.env.SENTRY_DEBUG);
const integrationsStr = process.env.SENTRY_PRELOAD_INTEGRATIONS;

const integrations = integrationsStr ? integrationsStr.split(',').map(integration => integration.trim()) : undefined;

/**
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL instrumentation,
 * without initializing the Sentry SDK.
 * The @sentry/node/preload export can be used with the node --import and --require args to preload the OTEL
 * instrumentation, without initializing the Sentry SDK.
 *
 * This is useful if you cannot initialize the SDK immediately, but still want to preload the instrumentation,
 * e.g. if you have to load the DSN from somewhere else.
Expand Down

13 changes: 11 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { envToBool } from '../utils/envToBool';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
Expand DownExpand Up@@ -221,6 +222,15 @@ function getClientOptions(
 ? true
 : options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
 if (spotlightEnv == null) {
 options.spotlight = process.env.SENTRY_SPOTLIGHT;
 } else {
 options.spotlight = spotlightEnv;
 }
Comment thread
BYK marked this conversation as resolved.

 }

 const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);

 const baseOptions = dropUndefinedKeys({
Expand DownExpand Up@@ -292,8 +302,7 @@ function getTracesSampleRate(tracesSampleRate: NodeOptions['tracesSampleRate']):
 * for more details.
 */
function updateScopeFromEnvVariables(): void {
 const sentryUseEnvironment = (process.env.SENTRY_USE_ENVIRONMENT || '').toLowerCase();
 if (!['false', 'n', 'no', 'off', '0'].includes(sentryUseEnvironment)) {
 if (envToBool(process.env.SENTRY_USE_ENVIRONMENT) !== false) {
 const sentryTraceEnv = process.env.SENTRY_TRACE;
 const baggageEnv = process.env.SENTRY_BAGGAGE;
 const propagationContext = propagationContextFromHeaders(sentryTraceEnv, baggageEnv);
Expand Down

38 changes: 38 additions & 0 deletions
packages/node/src/utils/envToBool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
export const FALSY_ENV_VALUES = new Set(['false', 'f', 'n', 'no', 'off', '0']);
export const TRUTHY_ENV_VALUES = new Set(['true', 't', 'y', 'yes', 'on', '1']);

export type StrictBoolCast = {
 strict: true;
};

export type LooseBoolCast = {
 strict?: false;
};

export type BoolCastOptions = StrictBoolCast | LooseBoolCast;

export function envToBool(value: unknown, options?: LooseBoolCast): boolean;
export function envToBool(value: unknown, options: StrictBoolCast): boolean | null;
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null;
/**
 * A helper function which casts an ENV variable value to `true` or `false` using the constants defined above.
 * In strict mode, it may return `null` if the value doesn't match any of the predefined values.
 *
 * @param value The value of the env variable
 * @param options -- Only has `strict` key for now, which requires a strict match for `true` in TRUTHY_ENV_VALUES
 * @returns true/false if the lowercase value matches the predefined values above. If not, null in strict mode,
 * and Boolean(value) in loose mode.
 */
export function envToBool(value: unknown, options?: BoolCastOptions): boolean | null {
Comment thread
BYK marked this conversation as resolved.

 const normalized = String(value).toLowerCase();

 if (FALSY_ENV_VALUES.has(normalized)) {
 return false;
 }

 if (TRUTHY_ENV_VALUES.has(normalized)) {
 return true;
 }

 return options && options.strict ? null : Boolean(value);
}

66 changes: 66 additions & 0 deletions
packages/node/test/utils/envToBool.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { envToBool } from '../../src/utils/envToBool';

describe('envToBool', () => {
 it.each([
 ['', true, null],
 ['', false, false],
 ['t', true, true],
 ['T', true, true],
 ['t', false, true],
 ['T', false, true],
 ['y', true, true],
 ['Y', true, true],
 ['y', false, true],
 ['Y', false, true],
 ['1', true, true],
 ['1', false, true],
 ['true', true, true],
 ['true', false, true],
 ['tRuE', true, true],
 ['tRuE', false, true],
 ['Yes', true, true],
 ['Yes', false, true],
 ['yes', true, true],
 ['yes', false, true],
 ['yEs', true, true],
 ['yEs', false, true],
 ['On', true, true],
 ['On', false, true],
 ['on', true, true],
 ['on', false, true],
 ['oN', true, true],
 ['oN', false, true],
 ['f', true, false],
 ['f', false, false],
 ['n', true, false],
 ['N', true, false],
 ['n', false, false],
 ['N', false, false],
 ['0', true, false],
 ['0', false, false],
 ['false', true, false],
 ['false', false, false],
 ['false', true, false],
 ['false', false, false],
 ['FaLsE', true, false],
 ['FaLsE', false, false],
 ['No', true, false],
 ['No', false, false],
 ['no', true, false],
 ['no', false, false],
 ['nO', true, false],
 ['nO', false, false],
 ['Off', true, false],
 ['Off', false, false],
 ['off', true, false],
 ['off', false, false],
 ['oFf', true, false],
 ['oFf', false, false],
 ['xxx', true, null],
 ['xxx', false, true],
 [undefined, false, false],
 [undefined, true, null],
 ])('%s becomes (strict: %s): %s', (value, strict, expected) => {
 expect(envToBool(value, { strict })).toBe(expected);
 });
});