Add 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% 📈

[smnandre]

You cannot pass options as third parameter, as the interface only declare "options" in docblock.

[Fan2Shrek]

I'm not really sure how to do that, could you explain it to me ?

[smnandre]

I think you could/should probably use TopicSet here, as it's specific to Mercure and would keep things properly typed / isolated.

Or any strategy that does not impact users using a different solution than Mercure.

You should look at this PR and the discussion, as most challenges are identical

#2407

[Fan2Shrek]

I don't see where I could use this object, could you add more details ?

[smnandre]

I did not mean "use this one", but if you read the PR linked and the discussion, you will see how it relates to yours.

We decided to introduce a new object to bypass these BC questions.

[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]

This will throw if the method is called twice during the render of the page.

What are the goal of the various options here ?

Or, say differently, why not use the mercure extension here ? (real question i'm not sure to get)

[Fan2Shrek]

Do you mean the Mercure Twig extension?
If so, it doesn't seem to work 😅. The dependency isn't being resolved, and to be honest, I'm not sure why.

[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]

@norkunas as i think you are one of the (if not the) person knowing this most, and having experience with this BC problematic... i'd love to have your input on this.

@Fan2Shrek I've opened a meta-issue to see how we can make changes in a more generic way first, to ease the development of this specific need, but also others after.

--> #2460

[seb-jean]

Hi,

This feature would be interesting for me: I would use it with #327.

Let's take the example of GitHub notifications.

I have a Notification entity:

// src/Entity/Notification.php
namespace App\Entity;

use Symfony\UX\Turbo\Attribute\Broadcast;

#[Broadcast(topics: ['@="notifications_list_" ~ entity.getUser().getId()'], private: true)]
class Notification
{
    // ...
}

With each creation, a notification will be automatically added with the Broadcast system.

A user can then view their own notifications with {{ turbo_stream_listen('notifications_list_' ~ app.user.id) }}.

The generated code will be as follows:

<div data-controller="symfony--ux-turbo--mercure-turbo-stream" data-symfony--ux-turbo--mercure-turbo-stream-hub-value="https://symfony.com/.well-known/mercure" data-symfony--ux-turbo--mercure-turbo-stream-topic-value="notifications_list_1"></div>

Unfortunately, this is not secure because a malicious person will be able to change the value of the data-symfony--ux-turbo--mercure-turbo-stream-topic-value attribute to have notifications from another user.

Here I talked about notifications, but it could also be valid for instant messaging for example.

The idea would then be to secure the turbo_stream_listen().

[smnandre]

Let's add this to the conversatioon about stream sources : #2460

I'd like to keep talking about generic implementation first (but based on your specific need, it's a rich source of feedback / irl usage!)