feat: Support versioned Sentry carrier object introduced in 8.6.0+ (#402)

Author: Lms24

.changeset/happy-adults-jam.md

@@ -0,0 +1,8 @@
+---
+'@spotlightjs/spotlight': minor
+'@spotlightjs/electron': minor
+'@spotlightjs/overlay': minor
+'@spotlightjs/astro': minor
+---
+
+feat: Support versioned Sentry carrier object introduced in 8.6.0+

demos/astro-playground/package.json

@@ -17,7 +17,7 @@
     "@astrojs/node": "^6.0.4",
     "@astrojs/react": "^3.0.5",
     "@astrojs/svelte": "^4.0.4",
-    "@sentry/astro": "^8.0.0-alpha.7",
+    "@sentry/astro": "8.7.0",
     "@spotlightjs/astro": "workspace:*",
     "@types/react": "^18.2.37",
     "@types/react-dom": "^18.2.15",

packages/overlay/src/integrations/sentry/index.ts

@@ -96,20 +96,6 @@ export default function sentryIntegration(options?: SentryIntegrationOptions) {
   } satisfies Integration<Envelope>;
 }
 
-type WindowWithSentry = Window & {
-  __SENTRY__?: {
-    /** Future-proof v8 way of accessing Sentry APIs via the global */
-    acs?: {
-      getCurrentScope: () => {
-        getClient: () => Client | undefined;
-      };
-    };
-    hub?: {
-      getClient: () => Client | undefined;
-    };
-  };
-};
-
 export function processEnvelope(rawEvent: RawEventContext) {
   const { data } = rawEvent;
   const [rawHeader, ...rawEntries] = data.split(/\n/gm);
@@ -146,6 +132,27 @@ export function processEnvelope(rawEvent: RawEventContext) {
   };
 }
 
+type V8Carrier = {
+  stack: {
+    getScope?: () => {
+      getClient?: () => Client | undefined;
+    };
+  };
+};
+
+type LegacyCarrier = {
+  /** pre-v8 way of accessing client (v7 and earlier) */
+  hub?: {
+    getClient?: () => Client | undefined;
+  };
+};
+
+type VersionedCarrier = { version: string } & Record<Exclude<string, 'version'>, V8Carrier>;
+
+type WindowWithSentry = Window & {
+  __SENTRY__?: LegacyCarrier & VersionedCarrier;
+};
+
 /**
  * Takes care of injecting spotlight-specific behavior into the Sentry SDK by
  * accessing the global __SENTRY__ carrier object.
@@ -167,22 +174,11 @@ function addSpotlightIntegrationToSentry(options?: SentryIntegrationOptions) {
     return;
   }
 
-  const sentryGlobal =
-    // This is what we expect the v8-stable accessor to be
-    (window as WindowWithSentry).__SENTRY__?.acs?.getCurrentScope() ||
-    // This is the current accessor (v7 and v8-alpha)
-    (window as WindowWithSentry).__SENTRY__?.hub;
-
-  if (!sentryGlobal) {
-    log(
-      "Couldn't find the Sentry SDK on this page. If you're using a Sentry SDK, make sure you're using version >=7.99.0 or 8.x",
-    );
-    return;
-  }
+  const sentryCarrier = (window as WindowWithSentry).__SENTRY__;
+  const sentryClient = sentryCarrier && getSentryClient(sentryCarrier);
 
-  const sentryClient = sentryGlobal.getClient();
   if (!sentryClient) {
-    warn("Couldn't find a Sentry SDK client. Make sure you're using a Sentry SDK with version >=7.99.0 or 8.x");
+    log("Couldn't find a Sentry SDK client. Make sure you're using a Sentry SDK with version >=7.99.0 or 8.x");
     return;
   }
 
@@ -211,3 +207,30 @@ function addSpotlightIntegrationToSentry(options?: SentryIntegrationOptions) {
 
   log('Added Spotlight integration to Sentry SDK');
 }
+
+/**
+ * Accesses the `window.__SENTRY__` carrier object and tries to get the Sentry client
+ * from it. This function supports all carrier object structures from v7 to all versions
+ * of v8.
+ */
+function getSentryClient(sentryCarrier: LegacyCarrier & VersionedCarrier): Client | undefined {
+  // 8.6.0+ way to get the client
+  if (sentryCarrier.version) {
+    const versionedCarrier = sentryCarrier[sentryCarrier.version];
+    const scope =
+      typeof versionedCarrier?.stack?.getScope === 'function' ? versionedCarrier?.stack?.getScope?.() : undefined;
+    if (typeof scope?.getClient === 'function') {
+      return scope.getClient();
+    }
+  }
+
+  // pre-8.6.0 (+v7) way to get the client
+  if (sentryCarrier.hub) {
+    const hub = sentryCarrier.hub;
+    if (typeof hub.getClient === 'function') {
+      return hub.getClient();
+    }
+  }
+
+  return undefined;
+}