ref(core): Use versioned carrier on global object (#12206)

This PR implements a versioned Sentry carrier as described in #12188.
The idea is that SDKs can from now on access their global Sentry
instance and thereby no longer overwrite or interfere with potentially
other SDKs (e.g. 3rd party libraries, scripts, etc).

Internally, SDKs can access their carrier via the
`window.__SENTRY__[SDK_VERSION]`. Externally (spotlight, loader script)
via `window.__SENTRY__[window.__SENTRY__.version]`.

---------

Co-authored-by: Francesco Novy <francesco.novy@sentry.io>

Author: Lms24

dev-packages/browser-integration-tests/fixtures/loader.js

@@ -1,5 +1,139 @@
-!function(n,e,r,t,i,o,a,c,s){for(var u=s,f=0;f<document.scripts.length;f++)if(document.scripts[f].src.indexOf(o)>-1){u&&"no"===document.scripts[f].getAttribute("data-lazy")&&(u=!1);break}var p=[];function l(n){return"e"in n}function d(n){return"p"in n}function _(n){return"f"in n}var v=[];function y(n){u&&(l(n)||d(n)||_(n)&&n.f.indexOf("capture")>-1||_(n)&&n.f.indexOf("showReportDialog")>-1)&&m(),v.push(n)}function g(){y({e:[].slice.call(arguments)})}function h(n){y({p:n})}function E(){try{n.SENTRY_SDK_SOURCE="loader";var e=n[i],o=e.init;e.init=function(i){n.removeEventListener(r,g),n.removeEventListener(t,h);var a=c;for(var s in i)Object.prototype.hasOwnProperty.call(i,s)&&(a[s]=i[s]);!function(n,e){var r=n.integrations||[];if(!Array.isArray(r))return;var t=r.map((function(n){return n.name}));n.tracesSampleRate&&-1===t.indexOf("BrowserTracing")&&(e.BrowserTracing?r.push(new e.BrowserTracing):e.browserTracingIntegration&&r.push(e.browserTracingIntegration()));(n.replaysSessionSampleRate||n.replaysOnErrorSampleRate)&&-1===t.indexOf("Replay")&&(e.Replay?r.push(new e.Replay):e.replayIntegration&&r.push(e.replayIntegration()));n.integrations=r}(a,e),o(a)},setTimeout((function(){return function(e){try{"function"==typeof n.sentryOnLoad&&(n.sentryOnLoad(),n.sentryOnLoad=void 0);for(var r=0;r<p.length;r++)"function"==typeof p[r]&&p[r]();p.splice(0);for(r=0;r<v.length;r++){_(o=v[r])&&"init"===o.f&&e.init.apply(e,o.a)}L()||e.init();var t=n.onerror,i=n.onunhandledrejection;for(r=0;r<v.length;r++){var o;if(_(o=v[r])){if("init"===o.f)continue;e[o.f].apply(e,o.a)}else l(o)&&t?t.apply(n,o.e):d(o)&&i&&i.apply(n,[o.p])}}catch(n){console.error(n)}}(e)}))}catch(n){console.error(n)}}var O=!1;function m(){if(!O){O=!0;var n=e.scripts[0],r=e.createElement("script");r.src=a,r.crossOrigin="anonymous",r.addEventListener("load",E,{once:!0,passive:!0}),n.parentNode.insertBefore(r,n)}}function L(){var e=n.__SENTRY__;return!(void 0===e||!e.hub||!e.hub.getClient())}n[i]=n[i]||{},n[i].onLoad=function(n){L()?n():p.push(n)},n[i].forceLoad=function(){setTimeout((function(){m()}))},["init","addBreadcrumb","captureMessage","captureException","captureEvent","configureScope","withScope","showReportDialog"].forEach((function(e){n[i][e]=function(){y({f:e,a:arguments})}})),n.addEventListener(r,g),n.addEventListener(t,h),u||setTimeout((function(){m()}))}
-(
+!(function (n, e, r, t, i, o, a, c, s) {
+  for (var u = s, f = 0; f < document.scripts.length; f++)
+    if (document.scripts[f].src.indexOf(o) > -1) {
+      u && 'no' === document.scripts[f].getAttribute('data-lazy') && (u = !1);
+      break;
+    }
+  var p = [];
+  function l(n) {
+    return 'e' in n;
+  }
+  function d(n) {
+    return 'p' in n;
+  }
+  function _(n) {
+    return 'f' in n;
+  }
+  var v = [];
+  function y(n) {
+    u &&
+      (l(n) || d(n) || (_(n) && n.f.indexOf('capture') > -1) || (_(n) && n.f.indexOf('showReportDialog') > -1)) &&
+      m(),
+      v.push(n);
+  }
+  function g() {
+    y({ e: [].slice.call(arguments) });
+  }
+  function h(n) {
+    y({ p: n });
+  }
+  function E() {
+    try {
+      n.SENTRY_SDK_SOURCE = 'loader';
+      var e = n[i],
+        o = e.init;
+      (e.init = function (i) {
+        n.removeEventListener(r, g), n.removeEventListener(t, h);
+        var a = c;
+        for (var s in i) Object.prototype.hasOwnProperty.call(i, s) && (a[s] = i[s]);
+        !(function (n, e) {
+          var r = n.integrations || [];
+          if (!Array.isArray(r)) return;
+          var t = r.map(function (n) {
+            return n.name;
+          });
+          n.tracesSampleRate &&
+            -1 === t.indexOf('BrowserTracing') &&
+            (e.BrowserTracing
+              ? r.push(new e.BrowserTracing())
+              : e.browserTracingIntegration && r.push(e.browserTracingIntegration()));
+          (n.replaysSessionSampleRate || n.replaysOnErrorSampleRate) &&
+            -1 === t.indexOf('Replay') &&
+            (e.Replay ? r.push(new e.Replay()) : e.replayIntegration && r.push(e.replayIntegration()));
+          n.integrations = r;
+        })(a, e),
+          o(a);
+      }),
+        setTimeout(function () {
+          return (function (e) {
+            try {
+              'function' == typeof n.sentryOnLoad && (n.sentryOnLoad(), (n.sentryOnLoad = void 0));
+              for (var r = 0; r < p.length; r++) 'function' == typeof p[r] && p[r]();
+              p.splice(0);
+              for (r = 0; r < v.length; r++) {
+                _((o = v[r])) && 'init' === o.f && e.init.apply(e, o.a);
+              }
+              L() || e.init();
+              var t = n.onerror,
+                i = n.onunhandledrejection;
+              for (r = 0; r < v.length; r++) {
+                var o;
+                if (_((o = v[r]))) {
+                  if ('init' === o.f) continue;
+                  e[o.f].apply(e, o.a);
+                } else l(o) && t ? t.apply(n, o.e) : d(o) && i && i.apply(n, [o.p]);
+              }
+            } catch (n) {
+              console.error(n);
+            }
+          })(e);
+        });
+    } catch (n) {
+      console.error(n);
+    }
+  }
+  var O = !1;
+  function m() {
+    if (!O) {
+      O = !0;
+      var n = e.scripts[0],
+        r = e.createElement('script');
+      (r.src = a),
+        (r.crossOrigin = 'anonymous'),
+        r.addEventListener('load', E, { once: !0, passive: !0 }),
+        n.parentNode.insertBefore(r, n);
+    }
+  }
+  function L() {
+    var e = n.__SENTRY__;
+
+    // TODO: This is a temporary hack to make the loader script compatible with the versioned
+    // carrier. This needs still needs to be added to the actual loader script before we
+    // release the loader for v8!
+    var v = e && e.version && e[e.version];
+
+    return !(void 0 === e || !e.hub || !e.hub.getClient()) || !!v;
+  }
+  (n[i] = n[i] || {}),
+    (n[i].onLoad = function (n) {
+      L() ? n() : p.push(n);
+    }),
+    (n[i].forceLoad = function () {
+      setTimeout(function () {
+        m();
+      });
+    }),
+    [
+      'init',
+      'addBreadcrumb',
+      'captureMessage',
+      'captureException',
+      'captureEvent',
+      'configureScope',
+      'withScope',
+      'showReportDialog',
+    ].forEach(function (e) {
+      n[i][e] = function () {
+        y({ f: e, a: arguments });
+      };
+    }),
+    n.addEventListener(r, g),
+    n.addEventListener(t, h),
+    u ||
+      setTimeout(function () {
+        m();
+      });
+})(
   window,
   document,
   'error',
@@ -8,5 +142,5 @@
   'loader.js',
   __LOADER_BUNDLE__,
   __LOADER_OPTIONS__,
-  __LOADER_LAZY__
+  __LOADER_LAZY__,
 );

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customInit/init.js

@@ -16,5 +16,9 @@ window.sentryIsLoaded = () => {
   const __sentry = window.__SENTRY__;
 
   // If there is a global __SENTRY__ that means that in any of the callbacks init() was already invoked
-  return !!(!(typeof __sentry === 'undefined') && __sentry.hub && __sentry.hub.getClient());
+  return !!(
+    !(typeof __sentry === 'undefined') &&
+    __sentry.version &&
+    !!__sentry[__sentry.version]
+  );
 };

dev-packages/browser-integration-tests/suites/old-sdk-interop/acs/getCurrentScope/init.js

@@ -0,0 +1,19 @@
+import * as Sentry from '@sentry/browser';
+
+/**
+ * This simulates an relatively new v7 SDK setting acs on the __SENTRY__ carrier.
+ * see: https://github.com/getsentry/sentry-javascript/issues/12054
+ */
+window.__SENTRY__ = {
+  acs: {
+    getCurrentScope: () => {
+      return 'scope';
+    },
+  },
+};
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+});

