feat: added bearer support to jira reporting for self hosted + misc

[Ice3man543]

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

• New Features
  • Jira integration now supports an alternative authentication method using personal access tokens for increased flexibility.
• Refactor
  • The authentication workflow has been streamlined to automatically select between token-based and traditional methods based on the provided credentials.

[coderabbitai]

Walkthrough

The changes update the Jira integration in the reporting package to support Bearer Authentication by adding a new field, PersonalAccessToken, to the Options struct. The existing Email and Token fields have been modified to remove mandatory validation. The New function now checks for the presence of PersonalAccessToken and chooses the appropriate authentication transport (Bearer or Basic) when creating the HTTP client.

Changes

File	Change Summary
pkg/.../jira.go	- Added PersonalAccessToken field to Options - Removed validation from Email and Token fields - Updated New function to select auth transport based on token presence

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant N as New() Function
    participant A as Auth Transport

    C ->> N: Call New(options)
    alt PersonalAccessToken provided
        N ->> A: Initialize with BearerAuthTransport
    else No PersonalAccessToken
        N ->> A: Initialize with BasicAuthTransport
    end
    N ->> C: Return HTTP Client instance

Loading

Poem

Hoppin' through the code, I cheer,
A token now leads our way so clear.
Email and token shed their strict decree,
For a fresh auth flow, wild and free!
In the fields of change, I bounce with glee 🐰
A rabbit’s delight in every line you see!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7c87285 and b47ce6c.

📒 Files selected for processing (1)

• pkg/reporting/trackers/jira/jira.go (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Tests (macOS-latest)
• GitHub Check: Tests (windows-latest)
• GitHub Check: Tests (ubuntu-latest)

🔇 Additional comments (2)

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

72-77: Authentication fields update looks good.

The changes correctly modify the Options struct by removing the required validation for the Email and Token fields and adding a new field for PersonalAccessToken. This implementation properly supports both authentication methods - Basic Auth (using Email/Token) and Bearer Auth (using PersonalAccessToken).

---

111-131:

✅ Verification successful

Authentication logic is well implemented.

The implementation provides a clear conditional path for choosing between Bearer and Basic authentication based on the presence of a personal access token. The code properly handles each authentication method and maintains backward compatibility.

One consideration: there's no handling for the edge case where both PersonalAccessToken and Token/Email are provided. The current logic will prioritize Bearer auth when PersonalAccessToken exists.

---

🏁 Script executed:

#!/bin/bash
# Verify if there are any existing configurations or tests that might be affected by this change

# Check if there are any tests for the jira package
fd -t f "_test\.go" pkg/reporting/trackers/jira/

# Check for any existing sample configurations that might need updating
rg -A 5 -B 5 "jira:" .github/ docs/ examples/ || echo "No sample configurations found in common locations"

Length of output: 294

---

Authentication logic implemented successfully, with one minor documentation suggestion.

The conditional handling between Bearer and Basic authentication is correctly implemented. The tests in pkg/reporting/trackers/jira/jira_test.go confirm that the changes are well-covered. One item to note:

• Edge-case consideration: When both PersonalAccessToken and Token (with username/email) are provided, the code currently prioritizes Bearer authentication without explicit notification. Consider documenting this behavior (or adding explicit handling) so the users are aware of the precedence decision.

Overall, the authentication update is solid, and only the potential ambiguity with dual credential inputs may need clarification.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.