-
-
Notifications
You must be signed in to change notification settings - Fork 604
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove MatrixClient.initLegacyCrypto
#4620
base: develop
Are you sure you want to change the base?
Remove MatrixClient.initLegacyCrypto
#4620
Conversation
MatrixClient.initLegacyCrypto
65e817c
to
8dcf73c
Compare
8dcf73c
to
ba1ca5c
Compare
I imagine that this will have very bad results on our coverage, as you are deleting the tests for code which is not yet deleted. Will this cause any breaches of contract? Do we still have any contracts to uphold coverage beyond a certain level? SonarCloud is only not complaining as it only looks at new code, of which there is none. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO this should remove all related exported entrypoints, all deprecated & now-unused symbols. Otherwise we will need a 2nd follow-up Breaking Change release to clean up the tech debt to maintain the contract around semver.
.e.g. https://matrix-org.github.io/matrix-js-sdk/enums/matrix.CryptoEvent.html and most things in the crypto dir.
…-initLegacyCrypto # Conflicts: # spec/integ/matrix-client-syncing.spec.ts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks broadly good to me, but I would rather see #4622 / #4624 land first.
I don't agree that we should rip out all of the legacy crypto code at once (and also, ftr, don't agree that removing things in the crypto
directory would necessarily result in a major version bump, though it's true that updating CryptoEvent
would), but I guess we should discuss that elsewhere.
…-initLegacyCrypto # Conflicts: # spec/integ/sliding-sync-sdk.spec.ts
Checklist
public
/exported
symbols have accurate TSDoc documentation.Task element-hq/element-web#26922
First step to delete definitively the legacy crypto stack. We deprecated during the past months the legacy crypto and now it is time to begin to delete it.
The removal will be in multiple phases and this PR has the unique goal to remove
MatrixClient.initLegacyCrypto
, the tests and documentation with direct references.The legacy tests, integration tests, code will be removed or cleaned in other PRs.