CXFLW-1520 GH | PR decoration comments interacting with CxFlow #1421
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
New Issues (14)Checkmarx found the following issues in this Pull Request
Fixed Issues (12)Great job! The following issues were fixed in this Pull Request
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Description & Value:
The goal is for users to be able to inquire about what CXFlow is doing by commenting with @CXFlow in their respective bug tracker. CXFlow would then capture these events and interpret the command in the comment (e.g., update, rescan, or other actions). For unsupported commands like "open the pod bay doors" (an impossible command for CXFlow), the system would respond with, "I'm afraid I can't do that, Dave."
Background:
In a PR the developer is waiting for a scan and sometimes would like to get some information or take some actions with CxFlow.
User Flow:
Recording: link
Commands
@CXFlow scan-status
@CXFlow re-scan
@CXFlow cancel-scan
Acceptance Criteria:
It's possible to write some commands in the comment section and get information
Functional Requirements:
Command Capture and Interpretation:
When a comment is made with @CXFlow, we need to parse it to determine whether it's a valid command like update or rescan. If it's unsupported, the system will respond with a predefined message like "I'm afraid I can't do that, Dave."
Advantage: This interaction would improve user engagement, allowing users to feel more in control of the process.
Disadvantage: Implementing this functionality across various bug trackers will be time-consuming and will require careful command parsing and error handling.
Bug Tracker Integration:
We plan to integrate this functionality one bug tracker at a time. This incremental approach would allow us to manage the complexity and tailor the feature per tracker.
Advantage: Gradually rolling out this feature reduces the risk of system-wide issues and allows for a smoother adoption process.
Disadvantage: It would take a significant amount of time to cover all bug trackers, delaying full implementation across the system.
Handling Unsupported Commands:
If the user requests an action that is not supported, such as "open the pod bay doors," CXFlow will respond with, "I'm afraid I can't do that, Dave." This ensures that the system gracefully handles invalid inputs.
Advantage: Provides clear feedback for unsupported commands, making the system more robust and user-friendly.
Disadvantage: If not properly managed, the system may end up responding frequently with this fallback message, which could become repetitive or frustrating for users.
Phased Rollout:
Given the complexity of this task, we are not closing this issue immediately. Instead, we will break it into smaller tasks and start by implementing this functionality for one bug tracker in the upcoming releases.
Advantage: Phasing this rollout allows us to focus on a high-quality implementation and learn from early feedback.
Disadvantage: This phased approach means that full functionality will not be available immediately, which may limit user satisfaction in the short term.
By implementing these improvements, we aim to make CXFlow more interactive and responsive, while also acknowledging that full integration will take time due to the complexity of supporting multiple bug trackers.