fix(client/v2): use (PREFIX)_HOME instead of NODE_HOME

[julienrbrt]

Description

Closes: #20958

Tagging beta.4 after the backport

---

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

• Bug Fixes

  • Improved handling of environment variables for specifying the home directory, ensuring the correct variable is used with or without a prefix.

• Documentation

  • Updated environment variable references from NODE_HOME to GAIA_HOME for clarity in Gaia node setup instructions.

[coderabbitai]

Walkthrough

Walkthrough

The change primarily involves updating the handling of the home directory environment variable in the Cosmos SDK's CLI. The GetNodeHomeDirectory function is modified to consider a configurable prefix for the HOME environment variable, ensuring it aligns with the actual prefix used by different chain setups. This improves the consistency and reliability of home directory resolution across various components.

Changes

File	Change Summary
client/v2/CHANGELOG.md	Bug fix related to the GetNodeHomeDirectory function to handle the (PREFIX)_HOME environment variable, improving reliability.
client/v2/helpers/home.go	Added EnvPrefix variable and updated GetNodeHomeDirectory function to handle prefixed environment variables.
docs/learn/advanced/07-cli.md	Updated NODE_HOME to GAIA_HOME to reflect the correct environment variable for Gaia node setup.
simapp/simd/main.go	Modified Execute call to include clientv2helpers.EnvPrefix as an argument.
simapp/v2/simdv2/main.go	Similar to simapp/simd/main.go, updated Execute call to include clientv2helpers.EnvPrefix argument.

Assessment against linked issues

