refactor web-worker package

Author: gingerbenw

dockerfiles/Dockerfile.node

@@ -1,30 +1,33 @@
 # CI test image for unit/lint/type tests
-FROM node:18-alpine@sha256:974afb6cbc0314dc6502b14243b8a39fbb2d04d975e9059dd066be3e274fbb25 as node-feature-builder
+FROM node:18-alpine@sha256:974afb6cbc0314dc6502b14243b8a39fbb2d04d975e9059dd066be3e274fbb25 AS node-feature-builder
 
 RUN apk add --update bash python3 make gcc g++ musl-dev xvfb-run curl
 
 WORKDIR /app
 
 COPY package*.json ./
-COPY babel.config.js lerna.json .eslintignore .eslintrc.js jest.config.js tsconfig.json ./
+COPY babel.config.js lerna.json eslint.config.mjs jest.config.js tsconfig.json ./
 COPY jest ./jest
 ADD min_packages.tar .
+COPY .rollup ./.rollup
 COPY bin ./bin
 COPY packages ./packages
 
 RUN npm ci
+
 RUN npm run build
 
+RUN npm pack --verbose packages/core/
 RUN npm pack --verbose packages/node/
+RUN npm pack --verbose packages/path-normalizer/
 RUN npm pack --verbose packages/plugin-express/
 RUN npm pack --verbose packages/plugin-koa/
 RUN npm pack --verbose packages/plugin-restify/
 RUN npm pack --verbose packages/plugin-hono/
 
 # The maze-runner node tests
-FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner-releases:latest-v9-cli as node-maze-runner
+FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner-releases:latest-v9-cli AS node-maze-runner
 WORKDIR /app/
