[Routing] Deal with hosts per locale

[odolbeau]

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix #30617
License	MIT
Doc PR	TODO

Allow to define a different host for each locale in routing.

It's now possible to define this kind of configuration:

controllers:
    resource: ../../src/Controller/
    type: annotation
    host:
        fr: www.example.fr
        en: www.example.com

It's still possible to define an unique host (host: wwww.example.com) and if a host is defined for a given route directly, it's not overridden.

To be done:

• YamlLoader
• XmlLoader
• PhpLoader?
• Documentation
• Changelog

[nicolas-grekas]

What happens when the route defines both localized paths and localized hosts?

It's still possible to define an unique host (host: wwww.example.com) and if a host is defined for a given route directly, it's not overridden.

I'm not sure this is correct: other attributes (defaults, condition, etc) give precedence to the importing side, isn't it?

[odolbeau]

What happens when the route defines both localized paths and localized hosts?

Both will be used. I didn't add any test for this case cause TBH I don't know what's the expected behavior.

I'm not sure this is correct: other attributes (defaults, condition, etc) give precedence to the importing side, isn't it?

You tell me. :) I can remove this behavior (here) if you think it makes sense.
I added it cause you may want to define a totally different domain for a given route (and only for this one).
Anyway, it's doable by adding another rule in configuration so giving precedence to the importing side is not a problem.

[nicolas-grekas]

I didn't add any test for this case cause TBH I don't know what's the expected behavior.

can you please add one? the behavior should be that we synchronize both path and host to create only one route for the locale, that matches host and path, both at the same time.

I can remove this behavior (here) if you think it makes sense.

I confirm, see this line that already has the correct precedence. It would make no sense to have precedence vary by type of declaration I think.

[odolbeau]

Looks like all implementations (xml, yaml & php) are working now. :)
For tests, I use a route file container 3 routes: 1 without host nor path, 1 with a single host, 1 with 2 hosts & 2 paths.
This file is imported 4 times: without any host, with only 1 host, with several hosts & with both hosts & locales (prefixes)
I tried to be as exhaustive as possible for those tests, tell me if I forget something.

Now waiting for your reviews! :)

[welcoMattic]

Thanks @odolbeau for your work!
I tested it here with a replication of a real-life case based on a client project, and it works like a charm 👌

[nicolas-grekas]

Looks nice. Here are some questions + suggestions.

[nicolas-grekas]

missing preg_quote()

btw, don't we miss this line in PrefixTrait? if confirmed, the fix should be for 4.4

[nicolas-grekas]

sweet thanks

[nicolas-grekas]

Just one thing: can you please rebase and update the changelog of the component?

[odolbeau]

Just one thing: can you please rebase and update the changelog of the component?

Done! 👍

[fabpot]

LGTM, made a minor comment on the CHANGELOG entry.

[odolbeau]

Documentation available here: symfony/symfony-docs#13571

[fabpot]

Thank you @odolbeau.

[seb-jean]

Hello @odolbeau ,

Could it work with the subdomain system?

With the files below, will it be possible to have

• www.example.fr/blog
• admin.example.fr

Thanks :)

Here are my different files:

# config/routes/annotations.yaml
controllers:
     resource: ../../src/Controller/
     type: annotation
     host:
         fr: www.example.fr
         en: www.example.com

// src/Controller/BlogController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Routing\Annotation\Route;

class BlogController extends AbstractController
{
    /**
     * @Route("/blog", name="blog_list")
     */
    public function list()
    {
        // ...
    }
}

// src/Controller/Admin/BlogController.php
namespace App\Controller\Admin;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Routing\Annotation\Route;

class BlogController extends AbstractController
{
    /**
     * @Route("/", name="admin_index", host="admin")
     */
    public function index()
    {
        // ...
    }
}