Files
bare/docs/decisions/067-version-in-sidebar-foot.md
T

5.4 KiB
Raw Blame History

ADR-067: Версия и время коммита в подвале сайдбара

Уточнён ADR-079: кнопка «ты: @nick» стала локальной пиктограммой профиля с @nick; версия осталась отдельной строкой рядом.

Доводит до интерфейса ADR-074: сервер отдаёт version и commitAt, а где их показывать, там не решено.

Контекст

GET /api/config называет работающую версию и время коммита (ADR-074). Клиент читает конфигурацию при запуске и так — ради kdfIterations и vapidPublicKey. Показать их негде: docs/ui.md такого элемента не знает.

Спрашивают об этом при каждой поломке: обновилось ли то, что человек видит. В установленном на «Домой» приложении вопрос острее — там нет ни адресной строки, ни консоли, и другого способа узнать версию у человека нет.

Решение

  • Версия стоит в подвале сайдбара, рядом с «ты: @nick»: это единственное постоянное место интерфейса, где уже написано, кто и где мы.
  • Текст — версия · дд.мм чч:мм, время коммита в местной зоне. Год не показывается: вопрос «что сейчас работает», а не летопись. Времени нет (commitAt = 0) — остаётся одна версия; конфигурации нет вовсе — строки нет.
  • Цвет stone, размер подписи 11 px, без рамок и фона. Акцентом версия не бывает: mark — один смысловой элемент на экран (ADR-024), и это непрочитанные, а не служебная строка.
  • Не кнопка и не ссылка: нажимать в ней нечего. Стоит рядом с кнопкой «ты: @nick», а не внутри неё — иначе экранный диктор зачитывал бы хеш как часть названия кнопки. Выделяется, в отличие от остального сайдбара (ADR-075): на iPhone скопировать её иначе нечем.
  • В сайдбаре 224 px строка и версия рядом не помещаются никогда: версия · дд.мм чч:мм — это 179 px при внутренней ширине 184, а «ты: @nick» просит ещё восемьдесят с лишним. Значит, на десктопе версия всегда занимает вторую строку и стоит справа; на мобильном, где сайдбар во всю ширину, обе стоят в одной строке. Ник, которому не хватило и целой строки, обрезается многоточием; версия — никогда: половина хеша бесполезна.
  • Текст ради одной строки не режется: вариант «в подвале ревизия, время в title» отклонён — title не показывается на телефоне, а телефон и есть место, ради которого строка заведена.

Следствия

  • Версия видна с любого экрана, где виден сайдбар, и на мобильном — в списке чатов.
  • Разговор о поломке начинается с версии, а не с «попробуйте обновиться».
  • Подвал сайдбара стал двухстрочным и вырос с 47 px мока до 76. Это принятое отклонение от docs/identity/screens.html, блок 2a: там подвал — одна строка «ты: @nick» без версии и без 44 px цели нажатия. Мок остаётся снимком айдентики на момент ADR-024 и за интерфейсом не идёт: в нём нет и строки + новый чат, и баннера установки.
  • Названа версия сервера, а не оболочки, которую исполняет браузер: version приезжает с GET /api/config, а страница и её модули — из кэша service worker. После релиза первое открытие показывает новую версию под старой оболочкой; расходятся они до применения обновления (ADR-068), а с недописанным сообщением в поле — сколь угодно долго. Показывать рядом версию кэша — отдельное решение, здесь его нет.
  • Записано в docs/ui.md, «Список чатов (сайдбар)». Отдельного запроса ради этого нет: поля приезжают с конфигурацией (ADR-074).