-COPY packages/node/ .
 COPY test/node/features test/node/features
 COPY --from=node-feature-builder /app/*.tgz ./
 RUN for d in test/node/features/fixtures/*/; do cp /app/*.tgz "$d"; done

packages/web-worker/babel.config.js

@@ -0,0 +1,3 @@
+const babelConfig = require('../../babel.config.js')
+
+module.exports = babelConfig

packages/web-worker/esm.config.js

@@ -3,9 +3,16 @@
     "version": "8.4.0",
     "description": "BugSnag error reporter for JavaScript web workers and service workers",
     "homepage": "https://www.bugsnag.com/",
-    "main": "dist/bugsnag.web-worker.js",
-    "module": "dist/bugsnag.web-worker.js",
-    "types": "types/notifier.ts",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/types/index.d.ts",
+            "import": "./dist/index.js",
+            "default": "./dist/index.js"
+        }
+    },
     "repository": {
         "type": "git",
         "url": "git@github.com:bugsnag/bugsnag-js.git"
@@ -14,8 +21,7 @@
         "access": "public"
     },
     "files": [
-        "dist",
-        "types"
+        "dist"
     ],
     "keywords": [
         "worker",
@@ -28,11 +34,8 @@
     ],
     "scripts": {
         "clean": "rm -fr dist && mkdir dist",
-        "build": "npm run clean && npm run build:dist && npm run build:dist:min",
-        "build:dist": "webpack",
-        "build:dist:min": "webpack --optimization-minimize --output-filename=bugsnag.web-worker.min.js",
-        "build:dist:esm": "webpack --config esm.config.js",
-        "build:dist:esm.min": "webpack --config esm.config.js --optimization-minimize --output-filename=bugsnag.web-worker.min.mjs",
+        "build": "npm run clean && npm run build:npm",
+        "build:npm": "rollup --config rollup.config.npm.mjs",
         "size": "../../bin/size dist/bugsnag.web-worker.min.js",
         "cdn-upload": "../../bin/cdn-upload dist/*"
     },
@@ -46,9 +49,18 @@
         "@bugsnag/plugin-client-ip": "^8.4.0",
         "@bugsnag/plugin-window-onerror": "^8.4.0",
         "@bugsnag/plugin-window-unhandled-rejection": "^8.4.0",
+        "@rollup/plugin-babel": "^6.0.4",
+        "@rollup/plugin-commonjs": "^28.0.2",
+        "@rollup/plugin-node-resolve": "^16.0.0",
+        "@rollup/plugin-replace": "^6.0.2",
+        "@rollup/plugin-terser": "^0.4.4",
+        "rollup": "^4.31.0",
         "ts-loader": "^9.4.1",
         "typescript": "^4.9.3",
-        "webpack": "^5.75.0",
-        "webpack-cli": "^5.0.0"
+        "webpack-cli": "^5.0.0",
+        "webpack": "^5.75.0"
+    },
+    "dependencies": {
+        "@bugsnag/core": "^8.1.1"
     }
 }

packages/web-worker/package.json

@@ -0,0 +1,69 @@
+import babel from '@rollup/plugin-babel'
+import commonjs from '@rollup/plugin-commonjs'
+import nodeResolve from '@rollup/plugin-node-resolve'
+import replace from '@rollup/plugin-replace'
+import terser from '@rollup/plugin-terser'
+import typescript from '@rollup/plugin-typescript'
+import fs from 'fs'
+
+import createRollupConfig, { sharedOutput } from '../../.rollup/index.mjs'
+
+const packageJson = JSON.parse(fs.readFileSync('./package.json'))
+
+const plugins = [
+  nodeResolve({
+    browser: true
+  }),
+  commonjs(),
+  typescript({
+    removeComments: true,
+    // don't output anything if there's a TS error
+    noEmitOnError: true,
+    compilerOptions: {
+      target: 'es2015'
+    }
+  }),
+  babel({ babelHelpers: 'bundled' }),
+  replace({
+    preventAssignment: true,
+    values: {
+      'process.env.NODE_ENV': JSON.stringify('production'),
+      __BUGSNAG_NOTIFIER_VERSION__: packageJson.version,
+    }
+  })
+]
+
+export default [
+  createRollupConfig({
+    input: 'src/index.ts',
+    output: [
+      {
+        ...sharedOutput,
+        preserveModules: false,
+        entryFileNames: '[name].js',
+        format: 'esm'
+      }
+    ],
+    plugins
+  }),
+  createRollupConfig({
+    input: 'src/index-umd.ts',
+    output: [
+      {
+        ...sharedOutput,
+        entryFileNames: 'bugsnag.web-worker.js',
+        format: 'umd',
+        name: 'Bugsnag'
+      },
+      {
+        ...sharedOutput,
+        entryFileNames: 'bugsnag.web-worker.min.js',
+        format: 'umd',
+        compact: true,
+        name: 'Bugsnag',
+        plugins: [terser()]
+      }
+    ],
+    plugins
+  })
+]

packages/web-worker/rollup.config.npm.mjs

@@ -0,0 +1,100 @@
+/* eslint-env worker, serviceworker */
+
+import delivery from '@bugsnag/delivery-fetch'
+import pluginClientIp from '@bugsnag/plugin-client-ip'
+import pluginWindowOnError from '@bugsnag/plugin-window-onerror'
+import pluginWindowUnhandledRejection from '@bugsnag/plugin-window-unhandled-rejection'
+
+// extend the base config schema with some browser-specific options
+import workerConfig from './config'
+import pluginBrowserDevice from '@bugsnag/plugin-browser-device'
+import pluginBrowserSession from '@bugsnag/plugin-browser-session'
+import pluginPreventDiscard from './prevent-discard'
+import { Client, Config, BugsnagStatic, schema as baseConfig } from '@bugsnag/core'
+
+
+export interface WorkerConfig extends Config {
+  collectUserIp?: boolean
+  generateAnonymousId?: boolean
+}
+
+export interface WorkerBugsnagStatic extends BugsnagStatic {
+  start(apiKeyOrOpts: string | WorkerConfig): Client
+  createClient(apiKeyOrOpts: string | WorkerConfig): Client
+}
+
+const name = 'Bugsnag Web Worker'
+const url = 'https://github.com/bugsnag/bugsnag-js'
+const version = '__BUGSNAG_NOTIFIER_VERSION__'
+
+// extend the base config schema with some worker-specific options
+const schema = Object.assign({}, baseConfig, workerConfig)
+
+type WorkerClient = Partial<Client> & {
+  _client: Client | null
+  createClient: (opts?: Config) => Client
+  start: (opts?: Config) => Client
+  isStarted: () => boolean
+}
+
+const notifier: WorkerClient = {
+  _client: null,
+  // @ts-expect-error
+  createClient: (opts) => {
+    // handle very simple use case where user supplies just the api key as a string
+    if (typeof opts === 'string') opts = { apiKey: opts }
+    if (!opts) opts = {} as unknown as Config
+
+    const internalPlugins = [
+      pluginBrowserDevice(navigator, null),
+      pluginBrowserSession,
+      pluginClientIp,
+      pluginPreventDiscard,
+      pluginWindowOnError(self, 'worker onerror'),
+      pluginWindowUnhandledRejection(self)
+    ]
+
+    // configure a client with user supplied options
+    const bugsnag = new Client(opts, schema, internalPlugins, { name, version, url })
+
+    bugsnag._setDelivery(client => delivery(client, self.fetch, self))
+
+    bugsnag._logger.debug('Loaded!')
+
+    return bugsnag._config.autoTrackSessions
+      ? bugsnag.startSession()
+      : bugsnag
+  },
+  start: (opts) => {
+    if (notifier._client) {
+      notifier._client._logger.warn('Bugsnag.start() was called more than once. Ignoring.')
+      return notifier._client
+    }
+    notifier._client = notifier.createClient(opts)
+    return notifier._client
+  },
+  isStarted: () => {
+    return notifier._client != null
+  }
+}
+
+;
+// Add client functions to notifier
+(Object.getOwnPropertyNames(Client.prototype)).forEach(method => {
+  // skip private methods
+  if (/^_/.test(method) || method === 'constructor') return
+  // @ts-expect-error
+  notifier[method] = function () {
+    if (!notifier._client) return console.log(`Bugsnag.${method}() was called before Bugsnag.start()`)
+    notifier._client._depth += 1
+    // @ts-expect-error
+    const ret = notifier._client[method].apply(notifier._client, arguments)
+    notifier._client._depth -= 1
+    return ret
+  }
+})
+
+// @ts-expect-error
+const Bugsnag = notifier as WorkerBugsnagStatic
+
+export default Bugsnag

