snazy opened a new issue, #759:
URL: https://github.com/apache/polaris/issues/759
### Describe the bug
The only implementation of `PolarisDiagnostics`
(`PolarisDefaultDiagServiceImpl`) has various issues:
* All functions that take `extraInfoFormat` and `extraInfoArgs` seem to
accept a SLF4J-style formatting using `{}`, but the actual formatting relies on
Guava's `Preconditions`, which only accepts `%s`. The formatted messages then
read awkward: `something_went_wrong: id={} fileName={} ["a",
java.lang.Object@deadbeef]` due to the implementation
* The generated exception messages contain rather cryptic information (e.g.
`unexpected_not_found_entity`) instead of a description that users can act on.
* Some functions say: "Create a fatal incident if expression is false" - but
all the implementation does is calling `Preconditions.checkState()`
* Nit-ish maybe: some functions unnecessarily have a `throw new
RuntimeException` after a `Preconditions.checkState(false, ...`
The current implementation is not really useful and emits no
information/instructions that a user could act on (other than raising questions
on a chat or open a GH issue).
These are some options:
1. replace all usages of `PolarisDiagnostics` with direct use of
`Preconditions` / `Objects.requireNonNull` and eventually remove
`PolarisDiagnostics` and its implementation
2. refactor `PolarisDiagnostics` and implement a proper mapping of
error-codes to user consumable and act-able messages
Generally speaking (IMHO), the use of `PolarisDiagnostics` adds a lot of
boilerplate code that makes it harder than necessary to read the code.
### To Reproduce
_No response_
### Actual Behavior
_No response_
### Expected Behavior
_No response_
### Additional context
_No response_
### System information
_No response_
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
