Adding GetChannelsWithPortPrefix function to 04-channel by chatton · Pull Request #2304 · cosmos/ibc-go

chatton · 2022-09-19T15:22:24Z

Description

closes: #2245

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

damiannolan · 2022-09-20T08:04:58Z

modules/apps/27-interchain-accounts/controller/keeper/migrations.go

 		isAuthenticated := m.keeper.scopedKeeper.AuthenticateCapability(ctx, cap, name)
 		if !isAuthenticated {
-			return sdkerrors.Wrapf(capabilitytypes.ErrCapabilityNotOwned, "expected capability owner: %s", types.SubModuleName)
+			return sdkerrors.Wrapf(capabilitytypes.ErrCapabilityNotOwned, "expected capability owner: %s", commitmenttypes.SubModuleName)


Not sure how this ended up as commitmenttypes I see the import previously would've been incorrect also.
It should be controllertypes.SubModuleName.

Ah right, I was wondering about that actually, I changed the import to be inline with other imports in the file. I can update this now.

I think the dangers of types as the import alias.

damiannolan · 2022-09-20T08:06:31Z

modules/core/04-channel/keeper/keeper.go

+
+// filteredPortPrefix returns the prefix key for the given port prefix.
+func filteredPortPrefix(portPrefix string) []byte {
+	return []byte(fmt.Sprintf("%s/ports/%s", host.KeyChannelEndPrefix, portPrefix))


small nit:

Suggested change

return []byte(fmt.Sprintf("%s/ports/%s", host.KeyChannelEndPrefix, portPrefix))

return []byte(fmt.Sprintf("%s/%s/%s", host.KeyChannelEndPrefix, host.KeyPortPrefix, portPrefix))

chatton · 2022-09-20T08:41:10Z

modules/apps/27-interchain-accounts/controller/keeper/migrations.go

+	for _, ch := range filteredChannels {
 		name := host.ChannelCapabilityPath(ch.PortId, ch.ChannelId)
-		cap, found := m.keeper.scopedKeeper.GetCapability(ctx, name)
+		capacity, found := m.keeper.scopedKeeper.GetCapability(ctx, name)


I renamed this to avoid shadowing the built in cap function.

codecov-commenter · 2022-09-20T08:49:26Z

Codecov Report

Merging #2304 (2ffd5e4) into main (b97729d) will decrease coverage by 0.08%.
The diff coverage is 67.18%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2304      +/-   ##
==========================================
- Coverage   79.54%   79.45%   -0.09%     
==========================================
  Files         175      175              
  Lines       12069    12149      +80     
==========================================
+ Hits         9600     9653      +53     
- Misses       2045     2067      +22     
- Partials      424      429       +5

Impacted Files	Coverage Δ
...27-interchain-accounts/controller/keeper/events.go	`0.00% <ø> (ø)`
...nterchain-accounts/controller/keeper/grpc_query.go	`100.00% <ø> (ø)`
...nterchain-accounts/controller/keeper/msg_server.go	`100.00% <ø> (ø)`
...27-interchain-accounts/controller/keeper/params.go	`100.00% <ø> (ø)`
.../27-interchain-accounts/controller/keeper/relay.go	`73.33% <ø> (ø)`
...in-accounts/controller/migrations/v5/migrations.go	`89.65% <ø> (ø)`
...ps/27-interchain-accounts/controller/types/msgs.go	`92.30% <ø> (ø)`
...ps/27-interchain-accounts/genesis/types/genesis.go	`0.00% <ø> (ø)`
...les/apps/27-interchain-accounts/host/ibc_module.go	`95.00% <ø> (ø)`
.../apps/27-interchain-accounts/host/keeper/events.go	`0.00% <ø> (ø)`
... and 116 more

…ction-to-04-channel

crodriguezvega · 2022-09-25T20:55:54Z

modules/core/04-channel/keeper/keeper.go

 }
+
+// filteredPortPrefix returns the prefix key for the given port prefix.
+func filteredPortPrefix(portPrefix string) []byte {


Would it make sense to place this function in types/keys.go instead?

good suggestion, done!

…ction-to-04-channel

colin-axner

LGTM, just would like a little testing in 04-channel as well. Nice work thus far!

modules/core/04-channel/keeper/keeper.go

damiannolan

Looks good to me! Left a couple of nits and a question regarding naming.

Great work! ⭐

modules/apps/27-interchain-accounts/controller/keeper/migrations.go

damiannolan · 2022-09-29T08:11:15Z

modules/apps/27-interchain-accounts/controller/keeper/migrations_test.go

+				portIdWithOutPrefix := ibctesting.MockPort
+				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper.SetChannel(suite.chainA.GetContext(), portIdWithOutPrefix, ibctesting.FirstChannelID, channeltypes.Channel{
+					ConnectionHops: []string{ibctesting.FirstConnectionID},
+				})


We normally favour using ID over Id in naming (except proto generated code).

Suggested change

portIdWithOutPrefix := ibctesting.MockPort

suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper.SetChannel(suite.chainA.GetContext(), portIdWithOutPrefix, ibctesting.FirstChannelID, channeltypes.Channel{

ConnectionHops: []string{ibctesting.FirstConnectionID},

})

portIDWithOutPrefix := ibctesting.MockPort

suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper.SetChannel(suite.chainA.GetContext(), portIDWithOutPrefix, ibctesting.FirstChannelID, channeltypes.Channel{

ConnectionHops: []string{ibctesting.FirstConnectionID},

})

We only favor "Id" in proto naming because using "ID" messes with the grpc gateway generation (I'm not sure why nor if this is still an issue, but it was when we initially switched to proto)

damiannolan · 2022-09-29T08:25:42Z

modules/core/04-channel/keeper/keeper.go

 }

+// GetChannelsWithPortPrefix returns all channels with the specified port prefix.
+func (k Keeper) GetChannelsWithPortPrefix(ctx sdk.Context, portPrefix string) []types.IdentifiedChannel {


Should we consider naming this function to align with GetAllChannels below which returns []types.IdentifiedChannel also?

Maybe GetAllChannelsWithPortPrefix or GetAllPortPrefixedChannels?

I don't feel particularly strongly but just a thought. cc. @crodriguezvega @colin-axner

I like GetAllChannelsWithPortPrefix to stay consistent

Sounds good to me. I have no preference

…ction-to-04-channel

chatton · 2022-09-29T09:06:13Z

modules/core/04-channel/keeper/keeper.go

+	if strings.TrimSpace(portPrefix) == "" {
+		return k.GetAllChannels(ctx)
+	}


missed this condition before the tests!

Nice! This is a good addition

…ns.go Co-authored-by: Damian Nolan <damiannolan@gmail.com>

colin-axner

LGTM! Left some suggestions for the tests, mostly nits. Happy to go with what you think would be best

modules/apps/27-interchain-accounts/controller/keeper/migrations_test.go

colin-axner · 2022-09-29T10:00:28Z

modules/core/04-channel/keeper/keeper.go

+	if strings.TrimSpace(portPrefix) == "" {
+		return k.GetAllChannels(ctx)
+	}


Nice! This is a good addition

modules/core/04-channel/keeper/keeper_test.go

…independant of order

chatton · 2022-09-29T10:34:38Z

modules/core/04-channel/keeper/keeper_test.go

+
+// containsAll verifies if all elements in the expected slice exist in the actual slice
+// independent of order.
+func containsAll(expected, actual []types.IdentifiedChannel) bool {


I added this function as I saw that the order of the values returned in GetAllChannels is not necessarily in the order they were added.

colin-axner

Followup ACK

…ction-to-04-channel

…-channel' of https://github.com/cosmos/ibc-go into cian/issue#2245-add-port-prefix-iterator-function-to-04-channel

…ction-to-04-channel

chatton · 2022-09-29T11:41:12Z

modules/core/04-channel/keeper/keeper_test.go

+	allChannels := []types.IdentifiedChannel{
+		types.NewIdentifiedChannel(transfertypes.PortID, ibctesting.FirstChannelID, types.Channel{}),
+		types.NewIdentifiedChannel(differentChannelPortID, secondChannelID, types.Channel{}),
+	}
+


great suggestion @colin-axner , this makes things much cleaner.

…ction-to-04-channel

(cherry picked from commit ce5aba8) # Conflicts: # CHANGELOG.md

…) (#2445) * Adding GetChannelsWithPortPrefix function to 04-channel (#2304) (cherry picked from commit ce5aba8) # Conflicts: # CHANGELOG.md * fix conflict * Update CHANGELOG.md Co-authored-by: Cian Hatton <cian@interchain.io> Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

chatton added 2 commits September 19, 2022 16:21

feat: adding GetChannelsWithPortPrefix functionto 04-channel

74dbd34

chore: adding changelog entry

ebbcd36

chatton added the backport-to-v6.0.x label Sep 19, 2022

chatton marked this pull request as ready for review September 19, 2022 15:31

chatton requested review from AdityaSripal, charleenfei, colin-axner, crodriguezvega, damiannolan and seantking as code owners September 19, 2022 15:31

damiannolan reviewed Sep 20, 2022

View reviewed changes

chore: addressing PR feedback

b5e1e9f

chatton commented Sep 20, 2022

View reviewed changes

chatton and others added 5 commits September 20, 2022 16:42

chore: merge main

b8bbe7d

Merge branch 'main' into cian/issue#2245-add-port-prefix-iterator-fun…

9001e64

…ction-to-04-channel

chore: merge

691748b

chore: fixing unit test

137439f

Merge branch 'main' into cian/issue#2245-add-port-prefix-iterator-fun…

2ffd5e4

…ction-to-04-channel

crodriguezvega reviewed Sep 25, 2022

View reviewed changes

chatton and others added 2 commits September 26, 2022 12:34

chore: addressing PR feedback

fc0c1a4

Merge branch 'main' into cian/issue#2245-add-port-prefix-iterator-fun…

b44777e

…ction-to-04-channel

colin-axner reviewed Sep 26, 2022

View reviewed changes

modules/core/04-channel/keeper/keeper.go Outdated Show resolved Hide resolved

chore: adding test [wip]

5bd25fd

damiannolan approved these changes Sep 29, 2022

View reviewed changes

chatton and others added 3 commits September 29, 2022 10:02

chore: adding tests for GetChannelsWithPortPrefix

019afc6

chore: reame GetChannelsWithPortPrefix to GetAllChannelsWithPortPrefix

1b663db

Merge branch 'main' into cian/issue#2245-add-port-prefix-iterator-fun…

2707071

…ction-to-04-channel

chatton commented Sep 29, 2022

View reviewed changes

Update modules/apps/27-interchain-accounts/controller/keeper/migratio…

78697b5

…ns.go Co-authored-by: Damian Nolan <damiannolan@gmail.com>

chatton added 2 commits September 29, 2022 10:07

chore: updated variable references

e3e4fc5

chore: renaming Id to ID

afe7941

colin-axner approved these changes Sep 29, 2022

View reviewed changes

chatton added 2 commits September 29, 2022 11:27

chore: addressing pr feedback

f404c27

chore: addressing PR feedback and adding contains function to verify …

ba22f69

…independant of order

chatton commented Sep 29, 2022

View reviewed changes

colin-axner approved these changes Sep 29, 2022

View reviewed changes

colin-axner and others added 4 commits September 29, 2022 13:31

Merge branch 'main' into cian/issue#2245-add-port-prefix-iterator-fun…

d287003

…ction-to-04-channel

chore: adding allChannels as variable in tests

0e61f33

Merge branch 'cian/issue#2245-add-port-prefix-iterator-function-to-04…

d7ee861

…-channel' of https://github.com/cosmos/ibc-go into cian/issue#2245-add-port-prefix-iterator-function-to-04-channel

Merge branch 'main' into cian/issue#2245-add-port-prefix-iterator-fun…

b085b89

…ction-to-04-channel

chatton enabled auto-merge (squash) September 29, 2022 11:37

chatton commented Sep 29, 2022

View reviewed changes

Merge branch 'main' into cian/issue#2245-add-port-prefix-iterator-fun…

bd9ded4

…ction-to-04-channel

chatton disabled auto-merge September 29, 2022 12:26

chatton and others added 2 commits September 29, 2022 13:37

chore: fixing migrations test

4f695dc

Merge branch 'main' into cian/issue#2245-add-port-prefix-iterator-fun…

c8364f2

…ction-to-04-channel

chatton merged commit ce5aba8 into main Sep 29, 2022

chatton deleted the cian/issue#2245-add-port-prefix-iterator-function-to-04-channel branch September 29, 2022 15:40

mergify bot pushed a commit that referenced this pull request Sep 29, 2022

Adding GetChannelsWithPortPrefix function to 04-channel (#2304)

b95a87f

(cherry picked from commit ce5aba8) # Conflicts: # CHANGELOG.md

mergify bot mentioned this pull request Sep 29, 2022

Adding GetChannelsWithPortPrefix function to 04-channel (backport #2304) #2445

Merged

	return []byte(fmt.Sprintf("%s/ports/%s", host.KeyChannelEndPrefix, portPrefix))
	return []byte(fmt.Sprintf("%s/%s/%s", host.KeyChannelEndPrefix, host.KeyPortPrefix, portPrefix))

Conversation

chatton commented Sep 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Sep 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

colin-axner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

damiannolan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

colin-axner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

colin-axner left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

chatton commented Sep 19, 2022 •

edited

Loading

codecov-commenter commented Sep 20, 2022 •

edited

Loading