fix: Use error handler for event class (#1018)

zachowj · Aug 3, 2023 · b009362 · b009362
1 parent 3f31af6
commit b009362
Show file tree

Hide file tree

Showing 16 changed files with 77 additions and 93 deletions.
diff --git a/src/common/events/ClientEvents.ts b/src/common/events/ClientEvents.ts
@@ -1,63 +1,17 @@
 import EventEmitter from 'events';
-import Joi from 'joi';
 import { Node } from 'node-red';
 
-import { RED } from '../../globals';
 import { ClientEvent } from '../../homeAssistant/Websocket';
-import BaseError from '../errors/BaseError';
-import Status from '../status/Status';
-import Events, { EventHandler } from './Events';
+import Events from './Events';
 
 export default class ClientEvents extends Events {
-    #status?: Status;
-
     constructor({ node, emitter }: { node: Node; emitter: EventEmitter }) {
         super({ node, emitter });
 
         this.emitter.on(ClientEvent.Error, this.onHaEventsError.bind(this));
     }
 
-    addListener(
-        event: string | symbol,
-        handler: EventHandler,
-        options = { once: false }
-    ): void {
-        super.addListener(event, this.#errorHandler(handler), options);
-    }
-
     onHaEventsError(err: Error) {
         if (err?.message) this.node.error(err.message);
     }
-
-    // set status for error reporting
-    setStatus(status: Status) {
-        this.#status = status;
-    }
-
-    #errorHandler(callback: any) {
-        return (...args: any) => {
-            try {
-                // eslint-disable-next-line n/no-callback-literal
-                callback(...args);
-            } catch (e) {
-                let statusMessage = RED._('home-assistant.status.error');
-                if (e instanceof Joi.ValidationError) {
-                    statusMessage = RED._(
-                        'home-assistant.status.validation_error'
-                    );
-                    this.node.error(e);
-                } else if (e instanceof BaseError) {
-                    statusMessage = e.statusMessage;
-                    this.node.error(e);
-                } else if (e instanceof Error) {
-                    this.node.error(e);
-                } else if (typeof e === 'string') {
-                    this.node.error(new Error(e));
-                } else {
-                    this.node.error(new Error(`Unrecognised error: ${e}`));
-                }
-                this.#status?.setFailed(statusMessage);
-            }
-        };
-    }
 }
diff --git a/src/common/events/Events.ts b/src/common/events/Events.ts
@@ -1,9 +1,14 @@
 import EventEmitter from 'events';
+import Joi from 'joi';
 import { Node } from 'node-red';
 
+import { RED } from '../../globals';
 import { NodeDone } from '../../types/nodes';
+import BaseError from '../errors/BaseError';
+import JSONataError from '../errors/JSONataError';
+import Status from '../status/Status';
 
-export type EventHandler = (...args: any[]) => void;
+type EventHandler = (...args: any[]) => void | Promise<void>;
 export type EventsList = [string | symbol, EventHandler][];
 
 export enum NodeEvent {
@@ -14,6 +19,8 @@ export enum NodeEvent {
 
 export default class Events {
     #listeners: EventsList = [];
+    #status?: Status;
+
     protected readonly node;
     protected readonly emitter;
 
@@ -22,42 +29,75 @@ export default class Events {
         this.emitter = emitter;
         emitter.setMaxListeners(0);
 
-        node.on(NodeEvent.Close, this.onClose.bind(this));
+        node.on(NodeEvent.Close, this.#onClose.bind(this));
+    }
+
+    #errorHandler(callback: EventHandler) {
+        return async (...args: any) => {
+            try {
+                // eslint-disable-next-line n/no-callback-literal
+                await callback(...args);
+            } catch (e) {
+                let statusMessage = RED._('home-assistant.status.error');
+                let error = e;
+                if (e instanceof Joi.ValidationError) {
+                    error = new JSONataError(e);
+                    statusMessage = RED._(
+                        'home-assistant.status.validation_error'
+                    );
+                } else if (e instanceof BaseError) {
+                    statusMessage = e.statusMessage;
+                } else if (typeof e === 'string') {
+                    error = new Error(e);
+                } else {
+                    error = new Error(
+                        `Unrecognised error ${JSON.stringify(e)}`
+                    );
+                }
+                this.node.error(error);
+                this.#status?.setFailed(statusMessage);
+            }
+        };
     }
 
-    onClose(_removed: boolean, done: NodeDone) {
+    #onClose(_removed: boolean, done: NodeDone) {
         this.removeListeners();
         done();
     }
 
-    addListener(
+    public addListener(
         event: string | symbol,
         handler: EventHandler,
         options = { once: false }
     ): void {
-        this.#listeners.push([event, handler]);
+        this.#listeners.push([event, this.#errorHandler(handler)]);
 
         if (options.once === true) {
-            this.emitter.once(event, handler);
+            this.emitter.once(event, this.#errorHandler(handler));
         } else {
-            this.emitter.on(event, handler);
+            this.emitter.on(event, this.#errorHandler(handler));
         }
     }
 
-    addListeners(bind: any, eventsList: EventsList) {
+    public addListeners(bind: unknown, eventsList: EventsList) {
         eventsList.forEach(([event, handler]) => {
             this.addListener(event, handler.bind(bind));
         });
     }
 
-    removeListeners() {
+    public removeListeners() {
         this.#listeners.forEach(([event, handler]) => {
             this.emitter.removeListener(event, handler);
         });
         this.#listeners = [];
     }
 
-    emit(event: string | symbol, ...args: any[]): boolean {
+    // set status for error reporting
+    public setStatus(status: Status) {
+        this.#status = status;
+    }
+
+    public emit(event: string | symbol, ...args: unknown[]): boolean {
         return this.emitter.emit(event, ...args);
     }
 }
diff --git a/src/nodes/button/ButtonController.ts b/src/nodes/button/ButtonController.ts
@@ -1,17 +1,18 @@
 import OutputController from '../../common/controllers/OutputController';
 import { HassEntity } from '../../types/home-assistant';
+import { NodeMessage } from '../../types/nodes';
 import { ButtonNode } from '.';
 
 export default class ButtonController extends OutputController<ButtonNode> {
     public onTrigger(data: { entity: HassEntity }) {
-        this.status.setSuccess('home-assistant.status.pressed');
-        const message = {};
+        const message: NodeMessage = {};
         this.setCustomOutputs(this.node.config.outputProperties, message, {
             config: this.node.config,
             entity: data.entity,
             entityState: data.entity.state,
             triggerId: data.entity.entity_id,
         });
+        this.status.setSuccess('home-assistant.status.pressed');
         this.node.send(message);
     }
 }
diff --git a/src/nodes/button/index.ts b/src/nodes/button/index.ts
@@ -37,6 +37,7 @@ export default function buttonNode(
         node: this,
         emitter: entityConfigNode,
     });
+    entityConfigEvents.setStatus(status);
     const controllerDeps = createControllerDependencies(this, homeAssistant);
 
     entityConfigNode.integration.setStatus(status);

diff --git a/src/nodes/number/NumberController.ts b/src/nodes/number/NumberController.ts
@@ -144,7 +144,6 @@ export default class NumberController extends InputOutputController<
         previousValue?: number
     ): Promise<void> {
         await this.integration?.updateHomeAssistant(value);
-        this.status.setSuccess(value.toString());
         if (!previousValue) {
             previousValue = this.#entityConfigNode?.state?.getLastPayload()
                 ?.state as number | undefined;
@@ -158,5 +157,6 @@ export default class NumberController extends InputOutputController<
             state: value,
             attributes: {},
         });
+        this.status.setSuccess(value.toString());
     }
 }
diff --git a/src/nodes/number/index.ts b/src/nodes/number/index.ts
@@ -89,7 +89,7 @@ export default function numberNode(
             node: this,
             emitter: entityConfigNode,
         });
-
+        entityConfigEvents.setStatus(status);
         entityConfigEvents.addListener(
             IntegrationEvent.ValueChange,
             controller.onValueChange.bind(controller)

diff --git a/src/nodes/select/SelectController.ts b/src/nodes/select/SelectController.ts
@@ -121,7 +121,6 @@ export default class SelectController extends InputOutputController<
         }
 
         await this.integration?.updateHomeAssistant(value);
-        this.status.setSuccess(value);
         if (!previousValue) {
             previousValue = this.#entityConfigNode?.state?.getLastPayload()
                 ?.state as string | undefined;
@@ -135,6 +134,7 @@ export default class SelectController extends InputOutputController<
             state: value,
             attributes: {},
         });
+        this.status.setSuccess(value);
     }
 
     public async onValueChange(value: string, previousValue?: string) {

diff --git a/src/nodes/select/index.ts b/src/nodes/select/index.ts
@@ -89,7 +89,7 @@ export default function selectNode(
             node: this,
             emitter: entityConfigNode,
         });
