Fix guirunner timing

[nkoenig]

🦟 Bug fix

Summary

The GuiRunner fails to get entities spawned from the GazeboFactory plugin, in ign-launch, when simulation is started in the running state.

This issue was found when porting SubT to Fortress. The following subt launch command will cause the GUI to miss robot creation:

ign launch -v 4 cloudsim_sim.ign worldName:=simple_ca_01 circuit:=cave robotName1:=X1 robotConfig1:=X1_SENSOR_CONFIG_1

Here is what's happening under the hood:

1. Factory message is received by the gazebo server.
2. The GuiRunner get the initial state and then subscribes to state topic.
3. The ECM creates the new robot.
4. The GuiRunner's subscription is connected (missing the robot creation event).

Checklist

• Signed all commits for DCO
• Added tests
• Updated documentation (as needed)
• Updated migration guide (as needed)
• codecheck passed (See contributing)
• All tests passed (See test coverage)
• While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge

[codecov]

Codecov Report

Merging #1073 (a87778e) into main (aff31b5) will decrease coverage by 0.02%.
The diff coverage is 72.00%.

❗ Current head a87778e differs from pull request most recent head 56a74bf. Consider uploading reports for the commit 56a74bf to get more accurate results

@@            Coverage Diff             @@
##             main    #1073      +/-   ##
==========================================
- Coverage   64.07%   64.05%   -0.03%     
==========================================
  Files         255      255              
  Lines       19958    19967       +9     
==========================================
+ Hits        12789    12790       +1     
- Misses       7169     7177       +8     

Impacted Files	Coverage Δ
src/SdfEntityCreator.cc	83.83% <0.00%> (-0.21%)	⬇️
src/systems/physics/Physics.cc	70.82% <0.00%> (-0.13%)	⬇️
src/gui/GuiRunner.cc	81.33% <76.92%> (-4.59%)	⬇️
src/SdfGenerator.cc	94.87% <100.00%> (+0.06%)	⬆️
src/EntityComponentManager.cc	85.34% <0.00%> (-0.14%)	⬇️

---

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 d6fbc26...56a74bf. Read the comment docs.

[chapulina]

👍