cleanup: remove debug artifacts from notification flows

This commit is contained in:
“Naeel”
2026-04-29 21:40:40 +04:00
parent 5952a4e344
commit 7808083a08
4 changed files with 121 additions and 20 deletions
+51
View File
@@ -722,3 +722,54 @@
- синтаксических ошибок в `v1/resources/instance_default.cfc` не обнаружено
- синтаксических ошибок в `v1/resources/svc_default.cfc` не обнаружено
- синтаксических ошибок в `v1/resources/instance_operation_default.cfc` не обнаружено
## Обновление: выбран bugfix-adjacent этап по debug-артефактам
Дата фиксации: 2026-04-29.
### Выбранные файлы
- `v1/resources/notification_ls.cfc`
- `v1/resources/instance_operation_default.cfc`
### Цель этапа
- убрать живые debug-артефакты, которые сейчас влияют на поведение ресурса
- сохранить общий контракт ответов и не трогать остальную бизнес-логику
- оформить это отдельным коммитом, а не смешивать с чисто косметическим cleanup
## Обновление: правило по спорным смысловым комментариям
Дата фиксации: 2026-04-29.
Уточнена трактовка исходного задания.
Решение на дальнейшую работу:
- явный закомментированный код, debug-хвосты и комментарии-рассуждения удалять
- спорные смысловые комментарии, где неочевидно, имелась ли в виду их обязательная зачистка, пока оставлять в коде
- не добавлять в исходники новые пометки вида `TODO удалить потом`, чтобы не создавать новый мусор
- вести отдельный внешний список кандидатов на удаление в `analysis/comment-removal-candidates-2026-04-29.md`
Это позволяет не терять спорные места и при этом не засорять исходники новыми временными комментариями.
### Результат bugfix-adjacent этапа
Изменены файлы:
- `v1/resources/notification_ls.cfc`
- `v1/resources/instance_operation_default.cfc`
Что сделано:
- удален живой тестовый возврат `Проверка связи 3` из ветки `invalidParamValue` в `notification_ls.cfc`
- убран сопутствующий закомментированный debug-слой вокруг этого ресурса
- в `instance_operation_default.cfc` удален `cfdump/cfabort` при ошибке десериализации стейта
- вместо аварийного останова оставлен безопасный fallback на пустые структуры
Дополнительно:
- создан внешний список спорных смысловых комментариев: `analysis/comment-removal-candidates-2026-04-29.md`
### Проверка
Измененные файлы проверены на ошибки.
Результат:
- синтаксических ошибок в `v1/resources/notification_ls.cfc` не обнаружено
- синтаксических ошибок в `v1/resources/instance_operation_default.cfc` не обнаружено
@@ -0,0 +1,64 @@
# Спорные кандидаты на удаление комментариев
Дата создания: 2026-04-29.
Назначение файла:
- фиксировать комментарии, которые могут подпадать под удаление по исходному заданию
- не размечать эти места внутри исходников новыми `TODO`
- оставить возможность позже быстро пройтись и удалить их одним отдельным этапом, если будет подтверждение
## Статус правила
- явный закомментированный код и debug-хвосты удаляются сразу
- спорные смысловые комментарии временно оставляются в коде
- кандидаты на последующее удаление записываются сюда
## Кандидаты
### 1. `v1/resources/instance_operation_default.cfc`
Оставлены пока что:
- комментарий про получение параметров из свежего стейта
- комментарии вокруг `formatter`, `value_list`, `default_compute`, `nested_ref_data`
- комментарии о частичном дублировании и временности некоторых решений
Почему спорно:
- часть комментариев выглядит как внутренние рассуждения автора
- часть при этом все еще помогает понять, зачем код делает нетривиальные вещи
Рекомендация:
- при отдельном подтвержденном этапе можно удалить большую часть комментариев-оценок и оставить только технические пояснения к формату данных
### 2. `v1/resources/instance_default.cfc`
Оставлены пока что:
- технические комментарии вокруг структуры шаблона экземпляра и вызова генерации имени
Почему спорно:
- часть уже очищена, остаток невелик и не мешает, но при строгом чтении задания может быть сокращен еще сильнее
Рекомендация:
- если потребуется максимально сухой код, пройтись повторно и убрать остаточные пояснения, не влияющие на понимание API-контракта
### 3. `v1/resources/notification_ls.cfc`
Оставлены пока что:
- короткие технические комментарии про фильтрацию и сортировку
Почему спорно:
- они не являются рассуждениями, но при очень агрессивной зачистке тоже могут считаться лишними
Рекомендация:
- удалять только если решено доводить list-resource до почти полного отсутствия комментариев
### 4. `v1/resources/instance_operation_cfs_param_ls.cfc`
Ожидаемо спорный файл для будущего этапа:
- содержит большой пласт рассуждений автора, предупреждений и объяснений по валидации, уникальности и доступу
Почему вынесено заранее:
- файл крупный и неоднозначный
- лучше разбирать отдельным этапом, чем смешивать с обычной зачисткой компактных ресурсов
Рекомендация:
- перед правкой сначала отделить чистый commented-out код от действительно полезных пояснений к ограничениям параметров