Objective	Addressed	Explanation
Update GetNodeHomeDirectory to handle (PREFIX)_HOME environment variable (#20958).	✅
Ensure consistency in resolving home directory paths without relying on a global instance.	✅
Update documentation to reflect changes in environment variable handling.	✅

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

[julienrbrt]

This solves the bug that effectively if you want to set another home using $HOME, you always get the directory called .simapp. This only happens when you do not use a prefix, and the command home clashes with system home (on linux and macos)

HOME=~/download/.simapp simd config home 
/home/user/download/.simapp/.simapp

If we make the env check on home, earlier then we would have had

simd config home
/home/user

So the fix is using node home if you want to specify another folder than simapp when you have no prefix

NODE_HOME=~/download/simappv2 simd config home
/home/user/download/simappv2

and

simd config home
/home/user/.simapp

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7a387cb and 24269e7.

Files selected for processing (5)

• client/v2/CHANGELOG.md (1 hunks)
• client/v2/helpers/home.go (2 hunks)
• docs/learn/advanced/07-cli.md (1 hunks)
• simapp/simd/main.go (2 hunks)
• simapp/v2/simdv2/main.go (2 hunks)

Files skipped from review due to trivial changes (1)

• docs/learn/advanced/07-cli.md

Additional context used

Path-based instructions (4)

simapp/simd/main.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

simapp/v2/simdv2/main.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

client/v2/helpers/home.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

client/v2/CHANGELOG.md (1)

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

Additional comments not posted (7)

simapp/simd/main.go (2)

7-7: Import of clientv2helpers added.

This import is necessary for accessing the EnvPrefix variable, which is used to dynamically set the environment variable prefix. This change is aligned with the PR objectives and seems correctly implemented.

---

16-16: Updated function call to use EnvPrefix.

The change to pass clientv2helpers.EnvPrefix instead of an empty string as the second argument to svrcmd.Execute() is crucial for ensuring that the environment variable prefix is correctly utilized. This should help in maintaining consistency with the viper setup and the current simapp configuration.

simapp/v2/simdv2/main.go (2)

7-7: Import of clientv2helpers added.

This import is necessary for accessing the EnvPrefix variable, which is used to dynamically set the environment variable prefix. This change is aligned with the PR objectives and seems correctly implemented.

---

16-16: Updated function call to use EnvPrefix.

The change to pass clientv2helpers.EnvPrefix instead of an empty string as the second argument to serverv2.Execute() is crucial for ensuring that the environment variable prefix is correctly utilized. This should help in maintaining consistency with the viper setup and the current simapp configuration.

client/v2/helpers/home.go (2)

9-11: Introduction of EnvPrefix variable.

The declaration of EnvPrefix is a crucial addition for dynamically setting the prefix for environment variables. This is aligned with the PR objectives to handle environment variables more flexibly and correctly.

---

Line range hint 14-36: Updated logic in GetNodeHomeDirectory.

The function now dynamically checks for the (PREFIX)_HOME environment variable if a prefix is set, and defaults to NODE_HOME otherwise. This change is essential for avoiding clashes with the system HOME variable and aligns with the PR objectives to correct the environment variable usage.

client/v2/CHANGELOG.md (1)

52-52: Changelog entry for GetNodeHomeDirectory fix.

The entry correctly documents the bug fix in GetNodeHomeDirectory to respect the (PREFIX)_HOME environment variable. It is well-placed under the "Bug Fixes" section and includes a reference to the pull request, which is good practice for traceability.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7a387cb and 24269e7.

Files selected for processing (5)

• client/v2/CHANGELOG.md (1 hunks)
• client/v2/helpers/home.go (2 hunks)
• docs/learn/advanced/07-cli.md (1 hunks)
• simapp/simd/main.go (2 hunks)
• simapp/v2/simdv2/main.go (2 hunks)

Additional context used

Path-based instructions (5)

simapp/simd/main.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

simapp/v2/simdv2/main.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

client/v2/helpers/home.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

client/v2/CHANGELOG.md (1)

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

docs/learn/advanced/07-cli.md (1)

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

Additional comments not posted (9)

simapp/simd/main.go (2)

7-7: Approved import addition.

The import of clientv2helpers is necessary for accessing EnvPrefix, aligning with the PR's objectives.

---

16-16: Verify the integration of EnvPrefix.

Ensure that the EnvPrefix is correctly utilized in the Execute function call and is consistent with other parts of the application.

Verification successful

---

The integration of EnvPrefix is correctly utilized and consistent across the application.

• The EnvPrefix is defined in client/v2/helpers/home.go.
• It is used consistently in various parts of the codebase for setting environment variable prefixes.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `clientv2helpers.EnvPrefix` in the `Execute` function call.

# Test: Search for the usage of `clientv2helpers.EnvPrefix` in the codebase. Expect: Consistent usage across the application.
rg --type go -A 5 $'clientv2helpers.EnvPrefix'

Length of output: 597

---

Script:

#!/bin/bash
# Description: Verify the definition and usage of `EnvPrefix` in the `clientv2helpers` package.

# Test: Search for the definition of `EnvPrefix` in the `clientv2helpers` package.
rg --type go -A 5 'EnvPrefix' --glob '**/clientv2helpers/*.go'

Length of output: 211

---

Script:

#!/bin/bash
# Description: Locate files in the `clientv2helpers` package and verify the definition and usage of `EnvPrefix`.

# Locate all files in the `clientv2helpers` package.
fd . --glob '**/clientv2helpers/*.go' > clientv2helpers_files.txt

# Search for the definition of `EnvPrefix` within the located files.
xargs rg --type go -A 5 'EnvPrefix' < clientv2helpers_files.txt

Length of output: 3048

simapp/v2/simdv2/main.go (2)

7-7: Approved import addition.

The import of clientv2helpers is necessary for accessing EnvPrefix, aligning with the PR's objectives.

---

16-16: Verify the integration of EnvPrefix.

Ensure that the EnvPrefix is correctly utilized in the Execute function call and is consistent with other parts of the application.

Verification successful

---

Verify the integration of EnvPrefix.

The EnvPrefix is defined as a variable in client/v2/helpers/home.go and is used in the Execute function calls in simapp/simd/main.go and simapp/v2/simdv2/main.go. The Execute function implementations are located in server/v2/commands.go and server/cmd/execute.go.

• Definition of EnvPrefix:

  • client/v2/helpers/home.go: var EnvPrefix = ""

• Usage in Execute function:

  • simapp/simd/main.go: if err := svrcmd.Execute(rootCmd, clientv2helpers.EnvPrefix, simapp.DefaultNodeHome); err != nil {
  • simapp/v2/simdv2/main.go: if err := serverv2.Execute(rootCmd, clientv2helpers.EnvPrefix, simapp.DefaultNodeHome); err != nil {

• Implementation of Execute function:

  • server/v2/commands.go: func Execute(rootCmd *cobra.Command, envPrefix, defaultHome string) error {
  • server/cmd/execute.go: func Execute(rootCmd *cobra.Command, envPrefix, defaultHome string) error {

The integration of EnvPrefix appears to be consistent and correctly utilized in the Execute function calls.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `clientv2helpers.EnvPrefix` in the `Execute` function call.

# Test: Search for the usage of `clientv2helpers.EnvPrefix` in the codebase. Expect: Consistent usage across the application.
rg --type go -A 5 $'clientv2helpers.EnvPrefix'

Length of output: 597

---

Script:

#!/bin/bash
# Locate the definition of `clientv2helpers.EnvPrefix`
rg --type go 'EnvPrefix' | grep 'clientv2helpers'

# Locate the implementation of the `Execute` function in `svrcmd` and `serverv2`
rg --type go 'func Execute' | grep -E 'svrcmd|serverv2'

Length of output: 352

---

Script:

#!/bin/bash
# Locate the definition of `EnvPrefix` within `clientv2helpers`
ast-grep --lang go --pattern 'const EnvPrefix = $_' | grep 'clientv2helpers'

# Locate the implementation of the `Execute` function in `svrcmd` and `serverv2`
ast-grep --lang go --pattern 'func Execute($_, $_, $_) $_' | grep -E 'svrcmd|serverv2'

Length of output: 165

---

Script:

#!/bin/bash
# Locate variable declarations of `EnvPrefix` within the codebase
ast-grep --lang go --pattern 'const EnvPrefix = $_'

# Locate the implementation of the `Execute` function within the codebase
ast-grep --lang go --pattern 'func Execute($_, $_, $_) $_'

Length of output: 114

---

Script:

#!/bin/bash
# Search for all occurrences of `EnvPrefix` to understand its context
rg --type go 'EnvPrefix'

# Search for all `Execute` function definitions
rg --type go 'func Execute'

Length of output: 976

client/v2/helpers/home.go (2)

9-11: Approved addition of EnvPrefix.

The introduction of EnvPrefix is crucial for handling environment variables correctly, aligning with the PR's objectives.

---

Line range hint 14-36: Review modifications to GetNodeHomeDirectory.

Ensure that the changes in the GetNodeHomeDirectory function correctly handle the environment variables based on the prefix and are clear in their logic.

Verification successful

---

Verified: The GetNodeHomeDirectory function correctly handles the environment variables based on the prefix and is clear in its logic.

• The function first checks command-line arguments for the --home flag.
• It then checks for the environment variable using EnvPrefix.
• If EnvPrefix is empty, it defaults to checking NODE_HOME.
• Finally, it falls back to the user's home directory.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the correct handling of environment variables in `GetNodeHomeDirectory`.

# Test: Search for the usage of `GetNodeHomeDirectory` in the codebase. Expect: Correct handling of environment variables based on the prefix.
rg --type go -A 5 $'GetNodeHomeDirectory'

Length of output: 1508

---

Script:

#!/bin/bash
# Description: Extract the complete implementation of GetNodeHomeDirectory and the definition of EnvPrefix.

# Extract the complete implementation of GetNodeHomeDirectory.
ast-grep --lang go --pattern $'func GetNodeHomeDirectory(name string) (string, error) {
  $$$
}' --debug

# Extract the definition of EnvPrefix.
rg --type go 'EnvPrefix'

Length of output: 1074

---

Script:

#!/bin/bash
# Description: Extract the complete implementation of GetNodeHomeDirectory.

# Extract the complete implementation of GetNodeHomeDirectory.
ast-grep --lang go --pattern $'func GetNodeHomeDirectory(name string) (string, error) {
  $$$
}'

Length of output: 1978

client/v2/CHANGELOG.md (1)

52-52: Review change log entry for correctness and clarity.

Ensure that the change log entry for the bug fix in GetNodeHomeDirectory is clear and grammatically correct.

docs/learn/advanced/07-cli.md (2)

185-185: Update environment variable in documentation.

The environment variable NODE_HOME has been updated to GAIA_HOME to reflect the semantic changes in the naming convention for specifying the path to the home directory within the context of the Gaia node setup. This change aligns with the PR objectives to use HOME or <prefix>_HOME instead of NODE_HOME.

---

Line range hint 1-200: Documentation Review: General Check

Overall, the documentation is well-written and informative. However, ensure all external links are up to date and functional. Additionally, verify that all code references and examples accurately reflect the latest SDK versions and practices.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 24269e7 and 3eaf060.

Files selected for processing (1)

• simapp/v2/simdv2/main.go (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• simapp/v2/simdv2/main.go