@sentry/browser 5.28.0 → 5.30.0

package/build/bundle.js

@@ -1,4 +1,4 @@
-/*! @sentry/browser 5.28.0 (705af78) | https://github.com/getsentry/sentry-javascript */
+/*! @sentry/browser 5.30.0 (6de2dd4) | https://github.com/getsentry/sentry-javascript */
 var Sentry = (function (exports) {
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation. All rights reserved.
@@ -40,6 +40,16 @@ var Sentry = (function (exports) {
         return __assign.apply(this, arguments);
     };
 
+    function __rest(s, e) {
+        var t = {};
+        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+            t[p] = s[p];
+        if (s != null && typeof Object.getOwnPropertySymbols === "function")
+            for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) if (e.indexOf(p[i]) < 0)
+                t[p[i]] = s[p[i]];
+        return t;
+    }
+
     function __values(o) {
         var m = typeof Symbol === "function" && o[Symbol.iterator], i = 0;
         if (m) return m.call(o);
@@ -191,6 +201,14 @@ var Sentry = (function (exports) {
         Status.fromHttpCode = fromHttpCode;
     })(exports.Status || (exports.Status = {}));
 
+    var TransactionSamplingMethod;
+    (function (TransactionSamplingMethod) {
+        TransactionSamplingMethod["Explicit"] = "explicitly_set";
+        TransactionSamplingMethod["Sampler"] = "client_sampler";
+        TransactionSamplingMethod["Rate"] = "client_rate";
+        TransactionSamplingMethod["Inheritance"] = "inheritance";
+    })(TransactionSamplingMethod || (TransactionSamplingMethod = {}));
+
     /* eslint-disable @typescript-eslint/no-explicit-any */
     /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
     /**
@@ -253,7 +271,7 @@ var Sentry = (function (exports) {
         return Object.prototype.toString.call(wat) === '[object String]';
     }
     /**
-     * Checks whether given value's is a primitive (undefined, null, number, boolean, string)
+     * Checks whether given value's is a primitive (undefined, null, number, boolean, string, bigint, symbol)
      * {@link isPrimitive}.
      *
      * @param wat A value to be checked.
@@ -615,7 +633,7 @@ var Sentry = (function (exports) {
      * Truncates given string to the maximum characters count
      *
      * @param str An object that contains serializable values
-     * @param max Maximum number of characters in truncated string
+     * @param max Maximum number of characters in truncated string (0 = unlimited)
      * @returns string Encoded
      */
     function truncate(str, max) {
@@ -672,15 +690,16 @@ var Sentry = (function (exports) {
      *
      * @param source An object that contains a method to be wrapped.
      * @param name A name of method to be wrapped.
-     * @param replacement A function that should be used to wrap a given method.
+     * @param replacementFactory A function that should be used to wrap a given method, returning the wrapped method which
+     * will be substituted in for `source[name]`.
      * @returns void
      */
-    function fill(source, name, replacement) {
+    function fill(source, name, replacementFactory) {
         if (!(name in source)) {
             return;
         }
         var original = source[name];
-        var wrapped = replacement(original);
+        var wrapped = replacementFactory(original);
         // Make sure it's a function first, as we need to attach an empty prototype for `defineProperties` to work
         // otherwise it'll throw "TypeError: Object.defineProperties called on non-object"
         if (typeof wrapped === 'function') {
@@ -712,10 +731,10 @@ var Sentry = (function (exports) {
             .join('&');
     }
     /**
-     * Transforms any object into an object literal with all it's attributes
+     * Transforms any object into an object literal with all its attributes
      * attached to it.
      *
-     * @param value Initial source that we have to transform in order to be usable by the serializer
+     * @param value Initial source that we have to transform in order for it to be usable by the serializer
      */
     function getWalkSource(value) {
         if (isError(value)) {
@@ -788,7 +807,15 @@ var Sentry = (function (exports) {
         }
         return serialized;
     }
-    /** Transforms any input value into a string form, either primitive value or a type of the input */
+    /**
+     * Transform any non-primitive, BigInt, or Symbol-type value into a string. Acts as a no-op on strings, numbers,
+     * booleans, null, and undefined.
+     *
+     * @param value The value to stringify
+     * @returns For non-primitive, BigInt, and Symbol-type values, a string denoting the value's type, type and value, or
+     *  type and `description` property, respectively. For non-BigInt, non-Symbol primitives, returns the original value,
+     *  unchanged.
+     */
     function serializeValue(value) {
         var type = Object.prototype.toString.call(value);
         // Node.js REPL notation
@@ -842,6 +869,13 @@ var Sentry = (function (exports) {
         if (typeof value === 'function') {
             return "[Function: " + getFunctionName(value) + "]";
         }
+        // symbols and bigints are considered primitives by TS, but aren't natively JSON-serilaizable
+        if (typeof value === 'symbol') {
+            return "[" + String(value) + "]";
+        }
+        if (typeof value === 'bigint') {
+            return "[BigInt: " + String(value) + "]";
+        }
         return value;
     }
     /**
@@ -3320,8 +3354,11 @@ var Sentry = (function (exports) {
     }
     /**
      * Set key:value that will be sent as tags data with the event.
+     *
+     * Can also be used to unset a tag, by passing `undefined`.
+     *
      * @param key String key of tag
-     * @param value String value of tag
+     * @param value Value of tag
      */
     function setTag(key, value) {
         callOnHub('setTag', key, value);
@@ -3623,7 +3660,7 @@ var Sentry = (function (exports) {
             var _this = this;
             var eventId = hint && hint.event_id;
             var promisedEvent = isPrimitive(message)
-                ? this._getBackend().eventFromMessage("" + message, level, hint)
+                ? this._getBackend().eventFromMessage(String(message), level, hint)
                 : this._getBackend().eventFromException(message, hint);
             this._process(promisedEvent
                 .then(function (event) { return _this._captureEvent(event, hint, scope); })
@@ -3946,7 +3983,7 @@ var Sentry = (function (exports) {
             // 0.0 === 0% events are sent
             // Sampling for transaction happens somewhere else
             if (!isTransaction && typeof sampleRate === 'number' && Math.random() > sampleRate) {
-                return SyncPromise.reject(new SentryError('This event has been sampled, will not send event.'));
+                return SyncPromise.reject(new SentryError("Discarding event because it's not included in the random sample (sampling rate = " + sampleRate + ")"));
             }
             return this._prepareEvent(event, scope, hint)
                 .then(function (prepared) {
@@ -4108,6 +4145,9 @@ var Sentry = (function (exports) {
     }
     /** Creates a SentryRequest from an event. */
     function eventToSentryRequest(event, api) {
+        // since JS has no Object.prototype.pop()
+        var _a = event.tags || {}, samplingMethod = _a.__sentry_samplingMethod, sampleRate = _a.__sentry_sampleRate, otherTags = __rest(_a, ["__sentry_samplingMethod", "__sentry_sampleRate"]);
+        event.tags = otherTags;
         var useEnvelope = event.type === 'transaction';
         var req = {
             body: JSON.stringify(event),
@@ -4126,6 +4166,9 @@ var Sentry = (function (exports) {
             });
             var itemHeaders = JSON.stringify({
                 type: event.type,
+                // TODO: Right now, sampleRate may or may not be defined (it won't be in the cases of inheritance and
+                // explicitly-set sampling decisions). Are we good with that?
+                sample_rates: [{ id: samplingMethod, rate: sampleRate }],
             });
             // The trailing newline is optional. We intentionally don't send it to avoid
             // sending unnecessary bytes.
@@ -4799,7 +4842,7 @@ var Sentry = (function (exports) {
              */
             var limited = this._handleRateLimit(headers);
             if (limited)
-                logger.warn("Too many requests, backing off till: " + this._disabledUntil(requestType));
+                logger.warn("Too many requests, backing off until: " + this._disabledUntil(requestType));
             if (status === exports.Status.Success) {
                 resolve({ status: status });
                 return;
@@ -4828,6 +4871,16 @@ var Sentry = (function (exports) {
             var raHeader = headers['retry-after'];
             if (rlHeader) {
                 try {
+                    // rate limit headers are of the form
+                    //     <header>,<header>,..
+                    // where each <header> is of the form
+                    //     <retry_after>: <categories>: <scope>: <reason_code>
+                    // where
+                    //     <retry_after> is a delay in ms
+                    //     <categories> is the event type(s) (error, transaction, etc) being rate limited and is of the form
+                    //         <category>;<category>;...
+                    //     <scope> is what's being limited (org, project, or key) - ignored by SDK
+                    //     <reason_code> is an arbitrary string like "org_quota" - ignored by SDK
                     for (var _c = __values(rlHeader.trim().split(',')), _d = _c.next(); !_d.done; _d = _c.next()) {
                         var limit = _d.value;
                         var parameters = limit.split(':', 2);
@@ -4922,7 +4975,13 @@ var Sentry = (function (exports) {
                         'x-sentry-rate-limits': response.headers.get('X-Sentry-Rate-Limits'),
                         'retry-after': response.headers.get('Retry-After'),
                     };
-                    _this._handleResponse({ requestType: sentryRequest.type, response: response, headers: headers, resolve: resolve, reject: reject });
+                    _this._handleResponse({
+                        requestType: sentryRequest.type,
+                        response: response,
+                        headers: headers,
+                        resolve: resolve,
+                        reject: reject,
+                    });
                 })
                     .catch(reject);
             }));
@@ -5291,7 +5350,7 @@ var Sentry = (function (exports) {
                     }
                     var client = currentHub.getClient();
                     var event = isPrimitive(error)
-                        ? _this._eventFromIncompleteRejection(error)
+                        ? _this._eventFromRejectionWithPrimitive(error)
                         : eventFromUnknownInput(error, undefined, {
                             attachStacktrace: client && client.getOptions().attachStacktrace,
                             rejection: true,
@@ -5339,16 +5398,19 @@ var Sentry = (function (exports) {
             return this._enhanceEventWithInitialFrame(event, url, line, column);
         };
         /**
-         * This function creates an Event from an TraceKitStackTrace that has part of it missing.
+         * Create an event from a promise rejection where the `reason` is a primitive.
+         *
+         * @param reason: The `reason` property of the promise rejection
+         * @returns An Event object with an appropriate `exception` value
          */
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        GlobalHandlers.prototype._eventFromIncompleteRejection = function (error) {
+        GlobalHandlers.prototype._eventFromRejectionWithPrimitive = function (reason) {
             return {
                 exception: {
                     values: [
                         {
                             type: 'UnhandledRejection',
-                            value: "Non-Error promise rejection captured with value: " + error,
+                            // String() is needed because the Primitive type includes symbols (which can't be automatically stringified)
+                            value: "Non-Error promise rejection captured with value: " + String(reason),
                         },
                     ],
                 },
@@ -5973,7 +6035,7 @@ var Sentry = (function (exports) {
     });
 
     var SDK_NAME = 'sentry.javascript.browser';
-    var SDK_VERSION = '5.28.0';
+    var SDK_VERSION = '5.30.0';
 
     /**
      * The Sentry Browser SDK Client.