Fix realtime connection fields

android/src/main/java/io/ably/flutter/plugin/AblyMethodCallHandler.java

@@ -23,6 +23,7 @@
 import io.ably.lib.realtime.AblyRealtime;
 import io.ably.lib.realtime.Channel;
 import io.ably.lib.realtime.CompletionListener;
+import io.ably.lib.realtime.ConnectionStateListener;
 import io.ably.lib.realtime.Presence;
 import io.ably.lib.rest.AblyBase;
 import io.ably.lib.rest.AblyRest;
@@ -112,6 +113,11 @@ public AblyMethodCallHandler(final MethodChannel methodChannel,
     _map.put(PlatformConstants.PlatformMethod.restAuthGetClientId,
             (methodCall, result) -> authMethodHandler.clientId(methodCall, result, AuthMethodHandler.Type.Rest));
 
+    // Connection specific handlers
+    _map.put(PlatformConstants.PlatformMethod.connectionId, this::connectionId);
+    _map.put(PlatformConstants.PlatformMethod.connectionKey, this::connectionKey);
+    _map.put(PlatformConstants.PlatformMethod.connectionRecoveryKey, this::connectionRecoveryKey);
+
     // Push Notifications
     _map.put(PlatformConstants.PlatformMethod.pushActivate, this::pushActivate);
     _map.put(PlatformConstants.PlatformMethod.pushDeactivate, this::pushDeactivate);
@@ -451,7 +457,18 @@ public void notImplemented() {
           return token[0];
         };
       }
-      result.success(clientHandle.createRealtime(clientOptions.options, applicationContext));
+
+      final long realtimeInstanceHandle = clientHandle.createRealtime(clientOptions.options, applicationContext);
+      final AblyRealtime realtime = instanceStore.getRealtime(realtimeInstanceHandle);
+      realtime.connection.on(new ConnectionStateListener() {
+        @Override
+        public void onConnectionStateChanged(ConnectionStateChange state) {
+          AblyFlutterMessage<String> channelMessage = new AblyFlutterMessage<>(realtime.connection.id, realtimeInstanceHandle);
+          methodChannel.invokeMethod(PlatformConstants.PlatformMethod.connectionIdUpdated, channelMessage);
+        }
+      });
+
+      result.success(realtimeInstanceHandle);
     } catch (final AblyException e) {
       handleAblyException(result, e);
     }
@@ -559,6 +576,23 @@ private void restTime(@NonNull MethodCall methodCall, @NonNull MethodChannel.Res
         time(result, instanceStore.getRest(ablyMessage.handle));
     }
 
