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

feat(depinject): add buf gen pulsar #5968

Merged
merged 22 commits into from
Apr 18, 2024

Conversation

crodriguezvega
Copy link
Contributor

@crodriguezvega crodriguezvega commented Mar 12, 2024

Description

  • I welcome ideas on how to call the new module instead of api.

ref: #3560


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 the 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 and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Copy link
Contributor

coderabbitai bot commented Mar 12, 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.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@crodriguezvega crodriguezvega changed the base branch from main to feat/depinject March 12, 2024 18:41
@crodriguezvega
Copy link
Contributor Author

We could also just use this api module also for what we want to do here.

@damiannolan
Copy link
Member

Is the feat/depinject target branch clean? And up to date with main?

@crodriguezvega
Copy link
Contributor Author

Is the feat/depinject target branch clean? And up to date with main?

Yes and yes!

@damiannolan
Copy link
Member

2024/04/16 15:30:37 Message ibc.applications.interchain_accounts.v1.InterchainAccountPacketData contains the reserved field name ibc.applications.interchain_accounts.v1.InterchainAccountPacketData.type which conflicts with protoreflect.Message interface implementation.
This field will be suffixed with an underscore '_'.
If you can change the message field name, please do so.
In a future iteration of pulsar we may make a breaking change to this practice in order to be compliant with field naming of the original golang protobuf implementation.

This msg is displayed in my shell when I run make proto-all. AFAIK the sdk team will be removing the need for pulsar(and protov2 spec) with the next release. They want to make it work with gogoproto which means the codegen will change and I think this problem/error msg will go away. The depinject apis will remain the same tho.

Copy link
Member

Choose a reason for hiding this comment

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

As I mentioned in #5968 (comment), we should no longer need pulsar with the next release. My thinking is that we can go ahead with this for now and add the pulsar codegen but when it works with gogoproto we just remove what's not needed and swap it out - should produce diffs to the codegen (i.e. removing the protov2 msg APIs and back to v1 with gogoproto - from what I understand this relates the reflection apis which are used in protobuf and sdk)

DimitrisJim
DimitrisJim previously approved these changes Apr 16, 2024
Copy link
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

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

200k diff, quick skim, lgtm

@DimitrisJim DimitrisJim dismissed their stale review April 16, 2024 23:07

writting comment now

@DimitrisJim
Copy link
Contributor

DimitrisJim commented Apr 16, 2024

Actually, scratch that. Can't get this to build locally still. Is cd-ing into api and doing go build ./... working for others? I would assume it should?

Looking into this more, some imports don't seem to be generated correctly? E.g, the import for the base account our interchain account wraps points to github.com/cosmos-sdk/x/auth/types and this type does not implement a ProtoReflect (what the go build step starts screaming about, among other things 😄 ).

The correct type is apparently located in cosmossdk.io/api/cosmos/auth/v1beta1.

go build complains about others too. The generation for some reason might have mucked things up?

@damiannolan
Copy link
Member

Actually, scratch that. Can't get this to build locally still. Is cd-ing into api and doing go build ./... working for others? I would assume it should?

Same experience for me.

go build complains about others too. The generation for some reason might have mucked things up?

Very possible, I can try to look into this a bit more.

@DimitrisJim
Copy link
Contributor

we should add a workflow for api/ that at least tries to go build it. Linting could be added later if we decide to use api to include non-generated files.

@crodriguezvega
Copy link
Contributor Author

go build complains about others too. The generation for some reason might have mucked things up?

Oh, I hadn't even tried that... Does building work in the api folder of the SDK?

@DimitrisJim
Copy link
Contributor

Does building work in the api folder of the SDK?

yup! I think our go.mod for api/ should probably have no reference to github.com/cosmos-sdk, only cosmossdk.io/api

plugins:
- name: go-pulsar
out: ../api
opt: Mcosmos/app/v1alpha1/module.proto=cosmossdk.io/api/cosmos/app/v1alpha1,Mcosmos/ics23/v1/proofs.proto=github.com/cosmos/ics23/go/api
Copy link
Contributor

Choose a reason for hiding this comment

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

seems to be the way to link the api module?

Copy link
Member

Choose a reason for hiding this comment

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

yeah, I think this is how you do overriding.

maybe @julienrbrt could give us a more detailed description so we have a better understanding.

api/go.mod Outdated Show resolved Hide resolved
Copy link
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

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

I'd be perfectly happy to merge. Since we know where the build issues were, this can be tested locally for the time being.

Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

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

LGTM!

.github/workflows/api_module.yml Outdated Show resolved Hide resolved
api/go.mod Outdated Show resolved Hide resolved
plugins:
- name: go-pulsar
out: ../api
opt: Mcosmos/app/v1alpha1/module.proto=cosmossdk.io/api/cosmos/app/v1alpha1,Mcosmos/ics23/v1/proofs.proto=github.com/cosmos/ics23/go/api
Copy link
Member

Choose a reason for hiding this comment

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

yeah, I think this is how you do overriding.

maybe @julienrbrt could give us a more detailed description so we have a better understanding.

Copy link

sonarcloud bot commented Apr 18, 2024

Quality Gate Passed Quality Gate passed for 'ibc-go'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@crodriguezvega
Copy link
Contributor Author

Great work taking this to the finish line, @damiannolan and @DimitrisJim. 👏

@crodriguezvega crodriguezvega merged commit 71233e5 into feat/depinject Apr 18, 2024
74 checks passed
@crodriguezvega crodriguezvega deleted the carlos/add-buf-gen-pulsar branch April 18, 2024 09: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.

4 participants