Extended error handling when a node fails by jonatan-qm · Pull Request #143 · qua-platform/qualibrate-core

jonatan-qm · 2025-11-26T14:25:45Z

Part of solving https://quantum-machines.atlassian.net/browse/QUAL-1645

Enhances error reporting for calibration node failures by providing the user with richer debugging context, including source code snippets, simplified tracebacks, and action execution history. This information is displayed by the frontend.

This change also affects qualibrate-core, where the qua-platform/qualibrate-runner#64 needs to be merged before this one is merged, for everything to be working.

Key Changes

Extended RunError model with details_headline and details fields for structured error context
Simplified traceback generation that filters out framework overhead and focuses on user code
Source code snippet extraction showing the exact location where errors occurred (with surrounding context)
Action execution tracking including completed, skipped, and failed actions
Comprehensive unit tests for action.py and action_manager.py (854 new test lines)
Improved code documentation with clarifying comments in action framework modules

Technical Implementation

The error handling for failed nodes now provides:

Error headlines: Concise descriptions like "Failed action 'execute_qua_program'" or "Failure in node body"
Error details: Markdown-formatted context including:
- Source code snippet with error marker
- Simplified traceback showing only relevant frames
- Action execution history (completed/skipped actions)
Smart traceback simplification: Removes framework overhead while preserving the full call chain within user code

Testing

Added comprehensive unit tests covering action registration, execution, error handling, and state management.
Updated README.md with testing instructions.

…ction in README.md on how to run the tests.

…manager.py and run_action/utils.py

… into feat/extended-error-handling

…lass

Elad-Zaharan · 2025-12-07T16:23:34Z

+            start_idx = node_frames_after_framework[0]
+        else:
+            # Fallback: use first node frame
+            # (shouldn't happen in normal execution)


Here, does it mean that the framework code ran after the users code? if that's the case maybe we could add it as a comment

This is a weird edge case, and I added this just to be sure. It is because it parses a trace and tries to remove all irrelevant information. But this is not likely to happen.

Elad-Zaharan · 2025-12-08T11:48:00Z

+
+    @pytest.fixture
+    def mock_node(self):
+        """Provide a mock QualibrationNode."""


code duplication

You're absolutely right. I am moving this to conftest.py.

Elad-Zaharan · 2025-12-08T11:48:36Z

+
+    @pytest.fixture
+    def mock_manager(self):
+        """Provide a mock ActionManager."""


same as the first mock with some extensions, could we maybe extend the first mock manager and make it to whole file?

You're absolutely right. I am moving this to conftest.py.

Elad-Zaharan · 2025-12-08T14:03:45Z

+        return Mock()
+
+    @pytest.fixture
+    def mock_node(self):


we might consider scoping here aswell so nothing override mutable objects this fixture returns

You're absolutely right. I am moving this to conftest.py.

…into feat/extended-error-handling

Elad-Zaharan · 2025-12-09T15:16:29Z

+class TestRunAction:
+    """Tests for the run_action method."""
+
+    @pytest.fixture


same fixture here, maybe we can extract it to conftest, seems like in this file it appears a lot

You're right! I will do that now.

Elad-Zaharan · 2025-12-09T15:17:00Z

+
+    @pytest.fixture
+    def mock_node(self):
+        """Provide a mock QualibrationNode."""


here aswell, maybe we can extract to conftest because we use it a lot

You're right! I will do that now.

Elad-Zaharan · 2025-12-09T15:22:32Z

+    """Tests for the register_action decorator."""
+
+    @pytest.fixture
+    def manager(self):


same fixture

You're right! I will do that now.

Elad-Zaharan · 2025-12-09T15:22:53Z

+
+    @pytest.fixture
+    def mock_node(self):
+        """Provide a mock QualibrationNode."""


pretty similar to previous one, maybe we can extend it here but might declare in conftest

You're right! I will do that now.

… into feat/extended-error-handling

jonatan-qm added 8 commits November 6, 2025 09:33

Adding unit tests for action.py and action_manager.py. Added short se…

2cf7704

…ction in README.md on how to run the tests.

Added clarifying comments to run_action/action.py, run_action/action_…

dc21ed3

…manager.py and run_action/utils.py

Simplifying comments

641ad83

Merge main branch (commit '23a359148472070ebb3064f81fbf14c621f54451')…

28700e1

… into feat/extended-error-handling

Changed comments - better explanations

db25838

Merge main branch (commit 'd38c50d481e546d1c1012814345b0cc65e33ef84')…

6afdb9f

… into feat/extended-error-handling

Adding optional fields 'details_headline' and 'details' to RunError c…

1ee0361

…lass

Adding details to error messaging when a node fails

d0bbeef

jonatan-qm self-assigned this Nov 26, 2025

jonatan-qm mentioned this pull request Nov 26, 2025

Extended error handling when a node fails qua-platform/qualibrate-runner#64

Merged

jonatan-qm added 3 commits November 26, 2025 15:44

Lint fix

3f2e1ae

More lint fixes - no functional changes

6d6419d

Lint formatting fix.

283da29

jonatan-qm requested review from natangqm and nulinspiratie November 26, 2025 15:27

jonatan-qm marked this pull request as ready for review November 26, 2025 20:52

jonatan-qm requested review from Elad-Zaharan and removed request for natangqm November 27, 2025 08:40

Merge branch 'main' into feat/extended-error-handling

e9147b6

Elad-Zaharan reviewed Dec 9, 2025

View reviewed changes

jonatan-qm added 3 commits December 10, 2025 15:08

Changes based on pull request comments

e1a29d0

Minor changes based on pull request comments

55b0c5a

Merge main branch, commit '9e47f299c00aed8bbcc08f44307176b195b9d0bd' …

e51a257

…into feat/extended-error-handling

Elad-Zaharan reviewed Dec 16, 2025

View reviewed changes

jonatan-qm added 3 commits December 23, 2025 14:53

Minor changes based on pull request feedback

8362eab

Merge main branch (commit 'e02b120503bdeccf0579ef406ece2c2cc48f36d0')…

ca36646

… into feat/extended-error-handling

Fixing lint errors

1398be0

Elad-Zaharan approved these changes Jan 6, 2026

View reviewed changes

jonatan-qm merged commit 6d9eed5 into main Jan 6, 2026
2 of 3 checks passed

jonatan-qm deleted the feat/extended-error-handling branch January 6, 2026 10:17

Uh oh!

Conversation

jonatan-qm commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jonatan-qm commented Nov 26, 2025 •

edited

Loading