ConfigFlowHandler and OptionsFlowHandler - managing the same parameter

alexdelprete · January 10, 2023, 10:55pm

Pete, you almost saved me from more hours of troubleshooting, I was getting crazy because it was exactly what I needed to implement in my component, I didn’t want to duplicate data from config to options, I wanted to be able to let users edit a subset of config data through the Options Flow.

Now the good news is that I’m able to edit data and saving it in config correctly, the bad news is that the options form is not picking up the labels I configured in en.json, and I can’t understand why.

This is the main config form of a first configuration:

This is the options form when I click configure (data is saved correctly, but I don’t see any labels):

Any help is greatly appreciated, you can find the source of config_flow.py and en.json in my repo.

Thanks a lot.

PeteRage · January 10, 2023, 11:44pm

It may be that the HASS language is not set to en in your dev environment. Check the .storage/core.config file.

I also have a strings.json in the same directory as the code. I believe when no language is specified it uses those. GitHub - PeteRager/lennoxs30: Home Assistant Lennox S30 / E30 / M30 integration

You can also try copying the .en file to strings.json and see if that fixes it.

alexdelprete · January 11, 2023, 12:01am

But for the config labels it works…I simply duplicated the config lines to options section in the en.json file.

Anyway, I checked core.config: "language": "en"

I also copied en.json to strings.json in source dir, but no luck.

Any other idea? I bet it’s some stupid thing in the en.json file…but I can’t see it…it looks good to me.

alexdelprete · January 11, 2023, 11:31am

This morning I restarted HA and it seems to be working fine now, who knows why it didn’t pick-up the labels yesterday. Anyway, seems to be ok now. Thanks a lot @PeteRage, your findings should be in the documentation. It was so hard understanding how to be able to edit a proper working Config Flow, but I guess it’s because I’m not a developer.

Always thankful for this great community.

alexdelprete · January 11, 2023, 11:35am

@PeteRage I forgot to ask one thing: when I save the config, in order to have the integration pick-up the new values, I need to reload it. Is there a way to reload it programmatically when the user clicks submit?

PeteRage · January 11, 2023, 5:14pm

There may be, but i don’t know how to do it.

alexdelprete · January 11, 2023, 9:11pm

Thanks anyway Pete.

anon63427907 · January 12, 2023, 6:39am

Reloading it @alexdelprete

github.com

fuatakgun/eufy_security/blob/43a3d0736b22a0d184af05028aa7a8a7219cafaa/custom_components/eufy_security/config_flow.py#L83

    
      
                  mfa_input = user_input[ConfigField.mfa_input.name]

                  await coordinator.set_mfa_and_connect(mfa_input)

              else:

                  captcha_id = coordinator.config.captcha_id

                  captcha_input = user_input[ConfigField.captcha_input.name]

                  coordinator.config.captcha_id = None

                  coordinator.config.captcha_img = None

                  await coordinator.set_captcha_and_connect(captcha_id, captcha_input)

          

              if self._async_current_entries():

                  await self.hass.config_entries.async_reload(self.context["entry_id"])

          

          if self._async_current_entries():

              return self.async_abort(reason="single_instance_allowed")

          

          if user_input is not None:

              valid = await self._test_credentials(user_input[ConfigField.host.name], user_input[ConfigField.port.name])

              if valid:

                  return self.async_create_entry(title=user_input[ConfigField.host.name], data=user_input)

              self._errors["base"] = "auth"

              return await self._show_config_form(user_input)

alexdelprete · January 12, 2023, 10:29pm

thank you so much.

questions:

Since I have to reload in the Option Flow, where in reality I’m editing config entries, can I use that function also there or it only works in the context of Config Flow?
I found another example that has a structure more similar to my component, with the difference that it’s used in ConfigFlow. So the idea is to put these two in my option flow, after I update the config items in async_step_init. Do you think it’s ok?

class ABBPowerOnePVISunSpecOptionsFlow(config_entries.OptionsFlow):
    """Config flow options handler"""

    VERSION = 1

    def __init__(self, config_entry: ConfigEntry) -> None:
        """Initialize option flow instance"""
        self.config_entry = config_entry
        self.data_schema=vol.Schema(
            {
                vol.Required(
                    CONF_PORT,
                    default=self.config_entry.data[CONF_PORT],
                ): vol.Coerce(int),
                vol.Required(
                    CONF_SLAVE_ID,
                    default=self.config_entry.data[CONF_SLAVE_ID],
                ): vol.Coerce(int),
                vol.Required(
                    CONF_BASE_ADDR,
                    default=self.config_entry.data[CONF_BASE_ADDR],
                ): vol.Coerce(int),
                vol.Required(
                    CONF_SCAN_INTERVAL,
                    default=self.config_entry.data[CONF_SCAN_INTERVAL],
                ): vol.All(vol.Coerce(int), vol.Range(min=5, max=900)),
            }
        )
    async def async_step_init(self, user_input=None):  # pylint: disable=unused-argument
        """Manage the options"""

        if user_input is not None:
            # complete non-edited entries before update (ht @PeteRage)
            if CONF_NAME in self.config_entry.data:
                user_input[CONF_NAME] = self.config_entry.data[CONF_NAME]
            if CONF_HOST in self.config_entry.data:
                user_input[CONF_HOST] = self.config_entry.data[CONF_HOST]

            # write updated config entries (ht @PeteRage / @anon63427907)
            self.hass.config_entries.async_update_entry(
                self.config_entry, data=user_input, options=self.config_entry.options
            )
            # reload updated config entries (ht @anon63427907)
            await self.hass.config_entries.async_reload(self.config_entry.entry_id)
            self.async_abort(reason="configuration updated")

            # write empty options entries (ht @PeteRage / @anon63427907)
            return self.async_create_entry(title="", data={})

        return self.async_show_form(step_id="init", data_schema=self.data_schema)

anon63427907 · January 13, 2023, 8:08am

I might be wrong, but ConfigFlow is supposed to create the config entry (async_create_entry) and OptionFlow is supposed to update it. So, what would be the point of reloding the entry under ConfigFlow before creating it?

Can you try your code with a fresh new addition of the integration, rather than editing the existing instance?

alexdelprete · January 13, 2023, 1:33pm

I agree with what you say, that’s why I didn’t understand why in the EufySecurity code, the async_reload is in the config_flow. That’s why I asked if it should be in the OptionFlow, after the user updates the values.

I tried my code (check previous post) now and it seems to be working fine. I tested it on the polling period, need to do further tests, but thanks a lot for now.

anon63427907 · January 13, 2023, 3:20pm

i have it because of re-authentication flow, but you are right, it is far from clear

alexdelprete · January 13, 2023, 4:45pm

That leads me to think that you can use AsyncReload in both ConfigFlow and OptionsFlow.

Everything related to ConfigFlow/OptionsFlow is very far from clear, if you ask me. If it weren’t for people like you and a couple of other guys I would never managed to implement what I needed.

Thanks again.

anon63427907 · January 13, 2023, 5:23pm

You are right, we can call async_reload anytime, as long as it is already configured once. Would it fail, in case it was not initialized once?

alexdelprete · January 13, 2023, 6:08pm

I think it’s available, as long as you pass it a valid ConfigEntry. But I’m just speculating.

PeteRage · January 13, 2023, 7:41pm

You could decouple it by firing an event (or figure out if one is already being fired) and have that hit a callback that then reloads. This way if the integration is not loaded or already disabled by then user, it won’t start up prematurely.

HAEdwin · January 15, 2023, 7:15pm

You don’t see any labels until you refresh the page, it’s a browser caching issue

alexdelprete · January 15, 2023, 10:13pm

I had already tried the obvious hard-refresh, it didn’t work. Restarting HA the next morning did seem to work. Anyway, all set now.

crowbarz · April 24, 2023, 8:14am

You can set a callback to be called when options are updated, but anecdotally I believe this fires only if the options are actually updated as a result of the config flow. If nothing is changed, then it doesn’t seem to fire. It may also not be fired if you use ConfigEntry.async_update_entry to update the config entry because you store your config in data rather than in options.

# __init__.py

async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
    [...]
    entry.async_on_unload(entry.add_update_listener(_async_update_listener))

async def _async_update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
    """Handle options update."""
    await hass.config_entries.async_reload(entry.entry_id)

Also, I don’t think it’s been mentioned previously in this thread, but you could also just store all of your config in options, and leave data empty. ConfigFlow.async_create_entry takes data and options as parameters:

    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> FlowResult:
        """Handle the initial step."""
        errors: dict[str, str] = {}
        description_placeholders: dict[str, str] = {}

        if user_input is not None:
            (data, options, errors, description_placeholders) = validate_input(
                user_input
            )
            if not errors:
                return self.async_create_entry(
                    title=data["title"], data=data, options=options
                ) 
        [...]

However, note that OptionsFlow.async_create_entry takes a parameter data but somewhat confusingly stores the value passed in options in the ConfigEntry. So as mentioned earlier, you need instead to use ConfigEntry.async_update_entry to update data, or store all config in options.

dbrunt · July 10, 2024, 2:37am

I just had that same issue except I was getting two of seven labels (I did a major rewrite of the integration). I searched /config with find . -exec grep "<label>" {} \; -print and found and edited all occurrences in strings.json, translations/en.json & ar.json but I also found a .translations folder (reason = ???) and also edited those but the problem persisted even though find could no longer find the label. I then cleared my browser cache and that solved my issue.