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

feat: justfile follower commands and configs #1607

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Conversation

dinhani-cw
Copy link
Contributor

@dinhani-cw dinhani-cw commented Aug 6, 2024

PR Type

enhancement, configuration changes


Description

  • Updated the stratus-follower.env.local configuration file to include the ADDRESS setting and changed EXTERNAL_RPC and EXTERNAL_RPC_WS to use localhost.
  • Added run-follower and run-importer aliases to the justfile.

Changes walkthrough 📝

Relevant files
Configuration changes
stratus-follower.env.local
Update follower environment configuration                               

config/stratus-follower.env.local

  • Added ADDRESS configuration.
  • Updated EXTERNAL_RPC and EXTERNAL_RPC_WS to use localhost.
  • +4/-2     
    Enhancement
    justfile
    Add follower and importer aliases to justfile                       

    justfile

    • Added run-follower and run-importer aliases.
    +2/-0     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @dinhani-cw dinhani-cw enabled auto-merge (squash) August 6, 2024 14:56
    Copy link

    github-actions bot commented Aug 6, 2024

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link

    github-actions bot commented Aug 6, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Security
    Use a more secure address for external RPC endpoints instead of localhost

    Consider using a more secure address for EXTERNAL_RPC and EXTERNAL_RPC_WS instead of
    localhost, especially if this configuration is intended for production. Using
    localhost might expose the service to local attacks.

    config/stratus-follower.env.local [11-12]

    -EXTERNAL_RPC=http://localhost:3000/
    -EXTERNAL_RPC_WS=ws://localhost:3000/
    +EXTERNAL_RPC=http://secure-address:3000/
    +EXTERNAL_RPC_WS=ws://secure-address:3000/
     
    Suggestion importance[1-10]: 9

    Why: This suggestion addresses a significant security concern by recommending the use of a more secure address for EXTERNAL_RPC and EXTERNAL_RPC_WS instead of localhost. This is especially important for production environments to prevent local attacks.

    9
    Maintainability
    Rename the alias run-importer to something more descriptive if it serves a different purpose

    The alias run-importer might be confusing if it points to the same command as
    run-follower. Consider renaming it to something more descriptive or removing it if
    it's redundant.

    justfile [36]

    -alias run-importer := stratus-follower
    +alias run-importer := stratus-importer
     
    Suggestion importance[1-10]: 7

    Why: The suggestion improves code maintainability by recommending a more descriptive alias name. This helps avoid confusion if run-importer serves a different purpose than run-follower.

    7

    @dinhani-cw dinhani-cw merged commit 8b79e7e into main Aug 6, 2024
    33 checks passed
    @dinhani-cw dinhani-cw deleted the justfile-follower branch August 6, 2024 15:00
    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.

    1 participant