output_devices in response of atvscript push_updates resulting in faulty state

[maxileith]

Hi @sebbo2002 ,

this Issue is related to #291. An user of my plugin @rvetere has reported the issue maxileith/homebridge-appletv-enhanced#155. After some investigation the root cause is similar to the on reported in #291. Below is the response of atvscript push_updates…

{"result": "success", "datetime": "2024-01-11T19:45:57.122827+01:00", "power_state": "on"}
{"result": "success", "datetime": "2024-01-11T19:45:57.123138+01:00", "output_devices": [{"name": "Apple TV", "identifier": "D4ED48E4-4C88-47C0-B05C-077747F85C5D"}]}
{"result": "success", "datetime": "2024-01-11T19:45:57.125393+01:00", "hash": "ca496c14642c78af6dd4250191fe175f6dafd72b4c33bcbab43c454aae051da1", "media_type": "unknown", "device_state": "idle", "title": null, "artist": null, "album": null, "genre": null, "total_time": null, "position": null, "shuffle": "off", "repeat": "off", "series_name": null, "season_number": null, "episode_number": null, "content_identifier": null, "app": null, "app_id": null}
{"result": "success", "datetime": "2024-01-11T19:45:57.126692+01:00", "volume": 50.0}

… which does include a line with the unexpected attribute output_devices which I do not think is correctly handled here:

node-pyatv/src/lib/device-events.ts

Lines 38 to 52 in 60a414d

	applyStateAndEmitEvents(newState: NodePyATVState): void {
	let keys = Object.keys(this.state);
	if('power_state' in newState && newState.power_state) {
	keys = ['power_state'];
	}
	if('focus_state' in newState && newState.focus_state) {
	keys = ['focus_state'];
	}
	// Volume events don't hold the complete state…
	// see https://github.com/sebbo2002/node-pyatv/pull/291
	if('volume' in newState && newState.volume) {
	keys = ['volume'];
	}

I think it should be handled like power_state or volume

[sebbo2002]

The field output_devices is currently not implemented and is therefore neither mapped in events nor in NodePyATVState. I'll put it on my todo list, I'm assuming to have something by the beginning to mid of next week...

[maxileith]

The problem is, that this function will return its default when passing an Object just with output_devices, so null for every attribute.

node-pyatv/src/lib/tools.ts

Line 237 in 60a414d

export function parseState(input: NodePyATVInternalState, id: string, options: NodePyATVInstanceOptions): NodePyATVState {

Then the following method will set all states to null.

node-pyatv/src/lib/device-events.ts

Line 38 in 60a414d

applyStateAndEmitEvents(newState: NodePyATVState): void {

So I would consider this a bug, not an enhancement.

[sebbo2002]

Oh. I'm glad you wrote again. I somehow didn't realize that the first time I read it. Yes, of course I should fix that also, so that applyStateAndEmitEvents does not trigger any events if everything is set to null. That would solve the problem, right?

[sebbo2002]

@maxileith Both should be fixed with 7.3.0-develop.1. Can you confirm that the fix works?

[maxileith]

I think there is a change required, see #299. Nevertheless, I already want to thank you for the fast replies and fixes in this project.

[sebbo2002]

#300 merged in favor of #299.

[maxileith]

@sebbo2002 I left a comment in #300. You may want to take a look at this. However, this feature should work either way for me. I will release a beta of my plugin and ask the author of the bug reported if it is working for him 👍🏻

[sebbo2002]

🎉 This issue has been resolved in version 7.3.0-develop.3 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release
• v7.3.0-develop.3

Your semantic-release bot 📦🚀

[sebbo2002]

🎉 This issue has been resolved in version 7.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release
• v7.3.0

Your semantic-release bot 📦🚀