заведён реестр префиксов, правила канона перенумерованы
- идентификатор правила теперь `<ПРЕФИКС>-<номер>` вместо `R<номер>`: префикс уникален по всему канону, поэтому ссылка больше не требует пути к файлу и не зависит от того, на какой оси файл лежит - префикс выбирается под файл, а не выводится по формуле, и хранится в conventions/prefixes.toml вместе с выбывшими; номера сохранены один в один вместе с дырами
This commit is contained in:
+32
-31
@@ -1,4 +1,5 @@
|
||||
---
|
||||
prefix: GTIM
|
||||
extends: arch/time.md
|
||||
---
|
||||
|
||||
@@ -10,7 +11,7 @@ extends: arch/time.md
|
||||
|
||||
## Правила
|
||||
|
||||
### R1. «Сейчас» берётся у слоя хранилища
|
||||
### GTIM-1. «Сейчас» берётся у слоя хранилища
|
||||
|
||||
**ДОЛЖЕН.** Текущее время приходит из `store.Now()`, возвращающего
|
||||
`time.Now().UTC()`, а не из `time.Now()` по коду.
|
||||
@@ -24,28 +25,28 @@ extends: arch/time.md
|
||||
придётся превратить в переменную или поле, если однажды понадобится
|
||||
подменять часы, но само по себе оно подмены не даёт.
|
||||
|
||||
### R2. Форматирование и разбор — через `store.FormatTime` / `store.ParseTime`
|
||||
### GTIM-2. Форматирование и разбор — через `store.FormatTime` / `store.ParseTime`
|
||||
|
||||
**ДОЛЖЕН.** Пара функций поверх `time.RFC3339` — единственный способ
|
||||
получить строку времени и прочитать её обратно.
|
||||
|
||||
**Почему.** Layout, набранный по месту вызова, превращает формат хранения в
|
||||
свойство каждой отдельной строки кода. Фиксированная ширина (R4) и
|
||||
свойство каждой отдельной строки кода. Фиксированная ширина (GTIM-4) и
|
||||
взаимная обратимость записи и чтения держатся ровно до первого второго
|
||||
layout — а расхождение проявится не на записи, а при сравнении значений,
|
||||
записанных разными местами.
|
||||
|
||||
### R3. Прямой `time.Now()` запрещён линтером, список исключений исчерпывающий
|
||||
### GTIM-3. Прямой `time.Now()` запрещён линтером, список исключений исчерпывающий
|
||||
|
||||
**ДОЛЖЕН.** Запрет проверяется линтером (в Go — `forbidigo`); исключений
|
||||
ровно два, и оба прописаны явно:
|
||||
|
||||
| № | Исключение | Почему оно не покрывается R1 |
|
||||
| № | Исключение | Почему оно не покрывается GTIM-1 |
|
||||
|---|---|---|
|
||||
| R3.1 | сама точка `store.Now()` | внутри неё вызов `time.Now()` и происходит |
|
||||
| R3.2 | обёртка измерения длительности | приведение к UTC срезает монотонную составляющую (R10) |
|
||||
| GTIM-3.1 | сама точка `store.Now()` | внутри неё вызов `time.Now()` и происходит |
|
||||
| GTIM-3.2 | обёртка измерения длительности | приведение к UTC срезает монотонную составляющую (GTIM-10) |
|
||||
|
||||
**Почему.** R1 без механической проверки держится на внимании, а
|
||||
**Почему.** GTIM-1 без механической проверки держится на внимании, а
|
||||
`time.Now()` пишется рефлекторно — и в новом коде, и в мелкой правке;
|
||||
нарушение молчит до тех пор, пока процесс не окажется в не-UTC зоне.
|
||||
Исключения перечисляются исчерпывающе, потому что каждое из них — само по
|
||||
@@ -53,23 +54,23 @@ layout — а расхождение проявится не на записи,
|
||||
«починены» тем, кто увидит в них дефект, и конвенция начнёт противоречить
|
||||
сама себе.
|
||||
|
||||
### R13. Исключение регистрируется директивой на месте вызова, а не в конфиге линтера
|
||||
### GTIM-13. Исключение регистрируется директивой на месте вызова, а не в конфиге линтера
|
||||
|
||||
**ДОЛЖЕН.** Исключение из R3 оформляется как `//nolint:forbidigo // <причина>`
|
||||
на строке вызова; exclude-записи в конфигурации линтера для него не
|
||||
заводятся.
|
||||
**ДОЛЖЕН.** Исключение из GTIM-3 оформляется как
|
||||
`//nolint:forbidigo // <причина>` на строке вызова; exclude-записи в
|
||||
конфигурации линтера для него не заводятся.
|
||||
|
||||
**Почему.** Запись в конфиге — второй реестр тех же двух мест: она адресует
|
||||
исключение путём к файлу, отвязывается при переносе кода и продолжает
|
||||
разрешать `time.Now()` там, где исключения уже нет, — молча. Директива
|
||||
переезжает вместе с кодом, и grep по `nolint:forbidigo` даёт весь список —
|
||||
та исчерпываемость, которой требует R3, проверяется одной командой. Голый
|
||||
та исчерпываемость, которой требует GTIM-3, проверяется одной командой. Голый
|
||||
`//nolint` без имени правила глушит на строке все проверки сразу, а без
|
||||
причины неотличим от заглушенного дефекта; обе деградации штатно ловит
|
||||
`nolintlint` (`require-specific`, `require-explanation`) — стандартный
|
||||
способ дисциплинировать директивы в golangci-lint.
|
||||
|
||||
### R4. В БД время хранится с секундной точностью, ширина 20 символов
|
||||
### GTIM-4. В БД время хранится с секундной точностью, ширина 20 символов
|
||||
|
||||
**ДОЛЖЕН.** Каноническое значение в колонке — `2026-06-28T11:23:45Z`.
|
||||
|
||||
@@ -83,16 +84,16 @@ layout — а расхождение проявится не на записи,
|
||||
Ширина достаётся даром: layout `time.RFC3339` не содержит долей секунды,
|
||||
поэтому `Format` их не выведет.
|
||||
|
||||
### R5. `time.RFC3339Nano` не используется
|
||||
### GTIM-5. `time.RFC3339Nano` не используется
|
||||
|
||||
**НЕ ДОЛЖЕН.** Ни как layout вывода, ни как формат хранения.
|
||||
|
||||
**Почему.** Он отбрасывает хвостовые нули, из-за чего длина строки зависит
|
||||
от значения: соседние записи получают разную ширину, и свойство, на котором
|
||||
держится R4, исчезает незаметно. Проверка «формат корректен» при этом
|
||||
держится GTIM-4, исчезает незаметно. Проверка «формат корректен» при этом
|
||||
проходит — отказывает только порядок.
|
||||
|
||||
### R6. Чужой вход нормализуется явно
|
||||
### GTIM-6. Чужой вход нормализуется явно
|
||||
|
||||
**ДОЛЖЕН.** Значение времени, пришедшее не от нашего писателя, приводится
|
||||
к каноническому виду явно, а не считается каноническим по факту успешного
|
||||
@@ -101,21 +102,21 @@ layout — а расхождение проявится не на записи,
|
||||
**Почему.** `time.Parse(time.RFC3339, …)` принимает и доли секунды, и
|
||||
офсеты, отличные от `Z`, — разбор шире вывода. Канонический вид гарантирует
|
||||
**писатель**, а не читатель; пока писатель один, этого достаточно, но
|
||||
значение из чужой системы, положенное в базу как пришло, нарушает R4 и
|
||||
значение из чужой системы, положенное в базу как пришло, нарушает GTIM-4 и
|
||||
обнаруживается не на записи, а на первой сортировке. Само решение
|
||||
«нормализовать, а не отклонять» — базовое (`arch/time.md` R13); здесь —
|
||||
«нормализовать, а не отклонять» — базовое (`TIME-13`); здесь —
|
||||
Go-механика, из-за которой его легко нарушить незаметно.
|
||||
|
||||
### R7. В драйвер передаётся строка, а не `time.Time`
|
||||
### GTIM-7. В драйвер передаётся строка, а не `time.Time`
|
||||
|
||||
**СЛЕДУЕТ.** В запрос идёт результат `FormatTime`.
|
||||
|
||||
**Почему.** Колонка — `TEXT`, и передача `time.Time` отдаёт форматирование
|
||||
драйверу: появляется вторая точка формата вне `FormatTime` (R2), с
|
||||
драйверу: появляется вторая точка формата вне `FormatTime` (GTIM-2), с
|
||||
собственным layout, который меняется вместе с версией драйвера, а не вместе
|
||||
с конвенцией.
|
||||
|
||||
### R8. Время в логах приводится к UTC через `ReplaceAttr`
|
||||
### GTIM-8. Время в логах приводится к UTC через `ReplaceAttr`
|
||||
|
||||
**ДОЛЖЕН.** Хендлер `slog` переопределяет атрибут `slog.TimeKey`:
|
||||
|
||||
@@ -134,17 +135,17 @@ func utcTime(_ []string, a slog.Attr) slog.Attr {
|
||||
неверная зона выглядит как совершенно валидное время, а записи из разных
|
||||
мест перестают складываться в одну хронологию с метками хранилища.
|
||||
|
||||
### R9. Точность времени в логах отличается от точности в БД
|
||||
### GTIM-9. Точность времени в логах отличается от точности в БД
|
||||
|
||||
**ДОПУСКАЕТСЯ.** `JSONHandler` пишет миллисекунды — три знака, и это не
|
||||
приводится к секундной точности R4.
|
||||
приводится к секундной точности GTIM-4.
|
||||
|
||||
**Почему.** Явное разрешение нужно, чтобы R4 не читался как требование
|
||||
**Почему.** Явное разрешение нужно, чтобы GTIM-4 не читался как требование
|
||||
одной точности везде. Ширина фиксируется на носитель: три знака в логе —
|
||||
такая же фиксированная ширина, и свойство, ради которого R4 существует, не
|
||||
нарушено. Общее у лога и базы одно — зона (R8).
|
||||
такая же фиксированная ширина, и свойство, ради которого GTIM-4 существует, не
|
||||
нарушено. Общее у лога и базы одно — зона (GTIM-8).
|
||||
|
||||
### R10. Обёртка измерения длительности берёт `time.Now()` напрямую
|
||||
### GTIM-10. Обёртка измерения длительности берёт `time.Now()` напрямую
|
||||
|
||||
**ДОПУСКАЕТСЯ.** Обёртка вызывает `time.Now()` и считает `time.Since` — с
|
||||
локальным `//nolint`.
|
||||
@@ -153,10 +154,10 @@ func utcTime(_ []string, a slog.Attr) slog.Attr {
|
||||
срезает монотонную составляющую `time.Time`. Интервал, посчитанный по таким
|
||||
меткам, зависит от подводки часов: перевод назад даёт отрицательную
|
||||
длительность, скачок вперёд — выброс в измерениях, и оба случая
|
||||
невоспроизводимы. Разрешение записано явно, иначе исключение R3.2 читается
|
||||
невоспроизводимы. Разрешение записано явно, иначе исключение GTIM-3.2 читается
|
||||
как недосмотр и его «чинят».
|
||||
|
||||
### R11. `time/tzdata` импортируется в `main`
|
||||
### GTIM-11. `time/tzdata` импортируется в `main`
|
||||
|
||||
**ДОЛЖЕН.** База зон вшивается в бинарь.
|
||||
|
||||
@@ -166,7 +167,7 @@ func utcTime(_ []string, a slog.Attr) slog.Attr {
|
||||
`main` держит это решение в одном видимом месте, а не в случайном пакете,
|
||||
откуда его удаляют при чистке зависимостей.
|
||||
|
||||
### R12. Зона отображения применяется только в UI
|
||||
### GTIM-12. Зона отображения применяется только в UI
|
||||
|
||||
**ДОЛЖЕН.** Зона из конфига используется в шаблонах и форматтерах
|
||||
представления, но не в хранимых значениях и не в вычислениях.
|
||||
|
||||
Reference in New Issue
Block a user