forkless/freecad-robust-mcp-fc111
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: Ensure auto-start works correctly (#40)

Browse Source 
* fix: Ensure auto-start works correctly

* fix: Correct auto-start functionality for Bridge

* fix: general improvements
This commit is contained in:
Sean P. Kane
2026-01-18 23:17:07 -08:00
committed by GitHub
parent 2bef958994
commit 610654ae38
6 changed files with 665 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
addon/FreecadRobustMCPBridge/Init.py
+79 -11
View File
@@ -13,13 +13,16 @@ must run on the main thread.
from __future__ import annotations
from typing import TYPE_CHECKING, Any
# Import FreeCAD first so we can log early
import FreeCAD
FreeCAD.Console.PrintMessage("Robust MCP Bridge: Init.py loaded\n")
from typing import TYPE_CHECKING, Any # noqa: E402
if TYPE_CHECKING:
from freecad_mcp_bridge.bridge_utils import GuiWaiter
import FreeCAD
FreeCAD.Console.PrintMessage("Robust MCP Bridge: Init loaded\n")
# Global reference to GuiWaiter and auto-start timer to prevent garbage collection
@@ -83,15 +86,22 @@ def _auto_start_bridge() -> None:
except Exception as e:
FreeCAD.Console.PrintError(f"Failed to auto-start MCP Bridge: {e}\n")
import traceback
FreeCAD.Console.PrintError(f"Traceback: {traceback.format_exc()}\n")
# Schedule auto-start after FreeCAD finishes loading
# Strategy:
# - If FreeCAD.GuiUp is True: Qt event loop is running, use timer for deferred start
# - If FreeCAD.GuiUp is False but Qt is available: FreeCAD GUI is initializing.
# - If FreeCAD.GuiUp is False but QApplication exists: FreeCAD GUI is initializing.
# Use GuiWaiter to wait for GuiUp to become True before starting.
# This ensures the bridge uses Qt timer (not background thread) for queue processing.
# - If Qt is not available: Pure headless mode, start bridge directly
# - If no QApplication: True headless mode, start bridge directly
#
# IMPORTANT: We check for QApplication.instance() rather than just QtCore availability
# because FreeCAD bundles PySide even in headless mode (freecadcmd), but there's no
# Qt event loop running. Without a QApplication, Qt timers will never fire.
#
# CRITICAL: We must wait for FreeCAD.GuiUp to be True before starting the bridge
# in GUI mode. If we start when GuiUp is False, the bridge's _start_queue_processor()
@@ -100,19 +110,59 @@ def _auto_start_bridge() -> None:
try:
from preferences import get_auto_start
if get_auto_start():
# Try to import Qt
_auto_start_enabled = get_auto_start()
FreeCAD.Console.PrintMessage(
f"Robust MCP Bridge: Auto-start preference = {_auto_start_enabled}\n"
)
if _auto_start_enabled:
# Try to import Qt and check for running QApplication
import contextlib
QtCore = None
QtWidgets = None
_has_qapp = False
_is_true_headless = False
try:
from PySide2 import QtCore # type: ignore[assignment, no-redef]
from PySide2 import QtCore, QtWidgets # type: ignore[assignment, no-redef]
except ImportError:
with contextlib.suppress(ImportError):
from PySide6 import QtCore # type: ignore[assignment, no-redef]
from PySide6 import ( # type: ignore[assignment, no-redef]
QtCore,
QtWidgets,
)
# Detect GUI mode vs true headless mode
# - True headless (freecadcmd): QCoreApplication exists but NOT QApplication
# - GUI mode early startup: No app yet, or QApplication being initialized
# - GUI mode ready: FreeCAD.GuiUp is True
if QtWidgets is not None and QtCore is not None:
qapp = QtWidgets.QApplication.instance()
if qapp is not None:
_has_qapp = True
else:
# No QApplication - check if QCoreApplication exists
# If QCoreApplication exists but is NOT a QApplication, it's true headless
qcore_app = QtCore.QCoreApplication.instance()
if qcore_app is not None and not isinstance(
qcore_app, QtWidgets.QApplication
):
_is_true_headless = True
# If no app at all, assume early GUI startup (will use GuiWaiter)
FreeCAD.Console.PrintMessage(
f"Robust MCP Bridge: GuiUp={FreeCAD.GuiUp}, "
f"QtCore={'available' if QtCore else 'unavailable'}, "
f"QApp={'running' if _has_qapp else 'none'}, "
f"headless={_is_true_headless}\n"
)
if FreeCAD.GuiUp:
# GUI is already up - use timer for deferred start
FreeCAD.Console.PrintMessage(
"Robust MCP Bridge: GUI already up, scheduling deferred start...\n"
)
if QtCore is not None:
_auto_start_timer = QtCore.QTimer()
_auto_start_timer.setSingleShot(True)
@@ -121,9 +171,21 @@ try:
else:
# GUI is up but Qt import failed - start directly
_auto_start_bridge()
elif _is_true_headless:
# True headless mode - QCoreApplication exists but not QApplication
# No Qt event loop for GUI, so start bridge directly with background thread
FreeCAD.Console.PrintMessage(
"Robust MCP Bridge: True headless mode (QCoreApplication only), "
"starting directly...\n"
)
_auto_start_bridge()
elif QtCore is not None:
# GUI not ready yet, but Qt is available (FreeCAD starting in GUI mode)
# GUI not ready yet (either QApplication exists or no app yet)
# Use GuiWaiter to wait for GuiUp to become True before starting
# This ensures the bridge uses Qt timer (not background thread) for queue
FreeCAD.Console.PrintMessage(
"Robust MCP Bridge: GUI not ready, using GuiWaiter...\n"
)
from freecad_mcp_bridge.bridge_utils import GuiWaiter
_gui_waiter = GuiWaiter(
@@ -136,7 +198,13 @@ try:
)
_gui_waiter.start()
else:
# True headless mode - no Qt, no GUI
# No Qt available at all - unusual state, start directly
FreeCAD.Console.PrintMessage(
"Robust MCP Bridge: No Qt available, starting directly...\n"
)
_auto_start_bridge()
except Exception as e:
FreeCAD.Console.PrintWarning(f"Could not set up auto-start: {e}\n")
import traceback
FreeCAD.Console.PrintWarning(f"Traceback: {traceback.format_exc()}\n")
addon/FreecadRobustMCPBridge/InitGui.py
+66
View File
@@ -178,6 +178,72 @@ try:
FreeCAD.Console.PrintMessage(
"Robust MCP Bridge: Status bar sync scheduled from InitGui (2s)\n"
)
# Auto-start the MCP bridge if configured in preferences
# This runs at FreeCAD GUI startup (InitGui.py module-level code)
# Note: Init.py does NOT run at startup for workbench addons, so auto-start
# must be triggered from here instead.
def _deferred_auto_start() -> None:
"""Auto-start bridge after GUI is fully ready."""
try:
from preferences import get_auto_start
if not get_auto_start():
return
# Check if bridge is already running
from commands import is_bridge_running
if is_bridge_running():
FreeCAD.Console.PrintMessage(
"Robust MCP Bridge: Bridge already running, skipping auto-start\n"
)
return
FreeCAD.Console.PrintMessage(
"Robust MCP Bridge: Auto-starting from InitGui...\n"
)
# Import and start the bridge
from freecad_mcp_bridge.bridge_utils import register_mcp_plugin
from freecad_mcp_bridge.server import FreecadMCPPlugin
from preferences import get_socket_port, get_xmlrpc_port
xmlrpc_port = get_xmlrpc_port()
socket_port = get_socket_port()
plugin = FreecadMCPPlugin(
host="localhost",
port=socket_port,
xmlrpc_port=xmlrpc_port,
enable_xmlrpc=True,
)
plugin.start()
# Register plugin with commands module
register_mcp_plugin(plugin, xmlrpc_port, socket_port)
# Sync status bar now that bridge is running
try:
from status_widget import sync_status_with_bridge
sync_status_with_bridge()
except Exception as status_err:
FreeCAD.Console.PrintWarning(
f"Could not sync status bar after auto-start: {status_err}\n"
)
except Exception as e:
FreeCAD.Console.PrintError(f"Robust MCP Bridge: Auto-start failed: {e}\n")
import traceback
FreeCAD.Console.PrintError(traceback.format_exc())
# Schedule auto-start after a short delay to ensure GUI is fully ready
# Use a longer delay than status bar sync to avoid race conditions
QtCore.QTimer.singleShot(3000, _deferred_auto_start)
FreeCAD.Console.PrintMessage(
"Robust MCP Bridge: Auto-start scheduled from InitGui (3s)\n"
)
except Exception as e:
FreeCAD.Console.PrintWarning(
f"Robust MCP Bridge: Could not schedule status bar sync: {e}\n"
addon/FreecadRobustMCPBridge/RELEASE_NOTES.md
+5 -2
View File
@@ -2,7 +2,7 @@
## Version 0.6.2 (2026-01-18)
No changes to the workbench code itself. This release reflects the repository restructuring.
This release fixes some auto-start issues and improves the overall startup experience across all supported modes.
### Added
@@ -11,10 +11,13 @@ No changes to the workbench code itself. This release reflects the repository re
### Changed
- **Repository restructured**: This addon now focuses solely on the MCP Bridge Workbench. Standalone macros have been moved to dedicated repositories for independent release cycles.
- **Cleaner startup messages**: Removed duplicate success messages when bridge auto-starts.
### Fixed
- No bug fixes in this release.
- **Auto-start not working at FreeCAD startup**: Fixed bug where auto-start only worked when manually selecting the workbench. For FreeCAD workbench addons, `Init.py` does NOT run at startup - only `InitGui.py` module-level code runs. Auto-start logic has been moved to `InitGui.py`.
- **Status bar not appearing after auto-start**: The status bar widget now syncs immediately after the bridge starts, instead of on a timer that ran before the bridge was ready.
- **Integration test crashes**: Fixed race condition where the bridge could start before `FreeCAD.GuiUp` was `True`, causing Qt operations to run on a background thread and crash FreeCAD.
### Note
addon/FreecadRobustMCPBridge/freecad_mcp_bridge/startup_bridge.py
+54 -8
View File
@@ -128,31 +128,76 @@ def _start_bridge() -> None:
# Schedule bridge start after FreeCAD finishes loading
# Strategy:
# - If FreeCAD.GuiUp is True: Qt event loop is running, start bridge directly
# - If FreeCAD.GuiUp is False but Qt is available: FreeCAD GUI is initializing.
# - If FreeCAD.GuiUp is False but QApplication exists: FreeCAD GUI is initializing.
# Use GuiWaiter to wait for GuiUp to become True before starting.
# This ensures the bridge uses Qt timer (not background thread) for queue processing.
# - If Qt is not available: Pure headless mode, start bridge directly
# - If no QApplication: True headless mode, start bridge directly
#
# IMPORTANT: We check for QApplication.instance() rather than just QtCore availability
# because FreeCAD bundles PySide even in headless mode (freecadcmd), but there's no
# Qt event loop running. Without a QApplication, Qt timers will never fire.
#
# CRITICAL: We must wait for FreeCAD.GuiUp to be True before starting the bridge
# in GUI mode. If we start when GuiUp is False, the bridge's _start_queue_processor()
# will see GuiUp=False and use a background thread. Later, code executed on that
# thread will try to do Qt operations, causing crashes (SIGABRT in QCocoaWindow).
try:
# Try to import Qt
# Try to import Qt and check for running QApplication
QtCore = None
QtWidgets = None
_has_qapp = False
_is_true_headless = False
try:
from PySide2 import QtCore # type: ignore[assignment, no-redef]
from PySide2 import QtCore, QtWidgets # type: ignore[assignment, no-redef]
except ImportError:
with contextlib.suppress(ImportError):
from PySide6 import QtCore # type: ignore[assignment, no-redef]
from PySide6 import QtCore, QtWidgets # type: ignore[assignment, no-redef]
# Detect GUI mode vs true headless mode
# - True headless (freecadcmd): QCoreApplication exists but NOT QApplication
# - GUI mode early startup: No app yet, or QApplication being initialized
# - GUI mode ready: FreeCAD.GuiUp is True
if QtWidgets is not None and QtCore is not None:
qapp = QtWidgets.QApplication.instance()
if qapp is not None:
_has_qapp = True
else:
# No QApplication - check if QCoreApplication exists
# If QCoreApplication exists but is NOT a QApplication, it's true headless
qcore_app = QtCore.QCoreApplication.instance()
if qcore_app is not None and not isinstance(
qcore_app, QtWidgets.QApplication
):
_is_true_headless = True
# If no app at all, assume early GUI startup (will use GuiWaiter)
FreeCAD.Console.PrintMessage(
f"Startup Bridge: GuiUp={FreeCAD.GuiUp}, "
f"QtCore={'available' if QtCore else 'unavailable'}, "
f"QApp={'running' if _has_qapp else 'none'}, "
f"headless={_is_true_headless}\n"
)
if FreeCAD.GuiUp:
# GUI is already up - start bridge directly
FreeCAD.Console.PrintMessage("Startup Bridge: GUI already up, starting...\n")
_start_bridge()
elif _is_true_headless:
# True headless mode - QCoreApplication exists but not QApplication
# No Qt event loop for GUI, so start bridge directly with background thread
FreeCAD.Console.PrintMessage(
"Startup Bridge: True headless mode (QCoreApplication only), "
"starting directly...\n"
)
_start_bridge()
elif QtCore is not None:
# GUI not ready yet, but Qt is available (FreeCAD starting in GUI mode)
# GUI not ready yet (either QApplication exists or no app yet)
# Use GuiWaiter to wait for GuiUp to become True before starting
# This ensures the bridge uses Qt timer (not background thread) for queue
FreeCAD.Console.PrintMessage(
"Startup Bridge: GUI not ready, using GuiWaiter...\n"
)
from bridge_utils import GuiWaiter
_gui_waiter = GuiWaiter(
@@ -165,10 +210,11 @@ try:
)
_gui_waiter.start()
else:
# True headless mode - no Qt, no GUI
# No Qt available at all - unusual state, start directly
FreeCAD.Console.PrintMessage(
"Startup Bridge: Headless mode, starting directly...\n"
"Startup Bridge: No Qt available, starting directly...\n"
)
_start_bridge()
except Exception as e:
FreeCAD.Console.PrintError(f"Startup Bridge: Failed to initialize: {e}\n")
FreeCAD.Console.PrintError(traceback.format_exc())