Обработка таймаутов

Puppeteer — это библиотека для автоматизации браузера с использованием Chromium. При разработке тестов, в особенности тех, которые взаимодействуют с веб-страницами, необходимо учитывать таймауты. В реальных приложениях страницы могут загружаться или изменяться с различной скоростью, и важно грамотно обрабатывать такие задержки. В этой статье рассматриваются способы управления таймаутами, которые помогут избежать ошибок и повысить стабильность тестов.

Таймауты в Puppeteer

Puppeteer использует таймауты в различных контекстах, например, при ожидании элементов на странице, при загрузке страницы или ожидании событий. Неправильная настройка таймаутов может привести к нестабильным тестам, особенно если взаимодействие с элементами страницы зависит от медленной или нестабильной сети.

Основные таймауты, которые можно встретить при использовании Puppeteer, это:

  • Таймауты ожидания — для ожидания элементов на странице.
  • Таймауты навигации — для ожидания загрузки страницы.
  • Таймауты действия — для ожидания завершения определённых действий, таких как клики или ввод текста.

Настройка таймаутов

Параметры таймаутов могут быть заданы глобально для всего браузера или локально для отдельных действий. Рассмотрим, как настроить таймауты в разных случаях.

Глобальная настройка таймаута

Для задания общего таймаута на все действия в Puppeteer, необходимо установить соответствующие параметры при запуске браузера. Это можно сделать с помощью опции timeout в конфигурации при создании экземпляра браузера или страницы. 

const browser = await puppeteer.launch({
  headless: true,
  timeout: 30000 // Таймаут на все действия в 30 секунд
});

В данном примере, если любое действие в браузере не завершится в течение 30 секунд, будет выброшено исключение.

Таймауты ожидания элементов

Самым распространённым использованием таймаутов в Puppeteer является ожидание появления элемента на странице. Для этого используется метод waitForSelector. Этот метод позволяет задать таймаут, через который будет сгенерировано исключение, если элемент не будет найден. 

const element = await page.waitForSelector(&


В этом примере тест будет ожидать появления элемента с селектором
#submit-button в течение 5 секунд. Если за это время
элемент не появится, возникнет ошибка.




Таймауты навигации




Когда требуется дождаться полной загрузки страницы или перехода на новый
URL, используется метод waitForNavigation. Он позволяет
задать таймаут, после которого будет выброшена ошибка, если страница не
загрузится в течение заданного времени.



await Promise.all([
  page.click('#link-to-another-page'),
  page.waitForNavigation({ timeout: 10000 })
]);



Здесь после клика по ссылке тест будет ожидать завершения навигации в
течение 10 секунд. Если за это время переход не состоится, произойдёт
исключение.




Таймауты для действий




Некоторые действия, такие как клик или ввод текста, могут занимать
разное время в зависимости от состояния страницы или сети. Для таких
операций также можно настроить таймауты. Например, при вводе текста в
поле можно задать время ожидания перед тем, как считать действие
завершённым.



await page.type('#username', 'testuser', { delay: 100, timeout: 5000 });



В этом примере типичный таймаут в 5 секунд задаёт время для ввода текста
в поле #username. Если текст не будет введён в течение
этого времени, будет выброшена ошибка.




Обработка ошибок таймаутов




Когда происходит превышение таймаута, Puppeteer генерирует ошибку,
которая может быть обработана с помощью конструкции
try-catch. Это позволяет в дальнейшем принимать необходимые
меры, например, записывать логи или повторять попытку.



try {
  await page.waitForSelector('#non-existent-element', { timeout: 5000 });
} catch (error) {
  console.log('Элемент не найден, повторяем попытку');
  // Логика повторной попытки
}



В этом примере, если элемент не появляется в течение 5 секунд, будет
выведено сообщение в консоль, и можно будет повторить действие.




Прерывание таймаутов




Если требуется прервать ожидание элемента или навигации до истечения
таймаута, можно использовать метод clearTimeout. Это может
быть полезно в тех случаях, когда заранее известно, что результат будет
получен через иной способ или по другим событиям.



const timeoutId = setTimeout(() => {
  console.log('Таймаут истёк!');
}, 5000);

clearTimeout(timeoutId);  // Прерывание таймаута



Данный метод позволяет отменить заранее установленный таймаут, если
условие для его срабатывания больше не актуально.




Стратегии уменьшения таймаутов




В тестировании важно понимать, что чрезмерно большие таймауты могут
скрывать проблемы в тестируемом приложении. Если тест проходит слишком
долго, есть риск, что ошибка или баг остаётся незамеченной. Важно
поддерживать оптимальные таймауты и делать их как можно более чёткими,
чтобы не “завуалировать” потенциальные проблемы.




Стратегия оптимизации таймаутов включает:



    

  • 
Использование минимально необходимых значений —
избегание слишком долгих таймаутов, которые могут скрыть реальные
проблемы.

    • 

  • 
Локальная настройка для критичных шагов — установка
таймаутов только для тех операций, где это действительно необходимо.

    • 




Инструменты для отладки




Puppeteer предоставляет различные способы для отладки и мониторинга
таймаутов. Например, можно настроить отладочный режим, чтобы видеть все
происходящие ошибки и таймауты в реальном времени. Это особенно полезно
при работе с нестабильными или сложными страницами.



const browser = await puppeteer.launch({
  headless: false,
  devtools: true
});



Включение DevTools позволяет следить за всеми действиями и ошибками в
реальном времени через консоль разработчика, что помогает быстрее
выявить и устранить проблемы с таймаутами.




Рекомендации по оптимизации



    

  • 
Установите адекватные таймауты для всех операций, не
делая их слишком большими.

    • 

  • 
Используйте waitForSelector и waitForNavigation для
синхронизации действий с реальным состоянием страницы.

    • 

  • 
Логируйте ошибки с таймаутами, чтобы можно было быстро
понять, что пошло не так, и улучшить стабильность тестов.

    • 

  • 
Разделяйте долгие операции на несколько более мелких с
разными таймаутами, чтобы ускорить диагностику.

    • 




Правильная обработка таймаутов — это не просто средство для избежания
ошибок, но и важная часть стратегии устойчивости тестов.
Оглавление