Vulcain encoding issue due to Caddy configuration

[elliotbruneel]

Hello,

I think it missing the order part in caddyfile to fix encoding issue.

For the example, apip-demo works fine: https://github.com/api-platform/demo/blob/4.1/api/frankenphp/Caddyfile#L10-L11

maybe we should add theses lines to the starter ?

order vulcain after reverse_proxy
order php_server before file_server

[7-zete-7]

Hi @elliotbruneel!

According to the php/frankenphp#832, this orders directive is no longer needed.

Please provide more details about the encoding issue.

[elliotbruneel]

hi @7-zete-7

maybe it's a frankenphp issue ?

With a fresh install with this controller

<?php

namespace App\Controller;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Routing\Attribute\Route;

class TestController extends AbstractController
{

    #[Route('/api/test')]
    public function test(): JsonResponse
    {
        return $this->json([
            'message' => str_repeat('Long repeated message to reach minimal caddy encode length ', 20),
        ]);
    }
}

I got an encoding issue for this endpoint call: https://localhost/api/test?fields="/message/"

When i'm adding this directive to the Caddyfile global option it's working fine

order vulcain after reverse_proxy

[7-zete-7]

This could also be a problem with another module or a combination of modules.

Can you show the Caddy JSON configuration before and after adding order?

What value does the Content-Encoding response header give you in the response on the screenshot?

[elliotbruneel]

Caddyfile with encoding issue

