Fix Traceback Display

[t0mdavid-m]

Summary by CodeRabbit

• Bug Fixes
  • Enhanced error logging in workflow processing to include detailed error traces, providing better diagnostics when workflows encounter issues.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Added traceback module import to WorkflowManager.py and enhanced exception handling in the workflow_process method to log formatted exception tracebacks alongside error messages. No control flow modifications; diagnostic information capture improved.

Changes

Cohort / File(s)	Summary
Error handling & diagnostics src/workflow/WorkflowManager.py	Added traceback import and logging of formatted exception details in workflow_process exception handler for improved error diagnostics

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single-file change with minimal scope
• Straightforward logging enhancement with no logic alterations
• Import addition and one-line logging addition in exception block

Poem

🐰 A trace of trouble, now laid bare,
With traceback logs floating through the air,
Debugging secrets no longer hidden deep,
Our workflow's health, we'll faithfully keep! 🌙✨

Pre-merge checks and finishing touches

✅ 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 'Fix Traceback Display' accurately reflects the main change: adding traceback support to error handling in WorkflowManager.py to display exception tracebacks when errors occur.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ 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 traceback_display

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/workflow/WorkflowManager.py (1)

52-53: Simplify exception logging with traceback.format_exc() for better readability.

While the current traceback.format_exception(e) syntax is compatible with the project's Python 3.10+ minimum version requirement, using traceback.format_exc() is simpler and more idiomatic:

• Returns a string directly without requiring "".join()
• More concise and readable
• Works consistently across all Python versions

Consider this change:

-        except Exception as e:
-            self.logger.log(f"ERROR: {e}")
-            self.logger.log("".join(traceback.format_exception(e)))
+        except Exception as e:
+            self.logger.log(f"ERROR: {e}")
+            self.logger.log(traceback.format_exc())

Alternatively, since format_exc() already includes the exception message, consolidate to a single log call:

-        except Exception as e:
-            self.logger.log(f"ERROR: {e}")
-            self.logger.log("".join(traceback.format_exception(e)))
+        except Exception:
+            self.logger.log(traceback.format_exc())

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6fd1a91 and 926f59c.

📒 Files selected for processing (1)

• src/workflow/WorkflowManager.py (2 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

src/workflow/WorkflowManager.py (1)

src/workflow/Logger.py (1)

• log (16-42)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build-openms
• GitHub Check: build-simple-app
• GitHub Check: build-full-app
• GitHub Check: test (ubuntu-latest, 3.11)

🔇 Additional comments (1)

src/workflow/WorkflowManager.py (1)

11-11: LGTM! Import added for traceback formatting.

The traceback module import is correctly placed and necessary for the enhanced error logging functionality.