[Turbo] Pass EventSource options to `turbo_stream_listen` #2447

Fan2Shrek · 2024-12-12T22:19:06Z

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 · 2024-12-12T22:19:55Z

📊 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% 📈}

src/Turbo/assets/src/turbo_stream_controller.ts

src/Turbo/CHANGELOG.md

src/Turbo/src/Twig/TwigExtension.php

src/Turbo/src/Twig/TurboStreamListenRendererInterface.php

src/Turbo/src/Twig/TwigExtension.php

src/Turbo/src/Twig/TurboRuntime.php

Fan2Shrek · 2024-12-14T22:58:06Z

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 ?

src/Turbo/src/Bridge/Mercure/TurboStreamListenRenderer.php

smnandre · 2024-12-18T00:24:44Z

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!

src/Turbo/doc/index.rst

smnandre · 2025-02-22T22:50:22Z

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 · 2025-02-22T23:12:20Z

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 · 2025-02-22T23:25:29Z

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 · 2025-02-22T23:34:12Z

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 · 2025-02-22T23:50:27Z

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 · 2025-02-23T00:26:42Z

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 · 2025-02-23T00:27:12Z

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 · 2025-02-23T09:45:46Z

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.

src/Turbo/src/Bridge/Mercure/TurboStreamListenRenderer.php

Fan2Shrek · 2025-02-28T23:06:52Z

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

smnandre · 2025-03-05T02:46:58Z

src/Turbo/src/Bridge/Mercure/TurboStreamListenRenderer.php

+                if (isset($eventSourceOptions['withCredentials'])) {
+                    $controllerAttributes['withCredentials'] = $eventSourceOptions['withCredentials'];
+                }
+            } catch (RuntimeError $e) {


This can be thrown by $this->twig->getExtension,
Should I remove it anyway?

smnandre · 2025-03-05T02:54:43Z

src/Turbo/src/DependencyInjection/Compiler/RegisterMercureHubs.php

+        foreach ($container->findTaggedServiceIds('mercure.hub') as $hubId => $tag) {
+            $name = str_replace('mercure.hub.', '', $hubId);
+
+            $container->register("turbo.mercure.$name.renderer", TurboStreamListenRenderer::class)
+                ->addArgument(new Reference($hubId))
+                ->addArgument(new Reference('turbo.mercure.stimulus_helper'))
+                ->addArgument(new Reference('turbo.id_accessor'))
+                ->addArgument(new Reference('twig'))
+                ->addTag('turbo.renderer.stream_listen', ['transport' => $name]);
+
+            if (isset($tag['default']) && $tag['default']) {
+                $container->getDefinition("turbo.mercure.{$name}.renderer")
+                    ->addTag('turbo.renderer.stream_listen', ['transport' => 'default']);
+            }
+
+            $container->register("turbo.mercure.$name.broadcaster", Broadcaster::class)
+                ->addArgument($name)
+                ->addArgument(new Reference($hubId))
+                ->addTag('turbo.broadcaster');
+        }


Could we have some test here ?

It does not seem to follow the findTaggedServiceIds() doc (it returns a array of tags, not a single one)

https://github.com/symfony/symfony/blob/6477041b05f95511c6c0a11bff062b1e6fd8ece6/src/Symfony/Component/DependencyInjection/ContainerBuilder.php#L1321-L1338

You're right, I've added tests :)

src/Turbo/src/DependencyInjection/Compiler/RegisterMercureHubs.php

smnandre · 2025-03-05T02:56:43Z

@Fan2Shrek sorry I was off ! Looks good to me, some minor (last) fixes and LGTM :)

carsonbot added Feature New Feature Status: Needs Review Needs to be reviewed labels Dec 12, 2024

Fan2Shrek force-pushed the add-option-to-turbo-stream branch 3 times, most recently from 867707d to 06ac699 Compare December 12, 2024 22:35

smnandre reviewed Dec 13, 2024

View reviewed changes

src/Turbo/assets/src/turbo_stream_controller.ts Outdated Show resolved Hide resolved

smnandre reviewed Dec 13, 2024

View reviewed changes

src/Turbo/CHANGELOG.md Outdated Show resolved Hide resolved

smnandre reviewed Dec 13, 2024

View reviewed changes

src/Turbo/src/Twig/TwigExtension.php Outdated Show resolved Hide resolved

smnandre reviewed Dec 13, 2024

View reviewed changes

src/Turbo/src/Twig/TwigExtension.php Outdated Show resolved Hide resolved

smnandre reviewed Dec 13, 2024

View reviewed changes

src/Turbo/src/Twig/TwigExtension.php Outdated Show resolved Hide resolved

smnandre requested changes Dec 13, 2024

View reviewed changes

src/Turbo/src/Twig/TwigExtension.php Outdated Show resolved Hide resolved

carsonbot added Status: Needs Work Additional work is needed and removed Status: Needs Review Needs to be reviewed labels Dec 13, 2024

Fan2Shrek force-pushed the add-option-to-turbo-stream branch from 06ac699 to abcc723 Compare December 13, 2024 18:02

carsonbot added Status: Needs Review Needs to be reviewed and removed Status: Needs Work Additional work is needed labels Dec 13, 2024

Fan2Shrek force-pushed the add-option-to-turbo-stream branch from abcc723 to e95cbab Compare December 13, 2024 18:14

smnandre reviewed Dec 14, 2024

View reviewed changes

src/Turbo/src/Twig/TurboStreamListenRendererInterface.php Show resolved Hide resolved