{
	skip_install_trust

	{$CADDY_GLOBAL_OPTIONS}

	frankenphp {
		{$FRANKENPHP_CONFIG}

		worker {
			file ./public/index.php
			env APP_RUNTIME Runtime\FrankenPhpSymfony\Runtime
			{$FRANKENPHP_WORKER_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 {
		# 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}
	}

	vulcain

	{$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 {
		hide *.php
	}
}

And the Caddyfile without encoding issue

{
	skip_install_trust

	{$CADDY_GLOBAL_OPTIONS}

	frankenphp {
		{$FRANKENPHP_CONFIG}

		worker {
			file ./public/index.php
			env APP_RUNTIME Runtime\FrankenPhpSymfony\Runtime
			{$FRANKENPHP_WORKER_CONFIG}
		}
	}
	order vulcain after reverse_proxy
}

{$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 {
		# 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}
	}

	vulcain

	{$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 {
		hide *.php
	}
}

The content-encoding response header is zstd

I can push my repository if you want

[7-zete-7]

Caddy JSON configuration (see https://caddyserver.com/docs/json/#docs), not Caddyfile. You can get JSON configuration for Caddyfile with the following command:

docker compose exec php frankenphp adapt -c /etc/frankenphp/Caddyfile --pretty

Or read the file /config/caddy/autosave.json from the container:

docker compose exec php cat /config/caddy/autosave.json

[7-zete-7]

Got Caddy JSON config on my project with and without order vulcain after reverse_proxy. As a result I got this change in order of array apps.http.servers.srv0.routes[0].handle[0].routes[2].handle:

-vulcain
 encode
 mercure
+vulcain

Caddy JSON config without order

{
        "logging": {
                "logs": {
                        "default": {
                                "exclude": [
                                        "http.log.access.log0"
                                ]
                        },
                        "log0": {
                                "encoder": {
                                        "fields": {
                                                "request\u003euri": {
                                                        "actions": [
                                                                {
                                                                        "parameter": "authorization",
                                                                        "type": "replace",
                                                                        "value": "REDACTED"
                                                                }
                                                        ],
                                                        "filter": "query"
                                                }
                                        },
                                        "format": "filter"
                                },
                                "include": [
                                        "http.log.access.log0"
                                ]
                        }
                }
        },
        "apps": {
                "frankenphp": {
                        "workers": [
                                {
                                        "file_name": "./public/index.php",
                                        "env": {
                                                "APP_RUNTIME": "Runtime\\FrankenPhpSymfony\\Runtime"
                                        },
                                        "watch": [
                                                "./**/*.{php,yaml,yml,twig,env}"
                                        ]
                                }
                        ]
                },
                "http": {
                        "servers": {
                                "srv0": {
                                        "listen": [
                                                ":80"
                                        ],
                                        "routes": [
                                                {
                                                        "match": [
                                                                {
                                                                        "host": [
                                                                                "localhost"
                                                                        ]
                                                                }
                                                        ],
                                                        "handle": [
                                                                {
                                                                        "handler": "subroute",
                                                                        "routes": [
                                                                                {
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "vars",
                                                                                                        "root": "/app/public"
                                                                                                },
                                                                                                {
                                                                                                        "handler": "headers",
                                                                                                        "response": {
                                                                                                                "require": {
                                                                                                                        "headers": {
                                                                                                                                "Permissions-Policy": null
                                                                                                                        }
                                                                                                                },
                                                                                                                "set": {
                                                                                                                        "Permissions-Policy": [
                                                                                                                                "browsing-topics=()"
                                                                                                                        ]
                                                                                                                }
                                                                                                        }
                                                                                                }
                                                                                        ]
                                                                                },
                                                                                {
                                                                                        "group": "group0",
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "rewrite",
                                                                                                        "uri": "index.php"
                                                                                                }
                                                                                        ],
                                                                                        "match": [
                                                                                                {
                                                                                                        "not": [
                                                                                                                {
                                                                                                                        "path": [
                                                                                                                                "/.well-known/mercure*"
                                                                                                                        ]
                                                                                                                },
                                                                                                                {
                                                                                                                        "file": {
                                                                                                                                "try_files": [
                                                                                                                                        "{http.request.uri.path}"
                                                                                                                                ]
                                                                                                                        }
                                                                                                                }
                                                                                                        ]
                                                                                                }
                                                                                        ]
                                                                                },
                                                                                {
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "vulcain"
                                                                                                },
                                                                                                {
                                                                                                        "encodings": {
                                                                                                                "br": {},
                                                                                                                "gzip": {},
                                                                                                                "zstd": {}
                                                                                                        },
                                                                                                        "handler": "encode",
                                                                                                        "prefer": [
                                                                                                                "zstd",
                                                                                                                "br",
                                                                                                                "gzip"
                                                                                                        ]
                                                                                                },
                                                                                                {
                                                                                                        "demo": true,
                                                                                                        "handler": "mercure",
                                                                                                        "publisher_jwt": {
                                                                                                                "alg": "{env.MERCURE_PUBLISHER_JWT_ALG}",
                                                                                                                "key": "{env.MERCURE_PUBLISHER_JWT_KEY}"
                                                                                                        },
                                                                                                        "subscriber_jwt": {
                                                                                                                "alg": "{env.MERCURE_SUBSCRIBER_JWT_ALG}",
                                                                                                                "key": "{env.MERCURE_SUBSCRIBER_JWT_KEY}"
                                                                                                        },
                                                                                                        "transport_url": "bolt:///data/mercure.db"
                                                                                                }
                                                                                        ]
                                                                                },
                                                                                {
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "php"
                                                                                                }
                                                                                        ],
                                                                                        "match": [
                                                                                                {
                                                                                                        "path": [
                                                                                                                "index.php"
                                                                                                        ]
                                                                                                }
                                                                                        ]
                                                                                },
                                                                                {
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "file_server",
                                                                                                        "hide": [
                                                                                                                "*.php",
                                                                                                                "/etc/frankenphp/Caddyfile"
                                                                                                        ]
                                                                                                }
                                                                                        ]
                                                                                }
                                                                        ]
                                                                }
                                                        ],
                                                        "terminal": true
                                                }
                                        ],
                                        "trusted_proxies": {
                                                "ranges": [
                                                        "192.168.0.0/16",
                                                        "172.16.0.0/12",
                                                        "10.0.0.0/8",
                                                        "127.0.0.1/8",
                                                        "fd00::/8",
                                                        "::1"
                                                ],
                                                "source": "static"
                                        },
                                        "logs": {
                                                "logger_names": {
                                                        "localhost": [
                                                                "log0"
                                                        ]
                                                }
                                        }
                                }
                        }
                },
                "pki": {
                        "certificate_authorities": {
                                "local": {
                                        "install_trust": false
                                }
                        }
                }
        }
}

Caddy JSON config with order vulcain after reverse_proxy