packages/web-worker/src/bugsnag.ts

@@ -0,0 +1,26 @@
+/* eslint-env worker, serviceworker */
+
+import { schema } from '@bugsnag/core'
+
+import getPrefixedConsole from './get-prefixed-console'
+
+export default {
+  appType: {
+    ...schema.appType,
+    defaultValue: () => 'workerjs'
+  },
+  logger: Object.assign({}, schema.logger, {
+    defaultValue: () =>
+      (typeof console !== 'undefined' && typeof console.debug === 'function')
+        ? getPrefixedConsole()
+        : undefined
+  }),
+  autoTrackSessions: {
+    ...schema.autoTrackSessions,
+    defaultValue: () => false
+  },
+  autoDetectErrors: {
+    ...schema.autoTrackSessions,
+    defaultValue: () => false
+  }
+}

packages/web-worker/src/config.js

@@ -0,0 +1,16 @@
+type LoggerMethod = 'debug' | 'info' | 'warn' | 'error'
+
+const getPrefixedConsole = () => {
+  const logger: Record<string, unknown> = {}
+  const consoleLog = console.log
+  const loggerMethods = ['debug', 'info', 'warn', 'error'] as const
+  loggerMethods.map((method: LoggerMethod) => {
+    const consoleMethod = console[method]
+    logger[method] = typeof consoleMethod === 'function'
+      ? consoleMethod.bind(console, '[bugsnag]')
+      : consoleLog.bind(console, '[bugsnag]')
+  })
+  return logger
+}
+
+export default getPrefixedConsole