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

Document supported matrix versions, and introduce compatibility modes for older ones #5115

Open
5 tasks
ShadowJonathan opened this issue Nov 10, 2021 · 2 comments
Labels
T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements X-Needs-Info This issue is blocked pending further information from the reporter

Comments

@ShadowJonathan
Copy link
Contributor

ShadowJonathan commented Nov 10, 2021

Your use case

What would you like to do?

  • Document the matrix versions supported ("Compatible with matrix vX" badges/shields#7245)
    • Document this within the client
  • Introduce compatibility probing (call /versions)
    • Show user-facing error when server and client supported versions mismatch
      ("Cannot communicate with server, your client supports versions v1.1 and v1.2, but the server only supports v1.0")
  • Introduce compatibility modes based off of the /versions response for older versions

Why would you like to do it?

Matrix now has a quarterly release cadence, it'd be nice to make element compatible with older matrix versions in a easily understandable way. (So that users may check compatibility for themselves)

Have you considered any alternatives?

No response

Additional context

No response

@ShadowJonathan ShadowJonathan added the T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements label Nov 10, 2021
@pixlwave pixlwave added the X-Needs-Info This issue is blocked pending further information from the reporter label Nov 23, 2021
@pixlwave
Copy link
Member

pixlwave commented Nov 23, 2021

Hi @ShadowJonathan, I'm not really sure what actions we can take from this other than adding a note to the README that we currently support Matrix v1.0. We already have an issue for Matrix 1.1 #5005 (which simply links to the web one for now), with detailed information on the changes to be made.

@ShadowJonathan
Copy link
Contributor Author

@pixlwave sorry, this would actually be more an SDK issue, and it's a request for future aspiration, in the following way;

  • introduce compatibility behaviour when dealing with older servers, such as disabling certain routes or functionality until that server denotes it supports it (i.e. with a new version)
  • Enumerate and document when certain features or API calls are first introduced, or are changed according to matrix compatibility, so that above can apply.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements X-Needs-Info This issue is blocked pending further information from the reporter
Projects
None yet
Development

No branches or pull requests

2 participants