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: compute audit progress taking into account selected implementation groups #1406

Conversation

nas-tabchiche
Copy link
Contributor

@nas-tabchiche nas-tabchiche commented Jan 22, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved progress calculation method for compliance assessments
    • Enhanced performance and readability of progress tracking logic

Copy link

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request introduces modifications to the progress method in the ComplianceAssessment class within the backend/core/models.py file. The changes refine the progress calculation logic by using a list comprehension to filter and count requirement assessments. The new implementation aims to improve code readability and potentially optimize the performance of progress tracking by reducing database queries.

Changes

File Change Summary
backend/core/models.py Updated progress() method in ComplianceAssessment class with refined logic for calculating progress percentage

Poem

🐰 A Rabbit's Progress Tale 🔍

In lines of code, a method grows,
Counting assessments as it goes
With list comprehension's might,
Progress tracking, clean and bright!
A dance of numbers, swift and clear,
Efficiency brings coding cheer! 🚀

✨ 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

@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: 0

🧹 Nitpick comments (1)
backend/core/models.py (1)

3231-3242: Consider optimizing the progress calculation.

The current implementation creates an intermediate list just to count elements. Consider using a generator expression to avoid the unnecessary list creation:

-        requirement_assessments = list(
-            self.get_requirement_assessments(include_non_assessable=False)
-        )
-        total_cnt = len(requirement_assessments)
-        assessed_cnt = len(
-            [
-                r
-                for r in requirement_assessments
-                if r.result != RequirementAssessment.Result.NOT_ASSESSED
-            ]
-        )
+        requirement_assessments = self.get_requirement_assessments(include_non_assessable=False)
+        total_cnt = sum(1 for _ in requirement_assessments)
+        assessed_cnt = sum(
+            1 for r in requirement_assessments
+            if r.result != RequirementAssessment.Result.NOT_ASSESSED
+        )
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5d0a017 and 7790f5f.

📒 Files selected for processing (1)
  • backend/core/models.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: startup-functional-test (3.12)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: startup-docker-compose-test
  • GitHub Check: enterprise-functional-tests (3.12, chromium)
  • GitHub Check: ruff (3.12)
  • GitHub Check: enterprise-startup-functional-test (3.12)
  • GitHub Check: functional-tests (3.12, chromium)
  • GitHub Check: enterprise-startup-docker-compose-test
  • GitHub Check: test (3.12)
  • GitHub Check: build (3.12)
🔇 Additional comments (1)
backend/core/models.py (1)

3231-3242: LGTM! The progress calculation correctly handles assessable requirements.

The changes improve the progress calculation by:

  1. Using get_requirement_assessments(include_non_assessable=False) to filter out non-assessable requirements
  2. Using list comprehension for better readability
  3. Handling the edge case when there are no requirements

@ab-smith ab-smith merged commit 604b405 into main Jan 23, 2025
18 checks passed
@ab-smith ab-smith deleted the CA-825-calculate-review-progress-with-selected-implementation-groups branch January 23, 2025 15:09
@github-actions github-actions bot locked and limited conversation to collaborators Jan 23, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants