Websockets - Locally Hosted Alternative for Pusher (Now Free)

tolgaaaltas

fakruzaruret You need to update that pic. 😃

Kyrne

m4v3rick Sure, contact me on Discord

m4v3rick

Kyrne done. thx.

Kyrne

1.0.7

Added a backend log output when debug mode is on. To help me debug any problems you guys may have.

Kyrne

1.0.8

Beta 14 support
Big thanks to @askvortsov for updating this while I'm at school!

Wadera

Lovely. Thank you!

Wadera

How to get it installed?

me@my-host:~/domains/dev.flarum.local/flarum$ composer require kyrne/websocket
Using version ^1.0 for kyrne/websocket
./composer.json has been updated
Running composer update kyrne/websocket
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - kyrne/websocket[1.0, ..., 1.0.7] require beyondcode/laravel-websockets 1.3 -> satisfiable by beyondcode/laravel-websockets[1.3.0].
    - beyondcode/laravel-websockets 1.3.0 requires pusher/pusher-php-server ~3.0 || ~4.0 -> found pusher/pusher-php-server[3.0.0, ..., v3.4.1, v4.0.0, ..., v4.1.4] but the package is fixed to 2.6.4 (lock file version) by a partial update and that version does not match. Make sure you list it as an argument for the update command.
    - Root composer.json requires kyrne/websocket ^1.0 -> satisfiable by kyrne/websocket[1.0, ..., 1.0.7].

Use the option --with-all-dependencies to allow upgrades, downgrades and removals for packages currently locked to specific versions.

You are using a snapshot build of Composer 2, which may be the cause of the problem. Run `composer self-update --stable` and then try again. In case it solves the problem, please report an issue mentioning Composer 2.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.

I've tried also:

$ composer require kyrne/websocket 1.0.8
$ composer require kyrne/websocket 1.0.8-beta.1
$ composer require kyrne/websocket 1.0.8-beta.14
$ composer require kyrne/websocket:1.0.8
$ composer require kyrne/websocket:dev-master

No luck and extiverse reporting it as incompatible 🙁
https://extiverse.com/extension/kyrne/websocket

luceos

Wadera --with-all-dependencies

Try using that in your composer require command.

Wadera

No luck 🙁
It's only start complaining about oauth:

$ composer require kyrne/websocket --with-all-dependencies
Using version ^1.0 for kyrne/websocket
./composer.json has been updated
Running composer update kyrne/websocket --with-all-dependencies
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - league/oauth2-facebook 2.0.3 requires league/oauth2-client ^2.0 -> found league/oauth2-client[2.0.0, ..., 2.5.0] but it conflicts with another require.
    - fof/oauth 0.1.0 requires league/oauth2-facebook ^2.0.3 -> satisfiable by league/oauth2-facebook[2.0.3].
    - fof/oauth is locked to version 0.1.0 and an update of this package was not requested.

Use the option --with-all-dependencies to allow upgrades, downgrades and removals for packages currently locked to specific versions.

You are using a snapshot build of Composer 2, which may be the cause of the problem. Run `composer self-update --stable` and then try again. In case it solves the problem, please report an issue mentioning Composer 2.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.

Kyrne

Wadera I'm aware and working on it.

Kyrne

A quick little update: I'm still waiting on a few things to get Websocket working on beta 14.

I also recently discovered a memory leak with the help of a few users, I'll get this patched up and included in the beta 14 version. Also on the roadmap for the future is a statistics widget for the admin portal, no eta on that though.

Wadera

Kyrne Also on the roadmap for the future is a statistics widget for the admin portal

That will be great!

Kyrne

2.0.0

Actual compatbility with beta 14 (14.1 is required)
Fix for memory/cpu usage leak
Increased time between pings to the server, actually closes the connection if that ping is not responded to
Added option to only allow connecting to the websocket server if the user is logged in
Some changes were made to allow for statistics logging in the future
Changes made to ensure each user only has 1 connection to the server (even across browser tabs), further reducing cpu/memory overhead
Defer loading pusher script to improve page load time
So many under the hood changes to make it better, more reliable, and more scalable - it's basically an entirely new extension code wise.

