Skip to content
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.

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

feat(core)!: Update hasTracingEnabled to consider empty trace config #14857

Merged
merged 5 commits into from
Dec 30, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
10 changes: 10 additions & 0 deletions docs/migration/v8-to-v9.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ Sentry.init({
});
```

- In previous versions, we determined if tracing is enabled (for Tracing Without Performance) by checking if either `tracesSampleRate` or `traceSampler` are _defined_ at all, in `Sentry.init()`. This means that e.g. the following config would lead to tracing without performance (=tracing being enabled, even if no spans would be started):

```js
Sentry.init({
tracesSampleRate: undefined,
});
```

In v9, an `undefined` value will be treated the same as if the value is not defined at all. You'll need to set `tracesSampleRate: 0` if you want to enable tracing without performance.

### `@sentry/node`

- When `skipOpenTelemetrySetup: true` is configured, `httpIntegration({ spans: false })` will be configured by default. This means that you no longer have to specify this yourself in this scenario. With this change, no spans are emitted once `skipOpenTelemetrySetup: true` is configured, without any further configuration being needed.
Expand Down
28 changes: 20 additions & 8 deletions packages/browser/src/sdk.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { Client, DsnLike, Integration, Options } from '@sentry/core';
import {
consoleSandbox,
dedupeIntegration,
Expand All @@ -12,7 +13,6 @@ import {
stackParserFromStackParserOptions,
supportsFetch,
} from '@sentry/core';
import type { Client, DsnLike, Integration, Options } from '@sentry/core';
import type { BrowserClientOptions, BrowserOptions } from './client';
import { BrowserClient } from './client';
import { DEBUG_BUILD } from './debug-build';
Expand Down Expand Up @@ -64,15 +64,27 @@ function applyDefaultOptions(optionsArg: BrowserOptions = {}): BrowserOptions {
sendClientReports: true,
};

// TODO: Instead of dropping just `defaultIntegrations`, we should simply
// call `dropUndefinedKeys` on the entire `optionsArg`.
// However, for this to work we need to adjust the `hasTracingEnabled()` logic
// first as it differentiates between `undefined` and the key not being in the object.
if (optionsArg.defaultIntegrations == null) {
delete optionsArg.defaultIntegrations;
return {
...defaultOptions,
...dropUndefinedKeysFlat(optionsArg),
};
}

/**
* In contrast to the regular `dropUndefinedKeys` method,
* this one does not deep-drop keys, but only on the top level.
*/
function dropUndefinedKeysFlat<T extends object>(obj: T): Partial<T> {
mydea marked this conversation as resolved.
Show resolved Hide resolved
const mutatetedObj: Partial<T> = {};

for (const k of Object.getOwnPropertyNames(obj)) {
const key = k as keyof T;
if (obj[key] !== undefined) {
mutatetedObj[key] = obj[key];
}
}

return { ...defaultOptions, ...optionsArg };
return mutatetedObj;
}

type ExtensionProperties = {
Expand Down
14 changes: 1 addition & 13 deletions packages/core/src/baseclient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { consoleSandbox, logger } from './utils-hoist/logger';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
import { SyncPromise, rejectedSyncPromise, resolvedSyncPromise } from './utils-hoist/syncpromise';
import { getPossibleEventMessages } from './utils/eventUtils';
Expand Down Expand Up @@ -144,18 +144,6 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
url,
});
}

// TODO(v9): Remove this deprecation warning
const tracingOptions = ['enableTracing', 'tracesSampleRate', 'tracesSampler'] as const;
const undefinedOption = tracingOptions.find(option => option in options && options[option] == undefined);
if (undefinedOption) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Deprecation warning: \`${undefinedOption}\` is set to undefined, which leads to tracing being enabled. In v9, a value of \`undefined\` will result in tracing being disabled.`,
);
});
}
}

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/hasTracingEnabled.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ export function hasTracingEnabled(
const client = getClient();
const options = maybeOptions || (client && client.getOptions());
// eslint-disable-next-line deprecation/deprecation
return !!options && (options.enableTracing || 'tracesSampleRate' in options || 'tracesSampler' in options);
return !!options && (options.enableTracing || options.tracesSampleRate != null || !!options.tracesSampler);
}
38 changes: 0 additions & 38 deletions packages/core/test/lib/baseclient.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,44 +87,6 @@ describe('BaseClient', () => {
expect(consoleWarnSpy).toHaveBeenCalledTimes(0);
consoleWarnSpy.mockRestore();
});

describe.each(['tracesSampleRate', 'tracesSampler', 'enableTracing'])('%s', key => {
it('warns when set to undefined', () => {
const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => undefined);

const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, [key]: undefined });
new TestClient(options);

expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
expect(consoleWarnSpy).toBeCalledWith(
`[Sentry] Deprecation warning: \`${key}\` is set to undefined, which leads to tracing being enabled. In v9, a value of \`undefined\` will result in tracing being disabled.`,
);
consoleWarnSpy.mockRestore();
});

it('warns when set to null', () => {
const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => undefined);

const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, [key]: null });
new TestClient(options);

expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
expect(consoleWarnSpy).toBeCalledWith(
`[Sentry] Deprecation warning: \`${key}\` is set to undefined, which leads to tracing being enabled. In v9, a value of \`undefined\` will result in tracing being disabled.`,
);
consoleWarnSpy.mockRestore();
});

it('does not warn when set to 0', () => {
const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => undefined);

const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, [key]: 0 });
new TestClient(options);

expect(consoleWarnSpy).toHaveBeenCalledTimes(0);
consoleWarnSpy.mockRestore();
});
});
});

describe('getOptions()', () => {
Expand Down
4 changes: 4 additions & 0 deletions packages/core/test/lib/utils/hasTracingEnabled.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ describe('hasTracingEnabled', () => {
['With tracesSampleRate', { tracesSampleRate }, true],
['With enableTracing=true', { enableTracing: true }, true],
['With enableTracing=false', { enableTracing: false }, false],
['With enableTracing=undefined', { enableTracing: undefined }, false],
['With tracesSampleRate=undefined', { tracesSampleRate: undefined }, false],
['With tracesSampleRate=0', { tracesSampleRate: 0 }, true],
['With tracesSampler=undefined', { tracesSampler: undefined }, false],
['With tracesSampler && enableTracing=false', { tracesSampler, enableTracing: false }, true],
['With tracesSampleRate && enableTracing=false', { tracesSampler, enableTracing: false }, true],
['With tracesSampler and tracesSampleRate', { tracesSampler, tracesSampleRate }, true],
Expand Down
Loading