fix incorrect defer exit(err) statements #93
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Getting a failure when trying to use mockery to build mocks: ``` internal error: package "context" without types was imported from ... ``` Updated to modern mockery v2.13.1 and regenerated our mocks to get tests passing. Signed-off-by: Jay Pipes <[email protected]>
When calling a function directly from a `defer` statement, like so:
```go
var err error
exit := someFuncReturningAFunctor()
defer exit(err)
```
The `exit` function is passed the `err` variable by value, which means
that the value of `err` will always be nil above.
In order to have the deferred `exit` function use the value of the `err`
variable *on exit of the function*, you need to wrap the `exit` call
inside a temporary function, like so:
```go
var err error
exit := someFuncReturningAFunctor()
defer func() {
exit(err)
}()
```
See here for more information about this odd behaviour:
https://stackoverflow.com/questions/42703707/when-defer-func-evaluates-its-parameters
The alternative solution here was to change `exit`'s call signature to
accept a `*error` instead of an `error`, however we have code out there
in the controllers that would break if we changed `exit`'s function
signature.
Signed-off-by: Jay Pipes <[email protected]>
vijtrip2
approved these changes
Jun 15, 2022
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jaypipes, vijtrip2 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 |
jaypipes
added a commit
to jaypipes/ack-code-generator
that referenced
this pull request
Jun 15, 2022
Updates the generated code that defers a call to `exit(err)` for the resource logger to wrap the defer in a temporary functor that then calls `exit(err)`. See aws-controllers-k8s/runtime#93 for explanation. Signed-off-by: Jay Pipes <[email protected]>
ack-bot
pushed a commit
to aws-controllers-k8s/code-generator
that referenced
this pull request
Jun 15, 2022
Updates the generated code that defers a call to `exit(err)` for the resource logger to wrap the defer in a temporary functor that then calls `exit(err)`. See aws-controllers-k8s/runtime#93 for explanation. Signed-off-by: Jay Pipes <[email protected]> By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
RedbackThomson
pushed a commit
to RedbackThomson/ack-code-generator
that referenced
this pull request
Jun 21, 2022
Updates the generated code that defers a call to `exit(err)` for the resource logger to wrap the defer in a temporary functor that then calls `exit(err)`. See aws-controllers-k8s/runtime#93 for explanation. Signed-off-by: Jay Pipes <[email protected]> By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When calling a function directly from a
deferstatement, like so:The
exitfunction is passed theerrvariable by value, which meansthat the value of
errwill always be nil above.In order to have the deferred
exitfunction use the value of theerrvariable on exit of the function, you need to wrap the
exitcallinside a temporary function, like so:
See here for more information about this odd behaviour:
https://stackoverflow.com/questions/42703707/when-defer-func-evaluates-its-parameters
The alternative solution here was to change
exit's call signature toaccept a
*errorinstead of anerror, however we have code out therein the controllers that would break if we changed
exit's functionsignature.
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.