Merge pull request #36 from mysteriumnetwork/connection-status-2

Connection status stream for iOS/macOS fixed

.swiftformat

@@ -0,0 +1,36 @@
+# file options
+
+--symlinks ignore
+--swiftversion 5.7
+
+# rules
+--enable isEmpty
+--disable andOperator
+--disable wrapMultilineStatementBraces
+
+# format options
+
+--commas inline
+--comments indent
+--decimalgrouping 3,5
+--exponentcase lowercase
+--exponentgrouping disabled
+--extensionacl on-declarations
+--fractiongrouping disabled
+--ifdef no-indent
+--importgrouping testable-top
+--operatorfunc no-space
+--nospaceoperators ..<, ...
+--selfrequired validate
+--someAny false
+--stripunusedargs closure-only
+--wraparguments preserve
+--wrapcollections preserve
+--wrapparameters preserve
+
+
+# rules
+
+--enable isEmpty
+--disable wrapMultilineStatementBraces
+--disable opaqueGenericParameters

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.5.0](https://github.com/mysteriumnetwork/wireguard_dart/tree/0.5.0) (2024-01-18)
+
+- darwin: Fix connection status streaming. Two available methods are `.status()` and `.statusStream()`
+- `.status()` now returns an unwrapped status instead of a map
+- Add a required `tunnelName` option in addition to `bundleId`
+
+[Full Changelog](https://github.com/mysteriumnetwork/wireguard_dart/compare/0.4.5...0.5.0)
+
 ## [0.4.5](https://github.com/mysteriumnetwork/wireguard_dart/tree/0.4.5) (2023-08-04)
 
 [Full Changelog](https://github.com/mysteriumnetwork/wireguard_dart/compare/0.4.4...0.4.5)

README.md

@@ -2,6 +2,9 @@
 
 A flutter plugin to setup and control VPN connection via [Wireguard](https://www.wireguard.com/) tunnel.
 
+It includes [Wireguard implementation for the corresponding OS](https://www.wireguard.com/embedding/) (WireGuardKit for darwin, com.wireguard.android:tunnel for android, etc.) and does not require any additional dependencies.
+
+
 |             | Android | iOS   | Linux | macOS | Windows     |
 |-------------|---------|-------|-------|-------|-------------|
 | **Support** | 21+     | 15.0+ | TBD   | 12+   | 10+         |

android/src/main/kotlin/network/mysterium/wireguard_dart/WireguardDartPlugin.kt

@@ -77,7 +77,7 @@ class WireguardDartPlugin : FlutterPlugin, MethodCallHandler, ActivityAware,
 
     override fun onAttachedToEngine(flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
         channel = MethodChannel(flutterPluginBinding.binaryMessenger, "wireguard_dart")
-        statusChannel = EventChannel(flutterPluginBinding.binaryMessenger, "wireguard_dart.status")
+        statusChannel = EventChannel(flutterPluginBinding.binaryMessenger, "wireguard_dart/status")
         statusBroadcaster = ConnectionStatusBroadcaster()
         statusChannel.setStreamHandler(statusBroadcaster)
         context = flutterPluginBinding.applicationContext

darwin/Classes/ConnectionStatus.swift

@@ -0,0 +1,25 @@
+import Foundation
+import NetworkExtension
+
+/// ConnectionStatus returned to Dart
+enum ConnectionStatus: String {
+    case connected
+    case disconnected
+    case connecting
+    case disconnecting
+    case unknown
+
+    static func fromNEVPNStatus(status: NEVPNStatus) -> ConnectionStatus {
+        switch status {
+        case .connected: return ConnectionStatus.connected
+        case .disconnected: return ConnectionStatus.disconnected
+        case .connecting: return ConnectionStatus.connecting
+        case .disconnecting: return ConnectionStatus.disconnecting
+        default: return ConnectionStatus.unknown
+        }
+    }
+
+    func string() -> String {
+        rawValue
+    }
+}

darwin/Classes/ConnectionStatusObserver.swift

@@ -1,73 +1,52 @@
+#if os(iOS)
+import Flutter
+import UIKit
+#elseif os(macOS)
 import Cocoa
 import FlutterMacOS
+#else
+#error("Unsupported platform")
+#endif
+
 import NetworkExtension
+import os
 import WireGuardKit
 
-public class ConnectionStatusObserver: NSObject, FlutterStreamHandler {
-
-  private var _sink: FlutterEventSink?
-  private var _vpnManager: NETunnelProviderManager
-
-  private var pIsRunning: Bool = false
-  var isRunning: Bool {
-    pIsRunning
-  }
-
-  init(vpnManager: NETunnelProviderManager) {
-    _vpnManager = vpnManager
-  }
-
-  public func _statusChanged(_: Notification?) {
-      guard let sink = _sink else {
-                  return
-              }
-    let status = _vpnManager.connection.status
-      let mappedStatus: Dictionary<String, String> = {
-      switch status {
-      case .connected:
-        return ["status": "connected"]
-      case .disconnected:
-        return ["status": "connected"]
-      case .connecting:
-        return ["status": "connecting"]
-      case .disconnecting:
-        return ["status": "disconnecting"]
-      default:
-        return ["status": "unknown"]
-      }
-    }()
-      sink(mappedStatus)
-  }
-
-  public func onListen(withArguments arguments: Any?, eventSink events: @escaping FlutterEventSink)
-    -> FlutterError?
-  {
-    _sink = events
-
-    if !pIsRunning {
-      NotificationCenter.default.addObserver(
-        forName: NSNotification.Name.NEVPNStatusDidChange,
-        object: nil,
-        queue: OperationQueue.main,
-        using: _statusChanged
-      )
+class ConnectionStatusObserver: NSObject, FlutterStreamHandler {
+    private var eventSink: FlutterEventSink?
+    private var isRunning: Bool = false
+
+    override init() {
+        super.init()
+        NotificationCenter.default.addObserver(
+            forName: NSNotification.Name.NEVPNStatusDidChange,
+            object: nil,
+            queue: OperationQueue.main,
+            using: handleStatusChanged
+        )
     }
 
-    pIsRunning = true
-
-    // Send the initial data.
-
-    // No errors.
-    return nil
-  }
+    deinit {
+        NotificationCenter.default.removeObserver(self)
+    }
 
-  public func onCancel(withArguments arguments: Any?) -> FlutterError? {
-    pIsRunning = false
+    public func handleStatusChanged(notification: Notification?) {
+        guard let conn = notification?.object as? NEVPNConnection else {
+            return
+        }
+        let newStatus = ConnectionStatus.fromNEVPNStatus(status: conn.status)
 
-    NotificationCenter.default.removeObserver(self)
+        Logger.main.debug("VPN status changed: \(newStatus.string())")
+        eventSink?(newStatus.string())
+    }
 
-    _sink = nil
+    public func onListen(withArguments arguments: Any?, eventSink events: @escaping FlutterEventSink) -> FlutterError? {
+        eventSink = events
+        return nil
+    }
 
-    return nil
-  }
+    public func onCancel(withArguments arguments: Any?) -> FlutterError? {
+        eventSink = nil
+        return nil
+    }
 }

darwin/Classes/FlutterError.swift

@@ -0,0 +1,11 @@
+#if os(iOS)
+import Flutter
+#elseif os(macOS)
+import FlutterMacOS
+#else
+#error("Unsupported platform")
+#endif
+
+func nativeFlutterError(message: String) -> FlutterError {
+    FlutterError(code: "NATIVE_ERR", message: message, details: nil)
+}

darwin/Classes/Logger.swift

@@ -0,0 +1,7 @@
+import Foundation
+import os.log
+
+extension Logger {
+    private static var subsystem = Bundle.main.bundleIdentifier!
+    public static let main = Logger(subsystem: subsystem, category: "main")
+}