@sentry/browser
Version:
Official Sentry SDK for browsers
120 lines (119 loc) • 3.81 kB
JavaScript
import { eventFromException, eventFromMessage } from "./eventbuilder.js";
import { WINDOW } from "./helpers.js";
import { resolveBrowserTunnelOption } from "./utils/managedTunnel.js";
import { Client, _INTERNAL_RELEASE_META_TAG_NAME, addAutoIpAddressToSession, applySdkMetadata, getSDKSource, timestampInSeconds } from "@sentry/core";
import { setRouteProvider } from "@sentry/browser-utils";
// src/client.ts
/**
* The Sentry Browser SDK Client.
*
* @see BrowserOptions for documentation on configuration options.
* @see SentryClient for usage documentation.
*/
var BrowserClient = class extends Client {
/**
* Creates a new Browser SDK instance.
*
* @param options Configuration options for this SDK.
*/
constructor(options) {
const opts = applyDefaultOptions({
...options,
...resolveBrowserTunnelOption(options)
});
const sdkSource = WINDOW.SENTRY_SDK_SOURCE || getSDKSource();
applySdkMetadata(opts, "browser", ["browser"], sdkSource);
super(opts);
if (opts.routeProvider) setRouteProvider(opts.routeProvider, this);
this._unhandledSessionStatus = "unhandled";
const { userInfo } = this.getDataCollectionOptions();
if (opts._metadata?.sdk) opts._metadata.sdk.settings = {
infer_ip: userInfo ? "auto" : "never",
...opts._metadata.sdk.settings
};
const { sendClientReports } = this._options;
const checkDrift = () => {
timestampInSeconds();
};
const listeners = [
[
WINDOW.document,
"visibilitychange",
() => {
checkDrift();
if (WINDOW.document.visibilityState === "hidden") {
if (sendClientReports) this._flushOutcomes();
queueMicrotask(() => {
this.flush();
});
}
}
],
[
WINDOW.document,
"freeze",
checkDrift
],
[
WINDOW.document,
"resume",
checkDrift
],
[
WINDOW,
"pagehide",
checkDrift
],
[
WINDOW,
"pageshow",
checkDrift
]
];
listeners.forEach(([target, name, listener]) => target?.addEventListener?.(name, listener));
this.on("close", () => listeners.forEach(([target, name, listener]) => target?.removeEventListener?.(name, listener)));
if (userInfo) this.on("beforeSendSession", addAutoIpAddressToSession);
}
/**
* @inheritDoc
*/
eventFromException(exception, hint) {
return eventFromException(this._options.stackParser, exception, hint, this._options.attachStacktrace);
}
/**
* @inheritDoc
*/
eventFromMessage(message, level = "info", hint) {
return 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 {
sendClientReports: true,
parentSpanIsAlwaysRootSpan: true,
...optionsArg,
release: optionsArg.release ?? getDefaultRelease()
};
}
function getDefaultRelease() {
return typeof __SENTRY_RELEASE__ === "string" ? __SENTRY_RELEASE__ : getReleaseFromMetaTag() ?? WINDOW.SENTRY_RELEASE?.id;
}
/**
* Framework SDKs render the release into each page, so the content-hashed client chunks don't change on every
* release. The page comes from the server on every request, so it wins over `WINDOW.SENTRY_RELEASE`, which a cached
* chunk can set. It loses to `__SENTRY_RELEASE__`, which belongs to the one bundle that defined it, so a script
* embedded in another app's page keeps its own release.
*/
function getReleaseFromMetaTag() {
return WINDOW.document?.querySelector?.(`meta[name="${_INTERNAL_RELEASE_META_TAG_NAME}"]`)?.getAttribute("content") || void 0;
}
export { BrowserClient, applyDefaultOptions };
//# sourceMappingURL=client.js.map