Изучите, как отладить JavaScript с помощью Chrome DevTools

Представьте себе, что вы работаете над этим невероятным новым веб-приложением, и ваши тестеры попросили вас исправить следующие ошибки:

  • “Loading…” сообщение строки состояния не исчезает, когда приложение закончило загружаться.
  • Язык по умолчанию - норвежский, даже в английских версиях IE и Firefox.
  • Где то в коде образовалась глобальная переменная prop (зло - прим. пер.).
  • В DOM-вьювере все элементы почему то имеют атрибут «clone».
  • Запуск отладчиков
    • В Firefox вы должны убедится, что у вам установлено расширение Firebug. Выберите “Инструменты > Firebug > Open Firebug”.
    • В Опере 9.5+, выберите “Инструменты > Дополнительно > Средства разработки.”
    • В бете IE, выберите “Сервис > Панели > Панели обозревателя > IE Developer Toolbar.”
    • В Safari или WebKit, сначала включите меню отладки (1) , затем выберите “Разработать > Показать веб-инспектор”
    Пришло время запускать отладчики. Так как некоторые инструкции требуют изменения кода, вам лучше сохранить тестовую страницу и загрузить ее браузером с диска.Ошибка № 1: Сообщение “Загрузка …” Если вы посмотрите на отлаживаемое приложение, то сначала вы увидите то, что изображено на рисунке 1.


    рис. 1: начальный вид нашего JavaScript-приложения в Dragonfly и Firebug, соответственно.

    Когда вы смотрите на исходный текст в отладчике, обратите внимание на функцию clearLoadingMessage() в самом начале кода. Это неплохое место для контрольной точки.

    Как её поставить:

  • Щелкните мышью в левом поле на номере строки, чтобы установить контрольную точку на первой строке
  • Перезагрузите страницу.
  • Обратите внимание: контрольная точка должна быть установлена на строке с кодом, который выполнится, когда функция будет запущена. Строка, которая содержит clearLoadingMessage(){ не подходит, так как является лишь определением функции. Если вы установите контрольную точку здесь, отладчик на ней не остановится, вместо этого контрольную точку надо устанавливать внутри функции.

    Когда страница будет перезагружена, выполнение скрипта будет остановлено и вы увидите то, что показано на рисунке два.


    рис. 2: отладчики остановились в контрольной точке внутри clearLoadingMessage.

    Давайте взглянем на код функции. Как нетрудно заметить, в ней обновляются два DOM элемента, а в строке 31 упоминается слово statusbar. Похоже, что getElements("p", {"class":"statusbar"}).innerHTML ищет элемент statusbar в дереве DOM. Как бы нам быстро проверить своё предположение?

    Вставьте эту инструкцию в командную строку, чтобы проверить. На рисунке три показаны три скриншота (Dragonfly, Firebug и IE8) после чтения innerHTML или outerHTML элемента, возвращенного командой, которую вы исследуете.

    Чтобы проверить сделайте следующее:

  • Найдите командную строку:
    * В Firebug, переключитесь в закладку “Console”.
    * В Dragonfly, просмотрите пониже панели кода JavaScript.
    * В IE8, найдите закладку справа «Console».
  • Вставьте getElements("p", {"class":"statusbar"}).innerHTML в командную строку.
  • Нажмите Enter.



  • рис. 3: вывод результата команды в Dragonfly, Firebug, и IE8, соответственно.

    Командная строка - очень полезный инструмент, который позволяет вам быстро проверять маленькие куски кода. Интеграция консоли Firebug очень полезна - если Ваша команда выводит объект, вы получаете очень интеллектуальное представление. Например, если это объект DOM - вы увидите размеченный результат.

    Можно использовать консоль, чтобы провести более глубокое исследование. Строка JavaScript, которую мы изучаем, делает следующие три вещи:

  • Получает ссылку на элемент statusbar.
  • Находит firstChild, другими словами, первый узел в этом параграфе.
  • Устанавливает свойство innerText.
  • Давайте попробуем запустить в консоли, что-то большее, чем предыдущая команда. Например вы можете попробовать узнать, какое текущее значение у свойства innerText, перед тем как ему присваивается новое значние. Чтобы узнать это, вы можете напечатать всю команду до знака "=" в командную строку: getElements("p" , {"class" :"statusbar" }).firstChild.innerText

    Сюрприз, на выходе… ничего. Таким образом выражение getElements ("p", {"класс:"statusbar" "}) .firstChild указывает на какой то объекст в DOM, который не содержит никакого текста, или не имеет свойства innerText.

    Тогда, следующий вопрос: что на самом деле является первым дочерним элементом у параграфа? Давайте зададим этот вопрос коммандной строке. (См. четвертый рисунок).

    рис. 4: командная строка отладчика СтDragonfly, вывод [объект Text].

    Вывод отладчика Dragonfly’s - [объект Text] показывает, что это - текстовый узел DOM. Таким образом мы нашли причину первой проблемы. У текстового узла нет свойства innerText, следовательно, установка значения для p.firstChild.innerText ничего не делает. Эта ошибка легко может быть исправлена, если заменить innerText на nodeValue, который является свойством, определенным стандартом W3C для текстовых узлов.

    Теперь, после того как мы разобрались с первой ошибкой:

  • Нажмите или кнопку Run, чтобы закончить скрипт.
  • Не забудьте сбросить поставленную контрольную точку, кликнув по номеру строки еще раз.
  • Ошибка два: проблема определения языка. Вы, возможно, обратили внимание на переменную lang;/*language*/ в начале скрипта. Можно предпложить, что код устанавливающий значение этой переменной и вызывает проблему. Можно попробовать найти этот код используя встроенную в отладчики функцию поиска. В Dragonfly поиск находтится прямо над просмотрщиком кода, в Firebug - в правом верхнем углу (см. рисунок 5)

    Чтобы найти место, где вероятно происходит проблема локализации сделайте следующее:

  • Напечатайте lang = в поле поиска.
  • Установите контрольную точку на строке, где переменной lang задается значение.
  • Перезагрузите страницу.
  • У WebInspector тоже есть очень удобная функция поиска. Она позволяет искать что угодно одновременно и в разметке страницы, и в CSS, и в коде JavaScript. Результаты показывюется на отдельной панели, где вы можете дважды кликнуть по ним, чтобы перейти в нужное место, как показано на скриншоте.


    рис. 5: поиск в Dragonfly и в WebInspector.

    Для того, чтобы проверить, что делает эта функция:

  • Нажмите кнопку «step into» для входа внутрь функции getLanguage.
  • Жмите ее еще и еще, пошагово выполняя код
  • В окне просмотра переменных смотрите как меняются их значния.
  • Войдя в функцию вы увидите попытку прочитать язык из строки юзер-агента браузера, путем анализа navigator.userAgent.
    var str1 = navigator.userAgent.match(/\((.*)\)/);
    var ar1 = str1.split(/\s*;\s*/), lang;
    for (var i = 0; i < ar1.length; i++){
    if (ar1[i].match(/^(.{2})$/)){
    lang = ar1[i];
    }
    }

    В процессе пошагового прохождения кода, вы можете использовать окно просмотра локальных переменных. На рисунке 6 показано как это выглядит в Firebug и IE8 DT, массив ar1 мы развернули, чтобы видеть его элементы.

    рис. 6: Панель просмотра локальных переменных фукции getLanguage в Firebug IE8’s

    Выражение ar1[i].match(/^(.{2})$/) просто ищет строку, состоящую их двух символов, типа «no», «en». Однако как видно на скриншоте у Firefox информация о языке представлена в виде «nn-NO» (2) . IE же и вовсе не помещает в юзер-агента информации о языке.

    Таким образом мы нашли вторую ошибку: определение языка производилось путем поиска двухбуквенного кода в строке юзерагента, но Firefox имеет пятисимвольное обозначение языка, а IE не имеет его вовсе. Такой код должен быть переписан и заменен на определение языка либо на стороне сервера с помощью HTTP заголовка Accept-Language, либо получением его из navigator.language (navigator.userLanguage для IE). Вот пример того, какой может быть такая функция

    function getLanguage() {
    var lang;

    if (navigator.language) {
    lang = navigator.language;
    } else if (navigator.userLanguage) {
    lang = navigator.userLanguage;
    }

    if (lang && lang.length > 2) {
    lang = lang.substring(0, 2);
    }

    return lang;
    }


    Ошибка три: таинственная переменная «prop»
    рис. 7: В панели просмотра переменных Firebug и Dragonfly видна глобальная переменная prop

    На рисунке 7 хорошо видно переменную «prop». В хорошо написанных приложениях количество глобальных переменных должно быть минимально, поскольку они могут стать причиной проблем, когда, например две части приложения захотят использовать одну и ту же переменную. Предположим, что завтра другая команда добавит новые возможности в наше приложение и тоже объявит переменную «prop». Мы получим две разные части кода приложения, использующие одно имя для разных вещей. Такая ситуация часто приводит к конфликтам и ошибкам. Можно попробовать найти эту переменную и объявить ее локальной. Для этого можно воспользоваться поиском, как мы делали это в предыдущем случае, но есть и более умный способ…

    У отладчиков для многих других языков программирования есть понятие «наблюдателя»(watch), который переходит в режим отладки, когда изменяется заданная переменная. Ни Firebug, ни Dragonfly не поддерживают «наблюдателей» в настоящее время, но мы можем легко эмулировать похожее поведение, добавив следующую строку в начало исследуемого кода:

    __defineSetter__("prop" , function () { debugger; });

    Сделайте следующее:
  • Добавьте отладочный код в начало самого первого скрипта.
  • Перезагрузите страницу.
  • Отметьте, как прерывается выполнение скрипта.
  • В IE8 DT имеется закладка «Watch», однако прерывания в момент изменения переменной не происходит. Так что этот пример работает только в Firefox, Opera и Safari.

    Когда вы перезагрузите страницу, выполнение кода немедленно остановится там где будет определена переменная «prop». Фактически остановка произодет в том месте, где вы добаили вышеупомянутую строку. Один клик по кнопке «step out» перекинет вас в место установки переменной.

    for (prop in attributes) {
    if (el.getAttribute(prop) != attributes) includeThisElement = false ;


    Нетрудно заметить цикл for в котором объявляется переменная prop без ключевого слова var, т.е. глобальная. Исправить это несложно, просто допишем var и исправим ошибку.Ошибка четыре: атрибут «clone», которого быть не должно Четвертая ошибка очевидно была обнаружена продвинутым тестировщиком, использующим DOM инспектор, так как ее существование никак не проявляется в пользовательском интерфейсе приложения. Если и мы откроем DOM инспектор (в Firebug это закладка «HTML», в Dragonfly она называется «DOM»), то увидим что многие элементы имеют атрибут clone, которого быть не должно.

    рис. 8: Dragonfly’s DOM инспектор показывает проблемный код.

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

    Самый быстрый способ найти эту проблему состоит в том, чтобы установить контрольную точку, которая срабатывает тогда, когда атрибут с названием clone будет установлен для какого-нибудь HTML элемента. Могут ли отладчики сделать это?

    JavaScript - очень гибкий язык, и одна из его сильных сторон (или слабых, в зависимости от вашей точки зрения) - это то, что вы можете заменить базовые функции языка своими собственными. Добавьте этот кусок кода на страницу, он переопределит системный метод setAttribute, вызывая остановку кода в момент установки свойства «clone»:

    var funcSetAttr = Element.prototype.setAttribute; /* сохраняем ссылку на системный метод */
    Element.prototype.setAttribute = function (name, value) {
    if (name == "clone" ) {
    debugger; /* останавливаем скрипт */
    }
    funcSetAttr.call(this ,name,value); /* вызываем ранее сохраненный системный метод, чтобы нормальные свойства устанавливались корректно */
    };

    Итак, делаем следующее:
  • Добавьте приведенный код в начало первого скрипта на странице.
  • Перезагрузите страницу.
  • После перезагрузки, скрипт начинает обрабатывать DOM-дерево, но сразу же останавливается, как только произойдет установка «плохого» атрибута. (Обратите внимание, что в текущих версиях Firefox, реализация setAttribute различна для разных элементов. Код, приведенный выше работает всегда как надо только в Опере; чтобы получить тот же самый эффект в Firefox, вы можете заменить слово Element на HTMLFormElement, чтобы переопределить более специфический метод HTMLFormElement.prototype.setAttribute).

    Когда выполнение остановится в контрольной точке, вы захотите узнать где же произошел вызов setAttribute(), то есть вам нужно вернуться на уровень выше в цепочке вызовов функций и посмотреть что происходит там. Для этого вы можете использовать стек вызовов.


    рис. 9: Стек вызовов в Dragonfly и IE8.

    На рисунке 10 показан стек в Firebug. В строке "setAttribute

    Понравилась статья? Поделиться с друзьями: