OfficialDakari
/
matrix-dart-sdk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1732 from famedly/krille/offer-ensure-not-soft-logged-out 

feat: Offers client.ensureNotSoftLoggedOut() to fix using client with stopped sync loop
This commit is contained in:
Krille-chan 2024-03-14 14:56:41 +01:00 committed by GitHub
parent 15549119db 3d09219269
commit 9826bbeb7b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
lib/src/client.dart
View File

@ -1382,6 +1382,8 @@ class Client extends MatrixApi {
accessToken = token; accessToken = token;
} }
await ensureNotSoftLoggedOut();
// Check if the notification contains an event at all: // Check if the notification contains an event at all:
final eventId = notification.eventId; final eventId = notification.eventId;
final roomId = notification.roomId; final roomId = notification.roomId;
@ -1793,6 +1795,10 @@ class Client extends MatrixApi {
bool get syncPending => _currentSync != null; bool get syncPending => _currentSync != null;
/// Controls the background sync (automatically looping forever if turned on). /// Controls the background sync (automatically looping forever if turned on).
/// If you use soft logout, you need to manually call
/// `ensureNotSoftLoggedOut()` before doing any API request after setting
/// the background sync to false, as the soft logout is handeld automatically
/// in the sync loop.
set backgroundSync(bool enabled) { set backgroundSync(bool enabled) {
_backgroundSync = enabled; _backgroundSync = enabled;
if (_backgroundSync) { if (_backgroundSync) {
@ -1847,6 +1853,19 @@ class Client extends MatrixApi {
} }
} }
/// Checks if the token expires in under [expiresIn] time and calls the
/// given `onSoftLogout()` if so. You have to provide `onSoftLogout` in the
/// Client constructor. Otherwise this will do nothing.
Future<void> ensureNotSoftLoggedOut(
[Duration expiresIn = const Duration(minutes: 1)]) async {
final tokenExpiresAt = accessTokenExpiresAt;
if (onSoftLogout != null &&
tokenExpiresAt != null &&
tokenExpiresAt.difference(DateTime.now()) <= expiresIn) {
await _handleSoftLogout();
}
}
/// Pass a timeout to set how long the server waits before sending an empty response. /// Pass a timeout to set how long the server waits before sending an empty response.
/// (Corresponds to the timeout param on the /sync request.) /// (Corresponds to the timeout param on the /sync request.)
Future<void> _innerSync({Duration? timeout}) async { Future<void> _innerSync({Duration? timeout}) async {
@ -1866,14 +1885,7 @@ class Client extends MatrixApi {
// amount of time if nothing happens. // amount of time if nothing happens.
timeout ??= const Duration(seconds: 30); timeout ??= const Duration(seconds: 30);
// Call onSoftLogout 5 minutes before access token expires to prevent await ensureNotSoftLoggedOut(timeout * 2);
// failing network requests.
final tokenExpiresAt = accessTokenExpiresAt;
if (onSoftLogout != null &&
tokenExpiresAt != null &&
tokenExpiresAt.difference(DateTime.now()) <= timeout * 2) {
await _handleSoftLogout();
}
final syncRequest = sync( final syncRequest = sync(
filter: syncFilterId, filter: syncFilterId,