Fix racy homekit_controller platform setup caused by #22368

[Jc2k]

Description:

#22194 introduced some new homekit_controller tests and @balloob and @awarecan pointed out at least one of them was flaky. This doesn't happen in my config entry branch and i've now traced its root cause to #22368.

Essentially, HKDevice.__init__ on dev has for some time triggered the setup_platform for its sub-domains like light/climate/etc. But there is a race where this code hasn't run yet:

hass.data[KNOWN_DEVICES][hkid] = device

If the setup_platform runs before that happens you get the error in the test. This fix moves where we store the current HKDevice into hass.data so that it is always set before any further setup_platform is called.

This race is probably a real bug, not just a flaky test. So if #22368 is already in a tag or in an rc branch it might be worth applying the fix there too.

This is something of a temporary band aid - the buggy code is actually removed in my config entry branch and doesn't have this problem. The config entry branch won't trigger side effects in HKDevice.__init__ any more. So the config entry work will be the 'real' fix, but this will do until then.

**Related issue (if applicable): #22650

Checklist:

• The code change is tested and works locally.
• Local tests pass with tox. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.

[codecov]

Codecov Report

Merging #22655 into dev will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev   #22655   +/-   ##
=======================================
  Coverage   92.57%   92.57%           
=======================================
  Files         457      457           
  Lines       36977    36977           
=======================================
  Hits        34232    34232           
  Misses       2745     2745

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48189dd...11c00e9. Read the comment docs.