feat(backend): add support for arbitrary provider requests with AnyRequest #32
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
add in-memory provider test
dutterbutter
requested review from
DaniPopes,
mattsse and
klkvr
as code owners
dutterbutter
force-pushed
the
db/add-custom-request-backend
branch
from
4601be7 to
1647268
Compare
mattsse
approved these changes
Nov 27, 2024
Comment on lines
+812
to
+826
| pub fn do_any_request<T, F>(&mut self, fut: F) -> DatabaseResult<T> | ||
| where | ||
| F: Future<Output = Result<T, eyre::Report>> + Send + 'static, | ||
| T: fmt::Debug + Send + 'static, | ||
| { | ||
| self.blocking_mode.run(|| { | ||
| let (sender, rx) = oneshot_channel::<Result<T, eyre::Report>>(); | ||
| let req = BackendRequest::AnyRequest(Box::new(AnyRequestFuture { | ||
| sender, | ||
| future: Box::pin(fut), | ||
| })); | ||
| self.backend.unbounded_send(req)?; | ||
| rx.recv()?.map_err(|err| DatabaseError::AnyRequest(Arc::new(err))) | ||
| }) | ||
| } |
There was a problem hiding this comment.
the way this is implemented kinda acts as tokio::Handle::block_on but it sends the request to the async backend, I think this could be quite useful, especially if we extend this with caching functionality, because rn this does not persist cache the responses.
we can add this feature separately though
There was a problem hiding this comment.
Will follow-up accordingly.
Comment on lines
+80
to
+82
| trait WrappedAnyRequest: Unpin + Send + fmt::Debug { | ||
| fn poll_inner(&mut self, cx: &mut Context<'_>) -> Poll<()>; | ||
| } |
There was a problem hiding this comment.
I see, this is basically a helper, alternatively we could use BoxFuture, but this would require a manual debug impl on the request enum, so this seems fine
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.
Motivation
SharedBackendto support diverse use casesfoundry-fork-db. For example,foundry-zksyncis currently using a fork of this repo for its own needs, specifically implementsZkSyncMiddlewareto facilitate bytecode retrieval viazks_getBytecodeByHash. These changes will eliminate the necessity of that fork while also serving other parties needs outside offoundry-zksync.Solution
src/backend.rs: Added theAnyRequestFuturestruct and implemented theWrappedAnyRequesttrait to handle arbitrary requests.src/backend.rs: Updated theProviderRequestandBackendRequestenums to include theAnyRequestvariant.src/backend.rs: Modified theSharedBackendstruct to include thedo_any_requestmethod for executing arbitrary requests.src/error.rs: Added theAnyRequestvariant to theDatabaseErrorenum for error handling.shared_backend_any_requestfor verifying the arbitrary request handling feature. This test spins up an in-memory HTTP server to simulate requests.PR Checklist