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

Gracefully handle NotSortableExceptions #3724

Merged
merged 1 commit into from
May 16, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented May 16, 2024

Description

Adds a JAX-RS ExceptionMapper for NotSortableException, which was introduced in stevespringett/Alpine#554.

In previous versions of Dependency-Track, attempts to sort by fields that are not sortable were silently ignored. As of Alpine 2.2.6, an exception will be raised instead.

This PR handles those exceptions gracefully, and returns a response in RFC 9457 format to the client.

Addressed Issue

N/A

Additional Details

N/A

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

Adds a JAX-RS `ExceptionMapper` for `NotSortableException`, which was introduced in stevespringett/Alpine#554.

Signed-off-by: nscuro <[email protected]>
@nscuro nscuro added the enhancement New feature or request label May 16, 2024
@nscuro nscuro added this to the 4.12 milestone May 16, 2024
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.03% (target: -1.00%) 100.00% (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (db58e69) 21630 16377 75.71%
Head commit (49c9359) 21640 (+10) 16390 (+13) 75.74% (+0.03%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#3724) 10 10 100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy will stop sending the deprecated coverage status from June 5th, 2024. Learn more

@nscuro nscuro merged commit c04d4df into DependencyTrack:master May 16, 2024
12 checks passed
@nscuro nscuro deleted the handle-notsortableexception branch May 16, 2024 18:28
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant