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

fix: remove score toggle if not applicable #1468

Merged
merged 4 commits into from
Feb 4, 2025

Conversation

Mohamed-Hacene
Copy link
Collaborator

@Mohamed-Hacene Mohamed-Hacene commented Feb 4, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced the assessment view by hiding the checkbox when the assessment result is 'not applicable', improving user interaction with the scoring functionality.
  • Style

    • Streamlined the application of CSS classes for the checkbox component, enhancing the overall structure and readability.

Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

Warning

Rate limit exceeded

@nas-tabchiche has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 15 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e690519 and e6ad5b1.

📒 Files selected for processing (1)
  • frontend/src/lib/components/Forms/Checkbox.svelte (1 hunks)

Walkthrough

This pull request introduces a conditional rendering logic in the Score component that determines the visibility of the Checkbox component based on the value of requirementAssessment.result. If the result is 'not_applicable', the Checkbox will not be displayed. Additionally, modifications to the structure and class bindings of the Checkbox component's HTML elements have been made to streamline class application. No changes to exported or public entities have been made.

Changes

File(s) Change Summary
frontend/src/routes/(app)/(third-party)/compliance-assessments/[id=uuid]/table-mode/+page.svelte Added conditional rendering for Checkbox based on requirementAssessment.result. Adjusted indentation and formatting.
frontend/src/lib/components/Forms/Checkbox.svelte Modified class bindings for outer and inner <div> elements to streamline hidden state logic. No changes to functionality or event handling.

Sequence Diagram(s)

sequenceDiagram
    participant Score as Score Component
    participant Check as Condition Evaluator
    participant Checkbox as Checkbox Component

    Score->>Check: Evaluate requirementAssessment.result
    alt result equals "not_applicable"
        Check-->>Score: Return false (skip Checkbox)
    else
        Check-->>Score: Return true (proceed with rendering)
        Score->>Checkbox: Render Checkbox Component
    end
Loading

Suggested reviewers

  • ab-smith

Poem

I'm a bunny, swift and bright,
Hopping through lines of code with delight.
Checkbox now will gracefully hide,
When "not_applicable" is in stride.
A little tweak, a careful hop—
Celebrating changes, never to stop!
🐰✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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: 0

🧹 Nitpick comments (2)
frontend/src/routes/(app)/(third-party)/compliance-assessments/[id=uuid]/table-mode/+page.svelte (2)

402-418: LGTM! Consider extracting the condition for reusability.

The conditional rendering of the score toggle aligns well with the disabled state of the Score components. However, since this condition is used in multiple places, consider extracting it into a computed property.

 <script lang="ts">
+  $: isApplicable = (requirementAssessment) => requirementAssessment.result !== 'not_applicable';
   // ... rest of the script
 </script>

 <!-- In the template -->
-  {#if requirementAssessment.result !== 'not_applicable'}
+  {#if isApplicable(requirementAssessment)}
     <Checkbox
       form={superForm(requirementAssessment.scoreForm, {
         id: `requirement-is-scored-${requirementAssessment.id}`
       })}
       field="is_scored"
       label={''}
       helpText={m.scoringHelpText()}
       checkboxComponent="switch"
       class="h-full flex flex-row items-center justify-center my-1"
       classesContainer="h-full flex flex-row items-center space-x-4"
       on:change={async () => {
         requirementAssessment.is_scored = !requirementAssessment.is_scored;
         await update(requirementAssessment, 'is_scored');
       }}
     />
   {/if}

399-400: Extract duplicated disabled state conditions.

The disabled state conditions are duplicated between the Score components. Extract them into a computed property to improve maintainability.

 <script lang="ts">
+  $: isScoreDisabled = (requirementAssessment) => 
+    !requirementAssessment.is_scored || requirementAssessment.result === 'not_applicable';
   // ... rest of the script
 </script>

 <!-- In the template -->
 <Score
   // ... other props
-  disabled={!requirementAssessment.is_scored ||
-    requirementAssessment.result === 'not_applicable'}
+  disabled={isScoreDisabled(requirementAssessment)}
 />

 <Score
   // ... other props
-  disabled={!requirementAssessment.is_scored ||
-    requirementAssessment.result === 'not_applicable'}
+  disabled={isScoreDisabled(requirementAssessment)}
 />

Also applies to: 433-434

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cc9805a and 5f60bc5.

📒 Files selected for processing (1)
  • frontend/src/routes/(app)/(third-party)/compliance-assessments/[id=uuid]/table-mode/+page.svelte (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: startup-functional-test (3.12)
  • GitHub Check: startup-docker-compose-test
  • GitHub Check: enterprise-startup-functional-test (3.12)
  • GitHub Check: enterprise-startup-docker-compose-test
  • GitHub Check: functional-tests (3.12, chromium)
  • GitHub Check: migrations-check (3.12)
  • GitHub Check: enterprise-functional-tests (3.12, chromium)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript-typescript)

ab-smith and others added 2 commits February 4, 2025 12:31
…results

If you enable scoring, set result as not applicable, then set it back to
another result, the scoring toggle appears on the 'off' position but the
score slider is displayed.
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: 0

🧹 Nitpick comments (1)
frontend/src/lib/components/Forms/Checkbox.svelte (1)

39-39: Consider adding ARIA attributes for better accessibility.

The class structure looks good, but consider adding aria-disabled to match the visual disabled state:

-	<div class="flex flex-row space-x-2 items-center {classesDisabled(disabled)}">
+	<div
+		class="flex flex-row space-x-2 items-center {classesDisabled(disabled)}"
+		aria-disabled={disabled}>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5f60bc5 and e690519.

📒 Files selected for processing (2)
  • frontend/src/lib/components/Forms/Checkbox.svelte (1 hunks)
  • frontend/src/routes/(app)/(third-party)/compliance-assessments/[id=uuid]/table-mode/+page.svelte (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/src/routes/(app)/(third-party)/compliance-assessments/[id=uuid]/table-mode/+page.svelte
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: startup-functional-test (3.12)
  • GitHub Check: startup-docker-compose-test
  • GitHub Check: enterprise-startup-functional-test (3.12)
  • GitHub Check: enterprise-functional-tests (3.12, chromium)
  • GitHub Check: enterprise-startup-docker-compose-test
  • GitHub Check: functional-tests (3.12, chromium)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
frontend/src/lib/components/Forms/Checkbox.svelte (1)

38-38: LGTM! Improved hidden state handling.

Moving the hidden state logic to the container level is a better architectural choice as it ensures the entire component is hidden as a unit.

Copy link
Contributor

@nas-tabchiche nas-tabchiche left a comment

Choose a reason for hiding this comment

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

LGTM, to merge once CI is green.

@nas-tabchiche nas-tabchiche merged commit 1f30b48 into main Feb 4, 2025
18 checks passed
@nas-tabchiche nas-tabchiche deleted the fix/hide-score-toggle-not-applicable branch February 4, 2025 17:07
@github-actions github-actions bot locked and limited conversation to collaborators Feb 4, 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.

3 participants