Check persistence metadata when sorting #554
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Only persistent fields can be queried and sorted by. Trying to sort by a non-persistent field will cause an exception to be thrown in the persistence layer. To users it is not immediately obvious which field is persistent, and which is computed. It would be good to provide a helpful error message as to what went wrong when a sorting request can not be fulfilled. Instead of checking the candidate classes' fields directly, leverage the type metadata of DataNucleus to figure out which field is persistent. Use specific exception messages for whether a field is not persistent, or doesn't exist at all. Applications built on Alpine can then define a custom `ExceptionMapper` to transform the new `NotSortableException` into an API-friendly format if desired. Alternatively, it can be handled with any generic `IllegalArgumentException` handling logic. Signed-off-by: nscuro <nscuro@protonmail.com>
1 task
nscuro
added a commit
to nscuro/dependency-track
that referenced
this pull request
May 16, 2024
Adds a JAX-RS `ExceptionMapper` for `NotSortableException`, which was introduced in stevespringett/Alpine#554. Signed-off-by: nscuro <nscuro@protonmail.com>
2 tasks
MM-msr
pushed a commit
to MM-msr/dependency-track
that referenced
this pull request
Jun 18, 2024
Adds a JAX-RS `ExceptionMapper` for `NotSortableException`, which was introduced in stevespringett/Alpine#554. Signed-off-by: nscuro <nscuro@protonmail.com>
netomi
pushed a commit
to netomi/dependency-track
that referenced
this pull request
Aug 8, 2024
Adds a JAX-RS `ExceptionMapper` for `NotSortableException`, which was introduced in stevespringett/Alpine#554. Signed-off-by: nscuro <nscuro@protonmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Only persistent fields can be queried and sorted by. Trying to sort by a non-persistent field will cause an exception to be thrown in the persistence layer.
To users it is not immediately obvious which field is persistent, and which is computed. It would be good to provide a helpful error message as to what went wrong when a sorting request can not be fulfilled.
Instead of checking the candidate classes' fields directly, leverage the type metadata of DataNucleus to figure out which field is persistent.
Use specific exception messages for whether a field is not persistent, or doesn't exist at all.
Applications built on Alpine can then define a custom
ExceptionMapperto transform the newNotSortableExceptioninto an API-friendly format if desired. Alternatively, it can be handled with any genericIllegalArgumentExceptionhandling logic.