addresses feedback

packages/url_launcher/url_launcher_ios/example/ios/RunnerTests/URLLauncherTests.swift

@@ -20,34 +20,28 @@ final class URLLauncherTests: XCTestCase {
 
   func testCanLaunchSuccess() {
     let result = createPlugin().canLaunchUrl(url: "good://url")
-    XCTAssertEqual(result.result, .success)
+    XCTAssertEqual(result, .success)
   }
 
   func testCanLaunchFailure() {
     let result = createPlugin().canLaunchUrl(url: "bad://url")
-    XCTAssertEqual(result.result, .failure)
+    XCTAssertEqual(result, .failedToLoad)
   }
 
   func testCanLaunchFailureWithInvalidURL() {
     let result = createPlugin().canLaunchUrl(url: "urls can't have spaces")
-    if result.result == .failure {
-      // When linking against the iOS 17 SDK or later, NSURL uses a lenient parser, and won't
-      // fail to parse URLs, so the test must allow for either outcome.
-      XCTAssertNil(result.errorMessage)
-      XCTAssertNil(result.errorDetails)
-    } else {
-      XCTAssertEqual(result.result, .invalidUrl)
-      XCTAssertEqual(result.errorMessage, "Unable to parse URL")
-      XCTAssertEqual(result.errorDetails, "Provided URL: urls can't have spaces")
-    }
+
+    // When linking against the iOS 17 SDK or later, NSURL uses a lenient parser, and won't
+    // fail to parse URLs, so the test must allow for either outcome.
+    XCTAssertTrue(result == .failedToLoad || result == .invalidUrl)
   }
 
   func testLaunchSuccess() {
     let expectation = XCTestExpectation(description: "completion called")
     createPlugin().launchUrl(url: "good://url", universalLinksOnly: false) { result in
       switch result {
       case .success(let details):
-        XCTAssertEqual(details.result, .success)
+        XCTAssertEqual(details, .success)
       case .failure(let error):
         XCTFail("Unexpected error: \(error)")
       }
@@ -62,7 +56,7 @@ final class URLLauncherTests: XCTestCase {
     createPlugin().launchUrl(url: "bad://url", universalLinksOnly: false) { result in
       switch result {
       case .success(let details):
-        XCTAssertEqual(details.result, .failure)
+        XCTAssertEqual(details, .failedToLoad)
       case .failure(let error):
         XCTFail("Unexpected error: \(error)")
       }
@@ -77,16 +71,9 @@ final class URLLauncherTests: XCTestCase {
     createPlugin().launchUrl(url: "urls can't have spaces", universalLinksOnly: false) { result in
       switch result {
       case .success(let details):
-        if details.result == .failure {
-          // When linking against the iOS 17 SDK or later, NSURL uses a lenient parser, and won't
-          // fail to parse URLs, so the test must allow for either outcome.
-          XCTAssertNil(details.errorMessage)
-          XCTAssertNil(details.errorDetails)
-        } else {
-          XCTAssertEqual(details.result, .invalidUrl)
-          XCTAssertEqual(details.errorMessage, "Unable to parse URL")
-          XCTAssertEqual(details.errorDetails, "Provided URL: urls can't have spaces")
-        }
+        // When linking against the iOS 17 SDK or later, NSURL uses a lenient parser, and won't
+        // fail to parse URLs, so the test must allow for either outcome.
+        XCTAssertTrue(details == .failedToLoad || details == .invalidUrl)
       case .failure(let error):
         XCTFail("Unexpected error: \(error)")
       }
@@ -104,7 +91,7 @@ final class URLLauncherTests: XCTestCase {
     plugin.launchUrl(url: "good://url", universalLinksOnly: false) { result in
       switch result {
       case .success(let details):
-        XCTAssertEqual(details.result, .success)
+        XCTAssertEqual(details, .success)
       case .failure(let error):
         XCTFail("Unexpected error: \(error)")
       }
@@ -123,7 +110,7 @@ final class URLLauncherTests: XCTestCase {
     plugin.launchUrl(url: "good://url", universalLinksOnly: true) { result in
       switch result {
       case .success(let details):
-        XCTAssertEqual(details.result, .success)
+        XCTAssertEqual(details, .success)
       case .failure(let error):
         XCTFail("Unexpected error: \(error)")
       }
@@ -144,7 +131,8 @@ final private class FakeLauncher: NSObject, Launcher {
   }
 
   func openURL(
-    _ url: URL, options: [UIApplication.OpenExternalURLOptionsKey: Any],
+    _ url: URL,
+    options: [UIApplication.OpenExternalURLOptionsKey: Any],
     completionHandler completion: ((Bool) -> Void)?
   ) {
     self.passedOptions = options

packages/url_launcher/url_launcher_ios/ios/Classes/Launcher.swift

@@ -6,9 +6,13 @@
 ///
 /// This protocol exists to allow injecting an alternate implementation for testing.
 protocol Launcher {
+  /// Returns a Boolean value that indicates whether an app is available to handle a URL scheme.
   func canOpenURL(_ url: URL) -> Bool
+
+  /// Attempts to asynchronously open the resource at the specified URL.
   func openURL(
-    _ url: URL, options: [UIApplication.OpenExternalURLOptionsKey: Any],
+    _ url: URL,
+    options: [UIApplication.OpenExternalURLOptionsKey: Any],
     completionHandler completion: ((Bool) -> Void)?)
 }
 
@@ -19,7 +23,8 @@ final class UIApplicationLauncher: Launcher {
   }
 
   func openURL(
-    _ url: URL, options: [UIApplication.OpenExternalURLOptionsKey: Any],
+    _ url: URL,
+    options: [UIApplication.OpenExternalURLOptionsKey: Any],
     completionHandler completion: ((Bool) -> Void)?
   ) {
     UIApplication.shared.open(url, options: options, completionHandler: completion)

packages/url_launcher/url_launcher_ios/ios/Classes/URLLaunchSession.swift

@@ -5,7 +5,7 @@
 import Flutter
 import SafariServices
 
-typealias OpenInSafariCompletionHandler = (Result<LaunchResultDetails, Error>) -> Void
+typealias OpenInSafariCompletionHandler = (Result<LaunchResult, Error>) -> Void
 
 /// A session responsible for launching a URL in Safari and handling its events.
 final class URLLaunchSession: NSObject, SFSafariViewControllerDelegate {
@@ -41,12 +41,9 @@ final class URLLaunchSession: NSObject, SFSafariViewControllerDelegate {
     _ controller: SFSafariViewController, didCompleteInitialLoad didLoadSuccessfully: Bool
   ) {
     if didLoadSuccessfully {
-      completion(.success(LaunchResultDetails(result: .success)))
+      completion(.success(.success))
     } else {
-      completion(
-        .success(
-          LaunchResultDetails(result: .failedToLoad, errorMessage: "Error while launching \(url)")
-        ))
+      completion(.success(.failedToLoad))
     }
   }
 

packages/url_launcher/url_launcher_ios/ios/Classes/URLLauncherPlugin.swift

@@ -15,7 +15,7 @@ public final class URLLauncherPlugin: NSObject, FlutterPlugin, UrlLauncherApi {
   private var currentSession: URLLaunchSession?
   private let launcher: Launcher
 
-  var topViewController: UIViewController? {
+  private var topViewController: UIViewController? {
     // TODO(stuartmorgan) Provide a non-deprecated codepath. See
     // https://github.com/flutter/flutter/issues/104117
     UIApplication.shared.keyWindow?.rootViewController?.topViewController
@@ -25,34 +25,33 @@ public final class URLLauncherPlugin: NSObject, FlutterPlugin, UrlLauncherApi {
     self.launcher = launcher
   }
 
-  func canLaunchUrl(url: String) -> LaunchResultDetails {
+  func canLaunchUrl(url: String) -> LaunchResult {
     guard let url = URL(string: url) else {
-      return invalidURLError(for: url)
+      return .failedToLoad
     }
     let canOpen = launcher.canOpenURL(url)
-    return LaunchResultDetails(result: canOpen ? .success : .failure)
+    return canOpen ? .success : .failedToLoad
   }
 
   func launchUrl(
     url: String, universalLinksOnly: Bool,
-    completion: @escaping (Result<LaunchResultDetails, Error>) -> Void
+    completion: @escaping (Result<LaunchResult, Error>) -> Void
   ) {
     guard let url = URL(string: url) else {
-      completion(.success(invalidURLError(for: url)))
+      completion(.success(.failedToLoad))
       return
     }
     let options = [UIApplication.OpenExternalURLOptionsKey.universalLinksOnly: universalLinksOnly]
-    launcher.openURL(url, options: options) { success in
-      let result = LaunchResultDetails(result: success ? .success : .failure)
-      completion(.success(result))
+    launcher.openURL(url, options: options) { result in
+      completion(.success(result ? .success : .failedToLoad))
     }
   }
 
   func openUrlInSafariViewController(
-    url: String, completion: @escaping (Result<LaunchResultDetails, Error>) -> Void
+    url: String, completion: @escaping (Result<LaunchResult, Error>) -> Void
   ) {
     guard let url = URL(string: url) else {
-      completion(.success(invalidURLError(for: url)))
+      completion(.success(.failedToLoad))
       return
     }
 
@@ -68,18 +67,6 @@ public final class URLLauncherPlugin: NSObject, FlutterPlugin, UrlLauncherApi {
   func closeSafariViewController() throws {
     currentSession?.close()
   }
-
-  /**
-    * Creates an error for an invalid URL string.
-    *
-    * @param url The invalid URL string
-    * @return The error to return
-    */
-  func invalidURLError(for url: String) -> LaunchResultDetails {
-    LaunchResultDetails(
-      result: .invalidUrl, errorMessage: "Unable to parse URL", errorDetails: "Provided URL: \(url)"
-    )
-  }
 }
 
 /// This method recursively iterates through the view hierarchy

packages/url_launcher/url_launcher_ios/ios/Classes/messages.g.swift

@@ -47,111 +47,43 @@ enum LaunchResult: Int {
   /// The URL was successfully launched.
   case success = 0
   /// The URL could not be launched
-  case failure = 1
+  case failedToLoad = 1
   /// The URL was not launched because it is not invalid URL
   case invalidUrl = 2
-  /// The URL did not load successfully in the SFSafariViewController.
-  case failedToLoad = 3
-}
-
-/// Generated class from Pigeon that represents data sent in messages.
-struct LaunchResultDetails {
-  /// The result of the launch attempt.
-  var result: LaunchResult
-  /// A system-provided error message, if any.
-  var errorMessage: String? = nil
-  /// A system-provided error details, if any.
-  var errorDetails: String? = nil
-
-  static func fromList(_ list: [Any?]) -> LaunchResultDetails? {
-    let result = LaunchResult(rawValue: list[0] as! Int)!
-    let errorMessage: String? = nilOrValue(list[1])
-    let errorDetails: String? = nilOrValue(list[2])
-
-    return LaunchResultDetails(
-      result: result,
-      errorMessage: errorMessage,
-      errorDetails: errorDetails
-    )
-  }
-  func toList() -> [Any?] {
-    return [
-      result.rawValue,
-      errorMessage,
-      errorDetails,
-    ]
-  }
-}
-
-private class UrlLauncherApiCodecReader: FlutterStandardReader {
-  override func readValue(ofType type: UInt8) -> Any? {
-    switch type {
-    case 128:
-      return LaunchResultDetails.fromList(self.readValue() as! [Any?])
-    default:
-      return super.readValue(ofType: type)
-    }
-  }
-}
-
-private class UrlLauncherApiCodecWriter: FlutterStandardWriter {
-  override func writeValue(_ value: Any) {
-    if let value = value as? LaunchResultDetails {
-      super.writeByte(128)
-      super.writeValue(value.toList())
-    } else {
-      super.writeValue(value)
-    }
-  }
-}
-
-private class UrlLauncherApiCodecReaderWriter: FlutterStandardReaderWriter {
-  override func reader(with data: Data) -> FlutterStandardReader {
-    return UrlLauncherApiCodecReader(data: data)
-  }
-
-  override func writer(with data: NSMutableData) -> FlutterStandardWriter {
-    return UrlLauncherApiCodecWriter(data: data)
-  }
-}
-
-class UrlLauncherApiCodec: FlutterStandardMessageCodec {
-  static let shared = UrlLauncherApiCodec(readerWriter: UrlLauncherApiCodecReaderWriter())
 }
 
 /// Generated protocol from Pigeon that represents a handler of messages from Flutter.
 protocol UrlLauncherApi {
   /// Returns true if the URL can definitely be launched.
-  func canLaunchUrl(url: String) throws -> LaunchResultDetails
+  func canLaunchUrl(url: String) throws -> LaunchResult
   /// Opens the URL externally, returning true if successful.
   func launchUrl(
     url: String, universalLinksOnly: Bool,
-    completion: @escaping (Result<LaunchResultDetails, Error>) -> Void)
+    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<LaunchResultDetails, Error>) -> Void)
+    url: String, completion: @escaping (Result<LaunchResult, Error>) -> Void)
   /// Closes the view controller opened by [openUrlInSafariViewController].
   func closeSafariViewController() throws
 }
 
 /// Generated setup class from Pigeon to handle messages through the `binaryMessenger`.
 class UrlLauncherApiSetup {
   /// The codec used by UrlLauncherApi.
-  static var codec: FlutterStandardMessageCodec { UrlLauncherApiCodec.shared }
   /// 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, codec: codec)
+      binaryMessenger: binaryMessenger)
     if let api = api {
       canLaunchUrlChannel.setMessageHandler { message, reply in
         let args = message as! [Any?]
         let urlArg = args[0] as! String
         do {
           let result = try api.canLaunchUrl(url: urlArg)
-          reply(wrapResult(result))
+          reply(wrapResult(result.rawValue))
         } catch {
           reply(wrapError(error))
         }
@@ -162,7 +94,7 @@ class UrlLauncherApiSetup {
     /// Opens the URL externally, returning true if successful.
     let launchUrlChannel = FlutterBasicMessageChannel(
       name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.launchUrl",
-      binaryMessenger: binaryMessenger, codec: codec)
+      binaryMessenger: binaryMessenger)
     if let api = api {
       launchUrlChannel.setMessageHandler { message, reply in
         let args = message as! [Any?]
@@ -171,7 +103,7 @@ class UrlLauncherApiSetup {
         api.launchUrl(url: urlArg, universalLinksOnly: universalLinksOnlyArg) { result in
           switch result {
           case .success(let res):
-            reply(wrapResult(res))
+            reply(wrapResult(res.rawValue))
           case .failure(let error):
             reply(wrapError(error))
           }
@@ -184,15 +116,15 @@ class UrlLauncherApiSetup {
     /// when it has loaded successfully.
     let openUrlInSafariViewControllerChannel = FlutterBasicMessageChannel(
       name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.openUrlInSafariViewController",
-      binaryMessenger: binaryMessenger, codec: codec)
+      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))
+            reply(wrapResult(res.rawValue))
           case .failure(let error):
             reply(wrapError(error))
           }
@@ -204,7 +136,7 @@ class UrlLauncherApiSetup {
     /// Closes the view controller opened by [openUrlInSafariViewController].
     let closeSafariViewControllerChannel = FlutterBasicMessageChannel(
       name: "dev.flutter.pigeon.url_launcher_ios.UrlLauncherApi.closeSafariViewController",
-      binaryMessenger: binaryMessenger, codec: codec)
+      binaryMessenger: binaryMessenger)
     if let api = api {
       closeSafariViewControllerChannel.setMessageHandler { _, reply in
         do {