-
+        entityConfigEvents.setStatus(status);
         entityConfigEvents.addListener(
             IntegrationEvent.ValueChange,
             controller.onValueChange.bind(controller)

diff --git a/src/nodes/sentence/SentenceController.ts b/src/nodes/sentence/SentenceController.ts
@@ -9,19 +9,13 @@ interface SentenceResponse {
 
 export default class SentenseController extends OutputController<SentenceNode> {
     public onReceivedMessage(data: SentenceResponse) {
-        this.status.setSuccess('home-assistant.status.triggered');
         const message: NodeMessage = {};
-        try {
-            this.setCustomOutputs(this.node.config.outputProperties, message, {
-                config: this.node.config,
-                triggerId: data.sentence,
-                results: data.result,
-            });
-        } catch (e) {
-            this.node.error(e);
-            this.status.setFailed('home-assistant.status.error');
-            return;
-        }
+        this.setCustomOutputs(this.node.config.outputProperties, message, {
+            config: this.node.config,
+            triggerId: data.sentence,
+            results: data.result,
+        });
+        this.status.setSuccess('home-assistant.status.triggered');
         this.node.send(message);
     }
 }
diff --git a/src/nodes/sentence/index.ts b/src/nodes/sentence/index.ts
@@ -44,7 +44,7 @@ export default function sentenceNode(
         config: serverConfigNode.config,
         node: this,
     });
-
+    nodeEvents.setStatus(status);
     const controllerDeps = createControllerDependencies(this, homeAssistant);
     const integration = new SentenceIntegration({
         node: this,

diff --git a/src/nodes/text/TextController.ts b/src/nodes/text/TextController.ts
@@ -126,7 +126,6 @@ export default class TextController extends InputOutputController<
         }
 
         await this.integration?.updateHomeAssistant(value);
-        this.status.setSuccess(value);
         if (!previousValue) {
             previousValue = this.#entityConfigNode?.state?.getLastPayload()
                 ?.state as string | undefined;
@@ -140,6 +139,7 @@ export default class TextController extends InputOutputController<
             state: value,
             attributes: {},
         });
+        this.status.setSuccess(value);
     }
 
     public async onValueChange(value: string, previousValue?: string) {

diff --git a/src/nodes/text/index.ts b/src/nodes/text/index.ts
@@ -86,7 +86,7 @@ export default function textNode(this: TextNode, config: TextNodeProperties) {
             node: this,
             emitter: entityConfigNode,
         });
