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

Remove the params store key and transient store key from the app. #2189

Merged
merged 3 commits into from
Oct 16, 2024

Conversation

SpicyLemon
Copy link
Contributor

@SpicyLemon SpicyLemon commented Oct 16, 2024

Description

Remove the params store key and transient store key from the app.

Turns out this should have been done in #2176. I didn't do it there because I was thinking that the app needed the store key in it in order to delete it. Now that I reflect on that, it should have obviously not been the right thing to do. Sorry.


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 correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Added relevant changelog entries under .changelog/unreleased (see Adding Changes).
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

Summary by CodeRabbit

Summary by CodeRabbit

  • Bug Fixes
    • Removed parameters related to store management, addressing restart issues after the recent upgrade.
    • Simplified application configuration by eliminating unnecessary key references, enhancing clarity in the app's initialization process.

@SpicyLemon SpicyLemon requested a review from a team as a code owner October 16, 2024 21:05
Copy link
Contributor

coderabbitai bot commented Oct 16, 2024

Walkthrough

The changes involve the removal of the params store key and transient store key from the application, as documented in the changelog under bug fixes. The app.go file has been updated to eliminate references to the params module, specifically removing the paramsKey and paramsTKey variables. This modification simplifies store management while retaining the overall structure and functionality of the application.

Changes

File Path Change Summary
.changelog/unreleased/bug-fixes/2189-remove-params-storekey.md Documentation of the removal of params store key and transient store key.
app/app.go Removed paramsKey and paramsTKey variables; updated initialization and configuration logic.

Poem

In the garden where changes bloom,
We’ve tidied up, made more room.
No more keys to clutter the way,
Simplicity shines bright today!
Hopping along, we celebrate,
A cleaner path, oh, isn’t it great? 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1f0f7de and 5ee7ebc.

📒 Files selected for processing (1)
  • .changelog/unreleased/bug-fixes/2189-remove-params-storekey.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.changelog/unreleased/bug-fixes/2189-remove-params-storekey.md

[style] ~2-~2: Consider using a different verb for a more formal wording.
Context: ...enance-io/provenance/pull/2189). This fixes a problem in v1.20.0-rc2 that prevent...

(FIX_RESOLVE)

🔇 Additional comments (1)
.changelog/unreleased/bug-fixes/2189-remove-params-storekey.md (1)

1-2: LGTM! Important bug fix clearly documented.

The changelog entry is well-written and provides clear information about the change:

  1. It succinctly describes the removal of the params store key and transient store key.
  2. It links to the relevant PR for further details.
  3. It explains the impact of the fix, addressing a critical issue that prevented node restarts after upgrades.

This is an important fix that enhances the stability of the system post-upgrade.

🧰 Tools
🪛 LanguageTool

[style] ~2-~2: Consider using a different verb for a more formal wording.
Context: ...enance-io/provenance/pull/2189). This fixes a problem in v1.20.0-rc2 that prevent...

(FIX_RESOLVE)


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.

@SpicyLemon SpicyLemon mentioned this pull request Oct 16, 2024
8 tasks
@SpicyLemon SpicyLemon changed the title Dwedul/remove params storekey Remove the params store key and transient store key from the app. Oct 16, 2024
Copy link
Contributor

@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 (1)
app/app.go (1)

214-216: Approved: Params constant marked for future removal

The removal of the paramsName constant is in line with the PR objectives. The TODO comment correctly indicates that this should be removed after an upgrade.

Would you like me to create a GitHub issue to track the future removal of this constant after the upgrade?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b11312b and 1f0f7de.

📒 Files selected for processing (2)
  • .changelog/unreleased/bug-fixes/2189-remove-params-storekey.md (1 hunks)
  • app/app.go (3 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changelog/unreleased/bug-fixes/2189-remove-params-storekey.md
🧰 Additional context used
🔇 Additional comments (2)
app/app.go (2)

Line range hint 363-387: Approved: Params key removed from store initialization

The paramsKey has been successfully removed from the store keys initialization, which is consistent with the PR objectives of removing the parameters store key.


Line range hint 1-1134: Overall assessment: Params module removal successfully implemented

The changes in this file accurately reflect the PR objectives of removing the parameters store key and transient store key. The modifications are minimal and focused:

  1. The paramsName constant has been marked for future removal.
  2. The paramsKey has been removed from the store keys initialization.

These changes appear to be sufficient for removing the params module without affecting other parts of the application. The rest of the file remains unchanged, suggesting that the params module was not deeply integrated into other components.

@SpicyLemon SpicyLemon enabled auto-merge (squash) October 16, 2024 21:11
@SpicyLemon SpicyLemon enabled auto-merge (squash) October 16, 2024 21:29
@SpicyLemon SpicyLemon merged commit 5f0c4e9 into main Oct 16, 2024
34 checks passed
@SpicyLemon SpicyLemon deleted the dwedul/remove-params-storekey branch October 16, 2024 22:09
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.

3 participants