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

Check bounds & warn users re various supported versions (platform/python/server/client) #1436

Open
4 tasks
neiljp opened this issue Nov 6, 2023 · 1 comment
Labels
area: infrastructure Project infrastructure area: popup: about area: startup enhancement New feature or request further discussion required Discuss this on #zulip-terminal on chat.zulip.org TRACKING

Comments

@neiljp
Copy link
Collaborator

neiljp commented Nov 6, 2023

The current values of these are shown in the About popup at runtime:

  • Platform (Linux/MacOS/[Unsupported])
  • Python version/implementation (3.x, x=...; implementation=CPython, PyPy)
  • Zulip server version (and feature level - ZFL in code)
  • Zulip-terminal version

It would useful to warn users if these are outside of the 'supported' bounds, in various locations:

  • upon startup on the console?
  • upon startup in some kind of popup if very important?
  • upon startup in the footer if less important?
  • highlighted in the About popup?

'Supported' is currently defined via documentation, based on testing in CI (platform, python) and constraints on installs (python version) - and in the past we aimed to define a minimum server via a version in version.py (which some tests use). We can improve the use of these, and use them to warn or error in case of certain issues.

In addition to static values, certain checks require runtime connections:

  • any specified/connected server (version); checking from this data shouldn't require prompting the user
  • the latest cloud/self-hosted server release & latest zulip-terminal release; this should be an option for background checks, or require active selection by the user

Prompts could take various forms, and inspiration from those used in the web app or mobile would be useful where applicable. Examples could include

  • warnings
    • unsupported platform/python/... - but may still work! please report success!
    • server is definitely not supported; use at your own risk (error?)
    • features missing (list known ones?)
  • errors
    • a version is known to be insecure, or very out of date
  • prompts to upgrade, and how/where (securely)

Please discuss this in #zulip-terminal before proceeding, as this issue may need refinement first

@neiljp neiljp added enhancement New feature or request further discussion required Discuss this on #zulip-terminal on chat.zulip.org area: infrastructure Project infrastructure TRACKING labels Nov 6, 2023
@neiljp
Copy link
Collaborator Author

neiljp commented Apr 22, 2024

One element of this is #704, which is an earlier version of this idea focused only on server version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: infrastructure Project infrastructure area: popup: about area: startup enhancement New feature or request further discussion required Discuss this on #zulip-terminal on chat.zulip.org TRACKING
Projects
None yet
Development

No branches or pull requests

1 participant