Using --watch with Laravel Octane, causes browser request to stay in waiting state

Open francoism90 opened this issue 1 year ago • 3 comments

What happened?

I'm using the following supervisor command to start FrankenPHP for development:

FROM docker.io/dunglas/frankenphp:php8.4-alpine

ARG UID=1000
ARG GID=$UID

ENV TZ=UTC
ENV SERVER_NAME="localhost:8080"
ENV PHP_INI_SCAN_DIR="${PHP_INI_DIR}/conf.d"
ENV SUPERVISOR_PHP_COMMAND="php -d variables_order=EGPCS /app/artisan octane:frankenphp --host=localhost --port=8080 --admin-port=2019 --caddyfile /etc/caddy/Caddyfile --watch"
ENV SUPERVISOR_PHP_USER="www-data"

WORKDIR /app

RUN ln -snf /usr/share/zoneinfo/${TZ} /etc/localtime \
    && echo ${TZ} > /etc/timezone

RUN apk update --no-cache \
    && apk upgrade --no-cache

RUN apk add --no-cache --virtual .build-deps ${PHPIZE_DEPS} \
    shadow \
    alpine-sdk \
    linux-headers \
    python3 \
    libcap

RUN usermod --non-unique --uid ${UID} www-data \
    && groupmod --non-unique --gid ${GID} www-data

RUN apk add --no-cache --virtual .run-deps \
    gnupg \
    curl \
    wget \
    nano \
    git \
    tzdata \
    nss-tools \
    ca-certificates \
    libsodium-dev \
    sqlite \
    supervisor \
    mariadb-client \
    postgresql-client \
    minio-client \
    nodejs \
    npm \
    fdk-aac \
    ffmpeg \
    gifsicle \
    gsm \
    jpegoptim \
    lame \
    libass \
    libavif \
    libogg \
    libpng \
    librsvg \
    libtheora \
    libva \
    libvdpau \
    libvorbis \
    libvpx \
    libwebp \
    numactl \
    opencore-amr \
    openjpeg \
    optipng \
    pngquant \
    speex \
    unzip \
    x264 \
    x265 \
    xvidcore \
    yarn \
    zip

RUN yarn global add svgo

RUN cp ${PHP_INI_DIR}/php.ini-development ${PHP_INI_DIR}/php.ini

RUN install-php-extensions \
    @composer \
    apcu \
    bcmath \
    bz2 \
    event \
    exif \
    ffi \
    intl \
    mbstring \
    msgpack \
    opcache \
    pcntl \
    pcov \
    pdo_mysql \
    pdo_pgsql \
    pgsql \
    redis \
    sockets \
    uv \
    zip \
    igbinary \
    gd

COPY --chown=${UID}:${GID} runtimes/php-development.ini ${PHP_INI_DIR}/conf.d/99-user.ini
COPY --chown=${UID}:${GID} runtimes/Caddyfile /etc/caddy/Caddyfile
COPY --chown=${UID}:${GID} runtimes/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
COPY --chown=${UID}:${GID} runtimes/start-container /usr/local/bin/start-container

RUN setcap -r /usr/local/bin/frankenphp
RUN chown -R ${UID}:${GID} /data/caddy && chown -R ${UID}:${GID} /config/caddy
RUN chmod +x /usr/local/bin/start-container

RUN apk del .build-deps \
    && docker-php-source delete \
    && rm -rf /var/cache/apk/* /tmp/* /var/tmp/*

USER ${UID}

EXPOSE 8080
EXPOSE 8443
EXPOSE 2019
EXPOSE 5173
EXPOSE 6001

ENTRYPOINT ["start-container"]

For some reason, changing any PHP file causes FrankenPHP to not push the new state. It seems to refresh the workers internally, but the browser keeps waiting for 'something'. If I click the browser's refresh-button, it works fine. If I change .vue or any other resources, it works fine using hot-reloading.

Maybe I don't need the --watch parameter? The Laravel Docs, suggest the following parameters instead: --workers=1 --max-requests=1, but also this seem to also cause a hang (wait) requests.

For some reason I also need to run php artisan octane:reload sometimes. Like it doesn't fully refresh the changes.

Could you please tell me the correct parameters to use this for development? I think it's a bug, because it seem to work correctly a release ago. I did this this in Brave and Firefox, both the latest version.

Build Type

Custom (tell us more in the description)

Worker Mode

Yes

Operating System

GNU/Linux

CPU Architecture

x86_64

PHP configuration

Relevant log output

INFO  Application change detected. Restarting workers….

This is shown, but no GET request is later shown.. unless I manually restart the server.

Dec 26 '24 14:12 francoism90

Hmm, could it be an issue with supervisor?

I have removed the stopasgroup and killasgroup options, and this seems to improve the reloading:

[supervisord]
nodaemon=true
user=%(ENV_SUPERVISOR_PHP_USER)s
logfile=/dev/null
logfile_maxbytes=0
logfile_backups=0
pidfile=/tmp/supervisord.pid
minfds=10000

[unix_http_server]
file=/tmp/supervisor.sock
chmod=0777

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock

[rpcinterface:supervisor]
supervisor.rpcinterface_factory=supervisor.rpcinterface:make_main_rpcinterface

[program:octane]
command=%(ENV_SUPERVISOR_PHP_COMMAND)s
user=%(ENV_SUPERVISOR_PHP_USER)s
environment=LARAVEL_OCTANE="1"
autostart=true
autorestart=true
priority=100
stopwaitsecs=3600
redirect_stderr=true
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0

[program:reverb]
command=php -d variables_order=EGPCS /app/artisan reverb:start
user=%(ENV_SUPERVISOR_PHP_USER)s
autostart=true
autorestart=true
priority=200
stopwaitsecs=3600
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0

[program:horizon]
command=php -d variables_order=EGPCS /app/artisan horizon
user=%(ENV_SUPERVISOR_PHP_USER)s
autostart=true
autorestart=true
priority=300
stopwaitsecs=3600
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0

[program:schedule]
command=php -d variables_order=EGPCS /app/artisan schedule:work
user=%(ENV_SUPERVISOR_PHP_USER)s
autostart=true
autorestart=true
priority=400
stopwaitsecs=3600
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0

To start FrankenPHP in the container:

php -d variables_order=EGPCS /app/artisan octane:frankenphp --caddyfile=/etc/caddy/Caddyfile --host=localhost --port=8080 --admin-port=2019 --workers=1 --max-requests=1 --watch

I'm now limiting both the works to 1 and using the watch flag.

Dec 26 '24 14:12 francoism90

I think Laravel Octane uses chokidar for worker reloading. Have you tried using the new built in watcher instead? You'll need to configure 'watch' in your own Caddyfile, but it will reload more gracefully .

Dec 26 '24 15:12 AlliBalliBaba

@AlliBalliBaba Thanks! I did read about this, but in another issue it wasn't advised for Laravel Octane, and reload using --watch instead?

I have disabled all caches, including opcache, and that also seems to help as well.

Weird, if you do recommend the new watcher, I'll check it out instead. :)

Dec 26 '24 17:12 francoism90