fix(utd_hook): Fix regression causing retry to report false late decrypt #4252
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4252 +/- ##
==========================================
- Coverage 84.95% 84.91% -0.04%
==========================================
Files 274 274
Lines 29768 29772 +4
==========================================
- Hits 25288 25282 -6
- Misses 4480 4490 +10 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
|
According to @BillCarsonFr: this bug should have caused the UTD rate reported to Posthog to (incorrectly) drop significantly. We haven't actually observed that -- possibly because the relevant change |
Actually there is no grace period on rust sdk UTD reporting like on other platform; On other platforms, an event decrypted in less than 4s is graced out and not reported. It is not the case in rust sdk, so the UTD would be reported immediatly but as a temporary UTD (with |
Added a regression test |
| match olm_machine | ||
| .try_decrypt_room_event(raw.cast_ref(), room_id, &decryption_settings) | ||
| .await? | ||
| { | ||
| RoomEventDecryptionResult::Decrypted(decrypted) => Ok(decrypted.into()), | ||
| RoomEventDecryptionResult::UnableToDecrypt(utd_info) => { | ||
| Ok(TimelineEvent::new_utd_event(raw.clone(), utd_info)) | ||
| } | ||
| } |
There was a problem hiding this comment.
Why is this change needed, out of curiosity? This is for the test timeline; is it operating that differently from the non-test timeline?
There was a problem hiding this comment.
It's needed to make the regression test ~"fails correctly".
If not the test never detects the behavior change because it is using the mock Decryptor that continues to fail with an error when there is an UTD instead of return a OK UTDEvent type.
The underlying problem is that we use a big catch everything Error for all possible errors of the SDK. And here the change that created the regression should have resulted in a change of signature of the trait. It is not anymore Result<, ALLERRORS> but a Result <,SubsetOfErrors>?
There was a problem hiding this comment.
Alright, I'm slightly scared that we might be reproducing an error only in testing conditions, but this code is likely going away at some point…
|
(Great catch and thanks for fixing, btw) |
| match olm_machine | ||
| .try_decrypt_room_event(raw.cast_ref(), room_id, &decryption_settings) | ||
| .await? | ||
| { | ||
| RoomEventDecryptionResult::Decrypted(decrypted) => Ok(decrypted.into()), | ||
| RoomEventDecryptionResult::UnableToDecrypt(utd_info) => { | ||
| Ok(TimelineEvent::new_utd_event(raw.clone(), utd_info)) | ||
| } | ||
| } |
There was a problem hiding this comment.
Alright, I'm slightly scared that we might be reproducing an error only in testing conditions, but this code is likely going away at some point…
There has been a recent change on
Decryptor#decrypt_event_implcausing the function to return an TimelineEvent of kind unable to decrypt instead of failing with an error.The
late_decryptdetection code was not changed, causing any retry to mark UTDs as late decrypt.Signed-off-by: