Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: fix reporting close functionality + misc #6066

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

Ice3man543
Copy link
Member

@Ice3man543 Ice3man543 commented Feb 23, 2025

Proposed changes

Checklist

  • Pull request is created against the dev branch
  • All checks passed (lint, unit/integration/regression tests etc.) with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Summary by CodeRabbit

  • Enhancements
    • Refined issue management to ensure consistency when creating and closing tickets by adjusting the criteria used during processing.
    • Improved integration with external issue tracking systems for a more reliable workflow.
  • Bug Fixes
    • Restored full functionality for exporting reports, ensuring complete and accurate data delivery.

@auto-assign auto-assign bot requested a review from dwisiswant0 February 23, 2025 17:52
Copy link
Contributor

coderabbitai bot commented Feb 23, 2025

Walkthrough

This pull request reintroduces the MongoDB exporter import in the reporting package and inverts the logic in the CloseIssue method to alter the control flow when filtering events. In addition, the Jira tracker has been updated by modifying the FindExistingIssue method signature to include a boolean parameter useStatus, and adjusting its use in both CreateIssue and CloseIssue methods. The JQL query has also been enhanced to conditionally apply a status check based on the new parameter.

Changes

File Change Summary
pkg/reporting/reporting.go Reintroduced MongoDB exporter import; inverted condition in CloseIssue to continue if the tracker does not filter the event.
pkg/reporting/trackers/jira/jira.go Updated FindExistingIssue signature to include a useStatus flag; modified calls in CreateIssue (using true) and CloseIssue (using false); adjusted JQL query to include status filtering conditionally.

Sequence Diagram(s)

sequenceDiagram
    participant RC as ReportingClient
    participant T as Tracker
    participant IC as IssueCloser
    RC->>T: ShouldFilter(event)
    alt Tracker does NOT filter event (!ShouldFilter)
        RC->>IC: Proceed with closing issue
    else Tracker filters event
        RC->>RC: Skip to next iteration
    end
Loading
sequenceDiagram
    participant J as JiraIntegration
    participant DB as JIRA Database
    Note over J,DB: Issue Processing in Jira Tracker
    J->>J: Call FindExistingIssue(event, useStatus)
    alt Creating Issue (useStatus=true)
         J->>DB: Query with status filter included
    else Closing Issue (useStatus=false)
         J->>DB: Query without status filter
    end
Loading

Suggested reviewers

  • dogancanbakir
  • ehsandeep

Poem

I'm a rabbit with hops so swift,
Dancing through code with a joyful lift.
Mongo joins the party, shining ever bright,
Jira flows refined in the moonlit night.
Bugs and issues, hop away from sight!
🐰✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 047d49f and eb0b865.

📒 Files selected for processing (2)
  • pkg/reporting/reporting.go (2 hunks)
  • pkg/reporting/trackers/jira/jira.go (3 hunks)
🔇 Additional comments (5)
pkg/reporting/reporting.go (1)

9-9: LGTM!

The MongoDB exporter import has been reintroduced.

pkg/reporting/trackers/jira/jira.go (4)

303-303: LGTM!

The addition of the useStatus parameter enhances the flexibility of the FindExistingIssue method by allowing control over whether to consider issue status in the JQL query.


243-243: LGTM!

Correctly passing true for useStatus to consider status when finding existing issues during creation/update.


268-268: LGTM!

Correctly passing false for useStatus to ignore status when finding existing issues during closure.


309-312: LGTM!

The JQL query has been improved:

  • Base query is now cleaner
  • Status condition is conditionally added based on useStatus parameter

@@ -329,7 +330,7 @@ func (c *ReportingClient) CreateIssue(event *output.ResultEvent) error {
// CloseIssue closes an issue in the tracker
func (c *ReportingClient) CloseIssue(event *output.ResultEvent) error {
for _, tracker := range c.trackers {
if tracker.ShouldFilter(event) {
if !tracker.ShouldFilter(event) {
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix the inverted condition in CloseIssue method.

The condition has been inverted which changes the intended behavior. Issues will now be closed when they should NOT be filtered, which appears to be incorrect.

Apply this diff to fix the logic:

-		if !tracker.ShouldFilter(event) {
+		if tracker.ShouldFilter(event) {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if !tracker.ShouldFilter(event) {
if tracker.ShouldFilter(event) {

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.

2 participants