Проверка расширения на сайте
Редактор поставляется готовым: собирать его для проверки расширения не нужно. Установите и подключите своё расширение, затем проверьте его в редакторе и на странице сайта. Обновления сначала проверяйте на тестовой копии сайта.
Основная проверка
- Вставка. Откройте редактор и добавьте свой блок. Проверьте, что он появился в нужном месте и показывает ожидаемое содержимое.
- Изменение. Измените текст и параметры блока. Например, у блока «Предупреждение» поменяйте подпись и оформление. Убедитесь, что изменения видны в редакторе.
- Сохранение. Сохраните документ, закройте редактор и откройте его снова. Текст, параметры и положение блока должны сохраниться. Если редактор открыт для поля Битрикс, примените результат к полю и сохраните форму.
- Вывод на сайте. Откройте страницу как обычный посетитель. Проверьте содержимое, оформление и используемые действия: ссылки, переключатели, раскрытие блока. Повторите проверку на узком экране.
- Удаление. Удалите тестовый блок и сохраните документ. После повторного открытия редактора и страницы сайта блок не должен появиться снова.
Например, блок может правильно выглядеть в редакторе, но потерять оформление на сайте. Тогда проверьте подключение его публичного CSS. Если блок пропадает после повторного открытия, проверьте сохранение и восстановление его данных.
Проверки для возможностей вашего расширения
Выберите только те строки, которые относятся к вашей интеграции.
| Если расширение… | Что проверить |
|---|---|
| Доступно не всем пользователям | Разрешённый пользователь может вставить и изменить блок; пользователь без доступа не может обойти ограничение через запрос |
| Подключается к отдельным сайтам или документам | Блок доступен в нужном сайте и документе; в остальных его подключение соответствует заданным правилам |
| Добавляет диалог или форму параметров | Корректные данные применяются; неверные значения показывают понятную ошибку; отмена не меняет документ |
| Добавляет обработчики в редактор | Откройте два редактора, затем закройте один. Действия в оставшемся редакторе должны работать один раз и менять только его документ |
| Добавляет JavaScript на публичную страницу | Проверьте действия посетителя. При отключённом публичном скрипте содержимое блока должно оставаться доступным в статическом HTML |
| Использует провайдер данных | Проверьте найденную, удалённую и недоступную запись. Вместо чужих данных или сломанной страницы должен появиться предусмотренный результат |
| Предоставляет команды Agent API | Проверьте успешный запрос, неверные данные и устаревшую версию документа. Если команда требует digest, проверьте несовпадение набора расширений. Отклонённый запрос не должен менять документ |
| Участвует в предпросмотре, переносе или фоновой обработке | Проверьте каждый используемый сценарий отдельно: правильный результат и соблюдение прав доступа |
При ошибке откройте консоль и вкладку «Сеть» в инструментах разработчика браузера. Проверьте сообщения об ошибках и загрузку файлов расширения. Ошибки формирования HTML ищите также в серверном журнале. При обращении за помощью приложите версии модуля и расширения, последовательность действий и текст ошибки без паролей и персональных данных.
Обновление расширения
- Сохраните резервную копию данных и прежние настройки подключения. Оставьте доступной предыдущую версию расширения.
- Установите новую версию расширения способом, предусмотренным его поставкой: например, обновлением модуля Маркетплейса. Сам редактор пересобирать не нужно.
- Повторите основную проверку на ранее сохранённом документе и на новом блоке. Проверьте страницу сайта.
- После успешной проверки примените обновление на рабочем сайте и проверьте результат там.
Если вы выпускаете расширение сами, изменённые файлы должны получить новую версию пакета и новые контрольные суммы. Не заменяйте содержимое уже опубликованной версии: на неё могут ссылаться сохранённые документы, история и шаблоны. Не удаляйте старые пакеты, пока они нужны этим данным.
Откат
Верните предыдущую совместимую версию расширения и настройки подключения. Снова проверьте открытие документа и страницу сайта.
Если обновление меняет формат сохранённых данных, одного возврата файлов недостаточно. До обновления предусмотрите восстановление данных из резервной копии либо обратное преобразование. Например, если новая версия заменила поле label объектом heading, старая версия должна либо понимать новый формат, либо получить документ в прежнем формате.
Проверка регенерации
Проверьте оба способа генерации HTML: на сервере и в браузере. Без Node.js должны работать публикация, предпросмотр, импорт, восстановление блока и подготовленный разработчиком переход на новую версию расширения.
- На тестовой копии подготовьте обычную страницу и страницу со своим расширением. Сохраните их исходный JSON и опубликованный HTML для сравнения.
- После изменения настроек отображения запустите регенерацию. При наличии Node.js проверьте фоновую обработку.
- Для проверки браузерного варианта попросите администратора тестового сервера временно указать недоступный путь к Node.js. В настройках модуля нажмите «Обработать в браузере» и запустите очередь.
- Проверьте паузу и продолжение. Закройте вкладку во время обработки, подождите пять минут и продолжите очередь. Уже завершённые страницы не должны теряться.
- Сравните результат: JSON не изменился, новый HTML соответствует настройкам, публичные стили и действия работают. Верните настройку Node.js.
Например, после смены CSS-класса абзаца новый класс должен появиться и на обычной странице, и в текстовых частях страницы с расширением. Если у расширения есть интерактивная кнопка, отдельно проверьте её у посетителя: регенерация HTML не проверяет работу public-скрипта.