Skip to content
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

Deprecate MatrixClient.login and replace with loginRequest #4632

Merged
merged 1 commit into from
Jan 20, 2025

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Jan 20, 2025

MatrixClient.login has some very unintuitive behaviour where it
stashes the access token, but not the device id, refresh token, etc etc, which
led people to imagine that they had a functional MatrixClient when they
didn't. In practice, you have to create a new MatrixClient given the LoginResponse.

As the first step for sorting this out, this deprecates the broken method and
replaces it with one that has sensible behaviour.

Related to: #4502

`MatrixClient.login` has some very unintuitive behaviour where it
stashes the access token, but not the device id, refresh token, etc etc, which
led people to imagine that they had a functional `MatrixClient` when they
didn't. In practice, you have to create a *new* `MatrixClient` given the `LoginResponse`.

As the first step for sorting this out, this deprecates the broken method and
replaces it with one that has sensible behaviour.
Copy link
Member

@t3chguy t3chguy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo coverage

@richvdh richvdh added this pull request to the merge queue Jan 20, 2025
Merged via the queue into develop with commit ce60162 Jan 20, 2025
35 checks passed
@richvdh richvdh deleted the rav/deprecate_login branch January 20, 2025 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants