feat: failover on relay auth timeout

Author: ice-hades

lib/app/features/ion_connect/providers/mixins/relay_create_mixin.dart

@@ -9,18 +9,16 @@ import 'package:ion/app/exceptions/exceptions.dart';
 import 'package:ion/app/features/core/providers/internet_connection_checker_provider.r.dart';
 import 'package:ion/app/features/core/providers/internet_status_stream_provider.r.dart';
 import 'package:ion/app/features/ion_connect/ion_connect.dart';
+import 'package:ion/app/features/ion_connect/providers/relays/relay_disliked_connect_urls_provider.r.dart';
 import 'package:ion/app/features/ion_connect/providers/relays/relay_proxy_domain_preference_provider.r.dart';
 import 'package:ion/app/features/ion_connect/providers/relays/relay_proxy_domains_provider.r.dart';
 import 'package:ion/app/features/user/providers/relays/relays_reachability_provider.r.dart';
 import 'package:ion/app/services/logger/logger.dart';
 import 'package:ion/app/utils/logging.dart';
 
 mixin RelayCreateMixin {
-  Future<IonConnectRelay> createRelay(
-    Ref ref,
-    String url, {
-    Set<String> dislikedConnectUrls = const <String>{},
-  }) async {
+  Future<IonConnectRelay> createRelay(Ref ref, String url) async {
+    final dislikedConnectUrls = ref.read(relayDislikedConnectUrlsProvider(url));
     final candidates = ref.read(relayConnectUrisProvider(url));
     final proxyDomains = ref.read(relaysProxyDomainsProvider);
     final savedPreferredDomain = ref.read(relayProxyDomainPreferenceProvider(url));

lib/app/features/ion_connect/providers/relays/relay_auth_provider.r.dart

@@ -12,19 +12,26 @@ import 'package:ion/app/features/ion_connect/ion_connect.dart' hide requestEvent
 import 'package:ion/app/features/ion_connect/model/action_source.f.dart';
 import 'package:ion/app/features/ion_connect/model/auth_event.f.dart';
 import 'package:ion/app/features/ion_connect/providers/ion_connect_notifier.r.dart';
+import 'package:ion/app/features/ion_connect/providers/relays/relay_disliked_connect_urls_provider.r.dart';
 import 'package:ion/app/features/ion_connect/providers/relays/relays_replica_delay_provider.m.dart';
 import 'package:ion/app/features/user/providers/relays/user_relays_manager.r.dart';
 import 'package:ion/app/features/user/providers/user_delegation_provider.r.dart';
+import 'package:ion/app/utils/logging.dart';
 import 'package:riverpod_annotation/riverpod_annotation.dart';
 
 part 'relay_auth_provider.r.g.dart';
 
+const _defaultTimeout = Duration(seconds: 30);
+
 @riverpod
 class RelayAuth extends _$RelayAuth {
   @override
   RelayAuthService build(IonConnectRelay relay) {
     final service = RelayAuthService(
       relay: relay,
+      addDislikedConnectUrl: (connectUrl) {
+        ref.read(relayDislikedConnectUrlsProvider(relay.url).notifier).add(connectUrl);
+      },
       createAuthEvent: ({
         required String challenge,
         required String relayUrl,
@@ -97,13 +104,16 @@ class RelayAuth extends _$RelayAuth {
 class RelayAuthService {
   RelayAuthService({
     required this.relay,
+    required this.addDislikedConnectUrl,
     required this.createAuthEvent,
     required this.onError,
     this.completer,
   });
 
   final IonConnectRelay relay;
 
+  final void Function(String connectUrl) addDislikedConnectUrl;
+
   final Future<EventMessage> Function({required String challenge, required String relayUrl})
       createAuthEvent;
 
@@ -179,7 +189,24 @@ class RelayAuthService {
         final okMessage = await relay.messages
             .where((message) => message is OkMessage)
             .cast<OkMessage>()
-            .firstWhere((message) => signedAuthEvent.id == message.eventId);
+            .firstWhere((message) => signedAuthEvent.id == message.eventId)
+            .timeout(
+          _defaultTimeout,
+          onTimeout: () {
+            addDislikedConnectUrl(relay.connectUrl);
+            relay.close();
+            reportFailover(
+              Exception(
+                '[RELAY] Relay connection failover for logical URL: ${relay.url} and connect URL ${relay.connectUrl} with reason: AUTH OK timeout}',
+              ),
+              StackTrace.current,
+              tag: 'relay_failover_auth_timeout',
+            );
+            throw SendEventException(
+              'auth-required: AUTH OK timeout after ${_defaultTimeout.inSeconds}s',
+            );
+          },
+        );
 
         if (!okMessage.accepted) {
           throw SendEventException(okMessage.message);

lib/app/features/ion_connect/providers/relays/relay_disliked_connect_urls_provider.r.dart

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: ice License 1.0
+
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'relay_disliked_connect_urls_provider.r.g.dart';
+
+/// Holds a per-logical-relay set of connect URLs that should be avoided for the
+/// current relay build / failover attempt.
+///
+/// This is intentionally separated from the Relay provider so other layers
+/// (e.g. auth handling) can mark a connect URL as bad and force failover.
+@Riverpod(keepAlive: true)
+class RelayDislikedConnectUrls extends _$RelayDislikedConnectUrls {
+  @override
+  Set<String> build(String logicalRelayUrl) => <String>{};
+
+  void reset() {
+    state = <String>{};
+  }
+
+  /// Adds [connectUrl] to the disliked set.
+  ///
+  /// Returns `true` if the url was newly added.
+  bool add(String connectUrl) {
+    if (state.contains(connectUrl)) return false;
+    state = {...state, connectUrl};
+    return true;
+  }
+}

lib/app/features/ion_connect/providers/relays/relay_provider.r.dart

@@ -9,6 +9,7 @@ import 'package:ion/app/features/ion_connect/providers/mixins/relay_closed_mixin
 import 'package:ion/app/features/ion_connect/providers/mixins/relay_create_mixin.dart';
 import 'package:ion/app/features/ion_connect/providers/mixins/relay_timer_mixin.dart';
 import 'package:ion/app/features/ion_connect/providers/relays/relay_auth_provider.r.dart';
+import 'package:ion/app/features/ion_connect/providers/relays/relay_disliked_connect_urls_provider.r.dart';
 import 'package:ion/app/services/logger/logger.dart';
 import 'package:ion/app/utils/logging.dart';
 import 'package:riverpod_annotation/riverpod_annotation.dart';
@@ -22,16 +23,11 @@ class Relay extends _$Relay
     with RelayTimerMixin, RelayCreateMixin, RelayAuthMixin, RelayClosedMixin, RelayActiveMixin {
   @override
   Future<IonConnectRelay> build(String url, {bool anonymous = false}) async {
-    final dislikedConnectUrls = <String>{};
+    final dislikedConnectUrlsNotifier = ref.read(relayDislikedConnectUrlsProvider(url).notifier);
 
     try {
       while (true) {
-        final relay = await createRelay(
-          ref,
-          url,
-          dislikedConnectUrls: dislikedConnectUrls,
-        );
-
+        final relay = await createRelay(ref, url);
         try {
           // Treat auth init as part of relay creation.
           // If auth fails with an auth-required loop, we failover by retrying with the next connect URL.
@@ -50,7 +46,7 @@ class Relay extends _$Relay
           // If we are stuck in an auth-required loop, consider this connect URL unusable and retry.
           if (!anonymous && RelayAuthService.isRelayAuthError(e)) {
             final connectUrl = relay.connectUrl;
-            final added = dislikedConnectUrls.add(connectUrl);
+            final added = dislikedConnectUrlsNotifier.add(connectUrl);
 
             // Close the bad relay before retrying.
             relay.close();
@@ -62,7 +58,7 @@ class Relay extends _$Relay
 
             reportFailover(
               Exception(
-                '[RELAY] Relay auth failover for logical URL: $connectUrl and connect URL: $connectUrl; reason: $e',
+                '[RELAY] Relay auth failover for logical URL: $url and connect URL: $connectUrl; reason: $e',
               ),
               st,
               tag: 'relay_failover_auth',