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

[Golang][client] fix CacheExpires ineffassign, Fix #464 #466

Merged

Conversation

grokify
Copy link
Member

@grokify grokify commented Jul 5, 2018

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.1.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

@antihax
@bvwells

Description of the PR

fix #464

client.go has an ineffectual if statement in the CacheExpires function. This results in a lower score on Go Report Card for the generated code described here: #464 . Go Report Card is a commonly used app with it's shield on many GitHub repo READMEs.

Here is an example:

https://goreportcard.com/report/github.com/grokify/go-stackexchange

Two options to resolve this include:

Option 1

lifetime, err := time.ParseDuration(maxAge + "s") 
if err != nil {
    expires = now
} else {
    expires = now.Add(lifetime)
}

Option 2

This option works because an error will return a 0s duration, but it may be better to not rely on this behavior.

lifetime, _ := time.ParseDuration(maxAge + "s")
expires = now.Add(lifetime)

Either approach will resolve the issue on Go Report Card for the generated code.

This PR uses option 1 since it is easier to understand, explicitly handles the error and is similar to other error handling in the function.

@grokify grokify changed the title [Golang][client] fix CacheExpires ineffassign [Golang][client] fix CacheExpires ineffassign, Fix #464 Jul 7, 2018
@wing328 wing328 added this to the 3.1.1 milestone Jul 8, 2018
Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change looks good to me 👍

@wing328 wing328 merged commit a14e757 into OpenAPITools:master Jul 8, 2018
A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Golang][client] ineffectual assignment in client.go / client.mustache
2 participants