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

Empty issue key causes misleading error #381

Open
romshark opened this issue Jun 15, 2021 · 2 comments
Open

Empty issue key causes misleading error #381

romshark opened this issue Jun 15, 2021 · 2 comments
Labels
needs triage Ticket that needs triage (a proper look for classification)

Comments

@romshark
Copy link

romshark commented Jun 15, 2021

Describe the bug

https://github.com/andygrunwald/go-jira/blob/v1.13.0/issue.go#L806 accepts empty issue keys which causes the resulting error to be:

405 Method Not Allowed: : request failed. Please analyze the request body for more details. Status code: 405

To Reproduce

  1. call (*IssueService).Update with no issue key set.

Expected behavior

Should return errors.New("invalid issue key")

Possible Solution

Validate the issue key before formatting:

if err := ValidateIssueKey(issue.Key); err != nil {
  return err
}
apiEndpoint := fmt.Sprintf("rest/api/2/issue/%v", issue.Key)
//...

Your Environment

  • go-jira version (git tag or sha): v.1.13.0
  • Go version (go version): go version go1.16.5 darwin/amd64

Additional context

The error 405 Method Not Allowed is misleading and doesn't reflect the actual error! Update shouldn't accept empty issue keys at all!
I suppose this isn't the only place in the code where similar things happen?

@github-actions
Copy link

Hi! Thank you for taking the time to create your first issue! Really cool to see you here for the first time. Please give us a bit of time to review it.

@andygrunwald andygrunwald added the needs triage Ticket that needs triage (a proper look for classification) label Aug 20, 2022
@andygrunwald
Copy link
Owner

Hey,

I am very sorry that this issue has been open for a long time with no final solution. We work on this project in our spare time, and sometimes, other priorities take over. This is the typical open source dilemma.

However, there is news: We are kicking off v2 of this library 🚀

To provide visibility, we created the Road to v2 Milestone and calling for your feedback in #489

The development will take some time; however, I hope you can benefit from the changes.
If you seek priority development for your issue + you like to sponsor it, please contact me.

What does this mean for my issue?

We will work on this issue indirectly.
This means that during the development phase, we aim to tackle it.
Maybe in a different way like it is currently handled.
Please understand that this will take a while because we are running this in our spare time.

Final words

Thanks for using this library.
If there is anything else you would like to tell us, let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage Ticket that needs triage (a proper look for classification)
Projects
None yet
Development

No branches or pull requests

2 participants