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

Add more structure to the source of ORT issues #4393

Open
oheger-bosch opened this issue Aug 25, 2021 · 1 comment
Open

Add more structure to the source of ORT issues #4393

oheger-bosch opened this issue Aug 25, 2021 · 1 comment
Labels
enhancement Issues that are considered to be enhancements model About the data model

Comments

@oheger-bosch
Copy link
Member

For some use cases it is necessary to match specific issues reported during an ORT execution. For instance, with resolutions some issues should be waived, or the new notifier module should send specific notifications when certain issues are found.

Such matching is currently difficult, however, because the OrtIssue class has not sufficient information to uniquely filter out specific issues. There is a single string property for the source of the issue, which - by convention - is set to the component (like analyzer, advisor, ...) that created the issue. Other than that, one typically has to match with regular expressions against the issue's message, which is fragile when there is a change in wording. Often, the message contains the coordinates of a package the issue is about.

To simplify identifying specific issues, some additional (optional) properties could be added to OrtIssue. The exact amount of properties is up to discussion; I would consider the following properties helpful:

  • An optional Identifier (or a string with package coordinates), which is set if the issue is related to a specific package.
  • An ORT-specific error code: This is not trivial, since it requires some sort of terminology of possible ORT errors, and means would be needed to manage this terminology and keep it consistent; but it would be very useful to make issues machine-readable and to understand what exactly went wrong.
@sschuberth
Copy link
Member

  • An optional Identifier (or a string with package coordinates), which is set if the issue is related to a specific package.

This could be done similar to 521640b.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Issues that are considered to be enhancements model About the data model
Projects
None yet
Development

No branches or pull requests

2 participants