feat: application data directory

ogabrielides commented 3 weeks ago

On startup, application data directory is created depending on the target architecture (for example):

macOS: ~/Library/Application Support/MyApp/
Windows: C:\Users\<User>\AppData\Roaming\MyApp\config
Linux: /home/<user>/.config/MyApp/

Database is created and used from that directory
Same for logging file
In application data directory, if ".env" is missing, then ".env.example" is copied as ".env"

Summary by CodeRabbit

Release Notes

New Features
- Introduced a new module for managing application user data directories and files.
- Enhanced the user interface for displaying withdrawal data with improved pagination controls.
Improvements
- Updated initialization logic to ensure necessary directories and files are created.
- Enhanced error handling for log file creation and configuration loading.
Bug Fixes
- Improved pagination logic to prevent out-of-bounds access in withdrawal data display.

These updates enhance user experience and application reliability.

coderabbitai[bot] commented 3 weeks ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces several modifications across multiple files in the dash-evo-tool package. Key changes include the addition of a new dependency in Cargo.toml, enhancements to the AppState struct in src/app.rs, and the introduction of a new module for managing application directories in src/app_dir.rs. The Config struct in src/config.rs now dynamically loads the .env file path, while logging functionality in src/logging.rs has been updated for better error handling. The UI for withdrawal status has also been improved in src/ui/withdraws_status_screen.rs.

Changes

File	Change Summary
Cargo.toml	- Added new dependency: `directories = "5.0"` - Updated dependency: `serde_yaml = "0.9.34+deprecated"`
src/app.rs	- Added functions: `create_app_user_data_directory_if_not_exists()`, `copy_mainnet_env_file_if_not_exists()` - Updated `new()` method in `AppState` to enhance initialization.
src/app_dir.rs	- Introduced functions for managing user data directories: `app_user_data_dir_path()`, `create_app_user_data_directory_if_not_exists()`, `app_user_data_file_path(filename: String)`, `copy_mainnet_env_file_if_not_exists()`
src/config.rs	- Updated `load()` method in `Config` to use dynamic path for `.env` file via `app_user_data_file_path`.
src/logging.rs	- Modified `initialize_logger` to use `app_user_data_file_path` for log file location.
src/main.rs	- Added new module: `mod app_dir;`
src/ui/withdraws_status_screen.rs	- Updated `WithdrawsStatusScreen` for improved pagination handling and display of withdrawal data. - Refined methods for clarity and usability.

Possibly related PRs

#15: The changes in src/config.rs related to loading the .env file dynamically are connected to the main PR's updates in Cargo.toml, as both involve managing configuration and dependencies in the application.
#18: The modifications in src/app.rs that enhance the AppState::new method are relevant to the main PR, as they both involve changes to the application state management and initialization processes.

Suggested reviewers

QuantumExplorer

🐰 In the garden where changes bloom,
New paths and functions make room.
With directories tidy and logs in place,
The app now runs with a happier face!
Let's hop along, with joy we cheer,
For every update brings us near! 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

ogabrielides commented 3 weeks ago

@coderabbitai review

coderabbitai[bot] commented 3 weeks ago

:white_check_mark: Actions performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

dashpay / dash-evo-tool