Various WebApp report fixes and new features (part 2) #9868

tsteenbe · 2025-01-30T00:51:32Z

See individual commits for details - expect a part 3 PR to some of the WebApp issues that are still open after this PR.

codecov · 2025-01-30T01:04:40Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.43%. Comparing base (7681705) to head (618ab4c).
Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #9868   +/-   ##
=========================================
  Coverage     68.43%   68.43%           
  Complexity     1308     1308           
=========================================
  Files           250      250           
  Lines          8880     8880           
  Branches        921      921           
=========================================
  Hits           6077     6077           
  Misses         2413     2413           
  Partials        390      390

Flag	Coverage Δ
funTest-docker	`65.14% <ø> (ø)`
funTest-non-docker	`33.37% <ø> (ø)`
test-ubuntu-24.04	`36.13% <ø> (ø)`
test-windows-2022	`36.11% <ø> (ø)`

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.

sschuberth · 2025-01-30T15:22:23Z

@mmurto, @Etsija, @lamppu, feel free to chime in to the review!

sschuberth · 2025-01-30T15:32:10Z

plugins/reporters/web-app-template/src/models/WebAppRuleViolation.js

+            this.#isResolved = !!(this.#resolutionIndexes.size > 0);
+
+            if (this.#isResolved) {
+                this.#severityIndex = this.#severityIndex + 10;


Where does the "magic number" 10 come from here?

Could have been any other number as long as it bigger than 3 but 10 allows for addition of future states and made things easier for remember e.g. SeverityIndex < 10 = unresolved error, warning or hint policy rule violation / issue, anything > 10 is resolved error, warning or hint policy rule violation / issue. Why the "bigger than 3" well you have to take into account column sorting which operates on comparing SeverityIndex integer instead of strings (Error, Warning, Hint).

Error - SeverityIndex 1

Warning - SeverityIndex 2

Hint - SeverityIndex 3

Resolved Error - SeverityIndex 11

Resolved Warning - SeverityIndex 12

Resolved Hint - SeverityIndex 13

plugins/reporters/web-app-template/src/components/RuleViolationsTable.jsx

plugins/reporters/web-app-template/src/components/VulnerabilitiesTable.jsx

plugins/reporters/web-app-template/src/components/VulnerabilitiesResolutionTable.jsx

plugins/reporters/web-app-template/src/models/WebAppVulnerabilityResolution.js

plugins/reporters/web-app-template/src/components/IssuesTable.jsx

MarcelBochtler

Most changes look good to me.

However, I would like to split off the commit feat(web-app-template): Adhere to severe thresholds into a separate PR, to discuss it independently.

MarcelBochtler · 2025-02-03T10:54:10Z

I haven't found the actual problematic code, but changes from this PR cause the report to display HINT issues as Warnings:

From the ort-result.yml:

issues:
  - timestamp: "2025-01-30T22:34:24.894998Z"
    source: "FossId"
    message: "This scan has 990 file(s) pending identification in FossID."
    severity: "HINT"

Prevent unnecessary recomputation of `SeverityIndex` and `isResolved` values in React, ensuring they are only recalculated when their actual values change. Signed-off-by: Thomas Steenbergen <[email protected]>

Replace policy rule violation severity icons with tags so they are more distinguishable and quicker to understand. Signed-off-by: Thomas Steenbergen <[email protected]>

Address minor linter issues by running `yarn lint --fix` to enhance code quality and maintainability. Signed-off-by: Thomas Steenbergen <[email protected]>

Improve the filtering of vulnerability severity levels to provide a clearer and more effective user experience. Signed-off-by: Thomas Steenbergen <[email protected]>

Enhance comment to clearly indicate the elements to which the CSS classes apply, improving code readability. Signed-off-by: Thomas Steenbergen <[email protected]>

Align the red color of error text with the color of the critical known security vulnerability tag in `VulnerabilityRatingTag` to ensure consistency in visual representation. Signed-off-by: Thomas Steenbergen <[email protected]>

…tions Ensure the `id` property of vulnerability resolutions [1] is displayed in `ResolutionTable`, addressing the previous limitation where only issue and policy rule violation resolutions [2] were supported. [1]: https://github.com/oss-review-toolkit/ort/blob/ef8b61c/website/docs/configuration/ort-yml.md#resolving-vulnerabilities [2]: https://github.com/oss-review-toolkit/ort/blob/ef8b61c/website/docs/configuration/ort-yml.md#resolution-basics Signed-off-by: Thomas Steenbergen <[email protected]>

Improve the filtering of issue severity levels to provide a clearer and more effective user experience. Signed-off-by: Thomas Steenbergen <[email protected]>

Re-apply parts 3106879 which was reverted for unclear reasons. Signed-off-by: Thomas Steenbergen <[email protected]>

…rence Implement score and vector following their addition to VulnerabilityReference.kt in 60ef7c9. Signed-off-by: Thomas Steenbergen <[email protected]>

In preparation for an upcoming change to show all references for each vulnerability. Signed-off-by: Thomas Steenbergen <[email protected]>

Show all reference information to facilitate the validation of vulnerabilities, enhancing user understanding. Signed-off-by: Thomas Steenbergen <[email protected]>

Ensure the `pageSize` is passed to pagination, allowing the table to adhere to the `pageSize` set in the initial state. Signed-off-by: Thomas Steenbergen <[email protected]>

Evaluator allows policy rule violations without a package see [1], however this case was not supported in the data mapping from `WebAppRuleViolation` to Ant Design table row data. Fixes #9880. [1]: https://github.com/oss-review-toolkit/ort/blob/cc6f09d/model/src/main/kotlin/RuleViolation.kt#L33 Signed-off-by: Thomas Steenbergen <[email protected]>

tsteenbe · 2025-02-06T00:44:40Z

@MarcelBochtler I dropped the severe threshold commits and fix the hint label issue - was a copy-paste mistake in fix(web-app-template): Enhance rule severity icons and fix(web-app-template): Enhance issue severity filtering which I now have updated.

Once this PR is merged I will fill another PR with the severe threshold commits e.g. feat(web-app-template): Implement severe thresholds in the model and feat(web-app-template): Adhere to severe thresholds .

MarcelBochtler

LGTM.

tsteenbe requested review from sschuberth and fviernau January 30, 2025 00:51

tsteenbe changed the title ~~Webapp fixes updates part 2~~ Various WebApp report fixes and updates (part 2) Jan 30, 2025

tsteenbe changed the title ~~Various WebApp report fixes and updates (part 2)~~ Various WebApp report fixes and new features (part 2) Jan 30, 2025

sschuberth reviewed Jan 30, 2025

View reviewed changes

tsteenbe force-pushed the webapp-fixes-updates-part-2 branch 3 times, most recently from 1e7d1a3 to 874b212 Compare January 30, 2025 16:43

tsteenbe requested a review from sschuberth January 30, 2025 16:44

sschuberth requested a review from a team January 30, 2025 16:48

tsteenbe mentioned this pull request Feb 1, 2025

WebApp Reporter: Rule violations without pkg breaks the report #9880

Closed

tsteenbe force-pushed the webapp-fixes-updates-part-2 branch from 20abb21 to dbc833a Compare February 2, 2025 20:21

MarcelBochtler requested changes Feb 3, 2025

View reviewed changes

tsteenbe added 14 commits February 6, 2025 01:24

fix(web-app-template): Reduce unnecessary render recomputations

102700f

Prevent unnecessary recomputation of `SeverityIndex` and `isResolved` values in React, ensuring they are only recalculated when their actual values change. Signed-off-by: Thomas Steenbergen <[email protected]>

fix(web-app-template): Enhance rule severity icons

8f6caa3

Replace policy rule violation severity icons with tags so they are more distinguishable and quicker to understand. Signed-off-by: Thomas Steenbergen <[email protected]>

fix(web-app-template): Auto-fix minor linter issues

5042d82

Address minor linter issues by running `yarn lint --fix` to enhance code quality and maintainability. Signed-off-by: Thomas Steenbergen <[email protected]>

fix(web-app-template): Enhance vulnerability severity filtering

a1c24bb

Improve the filtering of vulnerability severity levels to provide a clearer and more effective user experience. Signed-off-by: Thomas Steenbergen <[email protected]>

chore(web-app-template): Improve CSS comment for clarity

6691d54

Enhance comment to clearly indicate the elements to which the CSS classes apply, improving code readability. Signed-off-by: Thomas Steenbergen <[email protected]>

style(web-app-template): Align error color

c853a00

Align the red color of error text with the color of the critical known security vulnerability tag in `VulnerabilityRatingTag` to ensure consistency in visual representation. Signed-off-by: Thomas Steenbergen <[email protected]>

fix(web-app-template): Enhance issue severity filtering

550289b

Improve the filtering of issue severity levels to provide a clearer and more effective user experience. Signed-off-by: Thomas Steenbergen <[email protected]>

fix(web-app-template): Fix issue severity filtering

5c8dad4

Re-apply parts 3106879 which was reverted for unclear reasons. Signed-off-by: Thomas Steenbergen <[email protected]>

feat(web-app-template): Add score and vector to VulnerabilityRefe…

8282133

…rence Implement score and vector following their addition to VulnerabilityReference.kt in 60ef7c9. Signed-off-by: Thomas Steenbergen <[email protected]>

feat(web-app-template): Add helper function to WebAppVulnerability

f452019

In preparation for an upcoming change to show all references for each vulnerability. Signed-off-by: Thomas Steenbergen <[email protected]>

feat(web-app-template): Display vulnerability references

cd20cfc

Show all reference information to facilitate the validation of vulnerabilities, enhancing user understanding. Signed-off-by: Thomas Steenbergen <[email protected]>

fix(web-app-template): Correct pagination in various tables

5e4aa35

Ensure the `pageSize` is passed to pagination, allowing the table to adhere to the `pageSize` set in the initial state. Signed-off-by: Thomas Steenbergen <[email protected]>

tsteenbe force-pushed the webapp-fixes-updates-part-2 branch from dbc833a to 618ab4c Compare February 6, 2025 00:42

tsteenbe requested a review from MarcelBochtler February 6, 2025 00:45

MarcelBochtler approved these changes Feb 6, 2025

View reviewed changes

MarcelBochtler merged commit 1df67af into main Feb 6, 2025
26 checks passed

MarcelBochtler deleted the webapp-fixes-updates-part-2 branch February 6, 2025 08:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Various WebApp report fixes and new features (part 2) #9868

Various WebApp report fixes and new features (part 2) #9868

tsteenbe commented Jan 30, 2025

codecov bot commented Jan 30, 2025 •

edited

Loading

sschuberth commented Jan 30, 2025

sschuberth Jan 30, 2025

tsteenbe Jan 30, 2025

MarcelBochtler left a comment •

edited

Loading

MarcelBochtler commented Feb 3, 2025 •

edited

Loading

tsteenbe commented Feb 6, 2025 •

edited

Loading

MarcelBochtler left a comment

Various WebApp report fixes and new features (part 2) #9868

Various WebApp report fixes and new features (part 2) #9868

Conversation

tsteenbe commented Jan 30, 2025

codecov bot commented Jan 30, 2025 • edited Loading

Codecov Report

sschuberth commented Jan 30, 2025

sschuberth Jan 30, 2025

Choose a reason for hiding this comment

tsteenbe Jan 30, 2025

Choose a reason for hiding this comment

MarcelBochtler left a comment • edited Loading

Choose a reason for hiding this comment

MarcelBochtler commented Feb 3, 2025 • edited Loading

tsteenbe commented Feb 6, 2025 • edited Loading

MarcelBochtler left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 30, 2025 •

edited

Loading

MarcelBochtler left a comment •

edited

Loading

MarcelBochtler commented Feb 3, 2025 •

edited

Loading

tsteenbe commented Feb 6, 2025 •

edited

Loading