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

refactor: remove cyclic authz dependencies #16509

Merged
merged 10 commits into from
Jun 13, 2023
Merged

Conversation

kocubinski
Copy link
Member

@kocubinski kocubinski commented Jun 12, 2023

Description

Closes: #16463

This takes approach 1. from the above issue:

  1. Push AcceptResponse down into sdk/types, and change Updated field type to proto.Message. Refactor usages.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@kocubinski kocubinski marked this pull request as ready for review June 12, 2023 19:08
@kocubinski kocubinski requested a review from a team as a code owner June 12, 2023 19:08
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

I think this is pushing the problem further, right? IIRC the end goal is to have modules not import the SDK anymore (right?), so moving AcceptResponse to types/authz, solves one issue but creates another one for later. I think it is as well better if the types are closer to where they are used.

Doesn't it make more sense to remove the cyclic dependencies by moving the authorization definitions to authz directly? (However, that is wayyy more breaking).

However, if we go this way, I left one comment.

)

// TODO: Revisit this once we have propoer gas fee framework.
// Tracking issues https://github.com/cosmos/cosmos-sdk/issues/9054, https://github.com/cosmos/cosmos-sdk/discussions/9072
const gasCostPerIteration = uint64(10)

var _ authz.Authorization = &StakeAuthorization{}
Copy link
Member

Choose a reason for hiding this comment

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

This is quite handy, if we go this way, cannot we move the interface in types/authz?
Codec (x/bank/types/codec.go) still requires the interface registration anyway, so it does not really remove the cyclic dep as of now.

Copy link
Member Author

Choose a reason for hiding this comment

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

Codec (x/bank/types/codec.go) still requires the interface registration anyway, so it does not really remove the cyclic dep as of now.

Oops, I meant to move those registrations to authz. Will do that now.

This is quite handy, if we go this way, cannot we move the interface in types/authz?

This is handy while writing, but obviates one of the best features of how interfaces are implemented in go's type system. A type can implement an interface's behavior without forming an explicit relationship on the package in which it is specified.

@kocubinski
Copy link
Member Author

kocubinski commented Jun 13, 2023

I think this is pushing the problem further, right? IIRC the end goal is to have modules not import the SDK anymore (right?)

I think so, but it's not totally clear how that will look yet, or how we'll get there. Given this I think it's good take incremental steps. I consider removing a cyclic dependency by pushing the common dependency down an incremental improvement. We could also consider moving it api?

If we do ever eventually make the transition away from gogo types then implementing an interface method on a generated proto type will not be possible, so we'll need a different design for this authz pattern. I think that will happen eventually, but given that's not in writing either, I consider this an acceptable improvement.

Doesn't it make more sense to remove the cyclic dependencies by moving the authorization definitions to authz directly?

I'm not sure what you're proposing here, the Authorization interface is already in authz.

@julienrbrt
Copy link
Member

I'm not sure what you're proposing here, the Authorization interface is already in authz.

Yeah, never mind that, I didn't think we could just move the type registration 😅

@kocubinski kocubinski added this pull request to the merge queue Jun 13, 2023
Merged via the queue into main with commit 1363a02 Jun 13, 2023
@kocubinski kocubinski deleted the kocubinski/authz-deps branch June 13, 2023 18:32
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.

x/authz design should not require a cyclic dependency to function
3 participants