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

Validation report: Show the list of notices that could not have been checked because of a parsing problem #1485

Open
isabelle-dr opened this issue Jun 6, 2023 · 5 comments
Labels
dependencies Pull requests that update a dependency file enhancement New feature request or improvement on an existing feature parsing errors Related to improving validator parsing and clearer parsing error messages. validation report Adding information in the report, an improvement on the interface, etc.
Milestone

Comments

@isabelle-dr
Copy link
Contributor

isabelle-dr commented Jun 6, 2023

⚠️ Need to do #1537 and #1536 before this issue.

Context about the issue

When there is a parsing problem, some of the validators don't run validators don't run and a portion of the notices can't be checked.
This creates confusion for the users (see #1167).
We want to add a new section in the validation report that gives the user the list of notices that could not have been checked because of a parsing problem.

The list of notices referenced should only include validators that were not run because of a parsing problem, -not- because a component was missing from the dataset. (E.g duplicate_fare_media should not be included in the list of notices if there is no fares data, or pathway_to_wrong_location_type should not be included to the list of notices if there is no pathway data).

What this issue is for

This issue is for adding the section in the validation report that gives the user a list of notices that could not have been checked because of a parsing problem. This informs the user that these notices might be present in the data.

Not doing in this issue

Optimizing the list of validators that didn't run because of a parsing problem so that we don't stop validators from running when they actually can. We have an issue open for this #1484.

@isabelle-dr isabelle-dr moved this to Jarvus Backlog (for MobilityData) in Schedule Validator Q2 backlog Jun 6, 2023
@isabelle-dr isabelle-dr added enhancement New feature request or improvement on an existing feature status: Ready An issue that is ready to be worked on. dependencies Pull requests that update a dependency file labels Jun 6, 2023
@isabelle-dr
Copy link
Contributor Author

isabelle-dr commented Jun 6, 2023

Related to #1484
Might be related: #1089

@briandonahue
Copy link
Collaborator

@isabelle-dr would this list be shown on the HTML report, and/or do you want it included in the JSON report?

@isabelle-dr
Copy link
Contributor Author

isabelle-dr commented Jun 9, 2023

@briandonahue I am not sure. I see that when we added the Metadata (or Summary) in the HTML report, we didn't add it to the JSON report. Why did we decide not to, in this case?

I thought it would be more straightforward to have all the results in the JSON report and then use this to display the HTML page, but I may be over-simplifying things.
I also think from a user perspective, it's nice to have parity so that people that use the JSON report get the additional value as well, although we should be careful with breaking changes.

@briandonahue
Copy link
Collaborator

briandonahue commented Jun 9, 2023

@isabelle-dr My understanding (perhaps incorrect) was that the metadata section was only requested for the HTML report. The two are generated separately currently. I don't necessarily think it's a bad idea to use the JSON as the source for the HTML report, but it would require significant changes.

@briandonahue
Copy link
Collaborator

Initial work in #1496 is gathering the list of skipped validators due to parsing errors, but the further details required to collect the resulting skipped rules/notices is not readily available and will require more discussion and effort to allow those to be derived from the skipped validators. Additionally we may want to capture and report contextual information on why certain rules could not be validated, such as which files could not be parsed, and which rules could not be validated as a result.

@isabelle-dr isabelle-dr added this to the MobilityData Now milestone Jun 12, 2023
@isabelle-dr isabelle-dr moved this from Jarvus Backlog (for MobilityData) to MobilityData Backlog in Schedule Validator Q2 backlog Jun 19, 2023
@isabelle-dr isabelle-dr moved this from MobilityData Backlog (maintenance) to MobilityData backlog (new features) in Schedule Validator Q2 backlog Jun 19, 2023
@isabelle-dr isabelle-dr moved this from MobilityData backlog (new rules) to MobilityData backlog (enhancements) in Schedule Validator Q2 backlog Jun 19, 2023
@isabelle-dr isabelle-dr added status: Needs discussion We need a discussion on requirements before calling this issue ready and removed status: Ready An issue that is ready to be worked on. labels Jun 19, 2023
@davidgamez davidgamez removed the status: Needs discussion We need a discussion on requirements before calling this issue ready label Jun 19, 2023
@isabelle-dr isabelle-dr added the status: Needs discussion We need a discussion on requirements before calling this issue ready label Jul 3, 2023
@cka-y cka-y self-assigned this Jul 4, 2023
@emmambd emmambd added the parsing errors Related to improving validator parsing and clearer parsing error messages. label Jul 10, 2023
@cka-y cka-y added status: Blocked Can't work on it currently because of an external factor. and removed status: Needs discussion We need a discussion on requirements before calling this issue ready labels Jul 13, 2023
@emmambd emmambd removed the status: Blocked Can't work on it currently because of an external factor. label Jul 17, 2023
@emmambd emmambd changed the title Show users the list of notices that could not have been checked because of a parsing problem Validation report: Show the list of notices that could not have been checked because of a parsing problem Jul 17, 2023
@emmambd emmambd added the validation report Adding information in the report, an improvement on the interface, etc. label Jul 17, 2023
@cka-y cka-y removed their assignment Jul 27, 2023
@emmambd emmambd modified the milestones: Now , Next Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file enhancement New feature request or improvement on an existing feature parsing errors Related to improving validator parsing and clearer parsing error messages. validation report Adding information in the report, an improvement on the interface, etc.
Projects
None yet
Development

No branches or pull requests

5 participants