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

chore: remove sdk imports from server v2 #19744

Closed
wants to merge 13 commits into from

Conversation

facundomedica
Copy link
Member

@facundomedica facundomedica commented Mar 13, 2024

Description

Stuff missing/to revisit:

  • Copy pagination.proto to cometbft types, fix proto generation to generate on the correct directory
  • Figure out types.Any and cryptotypes.PubKey
  • Also genutiltypes.AppGenesisFromFile + sdk version

Follow up PR needed: to add the app version info to the GetNodeInfo method


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
  • confirmed ! in 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
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • 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 all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Copy link
Contributor

coderabbitai bot commented Mar 13, 2024

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@facundomedica facundomedica changed the title chore: remove sdk importes from server v2 chore: remove sdk imports from server v2 Mar 13, 2024
@tac0turtle
Copy link
Member

gentle ping on this, can we get this wrapped up. i can pick it up if needed

@facundomedica
Copy link
Member Author

@tac0turtle whoops, dropped the ball on this one. Will get back to it tomorrow 👌

@facundomedica facundomedica marked this pull request as ready for review March 26, 2024 20:13
@facundomedica facundomedica requested a review from a team as a code owner March 26, 2024 20:13

// DefaultPage is the default `page` number for queries.
// If the `page` number is not supplied, `DefaultPage` will be used.
const DefaultPage = 1
Copy link
Member

Choose a reason for hiding this comment

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

pagination seems like a generic thing, any reason we cant put it into the api pkg at the in server/v2?

Copy link
Member

Choose a reason for hiding this comment

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

Or we put a variation of it in core. This is to avoid sdk imports of pagination in modules. Thoughts?

Copy link
Member Author

Choose a reason for hiding this comment

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

There's also a proto generated file that contains PageRequest and some other. I think this is also extracted from comet, so if we want to extend this same pagination style everywhere else then we should make it like you said

Copy link
Member

Choose a reason for hiding this comment

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

can we use the api module here?

Copy link
Member Author

@facundomedica facundomedica Apr 4, 2024

Choose a reason for hiding this comment

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

I think we talked about this on a call, but that would mean we use a pulsar type. Also, those types use codec/any for pubkeys, so we are still going to have a dependency on the sdk EDIT: I'll double-check this last part, I think I got them mixed up

Copy link
Member

Choose a reason for hiding this comment

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

so i think this is fine for now, we should get this merged, but we will need to do another refactor here because we dont want to use the pulsar types. Im not sure where pagination should live to avoid the imports, maybe you can dive into this?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm a bit confused, should we not use pulsar on this pr? I started without it but then we talked about using it so I started to use it and added a bunch of utils to make that possible here: use cosmossdk.io/api

Copy link
Member

Choose a reason for hiding this comment

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

we should be able to depend on server v2 here, we can put it in there. the issue is we are adding multiple versions of pagination now, which makes client world harder

}

if ag.GenesisTime.IsZero() {
ag.GenesisTime = time.Now().Round(0).UTC()

Check warning

Code scanning / CodeQL

Calling the system time Warning

Calling the system time may be a possible source of non-determinism
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

there is still work to do there.

@@ -0,0 +1,232 @@
package genutil
Copy link
Member

Choose a reason for hiding this comment

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

where does this get used?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is used in getGenDocProvider when creating the node. I put it in a different package to make it easier to remove later if needed


// DefaultPage is the default `page` number for queries.
// If the `page` number is not supplied, `DefaultPage` will be used.
const DefaultPage = 1
Copy link
Member

Choose a reason for hiding this comment

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

so i think this is fine for now, we should get this merged, but we will need to do another refactor here because we dont want to use the pulsar types. Im not sure where pagination should live to avoid the imports, maybe you can dive into this?

int64 voting_power = 3;
int64 proposer_priority = 4;
string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
.tendermint.crypto.PublicKey pub_key = 2 [(gogoproto.nullable) = false];
Copy link
Member

Choose a reason for hiding this comment

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

why this change?

Copy link
Member Author

Choose a reason for hiding this comment

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

Because google.protobuf.Any will use the sdk's codec package, which is unnecessary here if we use the original types

Copy link
Member

Choose a reason for hiding this comment

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

ah true, dam that type. It was moved now but i guess the code gen needs to be updated


option go_package = "github.com/cosmos/cosmos-sdk/client/grpc/cmtservice";
option go_package = "github.com/cosmos/cosmos-sdk/server/v2/cometbft/client/grpc/cmtservice";
Copy link
Member

Choose a reason for hiding this comment

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

what happens to clients version? part of me thinks this needs to redefined

@tac0turtle tac0turtle closed this May 15, 2024
@tac0turtle tac0turtle deleted the facu/remove-sdk-deps branch September 17, 2024 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants