Konfiguracja narzędzi deweloperskich

​

Zalecane narzędzia deweloperskie

Te opcjonalne usługi nie są wymagane do uruchomienia Overleaf, ale są wysoce zalecane do rozwoju, debugowania i inspekcji podczas lokalnej pracy deweloperskiej.

• Hoppscotch to lekkie narzędzie do testowania API podobne do Postmana, ale działające w przeglądarce i bardzo wygodne w pracy deweloperskiej.
  • Frontend: http://localhost:3000
  • Proxy (do obejścia CORS): http://localhost:9159
• RedisInsight zapewnia wizualny interfejs do przeglądania danych Redis. Interfejs dostępny pod adresem: http://localhost:5540
• Mongo Express to webowy interfejs dla MongoDB. Możesz odwiedzić http://localhost:8081, używając danych logowania: admin:pass

Dodaj poniższą konfigurację do swojego pliku 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

​

Konfiguracja Hoppscotch

​

Przekierowanie żądań API przez proxy

Aby skonfigurować Hoppscotch, odwiedź http://localhost:3000, a następnie przejdź do karty ustawień. Ustaw Proxy na http://localhost:9159, aby narzędzia debugowania mogły komunikować się z wewnętrznymi sieciami kontenerów.

Teraz możesz wykonać test z użyciem http://web:3000/status, aby sprawdzić, czy usługa web działa:

​

Problemy z CSRF

Jeśli używasz Postmana lub innych narzędzi debugowania do wygenerowania żądania POST, może się okazać, że logowanie jest zabronione, a przyczyną jest błąd 401. Dzieje się tak, ponieważ Overleaf jest chroniony weryfikacją CSRF.

W konsoli możesz zobaczyć:

Aby poradzić sobie z tym podczas pracy nad Overleaf, musisz skonfigurować token CSRF. Oto szczegółowa instrukcja.

1. Dodaj skrypt Pre-Request

   Dodaj poniższy kod w sekcji Pre-Request

   

   Skrypt wygląda następująco:

   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. Dodaj nagłówki żądania

   Musisz dodać następujące nagłówki:

   Nazwa nagłówka	Wartość nagłówka
   Content-Type	application/json
   X-Csrf-Token	<<csrftoken>>
   Cookie	<<cookie_header>>

   
3. Zaloguj się za pomocą narzędzi API

   Teraz możesz zalogować się, używając swojej nazwy użytkownika i hasła.

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

   Oto odpowiedź w przypadku podania błędnej nazwy użytkownika lub hasła.