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: bump v1.13.78-RC.1 #519

Merged
merged 1 commit into from
Nov 28, 2024
Merged

Conversation

danidomi
Copy link
Contributor

@danidomi danidomi commented Nov 27, 2024

Summary by CodeRabbit

  • New Features

    • Updated the script to clone the latest branch of the injective_indexer repository for proto definitions.
  • Improvements

    • Enhanced string replacement logic in generated TypeScript files for better compatibility.
    • Updated import paths to ensure correct module resolution.
  • Chores

    • Maintained the cleanup process to remove temporary files and directories after generation.

Copy link

coderabbitai bot commented Nov 27, 2024

Walkthrough

The pull request modifies the gen.sh script used for generating TypeScript proto definitions from the injective_indexer repository. The branch being cloned is updated from v1.13.76 to v1.13.78-RC.1. Enhancements include additional string replacements in generated TypeScript files, such as changing import paths and adding TypeScript ignore comments. The cleanup process remains the same, ensuring old files are removed before new ones are generated.

Changes

File Change Summary
proto/indexer/gen.sh - Updated branch from v1.13.76 to v1.13.78-RC.1.
- Enhanced string replacements in TypeScript files (import paths and ignore comments).
- Maintained structure for copying template files.

Possibly related PRs

  • f/fix: remove unnecessary goa proto naming #511: The changes in both PRs involve updates to the branch version of the injective_indexer repository in the gen.sh script, indicating a direct connection in the context of managing proto definitions.

Poem

🐇 In the land of code where bunnies hop,
The gen.sh script makes changes non-stop.
From v1.13.76 to RC.1 we glide,
With TypeScript tweaks, we take great pride.
Old files are swept, new paths we set,
A cleaner codebase, the best one yet! 🌟


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
proto/indexer/gen.sh (2)

Line range hint 54-67: Investigate type issues requiring ts-ignore

The addition of // @ts-ignore comments for getExtension and setExtension methods suggests underlying type issues. Consider:

  1. Investigating why these type errors occur
  2. Fixing the type definitions if possible
  3. Adding comments explaining why these ignores are necessary if they can't be fixed

Line range hint 46-77: Consider using a more maintainable approach for string replacements

The current string replacement logic using multiple sed commands could be made more maintainable.

Consider creating a separate configuration file for replacements and using a more structured approach:

+ # Create replacements.json
+ {
+   "global": [
+     {"from": "@improbable-eng/grpc-web", "to": "@injectivelabs/grpc-web"},
+     {"from": "protobufjs/minimal", "to": "protobufjs/minimal.js"}
+   ],
+   "dts": [
+     {"from": "getExtension():", "to": "// @ts-ignore\n  getExtension():"},
+     {"from": "setExtension(", "to": "// @ts-ignore\n  setExtension("}
+   ]
+ }

+ # Create a helper script: replace.js
+ const replacements = require('./replacements.json');
+ const fs = require('fs');
+ const path = require('path');

+ function processFile(file, rules) {
+   let content = fs.readFileSync(file, 'utf8');
+   for (const rule of rules) {
+     content = content.replace(new RegExp(rule.from, 'g'), rule.to);
+   }
+   fs.writeFileSync(file, content);
+ }

This approach would make the replacements more maintainable and easier to update.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1dfb4fe and 17b92e2.

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

Line range hint 8-42: LGTM! Proto generation setup is well-structured

The proto generation process is properly configured with:

  • Thorough cleanup of old generated files
  • Appropriate protoc options for TypeScript
  • Support for both ESM and CJS outputs

Line range hint 108-114: LGTM! Thorough cleanup process

The final cleanup process effectively removes all temporary files and artifacts.


6-6: Verify compatibility with v1.13.78-RC.1

The script now uses a release candidate version. Please ensure that this version has been properly tested and is stable enough for integration.

@bangjelkoski bangjelkoski merged commit ab5642d into dev Nov 28, 2024
3 checks passed
@ThomasRalee ThomasRalee deleted the f/release-proto-indexer-v1.13.78-RC.1 branch November 29, 2024 13:18
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