From 7808083a0821494165320ff7eda7cd79227c9624 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CNaeel=E2=80=9D?= Date: Wed, 29 Apr 2026 21:40:40 +0400 Subject: [PATCH] cleanup: remove debug artifacts from notification flows --- analysis/cleanup-worklog-2026-04-29.md | 51 +++++++++++++++ .../comment-removal-candidates-2026-04-29.md | 64 +++++++++++++++++++ v1/resources/instance_operation_default.cfc | 3 +- v1/resources/notification_ls.cfc | 23 ++----- 4 files changed, 121 insertions(+), 20 deletions(-) create mode 100644 analysis/comment-removal-candidates-2026-04-29.md diff --git a/analysis/cleanup-worklog-2026-04-29.md b/analysis/cleanup-worklog-2026-04-29.md index 80af4ca..63d5f7f 100644 --- a/analysis/cleanup-worklog-2026-04-29.md +++ b/analysis/cleanup-worklog-2026-04-29.md @@ -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` не обнаружено diff --git a/analysis/comment-removal-candidates-2026-04-29.md b/analysis/comment-removal-candidates-2026-04-29.md new file mode 100644 index 0000000..d03b686 --- /dev/null +++ b/analysis/comment-removal-candidates-2026-04-29.md @@ -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 код от действительно полезных пояснений к ограничениям параметров \ No newline at end of file diff --git a/v1/resources/instance_operation_default.cfc b/v1/resources/instance_operation_default.cfc index c89b93a..104b806 100644 --- a/v1/resources/instance_operation_default.cfc +++ b/v1/resources/instance_operation_default.cfc @@ -57,7 +57,8 @@ - + + diff --git a/v1/resources/notification_ls.cfc b/v1/resources/notification_ls.cfc index 52e453e..fa4714d 100644 --- a/v1/resources/notification_ls.cfc +++ b/v1/resources/notification_ls.cfc @@ -2,7 +2,7 @@ - + @@ -25,19 +25,18 @@ - + - + - - + @@ -49,8 +48,6 @@ - - select @@ -61,11 +58,8 @@ n.timeout_sec n.contragent_id k.external_uid - to_char(n.dt_show_from, 'YYYY-MM-DD"T"HH24:MI:SS.FF3TZHTZM') as dt_show_from to_char(n.dt_show_to, 'YYYY-MM-DD"T"HH24:MI:SS.FF3TZHTZM') as dt_show_to - from notification n left outer join contragent k on (n.contragent_id=k.contragent_id) @@ -74,11 +68,8 @@ AND (n.dt_show_to >= CURRENT_TIMESTAMP OR n.dt_show_to IS NULL) AND (k.external_uid = OR n.contragent_id IS NULL) order by dt_show_from desc - limit #maxrows# - - select count(*) as cnt @@ -107,7 +98,6 @@ - @@ -116,9 +106,4 @@ - - - \ No newline at end of file