Skip to content

fix: embed .env.example and core configs into the binary#331

Merged
lklimek merged 3 commits into
v0.9-devfrom
feat/embed-resources
Jun 5, 2025
Merged

fix: embed .env.example and core configs into the binary#331
lklimek merged 3 commits into
v0.9-devfrom
feat/embed-resources

Conversation

@lklimek
Copy link
Copy Markdown
Contributor

@lklimek lklimek commented Jun 5, 2025

This pull request introduces functionality to manage bundled resources and streamline configuration file handling for different Dash network environments. The changes include adding a new BundledResource enum to encapsulate bundled resources, refactoring methods to use this new abstraction, and updating logic for creating and managing configuration files.

Bundled Resource Management:

  • src/bundled.rs: Introduced the BundledResource enum to represent bundled resources such as .env.example and Dash core configuration files. Added methods to load resources as byte slices and write them to files, including directory creation when necessary.

Configuration File Handling:

  • src/app_dir.rs: Refactored copy_env_file_if_not_exists to use BundledResource::DotEnvExample for copying the .env.example file. Added create_dash_core_config_if_not_exists to dynamically generate Dash core configuration files based on the network.
  • src/backend_task/core/start_dash_qt.rs: Updated logic to use create_dash_core_config_if_not_exists for determining and creating Dash core configuration files, replacing hardcoded paths.

Codebase Enhancements:

  • src/app_dir.rs: Improved imports by grouping and adding std::io and crate::bundled::BundledResource.
  • src/main.rs: Added the bundled module to the project structure for managing bundled resources.

@lklimek lklimek requested a review from Copilot June 5, 2025 11:54
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2025

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.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@lklimek lklimek moved this to In review / testing in Platform team Jun 5, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces functionality to embed bundled resource files (such as .env.example and Dash core configuration files) into the binary, streamlining configuration file management for different Dash network environments.

  • Added a new BundledResource enum for resource management.
  • Refactored configuration file handling to utilize the new abstraction in both app_dir.rs and backend_task/core/start_dash_qt.rs.
  • Updated the project structure by adding the bundled module in main.rs.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
src/main.rs Added the bundled module to support embedded resource management.
src/bundled.rs Introduced the BundledResource enum and associated helper methods to load and write files.
src/backend_task/core/start_dash_qt.rs Updated configuration file determination logic to use create_dash_core_config_if_not_exists.
src/app_dir.rs Refactored env file copying and added dynamic creation of Dash core configuration files.

Comment thread src/app_dir.rs Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@lklimek lklimek changed the title feat: embed .env.example and core configs into the binary fix: embed .env.example and core configs into the binary Jun 5, 2025
@lklimek lklimek merged commit da786c5 into v0.9-dev Jun 5, 2025
3 checks passed
@lklimek lklimek deleted the feat/embed-resources branch June 5, 2025 12:36
@github-project-automation github-project-automation Bot moved this from In review / testing to Done in Platform team Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Failed to copy env file: Os on new install using DET v0.9-Developer-Preview Cannot start Dash Core with v0.9-Developer-Preview

3 participants