[1.13][Admin] Referer redirection after a custom crud update seems broken

[jeromeengeln]

Sylius version affected: 1.13.10

Issue also created here : Sylius/Sylius#17686

Description
Sylius\Bundle\ResourceBundle\Controller\RequestConfiguration manage crud redirection after update.
According to the function :

public function getRedirectRoute($name)
    {
        $redirect = $this->parameters->get('redirect');

        if (null === $redirect) {
            return $this->getRouteName($name);
        }

        if (is_array($redirect)) {
            if (!empty($redirect['referer'])) {
                return 'referer';
            }

            return $redirect['route'];
        }

        return $redirect;
    }

There is a possibility to configure custom ressource crud redirection called 'referer'.
And allow user to go back on the previous request url.
Actually, by default, the user is redirected to the show route, according to Sylius\Bundle\ResourceBundle\Controller\RedirectHandler file :

public function redirectToResource(RequestConfiguration $configuration, ResourceInterface $resource): Response
    {
        try {
            return $this->redirectToRoute(
                $configuration,
                (string) $configuration->getRedirectRoute(ResourceActions::SHOW),
                $configuration->getRedirectParameters($resource),
            );
        } catch ...
    }

The expected behavior, after configuring my referer redirection in my route configuration is that the function getRedirectRoute return referer.

public function redirectToRoute(RequestConfiguration $configuration, string $route, array $parameters = []): Response
    {
           if ('referer' === $route) {
                 return $this->redirectToReferer($configuration);
           }
....

But it's not working, because now Sylius rework the route name and add a prefix.
For exemple :

public function getRedirectRoute($name)
    {
        $redirect = $this->parameters->get('redirect');
        dump($redirect);

The dump return 'app_admin_test_referer' instead of the configured value.

Steps to reproduce
Create a custom resource admin and add a referer redirection and in your routes.yaml add redirection: referer:

custom_resource_test_admin:
  resource: |
    alias: custom_resource.test
    section: admin
    redirect: referer

Possible Solution
Into Sylius\Bundle\ResourceBundle\Controller\RequestConfiguration change way to detect 'referer' value.

if (is_string($redirect) and str_ends_with($redirect, 'referer')) 

[loic425]

@jeromeengeln thx for opening that issue

But it's not working, because now Sylius rework the route name and add a prefix.

Where is it?

[jeromeengeln]

@jeromeengeln thx for opening that issue

But it's not working, because now Sylius rework the route name and add a prefix.

Where is it?

There is another problem :
In the getRedirectRoute function, this code is not reachable :

if (is_array($redirect)) {
            if (!empty($redirect['referer'])) {
                return 'referer';
            }
            return $redirect['route'];
        }

Because $this->parameters->get('redirect') only accept scalar values. so is_array($redirect) will always return false.

Second problem :

If you configure $redirect = $this->parameters->get('redirect'); as :

custom_resource_test_admin:
  resource: |
    alias: custom_resource.test
    section: admin
    redirect: referer

instead of get a string with 'referer' value as configured, you'll get a reworked and prefixed string value. I don't know why this configuration value is now considered as a route name.

dd($redirect);
src/Bundle/Controller/RequestConfiguration.php on line 163:
"sylius_admin_toto_referer"

Conclusion :

To make referer redirection working, we have to take care about a string value and not array anymore.
And test value ending with "referer" string instead of testing if it's equal to 'referer' as declared in my configuration.

[loic425]

For now, I'm really not sure for that kind of "work around".
I understand better the issue now, cause indeed that "redirect" is a shortcut of the route name.

In the new routing system, the redirect is build with the whole route name (but for now, there's no redirectToReferer feature).
Currently, I'm working on deprecating the ResourceController totally cause it's only needed by Sylius E-commerce, so I am not sure to make changes on that legacy system (all those things that are on this Controller namespace).

[jeromeengeln]

For now, I'm really not sure for that kind of "work around". I understand better the issue now, cause indeed that "redirect" is a shortcut of the route name.

In the new routing system, the redirect is build with the whole route name (but for now, there's no redirectToReferer feature). Currently, I'm working on deprecating the ResourceController totally cause it's only needed by Sylius E-commerce, so I am not sure to make changes on that legacy system (all those things that are on this Controller namespace).

What do you mean by deprecating the ResourceController? Do you plan to change this behavior in future versions or move it somewhere else? Could you provide more details? Or is it just because it's a very sensitive file?

Do you know if another "redirectToReferer" feature is already planned?

I'm working on a Sylius bundle that simplifies custom CRUD creation, and these few lines are very important to me. 😬 But yeah, it's your call. Let me know your final decision.

Thank you for your time!

[loic425]

@jeromeengeln I've tried to talk with you on Sylius Slack without success.