Reduce sleep() in CAP library code

[rajan-chari]

Why are these changes needed?

Related issue number

Resolves #2088 Roadmap item: (Remove Sleeps from Actor creation, ActorSender, ActorConnector in the CAP framework)

Checks

• I've included any doc changes needed for https://microsoft.github.io/autogen/. See https://microsoft.github.io/autogen/docs/Contribute#documentation to build and test documentation locally.
• I've added tests (if relevant) corresponding to the changes introduced in this PR.
• I've made sure all auto checks have passed.

[kinnym]

Typically we dont want to wait infinitely.. generally not a good idea. To fix it we can modify the existing code to this. Your timeout is your worst case scenario.
// Assuming _start_event is already defined somewhere
// Create an instance of threading.Event() if it's not already created
self._start_event = threading.Event()

//Wait for the event with a timeout of 5 seconds
if not self._start_event.wait(timeout=5):
// If the event didn't occur within 5 seconds
// Do something else or raise an exception
print("Event didn't occur within 5 seconds. Proceeding with other actions.")
else:
// If the event occurred within 5 seconds
// Proceed with the rest of the code
print("Event occurred. Proceeding with other actions.")

[kinnym]

Otherwise the changes look good.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.94%. Comparing base (32fbfa2) to head (9f0bbcc).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2189   +/-   ##
=======================================
  Coverage   37.94%   37.94%           
=======================================
  Files          77       77           
  Lines        7780     7780           
  Branches     1666     1666           
=======================================
  Hits         2952     2952           
  Misses       4579     4579           
  Partials      249      249           

Flag	Coverage Δ
unittests	37.93% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[rajan-chari]

Typically we dont want to wait infinitely.. generally not a good idea. To fix it we can modify the existing code to this. Your timeout is your worst case scenario. // Assuming _start_event is already defined somewhere // Create an instance of threading.Event() if it's not already created self._start_event = threading.Event()

//Wait for the event with a timeout of 5 seconds if not self._start_event.wait(timeout=5): // If the event didn't occur within 5 seconds // Do something else or raise an exception print("Event didn't occur within 5 seconds. Proceeding with other actions.") else: // If the event occurred within 5 seconds // Proceed with the rest of the code print("Event occurred. Proceeding with other actions.")

Thanks for the suggestion, Kiran. I see where you are coming from in case there is an error in signaling logic, this would prevent Actor startup from freezing.

I tried the suggested approach. Here are my observations:

1. In debugger, even when there are no issues, the waiting threads exit. This makes the Actor classes brittle and difficult to debug. In this case, attempting to avoid possible incorrect states, puts the code in incorrect states. Since the 5 seconds is just a heuristic, it's hard to guarantee correct behavior.

2. My preference here is to fix issues instead of providing a path for possibly incorrect behavior in the core framework. I try to ensure that all path's in the signaling thread are correct. Please let me know if you see any logic issues, for example, exceptions might cause things to not be signaled.

This change would make it harder to use the framework (at least under Debug). I concluded that the best approach here is to rely on correct event signaling behavior and correct logic in threading code, so I rolled back the changes.

[rajan-chari]

Merge seems to be prevented by checking a file that should be excluded. I created a PR to disable the file check. This has been merged to main. Not sure how to proceed here. The exclusion has also been committed to this branch.

[sonichi]

Could you fix the code formatting error?

[rajan-chari]

Could you fix the code formatting error?

Running into this issue: #2190

[rajan-chari]

Could you fix the code formatting error?

All set.