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(OverallRiskLevel): cap risk score display to a maximum of 100 #3008

Merged
merged 3 commits into from
Jan 29, 2025

Conversation

shanegrouber
Copy link
Collaborator

@shanegrouber shanegrouber commented Jan 29, 2025

  • Implement logic to limit risk score visualization
  • Ensure no risk score exceeds 100 for better clarity

(Your math skills are so questionable, I’d trust a fortune cookie more)

Summary by CodeRabbit

  • Bug Fixes
    • Ensured risk score display does not exceed 100 in the overall risk level component
    • Updated subproject commit in workflows service data migrations

- Implement logic to limit risk score visualization
- Ensure no risk score exceeds 100 for better clarity

(Your math skills are so questionable, I’d trust a fortune cookie more)
Copy link

changeset-bot bot commented Jan 29, 2025

⚠️ No Changeset found

Latest commit: 2b121b7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

The pull request introduces a modification to the OverallRiskLevel component in the backoffice application. The primary change involves capping the riskScore display at 100 by using Math.min(riskScore ?? 0, 100). This ensures that the risk score shown to the user does not exceed 100, even if the underlying score might be higher. The change is localized to the rendering logic and does not affect the component's overall structure or functionality.

Changes

File Change Summary
apps/backoffice-v2/src/common/components/molecules/OverallRiskLevel/OverallRiskLevel.tsx Modified risk score display to cap at 100 using Math.min(riskScore ?? 0, 100)
services/workflows-service/prisma/data-migrations Updated subproject commit from 4d14afe76300c59a1f91e0a732acf2bbf5c9ca3b to 9d9636f6c7c458c27ea139439b5dd9eb69980078

Possibly related PRs

Suggested reviewers

  • Omri-Levy
  • MatanYadaev

Poem

🐰 A rabbit's risk tale, oh so neat,
Capping scores with a mathematical feat
One hundred max, no more, no less
Our UI now passes the risk-score test!
Hop hop, code clean, risk displayed with glee 🎲


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 (1)
apps/backoffice-v2/src/common/components/molecules/OverallRiskLevel/OverallRiskLevel.tsx (1)

48-48: LGTM! Clean implementation of the risk score capping.

The implementation effectively caps the displayed risk score at 100 while handling undefined/null cases appropriately.

Consider adding a comment to explain why we cap at 100:

+            {/* Cap display at 100 for better UX while preserving actual risk calculation */}
             {Math.min(riskScore ?? 0, 100)}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 53266d4 and 718dfb9.

📒 Files selected for processing (2)
  • apps/backoffice-v2/src/common/components/molecules/OverallRiskLevel/OverallRiskLevel.tsx (1 hunks)
  • services/workflows-service/prisma/data-migrations (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • services/workflows-service/prisma/data-migrations
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: test_windows
  • GitHub Check: test_linux
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: lint
🔇 Additional comments (1)
apps/backoffice-v2/src/common/components/molecules/OverallRiskLevel/OverallRiskLevel.tsx (1)

Line range hint 27-27: Verify that severity calculation uses uncapped score.

The severity calculation appears to use the original uncapped score which is correct. Let's verify this behavior:

Also applies to: 48-48

✅ Verification successful

Severity calculation correctly uses uncapped score

The severity is calculated using the raw risk score before any capping is applied. The Math.min(riskScore ?? 0, 100) operation is only used for display purposes after the severity has already been determined.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that getSeverityFromRiskScore uses uncapped scores

# Search for getSeverityFromRiskScore implementation
echo "Searching for getSeverityFromRiskScore implementation..."
ast-grep --pattern 'export const getSeverityFromRiskScore = $_' -l typescript

# Search for other potential score capping in the codebase
echo "Checking for other score capping instances..."
rg "Math\.min.*100" --type typescript

Length of output: 2843


Script:

#!/bin/bash
# Retry searching for score capping with correct flags
echo "Checking for score capping..."
rg "Math\.min.*100" -t ts -t tsx

# Check how risk score is handled before severity calculation
echo "Checking risk score handling..."
rg "riskScore.*=.*Math\.min" -t ts -t tsx
rg "Math\.min.*riskScore" -t ts -t tsx

# Check how risk score is passed to OverallRiskLevel
ast-grep --pattern 'OverallRiskLevel.*riskScore={$_}' -l typescript

Length of output: 415


Script:

#!/bin/bash
# Search for any score capping
echo "Checking for score capping..."
rg "Math.min.*100"
rg "Math.min.*score"

# Check OverallRiskLevel component usage
echo "Checking component usage..."
rg "OverallRiskLevel.*riskScore"

# Check risk score calculations
echo "Checking risk score handling..."
rg "riskScore.*=.*Math"

Length of output: 630

@shanegrouber shanegrouber enabled auto-merge (squash) January 29, 2025 13:56
@shanegrouber shanegrouber merged commit 4780ac8 into dev Jan 29, 2025
18 checks passed
@shanegrouber shanegrouber deleted the BAL-2906 branch January 29, 2025 15:34
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