+  private void connectionId(@NonNull MethodCall methodCall, @NonNull MethodChannel.Result result) {
+    final AblyFlutterMessage ablyMessage = (AblyFlutterMessage) methodCall.arguments;
+    AblyRealtime realtime = instanceStore.getRealtime(ablyMessage.handle);
+    result.success(realtime.connection.id);
+  }
+
+  private void connectionKey(@NonNull MethodCall methodCall, @NonNull MethodChannel.Result result) {
+    final AblyFlutterMessage ablyMessage = (AblyFlutterMessage) methodCall.arguments;
+    AblyRealtime realtime = instanceStore.getRealtime(ablyMessage.handle);
+    result.success(realtime.connection.key);
+  }
+
+  private void connectionRecoveryKey(@NonNull MethodCall methodCall, @NonNull MethodChannel.Result result) {
+    final AblyFlutterMessage ablyMessage = (AblyFlutterMessage) methodCall.arguments;
+    AblyRealtime realtime = instanceStore.getRealtime(ablyMessage.handle);
+    result.success(realtime.connection.recoveryKey);
+  }
     private void time(@NonNull MethodChannel.Result result, AblyBase client) {
         Callback<Long> callback = new Callback<Long>() {
             @Override

android/src/main/java/io/ably/flutter/plugin/generated/PlatformConstants.java

@@ -77,6 +77,12 @@ static final public class PlatformMethod {
         public static final String realtimeAuthCreateTokenRequest = "realtimeAuthCreateTokenRequest";
         public static final String realtimeAuthRequestToken = "realtimeAuthRequestToken";
         public static final String realtimeAuthGetClientId = "realtimeAuthGetClientId";
+
+        public static final String connectionId = "connectionId";
+        public static final String connectionKey = "connectionKey";
+        public static final String connectionRecoveryKey = "connectionRecoveryKey";
+        public static final String connectionIdUpdated = "connectionIdUpdated";
+
         public static final String pushActivate = "pushActivate";
         public static final String pushDeactivate = "pushDeactivate";
         public static final String pushReset = "pushReset";

ios/Classes/AblyFlutter.m

@@ -263,6 +263,12 @@ -(void)reset;
     ARTRealtime *const realtime = [[ARTRealtime alloc] initWithOptions:options.clientOptions];
     [instanceStore setRealtime:realtime with:handle];
 
+    [realtime.connection on:^(ARTConnectionStateChange *stateChange) {
+        AblyFlutterMessage *const message =
+              [[AblyFlutterMessage alloc] initWithMessage:[realtime.connection id] handle: handle];
+        [ably.channel invokeMethod:AblyPlatformMethod_connectionIdUpdated arguments:message];
+    }];
+
     // Giving Ably client the deviceToken registered at device launch (didRegisterForRemoteNotificationsWithDeviceToken).
     // This is not an ideal solution. We save the deviceToken given in didRegisterForRemoteNotificationsWithDeviceToken and the
     // error in didFailToRegisterForRemoteNotificationsWithError and pass it to Ably in the first client that is first created.
@@ -586,7 +592,7 @@ -(void)reset;
 
 static const FlutterHandler _restTime = ^void(AblyFlutter *const ably, FlutterMethodCall *const call, const FlutterResult result) {
     AblyFlutterMessage *const ablyMessage = call.arguments;
-    
+
     AblyInstanceStore *const instanceStore = [ably instanceStore];
     ARTRest *const rest = [instanceStore restFrom:ablyMessage.handle];
 
@@ -599,6 +605,30 @@ -(void)reset;
     }];
 };
 
+static const FlutterHandler _connectionId = ^void(AblyFlutter *const ably, FlutterMethodCall *const call, const FlutterResult result) {
+    AblyFlutterMessage *const ablyMessage = call.arguments;
+    AblyInstanceStore *const instanceStore = [ably instanceStore];
+    ARTRealtime *const realtime = [instanceStore realtimeFrom:ablyMessage.handle];
+    NSString *const connectionId = [realtime.connection id];
+    result(connectionId);
+};
+
+static const FlutterHandler _connectionKey = ^void(AblyFlutter *const ably, FlutterMethodCall *const call, const FlutterResult result) {
+    AblyFlutterMessage *const ablyMessage = call.arguments;
+    AblyInstanceStore *const instanceStore = [ably instanceStore];
+    ARTRealtime *const realtime = [instanceStore realtimeFrom:ablyMessage.handle];
+    NSString *const connectionKey = [realtime.connection key];
+    result(connectionKey);
+};
+
+static const FlutterHandler _connectionRecoveryKey = ^void(AblyFlutter *const ably, FlutterMethodCall *const call, const FlutterResult result) {
+    AblyFlutterMessage *const ablyMessage = call.arguments;
+    AblyInstanceStore *const instanceStore = [ably instanceStore];
+    ARTRealtime *const realtime = [instanceStore realtimeFrom:ablyMessage.handle];
+    NSString *const connectionRecoveryKey = [realtime.connection recoveryKey];
+    result(connectionRecoveryKey);
+};
+
 static const FlutterHandler _getNextPage = ^void(AblyFlutter *const ably, FlutterMethodCall *const call, const FlutterResult result) {
     AblyFlutterMessage *const ablyMessage = call.arguments;
 
@@ -741,6 +771,10 @@ -(instancetype)initWithChannel:(FlutterMethodChannel *const)channel
         AblyPlatformMethod_releaseRealtimeChannel: _releaseRealtimeChannel,
         AblyPlatformMethod_realtimeTime:_realtimeTime,
         AblyPlatformMethod_restTime:_restTime,
+        // Connection fields
+        AblyPlatformMethod_connectionId:_connectionId,
+        AblyPlatformMethod_connectionKey:_connectionKey,
+        AblyPlatformMethod_connectionRecoveryKey:_connectionRecoveryKey,
         // Push Notifications
         AblyPlatformMethod_pushActivate: PushHandlers.activate,
         AblyPlatformMethod_pushRequestPermission: PushHandlers.requestPermission,

ios/Classes/codec/AblyPlatformConstants.h

@@ -75,6 +75,12 @@ extern NSString *const AblyPlatformMethod_realtimeAuthAuthorize;
 extern NSString *const AblyPlatformMethod_realtimeAuthCreateTokenRequest;
 extern NSString *const AblyPlatformMethod_realtimeAuthRequestToken;
 extern NSString *const AblyPlatformMethod_realtimeAuthGetClientId;
+
+extern NSString *const AblyPlatformMethod_connectionId;
+extern NSString *const AblyPlatformMethod_connectionKey;
+extern NSString *const AblyPlatformMethod_connectionRecoveryKey;
+extern NSString *const AblyPlatformMethod_connectionIdUpdated;
+
 extern NSString *const AblyPlatformMethod_pushActivate;
 extern NSString *const AblyPlatformMethod_pushDeactivate;
 extern NSString *const AblyPlatformMethod_pushReset;

ios/Classes/codec/AblyPlatformConstants.m

@@ -44,6 +44,12 @@
 NSString *const AblyPlatformMethod_realtimeAuthCreateTokenRequest= @"realtimeAuthCreateTokenRequest";
 NSString *const AblyPlatformMethod_realtimeAuthRequestToken= @"realtimeAuthRequestToken";
 NSString *const AblyPlatformMethod_realtimeAuthGetClientId= @"realtimeAuthGetClientId";
+
+NSString *const AblyPlatformMethod_connectionId = @"connectionId";
+NSString *const AblyPlatformMethod_connectionKey = @"connectionKey";
+NSString *const AblyPlatformMethod_connectionRecoveryKey = @"connectionRecoveryKey";
+NSString *const AblyPlatformMethod_connectionIdUpdated = @"connectionIdUpdated";
+
 NSString *const AblyPlatformMethod_pushActivate= @"pushActivate";
 NSString *const AblyPlatformMethod_pushDeactivate= @"pushDeactivate";
 NSString *const AblyPlatformMethod_pushReset= @"pushReset";

lib/src/generated/platform_constants.dart

@@ -76,6 +76,12 @@ class PlatformMethod {
       'realtimeAuthCreateTokenRequest';
   static const String realtimeAuthRequestToken = 'realtimeAuthRequestToken';
   static const String realtimeAuthGetClientId = 'realtimeAuthGetClientId';
+
+  static const String connectionId = 'connectionId';
+  static const String connectionKey = 'connectionKey';
+  static const String connectionRecoveryKey = 'connectionRecoveryKey';
+  static const String connectionIdUpdated = 'connectionIdUpdated';
+
   static const String pushActivate = 'pushActivate';
   static const String pushDeactivate = 'pushDeactivate';
   static const String pushReset = 'pushReset';

lib/src/platform/src/method_call_handler.dart

@@ -15,6 +15,8 @@ class AblyMethodCallHandler {
           return onAuthCallback(call.arguments as AblyMessage);
         case PlatformMethod.realtimeAuthCallback:
           return onRealtimeAuthCallback(call.arguments as AblyMessage?);
+        case PlatformMethod.connectionIdUpdated:
+          return onConnectionIdUpdated(call.arguments as AblyMessage?);
         case PlatformMethod.pushOnActivate:
           return _onPushOnActivate(call.arguments as ErrorInfo?);
         case PlatformMethod.pushOnDeactivate:
@@ -68,6 +70,15 @@ class AblyMethodCallHandler {
     return realtime.options.authCallback!(tokenParams);
   }
 
+  /// @nodoc
+  /// handles connection id updated for realtime instances
+  Future<Object?> onConnectionIdUpdated(AblyMessage<dynamic>? message) async {
+    final updatedConnId = message!.message as String;
+    final realtime = realtimeInstances[message.handle];
+    realtime?.connection.id = updatedConnId;
+    return null;
+  }
+
   final PushActivationEventsInternal _pushActivationEvents =
       Push.activationEvents as PushActivationEventsInternal;
   final PushNotificationEventsInternal _pushNotificationEvents =

lib/src/platform/src/realtime/connection.dart

@@ -55,8 +55,17 @@ class Connection extends PlatformObject {
   ///
   /// See [connection state recover options](https://ably.com/docs/realtime/connection#connection-state-recover-options)
   /// for more information.
+  @Deprecated('Use createRecoveryKey instead')
   String? recoveryKey;
 
+  /// The createRecoveryKey returns key string can be used by another client to
+  /// recover this connection's state in the recover client options property.
+  ///
+  /// See [connection state recover options](https://ably.com/docs/realtime/connection#connection-state-recover-options)
+  /// for more information.
+  Future<String?> createRecoveryKey() =>
+      invoke<String?>(PlatformMethod.connectionRecoveryKey);
+
   /// The serial number of the last message to be received on this connection,
   /// used automatically by the library when recovering or resuming a
   /// connection.