[Turbo] Pass EventSource options to turbo_stream_listen

[Fan2Shrek]

Q	A
Bug fix?	no
New feature?	yes
Issues	Fix #1860 I think
License	MIT

This allows to pass options to the EventSource, for example
{{ turbo_stream_listen('a_topic', 'default', { withCredentials: true }) }}
Or create specific auth cookie
{{ turbo_stream_listen('a_topic', 'default', { subscribe: '*' }) }}
This functionality is similar to how mercure() works

[github-actions]

📊 Packages dist files size difference

Thanks for the PR! Here is the difference in size of the packages dist files between the base branch and the PR.
Please review the changes and make sure they are expected.

File	Before (Size / Gzip)	After (Size / Gzip)
Turbo
turbo_stream_controller.d.ts	562 B / 280 B	651 B+16% 📈 / 303 B+8% 📈
turbo_stream_controller.js	1.27 kB / 535 B	1.35 kB+6% 📈 / 565 B+6% 📈

[Fan2Shrek]

Hey @smnandre,
Thanks for taking the time to explain this to me ! 😊

However, the last commit seems a bit off to me. Could you confirm if that's what you had in mind ?
Also, since the cookie logic was moved to the Mercure TurboStreamListenRenderer, is the Twig runtime still relevant ?

[smnandre]

Hi seb-jean Guervyl gremo DRaichev and anyone who want to :)

Well.... It’s time to lay all this out clearly! 😊

Could you share your ideal Developer Experience (DX) suggestions?
As much in PHP code than in Twig // Give examples of code usage
Once we have a solid understanding of what you’re aiming for, we can figure out the best way to make it happen together.

Please clarify where and how you’d use this feature:
For example, in a page template, a component, a full-page view, multiple times, or other contexts. This will help us better target the needs and define responsibilities.

Looking forward to your insights!

[smnandre]

TwigComponent errors are unrelated

[smnandre]

@Fan2Shrek it took too much time, i'm sorry for this. Thank you very much for this work.

@seb-jean & @tibobaldwin thank you for the recent pokes :)

[Fan2Shrek]

Hey @smnandre, thanks for the help! Unfortunately, there's still a problem with the TurboStreamListenRenderer. It doesn't create the cookie—I think it's because the class dependencies aren't resolved, but I have no clue why.

[Fan2Shrek]

I found that TurboStreamListenRenderer is configured by the Mercure bundle here. Should we open a PR there as well?

Using Mercure to create the cookies causes the tests to fail.

[smnandre]

I promise you I did not remember this... but now it happens it feels a bit ironic 😆

Well, let's move on :)

You can try this: #2447 (comment)

The only think you cannot is "configure" a service from another bundle/bridge/etc.

So if you find a way to inject the service directly it's perfect (just use ignoreOnInvalid to not pollute our code if there were a problem one day)

If you don't, I'll have a look later during the night 🦇 or tomorrow

[Fan2Shrek]

I adapted the code to use the Twig Mercure extension.
For the injection part, I'm not good enough to find a proper solution. 😅

[smnandre]

Well well well ... 👼 (1/1)

#2460

Well well well .... 👼 (2/2)

     *
     * @return string The URL of the hub with the appropriate "topic" query parameters (if any)
     */
    public function mercure($topics = null, array $options = []): string

https://github.com/symfony/mercure[•••]src/Twig/MercureExtension.php

[smnandre]

For the injection part, I'm not good enough to find a proper solution. 😅

Does it work ? If not, what is missing here ? How do you test?

[Fan2Shrek]

I tested it on a small app with Mercure already set up. The only problem I’m facing is how to inject TwigEnvironment to get MercureExtension. Since TurboStreamRenderer is configured by the MercureBundle, it doesn't inject the new dependencies.

I’m not sure what the 'proper' way to solve this problem is.

[smnandre]

did you update the config for this argument ?

[Fan2Shrek]

Can I? The config is handled by MercureBundle.

[smnandre]

How so ?

[Fan2Shrek]

Isn't this the line that handles it?
https://github.com/symfony/mercure-bundle/blob/77435d740b228e9f5f3f065b6db564f85f2cdb64/src/DependencyInjection/MercureExtension.php#L211C17-L211C19

[smnandre]

Well... back to step1.

Honestly it makes not much sense to me MercureBundle is the one configuring classes on this bundle :|

Could you start a conversation on the MercureBundle repository and see what's the best way to handle this ?

[Fan2Shrek]

Hey @smnandre, this finally looks good to me :)
Let me know if there are any details to adjust .