Tech Blog

Laravel SailでXdebugを有効にする

2021-02-13

Sailのカスタマイズ

ドキュメントにも書いている通りですが、 Sailをカスタマイズするには、sail:publishコマンドを実行します。

sail artisan sail:publish

これで、プロジェクトのルートにdockerディレクトリが作成され、 ./vendor/laravel/sail/runtimes/以下のディレクトリがコピーされます。

※ バージョンが最新ではない場合、注意が必要です。

https://github.com/laravel/sail/tree/1.x/runtimes の内容を確認し、適宜反映してください。

docker-compose.ymlの編集

services:
  laravel.test:
    build:
      context: ./vendor/laravel/sail/runtimes/8.0
      dockerfile: Dockerfile
      args:
        WWWGROUP: '${WWWGROUP}'
    image: sail-8.0/app

context:のパスを書き換えることで、PHPのバージョンが変更可能です。

利用しているPHPのバージョンのディレクトリを指定します。

php.iniの編集について

xdebug.modeとxdebug.client_hostは環境変数で設定可能なため、docker-compose.ymlのenvironmentに設定します。

# For more information: https://laravel.com/docs/sail
version: '3'
services:
    laravel.test:
        build:
            context: ./vendor/laravel/sail/runtimes/8.0
            dockerfile: Dockerfile
            args:
                WWWGROUP: '${WWWGROUP}'
        image: sail-8.0/app
        extra_hosts:
            - 'host.docker.internal:host-gateway'
        ports:
            - '${APP_PORT:-80}:80'
        environment:
            WWWUSER: '${WWWUSER}'
            LARAVEL_SAIL: 1
            XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
            XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
        volumes:
            - '.:/var/www/html'
        networks:
            - sail
        depends_on:
            - mysql
    mysql:
        image: mysql:5.7
        ports:
            - '${FORWARD_DB_PORT:-3306}:3306'
        environment:
            MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
            MYSQL_DATABASE: '${DB_DATABASE}'
            MYSQL_USER: '${DB_USERNAME}'
            MYSQL_PASSWORD: '${DB_PASSWORD}'
            MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
        volumes:
            - 'sailmysql:/var/lib/mysql'
        networks:
            - sail
        healthcheck:
            test: ["CMD", "mysqladmin", "ping", "-p${DB_PASSWORD}"]
            retries: 3
            timeout: 5s
    mailhog:
        image: 'mailhog/mailhog:latest'
        ports:
            - '${FORWARD_MAILHOG_PORT:-1025}:1025'
            - '${FORWARD_MAILHOG_DASHBOARD_PORT:-8025}:8025'
        networks:
            - sail
networks:
    sail:
        driver: bridge
volumes:
    sailmysql:
        driver: local

.envに以下を追記します。

SAIL_XDEBUG_MODE=develop,debug

dockerディレクトリの確認

https://github.com/laravel/sail/tree/1.x/runtimes/8.0 のデフォルトの内容に合わせておきます。

最新のsailではxdebugがデフォルトで有効になるようになってあります。

（php8.0-xdebugが含まれる）

参考: https://xdebug.org/docs/install

コンテナを再構築

変更を反映させるため、コンテナを再構築します。

sail down
sail build --no-cache
sail up -d

確認

sail shell
sail@414d0d2b4215:/var/www/htmlphp -m | grep xdebug

ブラウザでデバッグする場合

xdebug.start_with_requestの値がyesではないので、

ブラウザからデバッグする場合は、xdebug用の各種ブラウザの拡張を入れる必要があります。

https://www.jetbrains.com/help/phpstorm/browser-debugging-extensions.html

PhpStormの設定

Preferences > PHP > Server の Use path mappingsが有効になっている必要があります。

また、Absolute path on the server の値を/var/www/htmlに設定します。