How to use websockets in RR2

[M-Porter]

Apologies if this was already discussed and answered elsewhere. I've searched all other rr2 related packages and plugins for answers but couldn't find one.

I'm trying to implement websockets in my application. Based on all other discussions, it seems as though they should be working, but no matter what i attempt (based on the examples in the various plugins repos), all i ever get is a (index):30 WebSocket connection to 'ws://127.0.0.1:8000/ws' failed: error message with no error message. The rr output shows{"level":"debug","ts":1657129358.8321888,"logger":"websockets","msg":"validation","topics":[]}.

Start command: ./rr serve -c ./.rr.yaml

.rr.yaml

version: "2.7"

http:
  address: 0.0.0.0:8000
  pool:
    num_workers: 0
    max_jobs: 500
    supervisor:
      exec_ttl: 30s
  static:
    dir: "${PWD}/public"
  middleware: [ "static", "websockets" ]

rpc:
  listen: tcp://127.0.0.1:6001

server:
  command: "php ./vendor/bin/roadrunner-worker"
  env:
    - APP_ENV: "development"
    - APP_BASE_PATH: "${PWD}"
    - LARAVEL_OCTANE: "1"

websockets:
  broker: default
  allowed_origin: "*"
  path: "/ws"

broadcast:
  default:
    driver: memory
    config: { }

logs:
  mode: production
  level: debug
  output: stdout
  encoding: json

Then on my page in a script tag i have a very basic new WebSocket('ws://localhost:8000/ws') call which is where i get the connection failed error.

I feel like I'm missing something right in front of my face but I can't figure out what it is. Any nudge in the right direction would be appreciated.

$ ./rr -v
rr version 2.10.5 (build time: 2022-06-23T21:11:16+0000, go1.18.3)

[rustatian]

Hey @M-Porter 👋🏻 , nice to meet you :)

Have you tried to use tools like Postman to connect?

[rustatian]

Ah, got u. Before RR establishes a ws connection, RR redirects the http (before upgrading to ws connection) headers to the PHP worker. If the PHP worker returns non 200OK HTTP code, RR rejects such a connection. We're working on the docs very hard now, writing videos about different subsystems link, so please wait for a little until we upgrade our previous documentation.
You may try this worker to test the connection.
Also, you may have a look at this js client: link

[M-Porter]

Ok interesting. Definitely has to do with how laravel octane is starting the worker.

What works

use Laminas\Diactoros\ServerRequestFactory;
use Laminas\Diactoros\StreamFactory;
use Laminas\Diactoros\UploadedFileFactory;
use Laravel\Octane\ApplicationFactory;
use Laravel\Octane\RoadRunner\RoadRunnerClient;
use Laravel\Octane\Stream;
use Laravel\Octane\Worker;
use Spiral\Goridge\Relay;
use Spiral\RoadRunner\Http\PSR7Worker;
use Spiral\RoadRunner\Worker as RoadRunnerWorker;

$basePath = require __DIR__.'/vendor/laravel/octane/bin/bootstrap.php';

$psr7Client = new PSR7Worker(
    new RoadRunnerWorker(Relay::create('pipes')),
    new ServerRequestFactory,
    new StreamFactory,
    new UploadedFileFactory,
);
$roadRunnerClient = new RoadRunnerClient($psr7Client);

$worker = null;

while ($psr7Request = $psr7Client->waitRequest()) {
    try {
        $worker = $worker ?: tap((new Worker(
            new ApplicationFactory($basePath), $roadRunnerClient
        )))->boot();
    } catch (Throwable $e) {
        Stream::shutdown($e);

        exit(1);
    }

    try {
        $resp = new \GuzzleHttp\Psr7\Response();
        $resp->getBody()->write($_SERVER['RR_BROADCAST_PATH'] ?? '');
        $psr7Client->respond($resp);
    } catch (\Throwable $e) {
        $psr7Client->getWorker()->error((string) $e);
    }
}

if (! is_null($worker)) {
    $worker->terminate();
}

What doesn't

the standard laravel octane roadrunner-worker

#!/usr/bin/env php
<?php

use Laminas\Diactoros\ServerRequestFactory;
use Laminas\Diactoros\StreamFactory;
use Laminas\Diactoros\UploadedFileFactory;
use Laravel\Octane\ApplicationFactory;
use Laravel\Octane\RequestContext;
use Laravel\Octane\RoadRunner\RoadRunnerClient;
use Laravel\Octane\Stream;
use Laravel\Octane\Worker;
use Psr\Http\Message\ServerRequestInterface;
use Spiral\Goridge\Relay;
use Spiral\RoadRunner\Http\PSR7Worker;
use Spiral\RoadRunner\Worker as RoadRunnerWorker;

$basePath = require __DIR__.'/bootstrap.php';

/*
|--------------------------------------------------------------------------
| Start The Octane Worker
|--------------------------------------------------------------------------
|
| Next we will start the Octane worker, which is a long running process to
| handle incoming requests to the application. Octane can intercept the
| incoming requests and proxy them to the Laravel application for us.
|
*/

$roadRunnerClient = new RoadRunnerClient($psr7Client = new PSR7Worker(
    new RoadRunnerWorker(Relay::create('pipes')),
    new ServerRequestFactory,
    new StreamFactory,
    new UploadedFileFactory,
));

$worker = null;

while ($psr7Request = $psr7Client->waitRequest()) {
    try {
        $worker = $worker ?: tap((new Worker(
            new ApplicationFactory($basePath), $roadRunnerClient
        )))->boot();
    } catch (Throwable $e) {
        Stream::shutdown($e);

        exit(1);
    }

    if (! $psr7Request instanceof ServerRequestInterface) {
        break;
    }

    [$request, $context] = $roadRunnerClient->marshalRequest(new RequestContext([
        'psr7Request' => $psr7Request
    ]));

    $worker->handle($request, $context);
}

if (! is_null($worker)) {
    $worker->terminate();
}

[rustatian]

I don't think that octane supports RR plugins other than http with only a few middleware. It's better to use a SpiralFramework here or our worker. But still, we newer tested octane on our builds. And only SpiralFramework fully supports all RR plugins and middleware.

[M-Porter]

You have been the rubber-ducky programming side kick i actually needed. I figured it all out. Octane does support sockets and broadcasting.

All I had to do was add this to my routes file:

Route::get('/ws', fn () => new \GuzzleHttp\Psr7\Response());

And the connection was able to be created.

I was then able to hit /send

Route::get('/send', function () {
    $broadcast = new Broadcast(RPC::create('tcp://127.0.0.1:6001'));

    $broadcast->publish(['topic-1', 'topic-2'], 'message from broker');

    $topic = $broadcast->join(['topic-1', 'topic-2']);
    $topic->publish('message from topic');
    $topic->publish(['message 1 from topic', 'message 2 from topic']);
});

and have the messages appear on the page.

No other changes to my .rr.yaml or anything else were required. Just that single Route::get.

Let me know if you need any help with the docs around this when you get to it. I'd be happy to add minor laravel feedback as i know there may be a lot more people in the future coming to ask about laravel octane+roadrunner+websockets.

[M-Porter]

I should also note, this only works with sending data from the server. I haven't tested out what it'll take to handle messages sent to the server.

[M-Porter]

Per @rustatian

Before RR establishes a ws connection, RR redirects the http (before upgrading to ws connection) headers to the PHP worker. If the PHP worker returns non 200OK HTTP code, RR rejects such a connection.

Add a new route to /ws in your routes/web.php and return a valid PSR7 response (MUST BE PSR7!!!!).

<?php

// routes/web.php

// The route here should be same as defined in your .rr.yaml file. https://github.com/roadrunner-server/roadrunner/blob/4d8552df9fb578a2a4d3a541547f91e205661a9d/.rr.yaml#L879
Route::get('/ws', fn () => new \GuzzleHttp\Psr7\Response());

You can now connect to the Websocket with

ws = new WebSocket('ws://localhost:8000/ws');

and send a message from the server with

$broadcast = new Broadcast(RPC::create('tcp://127.0.0.1:6001'));

$broadcast->publish(['topic-1', 'topic-2'], 'message from broker');

$topic = $broadcast->join(['topic-1', 'topic-2']);
$topic->publish('message from topic');
$topic->publish(['message 1 from topic', 'message 2 from topic']);

[rustatian]

Nice 👍🏻 , thanks for the detailed explanation. One small note -> '/ws' path might be different, depending on the configuration: https://github.com/roadrunner-server/roadrunner/blob/master/.rr.yaml#L879

[rustatian]

@M-Porter I have updated docs as well: https://roadrunner.dev/docs/plugins-websockets/2.x/en