Stats function implementation

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

@@ -40,6 +40,7 @@
 import io.ably.lib.types.MessageExtras;
 import io.ably.lib.types.Param;
 import io.ably.lib.types.PresenceMessage;
+import io.ably.lib.types.Stats;
 import io.ably.lib.util.Crypto;
 import io.ably.lib.util.Log;
 import io.flutter.plugin.common.StandardMessageCodec;
@@ -112,6 +113,8 @@ public AblyMessageCodec(CipherParamsStorage cipherParamsStorage) {
             new CodecPair<>(null, self::decodeRestHistoryParams));
         put(PlatformConstants.CodecTypes.realtimeHistoryParams,
             new CodecPair<>(null, self::decodeRealtimeHistoryParams));
+        put(PlatformConstants.CodecTypes.stats,
+            new CodecPair<>(self::encodeStats, null));
         put(PlatformConstants.CodecTypes.restPresenceParams,
             new CodecPair<>(null, self::decodeRestPresenceParams));
         put(PlatformConstants.CodecTypes.realtimePresenceParams,
@@ -144,6 +147,81 @@ public AblyMessageCodec(CipherParamsStorage cipherParamsStorage) {
     };
   }
 
+  private Map<String, Object> encodeStats(Stats stats) {
+    if (stats == null) return null;
+    final HashMap<String, Object> jsonMap = new HashMap<>();
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.all, encodeStatsMessageTypes(stats.all));
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.apiRequests, encodeStatsRequestCount(stats.apiRequests));
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.channels, encodeStatsResourceCount(stats.channels));
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.connections, encodeStatsConnectionTypes(stats.connections));
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.inbound, encodeStatsMessageTraffic(stats.inbound));
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.intervalId, stats.intervalId);
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.outbound, encodeStatsMessageTraffic(stats.outbound));
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.persisted, encodeStatsMessageTypes(stats.persisted));
+    writeValueToJson(jsonMap, PlatformConstants.TxStats.tokenRequests, encodeStatsRequestCount(stats.tokenRequests));
+    return jsonMap;
+  }
+
+  private Map<String, Object> encodeStatsMessageTraffic(Stats.MessageTraffic messageTraffic) {
+    if (messageTraffic == null) return null;
+    final HashMap<String, Object> jsonMap = new HashMap<>();
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageTraffic.all, encodeStatsMessageTypes(messageTraffic.all));
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageTraffic.realtime, encodeStatsMessageTypes(messageTraffic.realtime));
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageTraffic.rest, encodeStatsMessageTypes(messageTraffic.rest));
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageTraffic.webhook, encodeStatsMessageTypes(messageTraffic.webhook));
+    return jsonMap;
+  }
+
+  private Map<String, Object> encodeStatsConnectionTypes(Stats.ConnectionTypes connectionTypes) {
+    if (connectionTypes == null) return null;
+    final HashMap<String, Object> jsonMap = new HashMap<>();
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsConnectionTypes.all, encodeStatsResourceCount(connectionTypes.all));
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsConnectionTypes.plain, encodeStatsResourceCount(connectionTypes.plain));
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsConnectionTypes.tls, encodeStatsResourceCount(connectionTypes.tls));
+    return jsonMap;
+  }
+
+  private Map<String, Object> encodeStatsResourceCount(Stats.ResourceCount resourceCount) {
+    if (resourceCount == null) return null;
+    final HashMap<String, Object> jsonMap = new HashMap<>();
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsResourceCount.mean, resourceCount.mean);
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsResourceCount.min, resourceCount.min);
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsResourceCount.opened, resourceCount.opened);
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsResourceCount.peak, resourceCount.peak);
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsResourceCount.refused, resourceCount.refused);
+    return jsonMap;
+  }
+
+  private Map<String, Object> encodeStatsRequestCount(Stats.RequestCount apiRequests) {
+    if (apiRequests == null) return null;
+    final HashMap<String, Object> jsonMap = new HashMap<>();
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsRequestCount.succeeded, apiRequests.succeeded);
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsRequestCount.failed, apiRequests.failed);
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsRequestCount.refused, apiRequests.refused);
+    return jsonMap;
+  }
+
+  private Map<String, Object> encodeStatsMessageTypes(Stats.MessageTypes messageTypes) {
+    if (messageTypes == null) return null;
+    final HashMap<String, Object> jsonMap = new HashMap<>();
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageTypes.all, encodeStatsMessageCategory(messageTypes.all));
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageTypes.messages, encodeStatsMessageCategory(messageTypes.messages));
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageTypes.presence, encodeStatsMessageCategory(messageTypes.presence));
+    return jsonMap;
+  }
+
+  // This is different in other platform and will correspond to StatsMessageCount for other
+  // libraries
+  private Map<String, Object> encodeStatsMessageCategory(Stats.MessageCategory category) {
+    if (category == null) return null;
+    final HashMap<String, Object> jsonMap = new HashMap<>();
+
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageCount.count, category.count);
+    writeValueToJson(jsonMap, PlatformConstants.TxStatsMessageCount.data, category.data);
+
+    return jsonMap;
+  }
+
   @Override
   protected Object readValueOfType(final byte type, final ByteBuffer buffer) {
     CodecPair pair = codecMap.get(type);
@@ -199,6 +277,8 @@ private Byte getType(Object value) {
     } else if (value instanceof ChannelOptions) {
       // Encoding it into a RealtimeChannelOptions instance, because it extends RestChannelOptions
       return PlatformConstants.CodecTypes.realtimeChannelOptions;
+    } else if (value instanceof Stats) {
+      return PlatformConstants.CodecTypes.stats;
     }
     return null;
   }
@@ -303,9 +383,13 @@ private PlatformClientOptions decodeClientOptions(Map<String, Object> jsonMap) {
     readValueFromJson(jsonMap, PlatformConstants.TxClientOptions.realtimeHost, v -> o.realtimeHost = (String) v);
     readValueFromJson(jsonMap, PlatformConstants.TxClientOptions.port, v -> o.port = (Integer) v);
     readValueFromJson(jsonMap, PlatformConstants.TxClientOptions.tlsPort, v -> o.tlsPort = (Integer) v);
-    o.autoConnect = false; // Always avoid auto-connect, to allow handle to be returned back to Dart side before authCallback is called.
-    // If the user specifies autoConnect, we call connect once we get the handle back to the dart side
-    // In other words, Ably Flutter internally manually connects, but to the SDK user this looks like autoConnect.
+    /* Always avoid auto-connect, to allow handle to be returned back to Dart side before
+     * authCallback is called.
+     * If the user specifies autoConnect, we call connect once we get the handle back to the dart side
+     * In other words, Ably Flutter internally manually connects, but to the SDK user this looks
+     * like autoConnect.
+     */
+    o.autoConnect = false;
     readValueFromJson(jsonMap, PlatformConstants.TxClientOptions.useBinaryProtocol, v -> o.useBinaryProtocol = (Boolean) v);
     readValueFromJson(jsonMap, PlatformConstants.TxClientOptions.queueMessages, v -> o.queueMessages = (Boolean) v);
     readValueFromJson(jsonMap, PlatformConstants.TxClientOptions.echoMessages, v -> o.echoMessages = (Boolean) v);

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

@@ -25,6 +25,7 @@
 import io.ably.lib.realtime.Channel;
 import io.ably.lib.realtime.CompletionListener;
 import io.ably.lib.realtime.Presence;
+import io.ably.lib.rest.AblyBase;
 import io.ably.lib.rest.AblyRest;
 import io.ably.lib.rest.Auth;
 import io.ably.lib.transport.Defaults;
@@ -87,6 +88,9 @@ public AblyMethodCallHandler(final MethodChannel methodChannel,
     _map.put(PlatformConstants.PlatformMethod.realtimePresenceUpdate, this::updateRealtimePresence);
     _map.put(PlatformConstants.PlatformMethod.realtimePresenceLeave, this::leaveRealtimePresence);
     _map.put(PlatformConstants.PlatformMethod.releaseRealtimeChannel, this::releaseRealtimeChannel);
+    _map.put(PlatformConstants.PlatformMethod.realtimeTime, this::realtimeTime);
+    _map.put(PlatformConstants.PlatformMethod.restTime, this::restTime);
+    _map.put(PlatformConstants.PlatformMethod.stats, this::stats);
 
     // Push Notifications
     _map.put(PlatformConstants.PlatformMethod.pushActivate, this::pushActivate);
@@ -304,6 +308,26 @@ private void getRestHistory(@NonNull MethodCall call, @NonNull MethodChannel.Res
     });
   }
 
