Stats implementation

.github/workflows/check.yaml

@@ -5,7 +5,28 @@ on:
       - main
 
 jobs:
-  check:
+  swift:
+    name: "Swift formatting checks"
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: 'Install SwiftFormat'
+        run: 'brew install swiftformat'
+
+      - name: Run SwiftFormat
+        run: swiftformat --lint --swiftversion 5.5 .
+  java:
+    name: "Java formatting checks"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: axel-op/googlejavaformat-action@v3
+        with:
+          args: "--set-exit-if-changed --dry-run"
+  dart:
+    name: "Dart formatting and analyzer checks"
     runs-on: ubuntu-latest
     steps:
 
@@ -20,7 +41,7 @@ jobs:
           cd test_integration && flutter pub get && cd ..
           cd example && flutter pub get && cd ..
 
-      - name: 'Check formatting issues in the code'
+      - name: 'Check Dart formatting issues in the code'
         run: flutter format --set-exit-if-changed .
 
       - name: 'Flutter analyze help'

PushNotifications.md

@@ -358,9 +358,11 @@ Take a look at the example app platform specific code to handle messages. For iO
 
 **iOS:** Some iOS dependencies perform techniques such as [method swizzling](https://nshipster.com/method-swizzling/) which break other iOS dependencies and Flutter Plugin packages.
 
-### Deactivating the device
+## Device deactivation
 
-Do this only if you do not want the device to receive push notifications at all. You usually do not need to run this at all. 
+Do this only if you do not want the device to receive push notifications at all. You usually do not need to run this at all, and especially don't need to deactivate and re-activate on every launch.
+
+Like device activation, the `Future` returned by `activate` is not guaranteed to complete quickly.
 
 ```dart
     try {

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

@@ -32,6 +32,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;
@@ -121,6 +122,7 @@ public AblyMessageCodec(CipherParamsStorage cipherParamsStorage) {
             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));
@@ -168,6 +170,125 @@ 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,
+        encodeMessageCategory(messageTypes.all));
+    writeValueToJson(
+        jsonMap,
+        PlatformConstants.TxStatsMessageTypes.messages,
+        encodeMessageCategory(messageTypes.messages));
+    writeValueToJson(
+        jsonMap,
+        PlatformConstants.TxStatsMessageTypes.presence,
+        encodeMessageCategory(messageTypes.presence));
+    return jsonMap;
+  }
+
+  // This is different in other platform and will correspond to StatsMessageCount for other
+  // libraries
+  private Map<String, Object> encodeMessageCategory(Stats.MessageCategory category) {
+    if (category == null) return null;
+    if (category.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);