Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
125 lines
3.6 KiB
Plaintext
125 lines
3.6 KiB
Plaintext
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
|
|
const core = require('@sentry/core');
|
|
const eventbuilder = require('./eventbuilder.js');
|
|
const helpers = require('./helpers.js');
|
|
|
|
/**
|
|
* A magic string that build tooling can leverage in order to inject a release value into the SDK.
|
|
*/
|
|
|
|
/**
|
|
* The Sentry Browser SDK Client.
|
|
*
|
|
* @see BrowserOptions for documentation on configuration options.
|
|
* @see SentryClient for usage documentation.
|
|
*/
|
|
class BrowserClient extends core.Client {
|
|
/**
|
|
* Creates a new Browser SDK instance.
|
|
*
|
|
* @param options Configuration options for this SDK.
|
|
*/
|
|
constructor(options) {
|
|
const opts = applyDefaultOptions(options);
|
|
const sdkSource = helpers.WINDOW.SENTRY_SDK_SOURCE || core.getSDKSource();
|
|
core.applySdkMetadata(opts, 'browser', ['browser'], sdkSource);
|
|
|
|
// Only allow IP inferral by Relay if sendDefaultPii is true
|
|
if (opts._metadata?.sdk) {
|
|
opts._metadata.sdk.settings = {
|
|
infer_ip: opts.sendDefaultPii ? 'auto' : 'never',
|
|
// purposefully allowing already passed settings to override the default
|
|
...opts._metadata.sdk.settings,
|
|
};
|
|
}
|
|
|
|
super(opts);
|
|
|
|
const {
|
|
sendDefaultPii,
|
|
sendClientReports,
|
|
enableLogs,
|
|
_experiments,
|
|
enableMetrics: enableMetricsOption,
|
|
} = this._options;
|
|
|
|
// todo(v11): Remove the experimental flag
|
|
// eslint-disable-next-line deprecation/deprecation
|
|
const enableMetrics = enableMetricsOption ?? _experiments?.enableMetrics ?? true;
|
|
|
|
// Flush logs and metrics when page becomes hidden (e.g., tab switch, navigation)
|
|
// todo(v11): Remove the experimental flag
|
|
if (helpers.WINDOW.document && (sendClientReports || enableLogs || enableMetrics)) {
|
|
helpers.WINDOW.document.addEventListener('visibilitychange', () => {
|
|
if (helpers.WINDOW.document.visibilityState === 'hidden') {
|
|
if (sendClientReports) {
|
|
this._flushOutcomes();
|
|
}
|
|
if (enableLogs) {
|
|
core._INTERNAL_flushLogsBuffer(this);
|
|
}
|
|
|
|
if (enableMetrics) {
|
|
core._INTERNAL_flushMetricsBuffer(this);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
if (sendDefaultPii) {
|
|
this.on('beforeSendSession', core.addAutoIpAddressToSession);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
eventFromException(exception, hint) {
|
|
return eventbuilder.eventFromException(this._options.stackParser, exception, hint, this._options.attachStacktrace);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
eventFromMessage(
|
|
message,
|
|
level = 'info',
|
|
hint,
|
|
) {
|
|
return eventbuilder.eventFromMessage(this._options.stackParser, message, level, hint, this._options.attachStacktrace);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
_prepareEvent(
|
|
event,
|
|
hint,
|
|
currentScope,
|
|
isolationScope,
|
|
) {
|
|
event.platform = event.platform || 'javascript';
|
|
|
|
return super._prepareEvent(event, hint, currentScope, isolationScope);
|
|
}
|
|
}
|
|
|
|
/** Exported only for tests. */
|
|
function applyDefaultOptions(optionsArg) {
|
|
return {
|
|
release:
|
|
typeof __SENTRY_RELEASE__ === 'string' // This allows build tooling to find-and-replace __SENTRY_RELEASE__ to inject a release value
|
|
? __SENTRY_RELEASE__
|
|
: helpers.WINDOW.SENTRY_RELEASE?.id, // This supports the variable that sentry-webpack-plugin injects
|
|
sendClientReports: true,
|
|
// We default this to true, as it is the safer scenario
|
|
parentSpanIsAlwaysRootSpan: true,
|
|
...optionsArg,
|
|
};
|
|
}
|
|
|
|
exports.BrowserClient = BrowserClient;
|
|
exports.applyDefaultOptions = applyDefaultOptions;
|
|
//# sourceMappingURL=client.js.map
|