dev-packages/browser-integration-tests/suites/old-sdk-interop/acs/getCurrentScope/subject.js

@@ -0,0 +1,10 @@
+const sentryCarrier = window && window.__SENTRY__;
+
+/**
+ * Simulate an old pre v8 SDK obtaining the hub from the global sentry carrier
+ * and checking for the hub version.
+ */
+const res = sentryCarrier.acs && sentryCarrier.acs.getCurrentScope();
+
+// Write back result into the document
+document.getElementById('currentScope').innerText = res && 'scope';

dev-packages/browser-integration-tests/suites/old-sdk-interop/acs/getCurrentScope/template.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+  </head>
+  <body>
+    <p id="currentScope"></p>
+  </body>
+</html>

dev-packages/browser-integration-tests/suites/old-sdk-interop/acs/getCurrentScope/test.ts

@@ -0,0 +1,13 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+
+sentryTest(
+  "doesn't crash if older SDKs access `acs.getCurrentScope` on the global object",
+  async ({ getLocalTestUrl, page }) => {
+    const url = await getLocalTestUrl({ testDir: __dirname });
+    await page.goto(url);
+
+    await expect(page.locator('#currentScope')).toHaveText('scope');
+  },
+);

dev-packages/browser-integration-tests/suites/old-sdk-interop/hub/isOlderThan/init.js

