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

Remove the unspecced, "legacy" account validity endpoints #15271

Open
matrixbot opened this issue Dec 21, 2023 · 0 comments
Open

Remove the unspecced, "legacy" account validity endpoints #15271

matrixbot opened this issue Dec 21, 2023 · 0 comments

Comments

@matrixbot
Copy link
Collaborator

matrixbot commented Dec 21, 2023

This issue has been migrated from #15271.


We have an undocumented and unspecced Account Validity feature currently implemented in Synapse. This was originally written for DINUM. Since then, all of the functionality has been moved into the module API (matrix-org/synapse#9884), and can be implemented by modules. https://github.com/matrix-org/synapse-email-account-validity is the only known implementation of this API.

Synapse still has an implementation of account validity however, gated behind an undocumented account_validity config option. Completely removing the account validity feature out of Synapse's main codebase is not what this issue is about though.

In the original implementation of account validity (https://github.com/matrix-org/synapse/pull/5047/files#diff-6fc5658389633ef773a5c9ed669e5273eecff1c01311d7ac2c0721119a9ad21b, https://github.com/matrix-org/synapse/pull/5073/files#diff-6fc5658389633ef773a5c9ed669e5273eecff1c01311d7ac2c0721119a9ad21b), the following endpoints were registered:

plus one Admin API endpoint:

In the effort to move towards a module in April 2021, account validity module API callbacks were created which were tied to these "legacy" endpoints. If one of the legacy endpoints were called, then these callbacks would fire.

https://github.com/matrix-org/synapse/blob/a00462dd9927558532b030593f8914ade53b7214/synapse/handlers/account_validity.py#L36-L40

At the same time, modules were also given the ability to register their own endpoints under /_synapse/client/, which is what synapse-email-account-validity does does. Client implementations were encouraged to move to these /_synapse/client/email_account_validity/... endpoints instead.

https://github.com/matrix-org/synapse-email-account-validity still implements these legacy callbacks though: in case a client still uses them, or a user clicks on an email still containing an old GET /_matrix/client/v3/account_validity/renew link.

However, it has been sufficiently long since matrix-org/synapse#9884 (April 2021), that I think we can remove the legacy endpoints and module API callbacks. The legacy module API callbacks are also not documented, so it's unlikely their usage has spread much.

I will ask DINUM if they are still using the unspecced /_matrix/client/... endpoints in any form. According to @giomfo, DINUM are not currently using the feature at all, but plan to again in the future. While Tchap clients have not yet been updated to point to the new endpoint, they're just going to use a proxy to rewrite the request path to ensure clients switch immediately.

Therefore I suggest we just rip out the "legacy" endpoints and module API callbacks without a deprecation period.

@matrixbot matrixbot changed the title Dummy issue Remove the unspecced, "legacy" account validity endpoints Dec 21, 2023
@matrixbot matrixbot reopened this Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant