Recurse over arrays for watch notices #279
Merged
Conversation
This file contains 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
|
@moolitayer @cben can you review? |
|
👍 good catch, recurse_over_arrays is desired and consistent with rest of kubeclient. Is there any backward-compatibility concern? |
moolitayer
reviewed
Dec 17, 2017
test/test_watch_notice.rb
Outdated
| notice = Kubeclient::Common::WatchNotice.new(json) | ||
| assert_kind_of(Array, notice.object.status.addresses) | ||
| notice.object.status.addresses.each do |address| | ||
| assert_kind_of(OpenStruct, address) |
There was a problem hiding this comment.
s/OpenStruct/RecursiveOpenStruct/
Will be helpful to do the same in the commit message
|
Look good, one nit. Agree with @cben this can be considered backward compatible |
|
Maybe we cab add a simple test for the array access compat? |
|
Thanks for your review @cben and @moolitayer. I have added the backwards compatibility test as you suggested. |
Currently the elements of arrays inside watch notices aren't converted
to intances of `RecursiveOpenStruct`, they are converted to instances of
`Hash` instead. This mean that accessing certain fields works
differently for objects retrieved directly than for objects received in
a notice. For example, to extract the internal IP address of a node
retrieved directly the code is like this:
```ruby
ip = node.status.addresses.detect { |x| x.type == 'InternalIP' }.address
```
But for a notice it is like this:
```ruby
ip = node.status.addresses.detect { |x| x['type'] == 'InternalIP' }['address']
```
This complicates code that needs to treat objects in the same way,
regardless of how they have been retrieved.
To avoid that this patch changes the `WatchNotice` class so that the
constructor adds the RecursiveOpenStruct `:recurse_over_arrays` option.
|
@simon3z thanks for merging this. When can we expect a new release of the gem containing the fix? |
|
@abonas who is currently responsible for doing releases of the gem? |
masayag
pushed a commit
to masayag/manageiq-providers-kubevirt
that referenced
this pull request
Dec 19, 2017
This is patch adds a temporary hack to solve an issue with the `kubeclient` gem. See the following pull request for details: Recurse over arrays for watch notices ManageIQ/kubeclient#279 Signed-off-by: Juan Hernandez <juan.hernandez@redhat.com>
cben
pushed a commit
to cben/kubeclient
that referenced
this pull request
Jan 22, 2018
…_watch_notices Recurse over arrays for watch notices
cben
pushed a commit
to cben/kubeclient
that referenced
this pull request
Jan 25, 2018
…_watch_notices Recurse over arrays for watch notices
moolitayer
pushed a commit
to moolitayer/kubeclient
that referenced
this pull request
Feb 4, 2018
…_watch_notices Recurse over arrays for watch notices (cherry picked from commit 8933375)
moolitayer
pushed a commit
to moolitayer/kubeclient
that referenced
this pull request
Feb 4, 2018
…_watch_notices Recurse over arrays for watch notices (cherry picked from commit 8933375)
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.
Currently the elements of arrays inside watch notices aren't converted
to intances of
RecursiveOpenStruct, they are converted to instances ofHashinstead. This mean that accessing certain fields works differently for
objects retrieved directly than for objects received in a notice. For
example, to extract the internal IP address of a node retrieved directly
the code is like this:
But for a notice it is like this:
This complicates code that needs to treat objects in the same way,
regardless of how they have been retrieved.
To avoid that this patch changes the
WatchNoticeclass so that theconstructor adds the RecursiveOpenStruct
:recurse_over_arraysoption.