Skip to content

feat: Component Status updates#152

Merged
chrisk314 merged 16 commits intomainfrom
feat/component-status-updates
Jul 2, 2025
Merged

feat: Component Status updates#152
chrisk314 merged 16 commits intomainfrom
feat/component-status-updates

Conversation

@toby-coleman
Copy link
Contributor

@toby-coleman toby-coleman commented Jun 25, 2025

Summary

Closes #148.

Changes

  • Add a new Status enum to plugboard.schemas.
  • Add a status property to the Component.
  • Removes from flakiness from the tuner tests.

@toby-coleman toby-coleman changed the title feat: Component Status updates. feat: Component Status updates Jun 25, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @toby-coleman, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a comprehensive status tracking mechanism for components, allowing their lifecycle state to be monitored and persisted. By defining a clear set of statuses and integrating them into the component's operational flow, it enhances observability and error handling within the system.

Highlights

  • New Status Enum: Introduced a new Status enumeration (StrEnum) in plugboard.schemas.state to represent the lifecycle states of a Component or Process. This enum includes states like CREATED, INIT, RUNNING, WAITING, COMPLETED, FAILED, and STOPPED, along with an is_terminal property.
  • Component Status Tracking: Added a status property to the Component class in plugboard/component/component.py. This property is initialized to Status.CREATED upon component instantiation.
  • Automated Status Updates: Implemented an internal _set_status asynchronous method within the Component class to manage status transitions. This method also handles publishing the updated component status to the state backend if connected.
  • Lifecycle Integration: Integrated status updates into key Component lifecycle methods: _handle_init_wrapper (sets INIT), _handle_step_wrapper (sets RUNNING and WAITING, handles FAILED on exception), _stop_event_handler (sets STOPPED), and run (sets RUNNING and COMPLETED).
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a status tracking mechanism for components by adding a Status enum and integrating it into the component lifecycle. I've identified a critical bug where a flag is unused, a high-severity issue in the run method's logic that could lead to an inconsistent state, and a medium-severity issue with logging usage. The provided suggestions aim to fix these issues and improve the robustness of the new feature.

@toby-coleman toby-coleman marked this pull request as ready for review June 29, 2025 14:21
@toby-coleman toby-coleman requested a review from chrisk314 June 29, 2025 14:21
@codecov
Copy link

codecov bot commented Jun 29, 2025

Codecov Report

Attention: Patch coverage is 97.50000% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
plugboard/schemas/state.py 91.66% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@chrisk314 chrisk314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@chrisk314 chrisk314 merged commit e71b82b into main Jul 2, 2025
16 checks passed
@chrisk314 chrisk314 deleted the feat/component-status-updates branch July 2, 2025 09:43
chrisk314 added a commit that referenced this pull request Aug 13, 2025
# Summary
This PR closes #151 by modifying the logic in the `Component.step`
wrapper to check the status of the process periodically to avoid waiting
indefinitely for inputs when a process is in a failed state.

# Changes
- Adds methods to `StateBackend` implementations to update and retrieve
just the `Process.status` attribute.
- Modifies logic of the `Component.step` wrapper to periodically check
the `Process.status` attribute and break out of `io.read` if necessary.

# Note
This PR builds on changes awaiting merge in #152.

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Status updates from component

2 participants