@@ -0,0 +1,19 @@
+import * as Sentry from '@sentry/browser';
+
+/**
+ * This simulates an old, pre-v8 SDK setting itself up on the global __SENTRY__ carrier.
+ * see: https://github.com/getsentry/sentry-javascript/issues/12155
+ */
+window.__SENTRY__ = {
+  hub: {
+    isOlderThan: version => {
+      return version < 7;
+    },
+  },
+};
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+});

dev-packages/browser-integration-tests/suites/old-sdk-interop/hub/isOlderThan/subject.js

@@ -0,0 +1,10 @@
+const sentryCarrier = window && window.__SENTRY__;
+
+/**
+ * Simulate an old pre v8 SDK obtaining the hub from the global sentry carrier
+ * and checking for the hub version.
+ */
+const res = sentryCarrier.hub && sentryCarrier.hub.isOlderThan(7);
+
+// Write back result into the document
+document.getElementById('olderThan').innerText = res;

dev-packages/browser-integration-tests/suites/old-sdk-interop/hub/isOlderThan/template.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+  </head>
+  <body>
+    <p id="olderThan"></p>
+  </body>
+</html>

dev-packages/browser-integration-tests/suites/old-sdk-interop/hub/isOlderThan/test.ts

@@ -0,0 +1,13 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+
+sentryTest(
+  "doesn't crash if older SDKs access `hub.isOlderThan` on the global object",
+  async ({ getLocalTestUrl, page }) => {
+    const url = await getLocalTestUrl({ testDir: __dirname });
+    await page.goto(url);
+
+    await expect(page.locator('#olderThan')).toHaveText('false');
+  },
+);