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

Improve panic error message to include the parse error. #4990

Merged

Conversation

brianpursley
Copy link
Member

@brianpursley brianpursley commented Jan 19, 2023

This came up while investigating issue #4988.

If my openapi json file fails to parse (due to a missing curly brace), the error message provides only this error message:

panic: invalid schema file

This PR adds the error message to the panic.

The new message will provide more details about the problem:

panic: invalid schema file: json: cannot unmarshal Go value of type spec.Swagger: unexpected EOF

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 19, 2023
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 19, 2023
@brianpursley
Copy link
Member Author

/assign @natasha41575

@KnVerey
Copy link
Contributor

KnVerey commented Jan 24, 2023

Ideally we would not panic, but I agree that this is a worthwhile improvement in the interim.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 24, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brianpursley, KnVerey

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 24, 2023
@k8s-ci-robot k8s-ci-robot merged commit 96351a9 into kubernetes-sigs:master Jan 24, 2023
@brianpursley
Copy link
Member Author

Ideally we would not panic, but I agree that this is a worthwhile improvement in the interim.

@KnVerey agreed, and I was going to attempt that, but there were going to be too many cascading effects. I was surprised to see panic used so routinely here and other places.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants