Помилки та налагодження

На живому сайті відвідувачі бачать коротку сторінку помилки, а деталі потрапляють до журналу помилок PHP. Режим налагодження показує розробнику все одразу.

Режим налагодження

Єдиний перемикач — site.debug у конфігурації сайту: 1 — увімкнено, 0 — вимкнено. Інсталятор записує 0. Вмикайте його лише на копії для розробки: у режимі налагодження сторінки помилок відображають шляхи на сервері та ланцюжок викликів, а будь-хто може відкрити XML будь-якої сторінки. php index.php setup check завершується помилкою, поки режим увімкнено.

У режимі налагодження:

  • PHP відображає помилки;
  • ?debug після адреси сторінки повертає XML-документ сторінки: її властивості, XML кожного компонента, рядки інтерфейсу, скрипти та запити до бази даних із їх кількістю;
  • ?struct повертає дерево розмітки та вмісту сторінки з класами її компонентів;
  • сторінки помилок показують повідомлення, файл і рядок, а також ланцюжок викликів;
  • зображення, яке не знайде ресайзер, відображається сірим заповнювачем.

Без режиму налагодження ?debug і ?struct ігноруються, і сторінка є звичайним HTML.

Що бачать відвідувачі

Відповідь Коли
404 невідома адреса; сторінка, вимкнена для цієї мови; мова в підготовці — для всіх, крім редактора; сторінка, до якої відвідувач не має прав доступу
403 вікно адміністратора або дія, що потребує прав, яких користувач не має
422 форма без токена або з іншого сайту; зміна — видалення, переміщення, увімкнення — запитана без POST
500 помилка, якої код не передбачав

Сторінки 404 і 403 зберігають макет сайту: власний site/modules/main/templates/layout/error.layout.xml, якщо він є, інакше — з ядра, із рядками інтерфейсу TXT_ERROR_404, TXT_ERROR_403 і TXT_ERROR_HINT. Сторінка 500 знаходиться поза макетом: текст помилки, посилання на головну сторінку та noindex. Поза режимом налагодження її текст — «Ошибка на сервере. Попробуйте ещё раз позже.», а деталі потрапляють до журналу. Запити адміністратора отримують помилку у форматі JSON: {"result": false, "errors": [{"message": …}]}.

Відмовлена форма відповідає 422, а не 403, тому що хостинг-панелі часто підставляють власну сторінку замість 403. Якщо ваша хостинг-панель обслуговує власні сторінки помилок, вимкніть це для сайту, інакше відвідувачі побачать сторінки панелі замість сторінок сайту.

Попередження PHP зупиняють сторінку

Всі помилки PHP реєструються. Попередження або повідомлення не ігнорується: воно зупиняє сторінку як помилку, відвідувач бачить сторінку помилки, а до журналу потрапляє повідомлення з файлом і рядком. Лише повідомлення про застаріле фіксуються в журналі і дозволяють сторінці продовжити роботу — щоб новіша версія PHP не ламала сайт.

Журнал

Simple не веде власних файлів журналу: він пише до журналу помилок PHP сайту, без рівнів або ротації. Його рядки починаються з:

Рядок Що означає
Energine: <class>: <message> @ <file>:<line> помилка, деталі якої відвідувач не побачив
PHP error <N> thrown as SystemException: … попередження або повідомлення PHP, що зупинило сторінку
PHP Deprecated: … повідомлення про застаріле
Mail: <reason> лист, який не було надіслано
Register: …, UserProfile: … невдала реєстрація або збереження профілю

База даних зберігає журнали, а не помилки:

  • «Журнал действий» за адресою /admin/action-log/: збереження та видалення в адмінці й збережені тексти — хто, що і коли;
  • історія кожного тексту: його останні 20 версій кожною мовою;
  • невдалі спроби входу за останні 15 хвилин — для обмежень на вхід.

Перевірки

  • php index.php setup check — перед передачею сайту замовнику; див. Перший сайт.
  • php index.php setup checklinks — зламані посилання в текстах; завершується з кодом 1, якщо знайде такі.

Власні тести репозиторію знаходяться в tests/ і описані в tests/README.md. Вони читають конфігурацію сайту та tests/local.php — e-mail і пароль адміністратора, локальну поштову скриньку та шлях до журналу помилок PHP; створіть його з tests/local.php.example, доступного лише власнику для читання. Вони викликають php8.5, клієнт mysql і curl; запускайте їх із репозиторію від імені користувача сайту.

  • bash tests/smoke-final.sh читає кожну сторінку як гість і як адміністратор та повідомляє про нові рядки в журналі PHP. Нічого не змінює й безпечний на живому сайті.
  • bash tests/regression.sh запускає всі набори тестів проти бази даних сайту: створює та видаляє тестові записи, а тест входу блокує адресу цієї машини на певний час. Запускайте його на тестовій копії — tests/tools/stand.sh запускає її з власною MariaDB і вбудованим сервером PHP.