HubNext
Справка
Справка Разработка

Разработка: площадки и тест запросов

Режим для команд разработки: отправить запрос на тестовый сервер прямо из задачи, увидеть ответ и одним нажатием положить результат в комментарий. Все запросы сохраняются в журнале.

Где найти

Режим включает администратор системы (Модули системы → Разработка). После этого в меню под «Задачи и дела» появляется пункт Разработка: Площадки (руководитель и выше) и Журнал запросов (менеджер и выше). Кнопка Тестировать есть в карточке каждой задачи у всех сотрудников от роли «Пользователь».

Площадки

Площадка — адрес, на который HubNext разрешает отправлять запросы. Любой другой адрес указать нельзя. Площадки добавляет руководитель.

  1. Нажмите Добавить площадку.
  2. Заполните Название, Окружение, Схему, IP или домен, при необходимости Порт и Базовый путь (например, /api/v1).
  3. В Общих заголовках можно указать токен: Authorization: Bearer .... Заголовки хранятся зашифрованно и после сохранения не показываются.
  4. Если нужны SQL-запросы, заполните блок База данных: Драйвер, при необходимости Хост БД и Порт БД, База, Пользователь и Пароль. Пароль хранится зашифрованно и после сохранения не показывается. Заведите для HubNext учётку только на чтение.
  5. Нажмите Сохранить.

На экране показан IP нашего сервера: добавьте его в разрешённые у себя, иначе ваш сервер может не принять запросы.

Отправка на площадку с окружением prod запрещена. Запросы идут только на dev и stage. Внутренние адреса (127.0.0.1, сети 10.x, 192.168.x и подобные) тоже запрещены.

Библиотека запросов

В Библиотеке запросов хранятся запросы, которыми пользуется вся организация: метод, путь, заголовки, тело, ожидаемый код и площадка по умолчанию. Смотреть и использовать их может любой сотрудник от роли «Пользователь», создавать, править и удалять — менеджер и выше (кнопка Добавить запрос).

  • В пути, заголовках и теле можно использовать переменные: {{task_code}} (код задачи, из которой запускают), {{site.host}}, {{site.title}}, {{date}} (сегодняшняя дата). Они подставляются при отправке.
  • Секретные заголовки (Authorization, Cookie, X-Api-Key и подобные) в запросе указать нельзя: токены хранятся в общих заголовках площадки. Не кладите пароли и токены и в тело запроса: библиотека открыта всей организации.
  • У каждого запроса показан результат последнего запуска, а менеджер видит ссылку в журнал по этому запросу.
  • Запрос можно проверить прямо в библиотеке: кнопка Запустить (треугольник в строке) открывает окно, где выбирается Площадка (по умолчанию — площадка запроса), и показывает код ответа, заголовки и тело (для SQL — таблицу строк). Запуск записывается в журнал, как обычная отправка. Для SQL в списке только площадки с настроенной базой.

Коллекции

На вкладке Коллекции библиотеки запросы собираются в набор, который запускается скопом. Менеджер и выше создаёт и правит коллекции (кнопка Добавить коллекцию), запускать их и смотреть историю может любой сотрудник от роли «Пользователь».

  1. Нажмите Добавить коллекцию, укажите Название и при необходимости Площадку по умолчанию.
  2. Добавьте шаги кнопкой Добавить шаг (до 20, один запрос можно добавить несколько раз) и расставьте их стрелками.
  3. Отметьте, нужно ли остановиться, если шаг не прошёл: тогда остальные шаги пропускаются и не отправляются.
  4. В блоке Запуск коллекции выберите коллекцию, Площадку и при желании введите Код задачи, затем нажмите Запустить. Запуск идёт на одну площадку, выбранную при запуске; площадки prod запрещены.

Результат показывает итог (Прошло, Упало или Ошибка), счётчики и таблицу шагов с кодом ответа, временем и причиной (например, «пропущено: предыдущий шаг не прошёл»). Если запуск привязан к задаче, появляется кнопка Добавить итог в задачу: в комментарий попадает сводка и список шагов без тел ответов. Коллекцию можно запустить и из окна Тестировать в карточке задачи.

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

SQL-запросы

Если у площадки настроена база данных, в окне Тестировать появляется переключатель HTTP / SQL, а в библиотеке запросов можно сохранить запрос типа SQL. SQL выполняется только на чтение.

  • Разрешён один оператор SELECT. INSERT, UPDATE, DELETE, DROP, несколько операторов через ;, SELECT ... INTO, FOR UPDATE, функции вроде sleep и блокировок отклоняются. Кроме того, сессия открывается в режиме «только чтение», так что записать в базу нельзя даже учётке с правом записи.
  • Результат — не больше 100 строк (если строк больше, это сказано под таблицей), запрос ограничен 10 секундами. Значения колонок с именами password, token, secret, api_key и подобных заменяются на *** везде: в окне, в комментарии и в журнале.
  • Свой текст SQL вводит менеджер и выше. Запрос из библиотеки может выполнить и пользователь, но менять его текст не может.
  • Добавить в задачу кладёт в комментарий запрос и первые строки результата. Выполнить на площадке prod нельзя.
  • SQL можно добавлять шагом в коллекцию вместе с HTTP-запросами: такой шаг выполняется на базе той же площадки. В коллекции шаг SQL считается пройденным, если запрос выполнился; в журнале у него указано число строк.
  • Сейчас поддерживаются MySQL и MariaDB. Вариант PostgreSQL появится, когда на сервере будет установлено расширение pdo_pgsql.

Тест запроса из задачи

  1. В карточке задачи нажмите Тестировать.
  2. При необходимости выберите запрос в поле Из библиотеки: площадка, метод, путь, заголовки, тело и ожидаемый код подставятся сами. Выберите Площадку и Метод, укажите Путь (после базового пути), при необходимости заголовки и тело запроса. В поле Ожидаемый код ответа можно указать, какой код считать успехом; по умолчанию успехом считается любой код 2xx.
  3. Нажмите Отправить. Вы увидите результат (Прошло, Упало или Ошибка), код ответа, время, заголовки и тело ответа.
  4. Нажмите Добавить в задачу, проверьте текст и нажмите Добавить комментарий. В комментарий попадут площадка, запрос, результат и тело ответа.

Комментарий увидят все, кто видит задачу. В журнале и в комментарии пароли и токены заменяются на ***. Внизу окна показана история запросов по этой задаче. Менеджер может сохранить введённый запрос в библиотеку кнопкой В библиотеку.

Ограничения: до 60 запросов в минуту на человека, тело запроса до 256 КБ, ответ до 1 МБ, время ожидания 20 секунд, редиректы не выполняются.

Журнал запросов

В разделе Журнал запросов — все запросы организации: время, кто отправил, площадка, запрос, код ответа и результат. Можно отфильтровать по задаче, площадке и результату; кнопка Подробнее открывает заголовки и тела запроса и ответа.

Журнал не очищается автоматически: записи только добавляются. Тела длиннее 64 КБ в журнале обрезаются.

См. также