Fix vizio bug that occurs when CONF_APPS isn't in config entry options

[raman325]

Proposed change

A user reported an error (#33851) when CONF_APPS isn't in the config entry options that causes the UI for options not to load. This fix sets a default when CONF_APPS isn't found ({}) which should prevent the error. This should be included in the next minor release that goes out for 0.108. I don't see a need to add a test for this because it's a straightforward bug with a straightforward fix, but I will add one if needed.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes Integration options for Vizio not working in 0.108 #33851

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• The code has been formatted using Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

• No score or internal
• 🥈 Silver
• 🥇 Gold
• 🏆 Platinum

[MartinHjelmare]

If we would have had a test we would have caught this. 😉

[raman325]

...touche, working on a test now

[raman325]

actually not sure if I can test this... I think my tests would have covered this if this was something that could have been tested on the backend. See the following tests:

core/tests/components/vizio/test_config_flow.py

Lines 128 to 150 in ff93630

	async def test_tv_options_flow_no_apps(hass: HomeAssistantType) -> None:
	"""Test options config flow for TV without providing apps option."""
	entry = MockConfigEntry(domain=DOMAIN, data=MOCK_USER_VALID_TV_CONFIG)
	entry.add_to_hass(hass)
	assert not entry.options
	result = await hass.config_entries.options.async_init(entry.entry_id, data=None)
	assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
	assert result["step_id"] == "init"
	options = {CONF_VOLUME_STEP: VOLUME_STEP}
	options.update(MOCK_INCLUDE_NO_APPS)
	result = await hass.config_entries.options.async_configure(
	result["flow_id"], user_input=options
	)
	assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
	assert result["title"] == ""
	assert result["data"][CONF_VOLUME_STEP] == VOLUME_STEP
	assert CONF_APPS not in result["data"]

core/tests/components/vizio/test_config_flow.py

Lines 153 to 176 in ff93630

	async def test_tv_options_flow_with_apps(hass: HomeAssistantType) -> None:
	"""Test options config flow for TV with providing apps option."""
	entry = MockConfigEntry(domain=DOMAIN, data=MOCK_USER_VALID_TV_CONFIG)
	entry.add_to_hass(hass)
	assert not entry.options
	result = await hass.config_entries.options.async_init(entry.entry_id, data=None)
	assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
	assert result["step_id"] == "init"
	options = {CONF_VOLUME_STEP: VOLUME_STEP}
	options.update(MOCK_INCLUDE_APPS)
	result = await hass.config_entries.options.async_configure(
	result["flow_id"], user_input=options
	)
	assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
	assert result["title"] == ""
	assert result["data"][CONF_VOLUME_STEP] == VOLUME_STEP
	assert CONF_APPS in result["data"]
	assert result["data"][CONF_APPS] == {CONF_INCLUDE: [CURRENT_APP]}

If this could be tested these code blocks should have resulted in an error because the issue occurs when options haven't been set yet, and in these tests I only set options after creating the entry 😦

[MartinHjelmare]

Make the test add CONF_VOLUME_STEP option to entry options before starting the flow.

[raman325]

just to note, options always get set with DEFAULT_VOLUME_STEP if no CONF_VOLUME_STEP is provided so this is probably a redundant test but added it anyway

EDIT: nevermind, because I'm adding MockConfigEntrys directly in these tests, what I said is false

[tteck]

108.1 broke Vizio SmartCast bar. Only the Google cast. This bar has Google assistant built in. Worked in 108
ERROR (Thread-8) [pychromecast.socket_client] [Soundbar:8009] Failed to connect to service SmartCast-Sound-Bar–1eabbb691d70ebdd4fc823a1f3ac4039._googlecast._tcp.local

[frenck]

@tteck Please don't report problems on merged issues. Instead, raise an issue here on GitHub. Thanks 👍