smnandre reviewed Dec 14, 2024

View reviewed changes

src/Turbo/src/Twig/TwigExtension.php Outdated Show resolved Hide resolved

smnandre reviewed Dec 14, 2024

View reviewed changes

src/Turbo/src/Twig/TurboRuntime.php Outdated Show resolved Hide resolved

smnandre reviewed Dec 14, 2024

View reviewed changes

src/Turbo/src/Twig/TurboRuntime.php Outdated Show resolved Hide resolved

Fan2Shrek force-pushed the add-option-to-turbo-stream branch 3 times, most recently from f92e643 to e56b74c Compare December 14, 2024 22:53

smnandre reviewed Dec 15, 2024

View reviewed changes

src/Turbo/src/Bridge/Mercure/TurboStreamListenRenderer.php Outdated Show resolved Hide resolved

smnandre added RFC DX labels Dec 18, 2024

Fan2Shrek added 2 commits February 22, 2025 21:54

Add options to turbo stream

8d7a6dd

Try to prevent BC

b1c1c22

Fan2Shrek force-pushed the add-option-to-turbo-stream branch from e56b74c to 4d9f2a9 Compare February 22, 2025 22:27

smnandre reviewed Feb 22, 2025

View reviewed changes

src/Turbo/doc/index.rst Outdated Show resolved Hide resolved

smnandre approved these changes Feb 22, 2025

View reviewed changes

carsonbot added the Status: Reviewed Has been reviewed by a maintainer label Feb 22, 2025

Fix after review

961ef08

Fan2Shrek force-pushed the add-option-to-turbo-stream branch from 4d9f2a9 to 961ef08 Compare February 22, 2025 23:15

Use mercure extension for creating the cookie

5b429a7

Fan2Shrek force-pushed the add-option-to-turbo-stream branch from 583aab6 to 5b429a7 Compare February 22, 2025 23:46

smnandre reviewed Feb 24, 2025

View reviewed changes

src/Turbo/src/Bridge/Mercure/TurboStreamListenRenderer.php Show resolved Hide resolved

Fan2Shrek mentioned this pull request Feb 27, 2025

How can we update the TurboStreamListenerRenderer configuration? symfony/mercure-bundle#94

Open

Fan2Shrek force-pushed the add-option-to-turbo-stream branch 2 times, most recently from 0663176 to ed131f3 Compare February 28, 2025 23:01

Register mercure hub services in Turbo

a59fd33

Fan2Shrek force-pushed the add-option-to-turbo-stream branch from ed131f3 to a59fd33 Compare February 28, 2025 23:03

smnandre reviewed Mar 5, 2025

View reviewed changes

src/Turbo/src/DependencyInjection/Compiler/RegisterMercureHubs.php Outdated Show resolved Hide resolved

Fiw after review

1b5ba3f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Turbo] Pass EventSource options to `turbo_stream_listen` #2447

[Turbo] Pass EventSource options to `turbo_stream_listen` #2447

Fan2Shrek commented Dec 12, 2024

github-actions bot commented Dec 12, 2024 •

edited

Loading

Fan2Shrek commented Dec 14, 2024

smnandre commented Dec 18, 2024

smnandre commented Feb 22, 2025

smnandre left a comment

Fan2Shrek commented Feb 22, 2025

Fan2Shrek commented Feb 22, 2025 •

edited

Loading

smnandre commented Feb 22, 2025

Fan2Shrek commented Feb 22, 2025 •

edited

Loading

smnandre commented Feb 23, 2025

smnandre commented Feb 23, 2025

Fan2Shrek commented Feb 23, 2025

Fan2Shrek commented Feb 28, 2025

smnandre Mar 5, 2025

Fan2Shrek Mar 5, 2025

smnandre Mar 5, 2025

Fan2Shrek Mar 5, 2025

smnandre commented Mar 5, 2025

[Turbo] Pass EventSource options to turbo_stream_listen #2447

Are you sure you want to change the base?

[Turbo] Pass EventSource options to turbo_stream_listen #2447

Conversation

Fan2Shrek commented Dec 12, 2024

github-actions bot commented Dec 12, 2024 • edited Loading

📊 Packages dist files size difference

Fan2Shrek commented Dec 14, 2024

smnandre commented Dec 18, 2024

smnandre commented Feb 22, 2025

smnandre left a comment

Choose a reason for hiding this comment

Fan2Shrek commented Feb 22, 2025

Fan2Shrek commented Feb 22, 2025 • edited Loading

smnandre commented Feb 22, 2025

Fan2Shrek commented Feb 22, 2025 • edited Loading

smnandre commented Feb 23, 2025

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

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

smnandre commented Feb 23, 2025

Fan2Shrek commented Feb 23, 2025

Fan2Shrek commented Feb 28, 2025

smnandre Mar 5, 2025

Choose a reason for hiding this comment

Fan2Shrek Mar 5, 2025

Choose a reason for hiding this comment

smnandre Mar 5, 2025

Choose a reason for hiding this comment

Fan2Shrek Mar 5, 2025

Choose a reason for hiding this comment

smnandre commented Mar 5, 2025

[Turbo] Pass EventSource options to `turbo_stream_listen` #2447

[Turbo] Pass EventSource options to `turbo_stream_listen` #2447

github-actions bot commented Dec 12, 2024 •

edited

Loading

Fan2Shrek commented Feb 22, 2025 •

edited

Loading

Fan2Shrek commented Feb 22, 2025 •

edited

Loading