add(scan): Implement DeleteKeys ScanService request
#8217
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
arya2
added
C-feature
arya2
added
the
A-concurrency
oxarbitrage
previously approved these changes
Jan 31, 2024
oxarbitrage
approved these changes
Jan 31, 2024
upbqdn
reviewed
Jan 31, 2024
Comment on lines
+44
to
+59
| let response_fut = scan_service | ||
| .ready() | ||
| .await | ||
| .map_err(|err| eyre!(err))? | ||
| .call(Request::DeleteKeys(vec![zec_pages_sapling_efvk.clone()])); | ||
|
|
||
| let expected_keys = vec![zec_pages_sapling_efvk.clone()]; | ||
| let cmd_handler_fut = tokio::task::spawn_blocking(move || { | ||
| let Ok(ScanTaskCommand::RemoveKeys { done_tx, keys }) = cmd_receiver.recv() else { | ||
| panic!("should successfully receive RemoveKeys message"); | ||
| }; | ||
|
|
||
| assert_eq!(keys, expected_keys, "keys should match the request keys"); | ||
|
|
||
| done_tx.send(()).expect("send should succeed"); | ||
| }); |
There was a problem hiding this comment.
Optional Suggestion
This looks great. I wonder if we could use mocked services from zebra-test, for example: https://github.com/ZcashFoundation/zebra/blob/main/zebra-test/src/mock_service.rs and https://github.com/ZcashFoundation/zebra/blob/main/zebra-test/src/transcript.rs. I haven't used them yet, but I'll look into it.
| ) -> JoinHandle<Result<(), Report>> { | ||
| scan::spawn_init(config, network, state, chain_tip_change) | ||
| /// Sends a message to the scan task to remove the provided viewing keys. | ||
| pub fn remove_keys( |
There was a problem hiding this comment.
Optional Suggestion
I think it would be good to place this function into a different file since the filename is init.rs, but let's do that in a different PR?
| // TODO: Replace with Arc::unwrap_or_clone() when it stabilises: | ||
| // https://github.com/rust-lang/rust/issues/93610 | ||
| let mut updated_parsed_keys = | ||
| Arc::try_unwrap(parsed_keys).unwrap_or_else(|arc| (*arc).clone()); |
There was a problem hiding this comment.
Optional Suggestion
Arc::get_mut might also have been an option here.
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
This PR implements the
DeleteKeysrequest forScanServiceto:Closes #8204.
PR Author Checklist
Check before marking the PR as ready for review:
For significant changes:
If a checkbox isn't relevant to the PR, mark it as done.
Solution
scan::start()for the scan task channel receiverScanTask::remove_keys()method for sending aRemoveKeysmessageScanTask::process_msgs()and calls it from the loop inscan::start()delete_sapling_keys()method toStorageremove_keys()anddelete_sapling_keys()from theScanServicematch arm forRequest::DeleteKeysTesting
Storage::delete_sapling_results()method deletes all results for a provided keyScanTaskto remove the keys and that it deletes the results before respondingReview
Anyone can review.
Reviewer Checklist
Check before approving the PR:
PR blockers can be dealt with in new tickets or PRs.
And check the PR Author checklist is complete.
Follow Up Work
ScanTask::process_msgs()