Fix: ViewerController

[OskarStark]

After upgrading to Symfony 6.4, the ViewerController stopped working while throwing the following exception:

Uncaught PHP Exception LogicException: "You cannot use the "render" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle"." at AbstractController.php line 435

Upon investigation with @mvhirsch, we discovered that the service_container injected into the controller lacked the twig service. However, this shouldn't have been a problem since twig was injected directly via arguments. The root cause turned out to be the use of AbstractController::render() method, which attempts to access twig from the service container, instead of the intended ViewerController::renderView().

Additionally, I've realized that there is no necessity to inject the service_container or extend the AbstractController. We’re currently running tests to see if this resolves the issue.

Thank you for your assistance and insights

[OskarStark]

Can you please approve the workflow run? Thanks

[DamienHarper]

@OskarStark Thanks for the PR.

[OskarStark]

Any clue why the tests are failing?

[mvhirsch]

@OskarStark pipeline is merging this branch against 5.x (not master). Maybe we overlooked something on first try?

[OskarStark]

@OskarStark pipeline is merging this branch against 5.x (not master). Maybe we overlooked something on first try?

This is correct, I target 5.x as version 6 is not yet released 🤷‍♂️

[OskarStark]

@DamienHarper can you please approve the workflow again? I extends the AbstractController again, lets see if that helps, thanks

[OskarStark]

I don't know why

auditor-bundle 5.x CI / Tests PHP 8.1, Symfony 6.* (pull_request)

is failing 🤷‍♂️

[svenpet90]

Any update on this PR? Im eagerly waiting for this to be merged and released since we have customer projects using this bundle 😇

[OskarStark]

I really don't know why this test is failing

[gassan]

I really don't know why this test is failing

Probably you are still extending from SF AbstractController and therefore renderView return type does not match

Fatal error: Declaration of DH\AuditorBundle\Controller\ViewerController::renderView(string $view, array $parameters = []): Symfony\Component\HttpFoundation\Response must be compatible with Symfony\Bundle\FrameworkBundle\Controller\AbstractController::renderView(string $view, array $parameters = []): string in /opt/www/github/auditor-bundle/src/Controller/ViewerController.php on line 109

[mvhirsch]

In Github Actions log I see this:

[critical] Uncaught PHP Exception LogicException: "You cannot use the "render" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle"." at AbstractController.php line 435

+1 for removing extends AbstractController. Do we really need it after this change? 😇

[OskarStark]

I tried in a previous commit but was still not working.

Will try to remove it tomorrow again

[OskarStark]

+1 for removing extends AbstractController. Do we really need it after this change? 😇

Removed again, lets see ...

@DamienHarper is it really needed, to reapprove the workflow run all the time?

[OskarStark]

Tests are still failing @DamienHarper, any idea?

[OskarStark]

It looks like this is causing the issue:

    public function showTransactionAction(Reader $reader, string $hash): Response
    {
        $audits = $reader->getAuditsByTransactionHash($hash);

[DamienHarper]

@OskarStark When looking at the GA CI logs, it looks like it checkout hash 7ce0d368c9bec4c9b2669f6e68f062c079a9b832 which does not include latest commits 🤔

[OskarStark]

Can you approve again, it should checkout the PR code itself and not the target ref IMHO

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7ce0d36) 93.14% compared to head (6f83864) 93.14%.

Additional details and impacted files

@@           Coverage Diff           @@
##              5.x     #379   +/-   ##
=======================================
  Coverage   93.14%   93.14%           
=======================================
  Files          15       15           
  Lines         350      350           
=======================================
  Hits          326      326           
  Misses         24       24           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[DamienHarper]

@OskarStark hurray! you made it ;)

[OskarStark]

Nice, can you tag a release?

[DamienHarper]

Done! (5.2.5)

[mvhirsch]

Thank you @OskarStark and @DamienHarper !

While I love this implementation (decoupling the controller from the framework), the only downside I can image is: the ViewerController is not marked as final and just changed. This should be marked as breaking change and thus not be released as patch-version, but a major one. At least, please add it to the release notes or upgrade guideline :-)

[DamienHarper]

@mvhirsch you're welcome ;)
You're right, I should have released it as a major version bump. It's a bit late now so I updated release notes. Sorry for the inconvenience.