Kehitystyökalujen käyttöönotto

​

Suositellut kehitystyökalut

Nämä valinnaiset palvelut eivät ole välttämättömiä Overleafin ajamiseen, mutta niitä suositellaan vahvasti kehitykseen, virheenjäljitykseen ja tarkasteluun paikallisen kehityksen aikana.

• Hoppscotch on kevyt, Postmanin kaltainen API-testaustyökalu, joka toimii selaimessa ja on erittäin kätevä kehityksessä.
  • Käyttöliittymä: http://localhost:3000
  • Välityspalvelin (CORS-rajoitusten ohittamiseen): http://localhost:9159
• RedisInsight tarjoaa visuaalisen käyttöliittymän Redis-datan tarkasteluun. Käyttöliittymä on saatavilla osoitteessa: http://localhost:5540
• Mongo Express on verkkopohjainen käyttöliittymä MongoDB:lle. Voit käyttää sitä osoitteessa http://localhost:8081 tunnuksilla: admin:pass

Lisää seuraava tiedostoon 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

​

Hoppscotchin käyttöönotto

​

API-pyyntöjen välitys

Ota Hoppscotch käyttöön avaamalla http://localhost:3000 ja siirtymällä asetusvälilehdelle. Aseta Proxy-arvoksi http://localhost:9159, jotta virheenjäljitystyökalusi voivat kommunikoida konttien sisäisten verkkojen kanssa.

Nyt voit testata osoitteella http://web:3000/status, onko web-palvelu käynnissä:

​

CSRF-ongelmat

Jos luot POST-pyynnön Postmanilla tai muulla virheenjäljitystyökalulla, saatat huomata, että kirjautuminen on estetty ja syynä on 401-virhe. Tämä johtuu siitä, että Overleaf on suojattu CSRF-tarkistuksella.

Konsolissa saatat nähdä:

Jotta voit käsitellä tämän Overleaf-kehityksessä, sinun on määritettävä CSRF-tunniste. Tässä on yksityiskohtainen ohje.

1. Lisää esipyyntö

   Lisää seuraava koodi kohtaan Pre-Request

   

   Skripti on seuraava:

   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. Lisää pyyntöotsakkeet

   Sinun on lisättävä seuraavat otsakkeet:

   Otsakkeen nimi	Otsakkeen arvo
   Content-Type	application/json
   X-Csrf-Token	<<csrftoken>>
   Cookie	<<cookie_header>>

   
3. Kirjaudu sisään API-työkaluilla

   Nyt voit kirjautua sisään käyttäjänimelläsi ja salasanallasi.

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

   Alla on vastaus, kun syötät väärän käyttäjänimen tai salasanan.