Make sure to turn off the websocket server before updating then restart it after.

matteocontrini

Kyrne Added option to only allow connecting to the websocket server if the user is logged in

Thanks for taking this into consideration!

Before I try it: will guest users see the "refresh" button on the homepage, like when the extension is disabled?

Kyrne Changes made to ensure each user only has 1 connection to the server (even across browser tabs), further reducing cpu/memory overhead

This is interesting, could you share how it works? I don't have much experience with WebSockets, I didn't know you could share connections

Wadera

Looks like still not available:

$ composer require kyrne/websocket
Using version ^1.0 for kyrne/websocket
./composer.json has been updated
Running composer update kyrne/websocket
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - kyrne/websocket[1.0, ..., 1.0.7] require beyondcode/laravel-websockets 1.3 -> satisfiable by beyondcode/laravel-websockets[1.3.0].
    - beyondcode/laravel-websockets 1.3.0 requires pusher/pusher-php-server ~3.0 || ~4.0 -> found pusher/pusher-php-server[3.0.0, ..., v3.4.1, v4.0.0, ..., v4.1.4] but the package is fixed to 2.6.4 (lock file version) by a partial update and that version does not match. Make sure you list it as an argument for the update command.
    - Root composer.json requires kyrne/websocket ^1.0 -> satisfiable by kyrne/websocket[1.0, ..., 1.0.7].

Use the option --with-all-dependencies to allow upgrades, downgrades and removals for packages currently locked to specific versions.

You are using a snapshot build of Composer 2, which may be the cause of the problem. Run `composer self-update --stable` and then try again. In case it solves the problem, please report an issue mentioning Composer 2.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.

$ php flarum info | grep 'Flarum core'
Flarum core 0.1.0-beta.14.1

Kyrne

Wadera try composer require kyrne/websocket 2.0.0 --with-all-dependencies

Wadera

$ composer update kyrne/websocket --with-all-dependencies
Loading composer repositories with package information
Updating dependencies
Package "kyrne/websocket" listed for update is not locked.
Nothing to modify in lock file
Installing dependencies from lock file (including require-dev)
Nothing to install, update or remove
Generating autoload files
57 packages you are using are looking for funding.
Use the `composer fund` command to find out more!

$ php flarum info | grep websocket
$

Wadera

https://imgur.com/lcVKZJE

Still not updated - extiverse cache?

luceos

This extension is causing some issues on Extiverse, I'm on it. Expect a solution within the hour.

Apologies for the inconvenience.

Edit: 2.0.0 is now available!

Kyrne

matteocontrini no, guests will not see the button, this is an oversight and I'll release a patch (along with that other fix) in an update.

It stores some values in localstorage which allows it to save connections.

Wadera

