addressing feedback

flutter · auto-submit · Oct 26, 2023 · Aug 18, 2023 · Aug 22, 2023 · Aug 22, 2023
commit 7b6272f7577e7eb0cd540684b21cacebd292fa01
@@ -38,7 +38,8 @@ final class URLLaunchSession: NSObject, SFSafariViewControllerDelegate {
   ///   - controller: The Safari view controller.
   ///   - didLoadSuccessfully: Indicates if the initial load was successful.
   func safariViewController(
-    _ controller: SFSafariViewController, didCompleteInitialLoad didLoadSuccessfully: Bool
+    _ controller: SFSafariViewController,
+    didCompleteInitialLoad didLoadSuccessfully: Bool
   ) {
     if didLoadSuccessfully {
       completion(.success(.success))

@@ -34,7 +34,8 @@ public final class URLLauncherPlugin: NSObject, FlutterPlugin, UrlLauncherApi {
   }
 
   func launchUrl(
-    url: String, universalLinksOnly: Bool,
+    url: String,
+    universalLinksOnly: Bool,
     completion: @escaping (Result<LaunchResult, Error>) -> Void
   ) {
     guard let url = URL(string: url) else {
@@ -48,7 +49,8 @@ public final class URLLauncherPlugin: NSObject, FlutterPlugin, UrlLauncherApi {
   }
 
   func openUrlInSafariViewController(
-    url: String, completion: @escaping (Result<LaunchResult, Error>) -> Void
+    url: String,
+    completion: @escaping (Result<LaunchResult, Error>) -> Void
   ) {
     guard let url = URL(string: url) else {
       completion(.success(.failedToLoad))
@@ -64,7 +66,7 @@ public final class URLLauncherPlugin: NSObject, FlutterPlugin, UrlLauncherApi {
     topViewController?.present(session.safariViewController, animated: true, completion: nil)
   }
 
-  func closeSafariViewController() throws {
+  func closeSafariViewController() {
     currentSession?.close()
   }
 }

@@ -5,13 +5,12 @@
 // See also: https://pub.dev/packages/pigeon
 
 import Foundation
-
 #if os(iOS)
-  import Flutter
+import Flutter
 #elseif os(macOS)
-  import FlutterMacOS
+import FlutterMacOS
 #else
-  #error("Unsupported platform.")
+#error("Unsupported platform.")
 #endif
 
 private func isNullish(_ value: Any?) -> Bool {
@@ -27,13 +26,13 @@ private func wrapError(_ error: Any) -> [Any?] {
     return [
       flutterError.code,
       flutterError.message,
-      flutterError.details,
+      flutterError.details
     ]
   }
   return [
     "\(error)",
     "\(type(of: error))",
-    "Stacktrace: \(Thread.callStackSymbols)",
+    "Stacktrace: \(Thread.callStackSymbols)"
   ]
 }
 
@@ -46,9 +45,9 @@ private func nilOrValue<T>(_ value: Any?) -> T? {
 enum LaunchResult: Int {
   /// The URL was successfully launched.
   case success = 0
-  /// The URL could not be launched
+  /// The URL could not be launched.
   case failedToLoad = 1
-  /// The URL was not launched because it is not invalid URL
+  /// The URL was not launched because the URL is invalid.
   case invalidUrl = 2
 }
 
@@ -57,13 +56,10 @@ protocol UrlLauncherApi {
   /// Returns true if the URL can definitely be launched.
   func canLaunchUrl(url: String) throws -> LaunchResult
   /// Opens the URL externally, returning true if successful.
-  func launchUrl(
-    url: String, universalLinksOnly: Bool,
-    completion: @escaping (Result<LaunchResult, Error>) -> Void)
+  func launchUrl(url: String, universalLinksOnly: Bool, completion: @escaping (Result<LaunchResult, Error>) -> Void)
   /// Opens the URL in an in-app SFSafariViewController, returning true
   /// when it has loaded successfully.
-  func openUrlInSafariViewController(
-    url: String, completion: @escaping (Result<LaunchResult, Error>) -> Void)
+  func openUrlInSafariViewController(url: String, completion: @escaping (Result<LaunchResult, Error>) -> Void)
   /// Closes the view controller opened by [openUrlInSafariViewController].
   func closeSafariViewController() throws
 }
@@ -74,9 +70,7 @@ class UrlLauncherApiSetup {
   /// Sets up an instance of `UrlLauncherApi` to handle messages through the `binaryMessenger`.
   static func setUp(binaryMessenger: FlutterBinaryMessenger, api: UrlLauncherApi?) {
     /// Returns true if the URL can definitely be launched.
-    let canLaunchUrlChannel = FlutterBasicMessageChannel(
-      name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.canLaunchUrl",
-      binaryMessenger: binaryMessenger)
+    let canLaunchUrlChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.canLaunchUrl", binaryMessenger: binaryMessenger)
     if let api = api {
       canLaunchUrlChannel.setMessageHandler { message, reply in
         let args = message as! [Any?]
@@ -92,20 +86,18 @@ class UrlLauncherApiSetup {
       canLaunchUrlChannel.setMessageHandler(nil)
     }
     /// Opens the URL externally, returning true if successful.
-    let launchUrlChannel = FlutterBasicMessageChannel(
-      name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.launchUrl",
-      binaryMessenger: binaryMessenger)
+    let launchUrlChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.launchUrl", binaryMessenger: binaryMessenger)
     if let api = api {
       launchUrlChannel.setMessageHandler { message, reply in
         let args = message as! [Any?]
         let urlArg = args[0] as! String
         let universalLinksOnlyArg = args[1] as! Bool
         api.launchUrl(url: urlArg, universalLinksOnly: universalLinksOnlyArg) { result in
           switch result {
-          case .success(let res):
-            reply(wrapResult(res.rawValue))
-          case .failure(let error):
-            reply(wrapError(error))
+            case .success(let res):
+              reply(wrapResult(res.rawValue))
+            case .failure(let error):
+              reply(wrapError(error))
           }
         }
       }
@@ -114,29 +106,25 @@ class UrlLauncherApiSetup {
     }
     /// Opens the URL in an in-app SFSafariViewController, returning true
     /// when it has loaded successfully.
-    let openUrlInSafariViewControllerChannel = FlutterBasicMessageChannel(
-      name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.openUrlInSafariViewController",
-      binaryMessenger: binaryMessenger)
+    let openUrlInSafariViewControllerChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.openUrlInSafariViewController", binaryMessenger: binaryMessenger)
     if let api = api {
       openUrlInSafariViewControllerChannel.setMessageHandler { message, reply in
         let args = message as! [Any?]
         let urlArg = args[0] as! String
         api.openUrlInSafariViewController(url: urlArg) { result in
           switch result {
-          case .success(let res):
-            reply(wrapResult(res.rawValue))
-          case .failure(let error):
-            reply(wrapError(error))
+            case .success(let res):
+              reply(wrapResult(res.rawValue))
+            case .failure(let error):
+              reply(wrapError(error))
           }
         }
       }
     } else {
       openUrlInSafariViewControllerChannel.setMessageHandler(nil)
     }
     /// Closes the view controller opened by [openUrlInSafariViewController].
-    let closeSafariViewControllerChannel = FlutterBasicMessageChannel(
-      name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.closeSafariViewController",
-      binaryMessenger: binaryMessenger)
+    let closeSafariViewControllerChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.closeSafariViewController", binaryMessenger: binaryMessenger)
     if let api = api {
       closeSafariViewControllerChannel.setMessageHandler { _, reply in
         do {

@@ -16,10 +16,10 @@ enum LaunchResult {
   /// The URL was successfully launched.
   success,
 
-  /// The URL could not be launched
+  /// The URL could not be launched.
   failedToLoad,
 
-  /// The URL was not launched because it is not invalid URL
+  /// The URL was not launched because the URL is invalid.
   invalidUrl,
 }
 

@@ -66,16 +66,15 @@ class UrlLauncherIOS extends UrlLauncherPlatform {
     required final LaunchResult results,
     required String url,
   }) {
-    // Replace this in https://github.com/flutter/flutter/issues/127665
-    // This is temporary since FlutterError is not a NSError.
-    // The PlatformExceptions thrown here are for compatibility with the
-    // previous Objective-C implementation.
     switch (results) {
       case LaunchResult.success:
         return true;
       case LaunchResult.failedToLoad:
         return false;
       case LaunchResult.invalidUrl:
+        // TODO(stuartmorgan): Remove this as part of standardizing error handling. See
+        // flutter/flutter#127665
+        // The PlatformExceptions thrown here is for compatibility with the previous implementation.
         throw PlatformException(
           code: 'invalidUrl',
           message: 'Unable to parse URL $url',

@@ -15,10 +15,10 @@ enum LaunchResult {
   /// The URL was successfully launched.
   success,
 
-  /// The URL could not be launched
+  /// The URL could not be launched.
   failedToLoad,
 
-  /// The URL was not launched because it is not invalid URL
+  /// The URL was not launched because the URL is invalid.
   invalidUrl,
 }
 

@@ -115,7 +115,7 @@ void main() {
       );
       expect(
           await launcher.launch(
-            'invalid://u r l',
+            'unknown://scheme',
             useSafariVC: false,
             useWebView: false,
             enableJavaScript: false,