Skip to content

# Sequence diagram for deduplicated git submodule status check #318

@Dargon789

Description

@Dargon789

Reviewer's Guide

Refactors and cleans up various utilities across the codebase while deduplicating the git submodule status logic and improving Solar source selection for lint/build flows. Also updates security advisories configuration.

Sequence diagram for deduplicated git submodule status check

sequenceDiagram
    actor Developer
    participant ForgeCLI
    participant GitUtils
    participant GitCommand as GitCommandRunner

    Developer->>ForgeCLI: run command requiring submodules_uninitialized
    ForgeCLI->>GitUtils: submodules_uninitialized()
    GitUtils->>GitUtils: has_missing_dependencies(empty_iterator)
    GitUtils->>GitCommand: cmd().args(["submodule", "status"])
    GitCommand-->>GitUtils: stdout
    GitUtils->>GitUtils: parse lines, check for '-' prefix
    GitUtils-->>ForgeCLI: bool (uninitialized_submodules)
    ForgeCLI-->>Developer: report based on uninitialized_submodules
Loading

Sequence diagram for Solar source selection with ignored paths in lint/build

sequenceDiagram
    actor User
    participant ForgeCLI
    participant LintArgs
    participant BuildArgs
    participant ProjectCompiler
    participant BuildUtils as BuildUtils_get_solar_sources
    participant Solar

    User->>ForgeCLI: forge lint
    ForgeCLI->>LintArgs: execute()
    LintArgs->>ProjectCompiler: compile(input_files)
    ProjectCompiler-->>LintArgs: ProjectCompileOutput
    LintArgs->>BuildUtils: get_solar_sources_from_compile_output(config, output, target_paths, ignored_paths)
    BuildUtils->>BuildUtils: collect target source_paths
    BuildUtils->>BuildUtils: traverse imports, skip is_ignored(path)
    BuildUtils-->>LintArgs: SolcVersionedInput (filtered sources)
    LintArgs->>Solar: run lint with SolcVersionedInput
    Solar-->>User: lint results

    User->>ForgeCLI: forge build
    ForgeCLI->>BuildArgs: execute()
    BuildArgs->>ProjectCompiler: compile(input_files)
    ProjectCompiler-->>BuildArgs: ProjectCompileOutput
    BuildArgs->>BuildUtils: get_solar_sources_from_compile_output(config, output, target_paths, ignored_paths=None)
    BuildUtils-->>BuildArgs: SolcVersionedInput
    BuildArgs->>Solar: optional Solar checks
    Solar-->>User: build diagnostics
Loading

Class diagram for updated Solar source selection utilities

classDiagram
    class BuildUtils {
        +get_solar_sources_from_compile_output(config: Config, output: ProjectCompileOutput, target_paths: Option~PathBuf[]~, ignored_paths: Option~PathBuf[]~) Result~SolcVersionedInput~
        +configure_pcx_from_compile_output(pcx: PcxConfig, config: Config, output: ProjectCompileOutput, target_paths: Option~PathBuf[]~) Result~()~
    }

    class LintArgs {
        +execute() Result~()~
        -ignored: Vec~PathBuf~
    }

    class BuildArgs {
        +execute() Result~()~
    }

    class ProjectCompiler {
        +new() ProjectCompiler
        +files(files: Vec~PathBuf~) ProjectCompiler
        +compile(project: Project) ProjectCompileOutput
    }

    class ProjectCompileOutput {
        +graph() DependencyGraph
    }

    class DependencyGraph {
        +imports(path: Path) Path[]
    }

    class SolcVersionedInput {
        +input: SolcInput
    }

    class SolcInput {
        +sources: HashMap~PathBuf, SourceUnit~
    }

    LintArgs --> BuildUtils : uses get_solar_sources_from_compile_output
    BuildArgs --> BuildUtils : uses get_solar_sources_from_compile_output
    BuildUtils --> ProjectCompileOutput : reads imports via graph()
    ProjectCompileOutput --> DependencyGraph : returns
    SolcVersionedInput --> SolcInput : contains
Loading

File-Level Changes

Change Details Files
Remove unused helper methods and dead APIs to simplify public surfaces in several crates.
  • Delete SessionSource::clear_global and clear_contract since they are unused
  • Remove to_script_source constructor from SessionSource which is no longer referenced
  • Drop get_benchmark_versions and setup_benchmark_repos helpers from benches library
  • Remove get_cached_entry_by_name helper from CLI compiler utilities
  • Delete from_int_or_hex_opt deserializer from serde helpers
  • Remove ContractsByArtifact::find_abi_by_name_or_identifier helper
  • Drop EvmArgs::ensure_fork_url helper as unused
  • Remove Wallets::add_private_key wrapper in cheatcodes
crates/chisel/src/source.rs
benches/src/lib.rs
crates/cli/src/utils/cmd.rs
crates/common/src/serde_helpers.rs
crates/common/src/contracts.rs
crates/cli/src/opts/evm.rs
crates/cheatcodes/src/script.rs
Extend Solar source extraction to support ignored paths and wire it into build/lint commands.
  • Add ignored_paths parameter and is_ignored helper to get_solar_sources_from_compile_output
  • Skip imports that are in the ignored set when traversing the compile graph
  • Update configure_pcx_from_compile_output to pass a None ignored list
  • Update forge lint and build commands to call get_solar_sources_from_compile_output with the new parameter, providing ignored paths for lint and None for build
crates/cli/src/opts/build/utils.rs
crates/forge/src/cmd/lint.rs
crates/forge/src/cmd/build.rs
Deduplicate git submodule status handling by reusing has_missing_dependencies in submodules_uninitialized.
  • Change submodules_uninitialized to delegate to has_missing_dependencies with an empty iterator instead of shelling out to git submodule status directly
  • Add comment documenting intent to keep behavior consistent and avoid duplicate "-prefix" parsing logic
crates/cli/src/utils/mod.rs
Update cargo-deny configuration to track current advisories.
  • Replace ignored advisory RUSTSEC-2025-0137 with new advisories RUSTSEC-2025-0141 and RUSTSEC-2026-0002 along with rationale comments
deny.toml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Originally posted by @sourcery-ai[bot] in #317 (comment)

Metadata

Metadata

Assignees

Labels

P-highT-bugdependenciesPull requests that update a dependency filedocumentationImprovements or additions to documentationduplicateThis issue or pull request already existsenhancementNew feature or requestgithub_actionsPull requests that update GitHub Actions codegood first issueGood for newcomershelp wantedExtra attention is neededinvalidThis doesn't seem rightquestionFurther information is requestedrustPull requests that update rust code

Projects

Status

Backlog

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions