Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roadrunner-php/centrifugo
🔌 RoadRunner Centrifugo Bridge
https://github.com/roadrunner-php/centrifugo
centrifugo grpc php pubsub roadrunner websocket
Last synced: about 15 hours ago
JSON representation
🔌 RoadRunner Centrifugo Bridge
- Host: GitHub
- URL: https://github.com/roadrunner-php/centrifugo
- Owner: roadrunner-php
- License: mit
- Created: 2022-10-26T09:29:31.000Z (over 2 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-07-22T07:44:31.000Z (6 months ago)
- Last Synced: 2025-01-25T01:18:10.079Z (3 days ago)
- Topics: centrifugo, grpc, php, pubsub, roadrunner, websocket
- Language: PHP
- Homepage:
- Size: 1.52 MB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# RoadRunner Centrifugo Bridge
[](https://packagist.org/packages/roadrunner-php/centrifugo)
[](https://packagist.org/packages/roadrunner-php/centrifugo)
[](https://github.com/roadrunner-php/centrifugo/actions)
[](https://github.com/roadrunner-php/centrifugo/actions)
[](https://codecov.io/gh/roadrunner-php/centrifugo/)
[](https://packagist.org/packages/roadrunner-php/centrifugo)
This repository contains the codebase PHP bridge using RoadRunner centrifuge plugin.
## Installation
To install application server and Jobs codebase
```bash
composer require roadrunner-php/centrifugo
```
You can use the convenient installer to download the latest available compatible version of RoadRunner assembly:
```bash
composer require spiral/roadrunner-cli --dev
vendor/bin/rr get
```
## Proxy Centrifugo requests to a PHP application
It's possible to proxy some client connection events from Centrifugo to the RoadRunner application server and react to
them in a custom way. For example, it's possible to authenticate connection via request from Centrifugo to application
backend, refresh client sessions and answer to RPC calls sent by a client over bidirectional connection.
The list of events that can be proxied:
* `connect` – called when a client connects to Centrifugo, so it's possible to authenticate user, return custom data to a
client, subscribe connection to several channels, attach meta information to the connection, and so on. Works for
bidirectional and unidirectional transports.
* `refresh` - called when a client session is going to expire, so it's possible to prolong it or just let it expire. Can
also be used just as a periodical connection liveness callback from Centrifugo to app backend. Works for bidirectional
and unidirectional transports.
* `sub_refresh` - called when it's time to refresh the subscription. Centrifugo itself will ask your backend about subscription validity instead of subscription refresh workflow on the client-side.
* `subscribe` - called when clients try to subscribe on a channel, so it's possible to check permissions and return custom
initial subscription data. Works for bidirectional transports only.
* `publish` - called when a client tries to publish into a channel, so it's possible to check permissions and optionally
modify publication data. Works for bidirectional transports only.
* `rpc` - called when a client sends RPC, you can do whatever logic you need based on a client-provided RPC method and
params. Works for bidirectional transports only.
First you need to add `centrifuge` section to your RoadRunner configuration. For example, such a configuration
would be quite feasible to run:
```yaml
rpc:
listen: tcp://127.0.0.1:6001
server:
command: "php app.php"
relay: pipes
centrifuge:
proxy_address: "tcp://0.0.0.0:10001" # Centrifugo address
```
and centrifugo config:
```json
{
"admin": true,
"api_key": "secret",
"admin_password": "password",
"admin_secret": "admin_secret",
"allowed_origins": [
"*"
],
"token_hmac_secret_key": "test",
"publish": true,
"proxy_publish": true,
"proxy_subscribe": true,
"proxy_connect": true,
"allow_subscribe_for_client": true,
"proxy_connect_endpoint": "grpc://127.0.0.1:10001",
"proxy_connect_timeout": "10s",
"proxy_publish_endpoint": "grpc://127.0.0.1:10001",
"proxy_publish_timeout": "10s",
"proxy_subscribe_endpoint": "grpc://127.0.0.1:10001",
"proxy_subscribe_timeout": "10s",
"proxy_refresh_endpoint": "grpc://127.0.0.1:10001",
"proxy_refresh_timeout": "10s",
"proxy_sub_refresh_endpoint": "grpc://127.0.0.1:10001",
"proxy_sub_refresh_timeout": "1s",
"proxy_rpc_endpoint": "grpc://127.0.0.1:10001",
"proxy_rpc_timeout": "10s"
}
```
> **Note**
> `proxy_connect_endpoint`, `proxy_publish_endpoint`, `proxy_subscribe_endpoint`, `proxy_refresh_endpoint`,
> `proxy_sub_refresh_endpoint`, `proxy_rpc_endpoint` - endpoint address of roadrunner server with activated
> `centrifuge` plugin.
To init abstract RoadRunner worker:
```php
waitRequest()) {
if ($request instanceof Request\Invalid) {
$errorMessage = $request->getException()->getMessage();
if ($request->getException() instanceof \RoadRunner\Centrifugo\Exception\InvalidRequestTypeException) {
$payload = $request->getException()->payload;
}
// Handle invalid request
// $logger->error($errorMessage, $payload ?? []);
continue;
}
if ($request instanceof Request\Refresh) {
try {
// Do something
$request->respond(new Payload\RefreshResponse(
// ...
));
} catch (\Throwable $e) {
$request->error($e->getCode(), $e->getMessage());
}
continue;
}
if ($request instanceof Request\Subscribe) {
try {
// Do something
$request->respond(new Payload\SubscribeResponse(
// ...
));
// You can also disconnect connection
$request->disconnect('500', 'Connection is not allowed.');
} catch (\Throwable $e) {
$request->error($e->getCode(), $e->getMessage());
}
continue;
}
if ($request instanceof Request\Publish) {
try {
// Do something
$request->respond(new Payload\PublishResponse(
// ...
));
// You can also disconnect connection
$request->disconnect('500', 'Connection is not allowed.');
} catch (\Throwable $e) {
$request->error($e->getCode(), $e->getMessage());
}
continue;
}
if ($request instanceof Request\RPC) {
try {
$response = $router->handle(
new Request(uri: $request->method, data: $request->data),
); // ['user' => ['id' => 1, 'username' => 'john_smith']]
$request->respond(new Payload\RPCResponse(
data: $response
));
} catch (\Throwable $e) {
$request->error($e->getCode(), $e->getMessage());
}
continue;
}
}
```
> **Note**
> You can find addition information about [here](https://centrifugal.dev/docs/server/proxy).
## License
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information. Maintained
by [Spiral Scout](https://spiralscout.com).