fix: Prevent extension errors from crashing Zigbee2MQTT #20477

lib/controller.ts

@@ -51,10 +51,7 @@ export class Controller {
 
     constructor(restartCallback: () => void, exitCallback: (code: number, restart: boolean) => void) {
         logger.init();
-        this.eventBus = new EventBus( /* istanbul ignore next */ (error) => {
-            logger.error(`Error: ${error.message}`);
-            logger.debug(error.stack);
-        });
+        this.eventBus = new EventBus();
         this.zigbee = new Zigbee(this.eventBus);
         this.mqtt = new MQTT(this.eventBus);
         this.state = new State(this.eventBus, this.zigbee);

lib/eventBus.ts

@@ -1,5 +1,5 @@
 import events from 'events';
-events.captureRejections = true;
+import logger from './util/logger';
 
 // eslint-disable-next-line
 type ListenerKey = object;
@@ -8,9 +8,8 @@ export default class EventBus {
     private callbacksByExtension: { [s: string]: { event: string, callback: (...args: unknown[]) => void }[] } = {};
     private emitter = new events.EventEmitter();
 
-    constructor(onError: (error: Error) => void) {
+    constructor() {
         this.emitter.setMaxListeners(100);
-        this.emitter.on('error', onError);
     }
 
     public emitAdapterDisconnected(): void {
@@ -163,9 +162,13 @@ export default class EventBus {
 
     private on(event: string, callback: (...args: unknown[]) => (Promise<void> | void), key: ListenerKey): void {
         if (!this.callbacksByExtension[key.constructor.name]) this.callbacksByExtension[key.constructor.name] = [];
-        const wrappedCallback = (...args: unknown[]): void => {
-            // Wrap callback as it may return a Promise which can throw an exception
-            Promise.resolve(callback(...args)).catch();
+        const wrappedCallback = async (...args: unknown[]): Promise<void> => {
+            try {
+                await callback(...args);
+            } catch (error) {
+                logger.error(`EventBus error '${key.constructor.name}/${event}': ${error.message}`);
+                logger.debug(error.stack);
+            }
         };
         this.callbacksByExtension[key.constructor.name].push({event, callback: wrappedCallback});
         this.emitter.on(event, wrappedCallback);

test/controller.test.js

@@ -730,4 +730,14 @@ describe('Controller', () => {
         await controller.stop();
         expect(controller.state.state[device.ieeeAddr]).toStrictEqual(undefined);
     });
+
+    it('EventBus should handle errors', async () => {
+        const eventbus = controller.eventBus;
+        const callback = jest.fn().mockImplementation(async () => {throw new Error('Whoops!')});
+        eventbus.onStateChange('test', callback);
+        eventbus.emitStateChange({});
+        await flushPromises();
+        expect(callback).toHaveBeenCalledTimes(1);
+        expect(logger.error).toHaveBeenCalledWith(`EventBus error 'String/stateChange': Whoops!`);
+    });
 });