Set up the PHP-SPX UI for out of the box profiling (#454)

Author: PrinsFrank

CONTRIBUTING.md

@@ -16,6 +16,14 @@ To profile how a specific PDF is being parsed, you can run the parser with SPX_E
 docker compose exec -e SPX_ENABLED=1 php vendor/bin/phpunit tests/Samples/ --filter "gdocs-image-simple"
 ```
 
+If you want a more detailed profile, you can run the following command:
+
+```bash
+docker compose exec -e SPX_ENABLED=1 -e SPX_REPORT=full php vendor/bin/phpunit tests/Samples/ --filter "gdocs-image-simple"
+```
+
+you can then head to http://localhost, scroll down to the last run and click on it to view the full profile.
+
 ## Acquiring the specification document
 
 Because the specification document is not freely available, it cannot be included in this repository directly. The specification document is downloadable on two different places:

compose.yml

@@ -5,5 +5,8 @@ services:
     container_name: php
     volumes:
       - ./:/app
+      - ./docker/php.ini:/usr/local/etc/php/conf.d/99-custom.ini
     working_dir: /app
-    command: sleep infinity
+    command: php -S 0.0.0.0:80 -t /app /opt/spx/spx.php
+    ports:
+      - "80:80"

docker/Dockerfile

@@ -15,7 +15,7 @@ RUN apk add --no-cache --virtual .build-deps \
     && docker-php-ext-configure gd --with-freetype --with-jpeg \
     && docker-php-ext-install gd \
     && pie install noisebynorthwest/php-spx \
-    && mkdir -p /opt/spx && echo '<?php declare(strict_types=1);' > /opt/spx/spx.php \
+    && mkdir -p /opt/spx && echo "<?php declare(strict_types=1); if (!isset(\$_GET['SPX_KEY']) && !isset(\$_GET['SPX_UI_URI']) && !isset(\$_GET['SPX_ENABLED'])) {header('Location: /?SPX_KEY=dev&SPX_UI_URI=/'); exit;}" > /opt/spx/spx.php \
     && apk del .build-deps \
     && rm -rf /tmp/* /var/tmp/* /var/cache/apk/* /usr/bin/pie
 

docker/php.ini

@@ -0,0 +1,4 @@
+spx.data_dir=/tmp
+spx.http_enabled=1
+spx.http_key=dev
+spx.http_ip_whitelist=*