Merge pull request #2258 from bugsnag/PLAT-13089-plugin-browser-session

Refactor @bugsnag/plugin-browser-session
bugsnag · Dec 6, 2024 · c97ef7c · c97ef7c
2 parents 7bbbff9 + c438893
commit c97ef7c
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 19 deletions.
diff --git a/packages/core/client.d.ts b/packages/core/client.d.ts
@@ -24,14 +24,24 @@ interface SessionDeliveryPayload {
   notifier?: Notifier
   device?: Device
   app?: App
-  sessions?: Session[]
+  sessions?: Array<{
+    id: string
+    startedAt: Date
+    user?: User
+  }>
 }
 
 interface Delivery {
   sendEvent(payload: EventDeliveryPayload, cb: (err?: Error | null) => void): void
   sendSession(session: SessionDeliveryPayload, cb: (err?: Error | null) => void): void
 }
 
+export interface SessionDelegate {
+  startSession: (client: ClientWithInternals, session: Session) => ClientWithInternals
+  pauseSession: (client: ClientWithInternals) => void
+  resumeSession: (client: ClientWithInternals) => ClientWithInternals
+}
+
 /**
  * Extend the public type definitions with internal declarations.
  *
@@ -58,11 +68,7 @@ export default class ClientWithInternals<T extends Config = Config> extends Clie
   _session: Session | null
   _pausedSession: Session | null
 
-  _sessionDelegate: {
-    startSession: (client: ClientWithInternals, session: Session) => ClientWithInternals
-    pauseSession: (client: ClientWithInternals) => void
-    resumeSession: (client: ClientWithInternals) => ClientWithInternals
-  }
+  _sessionDelegate: SessionDelegate
 
   _addOnSessionPayload: (cb: (sessionPayload: Session) => void) => void
 

diff --git a/packages/plugin-browser-session/package.json b/packages/plugin-browser-session/package.json
@@ -1,7 +1,15 @@
 {
   "name": "@bugsnag/plugin-browser-session",
   "version": "8.1.1",
-  "main": "session.js",
+  "main": "dist/session.js",
+  "types": "dist/types/session.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/session.d.ts",
+      "default": "./dist/session.js",
+      "import": "./dist/session.mjs"
+    }
+  },
   "description": "@bugsnag/js plugin to enable session tracking in browsers",
   "homepage": "https://www.bugsnag.com/",
   "repository": {
@@ -12,7 +20,7 @@
     "access": "public"
   },
   "files": [
-    "*.js"
+    "dist"
   ],
   "author": "Bugsnag",
   "license": "MIT",
@@ -21,5 +29,10 @@
   },
   "peerDependencies": {
     "@bugsnag/core": "^8.0.0"
+  },
+  "scripts": {
+    "build": "npm run build:npm",
+    "build:npm": "rollup --config rollup.config.npm.mjs",
+    "clean": "rm -rf dist/*"
   }
 }
diff --git a/packages/plugin-browser-session/rollup.config.npm.mjs b/packages/plugin-browser-session/rollup.config.npm.mjs
@@ -0,0 +1,6 @@
+import createRollupConfig from "../../.rollup/index.mjs";
+
+export default createRollupConfig({
+  input: "src/session.ts",
+  external: ["@bugsnag/core/lib/es-utils/includes"]
+});
diff --git a/packages/plugin-browser-session/session.js → ...ges/plugin-browser-session/src/session.ts b/packages/plugin-browser-session/session.js → ...ges/plugin-browser-session/src/session.ts
@@ -1,17 +1,25 @@
-const includes = require('@bugsnag/core/lib/es-utils/includes')
+import { Plugin, Session } from '@bugsnag/core'
+import ClientWithInternals, { Notifier } from '@bugsnag/core/client'
+import includes from '@bugsnag/core/lib/es-utils/includes'
 
-module.exports = {
-  load: client => { client._sessionDelegate = sessionDelegate }
+interface InternalClient extends ClientWithInternals {
+  _notifier?: Notifier
+}
+
+const plugin: Plugin = {
+  load: client => {
+    (client as InternalClient)._sessionDelegate = sessionDelegate
+  }
 }
 
 const sessionDelegate = {
-  startSession: (client, session) => {
+  startSession: (client: InternalClient, session: Session) => {
     const sessionClient = client
     sessionClient._session = session
     sessionClient._pausedSession = null
 
     // exit early if the current releaseStage is not enabled
-    if (sessionClient._config.enabledReleaseStages !== null && !includes(sessionClient._config.enabledReleaseStages, sessionClient._config.releaseStage)) {
+    if (sessionClient._config.enabledReleaseStages && !includes(sessionClient._config.enabledReleaseStages, sessionClient._config.releaseStage)) {
       sessionClient._logger.warn('Session not sent due to releaseStage/enabledReleaseStages configuration')
       return sessionClient
     }
@@ -24,13 +32,13 @@ const sessionDelegate = {
         {
           id: session.id,
           startedAt: session.startedAt,
-          user: session._user
+          user: session.getUser()
         }
       ]
-    })
+    }, () => {})
     return sessionClient
   },
-  resumeSession: (client) => {
+  resumeSession: (client: InternalClient) => {
     // Do nothing if there's already an active session
     if (client._session) {
       return client
@@ -47,8 +55,10 @@ const sessionDelegate = {
     // Otherwise start a new session
     return client.startSession()
   },
-  pauseSession: (client) => {
+  pauseSession: (client: InternalClient) => {
     client._pausedSession = client._session
     client._session = null
   }
 }
+
+export default plugin
diff --git a/packages/plugin-browser-session/test/session.test.ts b/packages/plugin-browser-session/test/session.test.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import plugin from '../'
+import plugin from '../src/session'
 import Client, { EventDeliveryPayload } from '@bugsnag/core/client'
 import EventWithInternals from '@bugsnag/core/event'
 

diff --git a/packages/plugin-browser-session/tsconfig.json b/packages/plugin-browser-session/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*.ts"]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -82,7 +82,6 @@
     "packages/plugin-node-device",
     "packages/plugin-node-surrounding-code",
     "packages/plugin-node-uncaught-exception",
-    "packages/plugin-browser-session",
     "packages/browser"
   ],
   "exclude": [