Reinstate tracing instrumentation on ReadOnlyDevice::encrypt
#2873
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
Until #2862, `GroupSessionManager::encrypt_session_for` called `Device::encrypt` (via `Device::maybe_encrypt_room_key`. `Device::encrypt` is a thin wrapper for `ReadOnlyDevice::encrypt`, but it also has an `instrument` annotation. #2862 short-cuts `Device::encrypt` and calls `ReadOnlyDevice::encrypt` directly: that was functionally fine but of course means that we no longer benefit from the `instrument` annotation. This PR rectifies the situation by pushing the annotation down to `ReadOnlyDevice::encrypt`.
poljar
reviewed
Nov 22, 2023
| /// | ||
| /// # Arguments | ||
| /// | ||
| /// * `event_type` - The type of the event that should be encrypted. |
There was a problem hiding this comment.
This method has an additional argument.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2873 +/- ##
=======================================
Coverage 82.46% 82.46%
=======================================
Files 211 211
Lines 21639 21639
=======================================
Hits 17844 17844
Misses 3795 3795 ☔ View full report in Codecov by Sentry. |
poljar
approved these changes
Nov 22, 2023
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.
Until #2862,
GroupSessionManager::encrypt_session_forcalledDevice::encrypt(viaDevice::maybe_encrypt_room_key.Device::encryptis a thin wrapper forReadOnlyDevice::encrypt, but it also has aninstrumentannotation.#2862 short-cuts
Device::encryptand callsReadOnlyDevice::encryptdirectly: that was functionally fine but of course means that we no longer benefit from theinstrumentannotation.This PR rectifies the situation by pushing the annotation down to
ReadOnlyDevice::encrypt. It also adds some documentation for that function, since we are using it in more places now.(Longer-term, I think we should probably aim to get rid of
Device::encryptaltogether, but that's a refactor I don't want to take on today.)