[11.x] Enhance eventStream to Support Custom Events and Start Messages

[devhammed]

[11.x] Enhance eventStream to Support Custom Events and Start Messages

Summary

⚠️ BREAKING CHANGE: This PR changes the eventStream method in ResponseFactory by allowing customization of:

• Event Name ($as) – Previously hardcoded as "update", now configurable.
• Start Stream Message ($startStreamWith) – Optional message sent before streaming begins.
• End Stream Message ($endStreamWith) – Now optional instead of required.

Why This Change?

• More Flexible SSE Handling: Developers can now specify custom event names, making it easier to differentiate between different types of SSE messages and also they can now decide if they want start/end messages.
• Improved Client Communication: Some clients expect an initial message when connecting. The $startStreamWith parameter allows for this.

Implementation Details

The method signature now includes:

public function eventStream(
    Closure $callback, 
    array $headers = [], 
    string $as = 'update', 
    ?string $startStreamWith = '<stream>', 
    ?string $endStreamWith = '</stream>'
) {}

Docs PR: laravel/docs#10180

[rodrigopedra]

Backward Compatible: Defaults maintain previous behaviour, ensuring no breaking changes.

Changing a public method signature, either by changing its arguments' defaults, or by adding an entirely new parameter, which also changes the arguments order, is a breaking change.

Of course, as this so newly released, maybe it can be tolerated. But nonetheless, it is a breaking change.

[devhammed]

Backward Compatible: Defaults maintain previous behaviour, ensuring no breaking changes.

Changing a public method signature, either by changing its arguments' default, or by adding an entirely new parameter, which also changes the arguments order, is a breaking change.

Of course, as this so newly released, maybe it can be tolerated. But nonetheless, it is a breaking change.

Thanks for the feedback, I have updated the description to point this out and you are correct, I didn't count it as a breaking change because it was newly released...