Remove deprecated methods and attributes of MatrixClient
#4659
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
florianduros
changed the title
MatrixClientMatrixClient
florianduros
force-pushed
the
florianduros/rip-out-legacy-crypto/clean-up-matrixclient
branch
from
5140262 to
808f7ee
Compare
- `Embedded.spec.ts`: casting since `encryptAndSendToDevices` is removed from `MatrixClient`. - `room.spec.ts`: remove deprecated usage of `MatrixClient.crypto` - `matrix-client.spec.ts` & `matrix-client-methods.spec.ts`: remove calls of deprecated methods of `MatrixClient`
florianduros
force-pushed
the
florianduros/rip-out-legacy-crypto/clean-up-matrixclient
branch
from
80891ce to
0b31afd
Compare
florianduros
force-pushed
the
florianduros/rip-out-legacy-crypto/clean-up-matrixclient
branch
from
65e8795 to
89ac700
Compare
florianduros
requested review from
uhoreg,
richvdh and
dbkr
and removed request for
a team
florianduros
commented
Jan 27, 2025
dbkr
approved these changes
Jan 28, 2025
|
Related: element-hq/element-web#17488 |
richvdh
reviewed
Jan 28, 2025
Comment on lines
-2132
to
-2139
| * Fetches the latest capabilities from the homeserver, ignoring any cached | ||
| * versions. The newly returned version is cached. | ||
| * | ||
| * @returns A promise which resolves to the capabilities of the homeserver | ||
| */ | ||
| public fetchCapabilities(): Promise<Capabilities> { | ||
| return this.serverCapabilitiesService.fetchCapabilities(); | ||
| } |
There was a problem hiding this comment.
It's a shame that git's diff algorithm makes such a mess of this.
If you look at it from the commandline with git show --patience, you get a much nicer diff, showing that fetchCapabilities, initRustCrypto and secretStorage are unchanged. I think the problem is basically that the change is so large that we've exhausted the standard diff algorithm's ability to look ahead to match up lines.
For future reference, it might be nice to break down massive removals like this into separate commits, so that they can be reviewed via the github UI.
Comment on lines
-2517
to
-2536
| /** | ||
| * Set the global override for whether the client should ever send encrypted | ||
| * messages to unverified devices. This provides the default for rooms which | ||
| * do not specify a value. | ||
| * | ||
| * @param value - whether to blacklist all unverified devices by default | ||
| * | ||
| * @deprecated Prefer direct access to {@link CryptoApi.globalBlacklistUnverifiedDevices}: | ||
| * | ||
| * ```javascript | ||
| * client.getCrypto().globalBlacklistUnverifiedDevices = value; | ||
| * ``` | ||
| */ | ||
| public setGlobalBlacklistUnverifiedDevices(value: boolean): boolean { | ||
| if (!this.cryptoBackend) { | ||
| throw new Error("End-to-end encryption disabled"); | ||
| } | ||
| this.cryptoBackend.globalBlacklistUnverifiedDevices = value; | ||
| return value; | ||
| } |
There was a problem hiding this comment.
It might be worth calling out, for the record, that some of the removed methods in MatrixClient do actually work in Rust Crypto.
It's definitely a good time to clean these out, so not suggesting we change anything; just making a note.
Comment on lines
-1038
to
-1039
| // the prepare request should complete successfully. | ||
| await p; |
There was a problem hiding this comment.
No it isn't, prepareToEncrypt is not asynchronous.
`ICreateClientOpts.deviceToImport` was used in the legacy cryto. The rust crypto doesn't support to import devices in this way.
`globalErrorOnUnknownDevices` is not used in the rust-crypto. The API is marked as unstable, we can remove it.
florianduros
force-pushed
the
florianduros/rip-out-legacy-crypto/clean-up-matrixclient
branch
from
04363e4 to
c5d6e35
Compare
florianduros
merged commit 89cec0a
into
florianduros/rip-out-legacy-crypto/remove-legacy-crypto
23 of 27 checks passed
florianduros
deleted the
florianduros/rip-out-legacy-crypto/clean-up-matrixclient
branch
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.
Task element-hq/element-web#26922
Part of #4653
This PR removes the deprecated methods and attributes of the the
MatrixClient. The legacy crypto relies on using deprecated methods of theMatrixClientand theMatrixClientis also using methods from the legacy crypto.In order to not have a gigantic PR where both the deprecated methods of the
MatrixClientand the legacy crypto are removed, only theMatrixClientis changed here (with the related tests). Accordingly, the legacy crypto tests and lint are in failure.Since the PR will be merged in
florianduros/rip-out-legacy-crypto/remove-legacy-cryptoand not indevelop, we can accept that the lint and the legacy crypto tests are in failure in the feature branch until the legacy crypto is removed.The unit (not related to legacy crypto) and integ tests are updated to pass. However the cleaning of theses (remove
isNewBackendOnly, run on eachbackendetc) tests will be done in a dedicated PR.