Skip to content

Workaround for web-configurator hangs in setup flow#59

Open
RyanGerleve wants to merge 1 commit into
unfoldedcircle:mainfrom
RyanGerleve:setup-sleep-workaround
Open

Workaround for web-configurator hangs in setup flow#59
RyanGerleve wants to merge 1 commit into
unfoldedcircle:mainfrom
RyanGerleve:setup-sleep-workaround

Conversation

@RyanGerleve
Copy link
Copy Markdown

I noticed the web-configurator can get stuck in the integration setup flow in certain cases. It happens when the first initial setup of an integration is canceled or errors/times out, then restarted by clicking on its tile in the web configurator. If the integration then requests a user input or user confirmation screen, the web UI will hang until it times out.

This is easily reproduced with the setup_flow example:

  1. Run the setup_flow.py example as an external integration.
  2. Use the web configurator to add it to a remote that doesn't have it yet.
  3. When the initial setup screen with "Configure enhanced options" appears, click the X to close it.
  4. Click the "Setup Flow Demo" integration tile to start setup again.
  5. Enable "Configure enhanced options" and click next. The web UI will spin on "Setting Up..." until it times out.

I saw the existing sleep calls and comments in the setup flow code that imply they're workarounds for the web-configurator, so I tried that here, and it worked. So maybe it's acceptable for a pull request!

Interestingly, I also tested this using the setup_flow example in the node integration library, but I couldn't reproduce it consistently.

- The web-configurator could get stuck when continuing a first-time setup that was previously canceled or interrupted. Added delays as a workaround.
@zehnm
Copy link
Copy Markdown
Contributor

zehnm commented Jun 4, 2026

Did you use the latest main branch of the integration (v0.7.0) and with which Remote firmware version did you test with?

@RyanGerleve
Copy link
Copy Markdown
Author

Did you use the latest main branch of the integration (v0.7.0) and with which Remote firmware version did you test with?

Yes, latest main branch and firmware 2.9.4. I had also tested on firmware 2.9.3 before updating my remote, and it had the same behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants