File `bolt.db` created at root of the project upgrading from 1.9 to 1.10

[gremo]

What happened?

Using the Docker image. When upgrading from 1.9 to .10 a new file called bolt.db is created at the root of the project. The file isn't created with 1.9.

What is it, and how can I prevent this file from being generated?

My Caddyfile is mounted over the FrankenPHP one:

services:
    php:
        build:
            target: frankenphp_dev
        volumes:
            - './config/docker/Caddyfile:/etc/frankenphp/Caddyfile'

{
	skip_install_trust 

	{$CADDY_GLOBAL_OPTIONS}

	frankenphp {
		{$FRANKENPHP_CONFIG}
	}
}

{$CADDY_EXTRA_CONFIG} 

{$SERVER_NAME:localhost} {
	log {
		{$CADDY_SERVER_LOG_OPTIONS}
		# Redact the authorization query parameter that can be set by Mercure
		format filter {
			request>uri query {
				replace authorization REDACTED
			}
		}
	}

	root /app/public
	encode zstd br gzip

	mercure {
		# Transport to use (default to Bolt)
		transport_url {$MERCURE_TRANSPORT_URL:bolt:///data/mercure.db}
		# Publisher JWT key
		publisher_jwt {env.MERCURE_PUBLISHER_JWT_KEY} {env.MERCURE_PUBLISHER_JWT_ALG}
		# Subscriber JWT key
		subscriber_jwt {env.MERCURE_SUBSCRIBER_JWT_KEY} {env.MERCURE_SUBSCRIBER_JWT_ALG}
		# Allow anonymous subscribers (double-check that it's what you want)
		anonymous
		# Enable the subscription API (double-check that it's what you want)
		subscriptions
		# Extra directives
		{$MERCURE_EXTRA_DIRECTIVES}
	}

	{$CADDY_SERVER_EXTRA_DIRECTIVES}

	# Disable Topics tracking if not enabled explicitly: https://github.com/jkarlin/topics
	header ?Permissions-Policy "browsing-topics=()"

	@phpRoute {
		not path /.well-known/mercure*
		not file {path}
	}
	rewrite @phpRoute index.php

	@frontController path index.php
	php @frontController

	file_server {
		precompressed zstd br gzip
		hide *.php
	}
}

My Dockerfile:

ARG FRANKENPHP_TAG=latest

# Franken base stage
################################################################################
FROM dunglas/frankenphp:1.10-$FRANKENPHP_TAG AS frankenphp_base
SHELL ["/bin/bash", "-euxo", "pipefail", "-c"]

ARG NODE_VERSION=
ENV COMPOSER_ALLOW_SUPERUSER=1

RUN \
    # Install OS packages
    apt-get update; \
    apt-get -y --no-install-recommends install \
        brotli \
        libnss3-tools \
        supervisor \
        unzip \
        zstd \
    ; \
    # Configure OS
    sed -i '/^exec "\$@"/i if [ "$1" = "frankenphp" ] && [ "$APP_ENV" = "prod" ] && php bin/console --raw | grep -q "^doctrine:migrations:migrate"; then\n	php bin/console doctrine:migrations:migrate --allow-no-migration --no-interaction --no-ansi\nfi\n' /usr/local/bin/docker-php-entrypoint; \
    sed -i '/\[supervisord\]/a user=root' /etc/supervisor/supervisord.conf; \
    sed -i '/\[supervisord\]/a nodaemon=true' /etc/supervisor/supervisord.conf; \
    # Install PHP extensions
    install-php-extensions \
        @composer \
        apcu \
        bcmath \
        calendar \
        gd \
        intl \
        opcache \
        pdo_mysql \
        redis \
        xsl \
        zip \
    ; \
    # Configure PHP
    { \
        echo apc.enable_cli = 1; \
        echo memory_limit = 256M; \
        echo opcache.interned_strings_buffer = 16; \
        echo opcache.max_accelerated_files = 20000; \
        echo opcache.memory_consumption = 256; \
        echo realpath_cache_ttl = 600; \
        echo session.use_strict_mode = 1; \
        echo zend.detect_unicode = 0; \
    } >> "$PHP_INI_DIR/conf.d/10-php.ini"; \
    # Install Node.js
    if [ -n "$NODE_VERSION" ]; then \
        curl -fsSL "https://deb.nodesource.com/setup_$NODE_VERSION.x" | bash -; \
        apt-get install -y --no-install-recommends nodejs; \
        npm install -g yarn; \
    fi; \
    # Cleanup
    apt-get clean; \
    rm -rf /var/lib/apt/lists/*

# Franken dev stage
################################################################################
FROM frankenphp_base AS frankenphp_dev
SHELL ["/bin/bash", "-euxo", "pipefail", "-c"]

RUN \
    # Install OS packages
    apt-get update; \
    apt-get -y --no-install-recommends install \
        git \
        gnupg2 \
        openssh-client \
    ; \
    # Configure OS
    mkdir -p ~/.ssh \
    chmod 700 ~/.ssh; \
    echo -e "Host *\n  StrictHostKeyChecking no\n  UserKnownHostsFile=/dev/null" > ~/.ssh/config; \
    chmod 600 ~/.ssh/config; \
    # Configure PHP
    cp "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini"; \
    { \
        echo xdebug.client_host = host.docker.internal; \
    } >> "$PHP_INI_DIR/conf.d/10-php.ini"; \
    # Cleanup
    apt-get clean; \
    rm -rf /var/lib/apt/lists/*

Build Type

Docker (Debian Trixie)

Worker Mode

Yes

Operating System

GNU/Linux

CPU Architecture

x86_64

PHP configuration

Not relevant

Relevant log output

[henderkes]

I see

		# Transport to use (default to Bolt)
		transport_url {$MERCURE_TRANSPORT_URL:bolt:///data/mercure.db}

I think the option was changed to just transport. You should have (had?) deprecation notices in your logs.

However, I don't think the old option was removed yet and it would just fail if it were... so I don't know how that could happen, short of MERCURE_TRANSPORT_URL having been defined at time of running.

[gremo]

@henderkes hey thanks for the response. I can still see transport_url https://github.com/php/frankenphp/blob/main/caddy/frankenphp/Caddyfile#L34

I'll check for the deprecations!

[henderkes]

Oop, that ought to be changed. I'll try to remember after SymfonyCon if nobody picks it up before.

[wizhippo]

I ran into this today too. Using "transport" did not solve it form me.

Is this the same as the "Bolt Adapter" mentioned https://mercure.rocks/docs/hub/config on?

Setting "path /data/mercure.db" under the mercure setting i now get a mercure.db file where I expect it but I still see the bolt.db created too in the working dir.

[ddattee]

Hi,

Setup close as the original message of this issue : Dockerfile based of of Frankenphp 1 alpine.

Same here, when I try setting up the transport using transport bolt:///data/mercure.db I get this error (tryed with 2 or 3 '/' same result) :

Error: adapting config using caddyfile: parsing caddyfile tokens for 'mercure': getting module named 'http.handlers.mercure.bolt:///data/mercure.db': module not registered: http.handlers.mercure.bolt:///data/mercure.db

And with a direct path same error which makes sens transport /data/mercure.db :

Error: adapting config using caddyfile: parsing caddyfile tokens for 'mercure': getting module named 'http.handlers.mercure./data/mercure.db': module not registered: http.handlers.mercure./data/mercure.db

And the transport_url directive is definetly not used anymore because when I try using it alone I get this, which basicaly says "there is no transport setup so I'll use default, trying to create the bold.db file where I stand but I don't have the permissions to create the db file" which is excpected because I don't want the db at the root of my project but in the volume I mount in /data :

Error: loading initial config: loading new config: loading http app module: provision http: server srv0: setting up route handlers: route 0: loading handler modules: position 0: loading module 'subroute': provision http.handlers.subroute: setting up subroutes: route 0: loading handler modules: position 4: loading module 'mercure': provision http.handlers.mercure: provision http.handlers.mercure.bolt: "": invalid transport: open bolt.db: permission denied

I might just be missing some documentation on how to configure transport but I based my tests on https://mercure.rocks/docs/hub/config

Thanks for the great work

[henderkes]

Hi,

Setup close as the original message of this issue : Dockerfile based of of Frankenphp 1 alpine.

Same here, when I try setting up the transport using transport bolt:///data/mercure.db I get this error (tryed with 2 or 3 '/' same result) :

Error: adapting config using caddyfile: parsing caddyfile tokens for 'mercure': getting module named 'http.handlers.mercure.bolt:///data/mercure.db': module not registered: http.handlers.mercure.bolt:///data/mercure.db

And with a direct path same error which makes sens transport /data/mercure.db :

Error: adapting config using caddyfile: parsing caddyfile tokens for 'mercure': getting module named 'http.handlers.mercure./data/mercure.db': module not registered: http.handlers.mercure./data/mercure.db

And the transport_url directive is definetly not used anymore because when I try using it alone I get this, which basicaly says "there is no transport setup so I'll use default, trying to create the bold.db file where I stand but I don't have the permissions to create the db file" which is excpected because I don't want the db at the root of my project but in the volume I mount in /data :

Error: loading initial config: loading new config: loading http app module: provision http: server srv0: setting up route handlers: route 0: loading handler modules: position 0: loading module 'subroute': provision http.handlers.subroute: setting up subroutes: route 0: loading handler modules: position 4: loading module 'mercure': provision http.handlers.mercure: provision http.handlers.mercure.bolt: "": invalid transport: open bolt.db: permission denied

I might just be missing some documentation on how to configure transport but I based my tests on https://mercure.rocks/docs/hub/config

Thanks for the great work

That's something entirely different, you must be compiling FrankenPHP manually without mercure?

[schuering]

I have solved it like this:

mercure {
		transport bolt {
			path /data/mercure.db
		}
		# Publisher JWT key
		publisher_jwt {env.MERCURE_PUBLISHER_JWT_KEY} {env.MERCURE_PUBLISHER_JWT_ALG}
		# Subscriber JWT key
		subscriber_jwt {env.MERCURE_SUBSCRIBER_JWT_KEY} {env.MERCURE_SUBSCRIBER_JWT_ALG}
		# Allow anonymous subscribers (double-check that it's what you want)
		anonymous
		# Enable the subscription API (double-check that it's what you want)
		subscriptions
		# Extra directives
		{$MERCURE_EXTRA_DIRECTIVES}
	}

[gremo]

Any update on this? How to prevent the file being created? Is this a bug or an intended feature? Thanks!

[henderkes]

It would be a bug, I don't know how this would even happen. I don't use Docker though so I haven't gotten around to replicating it yet.

[wizhippo]

Does look like a bug with legacy "transport_url" support.

"Legacy URL
This feature is deprecated: use the new transport directive instead."

I would migrate to using the new mercure transport configuration as @schuering shared #2034 (comment) will let you place the file correctly.