{
        "logging": {
                "logs": {
                        "default": {
                                "exclude": [
                                        "http.log.access.log0"
                                ]
                        },
                        "log0": {
                                "encoder": {
                                        "fields": {
                                                "request\u003euri": {
                                                        "actions": [
                                                                {
                                                                        "parameter": "authorization",
                                                                        "type": "replace",
                                                                        "value": "REDACTED"
                                                                }
                                                        ],
                                                        "filter": "query"
                                                }
                                        },
                                        "format": "filter"
                                },
                                "include": [
                                        "http.log.access.log0"
                                ]
                        }
                }
        },
        "apps": {
                "frankenphp": {
                        "workers": [
                                {
                                        "file_name": "./public/index.php",
                                        "env": {
                                                "APP_RUNTIME": "Runtime\\FrankenPhpSymfony\\Runtime"
                                        },
                                        "watch": [
                                                "./**/*.{php,yaml,yml,twig,env}"
                                        ]
                                }
                        ]
                },
                "http": {
                        "servers": {
                                "srv0": {
                                        "listen": [
                                                ":80"
                                        ],
                                        "routes": [
                                                {
                                                        "match": [
                                                                {
                                                                        "host": [
                                                                                "localhost"
                                                                        ]
                                                                }
                                                        ],
                                                        "handle": [
                                                                {
                                                                        "handler": "subroute",
                                                                        "routes": [
                                                                                {
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "vars",
                                                                                                        "root": "/app/public"
                                                                                                },
                                                                                                {
                                                                                                        "handler": "headers",
                                                                                                        "response": {
                                                                                                                "require": {
                                                                                                                        "headers": {
                                                                                                                                "Permissions-Policy": null
                                                                                                                        }
                                                                                                                },
                                                                                                                "set": {
                                                                                                                        "Permissions-Policy": [
                                                                                                                                "browsing-topics=()"
                                                                                                                        ]
                                                                                                                }
                                                                                                        }
                                                                                                }
                                                                                        ]
                                                                                },
                                                                                {
                                                                                        "group": "group0",
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "rewrite",
                                                                                                        "uri": "index.php"
                                                                                                }
                                                                                        ],
                                                                                        "match": [
                                                                                                {
                                                                                                        "not": [
                                                                                                                {
                                                                                                                        "path": [
                                                                                                                                "/.well-known/mercure*"
                                                                                                                        ]
                                                                                                                },
                                                                                                                {
                                                                                                                        "file": {
                                                                                                                                "try_files": [
                                                                                                                                        "{http.request.uri.path}"
                                                                                                                                ]
                                                                                                                        }
                                                                                                                }
                                                                                                        ]
                                                                                                }
                                                                                        ]
                                                                                },
                                                                                {
                                                                                        "handle": [
                                                                                                {
                                                                                                        "encodings": {
                                                                                                                "br": {},
                                                                                                                "gzip": {},
                                                                                                                "zstd": {}
                                                                                                        },
                                                                                                        "handler": "encode",
                                                                                                        "prefer": [
                                                                                                                "zstd",
                                                                                                                "br",
                                                                                                                "gzip"
                                                                                                        ]
                                                                                                },
                                                                                                {
                                                                                                        "demo": true,
                                                                                                        "handler": "mercure",
                                                                                                        "publisher_jwt": {
                                                                                                                "alg": "{env.MERCURE_PUBLISHER_JWT_ALG}",
                                                                                                                "key": "{env.MERCURE_PUBLISHER_JWT_KEY}"
                                                                                                        },
                                                                                                        "subscriber_jwt": {
                                                                                                                "alg": "{env.MERCURE_SUBSCRIBER_JWT_ALG}",
                                                                                                                "key": "{env.MERCURE_SUBSCRIBER_JWT_KEY}"
                                                                                                        },
                                                                                                        "transport_url": "bolt:///data/mercure.db"
                                                                                                },
                                                                                                {
                                                                                                        "handler": "vulcain"
                                                                                                }
                                                                                        ]
                                                                                },
                                                                                {
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "php"
                                                                                                }
                                                                                        ],
                                                                                        "match": [
                                                                                                {
                                                                                                        "path": [
                                                                                                                "index.php"
                                                                                                        ]
                                                                                                }
                                                                                        ]
                                                                                },
                                                                                {
                                                                                        "handle": [
                                                                                                {
                                                                                                        "handler": "file_server",
                                                                                                        "hide": [
                                                                                                                "*.php",
                                                                                                                "/etc/frankenphp/Caddyfile"
                                                                                                        ]
                                                                                                }
                                                                                        ]
                                                                                }
                                                                        ]
                                                                }
                                                        ],
                                                        "terminal": true
                                                }
                                        ],
                                        "trusted_proxies": {
                                                "ranges": [
                                                        "192.168.0.0/16",
                                                        "172.16.0.0/12",
                                                        "10.0.0.0/8",
                                                        "127.0.0.1/8",
                                                        "fd00::/8",
                                                        "::1"
                                                ],
                                                "source": "static"
                                        },
                                        "logs": {
                                                "logger_names": {
                                                        "localhost": [
                                                                "log0"
                                                        ]
                                                }
                                        }
                                }
                        }
                },
                "pki": {
                        "certificate_authorities": {
                                "local": {
                                        "install_trust": false
                                }
                        }
                }
        }
}

I'll forward this information as a Vulcain issue.

Adding the global option order vulcain after reverse_proxy should resolve the issue until it is fixed in the Vulcain.

Thanks @elliotbruneel for catching this!

[maxhelias]

I'm closing this one, in favor of vulcain issue. Thanks