Débugger vos requêtes HTTP en une ligne plutôt que mille

Nous gérons pour nos clients des centaines de plateformes, il nous arrive donc souvent de devoir assister au débogage ce qui peut impliquer de valider si les réponses d'un site/API sont bien cohérentes avec les requêtes qu'il reçoit.

Si le gros du travail de débogage se fait du côté de la réponse, il est parfois utile de vérifier en premier lieu que la requête est correctement formée.

Dans notre cas on cherchait à débugger une réponse passant par une série de proxies (Apache et Nginx), et on voulait vérifier que différents éléments étaient bien transmis de proxy en proxy (headers d'authentification, URI, paramètres, etc.) dont certains ne se retrouvent pas dans les logs du serveur HTTP.

Tout ce travail de débogage peut aussi être utile au développeur qui travaille sur son API (pour les mêmes raisons que nous) ou avec une API tiers pour vérifier que les appels partants de son code sont bien formés selon les spécifications de cette API.

Voyons ensemble comment debugger nos appels via un serveur qui répondra à chaque requête son contenu (on l'appellera "echo").

TL;DR

L'idée de départ de ce post est de simplifier cet outil qui s'est trouvé très utile lors d'une séance de debug: Docker http/https echo.

En une ligne plutôt que mille :

print_r($_SERVER); 

Le kit de débogage

Pour une mise en place rapide de ce kit de débogage, partons de nos images docker. Voici l'arborescence nécessaire :

|____docker-compose.yml
                |____echo
                | |____Dockerfile
                | |____echo.php
                |____nginx-echo.conf

On y trouve le 'docker-compose.yml' contenant simplement un conteneur nginx (qui servira sur 'localhost:8000') et un conteneur PHP :

services:
                  nginx:
                    image: bearstech/nginx
                    container_name: echo-nginx
                    restart: unless-stopped
                    volumes:
                      - ./nginx-echo.conf:/etc/nginx/conf.d/default.conf
                    ports:
                      - 127.0.0.1:8000:80
                  php:
                    build: ./echo
                    container_name: echo-php
                    restart: unless-stopped

La configuration nginx utilisée est minimale et fait simplement appel au conteneur PHP en utilisant toujours le même script :

server {
                   listen         80;
                   root /var/www/default/;
                   location / {
                      include fastcgi_params;
                      fastcgi_pass echo-php:9000;
                      fastcgi_param SCRIPT_FILENAME /var/www/default/echo.php;
                   }
                }

L'image PHP est buildée depuis le dossier 'echo' qui contient le Dockerfile nécessaire :

FROM bearstech/php:8.2
                ARG uid=1001
                RUN useradd echo --uid $uid --shell /bin/bash --home /var/www
                COPY echo.php /var/www/default/echo.php
                WORKDIR /var/www
                RUN chown -R $uid.$uid /var/www
                USER echo

ainsi que le fichier echo.php :

<?php print('toto'); ?>

Avec cela en place, on lance simplement :

$ docker-compose up --build

                        $ curl -H 'My-Super-Header: my-header-value' "127.0.0.1:8000/my-uri?my-param=my-param-value"
                                Array
                                (
                                    [HOSTNAME] => e2880d12e72e
                                    [PHP_VERSION] => 8.2
                                    [PWD] => /var/www
                                    [HOME] => /var/www
                                    [LANG] => en_US.UTF-8
                                    [SHLVL] => 0
                                    [PATH] => /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
                                    [DEBIAN_FRONTEND] => noninteractive
                                    [USER] => echo
                                    [HTTP_MY_SUPER_HEADER] => my-header-value
                                    [HTTP_ACCEPT] => */*
                                    [HTTP_USER_AGENT] => curl/8.4.0
                                    [HTTP_HOST] => 127.0.0.1:8000
                                    [SCRIPT_FILENAME] => /var/www/default/echo.php
                                    [REDIRECT_STATUS] => 200
                                    [SERVER_NAME] => 
                                    [SERVER_PORT] => 80
                                    [SERVER_ADDR] => 172.21.0.3
                                    [REMOTE_USER] => 
                                    [REMOTE_PORT] => 39722
                                    [REMOTE_ADDR] => 172.21.0.1
                                    [SERVER_SOFTWARE] => nginx/1.18.0
                                    [GATEWAY_INTERFACE] => CGI/1.1
                                    [REQUEST_SCHEME] => http
                                    [SERVER_PROTOCOL] => HTTP/1.1
                                    [DOCUMENT_ROOT] => /var/www/default
                                    [DOCUMENT_URI] => /my-uri
                                    [REQUEST_URI] => /my-uri?my-param=my-param-value
                                    [SCRIPT_NAME] => /my-uri
                                    [CONTENT_LENGTH] => 
                                    [CONTENT_TYPE] => 
                                    [REQUEST_METHOD] => GET
                                    [QUERY_STRING] => my-param=my-param-value
                                    [FCGI_ROLE] => RESPONDER
                                    [PHP_SELF] => /my-uri
                                    [REQUEST_TIME_FLOAT] => 1700665959.4737
                                    [REQUEST_TIME] => 1700665959
                                )