镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

fix(settings): удалить нечитаемый ms3_customer_api_token_ttl (#797) - #835

Open
Ibochkarev wants to merge 1 commit into
betafrom
fix/issue-797-remove-dead-token-ttl-setting
Open

Ibochkarev wants to merge 1 commit into
betafrom
fix/issue-797-remove-dead-token-ttl-setting

Conversation

@Ibochkarev

@Ibochkarev Ibochkarev commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

Описание

Реализован вариант «удалить» из issue: мёртвая настройка убрана из пакета, лексикона и с установленных сайтов.

ms3_customer_api_token_ttl не читается кодом с перехода на httpOnly cookie (5dcbbe3f), но осталась в _build/elements/settings.php рядом с рабочей ms3_customer_token_ttl — с тем же значением 86400, той же областью ms3_security и описанием, отличающимся одним словом. Администратор, сокращающий время жизни токена покупателя, с равной вероятностью открывал любую из двух, получал сохранённое значение без ошибок и прежний срок жизни.

Сделано:

  1. _build/elements/settings.php — ключ ms3_customer_api_token_ttl удалён.

  2. lexicon/{ru,en}/setting.inc.php — удалены пары setting_ms3_customer_api_token_ttl / ..._desc.

  3. Новая миграция 20261005120000_remove_customer_api_token_ttl_setting.php удаляет строку настройки из system_settings (namespace minishop3) — иначе у всех обновляющихся сайтов контрол продолжал бы висеть в админке.

  4. Тест выявил смежный пробел, он закрыт: у ms3_utility_import_fields и ms3_utility_import_fields_delimiter не было _desc ни в en, ни в ru — добавлены обе пары (ru/en), иначе инвариант «у каждой поставляемой настройки есть описание» не проверяем.

Ветка перебазирована на актуальную beta (146b3557). Правки фолбэка 86400 в CookieHelper, AuthManager и TokenService из первоначального коммита выброшены — они уже приехали в beta отдельно. Дифф PR после этого — ровно пять файлов, как и предполагалось в ревью.

Тип изменений

  • Исправление бага (non-breaking change)
  • Новая функциональность (non-breaking change)
  • Breaking change (изменение, ломающее обратную совместимость)
  • Рефакторинг (без изменения функциональности)
  • Документация
  • Другое (опишите):

Связанные Issues

Closes #797

Как это было протестировано?

  • Новый smoke-тест core/components/minishop3/tests/CustomerTokenTtlSettingTest.php фиксирует найденный в issue класс проблем:

    • мёртвый ключ не возвращается в settings.php, рабочий ms3_customer_token_ttl остаётся;
    • каждая из 115 поставляемых настроек имеет setting_* и setting_*_desc в en и ru, и осиротевших setting_* лексикона не осталось;
    • все места чтения ms3_customer_token_ttl в src/ используют фолбэк, равный значению из settings.php (ловит расхождение «два числа — одно значение»);
    • миграция, удаляющая строку настройки, существует.

    Проверено негативным сценарием: временный возврат ключа в settings.php валит тест с нужным сообщением.

  • MigrationSelfContainedTest — миграция самодостаточна (без use MiniShop3\), префикс таблиц берётся через getAdapter()->getOption('table_prefix').

  • Локальный CI-гейт (PHP lint + smoke + PHPUnit из .github/workflows/ci.yml):

cd core/components/minishop3
composer install
composer ci:php
composer stan

php tests/run-smoke.php — OK smoke tests (137).
vendor/bin/phpunit — Tests: 923, Assertions: 3193, 3 падения в tests/Integration/WebApi/HeadlessStorefrontErrorsTest.php (testCartAddOptionsJsonString, testChangeOptionJsonStringOptionsReturns200, testCartWithoutTokenAndFailedAutoMintReturns500) — воспроизводятся и на чистом beta без этой правки, к изменению отношения не имеют.
composer stan — [OK] No errors. JS/Vue не затрагивался, npm run lint:ci для этой правки не требуется.

  • Ручное тестирование
  • Автоматические тесты (composer ci:php / composer test, npm run lint:ci, composer stan / GitHub Actions CI)
  • Тестирование на разных версиях PHP/MODX

Конфигурация тестирования:

  • MiniShop3: beta @ 146b3557 (1.14.3-beta2)
  • MODX: —
  • PHP: 8.5.8

Скриншоты (если применимо)

До После
Два почти одинаковых TTL-контрола в «Безопасность», один из них молча игнорируется Один контрол ms3_customer_token_ttl, значение в админке = значение в коде

Чеклист

  • Код соответствует стилю проекта
  • Добавлены/обновлены комментарии в сложных местах
  • Изменения не ломают существующую функциональность
  • Лексиконы добавлены на двух языках (ru/en) — удалены обе пары мёртвого ключа, добавлены пары ms3_utility_import_fields*_desc в ru/en
  • PHPStan проходит без новых ошибок (composer stan / CI job PHPStan)
  • ESLint проходит без ошибок (npm run lint:ci для Vue) — JS не менялся
  • Обновлён CHANGELOG.md — запись добавляется при подготовке релиза

Дополнительные заметки

  • Возвращать чтение ms3_customer_api_token_ttl не стал: две ручки для одного значения продолжали бы путать, а роль настройки полностью закрывает ms3_customer_token_ttl.
  • Если в документации на docs.modx.pro где-то описан ms3_customer_api_token_ttl как рабочий — страницу нужно обновить (в этом PR доки не трогал).

@Ibochkarev
Ibochkarev requested a review from biz87 October 5, 2026 17:41
@Ibochkarev Ibochkarev self-assigned this Oct 5, 2026
@biz87

biz87 commented Oct 30, 2026

Copy link
Copy Markdown
Member

Конфликт с beta — одна строка докблока в CookieHelper.php, две формулировки одного и того же.

При ребейзе стоит заодно выбросить три хунка: дефолт 86400 в CookieHelper, правки AuthManager и TokenService уже приехали в beta отдельно. После мержа с актуальной базой дифф PR схлопывается с восьми файлов до пяти — остаётся ровно то, ради чего он и заводился:

_build/elements/settings.php                       −5
lexicon/ru|en/setting.inc.php                      ±4
migrations/..._remove_customer_api_token_ttl...    +40
tests/CustomerTokenTtlSettingTest.php              +126

Проверил с локально разрешённым конфликтом: smoke 136, PHPUnit 918. ms3_customer_api_token_ttl не читается нигде в src, elements, controllers, assets — премисса подтвердилась. Миграция идемпотентна (DELETE несуществующей строки — no-op), префикс берётся через getAdapter()->getOption('table_prefix') при сыром PDO, как в 26 других миграциях.

@Ibochkarev
Ibochkarev force-pushed the fix/issue-797-remove-dead-token-ttl-setting branch from aa4d80d to c4d9612 Compare October 31, 2026 03:17
@Ibochkarev

Copy link
Copy Markdown
Member Author

Ребейзнул на актуальную beta (146b3557).

  • Конфликт в CookieHelper.php разрешён в пользу beta: докблок оставлен в формулировке базы.
  • Хунки с дефолтом 86400 в CookieHelper, AuthManager и TokenService выброшены — эти правки уже в beta.
  • Дифф PR схлопнулся до пяти файлов, как и ожидалось: _build/elements/settings.php, lexicon/{ru,en}/setting.inc.php, миграция 20261005120000_remove_customer_api_token_ttl_setting.php, tests/CustomerTokenTtlSettingTest.php.
  • В миграцию добавил завершающий перевод строки, описание PR обновил под фактический состав диффа.

Проверки после ребейза: php tests/run-smoke.php — OK smoke tests (137); vendor/bin/phpunit — Tests: 923, Assertions: 3193, 3 падения в HeadlessStorefrontErrorsTest (те же, что и на чистом beta); composer stan — [OK] No errors.

Настройка осталась в пакете после перехода на httpOnly cookie, но код её
не читает — рядом висит рабочий ms3_customer_token_ttl с тем же значением
и областью. Удалены ключ из settings.php, пары лексикона и миграция,
чистящая строку настройки на установленных сайтах.

Заодно добавлены недостающие описания ms3_utility_import_fields и
ms3_utility_import_fields_delimiter в ru/en: без них smoke-тест не может
проверить инвариант «у каждой поставляемой настройки есть описание».
@Ibochkarev

Copy link
Copy Markdown
Member Author

Допровёл rebase на актуальную origin/beta (7d53553): конфликт в _build/elements/settings.php разрешён — мёртвый ms3_customer_api_token_ttl удалён, новая настройка ms3_gallery_allow_url_upload из beta сохранена. Дифф схлопнулся до 5 файлов (settings, lexicon ru/en, миграция, тест). Smoke/Unit/PHPStan — OK.

@Ibochkarev
Ibochkarev force-pushed the fix/issue-797-remove-dead-token-ttl-setting branch from c4d9612 to 140c98a Compare November 9, 2026 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Cleanup] ms3_customer_api_token_ttl не читается кодом, но висит в админке рядом с рабочим двойником

2 participants