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(collections): bring in protocodec in collections directly #23515

Merged
merged 2 commits into from
Jan 27, 2025

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 27, 2025

Description

cosmossdk.io/collections/protocodec package was created because at the time collections didn't have a protobuf dependency.
However this seems to have changed since the work on the indexer (#22544). We can thus kill the extra go.mod and just add this to collections, as the dependency graph won't be worsen. This improves the UX as well.

NOTE:If accepted, i'll go delete the vanity from cosmos/vanity, before it gets used: https://pkg.go.dev/cosmossdk.io/collections/protocodec?tab=importedby


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, you can find examples of the prefixes below:
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

Summary by CodeRabbit

  • Chores

    • Removed Dependabot configuration for collections/protocodec
    • Removed GitHub Actions test job for collections/protocodec
    • Removed PR labeler configuration for collections/protocodec
    • Updated collections module changelog to version 1.1.0
    • Removed collections/protocodec module and its associated files
  • Dependency Management

    • Added direct dependency on github.com/google/go-cmp v0.6.0
    • Removed collections/protocodec module from workspace configuration

@julienrbrt julienrbrt requested review from tac0turtle and a team as code owners January 27, 2025 14:38
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

📝 Walkthrough

Walkthrough

This pull request involves the removal of the collections/protocodec module from the Cosmos SDK project. The changes span multiple configuration files, including Dependabot settings, GitHub Actions workflows, and module dependencies. The collections/CHANGELOG.md is updated to reflect bringing the protocodec module into the main collections module as part of version 1.1.0. The modifications suggest a consolidation of the module's structure and dependency management.

Changes

File Change Summary
.github/dependabot.yml Removed Dependabot configuration entry for collections/protocodec
.github/pr_labeler.yml Deleted collections/protocodec/* pattern from labeling configuration
.github/workflows/test.yml Removed test-collections-protocodec job from GitHub Actions workflow
collections/CHANGELOG.md Added v1.1.0 entry bringing protocodec module into collections
collections/go.mod Modified go-cmp dependency (added directly, removed indirect)
collections/protocodec/CHANGELOG.md File deleted
collections/protocodec/go.mod Entire module file removed
go.work.example Removed ./collections/protocodec module reference

Possibly related PRs

Suggested Labels

C:orm, C:schema, C:core/testing, C:x/accounts, C:x/gov, C:x/authz, C:x/protocolpool, C:x/epochs, C:x/upgrade, C:x/staking, C:x/distribution, C:x/mint, C:x/nft, C:x/feegrant, C:x/group, C:x/circuit, C:server/v2, C:server/v2 cometbft, C:server/v2 appmanager, C:server/v2 stf, C:Simulations

Suggested Reviewers

  • julienrbrt
  • tac0turtle
  • aljo242

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b6d3d72 and 4dbed6c.

⛔ Files ignored due to path filters (1)
  • collections/protocodec/go.sum is excluded by !**/*.sum
📒 Files selected for processing (8)
  • .github/dependabot.yml (0 hunks)
  • .github/pr_labeler.yml (0 hunks)
  • .github/workflows/test.yml (0 hunks)
  • collections/CHANGELOG.md (1 hunks)
  • collections/go.mod (1 hunks)
  • collections/protocodec/CHANGELOG.md (0 hunks)
  • collections/protocodec/go.mod (0 hunks)
  • go.work.example (0 hunks)
💤 Files with no reviewable changes (6)
  • go.work.example
  • collections/protocodec/CHANGELOG.md
  • collections/protocodec/go.mod
  • .github/dependabot.yml
  • .github/pr_labeler.yml
  • .github/workflows/test.yml
🧰 Additional context used
📓 Path-based instructions (1)
collections/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 GitHub Actions: v2 core Tests
collections/go.mod

[warning] File detected in git diff, may require attention

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: tests (00)
  • GitHub Check: test-sim-nondeterminism
  • GitHub Check: Summary
🔇 Additional comments (3)
collections/CHANGELOG.md (2)

34-35: LGTM! Version header is well-formatted.

The version header follows the established format and includes a properly formatted release link.


36-38: LGTM! Improvement entry is clear and well-documented.

The entry follows the changelog format, properly references the PR, and clearly describes the change using consistent formatting for module names.

collections/go.mod (1)

10-10: Verify the direct dependency on go-cmp

The change moves github.com/google/go-cmp from indirect to direct dependencies. Let's verify this is intentionally used directly in the codebase.

✅ Verification successful

Direct dependency on go-cmp is correctly specified

The dependency is directly used in test files within the collections module (collections/protocodec/collections_test.go), justifying its status as a direct dependency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for direct usage of go-cmp in the collections module

echo "Searching for direct imports of go-cmp..."
rg --type go 'github.com/google/go-cmp' -g '!vendor/**'

echo -e "\nSearching for actual usage of go-cmp functions..."
ast-grep --pattern 'cmp.$_($$$)'

Length of output: 952

🧰 Tools
🪛 GitHub Actions: v2 core Tests

[warning] File detected in git diff, may require attention


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@aljo242 aljo242 added this pull request to the merge queue Jan 27, 2025
Merged via the queue into main with commit 7fdf3a2 Jan 27, 2025
77 of 78 checks passed
@aljo242 aljo242 deleted the julien/kill-protocodec-pkg branch January 27, 2025 16:59
@julienrbrt
Copy link
Member Author

alpe added a commit that referenced this pull request Jan 30, 2025
* main: (61 commits)
  build(deps): Bump cosmossdk.io/x/tx from 1.0.1 to 1.1.0 (#23547)
  feat(client/v2): add map support (#23544)
  fix(db): Fix pebbleDB integration (#23552)
  build(deps): Bump buf.build/gen/go/cometbft/cometbft/protocolbuffers/go from 1.36.3-20241120201313-68e42a58b301.1 to 1.36.4-20241120201313-68e42a58b301.1 in /api (#23520)
  build(deps): Bump github.com/golang/glog from 1.2.3 to 1.2.4 in /tools/hubl (#23541)
  fix(x/tx): add an option to encode maps using amino json (ref #23513) (#23539)
  build(deps): Bump cosmossdk.io/collections from 1.0.0 to 1.1.0 (#23534)
  build(deps): Bump github.com/bytedance/sonic from 1.12.7 to 1.12.8 in /log (#23516)
  chore: fix changelog for `v0.52.0-rc.2` (#23502)
  build(deps): Bump google.golang.org/protobuf from 1.36.3 to 1.36.4 in /x/upgrade (#23512)
  chore(collections): bring in `protocodec` in collections directly (#23515)
  feat(x/tx): add an option to encode maps using amino json (#23513)
  fix(codec): provide legacy amino og type (#23504)
  chore: remove unecessary SDKGasMeter impl (#23503)
  refactor: replace `golang.org/x/exp` with stdlib (#23501)
  build(deps): Bump google.golang.org/grpc from 1.69.4 to 1.70.0 in /tools/cosmovisor (#23496)
  build(deps): Bump google.golang.org/grpc from 1.69.4 to 1.70.0 in /store (#23494)
  build(deps): Bump github.com/hashicorp/go-plugin from 1.6.2 to 1.6.3 in /store (#23493)
  ci: Fix Ci job target (#23500)
  feat(server/v2): add swagger server component (#23486)
  ...
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.

3 participants