Skip to content

BED-5960 feat(AGT): add analysis enabled / disabled actions to AGT history #1663

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

Merged
merged 1 commit into from
Jul 14, 2025

Conversation

mistahj67
Copy link
Contributor

@mistahj67 mistahj67 commented Jul 9, 2025

Description

Added specific analysisEnabledTag / analysisDisabledTag history records when zone analysis is toggled

Motivation and Context

Resolves: BED-5960

How Has This Been Tested?

Locally enabled / disabled analysis through the PATCH /asset-group-tags endpoint and inspected the db for the new records. Also added unit test to handler test

Screenshots (if appropriate):

Types of changes

  • Chore (a change that does not modify the application functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • Documentation updates are needed, and have been made accordingly.
  • I have added and/or updated tests to cover my changes.
  • All new and existing tests passed.
  • My changes include a database migration.

Summary by CodeRabbit

  • New Features
    • Improved history tracking for asset group tags by recording specific changes when analysis is enabled or disabled.
    • Added clearer action types for analysis status changes in asset group tag history.

@mistahj67 mistahj67 self-assigned this Jul 9, 2025
@mistahj67 mistahj67 added the api A pull request containing changes affecting the API code. label Jul 9, 2025
Copy link
Contributor

coderabbitai bot commented Jul 9, 2025

"""

Walkthrough

The changes introduce more granular history tracking for asset group tags by adding specific history records when the AnalysisEnabled field changes. Two new constants are defined to represent enabling and disabling analysis, and the update logic now creates a separate history entry reflecting such status changes.

Changes

File(s) Change Summary
cmd/api/src/database/assetgrouptags.go Enhanced UpdateAssetGroupTag to create a distinct history record when AnalysisEnabled changes.
cmd/api/src/model/assetgrouphistory.go Added two new constants for analysis enabled/disabled actions to AssetGroupHistoryAction.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Database
    participant History

    Client->>API: UpdateAssetGroupTag request
    API->>Database: Fetch original AssetGroupTag
    API->>Database: Update AssetGroupTag
    API->>History: Create standard update history record
    alt If AnalysisEnabled changed
        API->>History: Create analysis enabled/disabled history record
    end
    API-->>Client: Return update result
Loading

Possibly related PRs

Poem

A tag was changed, a record made,
Now history notes when analysis is played.
Enabled or off, the logs will show,
Each toggle tracked as updates flow.
With constants new and logic neat,
The audit trail is now complete!
🐇✨
"""


📜 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 eeb96fe and 31beeca.

📒 Files selected for processing (2)
  • cmd/api/src/database/assetgrouptags.go (1 hunks)
  • cmd/api/src/model/assetgrouphistory.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • cmd/api/src/model/assetgrouphistory.go
  • cmd/api/src/database/assetgrouptags.go
⏰ 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 BloodHound Container Image / Build and Package Container
  • GitHub Check: run-tests
  • GitHub Check: run-analysis
  • GitHub Check: build-ui
✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@mistahj67 mistahj67 merged commit 22cee93 into main Jul 14, 2025
9 checks passed
@mistahj67 mistahj67 deleted the BED-5960 branch July 14, 2025 17:24
@github-actions github-actions bot locked and limited conversation to collaborators Jul 14, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api A pull request containing changes affecting the API code.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants