feat: Handle pyatv exceptions for getState() and event listeners

closes #105
sebbo2002 · Nov 29, 2021 · a695e11 · a695e11
1 parent 8a01c63
commit a695e11
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 12 deletions.
diff --git a/src/lib/device-events.ts b/src/lib/device-events.ts
@@ -91,8 +91,13 @@ export default class NodePyATVDeviceEvents extends EventEmitter {
     }
 
     private applyPushUpdate(update: NodePyATVInternalState, reqId: string): void {
-        const newState = parseState(update, reqId, this.options);
-        this.applyStateAndEmitEvents(newState);
+        try {
+            const newState = parseState(update, reqId, this.options);
+            this.applyStateAndEmitEvents(newState);
+        }
+        catch(error) {
+            this.emit('error', error);
+        }
     }
 
     private checkListener(): void {

diff --git a/src/lib/device.ts b/src/lib/device.ts
@@ -148,14 +148,19 @@ export default class NodePyATVDevice implements EventEmitter{
         }
 
         const id = addRequestId();
-        const parameters = getParamters(this.options);
 
-        const result = await request(id, NodePyATVExecutableType.atvscript, [...parameters, 'playing'], this.options);
-        const newState = parseState(result, id, this.options);
-        this.applyState(newState);
+        try {
+            const parameters = getParamters(this.options);
 
-        removeRequestId(id);
-        return newState;
+            const result = await request(id, NodePyATVExecutableType.atvscript, [...parameters, 'playing'], this.options);
+            const newState = parseState(result, id, this.options);
+
+            this.applyState(newState);
+            return newState;
+        }
+        finally {
+            removeRequestId(id);
+        }
     }
 
     /**

diff --git a/src/lib/tools.ts b/src/lib/tools.ts
@@ -252,6 +252,14 @@ export function parseState(input: NodePyATVInternalState, id: string, options: N
     if (!input || typeof input !== 'object') {
         return result;
     }
+    if(input.exception) {
+        let errorStr = 'Got pyatv Error: ' + input.exception;
+        if(input.stacktrace) {
+            errorStr += '\n\npyatv Stacktrace:\n' + input.stacktrace;
+        }
+
+        throw new Error(errorStr);
+    }
 
     // datetime
     if (typeof input.datetime === 'string') {

diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -171,6 +171,7 @@ export interface NodePyATVInternalState {
     power_state?: string | unknown,
     push_updates?: string | unknown,
     exception?: string | unknown,
+    stacktrace?: string | unknown,
     connection?: string | unknown
 }
 

diff --git a/test/device-events.ts b/test/device-events.ts
@@ -89,6 +89,29 @@ describe('NodePyATVDeviceEvents', function () {
 
             assert.deepStrictEqual(sort, ['update:title', 'update']);
         });
+        it('should emit error events on failures', async function () {
+            const device = new NodePyATVDevice({
+                name: 'My Testdevice',
+                host: '192.168.178.2',
+                spawn: createFakeSpawn(cp => {
+                    cp.onStdIn(() => cp.end());
+                    cp.stdout({
+                        result: 'failure',
+                        datetime: '2021-11-24T21:13:36.424576+03:00',
+                        exception: 'invalid credentials: 321',
+                        stacktrace: 'Traceback (most recent call last):\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 302, in appstart\n    print(args.output(await _handle_command(args, abort_sem, loop)), flush=True)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 196, in _handle_command\n    atv = await connect(config, loop, protocol=Protocol.MRP)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/__init__.py\", line 96, in connect\n    for setup_data in proto_methods.setup(\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 192, in setup\n    stream = AirPlayStream(config, service)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 79, in __init__\n    self._credentials: HapCredentials = parse_credentials(self.service.credentials)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/auth/hap_pairing.py\", line 139, in parse_credentials\n    raise exceptions.InvalidCredentialsError(\"invalid credentials: \" + detail_string)\npyatv.exceptions.InvalidCredentialsError: invalid credentials: 321\n'
+                    });
+                })
+            });
+
+            await new Promise(cb => {
+                device.once('error', error => {
+                    assert.ok(error instanceof Error);
+                    assert.ok(error.toString().includes('invalid credentials: 321'));
+                    cb(undefined);
+                });
+            });
+        });
         it('should not emit an update if new value is same as old one', async function () {
             let spawnCounter = 0;
             let eventCounter = 0;

diff --git a/test/device.ts b/test/device.ts
@@ -237,6 +237,24 @@ describe('NodePyATVDevice', function () {
                 powerState: null
             });
         });
+        it('should reject with error if pyatv fails', async function () {
+            const device = new NodePyATVDevice({
+                name: 'My Testdevice',
+                host: '192.168.178.2',
+                spawn: createFakeSpawn(cp => {
+                    cp.end({
+                        result: 'failure',
+                        datetime: '2021-11-24T21:13:36.424576+03:00',
+                        exception: 'invalid credentials: 321',
+                        stacktrace: 'Traceback (most recent call last):\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 302, in appstart\n    print(args.output(await _handle_command(args, abort_sem, loop)), flush=True)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 196, in _handle_command\n    atv = await connect(config, loop, protocol=Protocol.MRP)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/__init__.py\", line 96, in connect\n    for setup_data in proto_methods.setup(\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 192, in setup\n    stream = AirPlayStream(config, service)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 79, in __init__\n    self._credentials: HapCredentials = parse_credentials(self.service.credentials)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/auth/hap_pairing.py\", line 139, in parse_credentials\n    raise exceptions.InvalidCredentialsError(\"invalid credentials: \" + detail_string)\npyatv.exceptions.InvalidCredentialsError: invalid credentials: 321\n'
+                    });
+                })
+            });
+
+            assert.rejects(async () => {
+                await device.getState();
+            }, /Got pyatv Error: invalid credentials: 321/);
+        });
         it('should cache requests for a bit', async function () {
             let executions = 0;
             const device = new NodePyATVDevice({

diff --git a/test/tools.ts b/test/tools.ts
@@ -1,7 +1,7 @@
 'use strict';
 
 import assert from 'assert';
-import {addRequestId, debug, getExecutable, getParamters, parseState, removeRequestId} from '../src/lib/tools';
+import { addRequestId, debug, getExecutable, getParamters, parseState, removeRequestId } from '../src/lib/tools';
 import {
     NodePyATVDeviceState,
     NodePyATVExecutableType,
@@ -28,7 +28,7 @@ describe('Tools', function () {
             debug('TEST', 'Hello World.', {});
         });
         it('should work with default logger', function () {
-            debug('TEST', 'Hello World.', {debug: true});
+            debug('TEST', 'Hello World.', { debug: true });
         });
         it('should work with custom logger', function () {
             debug('TEST', 'Hello World.', {
@@ -39,7 +39,7 @@ describe('Tools', function () {
             });
         });
         it('should work with colors disabled', function () {
-            debug('TEST', 'Hello World.', {noColors: true});
+            debug('TEST', 'Hello World.', { noColors: true });
         });
         it('should work with custom logger and colors disabled', function () {
             debug('TEST', 'Hello World.', {
@@ -201,8 +201,19 @@ describe('Tools', function () {
                 powerState: null
             });
         });
+        it('should throw an error for pyatv exceptions', function () {
+            const input = {
+                result: 'failure',
+                datetime: '2021-11-24T21:13:36.424576+03:00',
+                exception: 'invalid credentials: 321',
+                stacktrace: 'Traceback (most recent call last):\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 302, in appstart\n    print(args.output(await _handle_command(args, abort_sem, loop)), flush=True)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 196, in _handle_command\n    atv = await connect(config, loop, protocol=Protocol.MRP)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/__init__.py\", line 96, in connect\n    for setup_data in proto_methods.setup(\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 192, in setup\n    stream = AirPlayStream(config, service)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 79, in __init__\n    self._credentials: HapCredentials = parse_credentials(self.service.credentials)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/auth/hap_pairing.py\", line 139, in parse_credentials\n    raise exceptions.InvalidCredentialsError(\"invalid credentials: \" + detail_string)\npyatv.exceptions.InvalidCredentialsError: invalid credentials: 321\n'
+            };
+            assert.throws(() => {
+                parseState(input, '', {});
+            }, /Got pyatv Error: invalid credentials: 321/);
+        });
         it('should ignore date if it\'s an invalid date', function () {
-            const input = {datetime: 'today'};
+            const input = { datetime: 'today' };
             const result = parseState(input, '', {});
             assert.deepStrictEqual(result, {
                 dateTime: null,