Feature: Broadcast custom Events on IPC

[gwleuverink]

Summary

This PR implements a api/broadcasting endpoint to handle all custom events dispatched on the nativephp channel. (See #295 (comment))

Whenever a Laravel event is dispatched on the nativephp channel, a native-event event will be dispached on IPC so we can both listen to these events on the frontend using ipcRenderer.on('native-event') and using Livewire listeners without using a separate websocket server.

Please also check out NativePHP/electron-plugin#37 which implements the endpoint in the Electron backend

For example, whenever the following event is dispatched:

class FooBar
{
    use Dispatchable;

    public $foo = 'Bar';

    public function broadcastOn(): array
    {
        return [
            new Channel('nativephp'),
        ];
    }
}

You may listen to it within Livewire using a listener:

#[On('native:\App\Events\FooBar')]
public function listenOnIpc(FooBar $event)
{
    // dd($event);
}

Or directly int the frontend using the ipcRenderer

<!-- 
Assuming you have ipcRenderer attached to the window scope in your bundle:
window.ipcRenderer = require('electron').ipcRenderer
-->

<script>
    window.ipcRenderer.on('native-event', (native, { event, payload }) => {

        console.dir(event)
        console.dir(payload)
    })
</script>

For your consideration

1. I'm using the existing native-event so all events are automatically forwarded to Livewire. I'm unsure about the naming of this, strictly speaking this isn't a Native event, but rather a custom one.

2. I've looked around for a existing path to testing this, but it seems similar features (like the debug endpoint) aren't covered. If you wan't me to cover this PR with tests I'll have to do some more digging. I'm not very experienced with jest & TS

3. While exploring the codebase I found an existing notifyLaravel function in the electron plugins' utils.ts. It looks like this function doesn't emit events to any menubar window like was recently added to the debug enpoint. Should I create a separate issue for this?

Closing

I've got all this working locally without issues. If you'd like me to change anything please let me know and I'll update this asap 👍🏻

[simonhamp]

This is great! Regarding your questions:

I'm using the existing native-event so all events are automatically forwarded to Livewire. I'm unsure about the naming of this, strictly speaking this isn't a Native event, but rather a custom one.

This is fine for now. If it becomes apparent that we should split them out, we can.

I've looked around for a existing path to testing this, but it seems similar features (like the debug endpoint) aren't covered. If you wan't me to cover this PR with tests I'll have to do some more digging. I'm not very experienced with jest & TS

This specific PR (on the Laravel side) could do with a simple test that just asserts that the correct client endpoint will be called when the event is the right type and not when it isn't. I don't think you'd need to dig into Jest etc...

That said, I'm happy with this as-is... I plan to revisit tests closer to or even after v1.

While exploring the codebase I found an existing notifyLaravel function in the electron plugins' utils.ts. It looks like this function doesn't emit events to any menubar window like was recently added to the debug enpoint. Should I create a separate issue for this?

Yes please. I think that makes sense for them all to be consistent.

[gwleuverink]

Great! I'll also add it to the broadcasting docs this evening 👍🏻