Настройка инструментов разработки

​

Рекомендуемые инструменты разработки

Эти дополнительные сервисы не обязательны для работы Overleaf, но настоятельно рекомендуются для разработки, отладки и анализа при локальной разработке.

• Hoppscotch — лёгкий инструмент для тестирования API, похожий на Postman, но работающий в браузере и очень удобный для разработки.
  • Фронтенд: http://localhost:3000
  • Прокси (для обхода CORS): http://localhost:9159
• RedisInsight предоставляет визуальный интерфейс для просмотра данных Redis. Интерфейс доступен по адресу: http://localhost:5540
• Mongo Express — веб-интерфейс для MongoDB. Откройте http://localhost:8081 и используйте учётные данные: admin:pass

Добавьте следующее в ваш docker-compose.yml:

develop/docker-compose.yml

develop/docker-compose.yml

# services: 
  # Overleaf Dev Containers
  # ...
  
  # Add those for your development
  # API debug
  hoppscotch-frontend:
    image: hoppscotch/hoppscotch-frontend:latest
    ports:
      - "3000:3000"

  hoppscotch-proxy:
    image: hoppscotch/proxyscotch:latest
    environment:
      - PORT=9159
    ports:
      - "9159:9159"

  # Redis-insight
  redis-insight:
    image: redislabs/redisinsight:latest
    ports:
      - "5540:5540"
    depends_on:
      - redis
    volumes:
      - ./data/redis-insight:/data

  # mongo-express
  # basicAuth credentials are "admin:pass"
  mongo-express:
    image: mongo-express
    ports:
      - "8081:8081"
    environment:
      ME_CONFIG_MONGODB_SERVER: mongo

​

Настройка Hoppscotch

​

Проксирование API-запросов

Чтобы настроить Hoppscotch, откройте http://localhost:3000 и перейдите на вкладку настроек. Укажите в поле Proxy адрес http://localhost:9159, чтобы инструменты отладки могли взаимодействовать с внутренними сетями контейнеров.

Теперь можно отправить запрос на http://web:3000/status, чтобы проверить, работает ли web:

​

Проблемы с CSRF

Если вы используете Postman или другие инструменты отладки для отправки POST-запроса, вход может оказаться запрещён с ошибкой 401. Это происходит потому, что Overleaf защищён проверкой CSRF.

В консоли вы можете увидеть:

Чтобы решить эту проблему при разработке Overleaf, нужно настроить CSRF-токен. Ниже приведена подробная инструкция.

1. Добавьте Pre-Request

   Добавьте следующий код в Pre-Request

   

   Скрипт выглядит так:

   pm.sendRequest("http://web:3000/dev/csrf", function (err, res) {
       if (err) {
           console.log(err);
           return;
       }
   
       // 1) Save CSRF token (/dev/csrf)
       const token = res.text().trim();
       pw.env.set("csrftoken", token);
       console.log("csrftoken =", token);
   
       const setCookieHeader = (res.headers || []).find(h => h.key?.toLowerCase() === "set-cookie")?.value;
       console.log("set-cookie =", setCookieHeader);
   
       if (!setCookieHeader) return;
   
       const cookiePair = setCookieHeader.split(";")[0].trim(); // overleaf.sid=...
       pw.env.set("cookie_header", cookiePair);
       console.log("cookie_header =", cookiePair);
   });
   
2. Добавьте заголовки запроса

   Необходимо добавить следующие заголовки:

   Имя заголовка	Значение заголовка
   Content-Type	application/json
   X-Csrf-Token	<<csrftoken>>
   Cookie	<<cookie_header>>

   
3. Войдите с помощью инструментов API

   Теперь можно войти, используя имя пользователя и пароль.

   {
     "_csrf": "<<csrftoken>>",
     "email": "[e-mail]",
     "password": "xxxxxx"
   }
   

   Так выглядит ответ, если введены неверные имя пользователя или пароль.