add wait_for_startup to base controller

[gilesknap]

@GDYendell as discussed yesterday. This is working as expected for fastcs-catio.

Summary by CodeRabbit

• New Features
  • Added wait_for_startup() method to controllers, allowing applications to synchronize with controller startup completion. Includes optional timeout support for flexible synchronization patterns.

[codecov]

Codecov Report

❌ Patch coverage is 44.44444% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.52%. Comparing base (e8d59fb) to head (fa73151).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/fastcs/controllers/base_controller.py	44.44%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #308      +/-   ##
==========================================
- Coverage   90.69%   90.52%   -0.17%     
==========================================
  Files          70       70              
  Lines        2535     2544       +9     
==========================================
+ Hits         2299     2303       +4     
- Misses        236      241       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[GDYendell]

This does not appear to be true - it times out and returns False. I think we probably want it to propagate the exception. If it times out what is the caller supposed to do other than stop the application?

[gilesknap]

that was not my experience - how did you test this to make that issue arise? I used it in a fastcs-catio system test and it behaved as advertised.

[GDYendell]

I haven't tested it I am just reading the code. When called without a timeout it blocks until post_initialise is complete, but with a timeout it returns before post_initialise is complete. Is that what we want? What is the caller supposed to do if it returns False?

[GDYendell]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

📝 Walkthrough

Walkthrough

The BaseController class now includes an asyncio-based startup synchronization mechanism. A private _started_event is initialized during instantiation and set in post_initialise after IO connection. A new public async method wait_for_startup() allows callers to wait for startup completion with an optional timeout.

Changes

Cohort / File(s)	Summary
Startup Synchronization src/fastcs/controllers/base_controller.py	Added asyncio.Event initialization in __init__, event signaling in post_initialise, and async wait_for_startup(timeout) method to allow callers to wait for controller initialization completion.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 bounces excitedly
A startup event hops into place,
Controllers wait with asyncio grace,
No more rushing through the race—
Now we synchronize, time and space! 🚀

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding a wait_for_startup method to the BaseController class.
Docstring Coverage	✅ Passed	Docstring coverage is 80.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch add-startup

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}