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

f/fix: remove unnecessary goa proto naming #511

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

danidomi
Copy link
Contributor

@danidomi danidomi commented Nov 5, 2024

Summary by CodeRabbit

  • Chores
    • Updated the branch version for proto definitions.
    • Removed obsolete file renaming logic to streamline the script.

Copy link

coderabbitai bot commented Nov 5, 2024

Walkthrough

The pull request modifies the gen.sh script in the proto/indexer directory. Key changes include updating the branch version from v1.13.41 to v1.13.62-RC.1 and removing obsolete code related to file renaming. The script continues to perform its primary functions, such as cleaning up old files and generating TypeScript proto code, while streamlining its logic by eliminating unnecessary renaming steps.

Changes

File Change Summary
proto/indexer/gen.sh Updated injective_indexer_branch from v1.13.41 to v1.13.62-RC.1; removed file renaming logic.

Poem

In the script where code does play,
A version change brightens the day.
With renaming gone, it’s clear and neat,
Generating types, oh what a feat!
Hopping along, we cheer with glee,
For simpler paths, just let it be! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5b50ef9 and 831ec47.

📒 Files selected for processing (1)
  • proto/indexer/gen.sh (1 hunks)
🔇 Additional comments (2)
proto/indexer/gen.sh (2)

6-6: Verify the rationale for using a release candidate version.

The branch version has been updated from v1.13.41 to v1.13.62-RC.1. While this change might address the goa proto naming issue, using a release candidate (RC) version in a build script could potentially introduce instability.

Let's verify if this version specifically addresses the goa proto naming issue:

#!/bin/bash
# Description: Check the changes between the old and new versions that might be related to goa proto naming

# Test 1: Clone both versions and compare the proto file generation
echo "Comparing proto generation between versions..."
OLD_DIR=$(mktemp -d)
NEW_DIR=$(mktemp -d)

git clone https://github.com/InjectiveLabs/injective-indexer.git $OLD_DIR -b v1.13.41 --depth 1 2>/dev/null
git clone https://github.com/InjectiveLabs/injective-indexer.git $NEW_DIR -b v1.13.62-RC.1 --depth 1 2>/dev/null

# Check for files with goadesign_goagen prefix in both versions
echo "Files with goadesign_goagen prefix in v1.13.41:"
find $OLD_DIR/api/gen -type f -name "goadesign_goagen_*" 2>/dev/null

echo "Files with goadesign_goagen prefix in v1.13.62-RC.1:"
find $NEW_DIR/api/gen -type f -name "goadesign_goagen_*" 2>/dev/null

# Cleanup
rm -rf $OLD_DIR $NEW_DIR

Line range hint 1-124: LGTM! The removal of goa proto naming cleanup logic is appropriate.

The removal of the code that handled renaming of goadesign_goagen_ prefixed files aligns with the PR objectives. Since the new version no longer generates files with this prefix, the cleanup step is no longer necessary.

Let's verify that no references to the old naming pattern remain:


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 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.

CodeRabbit Configuration 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.

@bangjelkoski bangjelkoski merged commit c55f0f6 into dev Nov 6, 2024
3 checks passed
@bangjelkoski bangjelkoski deleted the f/fix-unnecessary-replace-goa-proto-buf branch November 6, 2024 09:14
This was referenced Nov 25, 2024
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