Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Await for a successful connection to the websocket before listening to messages #76

Merged
merged 3 commits into from
Apr 24, 2024
Merged

Await for a successful connection to the websocket before listening to messages #76

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ce168b
Await for a successful connection to the websocket before listening t…
miguelcmedeiros Apr 18, 2024
7a94767
Fix socket reconnection
miguelcmedeiros Apr 19, 2024
be10e08
Update socket state accordingly and reason about at the beginning of …
miguelcmedeiros Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 9 additions & 5 deletions lib/src/socket.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,9 @@ class PhoenixSocket {
bool get isConnected => _ws != null && _socketState == SocketState.connected;

void _connect(Completer<PhoenixSocket?> completer) async {
if (_ws != null) {
if (_ws != null &&
(_socketState != SocketState.connected ||
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@matehat
In the case of a reconnection, we have a closed socket, then we would not attempt to reconnect.
If the socket state is unknown, closing or closed, then we are able to proceed with the reconnection of the socket.

_socketState != SocketState.connecting)) {
_logger.warning(
'Calling connect() on already connected or connecting socket.');
completer.complete(this);
Expand All @@ -190,6 +192,12 @@ class PhoenixSocket {
_ws = _webSocketChannelFactory != null
? _webSocketChannelFactory!(_mountPoint)
: WebSocketChannel.connect(_mountPoint);

// Wait for the WebSocket to be ready before continuing. In case of a
// failure to connect, the future will complete with an error and will be
// caught.
await _ws!.ready;

_ws!.stream
.where(_shouldPipeMessage)
.listen(_onSocketData, cancelOnError: true)
Expand Down Expand Up @@ -508,10 +516,6 @@ class PhoenixSocket {
void _onSocketData(message) => onSocketDataCallback(message);

void _onSocketError(dynamic error, dynamic stacktrace) {
if (_socketState == SocketState.closing ||
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@matehat
While testing the original change, I noticed that this check was preventing the socket from being reconnected, since _onSocketClosed() is called after it. The scheduling of the socket reconnection happens at that point.

Does it make sense?

_socketState == SocketState.closed) {
return;
}
final socketError = PhoenixSocketErrorEvent(
error: error,
stacktrace: stacktrace,
Expand Down