+  private void stats(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
+    final AblyFlutterMessage message = (AblyFlutterMessage) call.arguments;
+    final AblyFlutterMessage<Map<String, Object>> paramsMessage =
+        (AblyFlutterMessage<Map<String, Object>>) message.message;
+    final Map<String, Object> map = paramsMessage.message;
+    final HashMap<String, Object> paramsMap =
+        (HashMap<String, Object>) map.get(PlatformConstants.TxTransportKeys.params);
+    Param[] params = new Param[paramsMap != null ? paramsMap.size() : 0];
+    if (paramsMap != null) {
+      int i = 0;
+      for (String paramKey : paramsMap.keySet()) {
+        final Param param = new Param(paramKey, paramsMap.get(paramKey));
+        params[i++] = param;
+      }
+    }
+    instanceStore
+        .getRest(paramsMessage.handle)
+        .statsAsync(params, this.paginatedResponseHandler(result, null));
+  }
+
   private void getRestPresence(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
     final AblyFlutterMessage message = (AblyFlutterMessage) call.arguments;
     this.<AblyFlutterMessage<Map<String, Object>>>ablyDo(message, (ablyLibrary, messageData) -> {
@@ -600,7 +624,33 @@ private void releaseRealtimeChannel(@NonNull MethodCall call, @NonNull MethodCha
     });
   }
 
-  private void getRealtimeHistory(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
+    private void realtimeTime(@NonNull MethodCall methodCall, @NonNull MethodChannel.Result result) {
+        final AblyFlutterMessage message = (AblyFlutterMessage) methodCall.arguments;
+        time(result, instanceStore.getRealtime((int) message.message));
+    }
+
+    private void restTime(@NonNull MethodCall methodCall, @NonNull MethodChannel.Result result) {
+        final AblyFlutterMessage message = (AblyFlutterMessage) methodCall.arguments;
+        time(result, instanceStore.getRest((int) message.message));
+    }
+
+    private void time(@NonNull MethodChannel.Result result, AblyBase client) {
+        Callback<Long> callback = new Callback<Long>() {
+            @Override
+            public void onSuccess(Long timeResult) {
+                result.success(timeResult);
+            }
+
+            @Override
+            public void onError(ErrorInfo reason) {
+                result.error("40000", reason.message, reason);
+            }
+        };
+        client.timeAsync(callback);
+    }
+
+
+    private void getRealtimeHistory(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
     final AblyFlutterMessage message = (AblyFlutterMessage) call.arguments;
     this.<AblyFlutterMessage<Map<String, Object>>>ablyDo(message, (ablyLibrary, messageData) -> {
       final Map<String, Object> map = messageData.message;

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

@@ -26,16 +26,17 @@ static final public class CodecTypes {
         public static final byte restPresenceParams = (byte) 142;
         public static final byte presenceMessage = (byte) 143;
         public static final byte realtimePresenceParams = (byte) 144;
-        public static final byte deviceDetails = (byte) 145;
-        public static final byte localDevice = (byte) 146;
-        public static final byte pushChannelSubscription = (byte) 147;
-        public static final byte unNotificationSettings = (byte) 148;
-        public static final byte remoteMessage = (byte) 149;
-        public static final byte errorInfo = (byte) 150;
-        public static final byte logLevel = (byte) 151;
-        public static final byte connectionStateChange = (byte) 152;
-        public static final byte channelStateChange = (byte) 153;
-        public static final byte cipherParams = (byte) 154;
+        public static final byte stats = (byte) 145;
+        public static final byte deviceDetails = (byte) 146;
+        public static final byte localDevice = (byte) 147;
+        public static final byte pushChannelSubscription = (byte) 148;
+        public static final byte unNotificationSettings = (byte) 149;
+        public static final byte remoteMessage = (byte) 150;
+        public static final byte errorInfo = (byte) 151;
+        public static final byte logLevel = (byte) 152;
+        public static final byte connectionStateChange = (byte) 153;
+        public static final byte channelStateChange = (byte) 154;
+        public static final byte cipherParams = (byte) 155;
     }
 
     static final public class PlatformMethod {
@@ -66,6 +67,9 @@ static final public class PlatformMethod {
         public static final String publishRealtimeChannelMessage = "publishRealtimeChannelMessage";
         public static final String releaseRealtimeChannel = "releaseRealtimeChannel";
         public static final String realtimeHistory = "realtimeHistory";
+        public static final String realtimeTime = "realtimeTime";
+        public static final String restTime = "restTime";
+        public static final String stats = "stats";
         public static final String pushActivate = "pushActivate";
         public static final String pushDeactivate = "pushDeactivate";
         public static final String pushSubscribeDevice = "pushSubscribeDevice";
@@ -444,4 +448,54 @@ static final public class TxCryptoGenerateRandomKey {
         public static final String keyLength = "keyLength";
     }
 
+    static final public class TxStats {
+        public static final String all = "all";
+        public static final String apiRequests = "apiRequests";
+        public static final String channels = "channels";
+        public static final String connections = "connections";
+        public static final String inbound = "inbound";
+        public static final String intervalId = "intervalId";
+        public static final String outbound = "outbound";
+        public static final String persisted = "persisted";
+        public static final String tokenRequests = "tokenRequests";
+    }
+
+    static final public class TxStatsMessageTypes {
+        public static final String all = "all";
+        public static final String messages = "messages";
+        public static final String presence = "presence";
+    }
+
+    static final public class TxStatsMessageCount {
+        public static final String count = "count";
+        public static final String data = "data";
+    }
+
+    static final public class TxStatsRequestCount {
+        public static final String failed = "failed";
+        public static final String refused = "refused";
+        public static final String succeeded = "succeeded";
+    }
+
+    static final public class TxStatsResourceCount {
+        public static final String mean = "mean";
+        public static final String min = "min";
+        public static final String opened = "opened";
+        public static final String peak = "peak";
+        public static final String refused = "refused";
+    }
+
+    static final public class TxStatsConnectionTypes {
+        public static final String all = "all";
+        public static final String plain = "plain";
+        public static final String tls = "tls";
+    }
+
+    static final public class TxStatsMessageTraffic {
+        public static final String all = "all";
+        public static final String realtime = "realtime";
+        public static final String rest = "rest";
+        public static final String webhook = "webhook";
+    }
+
 }

bin/codegen_context.dart

@@ -21,6 +21,7 @@ Iterable<Map<String, dynamic>> get _types sync* {
     'restPresenceParams',
     'presenceMessage',
     'realtimePresenceParams',
+    'stats',
 
     // Push Notifications
     'deviceDetails',
@@ -94,6 +95,9 @@ const List<Map<String, dynamic>> _platformMethods = [
   },
   {'name': 'releaseRealtimeChannel', 'value': 'releaseRealtimeChannel'},
   {'name': 'realtimeHistory', 'value': 'realtimeHistory'},
+  {'name': 'realtimeTime', 'value': 'realtimeTime'},
+  {'name': 'restTime', 'value': 'restTime'},
+  {'name': 'stats', 'value': 'stats'},
 
   // Push Notifications
   {'name': 'pushActivate', 'value': 'pushActivate'},
@@ -507,6 +511,44 @@ const List<Map<String, dynamic>> _objects = [
   {
     'name': 'CryptoGenerateRandomKey',
     'properties': ['keyLength']
+  },
+  {
+    'name': 'Stats',
+    'properties': <String>[
+      'all',
+      'apiRequests',
+      'channels',
+      'connections',
+      'inbound',
+      'intervalId',
+      'outbound',
+      'persisted',
+      'tokenRequests'
+    ]
+  },
+  {
+    'name': 'StatsMessageTypes',
+    'properties': <String>['all', 'messages', 'presence']
+  },
+  {
+    'name': 'StatsMessageCount',
+    'properties': <String>['count', 'data']
+  },
+  {
+    'name': 'StatsRequestCount',
+    'properties': <String>['failed', 'refused', 'succeeded']
+  },
+  {
+    'name': 'StatsResourceCount',
+    'properties': <String>['mean', 'min', 'opened', 'peak', 'refused']
+  },
+  {
+    'name': 'StatsConnectionTypes',
+    'properties': <String>['all', 'plain', 'tls']
+  },
+  {
+    'name': 'StatsMessageTraffic',
+    'properties': <String>['all', 'realtime', 'rest', 'webhook']
   }
 ];
 

example/lib/ui/realtime_sliver.dart

@@ -153,8 +153,10 @@ class RealtimeSliver extends HookWidget {
     final latestMessage = useState<ably.Message?>(null);
     final channelSubscription =
         useState<StreamSubscription<ably.Message>?>(null);
+    final realtimeTime = useState<DateTime?>(null);
 
     useEffect(() {
+      realtime.time().then((value) => realtimeTime.value = value);
       setupListeners(connectionState, channelState);
       return dispose;
     }, []);
@@ -166,6 +168,7 @@ class RealtimeSliver extends HookWidget {
           'Realtime',
           style: TextStyle(fontSize: 24, fontWeight: FontWeight.bold),
         ),
+        Text('Realtime time: ${realtimeTime.value}'),
         Text('Connection State: ${connectionState.value}'),
         Row(
           children: <Widget>[