Merge branch 'integration/typescript' into PLAT-13699-derecursify

Author: gingerbenw

packages/core/package.json

@@ -11,7 +11,6 @@
     },
     "./lib/es-utils/assign": "./src/lib/es-utils/assign.js",
     "./lib/es-utils/includes": "./src/lib/es-utils/includes.js",
-    "./lib/callback-runner": "./src/lib/callback-runner.js",
     "./lib/path-normalizer": "./src/lib/path-normalizer.js"
   },
   "description": "Core classes and utilities for Bugsnag notifiers",

packages/core/src/index.ts

@@ -12,6 +12,7 @@ export { default as extractObject } from './lib/extract-object'
 export { default as intRange } from './lib/validators/int-range'
 export { default as isError } from './lib/iserror'
 export { default as listOfFunctions } from './lib/validators/list-of-functions'
+export { default as runCallbacks } from "./lib/callback-runner";
 export { default as runSyncCallbacks } from './lib/sync-callback-runner'
 export { default as stringWithLength } from './lib/validators/string-with-length'
 

packages/core/src/lib/async-every.d.ts

@@ -1,3 +1,5 @@
+export type NodeCallbackType<T = any> = (error?: Error | null, result?: T) => void;
+
 // This is a heavily modified/simplified version of
 //   https://github.com/othiym23/async-some
 // with the logic flipped so that it is akin to the
@@ -9,7 +11,11 @@
 //   - or the end of the array is reached
 // the callback (cb) will be passed (null, false) if any of the items in arr
 // caused fn to call back with false, otherwise it will be passed (null, true)
-module.exports = (arr, fn, cb) => {
+const every = <T>(
+  arr: T[],
+  fn: (item: T, cb: NodeCallbackType) => void,
+  cb: NodeCallbackType<boolean>
+): void => {
   let index = 0
 
   const next = () => {
@@ -24,3 +30,5 @@ module.exports = (arr, fn, cb) => {
 
   next()
 }
+
+export default every

packages/core/src/lib/async-every.js packages/core/src/lib/async-every.tspackages/core/src/lib/async-every.js renamed to packages/core/src/lib/async-every.ts

@@ -1,12 +1,18 @@
-const some = require('./async-every')
+import every from './async-every'
+import type { NodeCallbackType } from './async-every'
 
-module.exports = (callbacks, event, onCallbackError, cb) => {
+const runCallbacks = <T>(
+  callbacks: any[],
+  event: T,
+  onCallbackError: (err: Error) => void,
+  cb: NodeCallbackType<boolean>
+): void => {
   // This function is how we support different kinds of callback:
   //  - synchronous - return value
   //  - node-style async with callback - cb(err, value)
   //  - promise/thenable - resolve(value)
   // It normalises each of these into the lowest common denominator – a node-style callback
-  const runMaybeAsyncCallback = (fn, cb) => {
+  const runMaybeAsyncCallback = (fn: any, cb: NodeCallbackType<boolean>) => {
     if (typeof fn !== 'function') return cb(null)
     try {
       // if function appears sync…
@@ -16,9 +22,9 @@ module.exports = (callbacks, event, onCallbackError, cb) => {
         if (ret && typeof ret.then === 'function') {
           return ret.then(
             // resolve
-            val => setTimeout(() => cb(null, val)),
+            (val: boolean | undefined ) => setTimeout(() => cb(null, val)),
             // reject
-            err => {
+            (err: Error) => {
               setTimeout(() => {
                 onCallbackError(err)
                 return cb(null, true)
@@ -29,18 +35,20 @@ module.exports = (callbacks, event, onCallbackError, cb) => {
         return cb(null, ret)
       }
       // if function is async…
-      fn(event, (err, result) => {
+      fn(event, (err: Error, result: any) => {
         if (err) {
           onCallbackError(err)
           return cb(null)
         }
         cb(null, result)
       })
-    } catch (e) {
+    } catch (e: any) {
       onCallbackError(e)
       cb(null)
     }
   }
 
-  some(callbacks, runMaybeAsyncCallback, cb)
+  return every(callbacks, runMaybeAsyncCallback, cb)
 }
+
+export default runCallbacks

packages/core/src/lib/callback-runner.d.ts

@@ -1,5 +1,4 @@
-const { Breadcrumb, Event, featureFlagDelegate } = require('@bugsnag/core')
-const runCallbacks = require('@bugsnag/core/lib/callback-runner')
+const { Breadcrumb, Event, featureFlagDelegate, runCallbacks } = require('@bugsnag/core')
 
 module.exports = class BugsnagIpcMain {
   constructor (client) {

packages/core/src/lib/callback-runner.js packages/core/src/lib/callback-runner.tspackages/core/src/lib/callback-runner.js renamed to packages/core/src/lib/callback-runner.ts

@@ -1,3 +1,4 @@
+import { Schema } from '../../core/dist/types/config'
 import BugsnagIpcMain from '../bugsnag-ipc-main'
 import { Client, User, Plugin, Event, FeatureFlag } from '@bugsnag/core'
 
@@ -14,17 +15,20 @@ const Notifier = {
   url: 'https://github.com/bugsnag/bugsnag-js'
 }
 
+// @ts-expect-error invalid schema expected for testing
+const testSchema: Schema = {}
+
 describe('BugsnagIpcMain', () => {
   describe('constructor()', () => {
     it('should throw if the state manager plugin is not loaded first', () => {
-      const client = new Client({ apiKey: '123' }, {}, [], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [], Notifier)
       expect(() => {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const bugsnagIpcMain = new BugsnagIpcMain(client)
       }).toThrowError('Expected @bugsnag/plugin-electron-client-state-manager to be loaded first')
     })
     it('should work when the state manager plugin is loaded first', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       expect(() => {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const bugsnagIpcMain = new BugsnagIpcMain(client)
@@ -34,15 +38,15 @@ describe('BugsnagIpcMain', () => {
 
   describe('handle()', () => {
     it('works for updating context', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.setContext = jest.fn()
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       bugsnagIpcMain.handle({}, 'setContext', JSON.stringify('new context'))
       expect(client.setContext).toHaveBeenCalledWith('new context')
     })
 
     it('returns the current context', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.setContext('today')
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       const event = { returnValue: undefined }
@@ -51,7 +55,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for updating user', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.setUser = jest.fn()
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       // all fields set
@@ -63,7 +67,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('returns the current user', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.setUser('81676', undefined, 'Cal')
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       const event = { returnValue: undefined }
@@ -72,7 +76,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for adding metadata', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.addMetadata = jest.fn()
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       const stubWebContents = { /* this would be a WebContents instance */ }
@@ -82,15 +86,15 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for removing metadata', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.clearMetadata = jest.fn()
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       bugsnagIpcMain.handle({}, 'clearMetadata', JSON.stringify('section'))
       expect(client.clearMetadata).toHaveBeenCalledWith('section')
     })
 
     it('returns metadata content', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.addMetadata('section', 'content', 'X')
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       const event = { returnValue: undefined }
@@ -104,7 +108,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for adding a single feature flag', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.addFeatureFlag = jest.fn()
 
       const bugsnagIpcMain = new BugsnagIpcMain(client)
@@ -116,7 +120,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for adding multiple feature flags', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.addFeatureFlags = jest.fn()
 
       const bugsnagIpcMain = new BugsnagIpcMain(client)
@@ -136,7 +140,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for clearing a single feature flag', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.clearFeatureFlag = jest.fn()
 
       const bugsnagIpcMain = new BugsnagIpcMain(client)
@@ -148,7 +152,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for clearing all feature flags', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.clearFeatureFlags = jest.fn()
 
       const bugsnagIpcMain = new BugsnagIpcMain(client)
@@ -160,7 +164,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for managing sessions', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client._sessionDelegate = { startSession: jest.fn(), resumeSession: jest.fn(), pauseSession: jest.fn() }
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       // start
@@ -175,7 +179,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for breadcrumbs', (done) => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       client.addOnBreadcrumb(b => {
         expect(b.message).toBe('hi IPC')
         expect(b.type).toBe('manual')
@@ -191,7 +195,7 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('works for bulk updates', done => {
-      const client = new Client({ apiKey: '123' }, {}, [{
+      const client = new Client({ apiKey: '123' }, testSchema, [{
         name: 'clientStateManager',
         load: () => ({
           bulkUpdate: ({ context, user, metadata, features }: { context?: string, user?: User, metadata: Record<string, unknown>, features: FeatureFlag | null[]}) => {
@@ -219,13 +223,13 @@ describe('BugsnagIpcMain', () => {
     })
 
     it('is resilient to unknown methods', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       expect(() => bugsnagIpcMain.handle({}, 'explodePlease', JSON.stringify({ data: 123 }))).not.toThrowError()
     })
 
     it('is resilient to bad JSON', () => {
-      const client = new Client({ apiKey: '123' }, {}, [mockClientStateManagerPlugin], Notifier)
+      const client = new Client({ apiKey: '123' }, testSchema, [mockClientStateManagerPlugin], Notifier)
       const bugsnagIpcMain = new BugsnagIpcMain(client)
       expect(() => bugsnagIpcMain.handle({}, 'leaveBreadcrumb', 'not json')).not.toThrowError()
     })