Ensure concurrency safety across when downloading compilers for multiple hardhat projects #3818
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
Introduce a new wrapper around the compiler downloader that ensures multiple downloader calls within a transaction are guarenteed to execute sequentially. This fixes a concurrency issue that arises from the separation of the `isCompilerDownloaded` and `downloadCompiler` calls, where the previous call to `downloadCompiler` was safe, but `isCompilerDownloaded` was not. By allowing the composition of calls via `transaction`, and only exposing the underlying downloader via the `transaction` method, we can expose a much safer api surface for manging the downloads of multiple compilers.
🦋 Changeset detectedLatest commit: 63f5bd2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
HenryNguyen5
changed the title
|
@fvictorio Friendly ping on this as our CI pipelines are pretty flaky when we cache bust the compilers. LMK if you need anything else from me to expedite this! |
|
The issue has been resolved in this PR |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Introduces a new wrapper around the compiler downloader that ensures multiple downloader calls within a transaction are guaranteed to execute sequentially.
This fixes a concurrency issue that arises from the separation of the
isCompilerDownloadedanddownloadCompilercalls, where the previous call todownloadCompilerwas safe, butisCompilerDownloadedwas not.By allowing the composition of calls via
transaction, and only exposing the underlying downloader via thetransactionmethod, we can expose a much safer API surface for managing the downloads of multiple compilers.This also has the nice side effect of downloading the same compiler once and only once. Before this bug fix, we'd be seeing multiple re-downloads of the same compiler within our project, https://github.com/smartcontractkit/chainlink
I ended up creating a wrapper class rather than adding this functionality to the existing compiler class to preserve the current interface that it adheres to, so we can keep using the same interfaces for future compiler implementations without having to think about concurrency handling at the same time.