$ php flarum info
Flarum core 0.1.0-beta.14.1
PHP version: 7.4.12
Loaded extensions: Core, date, libxml, openssl, pcre, sqlite3, zlib, bcmath, calendar, ctype, curl, dom, hash, fileinfo, filter, ftp, gd, gettext, SPL, iconv, intl, json, mbstring, session, standard, mysqlnd, PDO, pdo_mysql, pdo_sqlite, Phar, posix, Reflection, mysqli, SimpleXML, soap, sockets, sodium, exif, tokenizer, xml, xmlreader, xmlwriter, xsl, zip, imagick, ionCube Loader
+-------------------------------+------------------+------------------------------------------+
| Flarum Extensions             |                  |                                          |
+-------------------------------+------------------+------------------------------------------+
| ID                            | Version          | Commit                                   |
+-------------------------------+------------------+------------------------------------------+
| flarum-approval               | v0.1.0-beta.14   |                                          |
| flarum-emoji                  | v0.1.0-beta.14   |                                          |
| flarum-lang-english           | v0.1.0-beta.14.1 |                                          |
| flarum-flags                  | v0.1.0-beta.14.1 |                                          |
| flarum-likes                  | v0.1.0-beta.14   |                                          |
| flarum-lock                   | v0.1.0-beta.14   |                                          |
| flarum-markdown               | v0.1.0-beta.14   |                                          |
| flarum-mentions               | v0.1.0-beta.14   |                                          |
| flarum-statistics             | v0.1.0-beta.14   |                                          |
| flarum-sticky                 | v0.1.0-beta.14   |                                          |
| flarum-subscriptions          | v0.1.0-beta.14   |                                          |
| flarum-suspend                | v0.1.0-beta.14   |                                          |
| flarum-tags                   | v0.1.0-beta.14   |                                          |
| kilowhat-audit-free           | 1.3.0            |                                          |
| fof-split                     | 0.4.4            |                                          |
| fof-user-bio                  | 0.2.0            |                                          |
| clarkwinkelmann-author-change | 0.2.1            |                                          |
| kyrne-websocket               | 2.0.0            |                                          |
| xelson-chat                   | dev-construct    | cce93767a6590c9bf7380e5267c19755f97c6ecb |
+-------------------------------+------------------+------------------------------------------+
Base URL: https://flarum.dev.local
Installation path: /home/dev/domains/flarumdev.local/flarum
Debug mode: ON
Don't forget to turn off debug mode! It should never be turned on in a production system.

From websocket:

m$ php flarum websocket:serve
Selecting 0.0.0.0:2199.
Starting the WebSocket server on port 2199...
New connection opened for app key XlJC4VVmJQQmSCYXy3n9vmSh9tyx3juZ.
Connection id 23024633.576390044 sending message {"event":"pusher:connection_established","data":"{\"socket_id\":\"23024633.576390044\",\"activity_timeout\":30}"}
New connection opened for app key XlJC4VVmJQQmSCYXy3n9vmSh9tyx3juZ.
Connection id 395350344.958925486 sending message {"event":"pusher:connection_established","data":"{\"socket_id\":\"395350344.958925486\",\"activity_timeout\":30}"}
911: connection id 23024633.576390044 received message: {"event":"pusher:subscribe","data":{"auth":"","channel":"public"}}.
Connection id 23024633.576390044 sending message {"event":"pusher_internal:subscription_succeeded","channel":"public"}
911: connection id 23024633.576390044 received message: {"event":"pusher:subscribe","data":{"auth":"XlJC4VVmJQQmSCYXy3n9vmSh9tyx3juZ:ff0fdc8e971e01241304fa5187954e06ba304c474a3f8386db95ee840a7ae886","channel":"private-user1"}}.
Connection id 23024633.576390044 sending message {"event":"pusher_internal:subscription_succeeded","channel":"private-user1"}
911: connection id 395350344.958925486 received message: {"event":"pusher:subscribe","data":{"auth":"","channel":"public"}}.
Connection id 395350344.958925486 sending message {"event":"pusher_internal:subscription_succeeded","channel":"public"}
911: connection id 395350344.958925486 received message: {"event":"pusher:subscribe","data":{"auth":"XlJC4VVmJQQmSCYXy3n9vmSh9tyx3juZ:9272eaaa3a6cac9f244e99e886508ae77a5a8da4125c1c7287528381b3eb8367","channel":"private-user2"}}.
Connection id 395350344.958925486 sending message {"event":"pusher_internal:subscription_succeeded","channel":"private-user2"}

https://imgur.com/zs3RCNJ

So in theory - all looks great, but there is no real flarum reaction to any events

no new posts apear without refresh
no new notifications
no other events like information about new discussions on main page

Assistance for debugging require 🙁
I can provide any additional information, tcp dump, access to flarum or even pay for additional support.

« Previous Page Next Page »