Websocket reconnection not working..

[jbryant314]

I'm asking this question here rather than reporting a bug because I don't have time to setup a clean repro and don't want to litter the bug reports in case this isn't actually a bug. I just updated stream_chat_flutter to 3.6.0 from 3.2.0 and it seems the websocket connection is never re-established when I wake the phone up. Hoping someone can chime in with a simple fix.. everything was working fine prior to updating, I've used this library extensively over the last 16 months.

Repro steps (Android Pixel 4):

1. Start app, connect user, everything is working fine
2. Lock phone screen
3. Unlock phone screen

Expected: Web socket reconnection succeeds
Observed: I get the following error:

I/flutter (15721): connection.changed
I/flutter (15721): 2022-04-13 11:12:38.269411 🚨 🔌 Connection failed 
I/flutter (15721): WebSocketError(message: user_details is a required field, data: ErrorResponse(code: 4, message: user_details is a required field, statusCode: 400, moreInfo: ))
I/flutter (15721): 2022-04-13 11:12:38.289982 🚨 📡 error connecting ws 
I/flutter (15721): WebSocketError(message: user_details is a required field, data: ErrorResponse(code: 4, message: user_details is a required field, statusCode: 400, moreInfo: ))
I/flutter (15721): 
E/flutter (15721): [ERROR:flutter/lib/ui/ui_dart_state.cc(209)] Unhandled Exception: WebSocketError(message: user_details is a required field, data: ErrorResponse(code: 4, message: user_details is a required field, statusCode: 400, moreInfo: ))

I looked through all the change notes from 3.2.0 to 3.6.0 and I couldn't find any breaking changes related to this.

If user_details is required then why does the flag includeUserDetails default to false in stream_chat-3.6.0/lib/src/ws/websocket.dart:182?

I am letting the stream_chat_core library handle reconnections, I only call connect once when the app first starts.

I'm following the calls: stream_chat_core.dart#didChangeAppLifecycleState -> stream_chat_core.dart#_onForeground() -> stream_chat_core.dart#client.openConnection etc

Hope someone can help, thanks

[jbryant314]

Downgrading to 3.5.1 fixed it. This does seem like a really bad bug in 3.6.0 as it completely prevents reconnection.