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

add spellcheck and run #79

Merged
merged 1 commit into from
Nov 15, 2024
Merged

add spellcheck and run #79

merged 1 commit into from
Nov 15, 2024

Conversation

Vritra4
Copy link
Contributor

@Vritra4 Vritra4 commented Nov 15, 2024

Description

similar with initia`s, add a workflow to check spell


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
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • 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

Summary by CodeRabbit

  • New Features

    • Introduced automated spell-checking for pull requests through a new GitHub Actions workflow.
    • Added a .codespellignore file to specify terms to be ignored during spell-checking.
  • Bug Fixes

    • Corrected typos in comments across multiple files for improved clarity.
  • Chores

    • Updated installation commands and comments in Dockerfiles and Makefiles for better understanding and accuracy.

@Vritra4 Vritra4 requested a review from a team as a code owner November 15, 2024 03:19
Copy link

coderabbitai bot commented Nov 15, 2024

Walkthrough

This pull request introduces several changes aimed at enhancing spell-checking processes and improving code clarity. A new .codespellignore file is added to specify terms to be ignored by the codespell tool. Additionally, a GitHub Actions workflow named spellcheck.yml is introduced to automate spell checking during pull requests. Other changes include updates to Dockerfiles and a Makefile, primarily focusing on correcting comments and ensuring proper installation of dependencies without altering existing functionalities.

Changes

File Path Change Summary
.github/config/.codespellignore New file added to ignore specific terms during spell-checking: cips, pullrequest, keypair, etc.
.github/workflows/spellcheck.yml New workflow added to automate spell checking on pull requests, including steps for code checkout and running codespell.
Dockerfile.arm64 Comments updated for clarity, added vim package for debugging, no functional changes.
app/keepers/keepers.go Comment typo corrected, initialization logic for keepers refined, no new functionalities introduced.
contrib/devtools/Makefile Comments updated for clarity regarding installation commands, no changes to functionality.
shared.Dockerfile Comment typo corrected, installation commands updated for dependencies, no functional changes.

Possibly related PRs

  • bump opinit and cleanup github actions #59: The changes in this PR involve the introduction of a new GitHub Actions workflow for spell checking, which is related to the .codespellignore file added in the main PR. Both PRs focus on improving the spell-checking process in the codebase.

Poem

In the code where rabbits hop,
A spell-checker’s work won’t stop.
With terms ignored and typos fixed,
Our project shines, no words mixed!
So let’s rejoice and give a cheer,
For clarity is finally here! 🐇✨

Warning

Rate limit exceeded

@Vritra4 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 20 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between dbee224 and f823e0d.


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

codecov bot commented Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.56%. Comparing base (dbee224) to head (f823e0d).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #79   +/-   ##
=======================================
  Coverage   64.56%   64.56%           
=======================================
  Files          39       39           
  Lines        3217     3217           
=======================================
  Hits         2077     2077           
  Misses        965      965           
  Partials      175      175           
Files with missing lines Coverage Δ
app/keepers/keepers.go 98.59% <100.00%> (ø)

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: 2

🧹 Outside diff range and nitpick comments (2)
.github/workflows/spellcheck.yml (2)

3-5: Consider adding more trigger events

The workflow currently only runs on pull requests. Consider adding:

  • push event for main/master branch to catch typos in direct pushes
  • workflow_dispatch for manual runs when needed
 on:
   pull_request:
+  push:
+    branches: [ main, master ]
+  workflow_dispatch:

7-9: Add timeout configuration

Consider adding a timeout to prevent hung jobs from consuming unnecessary minutes.

 spellcheck:
   runs-on: ubuntu-latest
+  timeout-minutes: 10
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between dbee224 and f823e0d.

📒 Files selected for processing (6)
  • .github/config/.codespellignore (1 hunks)
  • .github/workflows/spellcheck.yml (1 hunks)
  • Dockerfile.arm64 (1 hunks)
  • app/keepers/keepers.go (1 hunks)
  • contrib/devtools/Makefile (2 hunks)
  • shared.Dockerfile (1 hunks)
✅ Files skipped from review due to trivial changes (4)
  • .github/config/.codespellignore
  • Dockerfile.arm64
  • contrib/devtools/Makefile
  • shared.Dockerfile
🔇 Additional comments (6)
.github/workflows/spellcheck.yml (2)

10-11: LGTM!

Using the latest major version of actions/checkout is good practice.


16-16: Verify .codespellignore file setup

The workflow references .github/config/.codespellignore, but we need to verify its existence and format.

✅ Verification successful

Codespell ignore file exists and is properly formatted

The .github/config/.codespellignore file exists and contains a valid list of words to be ignored by the spellchecker, one word per line. The format is correct and matches the expected structure for codespell ignore files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if .codespellignore exists and is properly formatted
if [ -f ".github/config/.codespellignore" ]; then
    echo "Found .codespellignore file"
    cat ".github/config/.codespellignore"
else
    echo "Error: .codespellignore file not found"
    # Check if it exists in other locations
    find . -name ".codespellignore" -type f
fi

Length of output: 249

app/keepers/keepers.go (4)

247-247: LGTM: Typo fix in comment

The spelling correction from "propogated" to "propagated" is accurate.


Line range hint 247-262: LGTM: Proper keeper initialization and hook configuration

The initialization sequence is correct:

  1. MarketMapKeeper is properly configured with OracleKeeper hooks
  2. OPChildKeeper is initialized with all required dependencies
  3. Authority address configuration is consistent

The hook configuration ensures that new market map entries are properly propagated to the oracle keeper.


Line range hint 702-711: LGTM: Secure Wasm query configuration

The Wasm query configuration implements proper security measures:

  1. Query allowlist is correctly configured for specific oracle queries
  2. Proto message types are explicitly defined for allowed queries
  3. Stargate querier is restricted to the allowlist

This implementation follows security best practices by limiting the attack surface through explicit allowlisting.


Line range hint 439-474: Verify IBC middleware stack configuration

The IBC middleware stack is configured with multiple layers. Please verify:

  1. The ordering of middleware matches the security requirements
  2. All necessary middleware hooks are properly connected
  3. The sequence handles both Send and Receive paths correctly:
    • Send: transfer -> packet forward -> rate limit -> fee -> channel
    • Receive: channel -> fee -> wasm -> rate limit -> packet forward -> forwarding -> transfer
✅ Verification successful

Based on the shell script results, I can now verify the IBC middleware stack configuration. Let me generate the final response:

IBC middleware stack configuration is correctly ordered and connected

The verification confirms that the middleware stack is properly configured with the correct ordering for both Send and Receive paths:

  • Transfer stack:
    • Receive path: fee -> wasm -> rate limit -> packet forward -> forwarding -> transfer (verified in code)
    • Send path: transfer -> packet forward -> rate limit -> fee -> channel (verified in ICS4wrapper comment)
  • ICA stacks:
    • Both host and controller modules are properly wrapped with fee middleware
  • Wasm stack:
    • Receive path: fee -> hook -> wasm (verified in code)

The middleware ordering follows security best practices by ensuring fee middleware is the outermost layer and maintaining consistent ordering between send and receive paths.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify IBC middleware configuration
# Look for any potential middleware ordering issues or missing connections

# Check for middleware initialization order
rg -A 5 "NewIBCMiddleware|NewMiddleware" 

# Verify all required IBC hooks are properly connected
ast-grep --pattern 'SetHooks($hook)'

Length of output: 3523

.github/workflows/spellcheck.yml Show resolved Hide resolved
.github/workflows/spellcheck.yml Show resolved Hide resolved
Copy link
Contributor

@beer-1 beer-1 left a comment

Choose a reason for hiding this comment

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

LGTM

@beer-1 beer-1 merged commit 0a50ef0 into main Nov 15, 2024
10 checks passed
@beer-1 beer-1 deleted the chore/spellcheck branch November 15, 2024 06: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