feat: add support for sentry v8 (#92)

```js
import { fullStoryIntegration } from '@sentry/fullstory';

// ...

Sentry.init({
  dsn: '__DSN__',
  integrations: [
    fullStoryIntegration('__SENTRY_ORG_SLUG__', { client: FullStory }),
  ],
  // ...
});
```

Author: seanparmelee

.github/workflows/deploy-prep.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Cache node modules
         uses: actions/setup-node@v2
         with:
-          node-version: '12'
+          node-version: '18'
           cache: 'yarn'
 
       - name: Install node modules

package.json

@@ -24,12 +24,12 @@
   },
   "homepage": "https://github.com/getsentry/sentry-fullstory#readme",
   "peerDependencies": {
-    "@sentry/core": "4.x || 5.x || 6.x || 7.x"
+    "@sentry/core": "8.x"
   },
   "dependencies": {},
   "devDependencies": {
     "@babel/core": "^7.7.2",
-    "@sentry/types": "^7.18.0",
+    "@sentry/types": "^8.4.0",
     "rimraf": "^3.0.0",
     "rollup": "^1.26.3",
     "rollup-plugin-babel": "^4.3.3",

src/SentryFullStory.ts

@@ -1,7 +1,8 @@
-import type { EventProcessor, Hub, Integration } from '@sentry/types';
+import type { Integration } from '@sentry/types';
 import type { FullStoryClient } from './types';
 import {
   doesFullStoryExist,
+  getFullStoryUrl,
   getOriginalExceptionProperties,
   getSentryUrl,
 } from './util';
@@ -17,83 +18,56 @@ type Options = {
   baseSentryUrl?: string;
 };
 
-class SentryFullStory implements Integration {
-  public readonly name: string = SentryFullStory.id;
-  public static id: string = 'SentryFullStory';
-  sentryOrg: string;
-  baseSentryUrl: string;
-  client: FullStoryClient;
-
-  constructor(sentryOrg: string, options: Options) {
-    this.sentryOrg = sentryOrg;
-    this.client = options.client;
-    this.baseSentryUrl = options.baseSentryUrl || 'https://sentry.io';
-  }
-
-  getFullStoryUrl = (): Promise<string> | string => {
-    // getCurrentSessionURL isn't available until after the FullStory script is fully bootstrapped.
-    // If an error occurs before getCurrentSessionURL is ready, make a note in Sentry and move on.
-    // More on getCurrentSessionURL here: https://help.fullstory.com/develop-js/getcurrentsessionurl
-    try {
-      const res = this.client.getCurrentSessionURL?.(true);
-      if (!res) {
-        throw new Error('No FullStory session URL found');
-      }
-
-      return res;
-    } catch (e) {
-      const reason = e instanceof Error ? e.message : String(e);
-      throw new Error(`Unable to get url: ${reason}`);
-    }
-  };
+const INTEGRATION_NAME = 'SentryFullStory';
 
-  setupOnce(
-    addGlobalEventProcessor: (callback: EventProcessor) => void,
-    getCurrentHub: () => Hub
-  ) {
-    let fullStoryUrl: string | undefined;
+export function fullStoryIntegration(
+  sentryOrg: string,
+  options: Options
+): Integration {
+  const fullStoryClient = options.client;
+  const baseSentryUrl = options.baseSentryUrl || 'https://sentry.io';
+  let fullStoryUrl: string | undefined;
 
-    addGlobalEventProcessor(async (event, hint) => {
-      const hub = getCurrentHub();
-      const self = hub.getIntegration(SentryFullStory);
+  return {
+    name: INTEGRATION_NAME,
+    async processEvent(event, hint, client) {
+      const self = client.getIntegrationByName(INTEGRATION_NAME);
       // Run the integration ONLY when it was installed on the current Hub AND isn't a transaction
-      if (self && event.type !== 'transaction' && doesFullStoryExist()) {
+      if (self && event.type === undefined && doesFullStoryExist()) {
         if (!fullStoryUrl) {
           try {
-            fullStoryUrl = await this.getFullStoryUrl();
+            fullStoryUrl = await getFullStoryUrl(fullStoryClient);
           } catch (e) {
             const reason = e instanceof Error ? e.message : String(e);
             console.error(`Unable to get FullStory session URL: ${reason}`);
           }
         }
+      }
 
-        if (fullStoryUrl) {
-          event.contexts = {
-            ...event.contexts,
-            fullStory: {
-              fullStoryUrl,
-            },
-          };
-        }
+      if (fullStoryUrl) {
+        event.contexts = {
+          ...event.contexts,
+          fullStory: {
+            fullStoryUrl,
+          },
+        };
+      }
 
-        try {
-          this.client.event('Sentry Error', {
-            sentryUrl: getSentryUrl({
-              baseSentryUrl: this.baseSentryUrl,
-              sentryOrg: this.sentryOrg,
-              hint,
-              hub,
-            }),
-            ...getOriginalExceptionProperties(hint),
-          });
-        } catch (e) {
-          console.debug('Unable to report sentry error details to FullStory');
-        }
+      try {
+        fullStoryClient.event('Sentry Error', {
+          sentryUrl: getSentryUrl({
+            baseSentryUrl: baseSentryUrl,
+            sentryOrg,
+            hint,
+            client,
+          }),
+          ...getOriginalExceptionProperties(hint),
+        });
+      } catch (e) {
+        console.debug('Unable to report sentry error details to FullStory');
       }
 
       return event;
-    });
-  }
+    },
+  };
 }
-
-export default SentryFullStory;

src/index.ts

@@ -1,3 +1 @@
-import SentryFullStory from './SentryFullStory';
-
-export default SentryFullStory;
+export { fullStoryIntegration } from './SentryFullStory';

src/util.ts

@@ -1,4 +1,5 @@
-import type { EventHint, Hub } from '@sentry/types';
+import type { Client, EventHint } from '@sentry/types';
+import { FullStoryClient } from './types';
 
 /**
  * Returns true if Fullstory is installed correctly.
@@ -15,7 +16,7 @@ export const getProjectIdFromSentryDsn = (dsn: string) => {
   return new URL(dsn).pathname.replace('/', '');
 };
 
-const isError = (exception: string | Error): exception is Error => {
+const isError = (exception: unknown): exception is Error => {
   return (exception as Error).message !== undefined;
 };
 
@@ -41,16 +42,16 @@ export function getSentryUrl({
   hint,
   sentryOrg,
   baseSentryUrl,
-  hub,
+  client,
 }: {
   hint?: EventHint;
   sentryOrg: string;
   baseSentryUrl: string;
-  hub: Hub;
+  client: Client;
 }) {
   try {
     // No docs on this but the SDK team assures me it works unless you bind another Sentry client
-    const { dsn } = hub.getClient()?.getOptions() || {};
+    const { dsn } = client.getOptions();
     if (!dsn) {
       console.error('No sn');
       return 'Could not retrieve url';
@@ -67,3 +68,22 @@ export function getSentryUrl({
     return 'Could not retrieve url';
   }
 }
+
+export function getFullStoryUrl(
+  fullStoryClient: FullStoryClient
+): Promise<string> | string {
+  // getCurrentSessionURL isn't available until after the FullStory script is fully bootstrapped.
+  // If an error occurs before getCurrentSessionURL is ready, make a note in Sentry and move on.
+  // More on getCurrentSessionURL here: https://help.fullstory.com/develop-js/getcurrentsessionurl
+  try {
+    const res = fullStoryClient.getCurrentSessionURL?.(true);
+    if (!res) {
+      throw new Error('No FullStory session URL found');
+    }
+
+    return res;
+  } catch (e) {
+    const reason = e instanceof Error ? e.message : String(e);
+    throw new Error(`Unable to get url: ${reason}`);
+  }
+}

yarn.lock

@@ -134,10 +134,10 @@
     lodash "^4.17.13"
     to-fast-properties "^2.0.0"
 
-"@sentry/types@^7.18.0":
-  version "7.18.0"
-  resolved "https://registry.yarnpkg.com/@sentry/types/-/types-7.18.0.tgz#8b0eacd19cc9bcd1f14ca5dcaf7065ebd3186632"
-  integrity sha512-bOnyoK1S1chPJ+dAeWJo0srxZ9U48WE5dZFtvKeXoog6JNHY3nqAR/P/uxh9djB4bbwQRMdnGk1zm0bxhOOC6w==
+"@sentry/types@^8.4.0":
+  version "8.4.0"
+  resolved "https://registry.yarnpkg.com/@sentry/types/-/types-8.4.0.tgz#42500005a198ff8c247490434ed55e0a9f975ad1"
+  integrity sha512-mHUaaYEQCNukzYsTLp4rP2NNO17vUf+oSGS6qmhrsGqmGNICKw2CIwJlPPGeAkq9Y4tiUOye2m5OT1xsOtxLIw==
 
 "@types/estree@*":
   version "0.0.39"