-
+        entityConfigEvents.setStatus(status);
         entityConfigEvents.addListener(
             IntegrationEvent.ValueChange,
             controller.onValueChange.bind(controller)

diff --git a/src/nodes/time-entity/TimeEntityController.ts b/src/nodes/time-entity/TimeEntityController.ts
@@ -154,7 +154,6 @@ export default class TimeEntityController extends InputOutputController<
         value = this.#getFormattedValue(value);
 
         await this.integration?.updateHomeAssistant(value);
-        this.status.setSuccess(value);
         if (!previousValue) {
             previousValue = this.#entityConfigNode?.state?.getLastPayload()
                 ?.state as string | undefined;
@@ -168,5 +167,6 @@ export default class TimeEntityController extends InputOutputController<
             state: value,
             attributes: {},
         });
+        this.status.setSuccess(value);
     }
 }
diff --git a/src/nodes/time-entity/index.ts b/src/nodes/time-entity/index.ts
@@ -90,7 +90,7 @@ export default function timeEntityNode(
             node: this,
             emitter: entityConfigNode,
         });
-
+        entityConfigEvents.setStatus(status);
         entityConfigEvents.addListener(
             IntegrationEvent.ValueChange,
             controller.onValueChange.bind(controller)

diff --git a/src/nodes/webhook/WebhookController.ts b/src/nodes/webhook/WebhookController.ts
@@ -11,19 +11,12 @@ interface WebhookResponse {
 export default class WebhookController extends OutputController<WebhookNode> {
     public onReceivedMessage(data: WebhookResponse) {
         const message: NodeMessage = {};
-        try {
-            this.setCustomOutputs(this.node.config.outputProperties, message, {
-                config: this.node.config,
-                data: data.payload,
-                headers: data.headers,
-                params: data.params,
-            });
-        } catch (e) {
-            this.node.error(e);
-            this.status.setFailed('error');
-            return;
-        }
-
+        this.setCustomOutputs(this.node.config.outputProperties, message, {
+            config: this.node.config,
+            data: data.payload,
+            headers: data.headers,
+            params: data.params,
+        });
         this.status.setSuccess('home-assistant.status.received');
         this.node.send(message);
     }

diff --git a/src/nodes/webhook/index.ts b/src/nodes/webhook/index.ts
@@ -49,6 +49,7 @@ export default function webhookNode(
         config: serverConfigNode.config,
         node: this,
     });
+    nodeEvents.setStatus(status);
 
     const controllerDeps = createControllerDependencies(this, homeAssistant);
     const integration = new WebhookIntegration({