feat: Introduce EncryptionState
#4777
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
Hywan
force-pushed
the
feat-base-encryption-state
branch
from
8019667 to
69e4edd
Compare
Hywan
force-pushed
the
feat-base-encryption-state
branch
2 times, most recently
from
c02659c to
cf7e678
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4777 +/- ##
==========================================
- Coverage 86.38% 86.37% -0.02%
==========================================
Files 291 291
Lines 34293 34303 +10
==========================================
+ Hits 29624 29629 +5
- Misses 4669 4674 +5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
poljar
approved these changes
Mar 11, 2025
Comment on lines
+1571
to
+1577
| if !self.encryption_state_synced { | ||
| EncryptionState::Unknown | ||
| } else if self.base_info.encryption.is_some() { | ||
| EncryptionState::Encrypted | ||
| } else { | ||
| EncryptionState::NotEncrypted | ||
| } |
There was a problem hiding this comment.
It would probably be nice to replace encryption_state_synced and base_info.encryptionwith EncryptionState where Encrypted keeps the m.room.encryption content as associated data.
But that's probably something for a different PR and might not even be worth the trouble.
There was a problem hiding this comment.
Talked about that in a meeting and agreed to address that in another PR.
Hywan
force-pushed
the
feat-base-encryption-state
branch
3 times, most recently
from
7460970 to
45ae5f5
Compare
This patch introduces the new `EncryptionState` to represent the 3 possible states: `Encrypted`, `NotEncrypted` or `Unknown`. All the `is_encrypted` methods have been replaced by `encryption_state`. The most noticable change is in `matrix_sdk::Room` where `async fn is_encrypted(&self) -> Result<bool>` has been replaced by `fn fn encryption_state(&self) -> EncryptionState`. However, a new `async fn latest_encryption_state(&self) -> Result<EncryptionState>` method “restores” the previous behaviour by calling `request_encryption_state` if necessary. The idea is that the caller is now responsible to call `request_encryption_state` if desired, or use `latest_encryption_state` to automate the call if necessary. `encryption_state` is now non-async and infallible everywhere. `matrix-sdk-ffi` has been updated but no methods have been added for the moment.
Hywan
force-pushed
the
feat-base-encryption-state
branch
2 times, most recently
from
d007455 to
161eb8d
Compare
Hywan
force-pushed
the
feat-base-encryption-state
branch
from
161eb8d to
3c6ae5a
Compare
This was referenced Mar 11, 2025
Closed
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.
This patch introduces the new
EncryptionStateto represent the 3possible states:
Encrypted,NotEncryptedorUnknown. All theis_encryptedmethods have been replaced byencryption_state.The most noticable change is in
matrix_sdk::Roomwhereasync fn is_encrypted(&self) -> Result<bool>has been replaced byfn fn encryption_state(&self) -> EncryptionState. However, a newasync fn latest_encryption_state(&self) -> Result<EncryptionState>method“restores” the previous behaviour by calling
request_encryption_stateif necessary.
The idea is that the caller is now responsible to call
request_encryption_stateif desired, or uselatest_encryption_stateto automate the call if necessary.
encryption_stateis now non-asyncand infallible everywhere.
matrix-sdk-ffihas been updated but no methods have been added forthe moment.
Room::is_encryptedis now async #4756