feat!: v0.4.0 rewrite #202
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0.4.0 rewrite, more modular more awesome thanks to @beeb
* docs(core): document `auth` and `config` modules * ci: add doctests * refactor(core): move integrity checksum type to utils * docs(core): download module * docs(core): download module * docs(core): add documentation * docs(core): add docs * docs(core): typo * docs(core): rephrase * docs(core): install * docs(core): typo
* docs(core): document `auth` and `config` modules * ci: add doctests * refactor(core): move integrity checksum type to utils * docs(core): download module * docs(core): download module * docs(core): add documentation * docs(core): add docs * docs(core): typo * docs(core): rephrase * docs(core): install * docs(core): typo * docs(core): install mod * docs(core): lock module * docs(core): various * refactor(commands): move push zip file path logging to commands crate * docs(core): push mod * fix(core): missing import * docs(core): registry * docs(core): add missing item
* docs(core): remappings * docs(core): update * docs(core): utils
* test(commands): init integration tests
* refactor(commands)!: rename `Subcommands` to `Command` * test(commands): add integration tests for install command * refactor(core)!: zip download path clarification The zip is now downloaded inside the folder indicated by the argument to `download_file` and the filename can be chosen by the caller.
* test(commands): add integration tests for uninstall * test(commands): add integration test for config in foundry file * test(commands): add test for remappings in foundry file * test(commands): add uninstall test with foundry config
* feat(core): improve remappings matching Existing remappings can now be kept even during an update which changes the version string of the dependency folder. * fix(core): remappings rewriting on windows
* feat(core): improve remappings matching Existing remappings can now be kept even during an update which changes the version string of the dependency folder. * fix(core): updating git dependencies Updating git dependencies which should follow a branch did not work because we check out a given commit. This has been fixed.
Signed-off-by: Valentin B. <[email protected]>
perf: lock-free synchronization, add rayon
* (Ehancement) Add Banner - Display banner with useful information * Update crates/cli/src/main.rs Signing off , since there is no action i need to perform Co-authored-by: Valentin B. <[email protected]> Signed-off-by: xyizko <[email protected]> --------- Signed-off-by: xyizko <[email protected]> Co-authored-by: Valentin B. <[email protected]>
* test(commands): integration tests for push * chore: remove file * test(commands): add integration tests * test(commands): add integration test * test(commands): add assert
This function should only attempt to match a version to a version requirement if both can be parsed Also added extra tests
The tests for the `push` command were changing the current directory which lead to race conditions when run with `cargo test`. `cargo-nextest` does not seem to suffer from this.
mario-eth
approved these changes
Oct 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Version 0.4.0 marks a big step in the evolution of the soldeer codebase and implements many new features and improvements compared to previous releases. Below are the main points.
New code structure
The codebase has been split into 3 crates to enable integration of the soldeer core logic and CLI commands with other applications.
soldeer-core: the core functionality of soldeer. Things like reading and writing config files, lock files, interacting with the registry API and more. At the moment, logging is gated behind aclifeature flag.soldeer-commands: high-levelclapcommands which can be used to implement a CLI tool. This is meant to be used byforgeand thesoldeerCLI.soldeer: this is the standalone soldeer CLI applicationIn the future, I would like to further reduce the coupling between the
soldeer-corecrate andcliclackUI library, so that logging can be made agnostic of the (T)UI, but still be integrated nicely with it.Version requirement specifiers
Dependencies were previously specified with at least a name and a version. Starting with this release, the version can be a version requirement specifier. The format follows the semver::VersionReq comparator specification, with the notable exception that the absence of an operator is considered to mean "exact" (similar to what solidity does).
Remappings format
In remappings, the default behavior is to include the version requirement string as a suffix to the left-hand side path. As an example, this enables the following:
Remappings customization is now also handled properly, meaning that the left-hand side part can be customized to anything, which won't get overwritten when commands are ran without the
--regenerate-remappingsoption. The right part can likewise be customized to include additional path segments after the dependency's directory. Examples:New progress and prompts UI
The UI now uses
cliclackto display progress and prompt the user for information. This is a significantly nicer experience than previously.Improved install command
The install command now avoids to perform useless work by checking already installed dependencies and skipping associated downloads. For git dependencies, most operations leverage available git commands to avoid unnecessary clones.
Each dependency is installed in parallel, with more pipelining and thus a shorter total install time even if all dependencies must be installed.
Improved update command
Previously the update command was not performing according to user expectations. Now, the command updates dependencies which satisfy these requirements:
5or^5.0.0or>=5.0.0) andbranchidentifier or no identifier (default branch)The lockfile stores the exact installed version so that installs are reproducible. When the update command is ran, the lockfile is updated with the new versions.
Improved init command
The init command is now smarter and does slightly more:
dependenciesdirforge-stddependencylibfolder.gitignore.New lockfile format
The new lockfile format has differentiated entries for Git vs HTTP dependencies, allowing for a more concise and explicit representation. For HTTP dependencies, the zip archive checksum is stored and checked upon downloading. If the hash is different, installation is aborted. Likewise, the unzipped dependency is hashed upon installation and checked to avoid re-installing an existing dependency.
New test suite
All tests have been rewritten to enable running them in parallel. All IO side effects are contained to special temporary folders thanks to
testdir. API mocking is performed withmockitoand environment variables are mocked withtemp-env.The new suite runs significantly faster than the old one and can be efficiently parallelized with
cargo-nextest, which is the recommended way to run them.All tests are now ran in CI on Linux, macOS and Windows.
Various fixes and performance improvements
Various bugfixes have been implemented during the refactor, either as a result of the change in architecture or because they showed up in unit/integration tests. Some functions have been refactored to improve performance and parallelism.
Closes #188
Closes #182
Closes #181
Closes #156
Closes #155
Closes #153
Closes #152
Closes #144
Closes #138
Closes #134
Closes #120
Closes #108
Closes #46