Skip to content

Commit 35c4f73

Browse files
subzero10subzero10
authored
feat: flush events on process exit (#1430)
1 parent c598260 commit 35c4f73

13 files changed

+331
-6
lines changed

‎packages/core/src/client.ts

+8
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,14 @@ export abstract class Client {
325325
})
326326
}
327327

328+
/**
329+
* This method currently flushes the event (Insights) queue.
330+
* In the future, it should also flush the error queue (assuming an error throttler is implemented).
331+
*/
332+
flushAsync(): Promise<void> {
333+
return this.__eventsLogger.flushAsync();
334+
}
335+
328336
__getBreadcrumbs() {
329337
return this.__store.getContents('breadcrumbs').slice()
330338
}

‎packages/core/src/throttled_events_logger.ts

+18-4
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,19 @@ export class ThrottledEventsLogger implements EventsLogger {
3030
}
3131
}
3232

33+
flushAsync(): Promise<void> {
34+
this.logger.debug('[Honeybadger] Flushing events')
35+
return this.send();
36+
}
37+
3338
private processQueue() {
3439
if (this.queue.length === 0 || this.isProcessing) {
3540
return
3641
}
3742

3843
this.isProcessing = true
39-
const eventsData = this.queue.slice()
40-
this.queue = []
4144

42-
const data = NdJson.stringify(eventsData)
43-
this.makeHttpRequest(data)
45+
this.send()
4446
.then(() => {
4547
setTimeout(() => {
4648
this.isProcessing = false
@@ -57,6 +59,18 @@ export class ThrottledEventsLogger implements EventsLogger {
5759
})
5860
}
5961

62+
private async send(): Promise<void> {
63+
if (this.queue.length === 0) {
64+
return;
65+
}
66+
67+
const eventsData = this.queue.slice()
68+
this.queue = []
69+
70+
const data = NdJson.stringify(eventsData)
71+
return this.makeHttpRequest(data)
72+
}
73+
6074
private async makeHttpRequest(data: string): Promise<void> {
6175
return this.transport
6276
.send({

‎packages/core/src/types.ts

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ export interface Logger {
1111
export interface EventsLogger {
1212
configure: (opts: Partial<Config>) => void
1313
log(data: EventPayload): void
14+
flushAsync(): Promise<void>
1415
}
1516

1617
export type EventPayload = {

‎packages/js/src/server.ts

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { Client, Util, Types, Plugins as CorePlugins } from '@honeybadger-io/cor
44
import { getSourceFile, readConfigFromFileSystem } from './server/util'
55
import uncaughtException from './server/integrations/uncaught_exception_plugin'
66
import unhandledRejection from './server/integrations/unhandled_rejection_plugin'
7+
import shutdown from './server/integrations/shutdown_plugin'
78
import { errorHandler, requestHandler } from './server/middleware'
89
import { lambdaHandler } from './server/aws_lambda'
910
import { ServerTransport } from './server/transport'
@@ -15,6 +16,7 @@ const { endpoint } = Util
1516
const DEFAULT_PLUGINS = [
1617
uncaughtException(),
1718
unhandledRejection(),
19+
shutdown(),
1820
CorePlugins.events(),
1921
]
2022

‎packages/js/src/server/integrations/shutdown_monitor.ts

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
import Client from '../../server'
2+
import { fatallyLogAndExitGracefully } from '../util'
3+
4+
export default class ShutdownMonitor {
5+
6+
// SIGTERM is raised by AWS Lambda when the function is being shut down
7+
// SIGINT is raised by the user pressing CTRL+C
8+
private static KILL_SIGNALS = ['SIGTERM', 'SIGINT'] as const
9+
10+
protected __isReporting: boolean
11+
protected __client: typeof Client
12+
protected __listener: (signal: string) => void
13+
14+
constructor() {
15+
this.__isReporting = false
16+
this.__listener = this.makeListener()
17+
}
18+
19+
setClient(client: typeof Client) {
20+
this.__client = client
21+
}
22+
23+
makeListener() {
24+
// noinspection UnnecessaryLocalVariableJS
25+
const honeybadgerShutdownListener = async (signal: NodeJS.Signals) => {
26+
if (this.__isReporting || !this.__client) {
27+
return
28+
}
29+
30+
this.__isReporting = true
31+
32+
await this.__client.flushAsync()
33+
34+
this.__isReporting = false
35+
36+
if (!this.hasOtherShutdownListeners(signal)) {
37+
fatallyLogAndExitGracefully(signal)
38+
}
39+
}
40+
41+
return honeybadgerShutdownListener
42+
}
43+
44+
maybeAddListener() {
45+
for (const signal of ShutdownMonitor.KILL_SIGNALS) {
46+
const signalListeners = process.listeners(signal);
47+
if (!signalListeners.includes(this.__listener)) {
48+
process.on(signal, this.__listener)
49+
}
50+
}
51+
}
52+
53+
maybeRemoveListener() {
54+
for (const signal of ShutdownMonitor.KILL_SIGNALS) {
55+
const signalListeners = process.listeners(signal);
56+
if (signalListeners.includes(this.__listener)) {
57+
process.removeListener(signal, this.__listener)
58+
}
59+
}
60+
}
61+
62+
hasOtherShutdownListeners(signal: NodeJS.Signals) {
63+
const otherListeners = process
64+
.listeners(signal)
65+
.filter(listener => listener !== this.__listener)
66+
67+
return otherListeners.length > 0;
68+
69+
}
70+
}

‎packages/js/src/server/integrations/shutdown_plugin.ts

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { Types } from '@honeybadger-io/core'
2+
import Client from '../../server'
3+
import ShutdownMonitor from './shutdown_monitor'
4+
5+
const shutdownMonitor = new ShutdownMonitor()
6+
7+
export default function (): Types.Plugin {
8+
return {
9+
load: (client: typeof Client) => {
10+
shutdownMonitor.setClient(client)
11+
// at the moment, the shutdown monitor only sends events from the queue
12+
// if we implement a queue for throttling errors, we won't have to check for `config.eventsEnabled`
13+
if (client.config.eventsEnabled) {
14+
shutdownMonitor.maybeAddListener()
15+
} else {
16+
shutdownMonitor.maybeRemoveListener()
17+
}
18+
},
19+
shouldReloadOnConfigure: true,
20+
}
21+
}

‎packages/js/src/server/integrations/uncaught_exception_monitor.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ export default class UncaughtExceptionMonitor {
2020
}
2121

2222
makeListener() {
23+
// noinspection UnnecessaryLocalVariableJS
2324
const honeybadgerUncaughtExceptionListener = (uncaughtError: Error) => {
2425
if (this.__isReporting || !this.__client) { return }
2526

‎packages/js/src/server/integrations/unhandled_rejection_monitor.ts

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ export default class UnhandledRejectionMonitor {
1717
}
1818

1919
makeListener() {
20+
// noinspection UnnecessaryLocalVariableJS
2021
const honeybadgerUnhandledRejectionListener = (reason: unknown, _promise: Promise<unknown>) => {
2122
this.__isReporting = true;
2223
this.__client.notify(reason as Types.Noticeable, { component: 'unhandledRejection' }, {

‎packages/js/src/server/util.ts

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ import { promisify } from 'util'
66

77
const readFile = promisify(fs.readFile)
88

9+
export function fatallyLogAndExitGracefully(signal: NodeJS.Signals): never {
10+
console.log(`[Honeybadger] Received ${signal}, exiting immediately`)
11+
process.exit()
12+
}
13+
914
export function fatallyLogAndExit(err: Error, source: string): never {
1015
console.error(`[Honeybadger] Exiting process due to ${source}`)
1116
console.error(err.stack || err)

‎packages/js/test/e2e/playwright.config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export default defineConfig({
1515
forbidOnly: !!process.env.CI,
1616
/* Retry on CI only */
1717
retries: process.env.CI ? 2 : 0,
18-
workers: 8,
18+
workers: 4,
1919
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
2020
reporter: [
2121
[process.env.CI ? 'github' : 'list'],

‎packages/js/test/unit/server.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ describe('server client', function () {
409409
describe('__plugins', function () {
410410
it('exported singleton includes plugins', function () {
411411
Singleton.configure({ apiKey: 'foo' })
412-
expect(Singleton.config.__plugins.length).toBe(3)
412+
expect(Singleton.config.__plugins.length).toBe(4)
413413
})
414414

415415
it('clients produced via factory don\'t include plugins', function () {

‎packages/js/test/unit/server/integrations/shutdown_monitor.server.test.ts

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
import { TestTransport, TestClient, nullLogger } from '../../helpers'
2+
import * as util from '../../../../src/server/util'
3+
import Singleton from '../../../../src/server'
4+
import ShutdownMonitor from '../../../../src/server/integrations/shutdown_monitor'
5+
6+
describe('ShutdownMonitor', () => {
7+
// Using any rather than the real type so we can test and spy on private methods
8+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
9+
let shutdownMonitor: any
10+
let client: typeof Singleton
11+
let fatallyLogAndExitGracefullySpy: jest.SpyInstance
12+
let flushSpy: jest.SpyInstance
13+
14+
beforeEach(() => {
15+
// We just need a really basic client, so ignoring type issues here
16+
client = new TestClient(
17+
{ apiKey: 'testKey', afterUncaught: jest.fn(), logger: nullLogger() },
18+
new TestTransport()
19+
) as unknown as typeof Singleton
20+
shutdownMonitor = new ShutdownMonitor()
21+
shutdownMonitor.setClient(client)
22+
// Have to mock fatallyLogAndExit or we will crash the test
23+
fatallyLogAndExitGracefullySpy = jest
24+
.spyOn(util, 'fatallyLogAndExitGracefully')
25+
.mockImplementation(() => true as never)
26+
flushSpy = jest.spyOn(client, 'flushAsync')
27+
})
28+
29+
afterEach(() => {
30+
jest.clearAllMocks()
31+
process.removeAllListeners('SIGTERM')
32+
process.removeAllListeners('SIGINT')
33+
shutdownMonitor.__isReporting = false
34+
shutdownMonitor.__handlerAlreadyCalled = false
35+
})
36+
37+
describe('constructor', () => {
38+
it('sets variables', () => {
39+
// Using any rather than the real type so we can test and spy on private methods
40+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
41+
const newMonitor = new ShutdownMonitor() as any
42+
expect(newMonitor.__isReporting).toBe(false)
43+
expect(newMonitor.__listener).toStrictEqual(expect.any(Function))
44+
expect(newMonitor.__listener.name).toBe('honeybadgerShutdownListener')
45+
})
46+
})
47+
48+
describe('maybeAddListener', () => {
49+
it('adds our listener a maximum of one time', () => {
50+
expect(process.listeners('SIGINT')).toHaveLength(0)
51+
expect(process.listeners('SIGTERM')).toHaveLength(0)
52+
53+
// Adds our listener
54+
shutdownMonitor.maybeAddListener()
55+
expect(process.listeners('SIGINT')).toHaveLength(1)
56+
expect(process.listeners('SIGTERM')).toHaveLength(1)
57+
58+
// Doesn't add a duplicate
59+
shutdownMonitor.maybeAddListener()
60+
expect(process.listeners('SIGINT')).toHaveLength(1)
61+
expect(process.listeners('SIGTERM')).toHaveLength(1)
62+
})
63+
})
64+
65+
describe('maybeRemoveListener', () => {
66+
it('removes our listener if it is present', () => {
67+
shutdownMonitor.maybeAddListener()
68+
process.on('SIGINT', (signal) => { console.log(signal) })
69+
process.on('SIGTERM', (signal) => { console.log(signal) })
70+
expect(process.listeners('SIGINT')).toHaveLength(2)
71+
expect(process.listeners('SIGTERM')).toHaveLength(2)
72+
73+
shutdownMonitor.maybeRemoveListener()
74+
expect(process.listeners('SIGINT')).toHaveLength(1)
75+
expect(process.listeners('SIGTERM')).toHaveLength(1)
76+
})
77+
78+
it('does nothing if our listener is not present', () => {
79+
process.on('SIGINT', (signal) => { console.log(signal) })
80+
process.on('SIGTERM', (signal) => { console.log(signal) })
81+
expect(process.listeners('SIGINT')).toHaveLength(1)
82+
expect(process.listeners('SIGTERM')).toHaveLength(1)
83+
84+
shutdownMonitor.maybeRemoveListener()
85+
expect(process.listeners('SIGINT')).toHaveLength(1)
86+
expect(process.listeners('SIGTERM')).toHaveLength(1)
87+
})
88+
})
89+
90+
describe('__listener', () => {
91+
it('calls flushAsync and fatallyLogAndExitGracefully', (done) => {
92+
shutdownMonitor.__listener('SIGINT')
93+
expect(flushSpy).toHaveBeenCalledTimes(1)
94+
setTimeout(() => {
95+
expect(fatallyLogAndExitGracefullySpy).toHaveBeenCalledWith('SIGINT')
96+
done()
97+
}, 10)
98+
})
99+
100+
it('returns if it is already reporting', () => {
101+
shutdownMonitor.__isReporting = true
102+
shutdownMonitor.__listener('SIGINT')
103+
expect(flushSpy).not.toHaveBeenCalled()
104+
expect(fatallyLogAndExitGracefullySpy).not.toHaveBeenCalled()
105+
})
106+
})
107+
108+
describe('hasOtherShutdownListeners', () => {
109+
it('returns true if there are user-added listeners', () => {
110+
shutdownMonitor.maybeAddListener()
111+
process.on('SIGINT', function userAddedListener() {
112+
return
113+
})
114+
expect(shutdownMonitor.hasOtherShutdownListeners('SIGINT')).toBe(true)
115+
})
116+
117+
it('returns false if there are only our expected listeners', () => {
118+
shutdownMonitor.maybeAddListener()
119+
expect(shutdownMonitor.hasOtherShutdownListeners()).toBe(false)
120+
})
121+
})
122+
})

0 commit comments

Comments
 (0)