fix(simapp): fix default home

[julienrbrt]

Description

Closes: #18868

For reference, a temporary workaround, without adding this api (and thus needing 0.50.4) is this commit: b9de0f3

---

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

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

• Refactor
  • Deprecated ReadFromClientConfig in favor of CreateClientConfig for improved configuration management.
  • Introduced ReadDefaultValuesFromDefaultClientConfig to streamline reading default configuration values.
• Chores
  • Updated initialization processes in root.go and root_v2.go to utilize new configuration reading approach.

[coderabbitai]

Warning

Rate Limit Exceeded

@julienrbrt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 57 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

Files that changed from the base of the PR and between 5d1ae5d and c2a3b5a.

Walkthrough

The recent updates to the codebase focus on enhancing the configuration management for the client by deprecating the ReadFromClientConfig function in favor of CreateClientConfig, and introducing ReadDefaultValuesFromDefaultClientConfig to better handle default values and directory settings based on the client's configuration. These changes streamline the initialization process and address issues related to the --home flag not being respected, by ensuring the application's configuration directory is correctly set to the user-specified location.

Changes

File(s)	Change Summary
client/config/config.go	Deprecated ReadFromClientConfig; added CreateClientConfig and ReadDefaultValuesFromDefaultClientConfig for handling default configuration values.
simapp/simd/cmd/root.go & simapp/simd/cmd/root_v2.go	Replaced usage of CreateClientConfig with ReadDefaultValuesFromDefaultClientConfig to initialize default configuration values.

Assessment against linked issues

Objective	Addressed	Explanation
Bug Identification and Context (Issue #18868)	✅
Investigation Findings and Affected Version (Issue #18868)	❓	The summary does not explicitly mention the investigation's findings related to the --home flag issue or the affected versions being addressed.
Reproduction Steps and Correct Handling of Home Directory Flag (Issue #18868)	✅	The introduction of ReadDefaultValuesFromDefaultClientConfig and the modifications in root.go and root_v2.go suggest that the application now correctly initializes the configuration directory based on the specified --home flag, aligning with the objectives to ensure the custom home location is respected.

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between e4fabeb and 5d1ae5d.

Files selected for processing (3)

• client/config/config.go (1 hunks)
• simapp/simd/cmd/root.go (1 hunks)
• simapp/simd/cmd/root_v2.go (1 hunks)

Additional comments: 4

simapp/simd/cmd/root_v2.go (1)

• 123-123: The change to use config.ReadDefaultValuesFromDefaultClientConfig aligns with the PR's objective to ensure the --home flag is correctly respected by reading default values from the default client configuration. This approach should effectively address the issue with the --home flag not being respected.

simapp/simd/cmd/root.go (1)

• 111-111: Replacing config.CreateClientConfig with config.ReadDefaultValuesFromDefaultClientConfig in root.go is consistent with the PR's goal to fix the --home flag issue. This modification ensures that default values are correctly read and applied, addressing the initialization problem.

client/config/config.go (2)

• 39-39: Deprecating ReadFromClientConfig in favor of more explicit configuration handling functions is a good practice for clarity and maintainability.
• 44-61: The implementation of ReadDefaultValuesFromDefaultClientConfig correctly addresses the issue with the --home flag by temporarily setting HomeDir to ensure the default client configuration is read without affecting the actual HomeDir setting. This approach is effective for initializing the client context with default values while respecting the --home flag.