Skip to content

ROX-29513: Replace CSV report preview with Non-optional columns#15467

Merged
pedrottimark merged 1 commit intomasterfrom
ROX-29513-ReportParametersDetails-Non-optional
May 28, 2025
Merged

ROX-29513: Replace CSV report preview with Non-optional columns#15467
pedrottimark merged 1 commit intomasterfrom
ROX-29513-ReportParametersDetails-Non-optional

Conversation

@pedrottimark
Copy link
Contributor

@pedrottimark pedrottimark commented May 28, 2025

Description

Problem

Good eyes, Ross!

The report preview does not include an ADvisory column when I indicate I want to see advisories

How did I overlook during 3 release cycles when we have added:

  • NVD CVSS
  • EPSS probability
  • Advisory

Thank you, Surabhi for examples of CSV files and answer to question about body of e-mail message when I was confused which preview has the problem.

Which leads to problems, other than inconsistency:

  • One more thing to update whenever we add a column.
    Because there are at least 10 RFE for additional columns, the simpler to add, the better.
  • Horizontal scrolling farther and farther, because optional columns would be at the end.
    Redundant with Optional columns in Report parameters.
  • Another more thing to add made-up data for 3 rows.
    Increasingly difficult for combinations of data not to become impossible.
    Width of realistic Advisory Link data implies even more horizonatal scrolling.

Analysis

Non-optional columns rarely change and they precede Optional columns for which we have a pattern to update.

However, they have changed since the original design of the preview:

  • Component Upgrade in preview is CVE Fixed In in file.
  • false and true in preview is FALSE and TRUE in file.
  • Low and Moderate (with icons) in preview is LOW and MODERATE (without icons) in file.

Solution

Less is more:

User-facing documentation

  • CHANGELOG.md update is not needed
  • documentation PR is not needed

Testing and quality

  • the change is production ready: the change is GA, or otherwise the functionality is gated by a feature flag
  • CI results are inspected

Automated testing

  • added unit tests
  • added e2e tests
  • added regression tests
  • added compatibility tests
  • modified existing tests

How I validated my change

  1. npm run tsc in ui/apps/platform folder.
  2. npm run lint in ui/apps/platform folder.

Manual testing

  1. Visit /main/vulnerabilities/reports/configuration?action=create enter name, select one or more checkboxes under Optional columns, select collection, and advance to Review and create step.

    • Before changes, see presence of CVE report format but absence of any selected columns.
      ReportReviewForm

    • After changes, see absence of CVE report format but presence of Non-optional columns preceding Optional columns.
      ReportParametersDetails

@pedrottimark pedrottimark requested a review from a team as a code owner May 28, 2025 15:23
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @pedrottimark - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@rhacs-bot
Copy link
Contributor

Images are ready for the commit at c115b3c.

To use with deploy scripts, first export MAIN_IMAGE_TAG=4.8.x-834-gc115b3c733.

@codecov
Copy link

codecov bot commented May 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.25%. Comparing base (37eeeb6) to head (c115b3c).
Report is 9 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #15467   +/-   ##
=======================================
  Coverage   49.25%   49.25%           
=======================================
  Files        2581     2581           
  Lines      189326   189326           
=======================================
+ Hits        93251    93256    +5     
+ Misses      88735    88732    -3     
+ Partials     7340     7338    -2     
Flag Coverage Δ
go-unit-tests 49.25% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pedrottimark pedrottimark merged commit 1403b65 into master May 28, 2025
88 checks passed
@pedrottimark pedrottimark deleted the ROX-29513-ReportParametersDetails-Non-optional branch May 28, 2025 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants